返回可用于指定主要类别和国家/地区的营业地点的属性列表。
HTTP 请求
GET https://mybusinessbusinessinformation.googleapis.com/v1/attributes
网址采用 gRPC 转码语法。
查询参数
参数 | |
---|---|
parent |
用于查找可用特性的营业地点的资源名称。如果设置了此字段,则 categoryName、regionCode、languageCode 和 showAll 不是必需的,并且不得设置。 |
categoryName |
主要类别的稳定 ID,可用于查找可用属性。必须采用“categories/{category_id}”格式。 |
regionCode |
ISO 3166-1 alpha-2 国家/地区代码,可用于查找可用属性。 |
languageCode |
用于获取属性显示名称的 BCP 47 语言代码。如果没有此语言,将以英语提供。 |
showAll |
当此字段设置为 true 时,将返回所有可用属性的元数据,而不考虑 parent 和 categoryName 字段。当 showAll 设置为 true 时,必须提供 languageCode 和 regionCode。 |
pageSize |
每页应包含的属性数量。默认值为 200,最小值为 1。 |
pageToken |
如果指定,则检索下一页属性元数据。 |
请求正文
请求正文必须为空。
响应正文
对 AttributesService.ListAttributeMetadata 的响应。
如果成功,响应正文将包含结构如下的数据:
JSON 表示法 |
---|
{
"attributeMetadata": [
{
object ( |
字段 | |
---|---|
attributeMetadata[] |
一组可用属性的属性元数据。 |
nextPageToken |
如果属性数量超过所请求的页面大小,系统会使用令牌填充此字段,以在后续调用 |
授权范围
需要以下 OAuth 作用域:
https://www.googleapis.com/auth/business.manage
有关详情,请参阅 OAuth 2.0 概览。
AttributeMetadata
属性的元数据。包含属性的显示信息,其中包括本地化名称以及将相关属性组合在一起的标题。
JSON 表示法 |
---|
{ "parent": string, "valueType": enum ( |
字段 | |
---|---|
parent |
属性的唯一标识符。 |
valueType |
属性的值类型。设置和检索的值应为此类型的值。 |
displayName |
属性的本地化显示名(如果有);否则为英文显示名。 |
groupDisplayName |
包含此属性的群组的本地化显示名(如果有);否则,则为英语群组名称。相关属性会收集到一个组中,并且应一起显示在指定标题下。 |
repeatable |
如果为 true,此属性将支持多个值。如果为 false,应仅提供一个值。 |
valueMetadata[] |
对于某些类型的属性(例如枚举),系统会提供一个列表,其中包含受支持的值以及这些值所对应的显示名。 |
deprecated |
如果为 true,说明此属性已弃用,不应再使用。如果已弃用,更新此属性不会导致错误,但系统不会保存相应更新。在弃用后的某个时刻,该属性将被完全移除,并且会导致错误。 |
AttributeValueMetadata
受支持的属性值的元数据。
JSON 表示法 |
---|
{ "value": value, "displayName": string } |
字段 | |
---|---|
value |
属性值。 |
displayName |
此值的显示名,应为本地化显示名(如果有);否则,为英文显示名。值显示名称应该在与属性显示名称一起使用。 例如,对于“Wi-Fi”枚举属性,这可能包含“付费”以表示付费 Wi-Fi。 |