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

返回可用于指定主要类别和国家/地区的营业地点的可用属性列表。