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

Elenca i suggerimenti di collegamento

Restituisce le corrispondenze suggerite tra le sedi di Listings API e le schede di Google Business Profile o Facebook per un account collegato.

Richiede una chiave API. Consulta Autenticazione per il formato dell’header e la rotazione delle chiavi.

Parametri

Percorso

NomeTipoObbligatorioDescrizione
connectedAccountIdstringobbligatorioUUID of the connected account to list suggestions for.

Query

NomeTipoObbligatorioDescrizionePredefinito
pageintegerfacoltativo1-based page number.1
perPageintegerfacoltativoRecords per page.20

Risposte

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.

Restituisce gli abbinamenti suggeriti tra le sedi di Listings API e le schede di Google Business Profile o Facebook rilevati eseguendo i trigger di corrispondenza sull'account collegato. Ogni record mostra sia i dettagli della sede di Listings API sia la scheda corrispondente sulla piattaforma di pubblicazione, in modo che un operatore possa confrontarli prima di confermare.

I suggerimenti vengono generati in modo asincrono da POST /connected-accounts/trigger-matches. Se hai appena collegato un account, chiama prima trigger-matches, altrimenti records è vuoto e pageInfo.totalRecords è 0. (Quando viene eseguito su un account reale appena collegato per il quale non ci sono ancora corrispondenze, questo endpoint restituisce {"data":{"connectionSuggestionsForAccount":{"pageInfo":{"hasNextPage":false,"hasPreviousPage":false,"totalPages":0,"totalRecords":0},"records":[]}}}.) L'esempio sopra mostra la struttura di un record popolato.

Caso d'uso: flusso di verifica prima della conferma. Dopo aver importato l'account Google di un cliente, interroga periodicamente questo endpoint per visualizzare ogni corrispondenza suggerita nella tua interfaccia di verifica. Un operatore approva gli abbinamenti corretti e tu passi gli ID dei record approvati a POST /connected-accounts/confirm-matches.

Identificazione di un record. Un record di suggerimento non ha un campo id. Il suo identificatore è matchedDataDatabaseId, la chiave primaria del record di corrispondenza sottostante; accountType indica di quale tipo di record di corrispondenza si tratta (GMB, FB o APPLE). Conferma le corrispondenze richiede entrambi i valori per costruire l'id che accetta, quindi mantieni insieme la coppia quando prepari i suggerimenti per la verifica.

Paginazione e limiti di frequenza. Usa i parametri di query non annidati page e perPage per la paginazione (ad esempio ?page=2&perPage=50) e tieni d'occhio pageInfo.hasNextPage. Non esistono parametri pageInfo, filters, sortBy o accountId: l'account collegato è ricavato dal percorso, l'ordinamento è fisso e crescente in base alle informazioni sulla sede e qualsiasi altro parametro che invii viene ignorato anziché rifiutato. Questo endpoint è soggetto a limiti di frequenza come gli altri endpoint di elenco; quando ricevi 429, rallenta e riprova dopo l'intervallo indicato dal valore dell'header Retry-After, anziché aumentare la frequenza delle interrogazioni.

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