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”枚举属性,可能包含“Paid”用于表示付费 Wi-Fi。

方法

list

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