Method: accounts.list

呼び出し元のユーザーがアクセスでき、ページサイズやフィルタなどのリクエストの制約に一致するアカウントを一覧表示します。MCA のサブアカウントだけでなく、呼び出し元のユーザーがアクセスできるすべてのアカウント(他の MCA、リンクされたアカウント、スタンドアロン アカウントなど)が一覧表示されます。フィルタを指定しない場合、ユーザーが直接追加されているアカウントが返されます。

HTTP リクエスト

GET https://merchantapi.googleapis.com/accounts/v1beta/accounts

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

クエリ パラメータ

パラメータ
pageSize

integer

省略可。返されるアカウントの最大数。サービスが返す値はこれよりも少ないことがあります。指定されていない場合は、最大で 250 アカウントが返されます。最大値は 500 です。500 を超える値は 500 に強制変換されます。

pageToken

string

省略可。前回の accounts.list 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

ページ分割を行う場合、accounts.list に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

filter

string

省略可。フィルタに一致するアカウントのみを返します。詳しくは、フィルタ構文のリファレンスをご覧ください。

リクエスト本文

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

レスポンスの本文

accounts.list メソッドに対するレスポンス メッセージ。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

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

object (Account)

ListAccountsRequest に一致するアカウント。

nextPageToken

string

次のページを取得するために pageToken として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

認可スコープ

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

  • https://www.googleapis.com/auth/content

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