Method: categories.list

返回业务类别列表。搜索将匹配类别名称,但不匹配类别 ID。

HTTP 请求

GET https://mybusiness.googleapis.com/v4/categories

网址采用 gRPC 转码语法。

查询参数

参数
regionCode

string

ISO 3166-1 alpha-2 国家/地区代码。

languageCode

string

BCP 47 语言代码。如果没有支持的语言,则默认设置为英语。

searchTerm

string

用户的可选过滤字符串。

pageSize

integer

每页可提取的类别数量。默认值为 100,最小值为 1,页面大小上限为 100。

pageToken

string

如果指定,则将获取下一页的类别。

view

enum (CategoryView)

可选。指定应在响应中返回类别资源的哪些部分。

请求正文

请求正文必须为空。

响应正文

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

JSON 表示法
{
  "categories": [
    {
      object (Category)
    }
  ],
  "totalCategoryCount": integer,
  "nextPageToken": string
}
字段
categories[]

object (Category)

类别。类别是基本视图。它们不包含任何 ServiceType 信息。

totalCategoryCount

integer

请求参数的类别总数。

nextPageToken

string

如果类别数量超过所请求的页面大小,系统会使用令牌填充此字段,以在后续调用 categories.list 时获取下一页类别。

授权范围

需要以下 OAuth 范围之一:

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

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