Listings APIListings API
Entrar
POST/api/v4/locations/oauth-disconnect

Desconectar um local de uma plataforma de publicação

Desfaz a conexão de um único local com uma plataforma de publicação, como contraparte da URL de conexão OAuth por local.

Requer uma chave de API. Consulte Autenticação para ver o formato do cabeçalho e a rotação de chaves.

Parâmetros

Corpo

NomeTipoObrigatórioDescrição
inputobjectobrigatórioWrapper object. The entire request body must be nested under `input`.
input.locationIdstringobrigatórioBase64-encoded Relay ID of the one location to disconnect.
input.sitestringopcionalPublisher to disconnect from: `GOOGLE`, `FACEBOOK`, or `APPLE`. Required unless you send `providerId`.
input.providerIdstringopcionalThe publisher's own account identifier, as an alternative to `site`. Required unless you send `site`.

Exemplo de requisição

Corpo pronto para colar. Substitua os IDs e valores de exemplo pelos seus.

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

Respostas

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`).

Remove a conexão de um único local com uma plataforma de publicação. É a etapa de desconexão do fluxo OAuth por local iniciado por Criar uma URL de conexão OAuth para um local.

Esta rota e Desconectar uma listagem de um local são a mesma operação em dois caminhos: ambas recebem o mesmo corpo input e retornam o resultado em disconnectConnectedAccountsLocations, e não no nome de qualquer um dos caminhos. Escolha o caminho que fizer mais sentido na sua integração; não há diferença de comportamento.

O corpo deve estar encapsulado em input e conter um único locationId, além de um dos dois: site ou providerId, para indicar qual conexão desfazer. Se nenhum dos dois for enviado, o endpoint retorna SY10056 ("Site is not valid for the location disconnection"); para um local sem conexão ativa com esse site, retorna SY10057 em vez de indicar sucesso silenciosamente, portanto success: true realmente significa que um vínculo foi removido. Não é um endpoint em lote, portanto use um laço para vários locais. Para desconectar todos os locais de uma conta de uma só vez, use Desconectar contas do Google em lote.

Caso de uso: desfazer uma conexão com a listagem errada

Quando um usuário conecta a listagem errada de uma plataforma de publicação a uma loja, desconecte-a aqui com site definido para essa plataforma de publicação e, em seguida, encaminhe o usuário novamente pela URL de conexão (ou execute trigger-matches e Conectar uma listagem) para vincular a listagem correta. A desconexão mantém o local e seus dados intactos; apenas a sincronização de saída para essa plataforma de publicação é interrompida.

Caso de uso: um cliente encerra o relacionamento e leva sua conta do Apple Business

Com site: "APPLE", o local deixa de ser publicado por meio da conta do Apple Business do proprietário. Ele permanece no Apple Maps: as atualizações posteriores são publicadas por meio da conta do Apple Business Connect da ListingsAPI, e a Apple verifica o envio antes de publicá-lo. Para publicar novamente por meio da conta do proprietário, envie a ele um novo link de Criar uma URL de conexão OAuth para um local.

Este endpoint altera uma conexão ativa. A solicitação e a resposta de exemplo acima são exemplos.

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"    }  }'
Run in playground