REST Resource: attributes

Ressource: 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 
{
  "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

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.
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 des noms à afficher correspondants 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 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.

Méthodes

list

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