REST Resource: attributes

Zasób: AttributeMetadata

Metadane atrybutu. Zawiera informacje wyświetlane dla atrybutu, w tym zlokalizowaną nazwę i nagłówek służący do grupowania powiązanych atrybutów.

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

string

Identyfikator atrybutu.

valueType

enum (AttributeValueType)

Typ wartości atrybutu. Ustawione i pobrane wartości powinny być tego typu.

displayName

string

Zlokalizowana nazwa wyświetlana atrybutu, jeśli jest dostępna. W przeciwnym razie – angielska nazwa wyświetlana.

groupDisplayName

string

Zlokalizowana nazwa wyświetlana grupy zawierającej ten atrybut, jeśli jest dostępna. W przeciwnym razie – angielska nazwa grupy. Powiązane atrybuty są łączone w grupę i powinny być wyświetlane razem pod podanym tutaj nagłówkiem.

isRepeatable

boolean

Jeśli ma wartość true (prawda), atrybut obsługuje wiele wartości. Jeśli ma wartość false (fałsz), należy podać tylko jedną wartość.

valueMetadata[]

object (AttributeValueMetadata)

W przypadku niektórych typów atrybutów (np. wyliczeniowych) podana jest lista obsługiwanych wartości i odpowiadających im nazw wyświetlanych.

isDeprecated

boolean

Jeśli ma wartość true (prawda), atrybut został wycofany i nie powinien być już używany. Jeśli ten atrybut został wycofany, zaktualizowanie tego atrybutu nie spowoduje błędu, ale zmiany nie zostaną zapisane. W pewnym momencie po wycofaniu atrybut zostanie całkowicie usunięty i stanie się błędem.

AttributeValueMetadata

Metadane dotyczące obsługiwanych wartości atrybutów.

Zapis JSON
{
  "value": value,
  "displayName": string
}
Pola
value

value (Value format)

Wartość atrybutu.

displayName

string

Wyświetlana nazwa tej wartości zlokalizowana tam, gdzie jest dostępna. W przeciwnym razie jest w języku angielskim. Wyświetlanej nazwy wartości należy używać w kontekście wyświetlanej nazwy atrybutu.

Na przykład atrybut wyliczeniowy „Wi-Fi” może zawierać wartość „Płatna”, która oznacza płatne Wi-Fi.

Metody

list

Zwraca listę dostępnych atrybutów, które byłyby dostępne dla lokalizacji w podanej kategorii podstawowej i w danym kraju.