Package google.mybusiness.placeactions.v1

Index

• PlaceActions (interface)
• CreatePlaceActionLinkRequest (message)
• DeletePlaceActionLinkRequest (message)
• ErrorCode (enum)
• GetPlaceActionLinkRequest (message)
• ListPlaceActionLinksRequest (message)
• ListPlaceActionLinksResponse (message)
• ListPlaceActionTypeMetadataRequest (message)
• ListPlaceActionTypeMetadataResponse (message)
• PlaceActionLink (message)
• PlaceActionLink.ProviderType (enum)
• PlaceActionType (enum)
• PlaceActionTypeMetadata (message)
• UpdatePlaceActionLinkRequest (message)

PlaceActions

Cette API permet de gérer les liens PlaceAction vers des établissements.

CreatePlaceActionLink

rpc CreatePlaceActionLink(CreatePlaceActionLinkRequest) returns (PlaceActionLink) Crée un lien d'action pour un lieu associé à l'établissement spécifié, puis l'affiche. La requête est considérée comme un doublon si parent, place_action_link.uri et place_action_link.place_action_type sont identiques à une requête précédente. Champs d'application des autorisations Requiert le niveau d'accès OAuth suivant : https://www.googleapis.com/auth/business.manage Pour en savoir plus, consultez la présentation d'OAuth 2.0.

DeletePlaceActionLink
rpc DeletePlaceActionLink(DeletePlaceActionLinkRequest) returns (Empty) Supprime un lien d'action pour un lieu à partir de l'établissement spécifié. Champs d'application des autorisations Requiert le niveau d'accès OAuth suivant : https://www.googleapis.com/auth/business.manage Pour en savoir plus, consultez la présentation d'OAuth 2.0.

GetPlaceActionLink
rpc GetPlaceActionLink(GetPlaceActionLinkRequest) returns (PlaceActionLink) Récupère le lien d'action pour un lieu spécifié. Champs d'application des autorisations Requiert le niveau d'accès OAuth suivant : https://www.googleapis.com/auth/business.manage Pour en savoir plus, consultez la présentation d'OAuth 2.0.

ListPlaceActionLinks
rpc ListPlaceActionLinks(ListPlaceActionLinksRequest) returns (ListPlaceActionLinksResponse) Liste les liens d'action pour un lieu pour l'établissement spécifié. Champs d'application des autorisations Requiert le niveau d'accès OAuth suivant : https://www.googleapis.com/auth/business.manage Pour en savoir plus, consultez la présentation d'OAuth 2.0.

ListPlaceActionTypeMetadata
rpc ListPlaceActionTypeMetadata(ListPlaceActionTypeMetadataRequest) returns (ListPlaceActionTypeMetadataResponse) Affiche la liste des types d'actions disponibles pour un lieu pour un lieu ou un pays. Champs d'application des autorisations Requiert le niveau d'accès OAuth suivant : https://www.googleapis.com/auth/business.manage Pour en savoir plus, consultez la présentation d'OAuth 2.0.

UpdatePlaceActionLink
rpc UpdatePlaceActionLink(UpdatePlaceActionLinkRequest) returns (PlaceActionLink) Met à jour le lien d'action pour un lieu spécifié, puis le renvoie. Champs d'application des autorisations Requiert le niveau d'accès OAuth suivant : https://www.googleapis.com/auth/business.manage Pour en savoir plus, consultez la présentation d'OAuth 2.0.

CreatePlaceActionLinkRequest

Message de requête pour PlaceActions.CreatePlaceActionLink.

Champs
parent	string Obligatoire. Nom de ressource de l'établissement où créer ce lien d'action pour le lieu. locations/{location_id}.
place_action_link	PlaceActionLink Obligatoire. Lien d'action pour le lieu à créer.

DeletePlaceActionLinkRequest

Message de requête pour PlaceActions.DeletePlaceActionLink.

Champs
name	string Obligatoire. Nom de ressource du lien d'action pour un lieu à supprimer de l'établissement.

ErrorCode

Codes d'erreur pour les échecs internes.

Enums
ERROR_CODE_UNSPECIFIED	Code d'erreur non spécifié.
UNVERIFIED_LOCATION	L'établissement n'a pas été validé.
INVALID_LOCATION_CATEGORY	La catégorie de lieu n'est pas éligible pour le type d'action pour un lieu. Le type d'action de lieu à l'origine de l'erreur sera renvoyé dans les métadonnées, avec la chaîne "place_action_type" comme clé et la chaîne de valeur d'énumération PlaceActionType comme valeur.
INVALID_URL	L'URL est incorrecte ou non valide. L'URL d'action pour un lieu qui n'est pas valide sera renvoyée dans les métadonnées, avec la chaîne "url" comme clé et l'URL comme valeur.
URL_PROVIDER_NOT_ALLOWED	L'URL comporte un fournisseur qui n'est pas autorisé. L'URL d'action pour un lieu qui n'est pas autorisée sera renvoyée dans les métadonnées, avec la chaîne "url" comme clé et l'URL comme valeur.
TOO_MANY_VALUES	Trop de valeurs ont été définies pour le type d'action de lieu. Le type pour lequel la limite est atteinte est renvoyé dans les métadonnées, avec la chaîne "place_action_type" comme clé et la chaîne de valeur d'énumération PlaceActionType comme valeur.
DELETED_LINK	Le lien d'action pour un lieu demandé a été supprimé. L'URL correspondante est renvoyée dans les métadonnées, avec la chaîne "url" comme clé et l'URL comme valeur.
LINK_ALREADY_EXISTS	Une mise à jour est demandée pour convertir un lien d'action pour un lieu en un lien qui existe déjà, avec le même URI et le même type à l'emplacement spécifié.
SCALABLE_DEEP_LINK_INVALID_MULTIPLICITY	Le domaine associé au lien a déjà été utilisé. Le nombre de liens par domaine est limité à un par PlaceActionType.
LINK_DOES_NOT_EXIST	Un lien spécifié est introuvable dans la base de données.

GetPlaceActionLinkRequest

Message de requête pour PlaceActions.GetPlaceActionLink.

Champs
name	string Obligatoire. Nom du lien d'action pour un lieu à récupérer.

ListPlaceActionLinksRequest

Message de requête pour PlaceActions.ListPlaceActionLinks. Les liens d'action de lieu associés à un établissement seront listés, sans ordre spécifique. Il est possible que les liens qui ont été créés récemment (au cours des dernières 24 heures) ne s'affichent pas sur d'autres surfaces telles que le site Web Google My Business. Toute association créée il y a plus de 24 heures s'affiche via cette API.

Champs
parent	string Obligatoire. Nom de l'établissement dont les liens d'action pour un lieu seront listés. locations/{location_id}.
filter	string Facultatif. Filtre contraignant les liens d'action de lieu à renvoyer. La réponse inclut des entrées qui correspondent au filtre. Nous n'acceptons que le filtre suivant: 1. place_action_type=XYZ, où XYZ est un PlaceActionType valide.
page_size	int32 Facultatif. Nombre de liens d'action pour un lieu à afficher par page. Valeur par défaut : 10. La valeur minimale est 1.
page_token	string Facultatif. Si cette valeur est spécifiée, affiche la page suivante de liens d'action pour un lieu.

ListPlaceActionLinksResponse

Message de réponse pour PlaceActions.ListPlaceActionLinks.

Champs
place_action_links[]	PlaceActionLink Liste de liens d'action pour un lieu renvoyée.
next_page_token	string Si le nombre de liens d'action pour un lieu est supérieur à la taille de page demandée, ce champ est renseigné avec un jeton permettant d'extraire la page de résultats suivante.

ListPlaceActionTypeMetadataRequest

Message de requête pour PlaceActions.ListPlaceActionTypeMetadata. Les résultats ne s'affichent pas dans un ordre spécifique.

Champs
language_code	string Facultatif. Code IETF BCP-47 de la langue utilisée pour obtenir les noms à afficher. Si cette langue n'est pas disponible, ils seront fournis en anglais.
page_size	int32 Facultatif. Nombre de types d'actions à inclure par page. La valeur par défaut est 10. La valeur minimale est 1.
page_token	string Facultatif. Si elle est spécifiée, la page suivante des métadonnées du type d'action pour un lieu est récupérée. Le pageToken est renvoyé lorsqu'un appel à placeActionTypeMetadata.list renvoie plus de résultats que la taille de page demandée ne peut en tenir.
filter	string Facultatif. Filtre limitant les types d'actions de lieu pour lesquels renvoyer des métadonnées. La réponse inclut des entrées qui correspondent au filtre. Nous n'acceptons que les filtres suivants: 1. location=XYZ où XYZ est une chaîne indiquant le nom de la ressource d'un établissement, au format locations/{location_id}. 2. region_code=XYZ où XYZ correspond à un code régional CLDR Unicode pour rechercher les types d'actions disponibles. Si aucun filtre n'est fourni, tous les types d'actions de lieu sont renvoyés.

ListPlaceActionTypeMetadataResponse

Message de réponse pour PlaceActions.ListPlaceActionTypeMetadata.

Champs
place_action_type_metadata[]	PlaceActionTypeMetadata Ensemble de métadonnées pour les types d'actions disponibles pour un lieu.
next_page_token	string Si le nombre de types d'action dépasse la taille de page demandée, ce champ sera renseigné avec un jeton permettant d'extraire la page suivante lors d'un prochain appel à placeActionTypeMetadata.list. S'il n'y a plus de résultats, ce champ ne sera pas présent dans la réponse.

PlaceActionLink

Représente un lien d'action pour un lieu et ses attributs.

Champs
name	string Facultatif. Nom de la ressource, au format locations/{location_id}/placeActionLinks/{place_action_link_id}. Le champ "nom" ne sera pris en compte que dans les requêtes UpdatePlaceActionLink et DeletePlaceActionLink respectivement pour la mise à jour et la suppression d'associations. Toutefois, il sera ignoré dans la requête CreatePlaceActionLink, où place_action_link_id sera attribué par le serveur lors de la création d'un lien et renvoyé dans la réponse.
provider_type	ProviderType Uniquement en sortie. Spécifie le type de fournisseur.
is_editable	bool Uniquement en sortie. Indique si le lien peut être modifié par le client.
uri	string Obligatoire. URI du lien. Le même URI peut être réutilisé pour différents types d'actions à différents emplacements. Cependant, un seul lien d'action pour un lieu est autorisé pour chaque combinaison unique de (URI, type d'action pour le lieu, emplacement).
place_action_type	PlaceActionType Obligatoire. Type d'action sur un lieu pouvant être effectuée à l'aide de ce lien.
is_preferred	bool Facultatif. Indique si ce lien est préféré par le marchand. Vous ne pouvez marquer qu'un seul lien par type d'action pour un établissement comme préféré. Si, lors d'une prochaine demande, un autre lien est marqué comme favori pour le même type d'action pour un lieu, le lien préféré actuel (le cas échéant) perd sa préférence.
create_time	Timestamp Uniquement en sortie. Date et heure auxquelles le lien d'action pour un lieu a été créé.
update_time	Timestamp Uniquement en sortie. Heure de la dernière modification du lien d'action pour un lieu.

ProviderType

Le type de fournisseur du lien peut uniquement être lu.

Enums
PROVIDER_TYPE_UNSPECIFIED	Non spécifié.
MERCHANT	Un fournisseur propriétaire tel qu'un marchand ou une agence agissant pour le compte d'un marchand
AGGREGATOR_3P	Un agrégateur tiers, tel qu'un partenaire Reserve with Google.

PlaceActionType

Type d'action sur un lieu pouvant être effectuée à l'aide du lien.

Enums
PLACE_ACTION_TYPE_UNSPECIFIED	Non spécifié.
APPOINTMENT	Le type d'action est "prendre un rendez-vous".
ONLINE_APPOINTMENT	Le type d'action est de prendre un rendez-vous en ligne.
DINING_RESERVATION	Le type d'action est de réserver un restaurant.
FOOD_ORDERING	Le type d'action est "commander des plats en livraison et/ou à emporter".
FOOD_DELIVERY	Le type d'action est la commande de nourriture à livrer.
FOOD_TAKEOUT	Le type d'action est "commander des plats à emporter".
SHOP_ONLINE	Le type d'action est "Shopping", qui peut être livraison et/ou retrait.

PlaceActionTypeMetadata

Métadonnées des types d'actions pouvant être effectuées sur un lieu.

Champs
place_action_type	PlaceActionType Type d'action pour le lieu.
display_name	string Nom à afficher localisé de l'attribut, s'il est disponible ; sinon, le nom à afficher en anglais.

UpdatePlaceActionLinkRequest

Message de requête pour PlaceActions.UpdatePlaceActionLink.

Champs
place_action_link	PlaceActionLink Obligatoire. Lien d'action pour le lieu mis à jour.
update_mask	FieldMask Obligatoire. Champs spécifiques à mettre à jour. Les seuls champs modifiables sont uri, place_action_type et is_preferred. Si l'association mise à jour existe déjà au même emplacement avec les mêmes place_action_type et uri, échoue avec une erreur ALREADY_EXISTS.