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. Werte, die festgelegt und abgerufen werden, sollten diesen Typ haben.
displayName

string

Der lokalisierte Anzeigename für das Attribut, falls verfügbar, andernfalls der englische Anzeigename.
groupDisplayName

string

Sofern verfügbar der lokalisierte Anzeigename der Gruppe, die dieses Attribut enthält; andernfalls der englische Gruppenname. Verwandte Attribute werden in einer Gruppe zusammengefasst und sollten gemeinsam unter der hier angegebenen Überschrift angezeigt werden.
isRepeatable

boolean

Wenn 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 entsprechenden Anzeigenamen für diese Werte bereitgestellt.
isDeprecated

boolean

Wenn „true“ festgelegt ist, wurde das Attribut eingestellt und sollte nicht mehr verwendet werden. Wenn das Attribut veraltet ist, führt das Aktualisieren dieses Attributs nicht zu einem Fehler, die Aktualisierungen werden jedoch nicht gespeichert. Nach der Einstellung wird das Attribut vollständig entfernt und wird zu einem Fehler.

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, sofern verfügbar in der gewünschten Sprache, ansonsten auf Englisch. Der Anzeigename des Werts ist für die Verwendung im Zusammenhang mit dem Attributanzeigenamen vorgesehen.

Für ein enum-Attribut des Typs „WLAN“ könnte das beispielsweise „Kostenpflichtig“ für kostenpflichtiges WLAN enthalten.

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