/api/v4/connected-accounts/trigger-matchesAcionar a correspondência de locais
Busca os perfis do Google e do Facebook das contas conectadas e identifica correspondências com seus locais na Listings API.
Parâmetros
Corpo
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| input | object | obrigatório | Wrapper object. The entire request body must be nested under `input`. |
| input.connectedAccountIds | array of strings | obrigatório | UUIDs of the connected accounts to trigger matches for. Taken from `GET /connected-accounts`. |
Exemplo de requisição
Corpo pronto para colar. Substitua os IDs e valores de exemplo pelos seus.
{ "input": { "connectedAccountIds": [ "4f712c17-4f95-42dd-90f4-97171a2e67b5" ] }}Respostas
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`.
{ "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.
Inicia a tarefa assíncrona que recupera todos os perfis do Google Business Profile e do Facebook aos quais as contas conectadas especificadas têm acesso e identifica correspondências com seus locais na Listings API. Uma resposta success: true significa que a tarefa foi colocada na fila; a identificação das correspondências é executada em segundo plano.
Estrutura da requisição. O corpo deve estar encapsulado em um objeto input que contenha connectedAccountIds, um array das contas conectadas para as quais serão identificadas correspondências. O envio de um corpo sem esse encapsulamento é rejeitado com HTTP 400. Obtenha os IDs das contas em GET /connected-accounts. Quando não for possível colocar uma ou mais contas na fila, seus IDs serão retornados em failedIds e success será false.
Caso de uso: atualizar sugestões após conectar uma nova conta. Imediatamente após um cliente concluir o fluxo de conexão com o Google, chame trigger-matches com o connectedAccountId dessa conta. Isso preenche as sugestões de correspondência de locais para que sua interface de integração inicial possa mostrar "encontramos N das suas listagens" sem que o cliente precise esperar por uma sincronização agendada.
Caso de uso: executar novamente a identificação de correspondências após adicionar locais. Quando você criar em lote novos locais na Listings API para uma conta conectada existente, acione uma nova execução da identificação de correspondências para que os novos locais sejam associados às respectivas listagens existentes no Google/Facebook.
Como o trabalho é assíncrono, não interprete 200 como "identificação de correspondências concluída". Consulte periodicamente o endpoint de detalhes da conta conectada e aguarde até que requestMatchesStatus atinja MATCH_COMPLETED; em seguida, leia os resultados do endpoint connection-suggestions antes de chamar confirm-matches ou connect-listing.
Este endpoint coloca na fila uma busca em tempo real no Google/Facebook. A estrutura da requisição e a resposta de exemplo acima são documentadas com base na especificação da API; a chamada não é executada com dados de produção.
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" ] } }'