POST/api/v4/connected-accounts/disconnect-listing

断开商家信息与地点的连接

解除单个 Listings API 地点与已连接的发布平台商家信息之间的关联。

需要 API 密钥。请求头格式和密钥轮换请参阅身份验证。

参数

请求体

名称类型必填描述
inputobject必填Wrapper object. The entire request body must be nested under `input`.
input.locationIdstring必填Base64-encoded Relay ID of the one location to disconnect.
input.sitestring可选Publisher to disconnect from: `GOOGLE`, `FACEBOOK`, or `APPLE`. Required unless you send `providerId`.
input.providerIdstring可选The publisher's own account identifier, as an alternative to `site`. Required unless you send `site`.

请求示例

可直接粘贴的请求体。请将占位 ID 和值替换为您自己的。

Request body
{  "input": {    "locationId": "TG9jYXRpb246MTgwMDI4OQ==",    "site": "GOOGLE"  }}

响应

200Listing disconnected.
Response
{  "data": {    "disconnectConnectedAccountsLocations": {      "clientMutationId": null,      "success": true,      "errors": null    }  }}
401Unauthenticated, missing or invalid API key.

移除 Listings API 地点与其当前连接的发布平台商家信息(Google Business Profile、Facebook Page 或 Apple Business Connect)之间的关联。断开连接后,Listings API 将停止向该商家信息推送更新。地点本身仍保留在您的账户中,仅解除与商家信息的关联。

请求结构。 请求体必须封装在一个 input 对象中,该对象包含单个 locationId,并且必须在 site(GOOGLE、FACEBOOK 或 APPLE)和 providerId 中二选一,以指定要断开的连接。这不是批量端点:每次调用只能处理 1 个地点,因此如果您需要处理多个地点,请循环调用。

如果既不发送 site 也不发送 providerId,端点将返回 SY10056(“Site is not valid for the location disconnection”)。如果地点与该站点之间没有有效连接,端点将返回 SY10057(“Location is not connected for the site”),而不会静默返回成功,因此 success: true 确实表示已移除关联。

使用场景:将地点重新关联到其他账号。 当客户将门店从一个 Google 账号迁移到另一个账号时,请先在此处使用 site: "GOOGLE" 断开该地点当前的商家信息连接,然后在新的已连接账户上使用 trigger-matches 和 connect-listing,将该地点关联到正确的商家信息。

使用场景:停止服务但不删除。 当客户降级后不再希望 Listings API 管理其 Google/Facebook 商家信息,但希望保留地点记录及其由 Listings API 托管的数据时,请断开商家信息连接,而不是归档地点。这样会停止对外同步,同时保留该地点供其他发布平台使用。

此端点会更改正在使用的连接,并将更改推送到发布平台。上方的请求和响应仅为示例。

Request
curl -X POST 'https://listingsapi.com/api/v4/connected-accounts/disconnect-listing' \  -H "Authorization: API $LISTINGSAPI_KEY" \  -H 'Content-Type: application/json' \  -d '{    "input": {      "locationId": "TG9jYXRpb246MTgwMDI4OQ==",      "site": "GOOGLE"    }  }'