Method: attributes.list

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

Requête HTTP

GET https://mybusiness.googleapis.com/v4/attributes

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de requête

Paramètres
name

string

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

categoryId

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.

languageCode

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.

pageSize

integer

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

pageToken

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.

Corps de la requête

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

Corps de la réponse

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

Message de réponse pour Location.ListAttributeMetadata.

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

object (AttributeMetadata)

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

nextPageToken

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.

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.