/api/v4/connected-accounts/{connectedAccountId}/connection-suggestions列出连接建议
返回已连接账户的 Listings API 地点与 Google Business Profile 或 Facebook 商家信息之间的建议匹配。
参数
路径
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| connectedAccountId | string | 必填 | UUID of the connected account to list suggestions for. |
查询
| 名称 | 类型 | 必填 | 描述 | 默认值 |
|---|---|---|---|---|
| page | integer | 可选 | 1-based page number. | 1 |
| perPage | integer | 可选 | Records per page. | 20 |
响应
200Paginated list of connection suggestions.
{ "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 账号后,轮询此端点,在您自己的审核界面中展示每个建议匹配。操作人员批准正确的配对后,您将已批准记录的 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 响应头的值指定的时间后重试,而不是缩短轮询间隔。
curl -X GET 'https://listingsapi.com/api/v4/connected-accounts/<connectedAccountId>/connection-suggestions' \ -H "Authorization: API $LISTINGSAPI_KEY"