/api/v4/locations/{locationId}/reviews/settingsListar fontes de avaliações de um local
Retorna as fontes de avaliações configuradas para um único local, com suas URLs de conexão.
Parâmetros
Caminho
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| locationId | string | obrigatório | Location to read. Accepts a base64-encoded Relay ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`) or a raw numeric location ID. |
Respostas
200Review-source sites and their configured URLs for the location.
{ "data": { "interactionsSetting": { "siteSettings": [ { "name": "maps.google.com", "url": null }, { "name": "facebook.com", "url": null }, { "name": "yelp.com", "url": null } ] } }}401Unauthenticated, missing or invalid API key.
429Rate limit exceeded. Retry after the `Retry-After` header value.
Retorna as configurações das fontes de avaliações de um local. Cada entrada em siteSettings é uma plataforma compatível com o plano da conta. Um url não nulo significa que essa plataforma está conectada e que a Listings API está coletando avaliações dessa URL; um null url (como mostrado acima para o local em produção Jenny Home, que ainda não tem fontes de terceiros vinculadas) significa que a plataforma está disponível, mas ainda não foi configurada.
Caso de uso: identificar quais fontes ainda precisam de uma URL
Busque essa lista e filtre por url: null para montar a lista de plataformas que o proprietário de um local ainda precisa conectar. As fontes de avaliações são vinculadas automaticamente assim que os perfis do local no Google e no Facebook são conectados; conecte essas contas para preencher as URLs ausentes:
{ "name": "yelp.com", "url": "https://www.yelp.com/biz/your-listing" }Após a edição, a mesma plataforma é retornada com seu url preenchido em vez de null.
Caso de uso: auditar fontes conectadas em um conjunto de locais
Percorra seus locais (obtidos em Listar todos os locais) e chame este endpoint para cada local para gerar um relatório da cobertura das fontes de avaliações. Como é feita uma requisição por local, respeite o limite de requisições da conta, distribua as chamadas ao longo do tempo e, ao receber 429, tente novamente após o intervalo indicado no cabeçalho Retry-After, em vez de fazer requisições repetidas sem pausa.
O Google e o Facebook conectados via OAuth aparecem automaticamente como conectados e não podem ser sobrescritos pelo endpoint de edição. Use Listar fontes de avaliações de uma conta, que abrange toda a conta, para ver o conjunto completo de plataformas que o plano poderia oferecer.
curl -X GET 'https://listingsapi.com/api/v4/locations/<locationId>/reviews/settings' \ -H "Authorization: API $LISTINGSAPI_KEY"