Method: advertisers.creatives.list

広告主のクリエイティブを一覧表示します。

順序は orderBy パラメータで定義されます。entityStatus の filter が指定されていない場合、ENTITY_STATUS_ARCHIVED のクリエイティブは結果に含まれません。

HTTP リクエスト

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

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

パスパラメータ

パラメータ
advertiserId

string (int64 format)

必須。クリエイティブを一覧表示する広告主の ID。

クエリ パラメータ

パラメータ
pageSize

integer

リクエストされたページサイズです。 1～200 の範囲で指定してください。指定しない場合のデフォルトは 100 です。無効な値が指定されている場合は、エラーコード INVALID_ARGUMENT を返します。
pageToken

string

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

string

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

  • creativeId（デフォルト）
  • createTime
  • mediaDuration
  • dimensions（まず幅で並べ替え、次に高さで並べ替え）

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

string

クリエイティブ フィールドでのフィルタリングを可能にします。

サポートされる構文:

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

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

  • approvalStatus
  • creativeId
  • creativeType
  • dimensions（{width}x{height} の形式で入力）
  • dynamic
  • entityStatus
  • exchangeReviewStatus（{exchange}-{reviewStatus} の形式で入力）
  • lineItemIds
  • maxDuration（{duration}s の形式で入力。秒のみがサポートされています）
  • minDuration（{duration}s の形式で入力。秒のみがサポートされています）
  • updateTime（ISO 8601 形式または YYYY-MM-DDTHH:MM:SSZ での入力）

メモ:

  • updateTime の場合、クリエイティブ リソースのフィールド値はクリエイティブが最後に更新された日時を表します。これにはシステムによって行われた更新（クリエイティブの審査の更新など）も含まれます。

例:

  • すべてのネイティブ クリエイティブ: creativeType="CREATIVE_TYPE_NATIVE"
  • 300×400 または 50×100 の有効なすべてのクリエイティブ: entityStatus="ENTITY_STATUS_ACTIVE" AND (dimensions="300x400" OR dimensions="50x100")
  • AdX または AppNexus で承認され、再生時間が 5 秒以上 200 ミリ秒以上のすべてのダイナミック クリエイティブ: dynamic="true" AND minDuration="5.2s" AND (exchangeReviewStatus="EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED" OR exchangeReviewStatus="EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED")
  • 広告申込情報 ID 1 または 2 に関連付けられているすべての動画クリエイティブ: creativeType="CREATIVE_TYPE_VIDEO" AND (lineItemIds:1 OR lineItemIds:2)
  • 複数のクリエイティブ ID でクリエイティブを検索: creativeId=1 OR creativeId=2
  • 更新時間が 2020-11-04T18:54:47Z（ISO 8601 形式）以上のすべてのクリエイティブ: updateTime>="2020-11-04T18:54:47Z"

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

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

リクエスト本文

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

レスポンスの本文

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

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

object (Creative)

クリエイティブのリスト。

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

string

結果の次のページを取得するためのトークン。 結果の次のページを取得するには、後続の ListCreativesRequest メソッドの呼び出しで、この値を pageToken フィールドに渡します。このフィールドが null の場合、これが最後のページであることを意味します。

認可スコープ

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

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

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