/api/v4/connected-accounts/trigger-matchesDéclencher la mise en correspondance des établissements
Récupère les profils Google et Facebook des comptes connectés et les met en correspondance avec vos établissements Listings API.
Paramètres
Corps
| Nom | Type | Obligatoire | Description |
|---|---|---|---|
| input | object | obligatoire | Wrapper object. The entire request body must be nested under `input`. |
| input.connectedAccountIds | array of strings | obligatoire | UUIDs of the connected accounts to trigger matches for. Taken from `GET /connected-accounts`. |
Exemple de requête
Corps prêt à coller. Remplacez les identifiants et valeurs d’exemple par les vôtres.
{ "input": { "connectedAccountIds": [ "4f712c17-4f95-42dd-90f4-97171a2e67b5" ] }}Réponses
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.
Lance la tâche asynchrone qui récupère tous les profils Google Business Profile et Facebook auxquels les comptes connectés spécifiés ont accès et les met en correspondance avec vos établissements Listings API. Une réponse success: true signifie que la tâche a été mise en file d'attente ; la mise en correspondance elle-même s'exécute en arrière-plan.
Structure de la requête. Le corps doit être encapsulé dans un objet input contenant connectedAccountIds, un tableau des comptes connectés à mettre en correspondance. L'envoi d'un corps à plat, non encapsulé, est rejeté avec un statut HTTP 400. Récupérez les identifiants des comptes via GET /connected-accounts. Lorsqu'un ou plusieurs comptes ne peuvent pas être mis en file d'attente, leurs identifiants sont renvoyés dans failedIds et success vaut false.
Cas d'utilisation : actualiser les suggestions après la connexion d'un nouveau compte. Dès qu'un client termine le parcours de connexion à Google, appelez trigger-matches avec le connectedAccountId de ce compte. Cela renseigne les correspondances suggérées pour les établissements afin que votre interface d'intégration puisse afficher « nous avons trouvé N de vos fiches » sans que le client ait à attendre une synchronisation planifiée.
Cas d'utilisation : relancer la mise en correspondance après l'ajout d'établissements. Lorsque vous créez en masse de nouveaux établissements Listings API pour un compte connecté existant, déclenchez une nouvelle mise en correspondance afin que les nouveaux établissements soient associés à leurs fiches Google/Facebook existantes.
Comme le traitement est asynchrone, ne considérez pas 200 comme signifiant que « la mise en correspondance est terminée ». Interrogez régulièrement le point de terminaison des détails du compte connecté et attendez que requestMatchesStatus atteigne MATCH_COMPLETED, puis consultez les résultats via le point de terminaison connection-suggestions avant d'appeler confirm-matches ou connect-listing.
Ce point de terminaison met en file d'attente une récupération de données en direct auprès de Google/Facebook. La structure de la requête et l'exemple de réponse ci-dessus sont documentés à partir de la spécification de l'API ; l'appel n'est pas exécuté sur les données de production.
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" ] } }'