Method: attributes.list

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

HTTP 请求

GET https://mybusinessbusinessinformation.googleapis.com/v1/attributes

网址采用 gRPC 转码语法。

查询参数

参数
parent

string

用于查找可用属性的营业地点的资源名称。如果已设置此字段，则 categoryName、regionCode、languageCode 和 showAll 不是必需字段，且不得设置。
categoryName

string

主要类别的稳定 ID，可用于查找可用属性。必须采用“category/{category_id}”格式。
regionCode

string

ISO 3166-1 alpha-2 国家/地区代码，可用于查找可用属性。
languageCode

string

用于获取属性显示名称的 BCP 47 语言代码。如果未推出该语言版本，则会以英语提供。
showAll

boolean

当此字段设置为 true 时，系统会返回所有可用属性的元数据（忽略 parent 和 categoryName 字段）。当 showAll 设置为 true 时，必须提供 languageCode 和 regionCode。
pageSize

integer

每页包含的属性数量。默认值为 200，最小值为 1。
pageToken

string

如果指定，则检索下一页属性元数据。

请求正文

请求正文必须为空。

响应正文

AttributesService.ListAttributeMetadata 的响应。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "attributeMetadata": [
    {
      object (AttributeMetadata)
    }
  ],
  "nextPageToken": string
}
字段
attributeMetadata[]

object (AttributeMetadata)

一组可用属性的属性元数据。
nextPageToken

string

如果属性数量超过所请求的页面大小，系统会使用令牌填充此字段，以在后续调用 attributes.list 时获取下一页属性。如果没有其他属性，此字段将不会在响应中显示。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/business.manage

如需了解详情，请参阅 OAuth 2.0 概览。

AttributeMetadata

属性的元数据。包含属性的显示信息，其中包括本地化名称，以及用于将相关属性组合在一起的标题。

JSON 表示法 
{
  "parent": string,
  "valueType": enum (AttributeValueType),
  "displayName": string,
  "groupDisplayName": string,
  "repeatable": boolean,
  "valueMetadata": [
    {
      object (AttributeValueMetadata)
    }
  ],
  "deprecated": boolean
}
字段
parent

string

属性的唯一标识符。
valueType

enum (AttributeValueType)

属性的值类型。设置和检索的值应为此类型的值。
displayName

string

属性的本地化显示名（如果有）；否则为英文显示名。
groupDisplayName

string

包含此属性的群组的本地化显示名称（如果有）；否则为英文组名称。相关属性会收集到一个组中，并且应一起显示在此处指定的标题下。
repeatable

boolean

如果为 true，此属性将支持多个值。如果为 false，应仅提供一个值。
valueMetadata[]

object (AttributeValueMetadata)

对于某些类型的属性（例如枚举），系统会提供一个列表，其中包含支持的值以及这些值对应的显示名称。
deprecated

boolean

如果为 true，则此属性已弃用，不应再使用。如果已弃用，更新此属性将不会导致错误，但所做的更新将不会保存。此属性在弃用后的某个时刻会被完全移除，并引发错误。

AttributeValueMetadata

支持的属性值的元数据。

JSON 表示法 
{
  "value": value,
  "displayName": string
}
字段
value

value (Value format)

属性值。
displayName

string

该值的显示名（如果有的话），应进行本地化；英语。值显示名称应该与属性显示名称一起在上下文中使用。

例如，对于“Wi-Fi”枚举属性，可能包含“Paid”用于表示付费 Wi-Fi。