Method: attributes.list

Affiche la liste des attributs qui seraient disponibles pour un établissement associé à la catégorie principale et au pays indiqué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 valeurs 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. Le format doit être catégorie/{category_id}.
regionCode

string

Code pays ISO 3166-1 alpha-2 permettant de 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, ils seront fournis 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 valeur minimale est 1.
pageToken

string

Si elle 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 prochain appel à 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 d'affichage pour l'attribut, y compris un nom localisé et un en-tête permettant de regrouper les 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

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

string

Nom à afficher localisé du groupe qui contient cet attribut, s'il est disponible ; sinon, le nom du groupe en anglais. Les attributs associés sont rassemblés dans un groupe et doivent être affichés ensemble sous 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 des noms à afficher correspondants 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 mises à jour ne seront pas enregistrées. Après son abandon, l'attribut sera complètement supprimé et deviendra 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é le cas échéant. Sinon, il est 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 attribut d'énumération "Wi-Fi", il peut contenir "Payant" pour représenter le Wi-Fi payant.