/api/v4/connected-accounts/trigger-matches拠点の照合を開始
接続済みアカウントの Google および Facebook プロフィールを取得し、Listings API の拠点と照合します。
パラメーター
ボディ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
| input | object | 必須 | Wrapper object. The entire request body must be nested under `input`. |
| input.connectedAccountIds | array of strings | 必須 | UUIDs of the connected accounts to trigger matches for. Taken from `GET /connected-accounts`. |
リクエストの例
そのまま貼り付けられるボディです。プレースホルダーの ID と値をご自身のものに置き換えてください。
{ "input": { "connectedAccountIds": [ "4f712c17-4f95-42dd-90f4-97171a2e67b5" ] }}レスポンス
200Request accepted. `success` is `true` when the fetch-and-match job was queued for every account; accounts that could not be queued are returned in `failedIds` and `success` is `false`.
{ "data": { "connectedAccountsTriggerMatches": { "failedIds": null, "success": true } }}400Bad request, the body was not wrapped in `input` (error message: `Variable "$input" of required type "ConnectedAccountsTriggerMatchesInput!" was not provided`).
401Unauthenticated, missing or invalid API key.
指定された接続済みアカウントがアクセスできるすべての Google Business Profileおよび Facebook プロフィールを取得し、Listings API の拠点と照合する非同期ジョブを開始します。success: true レスポンスはジョブがキューに登録されたことを意味し、照合自体はバックグラウンドで実行されます。
リクエスト形式。 ボディは、照合対象の接続済みアカウントの配列である connectedAccountIds を含む input オブジェクトでラップする必要があります。ラップされていないフラットなボディを送信すると、HTTP 400 で拒否されます。アカウント ID は GET /connected-accounts から取得します。1 つ以上のアカウントをキューに登録できない場合、それらの ID が failedIds に返され、success は false になります。
ユースケース：新しいアカウントの接続後に候補を更新する。 顧客が Google の接続フローを完了した直後に、そのアカウントの connectedAccountId を指定して trigger-matches を呼び出します。これにより拠点の照合候補が設定されるため、顧客が定期同期を待たずに、オンボーディング UI に「お客様の掲載情報が N 件見つかりました」と表示できます。
ユースケース：拠点の追加後に照合を再実行する。 既存の接続済みアカウントに対して新しい Listings API の拠点を一括作成した場合は、新たに照合を実行し、新しい拠点が既存の Google/Facebook の掲載情報と対応付けられるようにします。
処理は非同期で行われるため、200 を「照合完了」と見なさないでください。接続済みアカウントの詳細エンドポイントをポーリングして requestMatchesStatus が MATCH_COMPLETED になるのを待ち、その後、confirm-matches または connect-listing を呼び出す前に、connection-suggestions エンドポイントから結果を読み取ってください。
このエンドポイントは、Google/Facebook からデータを直接取得する処理をキューに登録します。上記のリクエスト形式とサンプルレスポンスは API 仕様に基づいて記載されており、本番データに対する呼び出しは実行されていません。
curl -X POST 'https://listingsapi.com/api/v4/connected-accounts/trigger-matches' \ -H "Authorization: API $LISTINGSAPI_KEY" \ -H 'Content-Type: application/json' \ -d '{ "input": { "connectedAccountIds": [ "4f712c17-4f95-42dd-90f4-97171a2e67b5" ] } }'