Synup
Créer une clé
v1Ressources/Connexions/postAperçu de la création de fiches Google

Aperçu de la création de fiches Google

Vérifie si chaque établissement de la sélection peut recevoir une nouvelle fiche Google, sans rien créer ni enregistrer. Le flux commence ici : envoyez seulement locationIds pour obtenir l'état de préparation de chaque établissement et, dans accounts, les identifiants Google qui peuvent créer pour tous les clients de la sélection. Après avoir choisi un groupe avec l'endpoint destinations, rappelez preview avec accountConnectionId et googleAccountName pour vérifier cette destination. Lorsque canSubmit vaut true, envoyez le même body, avec confirmedNoExistingProfiles, à l'endpoint create. Les ids d'établissements auxquels vous n'avez pas accès reviennent dans unavailableIds au lieu de faire échouer la requête. Jusqu'à 200 établissements par requête. La vérification d'un groupe le lit en direct auprès de Google, cet appel peut donc renvoyer 502.

post/api/v1/connections/google-listing-create/preview
connections:read
Corps de la requête
locationIdsarray of stringobligatoire
Les ids des établissements à traiter, 200 au maximum. Les doublons sont ignorés.
accountConnectionIdstringfacultatif
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.
googleAccountNamestringfacultatif
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.
Réponse
dataobjectfacultatif
countsobjectfacultatif
Le nombre d'établissements dans chaque état.
readyintegerfacultatif
Établissements qui peuvent être créés tels quels.
reviewintegerfacultatif
Établissements qui peuvent être créés, mais qu'il vaut mieux vérifier d'abord.
needs_attentionintegerfacultatif
Établissements à corriger avant de pouvoir être créés.
excludedintegerfacultatif
Établissements qui ne recevront pas de nouvelle fiche Google.
unavailableintegerfacultatif
Ids demandés introuvables ou auxquels vous n'avez pas accès.
locationsarray of objectfacultatif
L'état de préparation de chaque établissement demandé auquel vous avez accès.
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.
accountsarray of objectfacultatif
Identifiants Google qui peuvent créer pour tous les clients de la sélection, y compris ceux à reconnecter. Les identifiants de l'agence apparaissent en premier. Vide lorsque tous les établissements sélectionnés sont exclus ou qu'aucun identifiant ne couvre tous les clients.
connectionIdstringfacultatif
L'id de connexion de l'identifiant. Envoyez-le comme accountConnectionId.
displayNamestringfacultatif
Le nom affiché de l'identifiant, généralement l'adresse e-mail du compte Google.
ownerobjectfacultatif
À qui appartient l'identifiant : à l'agence ou à un client.
typestring (agency | client)facultatif
agency pour un identifiant valable pour toute l'agence, client pour un identifiant qui appartient à un seul client.
clientIdstringfacultatif
L'id du client propriétaire de l'identifiant. Présent uniquement lorsque type vaut client.
namestringfacultatif
La raison sociale du client propriétaire de l'identifiant. Présent uniquement lorsque type vaut client.
statusstring (ready | needs_reconnection)facultatif
ready lorsque l'identifiant est utilisable, needs_reconnection lorsque son accès a expiré et que quelqu'un doit d'abord le reconnecter.
noCommonAccountbooleanfacultatif
True lorsque certains établissements pourraient être créés mais qu'aucun identifiant ne couvre tous leurs clients. Répartissez la sélection par client et réessayez.
destinationobjectfacultatif
Le résultat de la vérification de la destination envoyée.
selectedbooleanfacultatif
False lorsque vous n'avez envoyé ni accountConnectionId ni googleAccountName.
validbooleanfacultatif
Indique si l'identifiant et le groupe sont utilisables pour cette sélection. Présent lorsque selected vaut true.
resourceNamestringfacultatif
Le nom de ressource du groupe vérifié. Présent lorsque valid vaut true.
reasonstring (account_unavailable | group_unavailable | group_not_creatable)facultatif
Pourquoi la destination n'est pas utilisable : account_unavailable (l'identifiant ne peut pas créer pour cette sélection ou doit être reconnecté), group_unavailable (le groupe est introuvable sous l'identifiant, ou googleAccountName n'a pas la forme accounts/123456789) ou group_not_creatable (le groupe ne peut pas accueillir de nouvelles fiches). Présent lorsque valid vaut false.
submittableCountintegerfacultatif
Le nombre d'établissements que create mettrait en file d'attente : ready plus review.
canSubmitbooleanfacultatif
True lorsque la destination est valide et qu'au moins un établissement peut être créé.
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.
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/preview
Votre clé API
Corps de la requête*
{}

Guides qui utilisent cette ressource