POST/api/v4/connected-accounts/confirm-matches

Verbindungszuordnungen bestätigen

Bestätigt vorgeschlagene Zuordnungen zwischen Standorten und Einträgen, die vom Endpunkt für Verbindungsvorschläge zurückgegeben werden.

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.matchRecordIdsarray of stringserforderlichMatch-record global IDs to confirm: the standard base64 of `<MatchRecordType>:<matchedDataDatabaseId>`, built from a connection-suggestion record. At least one ID is required.

Beispielanfrage

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

Request body
{  "input": {    "matchRecordIds": [      "R21iTG9jYXRpb25NYXRjaGVkRGF0YTowZDVlMzA2Zi0wZGEwLTQ2ZTMtOTI5Zi1mZDNjNjdjY2Q4Y2M="    ]  }}

Antworten

200Request accepted. `success` is `true` when every match was confirmed; when some IDs could not be confirmed they are listed in `failedIds` and `success` is `false`.
Response
{  "data": {    "confirmConnectMatches": {      "failedIds": null,      "success": true    }  }}
400Bad request, the body was not wrapped in `input`, `matchRecordIds` was omitted (error message: `Field value.matchRecordIds of required type [ID!]! was not provided`), or `input` carried a field the endpoint does not accept.
401Unauthenticated, missing or invalid API key.

Akzeptiert vorgeschlagene Zuordnungen zwischen Standorten und Einträgen und bestätigt sie, wodurch die aktive Verbindung zwischen Listings API-Standorten und ihren entsprechenden Google Business Profile- oder Facebook-Einträgen hergestellt wird. Nach der Bestätigung beginnt die Synchronisierung des Eintrags mit dem zugeordneten Listings API-Standort.

Anfragestruktur. Der Body muss in ein input-Objekt eingebettet sein, und das einzige akzeptierte Feld ist matchRecordIds, ein Array von Zuordnungsdatensatz-IDs ([ID!]!, erforderlich). Ein flacher (nicht eingebetteter) Body wird mit HTTP 400 abgelehnt, ebenso wie ein unbekanntes Feld innerhalb von input, etwa connectedAccountId oder das ältere matchIds (Unknown field "connectedAccountId"). Ein zusätzlicher Schlüssel außerhalb von input wird ignoriert und führt nicht zur Ablehnung. Diese Anfrage enthält kein connectedAccountId-Feld; das Konto wird aus den Zuordnungsdatensätzen selbst abgeleitet.

Einen matchRecordIds-Wert erstellen. Ein Datensatz für einen Verbindungsvorschlag hat kein id. Nehmen Sie dessen matchedDataDatabaseId und accountType, verbinden Sie sie mit einem Doppelpunkt hinter dem Namen des Zuordnungsdatensatztyps und kodieren Sie das Ergebnis mit Base64:

accountTypeZuordnungsdatensatztyp
GMBGmbLocationMatchedData
FBFbLocationMatchedData
APPLEAppleLocationMatchedData
Python
import base64 TYPES = {    "GMB": "GmbLocationMatchedData",    "FB": "FbLocationMatchedData",    "APPLE": "AppleLocationMatchedData",} def match_record_id(record):    raw = f"{TYPES[record['accountType']]}:{record['matchedDataDatabaseId']}"    return base64.b64encode(raw.encode()).decode()

Eine ID, die sich nicht zu einem dieser drei Typen dekodieren lässt, erzeugt kein 400. Der Aufruf gibt HTTP 200 mit success: false und ohne failedIds zurück. Prüfen Sie daher bei jedem Aufruf success.

Dieser Endpunkt ist der letzte Schritt im Workflow zum gesammelten Verbinden: Verbinden Sie das Konto, führen Sie POST /connected-accounts/trigger-matches aus, um Vorschläge zu generieren, prüfen Sie diese über den Endpunkt für Verbindungsvorschläge und bestätigen Sie anschließend hier die genehmigten Datensätze.

Anwendungsfall: geprüfte Zuordnungen gesammelt akzeptieren. Nachdem eine Agentur das Google-Konto eines Kunden importiert und die vorgeschlagenen Zuordnungen in Ihrer eigenen Benutzeroberfläche geprüft hat, übermitteln Sie die genehmigten matchRecordIds in einem einzigen Aufruf statt in einem Aufruf pro Zuordnung. Senden Sie nur die IDs, die die zuständige Person genehmigt hat, damit ungeprüfte oder falsche Vorschläge unverändert bleiben.

Die Bestätigung einer Zuordnung überträgt nicht sofort Daten an Google oder Facebook; sie verknüpft den Listings API-Standort mit dem Plattform-Eintrag, sodass nachfolgende Aktualisierungen des Eintrags weitergeleitet werden. Ein erfolgreicher Aufruf gibt success: true mit failedIds: null zurück. Wenn eine oder mehrere IDs nicht bestätigt werden konnten (beispielsweise bei einem unbekannten oder bereits verwendeten Zuordnungsdatensatz oder einer Zuordnung, deren Standort inzwischen archiviert wurde), werden diese IDs in failedIds zurückgegeben, und success ist false, sodass Sie es erneut versuchen oder nur die fehlgeschlagenen Zuordnungen anzeigen können. failedIds enthält die dekodierten Datenbank-IDs, nicht die von Ihnen gesendeten kodierten Werte. Gleichen Sie sie daher mit matchedDataDatabaseId ab. Um einen einzelnen Eintrag manuell auszuwählen, ohne Vorschläge zu durchlaufen, verwenden Sie stattdessen den Endpunkt zum Verbinden eines Eintrags.

Request
curl -X POST 'https://listingsapi.com/api/v4/connected-accounts/confirm-matches' \  -H "Authorization: API $LISTINGSAPI_KEY" \  -H 'Content-Type: application/json' \  -d '{    "input": {      "matchRecordIds": [        "R21iTG9jYXRpb25NYXRjaGVkRGF0YTowZDVlMzA2Zi0wZGEwLTQ2ZTMtOTI5Zi1mZDNjNjdjY2Q4Y2M="      ]    }  }'