/api/v4/connected-accounts/trigger-matchesAvvia l'abbinamento delle sedi
Recupera i profili Google e Facebook degli account collegati e li abbina alle tue sedi in Listings API.
Parametri
Corpo
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| input | object | obbligatorio | Wrapper object. The entire request body must be nested under `input`. |
| input.connectedAccountIds | array of strings | obbligatorio | UUIDs of the connected accounts to trigger matches for. Taken from `GET /connected-accounts`. |
Richiesta di esempio
Corpo pronto da incollare. Sostituisci gli ID e i valori segnaposto con i tuoi.
{ "input": { "connectedAccountIds": [ "4f712c17-4f95-42dd-90f4-97171a2e67b5" ] }}Risposte
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.
Avvia il processo asincrono che recupera tutti i profili Google Business Profile e Facebook a cui gli account collegati specificati possono accedere e li abbina alle tue sedi in Listings API. Una risposta success: true indica che il processo è stato inserito in coda; l'abbinamento vero e proprio viene eseguito in background.
Struttura della richiesta. Il corpo deve essere racchiuso in un oggetto input contenente connectedAccountIds, un array degli account collegati per cui eseguire l'abbinamento. L'invio di un corpo piatto, non racchiuso nell'oggetto, viene rifiutato con uno stato HTTP 400. Ottieni gli ID degli account da GET /connected-accounts. Quando non è possibile inserire in coda uno o più account, i relativi ID vengono restituiti in failedIds e success è false.
Caso d'uso: aggiornare i suggerimenti dopo aver collegato un nuovo account. Subito dopo che un cliente ha completato il flusso di collegamento a Google, chiama trigger-matches con il valore connectedAccountId di quell'account. Questo popola gli abbinamenti suggeriti per le sedi, così la tua interfaccia di onboarding può mostrare "abbiamo trovato N delle tue schede" senza che il cliente debba attendere una sincronizzazione pianificata.
Caso d'uso: ripetere l'abbinamento dopo aver aggiunto sedi. Quando crei in blocco nuove sedi in Listings API per un account collegato esistente, avvia una nuova esecuzione dell'abbinamento affinché le nuove sedi vengano abbinate alle rispettive schede Google/Facebook esistenti.
Poiché l'elaborazione è asincrona, non interpretare 200 come "abbinamento completato". Interroga periodicamente l'endpoint dei dettagli dell'account collegato e attendi che requestMatchesStatus raggiunga MATCH_COMPLETED, quindi leggi i risultati dall'endpoint connection-suggestions prima di chiamare confirm-matches o connect-listing.
Questo endpoint mette in coda un recupero di dati in tempo reale da Google/Facebook. La struttura della richiesta e la risposta di esempio riportate sopra sono documentate sulla base della specifica API; la chiamata non viene eseguita sui dati di produzione.
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" ] } }'