Method: advertisers.creatives.list

列出某个广告客户名下的广告素材。

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

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
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

允许按广告素材属性进行过滤。

支持的语法：

  • 过滤表达式由一项或多项限制组成。
  • 同一字段的限制必须按 OR 合并。
  • 对不同字段的限制必须通过 AND 合并。
  • 在 ( 和 ) 之间，同一字段只能有按 OR 合并的限制。
  • 限制的形式为 {field} {operator} {value}。
  • 对于以下字段，运算符必须为 EQUALS (=)：
    • entityStatus
    • creativeType.
    • dimensions
    • minDuration
    • maxDuration
    • approvalStatus
    • exchangeReviewStatus
    • dynamic
    • creativeId
  • 对于以下字段，运算符必须为 HAS (:)：
    • lineItemIds
  • 对于以下字段，运算符必须为 GREATER THAN OR EQUAL TO (>=) 或 LESS THAN OR EQUAL TO (<=)：
    • 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 概览。