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

Method: accounts.list

認証されたユーザーのすべてのアカウントのリストを取得します。これには、ユーザーが所有するすべてのアカウントと、ユーザーが管理権限を持つアカウントが含まれます。

HTTP リクエスト

GET https://mybusinessaccountmanagement.googleapis.com/v1/accounts

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

クエリ パラメータ

パラメータ
parentAccount

string

(省略可)直接アクセス可能なアカウントのリストを取得するアカウントのリソース名。組織とユーザー グループに対してのみ有効です。空の場合、認証されたユーザーに対して accounts.list が返されます。accounts/{account_id}

pageSize

integer

(省略可)1 ページあたりで取得するアカウントの数。デフォルトは 20 です。

pageToken

string

(省略可)指定すると、アカウントの次のページが取得されます。accounts.list の呼び出しが、リクエストしたページサイズを上回る数の結果を返すと、pageToken が返されます。

filter

string

(省略可)返されるアカウントを制限するフィルタ。レスポンスには、フィルタに一致するエントリのみが含まれます。filter が空の場合、制約は適用されず、リクエストされたアカウントにすべてのアカウント(ページ分けされたページ)が取得されます。

たとえば、フィルタ type=USER_GROUP を含むリクエストでは、ユーザー グループのみが返されます。

サポートされるフィルタは type フィールドのみです。

リクエスト本文

リクエストの本文は空にする必要があります。

レスポンスの本文

成功すると、レスポンスの本文に次の構造のデータが含まれます。

Accounts.ListAccounts に対するレスポンス メッセージです。

JSON 表現
{
  "accounts": [
    {
      object (Account)
    }
  ],
  "nextPageToken": string
}
フィールド
accounts[]

object (Account)

ユーザーがアクセス権を持つアカウントの集まり。除外された場合を除き、クエリを実行したユーザーの個人アカウントが、常に検索結果の最初の項目となります。

nextPageToken

string

アカウントの数がリクエストしたページサイズを超えた場合、このフィールドには、後続の accounts.list 呼び出しでアカウントの次のページを取得するためのトークンが入力されます。取得するアカウントがない場合、このフィールドはレスポンスに含まれません。

認証スコープ

次の OAuth スコープが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。