Method: accounts.list

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

HTTP リクエスト

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

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

クエリ パラメータ

パラメータ
parentAccount

string

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

integer

省略可。ページあたりで取得するアカウントの数です。デフォルトおよび最大値は 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 の概要をご覧ください。