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

Einträge für Sprachassistenten für einen Standort abrufen

Gibt den Synchronisierungsstatus der Einträge für Sprachassistenten für einen Standort bei Google Assistant, Alexa, Siri, Cortana und Bixby zurück.

Erfordert einen API-Schlüssel. Format des Headers und Schlüsselrotation finden Sie unter Authentifizierung.

Parameter

Pfad

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

Antworten

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.

Gibt den Status der Einträge für Sprachassistenten für einen einzelnen Standort zurück. Listings API synchronisiert Standortdaten mit Google Assistant, Amazon Alexa, Apple Siri, Microsoft Cortana und Samsung Bixby, damit das Unternehmen in den Ergebnissen der Sprachsuche erscheint. Das Pfadsegment locationId akzeptiert die Base64-Knoten-ID aus einer beliebigen Standortantwort oder die unveränderte numerische Datenbank-ID; beide verweisen auf denselben Standort.

Anwendungsfall: Einträge für Sprachassistenten mit Handlungsbedarf in einem Dashboard anzeigen. Erstellen Sie für jeden Standort ein Widget, das die Bereitschaft für die Sprachsuche anzeigt, indem Sie das Array durchlaufen und jeden Eintrag markieren, bei dem actionRequired den Wert true hat oder syncIssue nicht null ist. Im obigen Beispiel besteht bei Google Assistant und Bixby Handlungsbedarf. Der häufigste Grund für Handlungsbedarf bei Google Assistant ist eine fehlende Google-Verbindung, da seine Ergebnisse aus der Verbindung zu Google Business Profile stammen. Verlinken Sie diese Zeilen mit Google verbinden, damit der Kunde das Konto verbinden kann. Die Ergebnisse von Siri stammen aus dem Apple Maps-Eintrag des Standorts.

Werte des Synchronisierungsstatus: IN_PROGRESS (Übermittlung läuft), REQUIRING_ACTION (Kundeneingabe erforderlich, bevor Listings API synchronisieren kann), LIVE (veröffentlicht) und NOT_SUBMITTED. errors ist ein Array von Fehlerzeichenfolgen auf Plattformseite; connectedAccountId verknüpft den Assistenten gegebenenfalls mit dem verbundenen Konto, über das die Synchronisierung erfolgt (e.g. Google Assistant über die Google-Verbindung).

Dieser Endpunkt wird auf das Anfragelimit Ihres Kontos angerechnet. Wenn Sie den Status der Einträge für Sprachassistenten für viele Standorte regelmäßig abfragen, durchlaufen Sie die Standorte mithilfe des Endpunkts Standortliste seitenweise und lassen Sie zwischen den Aufrufen zeitliche Abstände; eine 429 enthält einen Retry-After-Header, der angibt, wann Sie fortfahren können.

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