POST/api/v4/locations/oauth-disconnect

1つの拠点と掲載先の接続を解除する

1つの拠点と掲載先の接続を切断します。拠点ごとの OAuth 接続 URL に対応する接続解除操作です。

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"  }}

レスポンス

200Connection removed. Response key `disconnectConnectedAccountsLocations`.
Response
{  "data": {    "disconnectConnectedAccountsLocations": {      "clientMutationId": null,      "success": true,      "errors": null    }  }}
401Unauthenticated, missing or invalid API key.
403The key is valid but not permitted to disconnect this location (`SY90003`).

1つの拠点と掲載先の接続を解除します。1つの拠点用の OAuth 接続 URL を作成するで開始する、拠点ごとの OAuth フローのうち、接続解除を担う操作です。

このルートと拠点から掲載情報の接続を解除するは、2つのパスで提供される同じ操作です。どちらも同一の input リクエストボディを受け取り、結果はどちらのパス名の下でもなく、disconnectConnectedAccountsLocations の下に返されます。連携の実装でわかりやすい方のパスを選んでください。動作に違いはありません。

リクエストボディは input でラップし、1つの locationId に加えて、切断する接続を指定するために site または providerId のいずれかを含める必要があります。どちらも送信しない場合は SY10056(「このサイトは拠点の接続解除の対象として無効です」)が返されます。そのサイトへの有効な接続がない拠点の場合は、何もせずに成功を返すのではなく SY10057 が返されるため、success: true は実際に接続が解除されたことを意味します。一括処理用のエンドポイントではないため、複数の拠点を処理する場合はループで呼び出してください。1つのアカウントに属するすべての拠点の接続を一度に解除するには、代わりに Google アカウントの接続を一括解除するを使用してください。

ユースケース:誤った接続を取り消す

ユーザーが店舗に対して掲載先の誤った掲載情報を接続した場合は、site をその掲載先に設定してここで接続を解除し、その後、接続 URL から再度手続きを進めてもらうか、trigger-matches と掲載情報を接続するを実行して、正しい掲載情報を接続します。接続を解除しても拠点とそのデータはそのまま保持され、その掲載先への同期だけが停止します。

ユースケース:クライアントが契約を終了し、自身の Apple Business アカウントを引き続き使用する

site: "APPLE" を使用すると、オーナーの Apple Business アカウントを通じた拠点の公開が停止します。拠点は Apple Maps に残り、その後の更新は ListingsAPI の Apple Business Connect アカウントを通じて公開され、Apple が送信内容を検証してから公開します。オーナーのアカウントを通じて再び公開するには、1つの拠点用の OAuth 接続 URL を作成するで生成した新しいリンクをオーナーに送信してください。

このエンドポイントは実際の接続を変更します。上記のリクエストとレスポンスは例です。

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