REST Resource: attributes

Zasób: AttributeMetadata

Metadane atrybutu. Zawiera wyświetlane informacje o atrybucie, w tym zlokalizowaną nazwę i nagłówek 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 pobierane wartości powinny być tego typu.

displayName

string

zlokalizowana wyświetlana nazwa atrybutu, jeśli jest dostępna; w przeciwnym razie wyświetla się nazwa w języku angielskim.

groupDisplayName

string

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

isRepeatable

boolean

Jeśli ma wartość 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. wyliczenia) dostępna jest lista obsługiwanych wartości i odpowiadających im wyświetlanych nazw.

isDeprecated

boolean

Jeśli ma wartość true (prawda), atrybut został wycofany i nie należy go już używać. Jeśli atrybut zostanie wycofany, aktualizacja nie spowoduje błędu, ale aktualizacje nie zostaną zapisane. Po wycofaniu atrybut zostanie w pewnym momencie całkowicie usunięty i stanie się błędem.

AttributeValueMetadata

Metadane 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, jeśli jest dostępna; w przeciwnym razie – w języku angielskim. Wyświetlana nazwa wartości powinna być używana w kontekście z wyświetlaną nazwą atrybutu.

Na przykład w kolumnie „Wi-Fi” wyliczeniowy, może on zawierać wartość „Płatne” reprezentują płatną sieć Wi-Fi.

Metody

list

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