Method: advertisers.list

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

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

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

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

リストの並べ替え基準として使用するフィールド。指定できる値は次のとおりです。

  • 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 の概要をご覧ください。