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

Standortabgleich auslösen

Ruft die Google- und Facebook-Profile für verbundene Konten ab und gleicht sie mit Ihren Standorten in der Listings API ab.

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.connectedAccountIdsarray of stringserforderlichUUIDs of the connected accounts to trigger matches for. Taken from `GET /connected-accounts`.

Beispielanfrage

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

Request body
{  "input": {    "connectedAccountIds": [      "4f712c17-4f95-42dd-90f4-97171a2e67b5"    ]  }}

Antworten

200Request accepted. `success` is `true` when the fetch-and-match job was queued for every account; accounts that could not be queued are returned in `failedIds` and `success` is `false`.
Response
{  "data": {    "connectedAccountsTriggerMatches": {      "failedIds": null,      "success": true    }  }}
400Bad request, the body was not wrapped in `input` (error message: `Variable "$input" of required type "ConnectedAccountsTriggerMatchesInput!" was not provided`).
401Unauthenticated, missing or invalid API key.

Startet den asynchronen Auftrag, der alle Google Business Profile und Facebook-Profile abruft, auf die die angegebenen verbundenen Konten zugreifen können, und sie mit Ihren Standorten in der Listings API abgleicht. Eine success: true-Antwort bedeutet, dass der Auftrag in die Warteschlange aufgenommen wurde; der eigentliche Abgleich läuft im Hintergrund.

Anfragestruktur. Der Body muss in ein input-Objekt eingebettet sein, das connectedAccountIds enthält, ein Array der verbundenen Konten, für die der Abgleich durchgeführt werden soll. Ein flacher, nicht eingebetteter Body wird mit HTTP 400 abgelehnt. Rufen Sie die Konto-IDs über GET /connected-accounts ab. Wenn ein oder mehrere Konten nicht in die Warteschlange aufgenommen werden können, werden ihre IDs in failedIds zurückgegeben und success ist false.

Anwendungsfall: Vorschläge nach dem Verbinden eines neuen Kontos aktualisieren. Rufen Sie unmittelbar nachdem ein Kunde den Ablauf zum Verbinden mit Google abgeschlossen hat trigger-matches mit dem connectedAccountId dieses Kontos auf. Dadurch werden die vorgeschlagenen Standortzuordnungen bereitgestellt, sodass Ihre Onboarding-Oberfläche „Wir haben N Ihrer Einträge gefunden“ anzeigen kann, ohne dass der Kunde auf eine geplante Synchronisierung warten muss.

Anwendungsfall: Abgleich nach dem Hinzufügen von Standorten erneut ausführen. Wenn Sie für ein bestehendes verbundenes Konto mehrere neue Standorte in der Listings API auf einmal erstellen, lösen Sie einen neuen Abgleich aus, damit die neuen Standorte ihren bestehenden Google-/Facebook-Einträgen zugeordnet werden.

Da die Verarbeitung asynchron erfolgt, dürfen Sie 200 nicht als „Abgleich abgeschlossen“ interpretieren. Fragen Sie den Endpunkt für die Details des verbundenen Kontos wiederholt ab und warten Sie, bis requestMatchesStatus den Wert MATCH_COMPLETED erreicht, und lesen Sie dann die Ergebnisse vom connection-suggestions-Endpunkt, bevor Sie confirm-matches oder connect-listing aufrufen.

Dieser Endpunkt stellt einen Live-Abruf bei Google/Facebook in die Warteschlange. Die oben gezeigte Anfragestruktur und Beispielantwort sind anhand der API-Spezifikation dokumentiert; der Aufruf wird nicht mit Produktionsdaten ausgeführt.

Request
curl -X POST 'https://listingsapi.com/api/v4/connected-accounts/trigger-matches' \  -H "Authorization: API $LISTINGSAPI_KEY" \  -H 'Content-Type: application/json' \  -d '{    "input": {      "connectedAccountIds": [        "4f712c17-4f95-42dd-90f4-97171a2e67b5"      ]    }  }'