Method: placeActionTypeMetadata.list

Affiche la liste des types d'actions disponibles pour un lieu pour un établissement 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 langue dans laquelle les noms à afficher doivent être affichés. Si cette langue n'est pas disponible, elles seront fournies en anglais.

pageSize

integer

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

pageToken

string

Facultatif. Si cette valeur est spécifiée, la page suivante des métadonnées de 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 page demandée peut en contenir.

filter

string

Facultatif. Filtre contraignant les types d'actions liées à un 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 ressource d'un lieu, au format locations/{locationId}. 2. region_code=XYZ où XYZ est un code de région CLDR au format Unicode pour afficher les types d'actions disponibles.

Si aucun filtre n'est fourni, tous les types d'actions liées à un 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 liées à un lieu disponibles.

nextPageToken

string

Si le nombre de types d'actions dépasse la taille de page demandée, ce champ sera renseigné avec un jeton permettant d'extraire la page suivante lors d'un appel ultérieur à 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 pour les types d'actions liées à un lieu acceptés.

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

enum (PlaceActionType)

Type d'action pour un lieu.

displayName

string

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