/api/v4/connected-accounts/{connectedAccountId}/connection-suggestionsListar sugestões de conexão
Retorna correspondências sugeridas entre locais da Listings API e listagens do Google Business Profile ou do Facebook para uma conta conectada.
Parâmetros
Caminho
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| connectedAccountId | string | obrigatório | UUID of the connected account to list suggestions for. |
Query
| Nome | Tipo | Obrigatório | Descrição | Padrão |
|---|---|---|---|---|
| page | integer | opcional | 1-based page number. | 1 |
| perPage | integer | opcional | Records per page. | 20 |
Respostas
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.
Retorna associações sugeridas entre locais da Listings API e listagens do Google Business Profile ou do Facebook detectadas pela execução de gatilhos de correspondência na conta conectada. Cada registro mostra tanto os detalhes do local da Listings API quanto a listagem correspondente da plataforma de publicação, para que um operador possa compará-los antes de confirmar.
As sugestões são geradas de forma assíncrona por POST /connected-accounts/trigger-matches. Se você acabou de conectar uma conta, chame trigger-matches primeiro; caso contrário, records estará vazio e pageInfo.totalRecords será 0. (Quando executado em ambiente real para uma conta recém-conectada que ainda não tem correspondências, este endpoint retorna {"data":{"connectionSuggestionsForAccount":{"pageInfo":{"hasNextPage":false,"hasPreviousPage":false,"totalPages":0,"totalRecords":0},"records":[]}}}.) O exemplo acima mostra a estrutura de um registro preenchido.
Caso de uso: fluxo de avaliação antes da confirmação. Após importar a conta do Google de um cliente, consulte este endpoint periodicamente para exibir cada correspondência sugerida na sua própria interface de avaliação. Um operador aprova as associações corretas, e você passa os IDs dos registros aprovados para POST /connected-accounts/confirm-matches.
Identificação de um registro. Um registro de sugestão não tem o campo id. Seu identificador é matchedDataDatabaseId, a chave primária do registro de correspondência subjacente; accountType informa o tipo de registro de correspondência (GMB, FB ou APPLE). Confirmar correspondências precisa dos dois valores para construir o id que recebe, portanto mantenha o par junto ao preparar sugestões para avaliação.
Paginação e limites de taxa. Use os parâmetros de consulta page e perPage, sem aninhamento, para paginar (por exemplo, ?page=2&perPage=50) e monitore pageInfo.hasNextPage. Não há parâmetro pageInfo, filters, sortBy ou accountId: a conta conectada é determinada pelo caminho, a ordenação é fixa em ordem crescente das informações do local, e qualquer outro parâmetro que você enviar será ignorado em vez de rejeitado. Este endpoint está sujeito a limites de taxa, assim como outros endpoints de listagem; ao receber 429, aguarde o intervalo indicado pelo valor do cabeçalho Retry-After antes de tentar novamente, em vez de reduzir o intervalo entre as consultas periódicas.
curl -X GET 'https://listingsapi.com/api/v4/connected-accounts/<connectedAccountId>/connection-suggestions' \ -H "Authorization: API $LISTINGSAPI_KEY"