Method: advertisers.campaigns.list

広告主のキャンペーンを一覧表示します。

順序は orderBy パラメータで定義されます。entityStatus の filter が指定されていない場合、ENTITY_STATUS_ARCHIVED のキャンペーンは結果に含まれません。

HTTP リクエスト

GET https://displayvideo.googleapis.com/v1/advertisers/{advertiserId}/campaigns

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

パスパラメータ

パラメータ
advertiserId

string (int64 format)

キャンペーンを一覧表示する広告主の ID。

クエリ パラメータ

パラメータ
pageSize

integer

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

string

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

string

リストの並べ替え基準となるフィールドです。有効な値は次のとおりです。

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

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

string

キャンペーンのフィールドでフィルタできます。

サポートされる構文:

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

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

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

例:

  • 1 つの広告主のすべての「ENTITY_STATUS_ACTIVE」または「ENTITY_STATUS_PAUSED」キャンペーン: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")
  • 更新時間が 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 表現 
{
  "campaigns": [
    {
      object (Campaign)
    }
  ],
  "nextPageToken": string
}
フィールド
campaigns[]

object (Campaign)

キャンペーンのリスト。

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

string

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

認可スコープ

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

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

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