POST/api/v4/connected-accounts/connect-listing

Einen Eintrag mit einem Standort verknüpfen

Verknüpft einen bestimmten Google Business Profile- oder Facebook-Eintrag mit einem Standort in der Listings API.

Erfordert einen API-Schlüssel. Format des Headers und Schlüsselrotation finden Sie unter Authentifizierung.

Parameter

Body

NameTypErforderlichBeschreibung
inputobjecterforderlichWrapper object. The entire request body must be nested under `input`.
input.locationIdstringerforderlichBase64-encoded location Relay ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`) of the Listings API location to link the listing to.
input.connectedAccountIdstringerforderlichID of the connected account (Google or Facebook) that owns the listing. Taken from `GET /connected-accounts`.
input.connectedAccountListingIdstringerforderlichID of the listing within that connected account to link. Taken from the `id` of a record returned by `POST /connected-accounts/connected-account-listings`.

Beispielanfrage

Body zum direkten Einfügen. Ersetzen Sie Platzhalter-IDs und -Werte durch Ihre eigenen.

Request body
{  "input": {    "locationId": "TG9jYXRpb246MTgwMDI4OQ==",    "connectedAccountId": "4f712c17-4f95-42dd-90f4-97171a2e67b5",    "connectedAccountListingId": "R29vZ2xlTG9jYXRpb246ODc3NTkzNGItNTA5OC00ZDBhLThiNDQ="  }}

Antworten

200Request accepted. `success` is `true` when the listing was linked; when it cannot be linked `success` is `false` and `message` explains why (for example, `Listing record not found`).
Response
{  "data": {    "connectListing": {      "message": null,      "success": true    }  }}
400Bad request, the body was not wrapped in `input`, or a required field was omitted. Note the field is `connectedAccountListingId`, not `listingId` (the API rejects `listingId` with `did you mean locationId?`).
401Unauthenticated, missing or invalid API key.

Verknüpft einen Plattform-Eintrag (Google Business Profile oder Facebook-Seite) mit einem Standort in der Listings API, damit die Eintragsdaten synchron bleiben. Anders als beim vorschlagsbasierten Ablauf verknüpft dieser Endpunkt einen einzelnen Eintrag, den Sie bereits ausgewählt haben, ohne dass Sie die Zuordnung bestätigen müssen.

Anfragestruktur. Der Body muss in ein input-Objekt mit drei Pflichtfeldern eingebettet sein: locationId (die base64-codierte Relay ID des Standorts), connectedAccountId (das Konto, dem der Eintrag gehört) und connectedAccountListingId (der zu verknüpfende Eintrag). Es gibt kein Feld listingId; es wird vom Schema abgelehnt. Rufen Sie connectedAccountId aus GET /connected-accounts und connectedAccountListingId aus dem Feld id eines von POST /connected-accounts/connected-account-listings zurückgegebenen Datensatzes ab.

Anwendungsfall: manuelle Verknüpfung bei mehrdeutiger automatischer Zuordnung. Zwei nahe beieinanderliegende Geschäfte haben ähnliche Namen, und trigger-matches kann nicht entscheiden, welcher Google-Eintrag zu welchem Standort in der Listings API gehört. Rufen Sie die Einträge für das verbundene Konto ab, lassen Sie einen Mitarbeiter den richtigen Eintrag auswählen und verknüpfen Sie ihn direkt mit diesem Endpunkt, wobei Sie den Ablauf mit Vorschlägen und Bestätigung vollständig umgehen.

Wenn die Verbindung fehlschlägt, enthält die Antwort success: false mit einem Wert ungleich null für message, der den Grund beschreibt, zum Beispiel Listing record not found, wenn connectedAccountListingId nicht aufgelöst werden kann, oder eine Meldung, dass der Eintrag bereits mit einem anderen Standort verbunden ist. Um stattdessen mehrere vom System vorgeschlagene Zuordnungen auf einmal anzunehmen, verwenden Sie den Endpunkt confirm-matches.

Request
curl -X POST 'https://listingsapi.com/api/v4/connected-accounts/connect-listing' \  -H "Authorization: API $LISTINGSAPI_KEY" \  -H 'Content-Type: application/json' \  -d '{    "input": {      "locationId": "TG9jYXRpb246MTgwMDI4OQ==",      "connectedAccountId": "4f712c17-4f95-42dd-90f4-97171a2e67b5",      "connectedAccountListingId": "R29vZ2xlTG9jYXRpb246ODc3NTkzNGItNTA5OC00ZDBhLThiNDQ="    }  }'