Einen Standort von einer Plattform trennen

Parameter

Body

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

Antworten

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

Entfernt die Verbindung eines einzelnen Standorts zu einer Plattform. Dies ist der Schritt zum Trennen der Verbindung im standortspezifischen OAuth-Ablauf, der über OAuth-Verbindungs-URL für einen einzelnen Standort erstellen gestartet wird.

Diese Route und Verbindung zwischen einem Eintrag und einem Standort trennen führen über zwei Pfade denselben Vorgang aus: Beide akzeptieren denselben input-Body und geben ihr Ergebnis unter disconnectConnectedAccountsLocations zurück, nicht unter dem Namen des jeweiligen Pfads. Wählen Sie den Pfad, der sich in Ihrer Integration besser liest; es gibt keinen Unterschied im Verhalten.

Der Body muss in input eingebettet sein und einen einzelnen locationId sowie entweder site oder providerId enthalten, um anzugeben, welche Verbindung getrennt werden soll. Wenn Sie keines von beiden senden, wird SY10056 ("Site is not valid for the location disconnection") zurückgegeben; bei einem Standort ohne aktive Verbindung zu dieser Plattform wird SY10057 zurückgegeben, statt stillschweigend Erfolg zu melden. Somit bedeutet success: true tatsächlich, dass eine Verbindung entfernt wurde. Dies ist kein Endpunkt für Massenvorgänge. Verwenden Sie daher für mehrere Standorte eine Schleife. Um die Verbindungen aller Standorte eines Kontos auf einmal zu trennen, verwenden Sie stattdessen Verbindungen zu Google-Konten gesammelt trennen.

Anwendungsfall: Eine falsch zugeordnete Verbindung rückgängig machen

Wenn ein Benutzer den falschen Plattform-Eintrag mit einer Filiale verbindet, trennen Sie die Verbindung hier, indem Sie site auf diese Plattform setzen, und leiten Sie ihn anschließend erneut durch den Ablauf über die Verbindungs-URL (oder führen Sie trigger-matches und Eintrag verbinden aus), um den richtigen Eintrag zu verknüpfen. Beim Trennen der Verbindung bleiben der Standort und seine Daten erhalten; lediglich die ausgehende Synchronisierung mit dieser Plattform wird beendet.

Anwendungsfall: Ein Kunde beendet die Zusammenarbeit und nimmt sein Apple Business-Konto mit

Mit site: "APPLE" wird der Standort nicht mehr über das Apple Business-Konto des Inhabers veröffentlicht. Er bleibt auf Apple Maps bestehen: Spätere Aktualisierungen werden über das Apple Business Connect-Konto von ListingsAPI veröffentlicht, und Apple überprüft die Einreichung vor der Veröffentlichung. Um wieder über das Konto des Inhabers zu veröffentlichen, senden Sie ihm einen neuen Link aus OAuth-Verbindungs-URL für einen einzelnen Standort erstellen.

Dieser Endpunkt ändert eine aktive Verbindung. Die oben gezeigte Anfrage und Antwort sind Beispiele.

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