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://mybusinessbusinessinformation.googleapis.com/v1/attributes

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de requête

Paramètres
parent

string

Nom de ressource de l'emplacement pour rechercher les attributs disponibles. Si ce champ est défini, les champs categoryName, regionCode, languageCode et showAll ne sont pas obligatoires et ne doivent pas l'être.
categoryName

string

ID stable de la catégorie principale permettant de trouver les attributs disponibles. Doit être au format "catégories/{category_id}".
regionCode

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.
showAll

boolean

Les métadonnées de tous les attributs disponibles sont renvoyées lorsque ce champ est défini sur "true", sans tenir compte des champs parent et categoryName. languageCode et regionCode sont obligatoires lorsque "showAll" est défini sur "true".
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.

Corps de la requête

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

Corps de la réponse

Réponse pour AttributesService.ListAttributeMetadata.

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

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

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

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.

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.

Représentation JSON 
{
  "parent": string,
  "valueType": enum (AttributeValueType),
  "displayName": string,
  "groupDisplayName": string,
  "repeatable": boolean,
  "valueMetadata": [
    {
      object (AttributeValueMetadata)
    }
  ],
  "deprecated": boolean
}
Champs
parent

string

Identifiant unique de l'attribut.
valueType

enum (AttributeValueType)

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

string

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

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.
repeatable

boolean

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

object (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.
deprecated

boolean

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.

Représentation JSON 
{
  "value": value,
  "displayName": string
}
Champs
value

value (Value format)

Valeur de l'attribut.
displayName

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.