重要なエンドポイントが無効化される前に、Google Business Profile API 統合をアップデートする必要があります。2022 年 4 月から発生する可能性がある機能中断を避けるため、サポート終了スケジュールと説明を参照しましょう。

Method: categories.list

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

検索でカテゴリ名の先頭のみが照合されます(例: 「フードコート」が「フードコート」を返します。ただし、ファーストフード店の場合は戻りません)。

HTTP リクエスト

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

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

クエリ パラメータ

パラメータ
regionCode

string

必須。ISO 3166-1 alpha-2 の国コードです。

languageCode

string

必須。言語の BCP 47 コード。

filter

string

(省略可)ユーザーから文字列をフィルタします。サポートされるフィールドは displayName のみです。(例: filter=displayName=foo)。

pageSize

integer

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