Method: advertisers.list

現在のユーザーがアクセスできる広告主を一覧表示します。

順序は orderBy パラメータで定義されます。

partnerId は 1 つ必要です。クロスパートナー リスティングはサポートされていません。

HTTP リクエスト

GET https://displayvideo.googleapis.com/v3/advertisers

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

クエリ パラメータ

パラメータ
partnerId

string (int64 format)

必須。取得した広告主がすべて属するパートナーの ID。システムでは、一度に 1 つのパートナーの広告主のみを一覧表示できます。
pageSize

integer

リクエストされたページサイズ。1～200 の範囲で指定してください。指定しない場合、デフォルトで 100 になります。
pageToken

string

サーバーが返す必要がある結果のページを特定するトークン。通常、これは advertisers.list メソッドの前の呼び出しから返された nextPageToken の値です。指定しない場合は、結果の最初のページが返されます。
orderBy

string

リストの並べ替えに使用するフィールド。使用できる値は次のとおりです。

  • advertiserId（デフォルト）
  • displayName
  • entityStatus
  • updateTime

デフォルトの並べ替え順序は昇順です。フィールドに対して降順を指定するには、フィールド名に接尾辞「desc」を追加する必要があります。例: displayName desc
filter

string

広告主のフィールドでフィルタリングできます。

サポートされる構文:

  • フィルタ式は、1 つ以上の制限で構成されます。
  • 制限は、AND または OR 論理演算子で組み合わせることができます。
  • 制限の形式は {field} {operator} {value} です。
  • updateTime フィールドでは、GREATER THAN OR EQUAL TO (>=) 演算子または LESS THAN OR EQUAL TO (<=) 演算子を使用する必要があります。
  • 他のすべてのフィールドは EQUALS (=) 演算子を使用する必要があります。

サポートされているフィールド:

  • advertiserId
  • displayName
  • entityStatus
  • updateTime（ISO 8601 形式または YYYY-MM-DDTHH:MM:SSZ で入力）

例:

  • パートナーのすべての有効な広告主: entityStatus="ENTITY_STATUS_ACTIVE"
  • 更新日時が 2020-11-04T18:54:47Z（ISO 8601 形式）以下のすべての広告主様: updateTime<="2020-11-04T18:54:47Z"
  • 更新時刻が 2020-11-04T18:54:47Z（ISO 8601 形式）以降のすべての広告主様: updateTime>="2020-11-04T18:54:47Z"

このフィールドの長さは 500 文字以下にする必要があります。

詳しくは、フィルタ LIST リクエストのガイドをご覧ください。

リクエストの本文

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

レスポンスの本文

成功すると、レスポンスの本文に次の構造のデータが含まれます。

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

object (Advertiser)

広告主のリスト。

空の場合、このリストは存在しません。
nextPageToken

string

結果の次のページを取得するためのトークン。 この値を次の advertisers.list メソッド呼び出しの pageToken フィールドで渡して、結果の次ページを取得します。

認可スコープ

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

  • https://www.googleapis.com/auth/display-video

詳細については、OAuth 2.0 Overview をご覧ください。