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

Google アカウントの接続を解除する

接続済みの Google Business Profile アカウント全体を Listings API アカウントから切り離します。

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

パラメーター

ボディ

名前型必須説明
inputobject必須Wrapper object. The entire request body must be nested under `input`.
input.connectedAccountIdstring必須UUID of the connected Google account to disconnect. The whole account is disconnected.

リクエストの例

そのまま貼り付けられるボディです。プレースホルダーの ID と値をご自身のものに置き換えてください。

Request body
{  "input": {    "connectedAccountId": "d2397854-52c2-41d7-95f1-b90cba16498d"  }}

レスポンス

200Request accepted. `success: true` confirms the disconnect was processed.
Response
{  "data": {    "gmbBulkDisconnect": {      "success": true    }  }}
400Bad request, the body was not wrapped in `input`, or `connectedAccountId` was omitted (error message: `Field value.connectedAccountId of required type String! was not provided`).
401Unauthenticated, missing or invalid API key.

接続済みの Google Business Profile アカウントと Listings API アカウントの連携を解除します。接続を解除すると、そのアカウントを通じて同期されていた掲載情報は、Listings API からの更新を受け取らなくなります。

リクエストの形式。 リクエストボディは、connectedAccountId のみをフィールドとして持つ input オブジェクトで囲む必要があります。この操作では一部だけを解除することはできず、Google アカウント全体と、そのアカウントを通じて連携されているすべての拠点の接続が解除されます。locationIds フィールドはなく、指定するとスキーマによって拒否されます。アカウントの接続を維持したまま、単一の拠点の掲載情報の連携を解除するには、disconnect-listing エンドポイントを使用します。

ユースケース:クライアントとの契約終了時に連携を完全に解除する。 connectedAccountId を送信すると、1 回の呼び出しで接続全体を解除できます。これは、顧客が解約した後や Google アカウントの所有権を譲渡した後に、Listings API のアクセス権を取り消すための適切な方法です。

ユースケース:不具合のある接続を解除する。 Google との接続で、再認証しても解消できない認証情報のエラーが発生している場合は、このエンドポイントで接続を解除し、connect-google エンドポイントで新しいリンクを発行します。Facebook アカウントの場合は、同じリクエスト形式を受け付ける disconnect-facebook エンドポイントを使用します。不明な connectedAccountId に対しても success: true レスポンスが返されます。成功は「リクエストが処理された」という意味にとどまり、有効な接続が削除された証拠にはなりません。確実に確認する必要がある場合は GET /connected-accounts でアカウントの状態を確認してください。

このエンドポイントは本番の接続を変更し、Listings API の Google へのアクセス権を取り消します。上記のリクエスト形式とサンプルレスポンスは API 仕様に基づいて記載しており、本番データに対してこの呼び出しを実行しているわけではありません。

Request
curl -X POST 'https://listingsapi.com/api/v4/connected-accounts/disconnect-google' \  -H "Authorization: API $LISTINGSAPI_KEY" \  -H 'Content-Type: application/json' \  -d '{    "input": {      "connectedAccountId": "d2397854-52c2-41d7-95f1-b90cba16498d"    }  }'