Method: organizations.list

ユーザーがアクセスできる組織のリストを返します。

HTTP リクエスト

GET https://marketingplatformadmin.googleapis.com/v1alpha/organizations

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

クエリ パラメータ

パラメータ
pageSize

integer

省略可。1 回の呼び出しで返される組織の最大数。サービスから返される数は、この値より少ない場合があります。

指定されていない場合、最大で 50 個の組織が返されます。最大値は 1,000 です。1,000 を超える値は 1,000 に強制変換されます。
pageToken

string

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

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

リクエストの本文

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

レスポンスの本文

organizations.list RPC のレスポンス メッセージ。

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

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

object (Organization)

ユーザーがアクセスできる組織リソース。組織 ID と表示名が含まれます。
nextPageToken

string

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

認可スコープ

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

  • https://www.googleapis.com/auth/marketingplatformadmin.analytics.read
  • https://www.googleapis.com/auth/marketingplatformadmin.analytics.update