Method: categories.list

業種のリストを返します。検索はカテゴリ名と一致しますが、カテゴリ ID とは一致しません。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

クエリ パラメータ

パラメータ
regionCode

string

ISO 3166-1 alpha-2 の国コード。

languageCode

string

言語の BCP 47 コード。使用言語が利用できない場合、デフォルトで英語に設定されます。

searchTerm

string

ユーザーのフィルタ文字列(省略可)。

pageSize

integer

1 ページあたりで取得するカテゴリの数。デフォルトは 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 の概要をご覧ください。