Method: advertisers.creatives.list

列出廣告客戶中的廣告素材。

順序由 orderBy 參數定義。如未指定 entityStatus 的 filter，含有 ENTITY_STATUS_ARCHIVED 的廣告素材將不會納入結果中。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
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

允許依廣告素材欄位進行篩選。

支援的語法：

  • 篩選器運算式由一或多項限制組成。
  • 限制可以使用 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"
  • 所有尺寸為 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 (ISO 8601 格式) 的所有廣告素材：updateTime>="2020-11-04T18:54:47Z"

這個欄位的長度不得超過 500 個字元。

詳情請參閱篩選器 LIST 要求指南。

要求主體

要求主體必須為空白。

回應主體

如果成功，回應主體即會包含具有以下結構的資料：

JSON 表示法 
{
  "creatives": [
    {
      object (Creative)
    }
  ],
  "nextPageToken": string
}
欄位
creatives[]

object (Creative)

廣告素材清單。

如果留空，這份清單將不會顯示。
nextPageToken

string

用於擷取下一頁結果的權杖。在對 ListCreativesRequest 方法的後續呼叫中將這個值傳入 pageToken 欄位，即可擷取下一頁的結果。如果這個欄位為空值，表示這是最後一頁。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱 OAuth 2.0 總覽。