REST Resource: attributes

資源:AttributeMetadata

屬性的中繼資料。包含屬性的顯示資訊,包括本地化名稱,以及用來將相關屬性分組的標題。

JSON 表示法
{
  "attributeId": string,
  "valueType": enum (AttributeValueType),
  "displayName": string,
  "groupDisplayName": string,
  "isRepeatable": boolean,
  "valueMetadata": [
    {
      object (AttributeValueMetadata)
    }
  ],
  "isDeprecated": boolean
}
欄位
attributeId

string

屬性的 ID。

valueType

enum (AttributeValueType)

屬性的值類型。已設定及擷取的值應採用這個類型。

displayName

string

屬性的本地化顯示名稱 (如有);否則為英文顯示名稱。

groupDisplayName

string

含有這個屬性的群組顯示名稱 (如有);否則為英文群組名稱。相關屬性會彙整到群組中,並全部顯示在此處提供的標題下方。

isRepeatable

boolean

如為 true,則屬性支援多個值。如果為 false,則只能提供單一值。

valueMetadata[]

object (AttributeValueMetadata)

對於某些類型的屬性 (例如列舉),系統會提供清單支援的值和這些值的對應顯示名稱。

isDeprecated

boolean

如為 true,則屬性已淘汰,因此不再使用。如果已淘汰,更新這項屬性並不會導致錯誤,但系統不會儲存更新內容。該屬性在淘汰後不久將完全移除,會變成錯誤。

AttributeValueMetadata

支援屬性值的中繼資料。

JSON 表示法
{
  "value": value,
  "displayName": string
}
欄位
value

value (Value format)

屬性值。

displayName

string

此值的顯示名稱 (如有本地化)否則請使用英文值顯示名稱必須搭配屬性顯示名稱使用。

舉例來說,如果是「WiFi」列舉屬性,可能含有「付費」代表付費 Wi-Fi

方法

list

傳回特定主要類別和國家/地區的地點可用的屬性清單。