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

這個值的顯示名稱 (如有本地化版本),否則為英文。這個值的顯示名稱必須搭配屬性顯示名稱使用。

舉例來說,「Wi-Fi」列舉屬性可能包含「付費」一詞,代表付費 Wi-Fi。

方法

list

針對具有指定主要類別和國家/地區的地點,傳回可用的屬性清單。