Method: placeActionTypeMetadata.list

Affiche la liste des types d'actions disponibles pour un lieu pour un lieu ou un pays.

Requête HTTP

GET https://mybusinessplaceactions.googleapis.com/v1/placeActionTypeMetadata

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de requête

Paramètres
languageCode

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.

pageSize

integer

Facultatif. Nombre de types d'actions à inclure par page. La valeur par défaut est 10. La valeur minimale est 1.

pageToken

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/{locationId}. 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.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Message de réponse pour PlaceActions.ListPlaceActionTypeMetadata.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON
{
  "placeActionTypeMetadata": [
    {
      object (PlaceActionTypeMetadata)
    }
  ],
  "nextPageToken": string
}
Champs
placeActionTypeMetadata[]

object (PlaceActionTypeMetadata)

Ensemble de métadonnées pour les types d'actions disponibles pour un lieu.

nextPageToken

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.

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.

PlaceActionTypeMetadata

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

Représentation JSON
{
  "placeActionType": enum (PlaceActionType),
  "displayName": string
}
Champs
placeActionType

enum (PlaceActionType)

Type d'action pour le lieu.

displayName

string

Nom à afficher localisé de l'attribut, s'il est disponible ; sinon, le nom à afficher en anglais.