拠点の音声アシスタントの掲載情報を取得する

名前	型	必須	説明
locationId	string	必須	Location ID. Accepts either the base64-encoded node ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`) or the raw numeric database ID (e.g. `1800289`).

名前

型

必須

説明

locationId

string

必須

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

レスポンス

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.

単一拠点の音声アシスタントの掲載情報のステータスを返します。Listings APIは拠点データをGoogle Assistant、Amazon Alexa、Apple Siri、Microsoft Cortana、Samsung Bixbyに同期し、ビジネスが音声検索の結果に表示されるようにします。locationIdパスセグメントには、任意の拠点レスポンスに含まれるbase64ノードID、または数値のデータベースIDを指定でき、どちらも同じ拠点に解決されます。

ユースケース：ダッシュボードに「要対応」の音声アシスタントの掲載情報を表示する。 配列を走査し、actionRequiredがtrueであるか、syncIssueがnull以外であるすべてのエントリにフラグを付けて、拠点ごとの音声検索への対応状況を示すウィジェットを表示します。上記のサンプルでは、Google AssistantとBixbyに対応が必要です。Google Assistantの検索結果はGoogle Business Profileの接続から取得されるため、Google Assistantに対応が必要となる最も一般的な理由は、Google接続がないことです。顧客がアカウントを接続できるように、これらの行にGoogleを接続へのリンクを設定します。Siriの検索結果は、その拠点のApple Mapsの掲載情報から取得されます。

同期ステータスの値： IN_PROGRESS（送信中）、REQUIRING_ACTION（Listings APIが同期を行う前に顧客の入力が必要）、LIVE（公開済み）、NOT_SUBMITTEDです。errorsは掲載先側のエラー文字列の配列です。connectedAccountIdは、該当する接続済みアカウントがある場合に、アシスタントを同期元のそのアカウントに関連付けます（例：Google接続を介したGoogle Assistant）。

このエンドポイントへの呼び出しは、アカウントのレート制限の対象となります。多数の拠点の音声アシスタントのステータスをポーリングする場合は、拠点一覧エンドポイントで拠点をページ単位で取得し、呼び出しの間隔を空けてください。429には、再開できるタイミングを示すRetry-Afterヘッダーが含まれます。

パラメーター

パス

レスポンス