GET/api/v4/connected-accounts/{connectedAccountId}/connection-suggestions

Verbindungsvorschläge auflisten

Liefert Zuordnungsvorschläge zwischen Listings API-Standorten und Google Business Profile- oder Facebook-Einträgen für ein verbundenes Konto.

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

Parameter

Pfad

NameTypErforderlichBeschreibung
connectedAccountIdstringerforderlichUUID of the connected account to list suggestions for.

Query

NameTypErforderlichBeschreibungStandard
pageintegeroptional1-based page number.1
perPageintegeroptionalRecords per page.20

Antworten

200Paginated list of connection suggestions.
Response
{  "data": {    "connectionSuggestionsForAccount": {      "pageInfo": {        "hasNextPage": false,        "hasPreviousPage": false,        "totalPages": 1,        "totalRecords": 2      },      "records": [        {          "accountEmail": "contact@brightsmile-dental.com",          "accountType": "GMB",          "connectedAccountId": "4f712c17-4f95-42dd-90f4-97171a2e67b5",          "locationId": "73415",          "matchedDataDatabaseId": "0d5e306f-0da0-46e3-929f-fd3c67ccd8cc",          "locationInfo": {            "name": "My Business",            "city": "Lincoln",            "stateIso": "NE"          },          "suggestedLocationInfo": {            "locationInfo": { "name": "My Business", "city": "Lincoln" }          }        }      ]    }  }}
401Unauthenticated, missing or invalid API key.
429Rate limit exceeded. Retry after the `Retry-After` header value.

Gibt vorgeschlagene Zuordnungen zwischen Standorten in der Listings API und Einträgen in Google Business Profile oder Facebook zurück, die durch das Ausführen von Zuordnungstriggern für das verbundene Konto ermittelt wurden. Jeder Datensatz zeigt sowohl die Standortdetails aus der Listings API als auch den zugeordneten Plattformeintrag, damit ein Bediener sie vor der Bestätigung vergleichen kann.

Vorschläge werden asynchron durch POST /connected-accounts/trigger-matches generiert. Wenn Sie gerade ein Konto verbunden haben, rufen Sie zuerst trigger-matches auf, andernfalls ist records leer und pageInfo.totalRecords ist 0. (Bei einem Live-Aufruf für ein neu verbundenes Konto, für das noch keine Zuordnungen vorliegen, gibt dieser Endpunkt {"data":{"connectionSuggestionsForAccount":{"pageInfo":{"hasNextPage":false,"hasPreviousPage":false,"totalPages":0,"totalRecords":0},"records":[]}}} zurück.) Das obige Beispiel zeigt die Struktur eines ausgefüllten Datensatzes.

Anwendungsfall: Ablauf mit Prüfung vor der Bestätigung. Fragen Sie nach dem Import des Google-Kontos eines Kunden diesen Endpunkt regelmäßig ab, um jede vorgeschlagene Zuordnung in Ihrer eigenen Prüfoberfläche anzuzeigen. Eine zuständige Person genehmigt die korrekten Zuordnungen, und Sie übergeben die IDs der genehmigten Datensätze an POST /connected-accounts/confirm-matches.

Identifizierung eines Datensatzes. Ein Vorschlagsdatensatz hat kein Feld id. Sein Bezeichner ist matchedDataDatabaseId, der Primärschlüssel des zugrunde liegenden Zuordnungsdatensatzes; accountType gibt an, um welche Art von Zuordnungsdatensatz es sich handelt (GMB, FB oder APPLE). Zuordnungen bestätigen benötigt beide Werte, um die erwartete id zu bilden. Halten Sie dieses Wertepaar daher zusammen, wenn Sie Vorschläge zur Bewertung bereitstellen.

Paginierung und Ratenbegrenzungen. Verwenden Sie zur Paginierung die flachen Abfrageparameter page und perPage (zum Beispiel ?page=2&perPage=50) und beachten Sie pageInfo.hasNextPage. Es gibt keine Parameter pageInfo, filters, sortBy oder accountId: Das verbundene Konto wird über den Pfad bestimmt, die Sortierung ist fest auf aufsteigende Standortinformationen eingestellt, und alle weiteren übermittelten Parameter werden ignoriert statt abgelehnt. Für diesen Endpunkt gelten wie für andere Listenendpunkte Ratenbegrenzungen; warten Sie bei 429 die im Header Retry-After angegebene Zeit ab, bevor Sie es erneut versuchen, anstatt die Abfrageintervalle zu verkürzen.

Request
curl -X GET 'https://listingsapi.com/api/v4/connected-accounts/<connectedAccountId>/connection-suggestions' \  -H "Authorization: API $LISTINGSAPI_KEY"