Disconnettere una sede da una piattaforma di pubblicazione

Parametri

Corpo

Nome	Tipo	Obbligatorio	Descrizione
input	object	obbligatorio	Wrapper object. The entire request body must be nested under `input`.
input.locationId	string	obbligatorio	Base64-encoded Relay ID of the one location to disconnect.
input.site	string	facoltativo	Publisher to disconnect from: `GOOGLE`, `FACEBOOK`, or `APPLE`. Required unless you send `providerId`.
input.providerId	string	facoltativo	The publisher's own account identifier, as an alternative to `site`. Required unless you send `site`.

Risposte

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

Rimuove la connessione di una singola sede a una piattaforma di pubblicazione. È la fase di disconnessione del flusso OAuth per singola sede avviato da Creare un URL di connessione OAuth per una sede.

Questa route e Disconnettere una scheda da una sede eseguono la stessa operazione tramite due percorsi: entrambe accettano lo stesso corpo input e restituiscono il risultato sotto disconnectConnectedAccountsLocations, non sotto il nome di uno dei due percorsi. Scegli il percorso più leggibile nella tua integrazione; non c'è alcuna differenza di comportamento.

Il corpo deve essere racchiuso in input e contenere un solo locationId, oltre a uno tra site e providerId per indicare quale connessione interrompere. Se non invii nessuno dei due, viene restituito SY10056 ("Il sito non è valido per la disconnessione della sede"); se la sede non ha una connessione attiva per quel sito, viene restituito SY10057 anziché un esito positivo senza alcuna modifica, quindi success: true significa effettivamente che una connessione è stata rimossa. Non è un endpoint per operazioni in blocco, quindi usa un ciclo per più sedi. Per disconnettere contemporaneamente tutte le sedi di un intero account, usa invece Disconnettere in blocco gli account Google.

Caso d'uso: annullare una connessione alla scheda sbagliata

Quando un utente collega a un negozio la scheda sbagliata di una piattaforma di pubblicazione, disconnettila qui impostando site su quella piattaforma di pubblicazione, poi indirizza nuovamente l'utente all'URL di connessione (oppure esegui trigger-matches e Connettere una scheda) per collegare quella corretta. La disconnessione lascia intatti la sede e i suoi dati; si interrompe solo la sincronizzazione in uscita verso quella piattaforma di pubblicazione.

Caso d'uso: un cliente interrompe il rapporto e porta con sé il proprio account Apple Business

Con site: "APPLE", la sede non viene più pubblicata tramite l'account Apple Business del proprietario. Rimane su Apple Maps: gli aggiornamenti successivi vengono pubblicati tramite l'account Apple Business Connect di ListingsAPI e Apple verifica l'invio prima di pubblicarlo. Per pubblicare nuovamente tramite l'account del proprietario, inviagli un nuovo link da Creare un URL di connessione OAuth per una sede.

Questo endpoint modifica una connessione attiva. La richiesta e la risposta di esempio riportate sopra sono esempi.

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