Synup
Créer une clé
v1Ressources/Connexions/postCréer des fiches Google

Créer des fiches Google

Met en file d'attente un nouveau Google Business Profile pour chaque établissement de la sélection qui peut en recevoir un. C'est la version API de Créer des fiches Google dans Location Manager, et la dernière étape du flux : appelez preview avec locationIds pour voir l'état de préparation et les identifiants utilisables, listez les groupes d'un identifiant avec destinations, rappelez preview avec accountConnectionId et googleAccountName jusqu'à ce que canSubmit soit true, puis envoyez le même body ici. Tout est vérifié à nouveau lors de cet appel, un aperçu antérieur ne fait donc pas foi. Les établissements à l'état ready ou review sont mis en file d'attente, les autres reviennent dans skipped. confirmedNoExistingProfiles doit valoir true, sinon la requête renvoie 400. Un 202 signifie que le travail est en file d'attente, pas que les profils existent déjà : la création s'exécute en arrière-plan et peut être relancée ou échouer, interrogez donc l'endpoint de statut. Renvoie 409 lorsque l'identifiant ou le groupe n'est pas utilisable pour cette sélection, ou lorsqu'aucun des établissements ne peut être créé.

post/api/v1/connections/google-listing-create
connections:write
Corps de la requête
locationIdsarray of stringobligatoire
Les ids des établissements à traiter, 200 au maximum. Les doublons sont ignorés.
accountConnectionIdstringobligatoire
Le connectionId de l'identifiant Google sous lequel créer, issu de accounts dans la réponse de preview. Obligatoire pour destinations et create. Facultatif pour preview, où vous l'envoyez avec googleAccountName pour vérifier une destination.
googleAccountNamestringobligatoire
Le resourceName du groupe Google dans lequel créer les fiches, par exemple accounts/123456789, issu de la réponse de destinations. Obligatoire pour create. Facultatif pour preview.
confirmedNoExistingProfilesboolean (true)obligatoire
Doit valoir true. Confirme que ces entreprises ont besoin de nouveaux profils Google et n'en ont pas encore. Toute autre valeur renvoie 400.
Réponse
dataobjectfacultatif
resultsarray of objectfacultatif
Une entrée par établissement que create a tenté de mettre en file d'attente.
locationIdstringfacultatif
L'id de l'établissement.
outcomestring (queued | blocked | failed_to_queue)facultatif
queued (la création est lancée), blocked (elle n'a pas été autorisée, voir reason) ou failed_to_queue (un problème est survenu de notre côté, réessayez).
connectionIdstringfacultatif
La nouvelle connexion Google en attente de l'établissement. Présent uniquement avec queued.
orderItemIdstringfacultatif
L'id de la commande qui exécute la création. Présent uniquement avec queued.
reasonstringfacultatif
Pourquoi l'établissement n'a pas été mis en file d'attente : submission_not_allowed, un code de limite de forfait (feature_disabled, location_limit, connection_limit, cancellation_pending ou entitlement) ou internal_error. Absent avec queued.
skippedarray of objectfacultatif
Établissements sélectionnés non mis en file d'attente parce qu'ils sont exclus ou à corriger, avec les mêmes champs que locations dans la réponse de preview.
locationIdstringfacultatif
L'id de l'établissement.
clientIdstringfacultatif
Le client auquel appartient l'établissement, ou null.
namestringfacultatif
La raison sociale de l'établissement, ou null.
statestring (ready | review | needs_attention | excluded)facultatif
ready (peut être créé), review (peut être créé, mais vérifiez-le d'abord car Google a peut-être déjà un profil pour lui), needs_attention (corrigez l'établissement puis rappelez preview) ou excluded (ne recevra pas de nouvelle fiche Google).
reasonsarray of string (archived | already_connected | creating | needs_reconnection | google_excluded_by_package | opted_out | missing_business_name | missing_google_category | missing_address | possible_existing_profile | previously_connected)facultatif
Pourquoi l'établissement est dans cet état. Exclu : archived, already_connected, creating (une création est déjà en cours), needs_reconnection (lié à une fiche Google dont l'accès a expiré), google_excluded_by_package (Google ne fait pas partie du forfait de fiches de l'établissement) ou opted_out. À corriger : missing_business_name, missing_google_category ou missing_address (ni rue, ni ville, ni pays, et aucune zone desservie). À vérifier : possible_existing_profile (une fiche Google trouvée sous l'un de vos identifiants correspond à cet établissement) ou previously_connected (l'établissement a déjà été lié à Google puis déconnecté). Vide pour un établissement à l'état ready.
unavailableIdsarray of stringfacultatif
Ids d'établissements demandés introuvables ou auxquels vous n'avez pas accès. Ils sont listés ici au lieu de faire échouer la requête.
Erreurs
400Il manque un paramètre requis à la requête, ou elle est invalide.
401Clé API manquante, invalide, expirée ou révoquée.
403La clé n'a pas la permission requise, ou n'est pas autorisée pour ce client/établissement.
404La ressource est introuvable, ou n'appartient pas à votre agence.
409Rien n'a été mis en file d'attente. Le code de la réponse est invalid_destination lorsque l'identifiant ou le groupe n'est pas utilisable pour cette sélection, ou invalid_request lorsqu'aucun des établissements sélectionnés ne peut être créé. Appelez preview pour en connaître la raison.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
502Google n'a pas pu être joint pour lire les groupes de l'identifiant. Réessayez plus tard. Le code de la réponse est provider_unavailable.
post/api/v1/connections/google-listing-create
Votre clé API
Corps de la requête*
{}

Guides qui utilisent cette ressource