Method: categories.list

返回业务类别列表。搜索时,系统会匹配类别名称,但不会匹配类别 ID。

搜索只会匹配类别名称的前面(也就是说,“食品”可能会返回“美食广场”,而不会返回“快餐店”)。

HTTP 请求

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

网址采用 gRPC 转码语法。

查询参数

参数
regionCode

string

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

languageCode

string

必需。BCP 47 语言代码。

filter

string

可选。过滤用户的字符串。唯一支持的字段是 displayName。例如:filter=displayName=foo

pageSize

integer

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

pageToken

string

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

view

enum (CategoryView)

必需。指定响应中应返回的类别资源的哪些部分。

请求正文

请求正文必须为空。

响应正文

BusinessCategories.ListCategories 的响应消息。

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

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

object (Category)

基于所请求参数的匹配类别。

nextPageToken

string

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

授权范围

需要以下 OAuth 作用域:

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

有关详情,请参阅 OAuth 2.0 概览