Method: advertisers.creatives.list

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

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

HTTP リクエスト

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

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

パスパラメータ

パラメータ
advertiserId

string (int64 format)

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

クエリ パラメータ

パラメータ
pageSize

integer

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

string

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

string

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

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

デフォルトの並べ替え順は昇順です。フィールドの降順を指定するには、接尾辞「desc」を使用しますフィールド名に を追加します。例: createTime desc。
filter

string

クリエイティブのプロパティでフィルタできます。

サポートされている構文:

  • フィルタ式は 1 つ以上の制限で構成されます。
  • 同じフィールドの制限は、OR で結合する必要があります。
  • 異なるフィールドの制限は、AND で組み合わせる必要があります。
  • ( と ) の間は、同じフィールドの OR によってのみ制限を組み合わせることができます。
  • 制限の形式は {field} {operator} {value} です。
  • 次のフィールドでは、演算子は EQUALS (=) にする必要があります。 <ph type="x-smartling-placeholder">
      </ph>
    • entityStatus
    • creativeType。
    • dimensions
    • minDuration
    • maxDuration
    • approvalStatus
    • exchangeReviewStatus
    • dynamic
    • creativeId
  • 次のフィールドでは、演算子は HAS (:) にする必要があります。 <ph type="x-smartling-placeholder">
      </ph>
    • lineItemIds
  • 次のフィールドでは、演算子は GREATER THAN OR EQUAL TO (>=) または LESS THAN OR EQUAL TO (<=) にする必要があります。 <ph type="x-smartling-placeholder">
      </ph>
    • updateTime（ISO 8601 形式または YYYY-MM-DDTHH:MM:SSZ で入力）
  • entityStatus、minDuration、maxDuration、updateTime、dynamic に適用される制限は 1 つだけです。
  • dimensions の場合、値は "{width}x{height}" の形式です。
  • exchangeReviewStatus の場合、値は {exchange}-{reviewStatus} の形式です。
  • minDuration と maxDuration の場合、値は "{duration}s" の形式です。ミリ秒単位の粒度で指定できるのは秒のみです。
  • updateTime の場合、クリエイティブ リソースのフィールド値はクリエイティブが最後に更新された時刻を表します。これには、システムによる更新（クリエイティブの審査の更新など）が含まれます。
  • 複数の広告申込情報 ID に対して検索するには、複数の lineItemIds 制限が適用されることがあります。
  • 複数のクリエイティブ ID で検索するには、複数の creativeId 制限が適用されることがあります。

例:

  • すべてのネイティブ クリエイティブ: creativeType="CREATIVE_TYPE_NATIVE"
  • 300x400 または 50x100 のサイズのすべての有効なクリエイティブ: 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 (format of ISO 8601) 以上のすべてのクリエイティブ: updateTime>="2020-11-04T18:54:47Z" このフィールドの長さは 500 文字以下にする必要があります。

リクエスト本文

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

レスポンスの本文

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

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