Package google.mybusiness.v4

Index

AccessControl

Ce service permet de gérer les utilisateurs ayant accès aux comptes et aux établissements.

AcceptInvitation

rpc AcceptInvitation(AcceptInvitationRequest) returns (Empty)

Accepte l'invitation spécifiée.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

CreateAccountAdmin

rpc CreateAccountAdmin(CreateAccountAdminRequest) returns (Admin)

Invite l'utilisateur spécifié à devenir administrateur du compte spécifié. La personne invitée doit accepter l'invitation pour pouvoir accéder au compte. Voir [AcceptInvitation] [google.mybusiness.v4.AcceptInvitation] pour accepter une invitation par programmation.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

CreateLocationAdmin

rpc CreateLocationAdmin(CreateLocationAdminRequest) returns (Admin)

Invite l'utilisateur spécifié à devenir administrateur de l'établissement indiqué. La personne invitée doit accepter l'invitation pour pouvoir accéder à l'établissement. Voir [AcceptInvitation] [google.mybusiness.v4.AcceptInvitation] pour accepter une invitation par programmation.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

DeclineInvitation

rpc DeclineInvitation(DeclineInvitationRequest) returns (Empty)

Refuse l'invitation spécifiée.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

DeleteAccountAdmin

rpc DeleteAccountAdmin(DeleteAccountAdminRequest) returns (Empty)

Supprime l'administrateur spécifié du compte indiqué.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

DeleteLocationAdmin

rpc DeleteLocationAdmin(DeleteLocationAdminRequest) returns (Empty)

Supprime l'administrateur spécifié en tant qu'administrateur de l'établissement indiqué.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

ListAccountAdmins

rpc ListAccountAdmins(ListAccountAdminsRequest) returns (ListAccountAdminsResponse)

Répertorie les administrateurs du compte spécifié.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

ListInvitations

rpc ListInvitations(ListInvitationsRequest) returns (ListInvitationsResponse)

Répertorie les invitations en attente pour le compte spécifié.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

ListLocationAdmins

rpc ListLocationAdmins(ListLocationAdminsRequest) returns (ListLocationAdminsResponse)

Liste tous les administrateurs de l'établissement spécifié.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

UpdateAccountAdmin

rpc UpdateAccountAdmin(UpdateAccountAdminRequest) returns (Admin)

Met à jour l'administrateur de l'administrateur de compte spécifié. Seul le rôle AdminRole de l'administrateur peut être mis à jour.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

UpdateLocationAdmin

rpc UpdateLocationAdmin(UpdateLocationAdminRequest) returns (Admin)

Met à jour l'administrateur pour l'administrateur d'établissement spécifié. Seul le rôle AdminRole de l'administrateur peut être mis à jour.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

Comptes

Cette API permet de gérer des comptes professionnels sur Google. Il vous permet de gérer les ressources Account. Il définit le modèle de ressources suivant:

  • L'API comporte une collection de ressources Account, nommée accounts/*.

  • Pour plus de commodité, vous pouvez utiliser l'expression "moi" au lieu de l'ID du compte personnel de l'appelant authentifié. Exemples: GET /v4/accounts/me GET /v4/accounts/me/locations

CreateAccount

rpc CreateAccount(CreateAccountRequest) returns (Account)

Crée un compte avec le nom et le type spécifiés sous le compte parent donné.

  • Vous ne pouvez pas créer de comptes personnels ni d'organisations.
  • Impossible de créer des groupes d'utilisateurs avec un compte personnel défini comme propriétaire principal.
  • Impossible de créer des groupes d'établissements avec le propriétaire principal d'un compte personnel si celui-ci fait partie d'une organisation.
  • Ils ne peuvent pas être propriétaires de groupes d'établissements.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

DeleteNotifications

rpc DeleteNotifications(DeleteNotificationsRequest) returns (Empty)

Efface les paramètres de notification Pub/Sub pour le compte.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

GenerateAccountNumber

rpc GenerateAccountNumber(GenerateAccountNumberRequest) returns (Account)

Génère un numéro pour ce compte. Le numéro de compte n'est pas provisionné lors de la création d'un compte. Utilisez cette demande pour créer un numéro de compte lorsque celui-ci est nécessaire.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

GetAccount

rpc GetAccount(GetAccountRequest) returns (Account)

Récupère le compte spécifié. Renvoie NOT_FOUND si le compte n'existe pas ou si l'appelant n'a pas les droits d'accès à celui-ci.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

GetNotifications

rpc GetNotifications(GetNotificationsRequest) returns (Notifications)

Renvoie les paramètres de notification Pub/Sub pour le compte.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

ListAccounts

rpc ListAccounts(ListAccountsRequest) returns (ListAccountsResponse)

Liste tous les comptes pour l'utilisateur authentifié. Il peut s'agir de tous les comptes que possède l'utilisateur ou de ceux pour lesquels il dispose de droits de gestion.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

UpdateAccount

rpc UpdateAccount(UpdateAccountRequest) returns (Account)

Met à jour le compte professionnel spécifié. Les comptes personnels ne peuvent pas être mis à jour avec cette méthode.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

UpdateNotifications

rpc UpdateNotifications(UpdateNotificationsRequest) returns (Notifications)

Définit les paramètres de notification Pub/Sub pour le compte indiquant à la fiche d'établissement pour quel sujet envoyer des notifications Pub/Sub:

  • Nouveaux avis pour les établissements gérés par le compte.
  • Mise à jour des avis pour les établissements gérés par le compte.
  • Nouveau GoogleUpdates pour les établissements gérés par le compte.

Un compte ne dispose que d'une seule ressource de paramètres de notification, et vous ne pouvez définir qu'un seul sujet Pub/Sub.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

BusinessCategories

Cette API active la visibilité des catégories acceptées pour les établissements sur Google. Vous pouvez obtenir des listes paginées de toutes les catégories d'activité disponibles ou effectuer une recherche par terme spécifique. Pour en savoir plus, consultez la section "Catégories" de cet article: https://support.google.com/business/answer/3038177.

BatchGetBusinessCategories

rpc BatchGetBusinessCategories(BatchGetBusinessCategoriesRequest) returns (BatchGetBusinessCategoriesResponse)

Affiche la liste des catégories d'activité pour la langue et les ID GConcept fournis.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

ListBusinessCategories

rpc ListBusinessCategories(ListBusinessCategoriesRequest) returns (ListBusinessCategoriesResponse)

Affiche une liste de catégories d'activité. La recherche correspondra au nom de la catégorie, mais pas à son ID.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

BusinessMessagingService

Permet aux entreprises d'enregistrer leurs établissements pour Business Messages afin de proposer un canal de communication aux consommateurs qui les recherchent. Pour afficher les messages Business Messages d'un établissement et y effectuer des actions, vous devez être un MANAGER ou un OWNER de l'établissement.

Abonnés

Cette API expose l'API de gestion des followers.

GetFollowersMetadata

rpc GetFollowersMetadata(GetFollowersMetadataRequest) returns (FollowersMetadata)

Obtenez les paramètres des abonnés à un établissement.

NOT_FOUND est renvoyé si le compte ou l'établissement n'existe pas. PRECONDITION_FAILED est renvoyé si l'établissement n'est pas validé ni connecté à Maps.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

FoodMenuService

Cette API permet d'obtenir et de mettre à jour les menus des établissements.

Notez que Location.PriceList représente également des "menus" dans un de son type, mais avec des champs limités. Il partage le même stockage en aval que FoodMenus. Une fois la migration vers FoodMenuService terminée, nous déconseillons fortement aux clients d'utiliser Location.PriceList pour mettre à jour les données de leur menu, ce qui peut entraîner une perte de données inattendue.

GetFoodMenus

rpc GetFoodMenus(GetFoodMenusRequest) returns (FoodMenus)

Affiche les menus d'un lieu spécifique. N'appelez cette méthode que si location.location_state.can_have_food_menu est défini sur "true".

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

UpdateFoodMenus

rpc UpdateFoodMenus(UpdateFoodMenusRequest) returns (FoodMenus)

Met à jour les menus d'un lieu spécifique. N'appelez cette méthode que si location.location_state.can_have_food_menu est défini sur "true".

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

GoogleLocations

Cette API permet d'accéder à GoogleLocation et d'y effectuer des recherches.

ListRecommendedGoogleLocations

rpc ListRecommendedGoogleLocations(ListRecommendedGoogleLocationsRequest) returns (ListRecommendedGoogleLocationsResponse)

Répertorie tous les GoogleLocation qui ont été recommandés pour le compte de fiche d'établissement spécifié. Les recommandations ne sont fournies que pour les comptes personnels et les groupes d'établissements. Les demandes pour tous les autres types de comptes renverront une erreur. Les recommandations concernant les groupes d'établissements sont basées sur les établissements qu'ils contiennent.

Les recommandations pour les comptes personnels sont basées sur tous les établissements auxquels l'utilisateur a accès dans la fiche d'établissement (y compris ceux auxquels il peut accéder via des groupes d'établissements). Elles constituent un sur-ensemble de toutes les recommandations générées pour l'utilisateur.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

ReportGoogleLocation

rpc ReportGoogleLocation(ReportGoogleLocationRequest) returns (Empty)

Signaler un GoogleLocation.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

SearchGoogleLocations

rpc SearchGoogleLocations(SearchGoogleLocationsRequest) returns (SearchGoogleLocationsResponse)

Recherchez tous les emplacements possibles correspondant à la requête spécifiée.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

HealthProviderAttributesService

Ce service permet de gérer les attributs d'un prestataire de santé (par exemple, une assurance acceptée par un établissement) associé à un établissement.

GetHealthProviderAttributes

rpc GetHealthProviderAttributes(GetHealthProviderAttributesRequest) returns (HealthProviderAttributes)

Affiche les attributs du fournisseur de santé d'un lieu spécifique.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

UpdateHealthProviderAttributes

rpc UpdateHealthProviderAttributes(UpdateHealthProviderAttributesRequest) returns (HealthProviderAttributes)

Met à jour les attributs du prestataire de santé d'un lieu spécifique.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

Insights

Génère des rapports détaillant les tendances de consommation pour une ou plusieurs fiches sur les services Google. Vous pouvez interroger les données agrégées relatives aux métriques de base sur une période allant jusqu'à 18 mois. Les métriques pour lesquelles une ventilation est disponible peuvent afficher des données globales sur cette période, réparties par jour de la semaine ou par heure de la journée. Les demandes d'itinéraire peuvent être enregistrées dans des instantanés couvrant un certain nombre de jours.

ReportLocalPostInsights

rpc ReportLocalPostInsights(ReportLocalPostInsightsRequest) returns (ReportLocalPostInsightsResponse)

Affiche les insights d'un ensemble de posts locaux associés à une seule fiche. Les métriques et la manière dont elles sont enregistrées sont des options spécifiées dans le protocole de la requête.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

ReportLocationInsights

rpc ReportLocationInsights(ReportLocationInsightsRequest) returns (ReportLocationInsightsResponse)

Affiche un rapport contenant des insights sur une ou plusieurs métriques par établissement.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

InsuranceNetworkService

Ce service permet de proposer sur Google tous les réseaux d'assurances acceptés pour les établissements de santé.

ListInsuranceNetworks

rpc ListInsuranceNetworks(ListInsuranceNetworksRequest) returns (ListInsuranceNetworksResponse)

Affiche la liste de tous les réseaux d'assurance compatibles avec Google.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

LocalPosts

Cette API expose l'API de gestion des posts locaux.

CreateLocalPost

rpc CreateLocalPost(CreateLocalPostRequest) returns (LocalPost)

Crée un post local associé à l'établissement spécifié, puis l'affiche.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

DeleteLocalPost

rpc DeleteLocalPost(DeleteLocalPostRequest) returns (Empty)

Supprime un post local. Renvoie NOT_FOUND si le post local n'existe pas.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

GetLocalPost

rpc GetLocalPost(GetLocalPostRequest) returns (LocalPost)

Récupère le post local spécifié. Renvoie NOT_FOUND si le post local n'existe pas.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

ListLocalPosts

rpc ListLocalPosts(ListLocalPostsRequest) returns (ListLocalPostsResponse)

Affiche une liste de posts locaux associés à un établissement.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

UpdateLocalPost

rpc UpdateLocalPost(UpdateLocalPostRequest) returns (LocalPost)

Met à jour le post local spécifié et affiche le post local mis à jour.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

Emplacements

Cette API permet de gérer les établissements sur Google. Il vous permet de gérer les ressources Location. Il définit le modèle de ressources suivant:

  • L'API comporte une collection de ressources Account, nommée accounts/*.

  • Pour plus de commodité, vous pouvez utiliser l'expression "moi" au lieu de l'ID du compte personnel de l'appelant authentifié. Exemples: GET /v4/accounts/me GET /v4/accounts/me/locations

  • Chaque Account comporte une collection de ressources Location, nommée accounts/*/locations/*.

AssociateLocation

rpc AssociateLocation(AssociateLocationRequest) returns (Empty)

Associe un établissement à un ID de lieu. Toute association précédente est écrasée. Cette opération n'est valide que si l'établissement n'a pas été validé. L'association doit être valide, c'est-à-dire qu'elle apparaît dans la liste de FindMatchingLocations.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

BatchGetLocations

rpc BatchGetLocations(BatchGetLocationsRequest) returns (BatchGetLocationsResponse)

Récupère tous les établissements spécifiés dans le compte donné.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

ClearLocationAssociation

rpc ClearLocationAssociation(ClearLocationAssociationRequest) returns (Empty)

Efface une association entre un établissement et son ID de lieu. Cette opération n'est valide que si l'établissement n'a pas été validé.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

CreateLocation

rpc CreateLocation(CreateLocationRequest) returns (Location)

Crée un objet location appartenant au compte spécifié, puis l'affiche.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

DeleteLocation

rpc DeleteLocation(DeleteLocationRequest) returns (Empty)

Supprime un établissement.

FindMatchingLocations

rpc FindMatchingLocations(FindMatchingLocationsRequest) returns (FindMatchingLocationsResponse)

Recherche tous les lieux possibles correspondant à l'établissement spécifié. Cette opération n'est valide que si l'établissement n'a pas été validé.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

GetChain

rpc GetChain(GetChainRequest) returns (Chain)

Récupère la chaîne spécifiée. Renvoie NOT_FOUND si la chaîne n'existe pas.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

GetGoogleUpdatedLocation

rpc GetGoogleUpdatedLocation(GetLocationRequest) returns (GoogleUpdatedLocation)

Récupère la version mise à jour par Google de l'établissement spécifié. Renvoie NOT_FOUND si l'établissement n'existe pas.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

GetLocation

rpc GetLocation(GetLocationRequest) returns (Location)

Récupère l'emplacement spécifié. Renvoie NOT_FOUND si l'établissement n'existe pas.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

ListAttributeMetadata

rpc ListAttributeMetadata(ListAttributeMetadataRequest) returns (ListAttributeMetadataResponse)

Affiche la liste des attributs disponibles pour un établissement associé à la catégorie principale et au pays spécifiés.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

ListLocations

rpc ListLocations(ListLocationsRequest) returns (ListLocationsResponse)

Répertorie les établissements pour le compte spécifié.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

SearchChains

rpc SearchChains(SearchChainsRequest) returns (SearchChainsResponse)

Effectue une recherche dans la chaîne en fonction de son nom.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

TransferLocation

rpc TransferLocation(TransferLocationRequest) returns (Location)

Permet de déplacer un établissement d'un compte appartenant à l'utilisateur vers un autre compte qu'il gère. L'utilisateur doit être propriétaire du compte auquel l'établissement est actuellement associé et au moins un administrateur du compte de destination. Renvoie l'emplacement avec son nouveau nom de ressource.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

UpdateLocation

rpc UpdateLocation(UpdateLocationRequest) returns (Location)

Met à jour l'établissement spécifié.

Vous ne pouvez ajouter des photos que pour les établissements disposant d'une page Google+.

Renvoie NOT_FOUND si l'établissement n'existe pas.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

Multimédia

Ce service permet de gérer les contenus multimédias (photos et vidéos) associés à un établissement.

CreateMediaItem

rpc CreateMediaItem(CreateMediaItemRequest) returns (MediaItem)

Crée un élément multimédia pour l'établissement.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

DeleteMediaItem

rpc DeleteMediaItem(DeleteMediaItemRequest) returns (Empty)

Supprime l'élément multimédia spécifié.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

GetCustomerMediaItem

rpc GetCustomerMediaItem(GetCustomerMediaItemRequest) returns (MediaItem)

Affiche les métadonnées de l'élément multimédia client demandé.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

GetMediaItem

rpc GetMediaItem(GetMediaItemRequest) returns (MediaItem)

Affiche les métadonnées de l'élément multimédia demandé.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

ListCustomerMediaItems

rpc ListCustomerMediaItems(ListCustomerMediaItemsRequest) returns (ListCustomerMediaItemsResponse)

Affiche une liste d'éléments multimédias associés à un établissement dont les clients ont contribué.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

ListMediaItems

rpc ListMediaItems(ListMediaItemsRequest) returns (ListMediaItemsResponse)

Affiche la liste des éléments multimédias associés à un établissement.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

StartUploadMediaItemData

rpc StartUploadMediaItemData(StartUploadMediaItemDataRequest) returns (MediaItemDataRef)

Génère un MediaItemDataRef pour l'importation de l'élément multimédia.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

UpdateMediaItem

rpc UpdateMediaItem(UpdateMediaItemRequest) returns (MediaItem)

Met à jour les métadonnées de l'élément multimédia spécifié. Cela ne peut être utilisé que pour mettre à jour la catégorie d'un élément multimédia, à l'exception du fait que la nouvelle catégorie ne peut pas être COVER ou PROFILE.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

QuestionsAndAnswers

Ce service permet de gérer les questions et les réponses d'un établissement. Les questions et réponses ne sont valides que pour les établissements validés.

CreateQuestion

rpc CreateQuestion(CreateQuestionRequest) returns (Question)

Ajoute une question pour le lieu spécifié.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

DeleteAnswer

rpc DeleteAnswer(DeleteAnswerRequest) returns (Empty)

Supprime la réponse à une question rédigée par l'utilisateur actuel.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

DeleteQuestion

rpc DeleteQuestion(DeleteQuestionRequest) returns (Empty)

Supprime une question spécifique écrite par l'utilisateur actuel.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

ListAnswers

rpc ListAnswers(ListAnswersRequest) returns (ListAnswersResponse)

Affiche la liste paginée des réponses à une question spécifiée.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

ListQuestions

rpc ListQuestions(ListQuestionsRequest) returns (ListQuestionsResponse)

Affiche la liste paginée des questions et certaines de ses réponses pour un lieu spécifié.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

UpdateQuestion

rpc UpdateQuestion(UpdateQuestionRequest) returns (Question)

Met à jour une question spécifique écrite par l'utilisateur actuel.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

UpsertAnswer

rpc UpsertAnswer(UpsertAnswerRequest) returns (Answer)

Crée une réponse ou met à jour la réponse existante écrite par l'utilisateur pour la question spécifiée. Un utilisateur ne peut créer qu'une seule réponse par question.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

Avis

Cette API fournit des opérations CRUD pour les avis. google.mybusiness.v4.Reviews.

BatchGetReviews

rpc BatchGetReviews(BatchGetReviewsRequest) returns (BatchGetReviewsResponse)

Affiche la liste paginée des avis pour tous les établissements spécifiés. Cette opération n'est valide que si les établissements spécifiés ont été validés.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

DeleteReviewReply

rpc DeleteReviewReply(DeleteReviewReplyRequest) returns (Empty)

Supprime la réponse à l'avis spécifié. Cette opération n'est valide que si l'établissement spécifié est validé.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

GetReview

rpc GetReview(GetReviewRequest) returns (Review)

Affiche l'avis spécifié. Cette opération n'est valide que si l'établissement spécifié est validé. Affiche la valeur NOT_FOUND si l'avis n'existe pas ou a été supprimé.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

ListReviews

rpc ListReviews(ListReviewsRequest) returns (ListReviewsResponse)

Affiche la liste paginée des avis pour l'établissement spécifié. Cette opération n'est valide que si l'établissement spécifié est validé.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

UpdateReviewReply

rpc UpdateReviewReply(UpdateReviewReplyRequest) returns (ReviewReply)

Met à jour la réponse à l'avis spécifié. S'il n'en existe aucune, une réponse est créée. Cette opération n'est valide que si l'établissement spécifié est validé.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

ServiceLists

Cette API permet aux opérations d'obtenir et de mettre à jour la liste des services des établissements sur Google. Une liste de services contient les articles correspondant à des services fournis par les marchands. Il peut s'agir de services de coiffure, d'installation de chauffe-eau, etc.

GetServiceList

rpc GetServiceList(GetServiceListRequest) returns (ServiceList)

Permet d'obtenir la liste des services spécifiés pour un établissement.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

UpdateServiceList

rpc UpdateServiceList(UpdateServiceListRequest) returns (ServiceList)

Met à jour la liste de services spécifiée d'un établissement.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

Vérifications

Cette API permet de gérer les validations d'établissements sur Google. Il vous permet de gérer les ressources Verification.

Chaque Location comporte une collection de ressources Verification, nommée accounts/*/locations/*/verifications/*.

CompleteVerification

rpc CompleteVerification(CompleteVerificationRequest) returns (CompleteVerificationResponse)

Effectue une validation de PENDING.

Il n'est nécessaire que pour les méthodes de validation autres que AUTO. La demande de validation de AUTO est instantanément VERIFIED lors de sa création.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

FetchVerificationOptions

rpc FetchVerificationOptions(FetchVerificationOptionsRequest) returns (FetchVerificationOptionsResponse)

Indique toutes les options de validation éligibles pour un établissement dans une langue spécifique.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

ListVerifications

rpc ListVerifications(ListVerificationsRequest) returns (ListVerificationsResponse)

Lister les validations d'un établissement, classées par heure de création

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

VerifyLocation

rpc VerifyLocation(VerifyLocationRequest) returns (VerifyLocationResponse)

Lance la procédure de validation d'un établissement.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

AcceptInvitationRequest

Message de requête pour AccessControl.AcceptInvitation.

Champs
name

string

Nom de l'invitation qui est acceptée.

Compte

Un compte est un conteneur incluant les établissements de votre entreprise. Si vous êtes le seul utilisateur à gérer les établissements de votre établissement, vous pouvez utiliser votre compte Google personnel. Pour partager la gestion d'établissements avec plusieurs utilisateurs, créez un compte professionnel.

Champs
name

string

Nom de la ressource, au format accounts/{account_id}.

account_name

string

Nom du compte.

type

AccountType

Uniquement en sortie. Spécifie l'AccountType de ce compte.

role

AccountRole

Uniquement en sortie. Spécifie le AccountRole dont dispose l'appelant pour ce compte.

state

AccountState

Uniquement en sortie. Indique l'AccountState de ce compte.

account_number

string

Numéro de référence du compte, s'il est fourni

permission_level

PermissionLevel

Uniquement en sortie. Spécifie le PermissionLevel dont dispose l'appelant pour ce compte.

organization_info

OrganizationInfo

Informations supplémentaires sur une organisation. Ce champ n'est renseigné que pour un compte d'organisation.

OrganizationInfo

Informations supplémentaires stockées pour une organisation.

Champs
registered_domain

string

Domaine enregistré pour le compte.

postal_address

PostalAddress

Adresse postale du compte.

phone_number

string

Numéro de téléphone de l'organisation.

AccountRole

Indique le niveau d'accès de l'utilisateur authentifié pour ce compte. Pour en savoir plus, consultez cet article du Centre d'aide

Enums
ACCOUNT_ROLE_UNSPECIFIED Non spécifié.
OWNER L'utilisateur est propriétaire de ce compte. (s'affiche en tant que "Propriétaire principal" dans l'interface utilisateur).
CO_OWNER L'utilisateur est copropriétaire du compte. (s'affiche avec la mention "Propriétaire" dans l'interface utilisateur).
MANAGER L'utilisateur peut gérer ce compte.
COMMUNITY_MANAGER L'utilisateur peut gérer les pages de réseaux sociaux (Google+) du compte. ("Responsable de site" dans l'interface utilisateur)

AccountState

Indique l'état du compte, par exemple s'il a été validé par Google.

Champs
status

AccountStatus

S'ils sont validés, les futurs établissements créés sont automatiquement associés à Google Maps et des pages Google+ ont été créées, sans nécessiter de modération.

AccountStatus

Indique l'état de validation du compte.

Enums
ACCOUNT_STATUS_UNSPECIFIED Non spécifié.
VERIFIED Compte validé.
UNVERIFIED Compte non validé pour lequel la validation n'a pas été demandée.
VERIFICATION_REQUESTED Compte non validé alors qu'une validation a été demandée.

AccountType

Indique le type de compte: compte personnel/utilisateur ou compte professionnel.

Enums
ACCOUNT_TYPE_UNSPECIFIED Non spécifié.
PERSONAL Un compte utilisateur final.
LOCATION_GROUP Groupe d'établissements. Pour en savoir plus, consultez cet article du Centre d'aide
USER_GROUP Un groupe d'utilisateurs pour répartir le personnel de l'organisation dans des groupes Pour en savoir plus, consultez cet article du Centre d'aide
ORGANIZATION Organisation représentant une entreprise. Pour en savoir plus, consultez cet article du Centre d'aide

AdWordsLocationExtensions

Informations supplémentaires qui s'affichent dans AdWords.

Champs
ad_phone

string

Numéro de téléphone secondaire à afficher dans les extensions de lieu AdWords au lieu du numéro de téléphone principal de l'établissement.

AddressInput

Entrée pour la validation de l'adresse ADDRESS.

Champs
mailer_contact_name

string

Nom du contact auquel l'e-mail doit être envoyé.

Administrateur

Administrateur d'un Account ou d'un Location.

Champs
name

string

Nom de la ressource. Pour les administrateurs de compte, le format est le suivant: accounts/{account_id}/admins/{admin_id}

Pour les administrateurs d'établissements, le format est le suivant: accounts/{account_id}/locations/{location_id}/admins/{admin_id}

admin_name

string

Nom de l'administrateur. Lors de la création de l'invitation initiale, il s'agit de l'adresse e-mail de l'invité. Lors des appels GET, l'adresse e-mail de l'utilisateur est renvoyée si l'invitation est toujours en attente. Sinon, il contient le prénom et le nom de l'utilisateur.

role

AdminRole

Spécifie le AdminRole que cet administrateur utilise avec la ressource Account ou Location spécifiée.

pending_invitation

bool

Uniquement en sortie. Indique si cet administrateur a une invitation en attente pour la ressource spécifiée.

AdminRole

Indique le niveau d'accès d'un administrateur. Pour en savoir plus, consultez cet article du Centre d'aide

Enums
ADMIN_ROLE_UNSPECIFIED Non spécifié.
OWNER L'administrateur dispose d'un accès de niveau propriétaire et en est le propriétaire principal. (s'affiche en tant que "Propriétaire principal" dans l'interface utilisateur).
CO_OWNER L'administrateur dispose d'un accès de niveau propriétaire. (s'affiche avec la mention "Propriétaire" dans l'interface utilisateur).
MANAGER L'administrateur dispose d'un accès de niveau administrateur.
COMMUNITY_MANAGER L'administrateur peut gérer les pages de réseaux sociaux (Google+). ("Responsable de site" dans l'interface utilisateur)

AlertType

Type d'événement pour lequel le post d'alerte a été créé.

Enums
ALERT_TYPE_UNSPECIFIED Aucune alerte n'est spécifiée.
COVID_19 Alertes liées à la pandémie de coronavirus 2019. Les posts concernant la COVID-19 ne peuvent comporter qu'un champ de résumé et un champ d'incitation à l'action. Lorsque ces alertes ne seront plus pertinentes, la création de posts d'alerte pour le type COVID-19 sera désactivée. Toutefois, le marchand pourra toujours gérer ses posts concernant la COVID-19.

Allergènes

Informations sur les allergènes concernant un aliment.

Enums
ALLERGEN_UNSPECIFIED Allergène non spécifié
DAIRY Allergène lié aux produits laitiers
EGG Allergène lié aux œufs
FISH Allergène lié au poisson
PEANUT Allergène lié à l'arachide
SHELLFISH Allergène lié aux crustacés
SOY Allergène lié au soja
TREE_NUT Allergène lié aux fruits à coque
WHEAT Allergène lié au blé

Réponse

Représente une réponse à une question

Champs
name

string

Uniquement en sortie. Nom unique de la réponse accounts/*/locations/*/questions/*/answers/*

author

Author

Uniquement en sortie. Auteur de la réponse.

upvote_count

int32

Uniquement en sortie. Nombre de votes pour pour cette réponse.

text

string

Texte de la réponse. Il doit contenir au moins un caractère qui n'est pas un espace blanc. La longueur maximale est de 4 096 caractères.

create_time

Timestamp

Uniquement en sortie. Code temporel correspondant au moment où la réponse a été écrite.

update_time

Timestamp

Uniquement en sortie. Code temporel correspondant à la dernière modification de la réponse.

AssociateLocationRequest

Message de requête pour Location.AssociateLocationRequest.

Champs
name

string

Nom de ressource de l'établissement à associer.

place_id

string

Association à établir. Si ce champ n'est pas défini, il indique qu'il n'y a aucune correspondance.

Attribut

Attribut de lieu. Les attributs fournissent des informations supplémentaires sur un établissement. Les attributs qui peuvent être définis pour un établissement peuvent varier en fonction des propriétés de celui-ci (par exemple, la catégorie). Les attributs disponibles sont déterminés par Google et peuvent être ajoutés et supprimés sans modification de l'API.

Champs
attribute_id

string

Identifiant de l'attribut. Les ID d'attributs sont fournis par Google.

value_type

AttributeValueType

Uniquement en sortie. Type de valeur que contient cet attribut. Cela doit être utilisé pour déterminer comment interpréter la valeur.

values[]

Value

Valeurs de cet attribut. Le type des valeurs fournies doit correspondre à celui attendu pour cet attribut. consultez la section AttributeValueType. Il s'agit d'un champ répété dans lequel plusieurs valeurs d'attribut peuvent être fournies. Les types d'attributs n'acceptent qu'une seule valeur.

repeated_enum_value

RepeatedEnumAttributeValue

Lorsque le type de valeur de l'attribut est REPEATED_ENUM, cette valeur contient la valeur de l'attribut. Les autres champs de valeurs doivent être vides.

url_values[]

UrlAttributeValue

Lorsque le type de valeur de l'attribut est URL, ce champ contient la ou les valeurs de cet attribut. Les autres champs de valeurs doivent être vides.

AttributeMetadata

Métadonnées d'un attribut. Contient des informations à afficher pour l'attribut, y compris un nom localisé et un en-tête permettant de regrouper des attributs associés.

Champs
attribute_id

string

Identifiant de l'attribut.

value_type

AttributeValueType

Type de valeur de l'attribut. Les valeurs définies et récupérées doivent être de ce type.

display_name

string

Le nom à afficher localisé de l'attribut, le cas échéant sinon il s'agit du nom à afficher en anglais.

group_display_name

string

Le nom à afficher localisé du groupe qui contient cet attribut, le cas échéant Sinon, il s'agit du nom du groupe en anglais. Les attributs associés sont regroupés dans un groupe et doivent s'afficher ensemble dans le titre indiqué ici.

is_repeatable

bool

Si la valeur est "true", l'attribut accepte plusieurs valeurs. Si la valeur est "false", une seule valeur doit être fournie.

value_metadata[]

AttributeValueMetadata

Pour certains types d'attributs (par exemple, les énumérations), une liste des valeurs acceptées et les noms à afficher correspondants pour ces valeurs est fournie.

is_deprecated

bool

Si la valeur est "true", l'attribut est obsolète et ne doit plus être utilisé. S'il est obsolète, la mise à jour de cet attribut n'entraînera pas d'erreur, mais les modifications ne seront pas enregistrées. Une fois qu'il est obsolète, l'attribut est entièrement supprimé et devient une erreur.

AttributeValueMetadata

Métadonnées des valeurs d'attribut acceptées.

Champs
value

Value

Valeur de l'attribut.

display_name

string

Nom à afficher pour cette valeur, localisé si disponible sinon, en anglais. Le nom à afficher de la valeur est destiné à être utilisé en contexte avec le nom à afficher de l'attribut.

Par exemple, pour un "Wi-Fi" attribut enum, pourrait contenir la mention "Payant" pour représenter un Wi-Fi payant.

AttributeValueType

Type de valeur de l'attribut.

Enums
ATTRIBUTE_VALUE_TYPE_UNSPECIFIED Non spécifié.
BOOL Les valeurs de cet attribut sont des valeurs booléennes.
ENUM L'attribut est associé à une liste prédéterminée de valeurs disponibles que vous pouvez utiliser. Les métadonnées de cet attribut répertorient ces valeurs.
URL Les valeurs de cet attribut sont des URL.
REPEATED_ENUM La valeur de l'attribut est une énumération avec plusieurs valeurs possibles qui peuvent être définies explicitement ou non.

Auteur

Représente l'auteur d'une question ou d'une réponse

Champs
display_name

string

Nom à afficher de l'utilisateur

profile_photo_url

string

URL de la photo de profil de l'utilisateur.

type

AuthorType

Type d'utilisateur dont est l'auteur.

AuthorType

Énumération pour le type d'utilisateur dont l'auteur est l'auteur.

Enums
AUTHOR_TYPE_UNSPECIFIED Elle ne doit pas être utilisée.
REGULAR_USER Un utilisateur standard.
LOCAL_GUIDE Un Local Guide
MERCHANT Propriétaire/administrateur de l'établissement

BasicMetricsRequest

Requête d'insights de métriques de base.

Champs
metric_requests[]

MetricRequest

Ensemble de métriques permettant de renvoyer des valeurs pour inclure les options d'affichage des données.

time_range

TimeRange

Plage pour laquelle collecter des métriques. La plage maximale est de 18 mois à compter de la date de la demande. Dans certains cas, il est possible que les données soient encore manquantes pour les jours proches de la date de la demande. Les données manquantes seront spécifiées dans le metricValues de la réponse.

BatchGetBusinessCategoriesRequest

Message de requête pour BusinessCategories.BatchGetBusinessCategories.

Champs
language_code

string

Obligatoire. Code BCP 47 du langage dans lequel les noms de catégorie doivent être renvoyés.

category_ids[]

string

Obligatoire. Vous devez définir au moins un nom. Identifiants GConcept pour lesquels les noms de catégories localisés doivent être renvoyés.

region_code

string

Facultatif. Code pays ISO 3166-1 alpha-2 utilisé pour déduire les langues non standards.

view

CategoryView

Obligatoire. Spécifie les parties de la ressource "Category" à renvoyer dans la réponse.

BatchGetBusinessCategoriesResponse

Message de réponse pour BusinessCategories.BatchGetBusinessCategories.

Champs
categories[]

Category

Catégories qui correspondent aux ID GConcept fournis dans la requête. Ils n'apparaîtront pas dans le même ordre que les identifiants de catégorie dans la requête.

BatchGetLocationsRequest

Message de requête pour Location.BatchGetLocations.

Champs
name

string

Nom du compte à partir duquel extraire les zones géographiques.

location_names[]

string

Ensemble d'établissements à récupérer, spécifiés par leur nom.

BatchGetLocationsResponse

Message de réponse pour Location.BatchGetLocations.

Champs
locations[]

Location

Ensemble de lieux.

BatchGetReviewsRequest

Message de requête pour Reviews.BatchGetReviews.

Champs
name

string

Nom du compte à partir duquel vous souhaitez récupérer la liste des avis concernant plusieurs établissements.

location_names[]

string

Ensemble d'établissements pour lesquels extraire des avis, identifiés par leur nom.

page_size

int32

Nombre d'avis à extraire par page. La valeur par défaut est 50.

page_token

string

Si elle est spécifiée, la page d'avis suivante est récupérée.

order_by

string

Facultatif. Spécifie le champ selon lequel trier les avis. Si aucune valeur n'est spécifiée, l'ordre des avis renvoyés sera défini par défaut sur update_time desc. Les ordres de tri valides sont rating, rating desc et update_time desc. rating affichera les avis dans l'ordre croissant. update_time(par ordre croissant) n'est pas accepté.

ignore_rating_only_reviews

bool

Permet d'ignorer ou non les avis uniquement.

BatchGetReviewsResponse

Message de réponse pour Reviews.BatchGetReviews.

Champs
location_reviews[]

LocationReview

Avis avec des informations de localisation.

next_page_token

string

Si le nombre d'avis dépasse la taille de page demandée, ce champ est renseigné avec un jeton permettant d'extraire la page d'avis suivante lors des appels suivants. S'il n'y a plus d'avis, ce champ ne sera pas inclus dans la réponse.

BusinessHours

Représente les périodes d'ouverture de l'établissement. Contient une collection d'instances TimePeriod.

Champs
periods[]

TimePeriod

Ensemble des horaires d'ouverture de cet établissement. Chaque période correspond à un intervalle d'heures pendant lequel l'établissement est ouvert pendant la semaine.

CallToAction

Action effectuée lorsque l'utilisateur clique sur le post

Champs
action_type

ActionType

Type d'action qui sera effectuée.

url

string

URL vers laquelle l'utilisateur est dirigé lorsqu'il clique sur le lien. Ce champ ne doit pas être défini pour l'incitation à l'action "Appeler".

ActionType

Type d'action qui sera effectuée.

Enums
ACTION_TYPE_UNSPECIFIED Type non spécifié
BOOK Ce post souhaite qu'un utilisateur prenne un rendez-vous, une table, etc.
ORDER Ce post propose à l'utilisateur de commander quelque chose.
SHOP Ce post propose à l'utilisateur de parcourir un catalogue de produits.
LEARN_MORE Ce post vise à permettre à l'utilisateur d'en savoir plus (sur son site Web).
SIGN_UP Ce post propose à l'utilisateur de s'inscrire/s'inscrire/rejoindre quelque chose.
GET_OFFER

Obsolète. Utilisez OFFER dans LocalPostTopicType pour créer un post avec le contenu de l'offre.

CALL Ce post propose à l'utilisateur d'appeler l'entreprise.

Catégorie

Catégorie décrivant l'établissement (pas ses activités). Pour obtenir la liste des ID de catégorie valides, ainsi que les mappages avec leurs noms lisibles, consultez categories.list.

Champs
display_name

string

pour en savoir plus. Nom lisible de la catégorie. Il est défini lors de la lecture de l'emplacement. Lorsque vous modifiez l'emplacement, category_id doit être défini.

Remarque: Ce champ n'est utilisé que dans les réponses. Toute valeur spécifiée ici dans une requête est ignorée.

category_id

string

pour en savoir plus. Un identifiant stable (fourni par Google) pour cette catégorie. Vous devez spécifier le category_id lorsque vous modifiez la catégorie (lors de la création ou de la mise à jour d'un établissement).

Remarque: Ce champ n'est utilisé que dans les réponses. Toute valeur spécifiée ici dans une requête est ignorée.

service_types[]

ServiceType

pour en savoir plus. Liste de tous les types de services disponibles pour cette catégorie d'activité.

Remarque: Ce champ n'est utilisé que dans les réponses. Toute valeur spécifiée ici dans une requête est ignorée.

more_hours_types[]

MoreHoursType

Uniquement en sortie. Autres types d'horaires disponibles pour cette catégorie d'activité.

CategoryView

Énumération permettant de limiter la quantité de données renvoyées par le serveur.

Enums
CATEGORY_VIEW_UNSPECIFIED Non spécifié. Équivaut à CATEGORY_METADATA_ONLY.
BASIC La réponse du serveur n'inclura que les champs de catégorie display_name, category_id et language_code. Il omet tous les champs liés aux métadonnées de type de service.
FULL Renvoie tous les champs de la réponse.

Chaîne

Une chaîne est une marque à laquelle vos établissements peuvent être affiliés.

Champs
name

string

Nom de ressource de la chaîne, au format chains/{chain_place_id}.

chain_names[]

ChainName

Noms de la chaîne.

websites[]

ChainUrl

Sites Web de la chaîne

location_count

int32

Nombre d'établissements faisant partie de cette chaîne.

ChainName

Nom à utiliser lors de l'affichage de la chaîne.

Champs
display_name

string

Nom à afficher pour cette chaîne.

language_code

string

Code BCP 47 de la langue du nom.

ChainUrl

URL à utiliser lors de l'affichage de la chaîne.

Champs
url

string

URL de cette chaîne.

ClearLocationAssociationRequest

Message de requête pour Location.ClearLocationAssociationRequest.

Champs
name

string

Nom de ressource de l'établissement à dissocier.

CompleteVerificationRequest

Message de requête pour Verifications.CompleteVerificationAction.

Champs
name

string

Nom de ressource de la validation à effectuer.

pin

string

Code que le marchand a reçu pour terminer la validation.

CompleteVerificationResponse

Message de réponse pour Verifications.CompleteVerificationAction.

Champs
verification

Verification

Validation terminée.

CreateAccountAdminRequest

Message de requête pour AccessControl.CreateAccountAdmin.

Champs
parent

string

Nom de ressource du compte pour lequel cet administrateur est créé.

admin

Admin

L'administrateur chargé de créer

CreateAccountRequest

Message de requête pour Accounts.CreateAccount.

Champs
primary_owner

string

Nom de ressource du compte qui sera le propriétaire principal du compte en cours de création. Il doit se présenter sous la forme accounts/{account_id}/.

account

Account

Informations sur le compte à créer. Les seuls champs autorisés sont account_name et type.

CreateLocalPostRequest

Message de requête pour CreateLocalPost.

Champs
parent

string

Nom de l'établissement dans lequel créer ce post local.

local_post

LocalPost

Métadonnées du nouveau post local.

CreateLocationAdminRequest

Message de requête pour AccessControl.CreateLocationAdmin.

Champs
parent

string

Nom de ressource de l'établissement pour lequel cet administrateur est créé.

admin

Admin

L'administrateur chargé de créer

CreateLocationRequest

Message de requête pour Location.CreateLocation.

Champs
parent

string

Nom du compte dans lequel créer l'établissement.

location

Location

Métadonnées du nouvel établissement.

validate_only

bool

Si la valeur est "true", la requête est validée sans créer réellement l'établissement.

request_id

string

ID de requête unique permettant au serveur de détecter les requêtes en double. Nous vous recommandons d'utiliser des UUID. La longueur maximale est de 50 caractères.

CreateMediaItemRequest

Message de requête pour Media.CreateMediaItem.

Champs
parent

string

Nom de ressource de l'emplacement dans lequel cet élément multimédia sera créé.

media_item

MediaItem

Élément multimédia à créer.

CreateQuestionRequest

Message de requête pour QuestionsAndAnswers.CreateQuestion

Champs
parent

string

Nom du lieu pour lequel rédiger une question.

question

Question

La nouvelle question.

DeclineInvitationRequest

Message de requête pour AccessControl.DeclineInvitation.

Champs
name

string

Nom de l'invitation de compte en cours de refus.

DeleteAccountAdminRequest

Message de requête pour AccessControl.DeleteAccountAdmin.

Champs
name

string

Nom de ressource de l'administrateur à supprimer du compte.

DeleteAnswerRequest

Message de requête pour QuestionsAndAnswers.DeleteAnswer

Champs
parent

string

Nom de la question pour laquelle vous souhaitez supprimer une réponse.

DeleteLocalPostRequest

Message de requête pour DeleteLocalPost.

Champs
name

string

Nom du post local à supprimer.

DeleteLocationAdminRequest

Message de requête pour AccessControl.DeleteLocationAdmin.

Champs
name

string

Nom de ressource de l'administrateur à supprimer de l'établissement.

DeleteLocationRequest

Message de requête pour Location.DeleteLocation.

Champs
name

string

Nom de l'établissement à supprimer.

DeleteMediaItemRequest

Message de requête pour Media.DeleteMediaItem.

Champs
name

string

Nom de l'élément multimédia à supprimer.

DeleteNotificationsRequest

Message de requête pour Accounts.DeleteNotifications.

Champs
name

string

Nom de ressource pour les paramètres de notification à effacer.

DeleteQuestionRequest

Message de requête pour QuestionsAndAnswers.DeleteQuestion

Champs
name

string

Nom de la question à supprimer.

DeleteReviewReplyRequest

Message de requête pour Reviews.DeleteReviewResponse.

Champs
name

string

Nom de la réponse à l'avis à supprimer.

DietaryRestriction

Informations sur l'alimentation d'un aliment.

Enums
DIETARY_RESTRICTION_UNSPECIFIED Type de régime alimentaire non spécifié
HALAL Dénomination du plat en tant que plat halal.
KOSHER Définition de l'aliment en tant que plat casher.
ORGANIC Définition des aliments en tant que plats bio.
VEGAN La nourriture signifie qu'il s'agit d'un plat végétalien.
VEGETARIAN Dénomination du plat en tant que plat végétarien.

DimensionalMetricValue

Valeur correspondant à une seule métrique avec une dimension temporelle donnée.

Champs
metric_option

MetricOption

Option à l'origine de la demande de cette valeur dimensionnelle.

time_dimension

TimeDimension

Dimension de la valeur.

value

Int64Value

Valeur. Si aucune valeur n'est définie, les données demandées sont manquantes.

TimeDimension

Dimension au sein de laquelle les données sont réparties.

Champs
day_of_week

DayOfWeek

Jour de la semaine ("MONDAY" à "SUNDAY") auquel cette valeur correspond. Défini pour l'option BREAKDOWN_DAY_OF_WEEK.

time_of_day

TimeOfDay

Heure de la journée (0 à 23) à laquelle cette valeur correspond. Défini pour l'option BREAKDOWN_HOUR_OF_DAY.

time_range

TimeRange

Période couverte par cette valeur. Défini pour les options AGGREGATED_TOTAL et AGGREGATED_DAILY.

DrivingDirectionMetricsRequest

Requête d'insights sur les itinéraires.

Champs
num_days

NumDays

Nombre de jours pour lesquels agréger les données. Les résultats affichés seront les données disponibles pour le dernier nombre de jours demandés. Les valeurs valides sont 7, 30 et 90.

language_code

string

Code BCP 47 du langage. Si aucun code de langue n'est fourni, la langue par défaut est l'anglais.

NumDays

Nombre de jours pendant lesquels cette demande peut être traitée.

Enums
SEVEN 7 jours. Il s'agit de la valeur par défaut.
THIRTY 30 jours.
NINETY 90 jours.

EmailInput

Entrée pour la validation de l'adresse e-mail

Champs
email_address

string

Adresse e-mail à laquelle le code doit être envoyé.

L'adresse e-mail n'est acceptée que si elle fait partie des adresses fournies par FetchVerificationOptions. Si "is_user_name_editable" est défini sur "true" pour EmailVerificationData, le client peut spécifier un nom d'utilisateur différent (local-part), mais doit correspondre au nom de domaine.

ErrorDetail

Détaille une erreur ayant entraîné un échec de validation ou un échec interne.

Champs
code

int32

Code d'état, qui doit être une valeur d'énumération de ErrorCode.

field

string

Chemin d'accès à un champ du corps de la requête. La valeur est une séquence d'identifiants séparés par un point qui identifient un champ de tampon de protocole. Par exemple, "error_details.field" identifierait ce champ.

message

string

Description de la raison pour laquelle le champ a causé une défaillance. Le message est en anglais et peut ne pas être adapté à tous les utilisateurs.

value

string

Valeur pour laquelle la requête a échoué.

field_index

int32

Si le champ de requête qui a généré cette erreur est répété, il contient l'index de base zéro de l'entrée de ce champ qui a entraîné l'échec de la validation.

ErrorCode

Codes d'erreur pour ErrorDetail:

  • 1 à 199: codes d'erreur courants qui s'appliquent à tous les champs.
  • 1000 à 1099: codes d'erreur liés aux photos
  • 1100 à 1199: codes d'erreur liés à l'adresse et à la latitude/longitude.
  • 1200 à 1299: codes d'erreur liés aux catégories.
  • 1300 à 1399: codes d'erreur liés aux opérations.

Enums
ERROR_CODE_UNSPECIFIED Code d'erreur générique.
MISSING_VALUE Une valeur obligatoire n'a pas été fournie.
INVALID_VALUE La valeur saisie est incorrecte.
INVALID_CHARACTERS Des caractères non valides ont été détectés.
TOO_MANY_ITEMS Vous avez dépassé le nombre maximal d'éléments indiqué dans un champ répété.
READ_ONLY Impossible de modifier le champ en lecture seule.
OVERLAPPING_RANGES Les éléments d'un champ répété sont des plages qui se chevauchent.
INVERTED_RANGE La plage fournie est inversée. Cela inclut également le cas d'une plage vide.
VALUE_OUTSIDE_ALLOWED_RANGE La valeur fournie se situe en dehors de la plage autorisée.
MISSING_DEPENDENT_FIELD Champ dépendant obligatoire non présent.
FIELD_HAS_DEPENDENCIES Champ requis par le champ dépendant et ne peut pas être supprimé.
UNSUPPORTED_VALUE Bien qu'elle puisse être valide, la valeur fournie n'est pas prise en charge en raison d'autres contraintes.
EXPIRED_VALUE La valeur fournie a expiré et n'est plus valide.
PHOTO_FETCH_FAILED Échec de la récupération de la photo à partir de l'URL spécifiée.
PHOTO_UPLOAD_FAILED Échec de l'importation de la photo à partir de l'URL spécifiée.
GEOCODE_ERROR Une erreur s'est produite lors de la détermination automatique de la latitude/longitude.
LAT_LNG_OUTSIDE_COUNTRY La latitude/longitude fournies ne correspondent pas au pays indiqué.
LAT_LNG_REQUIRED Vous devez indiquer la latitude et la longitude.
LAT_LNG_TOO_FAR_FROM_ADDRESS La paire latitude/longitude et l'adresse sont trop éloignées l'une de l'autre.
CATEGORY_NOT_VERIFIED La catégorie fournie n'a pas été validée.
OPERATION_EXECUTION_ERROR Erreur générique d'exécution de l'opération.
OPERATION_UNSUPPORTED_UNDER_ACCOUNT_CONDITION Opération impossible en raison de la condition du compte.
LOCATION_DISABLED_FOR_LOCAL_POST_API Emplacement désactivé pour l'API Local Post.

FetchVerificationOptionsRequest

Message de requête pour Verifications.FetchVerificationOptions.

Champs
name

string

Nom de ressource de l'établissement à valider.

language_code

string

Code de langue BCP 47 représentant la langue à utiliser pour la procédure de validation. Les options disponibles varient selon les langues.

context

ServiceBusinessContext

Informations contextuelles supplémentaires pour la validation des entreprises de services Obligatoire pour les établissements dont le type d'activité est CUSTOMER_LOCATION_ONLY. INVALID_ARGUMENT sera généré s'il est défini pour d'autres types d'activité dans les zones géographiques.

FetchVerificationOptionsResponse

Message de réponse pour Verifications.FetchVerificationOptions.

Champs
options[]

VerificationOption

Options de validation disponibles

FindMatchingLocationsRequest

Message de requête pour Location.FindMatchingLocations.

Champs
name

string

Nom de ressource de l'établissement pour lequel rechercher des correspondances.

language_code

string

Langue préférée pour l'emplacement correspondant (au format BCP-47).

num_results

int32

Nombre de correspondances à renvoyer. La valeur par défaut est 3, avec un maximum de 10. Notez que la latence peut augmenter si davantage sont demandés. Il n'y a pas de pagination.

max_cache_duration

Duration

Obsolète. Ce champ est ignoré pour toutes les requêtes.

FindMatchingLocationsResponse

Message de réponse pour Location.FindMatchingLocations.

Champs
matched_locations[]

MatchedLocation

Ensemble de zones géographiques pouvant correspondre à la zone spécifiée, classées du plus proche au moins pertinent. S'il existe une correspondance exacte, elle s'affichera en première position.

match_time

Timestamp

Date de la dernière exécution de l'algorithme de mise en correspondance pour cet établissement.

FollowersMetadata

Métadonnées de followers pour un établissement.

Champs
name

string

Nom de ressource pour cet élément. accounts/{account_id}/locations/{location_id}/followers/metadata

count

uint64

Nombre total de followers pour l'établissement.

FoodMenu

Menu d'une entreprise de restauration.

Champs
labels[]

MenuLabel

Obligatoire. Libellés de menu avec marquage de langue. Exemple : "menu", "spécial déjeuner". Les noms à afficher ne doivent pas dépasser 140 caractères, et les descriptions ne doivent pas dépasser 1 000 caractères. Veuillez indiquer au moins un ensemble d'étiquettes.

source_url

string

Facultatif. URL source du menu s'il existe une page Web à laquelle accéder.

sections[]

FoodMenuSection

Obligatoire. Sections du menu

cuisines[]

Cuisine

Facultatif. Informations culinaires sur le menu Nous vous recommandons vivement de renseigner ce champ.

Cuisine

Informations sur la cuisine d'un restaurant.

Enums
CUISINE_UNSPECIFIED Cuisine non spécifiée
AMERICAN Cuisine américaine
ASIAN la cuisine asiatique
BRAZILIAN la cuisine brésilienne
BREAK_FAST Petit-déjeuner
BRUNCH Brunch
CHICKEN Poulet
CHINESE Cuisine chinoise
FAMILY Cuisine familiale
FAST_FOOD Restauration rapide
FRENCH Cuisine française
GREEK la cuisine grecque
GERMAN la cuisine allemande
HAMBURGER Hamburger
INDIAN Cuisine indienne
INDONESIAN la cuisine indonésienne
ITALIAN Cuisine italienne
JAPANESE Cuisine japonaise
KOREAN Cuisine coréenne
LATIN_AMERICAN Cuisine latino-américaine
MEDITERRANEAN la cuisine méditerranéenne
MEXICAN Cuisine mexicaine
PAKISTANI la cuisine pakistanaise
PIZZA Pizza
SEAFOOD Fruits de mer
SPANISH la cuisine espagnole
SUSHI Sushi
THAI la cuisine thaïe
TURKISH la cuisine turque
VEGETARIAN Cuisine végétarienne
VIETNAMESE la cuisine vietnamienne
OTHER_CUISINE Autres types de cuisine

FoodMenuItem

Élément d'une section. Il peut s'agir du plat lui-même ou de plusieurs FoodMenuItemOption.

Champs
labels[]

MenuLabel

Obligatoire. Libellés avec marquage linguistique de cet élément de menu. Les noms à afficher ne doivent pas dépasser 140 caractères, et les descriptions ne doivent pas dépasser 1 000 caractères. Veuillez indiquer au moins un ensemble d'étiquettes.

attributes

FoodMenuItemAttributes

Obligatoire. Attributs détaillés de l'article. Lorsque des options d'élément sont spécifiées, cet élément est considéré comme les attributs de base et est inséré dans chaque option.

options[]

FoodMenuItemOption

Facultatif. Il s’agit d’un élément qui est proposé dans plusieurs options différentes et les utilisateurs doivent faire des choix. Exemple : standard par rapport à "grande taille" pizza. Lorsque des options sont spécifiées, les libellés et attributs définis au niveau de l'article deviennent automatiquement les libellés et attributs de la première option. Les clients doivent simplement indiquer d'autres options alimentaires dans ce champ.

FoodMenuItemAttributes

Attributs d'un plat ou d'un plat

Champs
price

Money

Obligatoire. Prix du plat

spiciness

Spiciness

Facultatif. Niveau d'épicémie du plat

allergen[]

Allergen

Facultatif. Allergènes associés au plat. Nous vous recommandons vivement de renseigner ce champ.

dietary_restriction[]

DietaryRestriction

Facultatif. Informations diététiques du plat. Nous vous recommandons vivement de renseigner ce champ.

nutrition_facts

NutritionFacts

Facultatif. Informations nutritionnelles sur le plat. Nous vous recommandons vivement de renseigner ce champ.

ingredients[]

Ingredient

Facultatif. Ingrédients du plat

serves_num_people

int32

Facultatif. Nombre de personnes pouvant bénéficier de ce plat de restauration.

preparation_methods[]

PreparationMethod

Facultatif. Méthodes de préparation du plat

portion_size

PortionSize

Facultatif. Taille de la commande, représentée en unités d'articles. (ex. : 4 "brochettes", 6 "pièces")

media_keys[]

string

Facultatif. Touches multimédias des contenus multimédias associés au plat. Seuls les supports photo sont acceptés. Lorsque plusieurs photos sont associées, la première est considérée comme la photo préférée.

Ingrédient

Ce message fournit des informations sur les ingrédients d'un plat.

Champs
labels[]

MenuLabel

Obligatoire. Étiquettes pour décrire l'ingrédient. Les noms à afficher ne doivent pas dépasser 140 caractères, et les descriptions ne doivent pas dépasser 1 000 caractères. Veuillez indiquer au moins un ensemble d'étiquettes.

PortionSize

Portion d'un plat

Champs
quantity

int32

Obligatoire. Numéro de la portion.

unit[]

MenuLabel

Obligatoire. Le champ répété "name_info" concerne l'unité en plusieurs langues.

FoodMenuItemOption

Option d'un élément. Elle nécessite une sélection explicite de l'utilisateur.

Champs
labels[]

MenuLabel

Obligatoire. Libellés avec balises de langue pour cette option de menu. Par exemple : "pad thai au bœuf", "pad thai végétarien", "petite pizza", "grande pizza". Les noms à afficher ne doivent pas dépasser 140 caractères, et les descriptions ne doivent pas dépasser 1 000 caractères. Veuillez indiquer au moins un ensemble d'étiquettes.

attributes

FoodMenuItemAttributes

Obligatoire. Attributs détaillés de l'option d'article. Les attributs individuels non spécifiés seront hérités des attributs au niveau de l'article en tant que base.

FoodMenuSection

Section d'un menu. Il peut contenir plusieurs plats/plats.

Champs
labels[]

MenuLabel

Obligatoire. Libellés avec marquage linguistique pour cette section de menu. Les noms à afficher ne doivent pas dépasser 140 caractères, et les descriptions ne doivent pas dépasser 1 000 caractères. Veuillez indiquer au moins un ensemble d'étiquettes.

items[]

FoodMenuItem

Obligatoire. Éléments de la section. Chaque section doit contenir au moins un élément.

FoodMenus

Menus d'une entreprise de restauration.

Champs
name

string

Obligatoire. Identifiant Google de cet établissement, au format suivant: accounts/{account_id}/locations/{location_id}/foodMenus

menus[]

FoodMenu

Facultatif. Ensemble de menus alimentaires.

GenerateAccountNumberRequest

Message de requête pour Accounts.GenerateAccountNumber.

Champs
name

string

Nom du compte pour lequel vous souhaitez générer un numéro de compte.

GetAccountRequest

Message de requête pour Accounts.GetAccount.

Champs
name

string

Nom du compte à extraire.

GetChainRequest

Message de requête pour Location.GetChain.

Champs
name

string

Nom de ressource de la chaîne, au format chains/{chain_place_id}.

GetCustomerMediaItemRequest

Message de requête pour Media.GetCustomerMediaItem.

Champs
name

string

Nom de ressource de l'élément multimédia client demandé.

GetFollowersMetadataRequest

Message de requête permettant d'obtenir les métadonnées des followers d'un établissement.

Champs
name

string

Nom de ressource des métadonnées des followers de l'établissement. accounts/{account_id}/locations/{location_id}/followers/metadata

GetFoodMenusRequest

Message de requête pour FoodMenu.GetFoodMenus

Champs
name

string

Obligatoire. Identifiant Google de cet établissement, au format suivant: accounts/{account_id}/locations/{location_id}/foodMenus

read_mask

FieldMask

Facultatif. Champs spécifiques à afficher. Si aucun masque n'est spécifié, l'intégralité de FoodMenu est renvoyée (comme "*"). Les éléments de champ répétés ne peuvent pas être spécifiés individuellement. Par exemple : "nom" et "menus" sont des masques valides, tandis que "menus.sections" n'est pas valide.

GetHealthProviderAttributesRequest

Message de requête pour HealthProviderAttributes.GetHealthProviderAttributes

Champs
name

string

Obligatoire. Identifiant Google de cet établissement au format suivant: accounts/{account_id}/locations/{location_id}/healthProviderAttributes

language_code

string

Facultatif. Code BCP 47 du langage. Si aucun code de langue n'est fourni, la langue par défaut est l'anglais. Actuellement, uniquement les lettres "en" est pris en charge.

GetLocalPostRequest

Message de requête pour LocalPosts.GetLocalPost.

Champs
name

string

Nom du post local à récupérer.

GetLocationRequest

Message de requête pour Location.GetLocation.

Champs
name

string

Nom de l'établissement à extraire.

GetMediaItemRequest

Message de requête pour Media.GetMediaItem.

Champs
name

string

Nom de l'élément multimédia demandé.

GetNotificationsRequest

Message de requête pour Accounts.GetNotifications.

Champs
name

string

Nom de la ressource des paramètres de notification.

GetReviewRequest

Message de requête pour Reviews.GetReview.

Champs
name

string

Nom de l'avis à extraire.

GetServiceListRequest

Permet d'obtenir un message de requête de liste de services.

Champs
name

string

Obligatoire. Identifiant Google de cet établissement, au format suivant: accounts/{account_id}/locations/{location_id}/servicelist

GoogleLocation

Représente un Location présent sur Google. Il peut s'agir d'un établissement qui a été revendiqué par l'utilisateur ou par quelqu'un d'autre, ou n'a pas été revendiqué.

Champs
name

string

Nom de ressource de cet objet GoogleLocation, au format googleLocations/{googleLocationId}.

location

Location

Informations Location partiellement renseignées. Vous pouvez réutiliser ce champ dans CreateLocation s'il n'est pas revendiqué par un utilisateur.

request_admin_rights_url

string

URL qui redirigera l'utilisateur vers l'interface de demande des droits d'administrateur. Ce champ n'est visible que si l'établissement a déjà été revendiqué par un autre utilisateur, y compris l'utilisateur actuel.

GoogleUpdatedLocation

Représente un établissement modifié par Google.

Champs
location

Location

Version de cet établissement mise à jour par Google.

diff_mask

FieldMask

Champs modifiés par Google.

HealthProviderAttributes

Attributs du prestataire de santé associés à cet établissement.

Champs
name

string

Obligatoire. Identifiant Google de cet établissement, au format suivant: accounts/{account_id}/locations/{location_id}/healthProviderAttributes

insurance_networks[]

InsuranceNetwork

Facultatif. Liste des réseaux d'assurances concernés par cet emplacement.

InsuranceNetwork

Un seul réseau d'assurance. Identifiant suivant: 5

Champs
network_id

string

Obligatoire. ID de ce réseau d'assurance généré par Google.

network_names

map<string, string>

Uniquement en sortie. Carte des noms d'affichage réseau dans les langues demandées, où la langue est la clé et le nom à afficher localisé la valeur. Le nom à afficher en anglais est défini par défaut.

payer_names

map<string, string>

Uniquement en sortie. Carte des noms à afficher du payeur dans les langues demandées, où la langue est la clé et le nom à afficher localisé la valeur. Le nom à afficher en anglais est défini par défaut.

state

NetworkState

Uniquement en sortie. État de ce réseau d'assurance.

InternalError

Décrit les défaillances internes.

Champs
error_details[]

ErrorDetail

Détaille les échecs individuels.

Invitation

Uniquement en sortie. Représente une invitation en attente.

Champs
name

string

Nom de ressource de l'invitation.

role

AdminRole

Rôle invité sur le compte.

Champ d'union target. Indique la cible de cette invitation. target ne peut être qu'un des éléments suivants :
target_account

Account

Compte partiellement rempli auquel cette invitation est destinée.

target_location

TargetLocation

Emplacement cible auquel cette invitation est destinée.

TargetLocation

Représente une zone géographique cible pour une invitation en attente.

Champs
location_name

string

Nom de l'établissement auquel l'utilisateur est invité.

location_address

string

Adresse de l'établissement auquel l'utilisateur est invité.

ListAccountAdminsRequest

Message de requête pour AccessControl.ListAccountAdmins.

Champs
parent

string

Nom du compte à partir duquel récupérer la liste des administrateurs.

ListAccountAdminsResponse

Message de réponse pour AccessControl.ListAccountAdmins.

Champs
admins[]

Admin

Une collection de Admin instances.

ListAccountsRequest

Message de requête pour Accounts.ListAccounts.

Champs
page_size

int32

Nombre de comptes à extraire par page. La valeur par défaut est 20, la minimale est 2 et la maximale est 20.

page_token

string

Si une valeur est spécifiée, la page de comptes suivante est récupérée. Le pageToken est renvoyé lorsqu'un appel à accounts.list renvoie plus de résultats que la page demandée peut en contenir.

name

string

Nom de ressource du compte pour lequel la liste des comptes directement accessibles doit être récupérée. Cela n'a de sens que pour les organisations et les groupes d'utilisateurs. Si ce champ est vide, renvoie ListAccounts pour l'utilisateur authentifié.

filter

string

Filtre contraignant les comptes à renvoyer. La réponse n'inclut que les entrées correspondant au filtre. Si filter est vide, aucune contrainte n'est appliquée et tous les comptes (paginés) sont récupérés pour le compte demandé.

Par exemple, une requête avec le filtre type=USER_GROUP ne renverra que les groupes d'utilisateurs.

ListAccountsResponse

Message de réponse pour Accounts.ListAccounts.

Champs
accounts[]

Account

Ensemble de comptes auxquels l'utilisateur a accès. Le compte personnel de l'utilisateur effectuant la requête sera toujours le premier élément du résultat, sauf s'il est filtré.

next_page_token

string

Si le nombre de comptes dépasse la taille de page demandée, ce champ est renseigné avec un jeton permettant d'extraire la page de comptes suivante lors d'un appel ultérieur à accounts.list. S'il n'y a plus de comptes, ce champ n'est pas présent dans la réponse.

ListAnswersRequest

Message de requête pour QuestionsAndAnswers.ListAnswers

Champs
parent

string

Nom de la question pour laquelle récupérer les réponses.

page_size

int32

Nombre de réponses à extraire par page. Les valeurs page_size par défaut et maximales sont de 10.

page_token

string

Si une valeur est spécifiée, la page de réponses suivante est récupérée.

order_by

string

Ordre dans lequel les réponses sont renvoyées. Les options valides incluent "update_time desc" et 'upvote_count desc', qui renvoient les réponses triées dans l'ordre décroissant en fonction du champ demandé. L'ordre de tri par défaut est "update_time desc".

ListAnswersResponse

Message de réponse pour QuestionsAndAnswers.ListAnswers

Champs
answers[]

Answer

Réponses demandées.

total_size

int32

Nombre total de réponses publiées pour cette question sur toutes les pages.

next_page_token

string

Si le nombre de réponses dépasse la taille de page maximale demandée, ce champ est renseigné avec un jeton permettant d'extraire la page de réponses suivante lors d'un appel ultérieur. S'il n'y a plus de réponses, ce champ n'est pas présent dans la réponse.

ListAttributeMetadataRequest

Message de requête pour Location.ListAttributeMetadata. Si le nom de la ressource d'emplacement est fourni, cet emplacement sera utilisé pour renseigner le reste des critères. Si ce n'est pas le cas, indiquez la catégorie et le pays.

Champs
name

string

Nom de ressource de l'emplacement pour rechercher les attributs disponibles.

category_id

string

ID stable de la catégorie principale permettant de trouver les attributs disponibles.

country

string

Code pays ISO 3166-1 alpha-2 pour trouver les attributs disponibles.

language_code

string

Code BCP 47 de la langue dans laquelle obtenir les noms à afficher des attributs. Si cette langue n'est pas disponible, elles seront fournies en anglais.

page_size

int32

Nombre d'attributs à inclure par page. La valeur par défaut est 200, la minimale est 1.

page_token

string

Si une valeur est spécifiée, la page suivante des métadonnées d'attribut est récupérée. Le pageToken est renvoyé lorsqu'un appel à attributes.list renvoie plus de résultats que la page demandée peut en contenir.

ListAttributeMetadataResponse

Message de réponse pour Location.ListAttributeMetadata.

Champs
attributes[]

AttributeMetadata

Ensemble de métadonnées pour les attributs disponibles.

next_page_token

string

Si le nombre d'attributs dépasse la taille de page demandée, ce champ sera renseigné avec un jeton permettant d'extraire la page d'attributs suivante lors d'un appel ultérieur à attributes.list. S'il n'y a plus d'attributs, ce champ ne sera pas présent dans la réponse.

ListBusinessCategoriesRequest

Champs
region_code

string

Code pays ISO 3166-1 alpha-2.

language_code

string

Code de langue BCP 47. Si la langue n'est pas disponible, l'anglais sera sélectionné par défaut.

search_term

string

Chaîne de filtre facultative de l'utilisateur.

page_size

int32

Nombre de catégories à extraire par page. La valeur par défaut est 100, la minimale est 1 et la maximale est 100.

page_token

string

Si cette valeur est spécifiée, la page de catégories suivante est récupérée.

view

CategoryView

Facultatif. Spécifie les parties de la ressource "Category" à renvoyer dans la réponse.

ListBusinessCategoriesResponse

Champs
categories[]

Category

Catégories. Les catégories constituent une vue GÉNÉRALE. Ils ne contiennent aucune information ServiceType.

total_category_count

int32

Nombre total de catégories pour les paramètres de requête.

next_page_token

string

Si le nombre de catégories dépasse la taille de page demandée, ce champ sera renseigné avec un jeton permettant d'extraire la page de catégories suivante lors d'un appel ultérieur à ListBusinessCategories.

ListCustomerMediaItemsRequest

Message de requête pour Media.ListCustomerMediaItems.

Champs
parent

string

Nom de l'établissement dont les éléments multimédias des clients seront listés.

page_size

int32

Nombre d'éléments multimédias à afficher par page. La valeur par défaut est 100, et la taille de page maximale acceptée est 200.

page_token

string

Si une valeur est spécifiée, affiche la page d'éléments multimédias suivante.

ListCustomerMediaItemsResponse

Message de réponse pour Media.ListCustomerMediaItems.

Champs
media_items[]

MediaItem

Liste d'éléments multimédias renvoyée.

total_media_item_count

int32

Nombre total d'éléments multimédias pour cet établissement, quelle que soit la pagination. Ce nombre est approximatif, en particulier lorsque les résultats s'affichent sur plusieurs pages.

next_page_token

string

Si le nombre d'éléments multimédias est supérieur à la taille de page demandée, ce champ est renseigné avec un jeton permettant d'extraire la page d'éléments multimédias suivante lors d'un appel ultérieur à ListCustomerMediaItems.

ListInsuranceNetworksRequest

Message de requête pour InsuranceNetworkService.ListInsuranceNetworks

Champs
parent

string

Obligatoire. Nom de l'établissement dont les réseaux d'assurance seront listés. Le nom a le format suivant: accounts/{account_id}/locations/{location_id}

language_code

string

Facultatif. Code BCP 47 du langage. Si aucun code de langue n'est fourni, la langue par défaut est l'anglais. Actuellement, uniquement les lettres "en" est pris en charge.

page_size

int32

Nombre de réseaux d'assurance à afficher par page. La valeur par défaut est 5 000. La taille de page maximale est de 10 000.

page_token

string

Si une valeur est spécifiée, affiche la page suivante des réseaux d'assurance.

ListInsuranceNetworksResponse

Message de réponse pour InsuranceNetworkService.ListInsuranceNetworks

Champs
networks[]

InsuranceNetwork

Liste des réseaux d'assurances acceptés par Google.

next_page_token

string

Si le nombre de réseaux d'assurance est supérieur à la taille de page demandée, ce champ est renseigné avec un jeton permettant d'extraire la page suivante des réseaux d'assurance lors d'un appel ultérieur à ListInsuranceNetworks.

ListInvitationsRequest

Message de requête pour AccessControl.ListInvitations.

Champs
parent

string

Nom du compte à partir duquel la liste d'invitations est extraite.

target_type

TargetType

Spécifie les types de cibles à afficher dans la réponse.

TargetType

Type de cible auquel une invitation est destinée.

Enums
ALL Répertoriez les invitations pour tous les types de cibles. Il s'agit de la valeur par défaut.
ACCOUNTS_ONLY Afficher les invitations uniquement pour les cibles de type Compte.
LOCATIONS_ONLY Afficher les invitations uniquement pour les cibles de type "Zone géographique".

ListInvitationsResponse

Message de réponse pour AccessControl.ListInvitations.

Champs
invitations[]

Invitation

Ensemble d'invitations d'établissements en attente pour le compte. Le nombre d'invitations répertoriées ici ne peut pas dépasser 1 000.

ListLocalPostsRequest

Message de requête pour ListLocalPosts.

Champs
parent

string

Nom de l'établissement dont les posts locaux seront répertoriés.

page_size

int32

Nombre de posts locaux à afficher par page. Valeur par défaut : 20. La taille minimale est de 1 et la taille de page maximale est de 100.

page_token

string

Si une valeur est spécifiée, affiche la page de posts locaux suivante.

ListLocalPostsResponse

Message de réponse pour ListLocalPosts

Champs
local_posts[]

LocalPost

Liste de posts locaux renvoyée.

next_page_token

string

Si le nombre de posts locaux est supérieur à la taille de page demandée, ce champ est renseigné avec un jeton permettant d'extraire la page de posts locaux suivante lors d'un appel ultérieur à ListLocalPosts.

ListLocationAdminsRequest

Message de requête pour AccessControl.ListLocationAdmins.

Champs
parent

string

Nom de l'établissement dont les administrateurs doivent être listés.

ListLocationAdminsResponse

Message de réponse pour AccessControl.ListLocationAdmins.

Champs
admins[]

Admin

Une collection de Admin instances.

ListLocationsRequest

Message de requête pour Location.ListLocations.

Champs
parent

string

Nom du compte à partir duquel extraire les établissements. Si la valeur de Account est de AccountType PERSONNEL, seules les Adresses détenues directement par le compte sont renvoyées. Sinon, toutes les adresses accessibles à partir du compte sont renvoyées, directement ou indirectement.

page_size

int32

Nombre d'établissements à extraire par page. La valeur par défaut est 100, la minimale est 1 et la maximale est 100.

page_token

string

Si spécifié, il récupère les page établissements suivants. Le jeton de page est renvoyé par les appels précédents à ListLocations lorsque le nombre d'emplacements était supérieur à la taille de page demandée.

filter

string

Filtre contraignant les établissements à renvoyer. La réponse n'inclut que les entrées correspondant au filtre. Si filter est vide, les contraintes sont appliquées et tous les établissements (paginés) sont récupérés pour le compte demandé.

Pour en savoir plus sur les champs valides et obtenir des exemples d'utilisation, consultez le guide Utiliser les données de localisation.

language_code
(deprecated)

string

Code de langue BCP 47 dans lequel obtenir les propriétés de localisation d'affichage. Si cette langue n'est pas disponible, elles seront fournies dans la langue du pays. Si aucune de ces informations n'est disponible, elles seront fournies en anglais.

Obsolète. Après le 15 août 2020, ce champ ne sera plus appliqué. À la place, la langue du lieu sera toujours utilisée.

order_by

string

Ordre de tri de la requête. Les différents champs doivent être séparés par une virgule en suivant la syntaxe SQL. Par défaut, l'ordre de tri est croissant. Pour indiquer l'ordre décroissant, un suffixe " desc" doit être ajouté. Les champs valides pour "order_by" sont location_name et store_code. Par exemple : "location_name, store_code desc" ou "location_name" ou "store_code desc"

ListLocationsResponse

Message de réponse pour Location.ListLocations.

Champs
locations[]

Location

Emplacements.

next_page_token

string

Si le nombre d'établissements dépasse la taille de page demandée, ce champ est renseigné avec un jeton permettant d'extraire la page d'établissements suivante lors d'un appel ultérieur à ListLocations. S'il n'y a plus d'établissements, ce champ n'est pas présent dans la réponse.

total_size

int32

Nombre approximatif d'établissements dans la liste, quelle que soit la pagination.

ListMediaItemsRequest

Message de requête pour Media.ListMediaItems.

Champs
parent

string

Nom de l'établissement dont les éléments multimédias seront répertoriés.

page_size

int32

Nombre d'éléments multimédias à afficher par page. La valeur par défaut est 100, ce qui correspond au nombre maximal d'éléments multimédias pouvant être ajoutés à un établissement à l'aide de l'API Google My Business. La taille de page maximale est de 2 500.

page_token

string

Si une valeur est spécifiée, affiche la page d'éléments multimédias suivante.

ListMediaItemsResponse

Message de réponse pour Media.ListMediaItems.

Champs
media_items[]

MediaItem

Liste d'éléments multimédias renvoyée.

total_media_item_count

int32

Nombre total d'éléments multimédias pour cet établissement, quelle que soit la pagination.

next_page_token

string

Si le nombre d'éléments multimédias est supérieur à la taille de page demandée, ce champ est renseigné avec un jeton permettant d'extraire la page d'éléments multimédias suivante lors d'un appel ultérieur à ListMediaItems.

ListQuestionsRequest

Message de requête pour QuestionsAndAnswers.ListQuestions

Champs
parent

string

Nom de l'établissement pour lequel récupérer les questions.

page_size

int32

Nombre de questions à extraire par page. Les valeurs page_size par défaut et maximales sont de 10.

page_token

string

Si une valeur est spécifiée, la page de questions suivante est récupérée.

answers_per_question

int32

Nombre de réponses à extraire par question. Les valeurs answers_per_question par défaut et maximales sont de 10.

filter

string

Filtre contraignant les questions à renvoyer. Le seul filtre actuellement pris en charge est "ignore_answered=true".

order_by

string

Ordre dans lequel les questions doivent être renvoyées. Les options valides incluent "update_time desc" et 'upvote_count desc', qui renvoient les questions triées dans l'ordre décroissant en fonction du champ demandé. L'ordre de tri par défaut est "update_time desc".

ListQuestionsResponse

Message de réponse pour QuestionsAndAnswers.ListQuestions

Champs
questions[]

Question

Les questions demandées,

total_size

int32

Nombre total de questions publiées pour cet établissement sur l'ensemble des pages.

next_page_token

string

Si le nombre de questions dépasse la taille de page maximale demandée, ce champ est renseigné avec un jeton permettant d'extraire la page de questions suivante lors d'un appel ultérieur. S'il n'y a plus de questions, ce champ n'apparaît pas dans la réponse.

ListRecommendedGoogleLocationsRequest

Message de requête permettant de lister les lieux recommandés pour un compte de fiche d'établissement.

Champs
name

string

Nom de la ressource de compte pour laquelle extraire les emplacements Google recommandés.

page_size

int32

Nombre d'établissements à extraire par page. La valeur par défaut est 25, la minimale est 1 et la maximale est 100.

page_token

string

Si une valeur est spécifiée, la page d'établissements suivante est récupérée.

ListRecommendedGoogleLocationsResponse

Message de réponse pour GoogleLocations.ListRecommendedGoogleLocations.

Il contient également des établissements qui ont été revendiqués par d'autres utilisateurs de la fiche depuis leur dernière recommandation dans ce compte.

Champs
google_locations[]

GoogleLocation

Établissements recommandés pour un compte de fiche d'établissement. Chacun de ces éléments représente un GoogleLocation présent sur Maps. Les établissements sont triés par ordre décroissant de pertinence par rapport au compte de la fiche d'établissement.

total_size

int32

Nombre total d'établissements recommandés pour ce compte de fiche d'établissement, quelle que soit la pagination.

next_page_token

string

Au cours de la pagination, si d'autres emplacements sont disponibles à extraire sur la page suivante, ce champ est renseigné avec un jeton permettant d'extraire la page d'établissements suivante dans un appel ultérieur. S'il n'y a plus d'établissements à récupérer, ce champ n'est pas présent dans la réponse.

ListReviewsRequest

Message de requête pour Reviews.ListReviews.

Champs
parent

string

Nom de l'établissement pour lequel extraire les avis.

page_size

int32

Nombre d'avis à extraire par page. La valeur maximale de page_size est de 50.

page_token

string

Si elle est spécifiée, la page d'avis suivante est récupérée.

order_by

string

Spécifie le champ selon lequel trier les avis. Si aucune valeur n'est spécifiée, l'ordre des avis renvoyés sera défini par défaut sur update_time desc. Les ordres de tri valides sont rating, rating desc et update_time desc.

ListReviewsResponse

Message de réponse pour Reviews.ListReviews.

Champs
reviews[]

Review

Les avis

average_rating

double

Note moyenne de tous les avis pour cet établissement, sur une échelle de 1 à 5 (5 étant la note la plus élevée).

total_review_count

int32

Nombre total d'avis pour cet établissement.

next_page_token

string

Si le nombre d'avis dépasse la taille de page demandée, ce champ est renseigné avec un jeton permettant d'extraire la page d'avis suivante lors d'un appel ultérieur à ListReviews. S'il n'y a plus d'avis, ce champ n'est pas présent dans la réponse.

ListVerificationsRequest

Message de requête pour Verifications.ListVerifications.

Champs
parent

string

Nom de ressource de l'emplacement auquel appartiennent les demandes de validation.

page_size

int32

Nombre de validations à inclure par page. Si cette règle n'est pas configurée, la fonction renvoie tous les résultats.

page_token

string

Si une valeur est spécifiée, affiche la page de validations suivante.

ListVerificationsResponse

Message de réponse pour Verifications.ListVerifications.

Champs
verifications[]

Verification

Liste des validations.

next_page_token

string

Si le nombre de validations dépasse la taille de page demandée, ce champ sera renseigné avec un jeton permettant de récupérer la page de validation suivante lors d'un appel ultérieur. S'il n'y a plus d'attributs, ce champ ne sera pas présent dans la réponse.

LocalPost

Représente un post local pour un établissement.

Champs
name

string

Uniquement en sortie. Identifiant Google de ce post local au format suivant: accounts/{account_id}/locations/{location_id}/localPosts/{local_post_id}

language_code

string

Langue du post local.

summary

string

Description/Corps du post local.

call_to_action

CallToAction

URL vers laquelle les utilisateurs sont redirigés lorsqu'ils cliquent sur la promotion. Ignoré pour le type de sujet OFFER.

create_time

Timestamp

Uniquement en sortie. Heure de création du post.

update_time

Timestamp

Uniquement en sortie. Heure de la dernière modification du post publié par l'utilisateur.

event

LocalPostEvent

Informations sur les événements. Obligatoire pour les types de sujets EVENT et OFFER.

state

LocalPostState

Uniquement en sortie. État de la publication indiquant la partie de son cycle de vie dans laquelle elle se trouve.

media[]

MediaItem

Contenu multimédia associé au post. source_url est le seul champ de données accepté pour un élément MediaItem LocalPost.

search_url

string

Uniquement en sortie. Lien vers le post local dans la recherche Google. Vous pouvez utiliser ce lien pour partager la publication sur les réseaux sociaux, par e-mail, par SMS, etc.

topic_type

LocalPostTopicType

Obligatoire. Type de sujet du post: standard, événement, offre ou alerte.

alert_type

AlertType

Type d'alerte pour lequel le post est créé. Ce champ s'applique uniquement aux messages de l'alerte topic_type et se comporte comme un sous-type d'alertes.

offer

LocalPostOffer

Données supplémentaires pour les posts d'offres. Ce paramètre ne doit être défini que lorsque le champ topic_type est défini sur OFFER.

LocalPostState

Indique l'état du post.

Enums
LOCAL_POST_STATE_UNSPECIFIED État non spécifié.
REJECTED Ce post a été refusé, car il ne respecte pas le règlement relatif au contenu.
LIVE Ce post est publié et apparaît actuellement dans les résultats de recherche.
PROCESSING Ce post est en cours de traitement et n'apparaît pas dans les résultats de recherche.

LocalPostEvent

Toutes les informations concernant un événement présenté dans un post local.

Champs
title

string

Nom de l'événement.

schedule

TimeInterval

Dates et heures de début et de fin de l'événement

LocalPostMetrics

Toutes les métriques requises pour un post local.

Champs
local_post_name

string

metric_values[]

MetricValue

Liste de valeurs pour les métriques demandées.

LocalPostOffer

Champs spécifiques pour les posts d'offres.

Champs
coupon_code

string

Facultatif. Code promotionnel utilisable en magasin ou en ligne.

redeem_online_url

string

Facultatif. Lien en ligne permettant d'utiliser l'offre.

terms_conditions

string

Facultatif. Conditions d'utilisation de l'offre

LocalPostTopicType

Type de sujet du post local, qui permet de sélectionner différents modèles pour créer et afficher un post.

Enums
LOCAL_POST_TOPIC_TYPE_UNSPECIFIED Aucun type de post n'est spécifié.
STANDARD Le post contient des informations de base, comme un résumé et des images.
EVENT Le post contient des informations de base et un événement.
OFFER Le post contient des informations de base, un événement et du contenu lié à une offre (code promotionnel, par exemple).
ALERT Annonces urgentes et prioritaires concernant un événement en cours. Il n'est pas toujours possible de créer des posts de ce type.

Lieu

Un établissement. Consultez l'article du Centre d'aide pour obtenir une description détaillée de ces champs ou le point de terminaison de la catégorie pour obtenir la liste des catégories d'activité valides.

Champs
name

string

Identifiant Google de cet établissement, au format suivant: accounts/{account_id}/locations/{location_id}

Dans le cas de correspondances, ce champ n'est pas renseigné.

language_code

string

Langue du lieu. Défini lors de la création et non modifiable.

store_code

string

Identifiant externe associé à cet établissement, qui doit être unique au sein d'un compte donné. Cela vous permet d'associer l'établissement à vos propres données.

location_name

string

Le nom de l'établissement doit correspondre au nom réel de votre établissement, tel qu'il est connu des clients, tel qu'il figure sur votre devanture, votre site Web et vos documents. Toute information supplémentaire, le cas échéant, peut être incluse dans d'autres champs de la ressource (par exemple, Address ou Categories). N'ajoutez pas d'informations inutiles à votre nom (par exemple, préférez "Google" plutôt que "Google Inc. - Siège social de Mountain View"). N'ajoutez pas de slogan marketing, de codes de magasin, de caractères spéciaux, d'horaires d'ouverture, d'état de fermeture ou d'ouverture, de numéros de téléphone, d'URL de sites Web, d'informations sur les services ou produits, d'informations sur le lieu, l'adresse, l'itinéraire, ni sur l'endroit où se trouve l'établissement (par exemple, "Distributeur de billets Banque centrale à Biarritz).

primary_phone

string

Un numéro de téléphone permettant d'être directement mis en relation avec votre établissement Dans la mesure du possible, indiquez le numéro de téléphone local de votre établissement plutôt que celui d'un centre d'appels.

additional_phones[]

string

Jusqu'à deux numéros de téléphone (mobile ou fixe, pas de fax) permettant de joindre votre établissement, en plus du numéro de téléphone principal

address

PostalAddress

Adresse précise et exacte permettant de décrire votre établissement. Les boîtes postales ou boîtes aux lettres situées à des adresses distantes ne sont pas autorisées. Pour le moment, vous pouvez spécifier un maximum de cinq valeurs address_lines dans l'adresse.

primary_category

Category

Catégorie qui décrit le mieux l'activité principale de l'établissement.

additional_categories[]

Category

Catégories supplémentaires permettant de décrire votre entreprise. Les catégories permettent à vos clients de trouver des résultats précis et spécifiques pour les services qui les intéressent. Pour que les informations sur votre établissement restent exactes et à jour, veillez à utiliser le moins de catégories possible pour décrire votre activité principale. Choisissez des catégories aussi spécifiques que possible, tout en veillant à ce qu'elles correspondent bien à votre activité principale.

website_url

string

URL de cet établissement. Si possible, utilisez une URL qui représente l'établissement en question plutôt qu'un site Web/une URL générique qui représente tous les établissements ou la marque.

regular_hours

BusinessHours

Horaires d'ouverture de l'établissement

special_hours

SpecialHours

Horaires d'ouverture exceptionnels de l'établissement. Cela inclut généralement les horaires de jours fériés et d'autres heures en dehors des heures d'ouverture habituelles. Ces horaires remplacent les horaires d'ouverture habituels.

service_area

ServiceAreaBusiness

Les établissements de services de proximité à domicile proposent leurs services à l'adresse du client. S'il s'agit d'un établissement de services de proximité à domicile, ce champ décrit la ou les zones desservies par l'établissement.

location_key

LocationKey

Ensemble de clés permettant d'associer cet établissement à d'autres sites Google, tels qu'une page Google+ et des adresses Google Maps.

labels[]

string

Ensemble de chaînes au format libre pour vous permettre d'ajouter des tags à votre établissement. Ces libellés ne sont PAS visibles par l'utilisateur. vous seul pouvez les voir. Limité à 255 caractères (par libellé).

ad_words_location_extensions

AdWordsLocationExtensions

Informations supplémentaires qui s'affichent dans AdWords.

latlng

LatLng

Latitude et longitude fournies par l'utilisateur. Lors de la création d'un établissement, ce champ est ignoré si l'adresse fournie est correctement géocodée. Ce champ n'est renvoyé que pour les demandes GET si la valeur latlng fournie par l'utilisateur a été acceptée lors de la création ou si la valeur latlng a été modifiée via le site Web de la fiche d'établissement. Impossible de mettre à jour ce champ.

open_info

OpenInfo

Indicateur indiquant si l'établissement est actuellement ouvert.

location_state

LocationState

Uniquement en sortie. Ensemble de valeurs booléennes reflétant l'état d'un établissement.

attributes[]

Attribute

Attributs pour cet établissement.

metadata

Metadata

Uniquement en sortie. Autres informations non modifiables par l'utilisateur.

price_lists[]
(deprecated)

PriceList

Obsolète: informations sur les tarifs pour cet emplacement.

profile

Profile

Décrivez votre entreprise avec vos propres mots, et partagez avec les utilisateurs l'histoire unique de votre entreprise et de vos offres.

relationship_data

RelationshipData

Tous les établissements et la chaîne associés.

more_hours[]

MoreHours

Des horaires supplémentaires pour les différents services d'un établissement ou des clients spécifiques.

Métadonnées

Autres informations sur l'établissement non modifiables par l'utilisateur.

Champs
duplicate
(deprecated)

Duplicate

Informations sur l'établissement que cet établissement duplique. Présent uniquement lorsque la valeur de location_state.is_duplicate est "true". Obsolète: nous ne prenons plus en charge les informations détaillées sur les doublons.

maps_url

string

Lien vers l'établissement sur Maps.

new_review_url

string

Lien vers la page de la recherche Google sur laquelle les clients peuvent laisser un avis sur l'établissement.

Dupliquer

Informations sur l'établissement que cet établissement duplique.

Champs
location_name

string

Nom de ressource de l'établissement dupliqué. Renseigné uniquement si l'utilisateur authentifié dispose de droits d'accès à cet établissement et que celui-ci n'est pas supprimé.

place_id

string

ID de l'établissement concerné par ce doublon.

access

Access

Indique si l'utilisateur a accès à l'établissement dupliqué.

Accès

Niveau d'accès de l'utilisateur à l'établissement dupliqué. Cette propriété remplace la propriété et doit être utilisée à la place.

Enums
ACCESS_UNSPECIFIED Non spécifié.
ACCESS_UNKNOWN Impossible de déterminer si l'utilisateur a accès à l'établissement qu'il duplique.
ALLOWED L'utilisateur a accès à l'établissement qu'il duplique.
INSUFFICIENT L'utilisateur n'a pas accès à l'établissement qu'il duplique.

RelationshipData

Informations sur tous les emplacements parents et enfants associés à celui-ci.

Champs
parent_chain

string

Nom de ressource de la chaîne à laquelle appartient l'établissement. How to find Chain ID

LocationDrivingDirectionMetrics

Emplacement indexé avec les régions d'où viennent généralement les utilisateurs. Ces données sont obtenues en comptabilisant le nombre de demandes d'itinéraire vers cet établissement provenant de chaque région.

Champs
location_name

string

Nom de ressource d'emplacement auquel cette valeur de métrique appartient.

top_direction_sources[]

TopDirectionSources

Requêtes d'itinéraire par région source. Par convention, les résultats sont triés par nombre (10 résultats au maximum).

time_zone

string

Fuseau horaire (ID de fuseau horaire IANA, par exemple, "Europe/Londres") du lieu.

TopDirectionSources

Principales régions d'où proviennent les demandes d'itinéraire.

Champs
day_count

int32

Nombre de jours sur lesquels les données sont agrégées.

region_counts[]

RegionCount

Régions triées par ordre décroissant du nombre.

RegionCount

Une région avec le nombre de requêtes associé.

Champs
latlng

LatLng

Centre de la région.

label

string

Libellé lisible pour la région.

count

int64

Nombre de demandes d'itinéraires depuis cette région.

LocationKey

Références de clés alternatives/de substitution pour un établissement.

Champs
plus_page_id

string

Uniquement en sortie. Si cet établissement est associé à une page Google+, ce champ est renseigné avec l'ID de la page Google+ de cet établissement.

place_id

string

Si cet établissement a été validé et s'il est associé à Google Maps ou s'il apparaît dans Google Maps, l'ID de lieu est inséré dans ce champ. Cet ID peut être utilisé dans diverses API Places.

Si cet établissement n'est pas validé, ce champ peut être renseigné si l'établissement a été associé à un lieu qui apparaît sur Google Maps.

Ce champ peut être défini lors des appels Create, mais pas Update.

La valeur booléenne explicit_no_place_id supplémentaire indique si un ID de lieu non défini est intentionnel ou non.

explicit_no_place_id

bool

Uniquement en sortie. La valeur "true" indique qu'un identifiant de lieu n'est pas défini, ce qui n'est pas le cas si aucune association n'a encore été effectuée.

request_id

string

Uniquement en sortie. request_id utilisé pour créer cet établissement. Ce champ peut être vide si cet établissement a été créé en dehors de l'API Google My Business ou des établissements des fiches.

LocationMetrics

Série de métriques et de RépartitionMetrics associées à un établissement sur une période donnée.

Champs
location_name

string

Nom de ressource d'emplacement auquel ces valeurs appartiennent.

time_zone

string

Fuseau horaire IANA de l'emplacement.

metric_values[]

MetricValue

Liste de valeurs pour les métriques demandées.

LocationReview

Représente un avis avec des informations géographiques.

Champs
name

string

Nom de la ressource d'emplacement.

review

Review

Avis sur l'établissement.

LocationState

Contient un ensemble de valeurs booléennes indiquant l'état d'un établissement.

Champs
is_google_updated

bool

Uniquement en sortie. Indique si l'ID de lieu associé à cet établissement comporte des mises à jour.

is_duplicate

bool

Uniquement en sortie. Indique si l'établissement est un doublon d'un autre établissement.

is_suspended

bool

Uniquement en sortie. Indique si l'établissement est suspendu. Les utilisateurs finaux ne peuvent pas voir les établissements suspendus dans les produits Google. Si vous pensez qu'il s'agit d'une erreur, consultez cet article du Centre d'aide.

can_update

bool

Uniquement en sortie. Indique si l'établissement peut être mis à jour.

can_delete

bool

Uniquement en sortie. Indique si l'établissement peut être supprimé à l'aide de l'API Google My Business.

is_verified

bool

Uniquement en sortie. Indique si l'établissement est validé.

needs_reverification

bool

Uniquement en sortie. Indique si l'établissement doit être de nouveau validé.

is_pending_review

bool

Uniquement en sortie. Indique si l'examen de l'établissement est en attente.

is_disabled

bool

Uniquement en sortie. Indique si l'établissement est désactivé.

is_published

bool

Uniquement en sortie. Indique si l'établissement est publié.

is_disconnected

bool

Uniquement en sortie. Indique si l'établissement est déconnecté d'un lieu sur Google Maps.

is_local_post_api_disabled

bool

Uniquement en sortie. Indique si accounts.locations.localPosts est désactivé pour cet établissement.

can_modify_service_list

bool

Uniquement en sortie. Indique si la fiche peut modifier une ServiceList.

can_have_food_menus

bool

Uniquement en sortie. Indique si la fiche peut bénéficier d'un menu.

has_pending_edits

bool

Uniquement en sortie. Indique si l'une des propriétés de cet établissement est en attente de modification.

has_pending_verification

bool

Uniquement en sortie. Indique si l'établissement présente des demandes de validation en attente.

can_operate_health_data

bool

Uniquement en sortie. Indique si l'établissement peut exploiter les données de santé.

can_operate_lodging_data

bool

Uniquement en sortie. Indique si l'établissement peut exploiter les données sur l'hébergement.

MatchedLocation

Représente une correspondance possible avec un emplacement.

Champs
location

Location

Zone géographique partiellement remplie qui constitue une correspondance potentielle. Les champs non renseignés incluent, sans s'y limiter: name (l'établissement correspondant ne peut pas être récupéré via GetLocation ni BatchGetLocations). store_code; Détails de la zone de couverture de service_area labels; ad_words_location_extensions photos

is_exact_match

bool

S'agit-il d'une correspondance exacte ?

MediaItem

Un seul élément multimédia.

Champs
name

string

Nom de ressource de cet élément multimédia. accounts/{account_id}/locations/{location_id}/media/{media_key}

media_format

MediaFormat

Format de cet élément multimédia. Doit être défini lors de la création de l'élément multimédia et est en lecture seule pour toutes les autres demandes. Ce paramètre ne peut pas être modifié.

location_association

LocationAssociation

Obligatoire lors de l'appel de CreatePhoto. Décrit comment cet élément multimédia est associé à son emplacement. Doit être une catégorie (par exemple, EXTERIOR) ou l'identifiant d'un article de la liste de prix.

Nécessaire lorsque vous ajoutez des contenus multimédias à un emplacement avec CreateMediaItem. Pour les autres types de médias, tels que les photos sur les posts locaux, cette option ne sera pas disponible.

google_url

string

Uniquement en sortie. URL hébergée par Google pour cet élément multimédia. Cette URL n'est pas statique, car elle peut changer au fil du temps. Pour les vidéos, il s'agit d'un aperçu avec une icône de lecture superposée.

thumbnail_url

string

Uniquement en sortie. URL de la vignette de cet élément multimédia, si elle est fournie.

create_time

Timestamp

Uniquement en sortie. Heure de création de cet élément multimédia.

dimensions

Dimensions

Uniquement en sortie. Dimensions (largeur et hauteur) en pixels.

insights

MediaInsights

Uniquement en sortie. Statistiques sur cet élément multimédia.

attribution

Attribution

Uniquement en sortie. Informations sur l'attribution pour les éléments multimédias des clients. Vous devez afficher cette attribution telle qu'elle a été fournie à vos utilisateurs, et vous ne devez pas la supprimer ni la modifier.

description

string

Description de cet élément multimédia. Les descriptions ne peuvent pas être modifiées via l'API Google My Business, mais vous pouvez les définir lors de la création d'un élément multimédia autre que la photo de couverture.

Champ d'union data. Source de données de l'élément multimédia. Lorsque vous créez un élément multimédia, vous devez fournir une URL ou des références de données.

À l'exception des catégories PROFILE et COVER, toutes les photos doivent mesurer un minimum de 250 pixels sur le bord court et une taille de fichier d'au moins 10 240 octets.

Toutes les photos importées doivent respecter les Consignes concernant les photos des fiches d'établissement. data ne peut être qu'un des éléments suivants :

source_url

string

URL accessible publiquement à partir de laquelle l'élément multimédia peut être récupéré.

Lors de la création de l'une de ces valeurs, vous devez définir data_ref afin de spécifier la source de l'élément multimédia.

Si source_url a été utilisé lors de la création d'un élément multimédia, il sera renseigné avec cette URL source lors de la récupération de l'élément multimédia.

Impossible de mettre à jour ce champ.

data_ref

MediaItemDataRef

Uniquement en entrée. Référence aux données binaires de l'élément multimédia obtenues par la méthode StartUploadMediaItemData.

Lors de la création d'un élément multimédia,

sourceUrl

ou

dataRef

doit être défini.

Attribution

Informations d'attribution pour les éléments multimédias des clients, tels que le nom et la photo de profil du contributeur.

Champs
profile_name

string

Nom d'utilisateur auquel attribuer l'élément multimédia.

profile_photo_url

string

URL de la vignette de la photo de profil de l'utilisateur attribué.

takedown_url

string

URL de la page de retrait, où l'élément multimédia peut être signalé s'il est inapproprié.

profile_url

string

URL de la page de profil Google Maps de l'utilisateur attribué.

Dimensions

Dimensions de l'élément multimédia.

Champs
width_pixels

int32

Largeur de l'élément multimédia, en pixels.

height_pixels

int32

Hauteur de l'élément multimédia, en pixels.

LocationAssociation

Association de l'élément multimédia à son emplacement.

Champs
Champ d'union location_attachment_type. L'élément multimédia de l'établissement doit être associé à une catégorie ou à l'ID d'un article de la liste de prix. Aucun des éléments multimédias qui ne sont pas associés à l'établissement (par exemple, des photos des posts locaux) ne doit comporter aucun de ces éléments. location_attachment_type ne peut être qu'un des éléments suivants :
category

Category

Catégorie à laquelle cette photo d'établissement appartient.

price_list_item_id

string

Identifiant d'un article de la liste de prix auquel cette photo d'établissement est associée.

Catégorie

Énumération pour la catégorie d'élément multimédia.

Enums
CATEGORY_UNSPECIFIED Catégorie non spécifiée.
COVER Photo de couverture. Un établissement ne possède qu'une seule photo de couverture.
PROFILE Photo de profil. Un établissement ne peut avoir qu'une seule photo de profil.
EXTERIOR Support extérieur.
INTERIOR Éléments multimédias de l'intérieur.
PRODUCT Contenus multimédias du produit.
AT_WORK Au travail médias.
FOOD_AND_DRINK Élément multimédia représentant des aliments et des boissons.
MENU Contenu multimédia du menu.
COMMON_AREA Élément multimédia représentant les espaces communs.
ROOMS Contenu multimédia des salles.
TEAMS Éléments multimédias des équipes.
ADDITIONAL Contenus multimédias supplémentaires sans catégorie.

MediaFormat

Énumération pour le format du média.

Enums
MEDIA_FORMAT_UNSPECIFIED Format non spécifié.
PHOTO L'élément multimédia est une photo. Dans cette version, seules les photos sont prises en charge.
VIDEO L'élément multimédia est une vidéo.

MediaInsights

Insights et statistiques sur l'élément multimédia.

Champs
view_count

int64

Uniquement en sortie. Nombre de fois où l'élément multimédia a été vu.

MediaItemDataRef

Référence aux données binaires photo d'un MediaItem importé via l'API Google My Business.

Créez une référence de données à l'aide de StartUploadMediaItemData, puis utilisez-la lorsque vous importez des octets dans [UpdateMedia], puis appelez CreateMediaItem.

Champs
resource_name

string

Identifiant unique des données binaires de cet élément multimédia. Permet d'importer les données des photos avec [UpdateMedia] et de créer un élément multimédia à partir de ces octets avec CreateMediaItem.

Exemple d'importation d'octets: curl -X POST -T{path_to_file} "http://mybusiness.googleapis.com/upload/v1/media/{resource_name}?upload_type=media"

Pour les appels CreateMediaItem, définissez ce paramètre en tant que MediaItem data_ref.

Étiquette à utiliser pour afficher le menu et ses différents sous-composants.

Champs
display_name

string

Obligatoire. Nom à afficher du composant.

description

string

Facultatif. Informations supplémentaires sur le composant.

language_code

string

Facultatif. Code de langue BCP 47. Si la langue n'est pas disponible, l'anglais sera sélectionné par défaut.

Métrique

Métrique des données sur une ressource.

Enums
METRIC_UNSPECIFIED Aucune métrique spécifiée.
ALL Raccourci pour demander toutes les métriques disponibles. Les métriques incluses dans TOUS les métriques varient en fonction de la ressource pour laquelle les insights sont demandés.
QUERIES_DIRECT Nombre de fois où la ressource a été affichée lors d'une recherche directe de l'établissement.
QUERIES_INDIRECT Nombre de fois où la ressource a été affichée suite à une recherche par catégorie (restaurant, par exemple).
QUERIES_CHAIN Nombre de fois où une ressource a été affichée suite à une recherche sur la chaîne à laquelle elle appartient ou sur une marque qu'elle vend. Exemples : Starbucks, Adidas. Il s'agit d'un sous-ensemble de QUERIES_INDIRECT.
VIEWS_MAPS Nombre de fois où la ressource a été consultée sur Google Maps.
ACTIONS_WEBSITE Nombre de fois où les visiteurs ont cliqué sur le site Web.
ACTIONS_PHONE Nombre de fois où les utilisateurs ont cliqué sur le numéro de téléphone.
ACTIONS_DRIVING_DIRECTIONS Nombre de fois où un itinéraire en voiture a été demandé.
PHOTOS_VIEWS_MERCHANT Nombre de vues des éléments multimédias importés par le marchand.
PHOTOS_VIEWS_CUSTOMERS Nombre de vues des éléments multimédias importés par les clients.
PHOTOS_COUNT_MERCHANT Nombre total d'éléments multimédias actuellement en ligne qui ont été importés par le marchand.
PHOTOS_COUNT_CUSTOMERS Nombre total d'éléments multimédias actuellement en ligne qui ont été importés par des clients.
LOCAL_POST_VIEWS_SEARCH Nombre de fois où le post local a été consulté dans la recherche Google.
LOCAL_POST_ACTIONS_CALL_TO_ACTION Nombre de fois où les utilisateurs ont cliqué sur le bouton d'incitation à l'action sur Google.

MetricOption

Option permettant de spécifier la manière dont les données doivent être affichées dans la réponse.

Enums
METRIC_OPTION_UNSPECIFIED Aucune option de métrique spécifiée. La valeur AGGREGATED_TOTAL sera utilisée par défaut dans une requête.
AGGREGATED_TOTAL Les valeurs renvoyées sont agrégées sur l'ensemble de la période. Il s'agit de la valeur par défaut.
AGGREGATED_DAILY Renvoyez des valeurs horodatées quotidiennes pour une période donnée.
BREAKDOWN_DAY_OF_WEEK Les valeurs seront renvoyées par jour de la semaine. Valable uniquement pour ACTIONS_PHONE.
BREAKDOWN_HOUR_OF_DAY Les valeurs seront renvoyées par heure de la journée. Valable uniquement pour ACTIONS_PHONE.

MetricRequest

Requête permettant de renvoyer les valeurs d'une métrique et les options relatives à la manière dont ces valeurs doivent être renvoyées.

Champs
metric

Metric

Métrique demandée.

options[]

MetricOption

Indique comment les valeurs doivent apparaître lorsqu'elles sont renvoyées.

MetricValue

Valeur correspondant à une seule métrique à partir d'une heure de début.

Champs
metric

Metric

Métrique à laquelle la valeur s'applique.

total_value

DimensionalMetricValue

Valeur totale agrégée pour cette métrique. Défini pour l'option AGGREGATED_TOTAL.

dimensional_values[]

DimensionalMetricValue

Valeurs des dimensions de cette métrique.

MoreHours

Périodes d'ouverture pour certains types d'entreprises.

Champs
hours_type_id

string

Obligatoire. Type d'horaires. Les clients doivent appeler {#link businessCategories:BatchGet} pour obtenir les types d'horaires d'ouverture acceptés pour les catégories de leurs établissements.

periods[]

TimePeriod

Obligatoire. Ensemble des horaires d'ouverture de cet établissement. Chaque période correspond à un intervalle d'heures pendant lequel l'établissement est ouvert pendant la semaine.

MoreHoursType

Autres types d'horaires qu'un établissement peut proposer, en plus de ses horaires habituels.

Champs
hours_type_id

string

Uniquement en sortie. Identifiant stable fourni par Google pour ce type d'horaires.

display_name

string

Uniquement en sortie. Nom lisible à afficher en anglais pour le type d'horaires.

localized_display_name

string

Uniquement en sortie. Nom à afficher, localisé et intelligible, pour le type d'horaires.

NetworkState

État d'un réseau d'assurance concernant cet établissement.

Enums
NETWORK_STATE_UNSPECIFIED Valeur par défaut.
ACCEPTED Ce réseau est accepté par cet établissement.
PENDING_ADD Une demande d'ajout de ce réseau à la liste des réseaux acceptés est en attente.
PENDING_DELETE Une demande de suppression de ce réseau de la liste des réseaux acceptés est en attente.
NOT_ACCEPTED Ce réseau n'est pas accepté par cet emplacement.

NotificationType

Type de notification envoyée au sujet Cloud Pub/Sub.

Enums
NOTIFICATION_TYPE_UNSPECIFIED Aucun type de notification. Ne correspondra à aucune notification.
GOOGLE_UPDATE L'établissement fait l'objet de mises à jour Google à examiner. Le champ "location_name" de la notification fournit le nom de ressource de l'établissement avec les mises à jour Google.
NEW_REVIEW Un nouvel avis a été ajouté à l'établissement. Le champ "review_name" de la notification indique le nom de la ressource de l'avis ajouté, et le champ "location_name" contient le nom de la ressource de l'établissement.
UPDATED_REVIEW Un avis sur l'établissement a été mis à jour. Le champ "review_name" de la notification indique le nom de la ressource de l'avis ajouté, et le champ "location_name" contient le nom de la ressource de l'établissement.
NEW_CUSTOMER_MEDIA Un utilisateur de Google Maps a ajouté un élément multimédia à l'établissement. La notification fournit le nom de ressource du nouvel élément multimédia.
NEW_QUESTION Une nouvelle question est ajoutée au lieu. La notification fournit le nom de ressource de la question.
UPDATED_QUESTION Une question concernant la position est mise à jour. La notification fournit le nom de ressource de la question.
NEW_ANSWER Une nouvelle réponse est ajoutée au lieu. La notification fournit le nom de ressource de la question et de la réponse.
UPDATED_ANSWER Une réponse correspondant au lieu est mise à jour. La notification fournit le nom de ressource de la question et de la réponse.
UPDATED_LOCATION_STATE L'élément LocationState de l'établissement a été mis à jour. La notification contiendra le masque de champ des champs LocationState mis à jour.

Notifications

Un sujet Google Cloud Pub/Sub dans lequel des notifications peuvent être publiées lorsqu'un établissement est mis à jour ou fait l'objet d'un nouvel avis. Il n'existe qu'une seule ressource de paramètres de notification par compte.

Champs
name

string

Uniquement en sortie. Nom de la ressource des notifications.

topic_name

string

Sujet Google Cloud Pub/Sub qui recevra des notifications lorsque des emplacements gérés par ce compte sont mis à jour. Si cette règle n'est pas configurée, aucune notification ne sera publiée.

Le compte mybusiness-api-pubsub@system.gserviceaccount.com doit au minimum disposer d'autorisations de publication sur le sujet Cloud Pub/Sub.

notification_types[]

NotificationType

Types de notifications qui seront envoyées au sujet Cloud Pub/Sub. Vous devez en spécifier au moins un. Pour ne plus recevoir de notifications, utilisez DeleteNotifications.

NutritionFacts

Ce message présente des informations nutritionnelles concernant un plat.

Champs
calories

CaloriesFact

Facultatif. Calories du plat.

total_fat

NutritionFact

Facultatif. Informations sur les matières grasses pour un plat donné.

cholesterol

NutritionFact

Facultatif. Informations sur le cholestérol pour un plat donné.

sodium

NutritionFact

Facultatif. Informations sur le sel pour un plat donné.

total_carbohydrate

NutritionFact

Facultatif. Informations sur les glucides d'un plat donné

protein

NutritionFact

Facultatif. Informations sur les protéines d'un plat donné.

CaloriesFact

Ce message fournit des informations sur les calories, avec des limites supérieure et inférieure. Vous devez indiquer un montant inférieur. Les valeurs inférieure et supérieure sont des nombres non négatifs.

Champs
lower_amount

int32

Obligatoire. Moins de calories

upper_amount

int32

Facultatif. Quantité supérieure de calories

unit

EnergyUnit

Obligatoire. Unité des informations de calories données.

EnergyUnit

Unités possibles de l'énergie alimentaire (calories).

Enums
ENERGY_UNIT_UNSPECIFIED Unité d'énergie non spécifiée
CALORIE Calories
JOULE Joule

MassUnit

Unités de masse possibles.

Enums
MASS_UNIT_UNSPECIFIED Unité de masse non spécifiée
GRAM Gram
MILLIGRAM Milligramme

NutritionFact

Ce message fournit des informations nutritionnelles avec des limites supérieure et inférieure, et peut être représenté par une unité de masse. Vous devez indiquer un montant inférieur. Les valeurs inférieure et supérieure sont des nombres non négatifs.

Champs
lower_amount

double

Obligatoire. Moins bonne quantité d'alimentation

upper_amount

double

Facultatif. Niveau d'alimentation maximal

unit

MassUnit

Obligatoire. Unité des informations nutritionnelles données.

OpenInfo

Informations sur l'état d'ouverture de l'établissement.

Champs
status

OpenForBusiness

Indique si l'établissement est actuellement ouvert ou non. Tous les établissements sont ouverts par défaut, sauf s'ils sont modifiés comme étant fermés.

can_reopen

bool

Uniquement en sortie. Indique si l'établissement peut être rouvert.

opening_date

Date

Date de la première ouverture de l'établissement. Si le jour exact n'est pas connu, seuls le mois et l'année peuvent être indiqués. La date doit être antérieure à la date du jour ou ne pas être postérieure à plus d'un an.

OpenForBusiness

Indique l'état d'un établissement.

Enums
OPEN_FOR_BUSINESS_UNSPECIFIED Non spécifié.
OPEN Indique que l'établissement est ouvert.
CLOSED_PERMANENTLY indique que l'établissement a été définitivement fermé.
CLOSED_TEMPORARILY indique que l'établissement a été temporairement fermé. Cette valeur ne peut être appliquée qu'aux zones géographiques publiées (par exemple, location_state.is_publish = true). Lorsqu'ils mettent à jour le champ d'état avec cette valeur, les clients doivent définir explicitement update_mask sur open_info.status. Aucun autre masque de mise à jour ne peut être défini pendant cet appel de mise à jour. Il s'agit d'une restriction temporaire qui sera bientôt assouplie.

PermissionLevel

Indique le niveau d'accès de l'utilisateur authentifié pour ce compte.

Enums
PERMISSION_LEVEL_UNSPECIFIED Non spécifié.
OWNER_LEVEL L'utilisateur dispose d'une autorisation de niveau propriétaire.
MEMBER_LEVEL L'utilisateur dispose d'une autorisation au niveau du membre.

PhoneInput

Entrée pour la validation par PHONE_CALL/SMS.

Champs
phone_number

string

Numéro de téléphone à appeler ou auquel un SMS doit être envoyé. Il doit s'agir de l'un des numéros de téléphone des options éligibles.

PlaceInfo

Définit une zone représentée par un ID de lieu.

Champs
name

string

Nom localisé du lieu. Par exemple, Scottsdale, AZ.

place_id

string

Identifiant du lieu. Doit correspondre à une région.

Places

Définit l'union de zones représentées par un ensemble de lieux.

Champs
place_infos[]

PlaceInfo

Zones représentées par des ID de lieu. 20 emplacements maximum.

PointRadius

Rayon autour d'un point particulier (latitude/longitude).

Champs
latlng

LatLng

Latitude/Longitude spécifiant le centre d'une zone définie par le rayon.

radius_km

float

Distance en kilomètres de la zone autour du point.

PreparationMethod

Méthode de préparation d'un plat

Enums
PREPARATION_METHOD_UNSPECIFIED Méthode de préparation non spécifiée
BAKED Méthode de cuisson
BARBECUED Méthode au barbecue
BASTED Méthode bas débit
BLANCHED Méthode blanchie
BOILED Méthode bouillie
BRAISED Méthode braisée
CODDLED Méthode connectée
FERMENTED Méthode fermentée
FRIED Méthode frite
GRILLED Méthode grillée
KNEADED Méthode avec pétrir
MARINATED Méthode marinée
PAN_FRIED Méthode frite
PICKLED Méthode avec pickled
PRESSURE_COOKED Méthode de cuisson sous pression
ROASTED Méthode de rôtissoire
SAUTEED Méthode sautée
SEARED Méthode enregistrée
SIMMERED Méthode mijotée
SMOKED Méthode "fumée"
STEAMED Méthode à vapeur
STEEPED Méthode pilotée
STIR_FRIED Méthode sautée
OTHER_METHOD Autre méthode

PriceList

Obsolète: liste d'informations sur le prix des articles. Les listes de prix sont structurées comme une ou plusieurs listes de prix, chacune contenant une ou plusieurs sections présentant un ou plusieurs articles. Par exemple, les listes de prix des repas peuvent correspondre à des menus pour le petit-déjeuner, le déjeuner et le dîner, avec des sections dédiées aux burgers, aux steaks et aux produits de la mer.

Champs
price_list_id

string

Obligatoire. Identifiant de la liste de prix. Les ID des listes de prix, des sections et des articles ne peuvent pas être dupliqués dans cet emplacement.

labels[]

Label

Obligatoire. Libellés avec marquage linguistique pour la liste de prix.

source_url

string

URL de la source facultative depuis laquelle la liste de prix a été récupérée. Par exemple, il peut s'agir de l'URL de la page qui a été automatiquement détournée pour renseigner les informations du menu.

sections[]

Section

Obligatoire. Rubriques de cette liste de prix. Chaque liste de prix doit contenir au moins une section.

Libellé

Libellé à utiliser pour afficher la liste de prix, la section ou l'article.

Champs
display_name

string

Obligatoire. Nom à afficher de la liste de prix, de la section ou de l'article.

description

string

Facultatif. Description de la liste de prix, de la section ou de l'article.

language_code

string

Facultatif. Code de langue BCP-47 auquel ces chaînes s'appliquent. Vous ne pouvez définir qu'un seul ensemble de libellés par langue.

Section

Section de la liste de prix contenant un ou plusieurs articles.

Champs
section_id

string

Obligatoire. ID de la section. Les ID des listes de prix, des sections et des articles ne peuvent pas être dupliqués dans cet emplacement.

labels[]

Label

Obligatoire. Libellés de la section avec marquage de la langue. Nous recommandons de ne pas dépasser 140 caractères pour les noms de sections et les descriptions. Veuillez indiquer au moins un ensemble d'étiquettes.

section_type

SectionType

Facultatif. Type de la section de la liste de prix actuelle. La valeur par défaut est FOOD.

items[]

Item

Articles inclus dans cette section de la liste de prix.

Élément

Un seul élément de liste. Chaque variante d'un article de la liste de prix doit avoir son propre article avec ses propres données tarifaires.

Champs
item_id

string

Obligatoire. ID de l'article. Les ID des listes de prix, des sections et des articles ne peuvent pas être dupliqués dans cet emplacement.

labels[]

Label

Obligatoire. Libellés de l'élément avec marquage de la langue. Nous recommandons de ne pas dépasser 140 caractères pour les noms d'éléments et 250 caractères pour les descriptions. Veuillez indiquer au moins un ensemble d'étiquettes.

price

Money

Facultatif. Prix de l'article

SectionType

Type de section.

Enums
SECTION_TYPE_UNSPECIFIED Non spécifié.
FOOD La section contient des éléments qui représentent des aliments.
SERVICES La section contient des éléments qui représentent des services.

Profil

Toutes les informations concernant le profil de l'établissement.

Champs
description

string

Description du lieu de votre propre voix, non modifiable par les autres utilisateurs.

Question

Représente une question unique et certaines de ses réponses.

Champs
name

string

Uniquement en sortie. Nom unique de la question. accounts/*/locations/*/questions/*

author

Author

Uniquement en sortie. Auteur de la question.

upvote_count

int32

Uniquement en sortie. Nombre de votes pour la question.

text

string

Texte de la question. Il doit contenir au moins trois mots et la longueur totale doit être supérieure ou égale à 10 caractères. La longueur maximale est de 4 096 caractères.

create_time

Timestamp

Uniquement en sortie. Code temporel correspondant au moment où la question a été rédigée.

update_time

Timestamp

Uniquement en sortie. Code temporel correspondant à la dernière modification de la question.

top_answers[]

Answer

Uniquement en sortie. Liste des réponses à la question, triées par nombre de votes pour. Selon les paramètres de la demande, cette liste de réponses peut ne pas être complète (answers_per_question)

total_answer_count

int32

Uniquement en sortie. Nombre total de réponses publiées pour cette question.

RepeatedEnumAttributeValue

Valeurs d'un attribut avec un value_type défini sur REPEATED_ENUM. Elle se compose de deux listes d'ID de valeur: ceux qui sont définis (true) et ceux qui ne sont pas définis (false). Les valeurs absentes sont considérées comme inconnues. Vous devez spécifier au moins une valeur.

Champs
set_values[]

string

Valeurs d'énumération définies.

unset_values[]

string

Valeurs d'énumération non définies.

ReportGoogleLocationRequest

Message de requête pour signaler un GoogleLocation.

Champs
name

string

Nom de ressource d'un [GoogleLocation], au format googleLocations/{googleLocationId}.

location_group_name

string

Facultatif. Nom de ressource du groupe d'établissements pour lequel cet établissement Google est signalé, au format accounts/{account_id}.

report_reason_elaboration

string

Facultatif. Entrée de texte permettant de préciser la raison pour laquelle l'utilisateur signale cette position. La longueur maximale est de 512 caractères.

report_reason_language_code

string

Facultatif. Code BCP 47 du langage utilisé dans report_reason_elaboration.

Champ d'union report_reason. Raison pour laquelle cette position est signalée. Vous devez indiquer un motif. report_reason ne peut être qu'un des éléments suivants :
report_reason_bad_location

BadLocationReason

Raison pour laquelle l'utilisateur signale cette position lorsque le problème concerne l'établissement lui-même.

report_reason_bad_recommendation

BadRecommendationReason

Raison pour laquelle l'utilisateur signale cette position lorsque le problème concerne la recommandation. Ce rapport est utile si l'établissement a été recommandé dans le compte de la fiche d'établissement.

BadLocationReason

Ensemble de raisons pouvant expliquer pourquoi vous signalez un établissement en cas de problème de qualité des données s'y rapportant.

Enums
BAD_LOCATION_REASON_UNSPECIFIED Non spécifié.
NOT_A_LOCATION L'emplacement recommandé n'est pas un emplacement réel.
PERMANENTLY_CLOSED L'établissement recommandé est définitivement fermé.
DOES_NOT_EXIST L'emplacement recommandé n'existe pas.
SPAM L'adresse recommandée est un spam, des fausses informations ou du contenu choquant.
NOT_A_BUSINESS Le lieu recommandé est un lieu privé ou une maison.
MOVED

L'emplacement recommandé a changé d'emplacement.

Il doit être accompagné d'un élément report_reason_elaboration spécifiant la nouvelle adresse.

DUPLICATE L'établissement recommandé existe déjà.

BadRecommendationReason

Ensemble de raisons possibles pour signaler une position lorsque la qualité de la recommandation (lorsque cette position est recommandée à l'utilisateur) est problématique.

Enums
BAD_RECOMMENDATION_REASON_UNSPECIFIED Non spécifié.
NOT_A_STORE_FRONT L'emplacement recommandé n'est pas une vitrine.
NOT_PART_OF_SUGGESTED_CHAIN

L'établissement recommandé n'appartient pas à la chaîne suggérée dans chain_display_name dans l'établissement renvoyé.

Il doit être accompagné d'un élément report_reason_elaboration spécifiant le nom de la chaîne appropriée.

IRRELEVANT

L'emplacement recommandé n'est pas pertinent pour l'utilisateur.

Il doit être accompagné d'un report_reason_elaboration pour expliquer pourquoi la recommandation n'est pas pertinente.

ReportLocalPostInsightsRequest

Message de requête pour Insights.ReportLocalPostInsights

Champs
name

string

Obligatoire. Nom de l'établissement pour lequel extraire des insights.

local_post_names[]

string

Obligatoire. Liste des posts pour lesquels extraire des données d'insights. Tous les posts doivent appartenir à l'établissement dont le nom est spécifié dans le champ name.

basic_request

BasicMetricsRequest

Demande d'inclusion d'insights de base sur les métriques dans le rapport. Cette demande s'applique à tous les posts demandés.

ReportLocalPostInsightsResponse

Message de réponse pour Insights.ReportLocalPostInsights

Champs
name

string

local_post_metrics[]

LocalPostMetrics

Une entrée par post demandé correspondant à cet établissement.

time_zone

string

Fuseau horaire (ID de fuseau horaire IANA, par exemple "Europe/Londres") du lieu.

ReportLocationInsightsRequest

Message de requête pour Insights.ReportLocationInsights.

Champs
name

string

Nom de ressource du compte.

location_names[]

string

Ensemble d'établissements pour lesquels extraire des insights, spécifiés par leur nom.

basic_request

BasicMetricsRequest

Demande d'inclusion d'insights de base sur les métriques dans le rapport.

driving_directions_request

DrivingDirectionMetricsRequest

Demande d'inclusion d'insights sur les demandes d'itinéraire dans le rapport.

ReportLocationInsightsResponse

Message de réponse pour Insights.ReportLocationInsights.

Champs
location_metrics[]

LocationMetrics

Ensemble de valeurs de métriques par emplacement.

location_driving_direction_metrics[]

LocationDrivingDirectionMetrics

Ensemble de valeurs permettant de générer des métriques liées aux itinéraires.

Récapitulatif

Uniquement en sortie. Représente un avis concernant un établissement.

Champs
name

string

Nom de la ressource. Pour l'avis, il se présente sous la forme accounts/{account_id}/locations/{location_id}/reviews/{review_id}

review_id

string

Identifiant unique chiffré.

reviewer

Reviewer

Auteur de l'avis.

star_rating

StarRating

Note de l'avis.

comment

string

Corps de l'avis sous forme de texte brut avec des balisages.

create_time

Timestamp

Code temporel correspondant à la date de rédaction de l'avis.

update_time

Timestamp

Code temporel correspondant à la dernière modification de l'avis.

review_reply

ReviewReply

La réponse du propriétaire/responsable de cet établissement à cet avis.

Reviewer

Représente l'auteur de l'avis.

Champs
profile_photo_url

string

Lien vers la photo de profil de l'auteur de l'avis. Renseigné uniquement si is_anonymous est défini sur "false".

display_name

string

Nom de l'auteur de l'avis. Renseigné uniquement avec le vrai nom de l'auteur de l'avis si la valeur de is_anonymous est "false".

is_anonymous

bool

Indique si l'examinateur a choisi de rester anonyme.

StarRating

Note sur cinq étoiles (cinq étant la meilleure note)

Enums
STAR_RATING_UNSPECIFIED Non spécifié.
ONE Une étoile sur cinq.
TWO Deux étoiles sur cinq.
THREE Trois étoiles sur cinq.
FOUR Quatre étoiles sur cinq.
FIVE Note maximale.

ReviewReply

Représente la réponse du propriétaire/responsable de l'établissement à un avis.

Champs
comment

string

Corps de la réponse sous forme de texte brut avec des annotations. La longueur maximale est de 4 096 octets.

update_time

Timestamp

Uniquement en sortie. Code temporel correspondant à la dernière modification de la réponse.

SearchChainsRequest

Message de requête pour Location.SearchChains.

Champs
chain_display_name

string

Recherchez une chaîne par son nom. Les requêtes exactes, partielles, partielles ou connexes sont acceptées. Exemples : "walmart", "wal-mart", "walmmmart", "沃尔玛"

result_count

int32

Nombre maximal de chaînes correspondantes à renvoyer à partir de cette requête. La valeur par défaut est 10. La valeur maximale possible est 500.

SearchChainsResponse

Message de réponse pour "Locations.SearchChains".

Champs
chains[]

Chain

Chaînes correspondant au nom "chain_display_name" interrogé dans SearchChainsRequest. En l'absence de correspondance, ce champ sera vide. Les résultats sont classés par ordre de pertinence.

SearchGoogleLocationsRequest

Message de requête pour GoogleLocations.SearchGoogleLocations.

Champs
result_count

int32

Nombre de correspondances à renvoyer. La valeur par défaut est 3, avec un maximum de 10. Notez que la latence peut augmenter si davantage sont demandés. Il n'y a pas de pagination.

Champ d'union search_query. Requête de recherche. Il peut être fourni sous la forme d'un objet location ou d'une requête de chaîne. search_query ne peut être qu'un des éléments suivants :
location

Location

Lieu à rechercher. Si des informations sur l'établissement sont fournies, la recherche affiche les établissements qui correspondent aux informations fournies.

query

string

Requête textuelle à rechercher. Les résultats de recherche à partir d'une chaîne de requête sont moins précis que s'ils fournissent un lieu exact, mais ils peuvent fournir des correspondances plus inexactes.

SearchGoogleLocationsResponse

Message de réponse pour GoogleLocations.SearchGoogleLocations.

Champs
google_locations[]

GoogleLocation

Ensemble de GoogleLocations qui sont des correspondances potentielles avec la requête spécifiée, classés du plus précis au moins précis.

ServiceAreaBusiness

Les établissements de services de proximité à domicile proposent leurs services à l'adresse du client (par exemple, un serrurier ou un plombier).

Champs
business_type

BusinessType

Indique le type de l'établissement de services de proximité à domicile.

Champ d'union coverageArea. Indique la zone de couverture où l'établissement propose ses services. coverageArea ne peut être qu'un des éléments suivants :
radius

PointRadius

Uniquement en sortie. Zone desservie par cet établissement, centrée autour d'un point.

places

Places

Zone desservie par cet établissement, définie via un ensemble d'adresses.

BusinessType

Indique si cet établissement propose uniquement des services sur place au domicile du client (par exemple, une dépanneuse) ou à la fois à une adresse et sur place (par exemple, une pizzeria dotée d'un espace repas, qui livre aussi à ses clients).

Enums
BUSINESS_TYPE_UNSPECIFIED Uniquement en sortie. Non spécifié.
CUSTOMER_LOCATION_ONLY Offre un service uniquement aux alentours (pas à l'adresse de l'établissement).
CUSTOMER_AND_BUSINESS_LOCATION Propose un service à l'adresse de l'établissement et aux alentours.

ServiceBusinessContext

Données supplémentaires pour la validation des établissements de services.

Champs
address

PostalAddress

Adresse de validation de l'établissement. Il permet d'activer d'autres options de validation ou d'envoyer un courrier.

ServiceList

Liste de services contenant un ou plusieurs éléments de service.

Champs
name

string

Obligatoire. Identifiant Google de cet établissement, au format suivant: accounts/{account_id}/locations/{location_id}/serviceList

service_items[]

ServiceItem

Éléments de service inclus dans cette liste de services. Les éléments de service en double seront supprimés automatiquement.

ServiceItem

Message décrivant un seul élément de service. Il permet de décrire le type de service fourni par le marchand. Par exemple, coiffure peut être un service.

Champs
is_offered

bool

Facultatif. Ce champ détermine si le service de saisie est proposé ou non par le marchand.

price

Money

Facultatif. Représente le prix monétaire de l'élément de service. Nous vous recommandons de définir "currency_code" et les unités lorsque vous incluez un prix.

Champ d'union service_item_info. L'un des champs suivants doit toujours être défini. service_item_info ne peut être qu'un des éléments suivants :
structured_service_item

StructuredServiceItem

La casse de ce champ sera définie pour les données de services structurées.

free_form_service_item

FreeFormServiceItem

Ce champ sera défini pour les données de services de format libre.

FreeFormServiceItem

Représente un service de format libre proposé par le marchand. Il s'agit de services qui ne sont pas exposés dans les données de notre service de structure. Le marchand saisit manuellement le nom de ces services via une surface geomerchant.

Champs
category_id

string

Obligatoire. category_id et service_type_id doivent correspondre aux combinaisons possibles fournies dans le message Category.

label

Label

Obligatoire. Libellés de l'élément avec marquage de la langue. Nous recommandons de ne pas dépasser 140 caractères pour les noms d'éléments et 250 caractères pour les descriptions. Ce champ ne doit être défini que si l'entrée est un élément de service personnalisé. Les types de services standardisés doivent être mis à jour via service_type_id.

StructuredServiceItem

Représente un service structuré proposé par le marchand. Par exemple: installation de toilettes.

Champs
service_type_id

string

Obligatoire. Le champ service_type_id est un identifiant unique fourni par Google, qui se trouve dans ServiceTypeMetadata. Ces informations sont fournies par le service RPC BatchGetBusinessCategories.

description

string

Facultatif. Description de l'élément de service structuré. Le nombre maximal de caractères est de 300.

ServiceType

Message décrivant un type de service proposé par l'établissement.

Champs
service_type_id

string

Uniquement en sortie. ID stable (fourni par Google) pour ce type de service.

display_name

string

Uniquement en sortie. Nom lisible à afficher pour le type de service.

SpecialHourPeriod

Représente une période unique au cours de laquelle les horaires d'ouverture d'un établissement diffèrent des horaires d'ouverture habituels. Une période d'horaires d'ouverture exceptionnels doit représenter une plage de moins de 24 heures. Les open_time et start_date doivent être antérieures aux close_time et end_date. Les close_time et end_date peuvent s'étendre jusqu'à 23h59 le lendemain de la start_date spécifiée. Par exemple, les entrées suivantes sont valides:

start_date=2015-11-23, open_time=08:00, close_time=18:00
start_date=2015-11-23, end_date=2015-11-23, open_time=08:00,
close_time=18:00 start_date=2015-11-23, end_date=2015-11-24,
open_time=13:00, close_time=11:59

Les entrées suivantes ne sont pas valides:

start_date=2015-11-23, open_time=13:00, close_time=11:59
start_date=2015-11-23, end_date=2015-11-24, open_time=13:00,
close_time=12:00 start_date=2015-11-23, end_date=2015-11-25,
open_time=08:00, close_time=18:00
Champs
start_date

Date

Date du calendrier à laquelle commence cette période d'horaires d'ouverture exceptionnels.

open_time

string

Durée d'exécution à l'ouverture du start_date à l'ouverture d'un emplacement, exprimée au format ISO 8601 étendu sur 24 heures. (hh:mm). Les valeurs valides vont de 00:00 à 24:00, où 24:00 correspond à minuit à la fin du champ de jour spécifié. Doit être spécifié si is_closed est défini sur "false".

end_date

Date

Date de fin de cette période d'horaires d'ouverture exceptionnels. Si le champ end_date n'est pas défini, la date spécifiée dans start_date est utilisée par défaut. S'il est défini, ce champ doit être égal ou inférieur à 1 jour après start_date.

close_time

string

Durée d'exécution à la fermeture d'un établissement à end_date, exprimée au format ISO 8601 étendu sur 24 heures. (hh:mm). Les valeurs valides vont de 00:00 à 24:00, où 24:00 correspond à minuit à la fin du champ de jour spécifié. Doit être spécifié si is_closed est défini sur "false".

is_closed

bool

Si la valeur est "true", end_date, open_time et close_time sont ignorés, et la date spécifiée dans start_date est traitée comme l'établissement fermé toute la journée.

SpecialHours

Représente un ensemble de périodes au cours desquelles les horaires d'ouverture d'un établissement diffèrent des horaires d'ouverture habituels.

Champs
special_hour_periods[]

SpecialHourPeriod

Liste des exceptions aux horaires d'ouverture habituels de l'établissement.

Caractère épicé

Niveau épicé d'un aliment.

Enums
SPICINESS_UNSPECIFIED Niveau non spécifié
MILD Symbole de légèrement épicé.
MEDIUM Indique un épicé moyennement épicé.
HOT Symbole "piment et épicé". Niveau le plus épicé.

StartUploadMediaItemDataRequest

Message de requête pour Media.StartUploadMediaItemData.

Champs
parent

string

Nom de ressource de l'emplacement auquel l'élément multimédia doit être ajouté.

TimeInterval

Intervalle de temps inclus. Il doit contenir tous les champs pour être valide.

Champs
start_date

Date

Date de début de cette période.

start_time

TimeOfDay

Heure de début de cette période.

end_date

Date

Date de fin de cette période.

end_time

TimeOfDay

Heure de fin de cette période.

TimePeriod

Représente la période d'ouverture de l'établissement, à partir du jour et de l'heure d'ouverture spécifiés, jusqu'au jour et à l'heure de fermeture spécifiés. L'heure de fermeture doit être postérieure à l'heure d'ouverture (par exemple, plus tard le même jour ou un jour suivant).

Champs
open_day

DayOfWeek

Indique le day of the week à partir duquel cette période commence.

open_time

string

Heure au format ISO 8601 étendu (hh:mm). Les valeurs valides sont comprises entre 00:00 et 24:00, où 24:00 correspond à minuit à la fin du champ de jour spécifié.

close_day

DayOfWeek

Indique le day of the week auquel se termine cette période.

close_time

string

Heure au format ISO 8601 étendu (hh:mm). Les valeurs valides sont comprises entre 00:00 et 24:00, où 24:00 correspond à minuit à la fin du champ de jour spécifié.

TimeRange

Une plage de temps Les données seront extraites sur la plage sous la forme d'une valeur médiane semi-ouverte (c'est-à-dire [start_time, end_time]).

Champs
start_time

Timestamp

Code temporel de l'epoch du début de la plage (inclus).

end_time

Timestamp

Code temporel de l'epoch de fin de la plage (exclus).

TransferLocationRequest

Message de requête pour Location.TransferLocation.

Champs
name

string

Nom de l'établissement à transférer.

to_account

string

Nom de la ressource du compte vers laquelle transférer l'établissement (par exemple, "accounts/8675309").

UpdateAccountAdminRequest

Message de requête pour AccessControl.UpdateAccountAdmin.

Champs
name

string

Nom de ressource de l'administrateur à mettre à jour.

admin

Admin

Administrateur mis à jour. Remarque: role est le seul champ modifiable. Tous les autres champs sont ignorés.

UpdateAccountRequest

Message de requête pour Accounts.UpdateAccount.

Champs
name

string

Nom du compte à mettre à jour.

account

Account

Informations de compte mises à jour. Remarque: account_name est le seul champ modifiable.

validate_only

bool

Si la valeur est "true", la demande est validée sans mettre à jour le compte.

UpdateFoodMenusRequest

Message de requête pour FoodMenu.UpdateFoodMenus

Champs
food_menus

FoodMenus

Obligatoire. Les informations sur la carte des aliments mises à jour. Vous pouvez désactiver le menu en le mettant à jour sans aucune section de menu.

update_mask

FieldMask

Facultatif. Champs spécifiques à mettre à jour. Si aucun masque n'est spécifié, le problème est traité comme une mise à jour complète et tous les champs sont définis sur les valeurs transmises, ce qui peut inclure la désactivation des champs vides dans la requête. Les éléments de champ répétés ne peuvent pas être mis à jour individuellement. Remarque : "name" (nom) de FoodMenus est l'identifiant de la ressource qui ne peut pas être mis à jour.

UpdateHealthProviderAttributesRequest

Message de requête pour HealthProviderAttributes.UpdateHealthProviderAttributes

Champs
health_provider_attributes

HealthProviderAttributes

Obligatoire. Attributs du fournisseur de santé mis à jour.

update_mask

FieldMask

Facultatif. Champs spécifiques à mettre à jour. Si aucun masque n'est spécifié, le problème est traité comme une mise à jour complète et tous les champs sont définis sur les valeurs transmises, ce qui peut inclure la désactivation des champs vides dans la requête. Dans la version 1, seul le champ "Assurance_networks" doit être mis à jour. D'autres attributs seront acceptés ultérieurement.

UpdateLocalPostRequest

Message de requête pour UpdateLocalPost.

Champs
name

string

Nom du post local à mettre à jour.

local_post

LocalPost

Informations du post local mises à jour.

update_mask

FieldMask

Champs spécifiques à mettre à jour. Vous devez spécifier chaque champ en cours de mise à jour dans le masque.

UpdateLocationAdminRequest

Message de requête pour AccessControl.UpdateLocationAdmin.

Champs
name

string

Nom de ressource de l'administrateur à mettre à jour.

admin

Admin

Administrateur mis à jour. Remarque: role est le seul champ modifiable. Tous les autres champs sont ignorés.

UpdateLocationRequest

Message de requête pour Location.UpdateLocation.

Champs
name

string

Nom de l'établissement à mettre à jour.

location

Location

Informations sur l'établissement mises à jour.

update_mask

FieldMask

Champs spécifiques à mettre à jour. Si aucun masque n'est spécifié, le problème est traité comme une mise à jour complète et tous les champs sont définis sur les valeurs transmises, ce qui peut inclure la désactivation des champs vides dans la requête.

validate_only

bool

Si la valeur est "true", la requête est validée sans mettre à jour l'établissement.

attribute_mask

FieldMask

Identifiants des attributs à mettre à jour. Seuls les attributs indiqués dans le masque seront mis à jour. Si un attribut est présent dans le masque et non dans l'établissement, il sera supprimé. Un masque vide mettra à jour tous les attributs.

Chaque fois que ce champ est défini, le masque update_mask doit inclure des attributs en tant que champs à mettre à jour.

UpdateMediaItemRequest

Message de requête pour Media.UpdateMediaItem.

Champs
name

string

Nom de l'élément multimédia à mettre à jour.

media_item

MediaItem

Élément multimédia à mettre à jour.

Seul l'identifiant de la catégorie ou de l'article de la liste de prix peut être mis à jour.

update_mask

FieldMask

Champs spécifiques à mettre à jour. Si aucun masque n'est spécifié, le problème est traité comme une mise à jour complète et tous les champs modifiables sont définis sur les valeurs transmises.

UpdateNotificationsRequest

Message de requête pour Accounts.UpdateNotifications.

Champs
name

string

Nom de la ressource des paramètres de notification.

notifications

Notifications

Paramètres de notification mis à jour.

UpdateQuestionRequest

Message de requête pour QuestionsAndAnswers.UpdateQuestion

Champs
name

string

Nom de la question à mettre à jour.

question

Question

Question modifiée.

UpdateReviewReplyRequest

Message de requête pour Reviews.UpdateReview Reply.

Champs
name

string

Nom de l'avis auquel répondre.

review_reply

ReviewReply

Réponse à l'avis. Si une réponse existe déjà, elle remplacera l'ancienne.

UpdateServiceListRequest

Message de requête de mise à jour de la liste de services.

Champs
service_list

ServiceList

Facultatif. Informations de la liste de services mises à jour. Si vous laissez ce champ vide, l'API supprimera la ServiceList. Si une ServiceList est définie, l'API remplace la ServiceList d'origine par celle définie.

update_mask

FieldMask

Facultatif. Champs spécifiques à mettre à jour. Si aucun masque n'est spécifié, le problème est traité comme une mise à jour complète et tous les champs sont définis sur les valeurs transmises, ce qui peut inclure la désactivation des champs vides dans la requête. Les éléments de champ répétés ne peuvent pas être mis à jour individuellement.

UpsertAnswerRequest

Message de requête pour QuestionsAndAnswers.UpsertAnswer

Champs
parent

string

Nom de la question à laquelle vous devez rédiger une réponse.

answer

Answer

La nouvelle réponse.

UrlAttributeValue

Valeurs d'un attribut avec un value_type correspondant à "URL".

Champs
url

string

L'URL.

ValidationError

Décrit les échecs de validation dans une requête client.

Champs
error_details[]

ErrorDetail

Détaille les échecs de validation individuels à l'aide de codes d'erreur sous forme de nombres entiers.

Validation

Une validation correspond à une tentative de validation d'un établissement.

Champs
name

string

Nom de ressource de la validation.

method

VerificationMethod

Méthode de vérification.

state

VerificationState

État de la validation.

create_time

Timestamp

Code temporel du moment où la demande de validation est demandée.

VerificationState

Tous les états de validation possibles.

Enums
VERIFICATION_STATE_UNSPECIFIED Valeur par défaut, entraînera des erreurs.
PENDING La validation est en attente.
COMPLETED La validation est terminée.
FAILED Échec de la validation.

VerificationMethod

Spécifie les processus utilisés par Google pour valider un établissement.

Enums
VERIFICATION_METHOD_UNSPECIFIED Valeur par défaut, entraînera des erreurs.
ADDRESS Envoyez un courrier contenant un code de validation à une adresse postale spécifique. Ce code permet de valider votre identité auprès de Google.
EMAIL Envoyez un e-mail contenant un code de validation à une adresse e-mail spécifique. Ce code permet de valider votre identité auprès de Google.
PHONE_CALL Passez un appel téléphonique avec un code de validation vers un numéro de téléphone spécifique. Ce code permet de valider votre identité auprès de Google.
SMS Envoyer un code d'accès de validation par SMS à un numéro de téléphone spécifique Ce code permet de valider votre identité auprès de Google.
AUTO Faire valider l'établissement sans autre action de la part de l'utilisateur Il est possible que cette option ne soit pas disponible pour toutes les zones géographiques.

VerificationOption

L'option de validation indique comment valider l'établissement (indiqué par la méthode de validation) et où la validation sera envoyée (indiqué par les données d'affichage).

Champs
verification_method

VerificationMethod

Méthode de validation de l'établissement.

Champ d'union DisplayData. Une des données d'affichage. Les données doivent correspondre à la méthode. Ce champ est vide si la méthode correspondante ne comporte aucune donnée d'affichage. DisplayData ne peut être qu'un des éléments suivants :
phone_data

PhoneVerificationData

À définir uniquement si la méthode est PHONE_CALL ou SMS.

address_data

AddressVerificationData

À définir uniquement si la méthode est MAIL.

email_data

EmailVerificationData

À définir uniquement si la méthode est EMAIL.

AddressVerificationData

Affichez les données de validation par courrier.

Champs
business_name

string

Nom de l'entreprise du marchand.

address

PostalAddress

Adresse à laquelle le courrier peut être envoyé.

EmailVerificationData

Permet d'afficher les données des validations par e-mail.

Champs
domain_name

string

Nom de domaine dans l'adresse e-mail. Ex. : &quot;gmail.com&quot; à l'adresse foo@gmail.com

user_name

string

Nom d'utilisateur dans l'adresse e-mail. Ex. : "foo" à l'adresse foo@gmail.com

is_user_name_editable

bool

Indique si le client est autorisé à fournir un autre nom d'utilisateur.

PhoneVerificationData

Afficher les données pour les vérifications par téléphone (ex. : appel téléphonique, SMS.

Champs
phone_number

string

Numéro de téléphone auquel le code sera envoyé.

VerifyLocationRequest

Message de requête pour Verifications.VerifyLocation.

Champs
name

string

Nom de ressource de l'établissement à valider.

method

VerificationMethod

Méthode de validation.

language_code

string

Code de langue BCP 47 représentant la langue à utiliser pour la procédure de validation.

context

ServiceBusinessContext

Informations contextuelles supplémentaires pour la validation des entreprises de services Obligatoire pour les établissements dont le type d'activité est CUSTOMER_LOCATION_ONLY. Pour la validation de ADDRESS, l'adresse sera utilisée pour l'envoi du courrier. Pour les autres méthodes, elle doit être identique à celle transmise à FetchVerificationOptions. INVALID_ARGUMENT est généré s'il est défini pour d'autres types d'établissements.

Champ d'union RequestData. Données d'entrée utilisateur pour une méthode spécifique, en plus des données d'affichage. Les données doivent correspondre à la méthode demandée. Laissez ce champ vide si aucune donnée n'est nécessaire. RequestData ne peut être qu'un des éléments suivants :
email_input

EmailInput

Entrée pour la méthode EMAIL.

address_input

AddressInput

Valeur saisie pour la méthode ADDRESS.

phone_input

PhoneInput

Entrée pour la méthode PHONE_CALL/SMS

VerifyLocationResponse

Message de réponse pour Verifications.VerifyLocation.

Champs
verification

Verification

Demande de validation créée.