GET/api/v4/locations/{locationId}/voice-assistants

Ottieni le schede degli assistenti vocali per una sede

Restituisce lo stato di sincronizzazione delle schede degli assistenti vocali per una sede su Google Assistant, Alexa, Siri, Cortana e Bixby.

Richiede una chiave API. Consulta Autenticazione per il formato dell’header e la rotazione delle chiavi.

Parametri

Percorso

NomeTipoObbligatorioDescrizione
locationIdstringobbligatorioLocation ID. Accepts either the base64-encoded node ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`) or the raw numeric database ID (e.g. `1800289`).

Risposte

200Array of voice assistant listings with per-assistant sync status.
Response
{  "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.

Restituisce lo stato delle schede degli assistenti vocali per una singola sede. Listings API sincronizza i dati della sede con Google Assistant, Amazon Alexa, Apple Siri, Microsoft Cortana e Samsung Bixby affinché l'attività compaia nei risultati delle ricerche vocali. Il segmento di percorso locationId accetta l'ID del nodo in base64 presente in qualsiasi risposta relativa a una sede oppure l'ID numerico del database non codificato; entrambi identificano la stessa sede.

Caso d'uso: mostrare in una dashboard le schede degli assistenti vocali che richiedono un intervento. Crea un widget per ogni sede che ne mostri lo stato di preparazione per la ricerca vocale, scorrendo l'array e segnalando ogni voce in cui actionRequired è true oppure syncIssue è diverso da null. Nell'esempio precedente, Google Assistant e Bixby richiedono attenzione. Il motivo più comune per cui Google Assistant richiede attenzione è l'assenza di una connessione a Google, perché i suoi risultati provengono dalla connessione a Google Business Profile. Collega queste righe a Connetti Google affinché il cliente possa connettere l'account. I risultati di Siri provengono dalla scheda della sede su Apple Maps.

Valori dello stato di sincronizzazione: IN_PROGRESS (invio in corso), REQUIRING_ACTION (è necessario un intervento del cliente prima che Listings API possa eseguire la sincronizzazione), LIVE (pubblicato) e NOT_SUBMITTED. errors è un array di stringhe di errore provenienti dalla piattaforma di pubblicazione; connectedAccountId associa l'assistente all'account connesso tramite cui avviene la sincronizzazione, quando applicabile (e.g. Google Assistant tramite la connessione a Google).

Le chiamate a questo endpoint vengono conteggiate ai fini del limite di frequenza del tuo account. Se controlli periodicamente lo stato degli assistenti vocali per molte sedi, scorri le sedi usando la paginazione dell'endpoint elenco delle sedi e distanzia le chiamate; una risposta 429 include un'intestazione Retry-After che indica quando riprendere.

Request
curl -X GET 'https://listingsapi.com/api/v4/locations/<locationId>/voice-assistants' \  -H "Authorization: API $LISTINGSAPI_KEY"