Method: mediaPlanners.list

呼び出し元がアクセスできるすべてのメディア プランナー アカウントを一覧表示します。

キュレーターの場合、キュレーター規約に同意したすべてのメディア プランナーが返されます。

他のアカウントでメディア プランナーを一覧表示しようとすると、エラーが返されます。

HTTP リクエスト

GET https://curationpartners.googleapis.com/v1/mediaPlanners

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

クエリ パラメータ

パラメータ
pageSize

integer

返されるメディア プランナーの最大数。指定されていない場合は、最大で 100 人のメディア プランナーが返されます。最大値は 500 です。500 を超える値は 500 に強制変換されます。

pageToken

string

省略可。サーバーが返す必要がある結果のページを特定するトークン。この値は、ListMediaPlannersResponse.nextPageToken の前の mediaPlanners.list 呼び出しから受け取ります。

filter

string

Cloud API リスト フィルタリング構文を使用したオプションのクエリ文字列。フィルタリングに対応する列は次のとおりです。

  • name
  • displayName
  • ancestorNames

リクエストの本文

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

レスポンスの本文

メディア プランナーのアカウント情報を含むレスポンス。

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

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

object (MediaPlanner)

メディア プランナーのリスト。

nextPageToken

string

ListMediaPlannersRequest.page_token の結果の次のページを取得するために、mediaPlanners.list メソッドの後続の呼び出しに渡すことができるトークン。

認可スコープ

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

  • https://www.googleapis.com/auth/curation-partners