GET/api/v4/connected-accounts/{connectedAccountId}/connection-suggestions

接続候補の一覧を取得

接続済みアカウントについて、Listings APIの拠点とGoogle Business ProfileまたはFacebookの掲載情報とのマッチング候補を返します。

API キーが必要です。ヘッダーの形式とキーのローテーションについては認証を参照してください。

パラメーター

パス

名前型必須説明
connectedAccountIdstring必須UUID of the connected account to list suggestions for.

クエリ

名前型必須説明デフォルト
pageinteger任意1-based page number.1
perPageinteger任意Records per page.20

レスポンス

200Paginated list of connection suggestions.
Response
{  "data": {    "connectionSuggestionsForAccount": {      "pageInfo": {        "hasNextPage": false,        "hasPreviousPage": false,        "totalPages": 1,        "totalRecords": 2      },      "records": [        {          "accountEmail": "contact@brightsmile-dental.com",          "accountType": "GMB",          "connectedAccountId": "4f712c17-4f95-42dd-90f4-97171a2e67b5",          "locationId": "73415",          "matchedDataDatabaseId": "0d5e306f-0da0-46e3-929f-fd3c67ccd8cc",          "locationInfo": {            "name": "My Business",            "city": "Lincoln",            "stateIso": "NE"          },          "suggestedLocationInfo": {            "locationInfo": { "name": "My Business", "city": "Lincoln" }          }        }      ]    }  }}
401Unauthenticated, missing or invalid API key.
429Rate limit exceeded. Retry after the `Retry-After` header value.

接続済みアカウントでマッチングトリガーを実行して検出された、Listings APIの拠点とGoogle Business ProfileまたはFacebookの掲載情報との組み合わせ候補を返します。各レコードには、Listings APIの拠点の詳細と、マッチした掲載先の掲載情報の両方が表示されるため、担当者は確定前に両者を比較できます。

候補はPOST /connected-accounts/trigger-matchesによって非同期で生成されます。アカウントを接続したばかりの場合は、まずtrigger-matchesを呼び出してください。そうしないと、recordsは空になり、pageInfo.totalRecordsは0になります。(接続直後でまだマッチング結果がないアカウントに対して実際に実行すると、このエンドポイントは{"data":{"connectionSuggestionsForAccount":{"pageInfo":{"hasNextPage":false,"hasPreviousPage":false,"totalPages":0,"totalRecords":0},"records":[]}}}を返します。)上の例は、データが入ったレコードの構造を示しています。

ユースケース:確定前にレビューするワークフロー。 クライアントのGoogleアカウントをインポートした後、このエンドポイントをポーリングして、すべてのマッチング候補を独自のレビューUIに表示します。担当者が正しい組み合わせを承認し、承認されたレコードのIDをPOST /connected-accounts/confirm-matchesに渡します。

レコードの識別。 候補レコードにはidフィールドがありません。その識別子は、基になるマッチングレコードの主キーであるmatchedDataDatabaseIdです。accountTypeは、マッチングレコードの種類(GMB、FB、またはAPPLE)を示します。マッチングの確定は、この2つの値から受け付けるIDを組み立てるため、レビュー用に候補を準備する際は、この2つの値を一緒に保持してください。

ページネーションとレート制限。 ネストされていないクエリパラメーターpageとperPage(例:?page=2&perPage=50)でページを切り替え、pageInfo.hasNextPageを確認してください。pageInfo、filters、sortBy、accountIdというパラメーターはありません。接続済みアカウントはパスから決まり、並び順は拠点情報の昇順に固定されており、それ以外に送信したものは拒否されずに無視されます。このエンドポイントには、他の一覧取得エンドポイントと同様にレート制限があります。429が返された場合は、ポーリング間隔を短くするのではなく、Retry-Afterヘッダーの値で指定された時間だけ待ってから再試行してください。

Request
curl -X GET 'https://listingsapi.com/api/v4/connected-accounts/<connectedAccountId>/connection-suggestions' \  -H "Authorization: API $LISTINGSAPI_KEY"