Method: advertisers.creatives.list

列出广告客户中的广告素材。

顺序由 orderBy 参数定义。如果未指定 entityStatus 的 filter，则具有 ENTITY_STATUS_ARCHIVED 的广告素材将不会包含在结果中。

HTTP 请求

GET https://displayvideo.googleapis.com/v3/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 字段，最多只能有一个限制。

支持的字段：

  • 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 字段以检索下一页结果。如果此字段为 null，则表示这是最后一页。

授权范围

需要以下 OAuth 范围：

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

如需了解详情，请参阅 OAuth 2.0 概览。