REST Resource: attributes

Ressource: 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 
{
  "attributeId": string,
  "valueType": enum (AttributeValueType),
  "displayName": string,
  "groupDisplayName": string,
  "isRepeatable": boolean,
  "valueMetadata": [
    {
      object (AttributeValueMetadata)
    }
  ],
  "isDeprecated": boolean
}
Champs
attributeId

string

Identifiant 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.
isRepeatable

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

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.

Méthodes

list

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