REST Resource: attributes

Ressource: AttributeMetadata

Metadaten für ein Attribut. Enthält Anzeigeinformationen für das Attribut, einschließlich eines lokalisierten Namens und einer Überschrift zum Gruppieren verwandter Attribute.

JSON-Darstellung
{
  "attributeId": string,
  "valueType": enum (AttributeValueType),
  "displayName": string,
  "groupDisplayName": string,
  "isRepeatable": boolean,
  "valueMetadata": [
    {
      object (AttributeValueMetadata)
    }
  ],
  "isDeprecated": boolean
}
Felder
attributeId

string

Die ID des Attributs.

valueType

enum (AttributeValueType)

Der Werttyp für das Attribut. Es wird davon ausgegangen, dass die festgelegten und abgerufenen Werte diesen Typ haben.

displayName

string

Der lokalisierte Anzeigename für das Attribut, falls verfügbar andernfalls den englischen Anzeigenamen.

groupDisplayName

string

Der lokalisierte Anzeigename der Gruppe, die dieses Attribut enthält (falls verfügbar) andernfalls den englischen Gruppennamen. Zugehörige Attribute werden in einer Gruppe zusammengefasst und sollten zusammen unter der hier angegebenen Überschrift angezeigt werden.

isRepeatable

boolean

Falls wahr, unterstützt das Attribut mehrere Werte. Bei „false“ sollte nur ein Wert angegeben werden.

valueMetadata[]

object (AttributeValueMetadata)

Für einige Attributtypen (z. B. enums) wird eine Liste der unterstützten Werte und der entsprechenden Anzeigenamen für diese Werte bereitgestellt.

isDeprecated

boolean

Bei Einstellung auf „true“ wird das Attribut eingestellt und sollte nicht mehr verwendet werden. Wenn dieses Attribut eingestellt wird, führt das Aktualisieren dieses Attributs nicht zu einem Fehler, aber Aktualisierungen werden nicht gespeichert. Irgendwann wird das Attribut vollständig entfernt und es wird ein Fehler ausgegeben.

AttributeValueMetadata

Metadaten für unterstützte Attributwerte.

JSON-Darstellung
{
  "value": value,
  "displayName": string
}
Felder
value

value (Value format)

Der Attributwert.

displayName

string

Der Anzeigename für diesen Wert, lokalisiert, sofern verfügbar. andernfalls auf Englisch. Der Anzeigename des Werts ist für die Verwendung im Zusammenhang mit dem Anzeigenamen des Attributs vorgesehen.

Für die Option „WLAN“ enum-Attribut enthält, könnte dieses Attribut „Bezahlt“ enthalten für kostenpflichtiges WLAN.

Methoden

list

Gibt die Liste der verfügbaren Attribute zurück, die für einen Standort mit der angegebenen primären Kategorie und dem angegebenen Land verfügbar wären.