/api/v4/locations/{locationId}/voice-assistantsObter listagens de assistentes de voz para um local
Retorna o status de sincronização das listagens de um local no Google Assistant, Alexa, Siri, Cortana e Bixby.
Parâmetros
Caminho
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| locationId | string | obrigatório | Location ID. Accepts either the base64-encoded node ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`) or the raw numeric database ID (e.g. `1800289`). |
Respostas
200Array of voice assistant listings with per-assistant sync status.
{ "data": { "voiceAssistantsForLocation": [ { "databaseId": "104468723", "voiceIdentifier": "GOOGLE_ASSISTANT", "name": "Google Assistant", "connectedAccountId": null, "syncStatus": "REQUIRING_ACTION", "actionRequired": true, "syncIssue": null, "errors": [] }, { "databaseId": "104468711", "voiceIdentifier": "SIRI", "name": "Siri", "connectedAccountId": null, "syncStatus": "IN_PROGRESS", "actionRequired": false, "syncIssue": null, "errors": [] }, { "databaseId": "104468714", "voiceIdentifier": "ALEXA", "name": "Alexa", "connectedAccountId": null, "syncStatus": "IN_PROGRESS", "actionRequired": false, "syncIssue": null, "errors": [] } ] }}401Unauthenticated, missing or invalid API key.
429Rate limit exceeded. Retry after the `Retry-After` header value.
Retorna o status das listagens de assistentes de voz para um único local. A Listings API sincroniza os dados do local com o Google Assistant, Amazon Alexa, Apple Siri, Microsoft Cortana e Samsung Bixby para que a empresa apareça nos resultados de pesquisa por voz. O segmento locationId do caminho aceita o ID de nó em base64 de qualquer resposta de local ou o ID numérico bruto do banco de dados; ambos correspondem ao mesmo local.
Caso de uso: mostrar listagens de voz que exigem ação em um painel. Renderize um widget por local que indique se ele está pronto para a pesquisa por voz, percorrendo o array e sinalizando cada entrada em que actionRequired seja true ou syncIssue não seja nulo. No exemplo acima, o Google Assistant e o Bixby precisam de atenção. O motivo mais comum para o Google Assistant precisar de atenção é a ausência de uma conexão com o Google, pois seus resultados vêm da conexão com o Google Business Profile. Vincule essas linhas a Conectar o Google para que o cliente possa conectar a conta. Os resultados da Siri vêm da listagem do local no Apple Maps.
Valores do status de sincronização: IN_PROGRESS (envio em andamento), REQUIRING_ACTION (são necessárias informações do cliente para que a Listings API possa sincronizar), LIVE (publicado) e NOT_SUBMITTED. errors é um array de strings de erro do lado da plataforma de publicação; connectedAccountId vincula o assistente à conta conectada usada para a sincronização, quando aplicável (e.g. Google Assistant por meio da conexão com o Google).
Este endpoint é contabilizado no limite de requisições da sua conta. Se você consultar periodicamente o status de voz de muitos locais, percorra-os usando a paginação do endpoint de lista de locais e espace as chamadas; uma resposta 429 inclui um cabeçalho Retry-After que informa quando retomar.
curl -X GET 'https://listingsapi.com/api/v4/locations/<locationId>/voice-assistants' \ -H "Authorization: API $LISTINGSAPI_KEY"