Method: advertisers.campaigns.list

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

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

HTTP リクエスト

GET https://displayvideo.googleapis.com/v3/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）

例:

  • 広告主のすべての 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 Overview をご覧ください。