Method: mediaPlanners.list

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

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

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

HTTP リクエスト

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

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

クエリ パラメータ

パラメータ
pageSize

integer

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

string

省略可。サーバーが返す結果のページを識別するトークン。この値は、以前の mediaPlanners.list 呼び出しで ListMediaPlannersResponse.nextPageToken から取得されます。
filter

string

省略可。Cloud API のリストフィルタリング構文を使用したクエリ文字列。フィルタリングでサポートされている列は次のとおりです。

  • name
  • displayName
  • ancestorNames

リクエストの本文

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

レスポンスの本文

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

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

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

object (MediaPlanner)

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

string

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

認可スコープ

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

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

MediaPlanner

メディア プランナー アカウントを表します。

JSON 表現 
{
  "accountId": string,
  "name": string,
  "displayName": string,
  "ancestorNames": [
    string
  ]
}
フィールド
accountId
(deprecated)

string

出力専用。メディア プランナーのアカウント ID。
name

string

ID。メディア プランナーの一意のリソース名。形式: mediaPlanners/{mediaPlannerAccountId}。mediaPlanners.list メソッドのレスポンスをフィルタするために使用できます。
displayName

string

出力専用。メディア プランナーの表示名。[mediaPlanners.list][google.ads.authorizedbuyers.marketplace.v1main.MediaPlanners.ListMediaPlanners] メソッドのレスポンスをフィルタするために使用できます。
ancestorNames[]

string

出力専用。メディア プランナーの祖先名。形式: mediaPlanners/{mediaPlannerAccountId}。mediaPlanners.list メソッドのレスポンスをフィルタするために使用できます。