/api/v4/connected-accounts/{connectedAccountId}/connection-suggestionsLister les suggestions de connexion
Renvoie les correspondances suggérées entre les établissements Listings API et les fiches Google Business Profile ou Facebook pour un compte connecté.
Paramètres
Chemin
| Nom | Type | Obligatoire | Description |
|---|---|---|---|
| connectedAccountId | string | obligatoire | UUID of the connected account to list suggestions for. |
Chaîne de requête
| Nom | Type | Obligatoire | Description | Par défaut |
|---|---|---|---|---|
| page | integer | facultatif | 1-based page number. | 1 |
| perPage | integer | facultatif | Records per page. | 20 |
Réponses
200Paginated list of connection suggestions.
{ "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.
Renvoie les associations suggérées entre les établissements Listings API et les fiches Google Business Profile ou Facebook, détectées en exécutant les déclencheurs de correspondance sur le compte connecté. Chaque enregistrement présente à la fois les détails de l'établissement Listings API et la fiche correspondante sur la plateforme de publication, afin qu'un opérateur puisse les comparer avant de confirmer.
Les suggestions sont générées de manière asynchrone par POST /connected-accounts/trigger-matches. Si vous venez de connecter un compte, appelez d'abord trigger-matches ; sinon, records est vide et pageInfo.totalRecords vaut 0. (Lorsqu'il est appelé en conditions réelles pour un compte fraîchement connecté qui n'a encore aucune correspondance, cet endpoint renvoie {"data":{"connectionSuggestionsForAccount":{"pageInfo":{"hasNextPage":false,"hasPreviousPage":false,"totalPages":0,"totalRecords":0},"records":[]}}}.) L'exemple ci-dessus montre la structure d'un enregistrement contenant des données.
Cas d'utilisation : workflow d'examen avant confirmation. Après avoir importé le compte Google d'un client, interrogez régulièrement cet endpoint pour afficher chaque correspondance suggérée dans votre propre interface d'examen. Un opérateur approuve les associations correctes, puis vous transmettez les identifiants des enregistrements approuvés à POST /connected-accounts/confirm-matches.
Identification d'un enregistrement. Un enregistrement de suggestion ne possède pas de champ id. Son identifiant est matchedDataDatabaseId, la clé primaire de l'enregistrement de correspondance sous-jacent ; accountType vous indique le type d'enregistrement de correspondance dont il s'agit (GMB, FB ou APPLE). Confirmer les correspondances a besoin des deux valeurs pour construire l'identifiant attendu ; conservez donc ces deux valeurs ensemble lorsque vous préparez les suggestions pour examen.
Pagination et limites de débit. Parcourez les pages à l'aide des paramètres de requête non imbriqués page et perPage (par exemple ?page=2&perPage=50) et surveillez pageInfo.hasNextPage. Il n'existe aucun paramètre pageInfo, filters, sortBy ou accountId : le compte connecté est déterminé par le chemin, le tri est fixé à l'ordre croissant selon les informations de l'établissement, et tout autre paramètre que vous envoyez est ignoré plutôt que rejeté. Cet endpoint est soumis à une limite de débit, comme les autres endpoints de liste ; en cas de 429, espacez vos requêtes et réessayez après le délai indiqué par la valeur de l'en-tête Retry-After, plutôt que de raccourcir l'intervalle entre vos interrogations.
curl -X GET 'https://listingsapi.com/api/v4/connected-accounts/<connectedAccountId>/connection-suggestions' \ -H "Authorization: API $LISTINGSAPI_KEY"