Method: accounts.list

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

HTTP リクエスト

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

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

クエリ パラメータ

パラメータ
pageSize

integer

1 ページあたりで取得するアカウント数。デフォルトは 20、最小値は 2、最大ページサイズは 20 です。
pageToken

string

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

string

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

string

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

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

リクエスト本文

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

レスポンスの本文

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

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

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

object (Account)

ユーザーがアクセスできるアカウントのコレクション。クエリを実行したユーザーの個人アカウントが、フィルタで除外されていない限り、常に結果の最初の項目になります。
nextPageToken

string

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

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳細については、OAuth 2.0 の概要をご覧ください。