/api/v4/locations/oauth-disconnect사업장 1개의 게시 플랫폼 연결 해제
사업장 1개와 게시 플랫폼 간의 연결을 해제하며, 사업장별 OAuth 연결 URL에 대응하는 연결 해제 기능입니다.
매개변수
본문
| 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| input | object | 필수 | Wrapper object. The entire request body must be nested under `input`. |
| input.locationId | string | 필수 | Base64-encoded Relay ID of the one location to disconnect. |
| input.site | string | 선택 | Publisher to disconnect from: `GOOGLE`, `FACEBOOK`, or `APPLE`. Required unless you send `providerId`. |
| input.providerId | string | 선택 | The publisher's own account identifier, as an alternative to `site`. Required unless you send `site`. |
요청 예시
바로 붙여 넣을 수 있는 본문입니다. 예시 ID와 값을 실제 값으로 바꾸세요.
{ "input": { "locationId": "TG9jYXRpb246MTgwMDI4OQ==", "site": "GOOGLE" }}응답
200Connection removed. Response key `disconnectConnectedAccountsLocations`.
{ "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으로 감싸야 하며, 단일 locationId와 함께 해제할 연결을 지정하는 site 또는 providerId 중 하나를 포함해야 합니다. 둘 다 보내지 않으면 SY10056("Site is not valid for the location disconnection")이 반환되며, 해당 사이트에 대한 활성 연결이 없는 사업장의 경우 아무 작업 없이 성공을 반환하는 대신 SY10057이 반환되므로, success: true는 실제로 연결이 제거되었음을 의미합니다. 일괄 처리 엔드포인트가 아니므로 여러 사업장의 연결을 해제하려면 반복 호출합니다. 한 계정에 속한 모든 사업장의 연결을 한 번에 해제하려면 대신 Google 계정 일괄 연결 해제를 사용합니다.
사용 사례: 잘못된 대상에 대한 연결 취소
사용자가 매장에 잘못된 게시 플랫폼 등록 정보를 연결한 경우, 여기서 site를 해당 게시 플랫폼으로 설정하여 연결을 해제한 다음, 연결 URL을 통해 다시 연결하도록 안내하거나 trigger-matches와 등록 정보 연결을 실행하여 올바른 등록 정보를 연결합니다. 연결을 해제해도 사업장과 해당 데이터는 그대로 유지되며, 해당 게시 플랫폼으로의 아웃바운드 동기화만 중지됩니다.
사용 사례: 고객이 서비스를 떠나면서 Apple Business 계정도 가져가는 경우
site: "APPLE"을 사용하면 소유자의 Apple Business 계정을 통한 사업장 게시가 중지됩니다. 사업장은 Apple Maps에 그대로 유지되며, 이후 업데이트는 ListingsAPI Apple Business Connect 계정을 통해 게시되고, Apple은 게시 전에 제출 내용을 검증합니다. 소유자의 계정을 통해 다시 게시하려면 사업장 1개의 OAuth 연결 URL 생성으로 새 링크를 생성하여 소유자에게 보냅니다.
이 엔드포인트는 실제 연결을 변경합니다. 위의 샘플 요청과 응답은 예시입니다.
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" } }'