Listings APIListings API
サインイン
POST/api/v4/connected-accounts/disconnect-listing

拠点から掲載情報の接続を解除する

Listings APIの1つの拠点に接続されている掲載先の掲載情報とのリンクを解除します。

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はその掲載情報への更新の送信を停止します。拠点自体はアカウントに残り、掲載情報とのリンクのみが解除されます。

リクエストの構造。 リクエストボディは、1つのlocationIdと、解除する接続を指定するためのsite（GOOGLE、FACEBOOK、APPLE）またはproviderIdのいずれかを含むinputオブジェクトでラップする必要があります。これは一括処理用のエンドポイントではなく、1回の呼び出しで処理できるのは1つの拠点のみなので、複数の拠点を処理する場合はループで呼び出してください。

siteもproviderIdも送信しない場合、SY10056（"Site is not valid for the location disconnection"）が返されます。そのサイトへの有効な接続がない拠点を指定すると、何もせずに成功を返すのではなく、SY10057（"Location is not connected for the site"）が返されるため、success: trueは実際にリンクが解除されたことを意味します。

ユースケース：拠点の接続先を別のアカウントに変更する。 顧客が店舗をあるGoogleアカウントから別の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"    }  }'
Run in playground