Method: advertisers.campaigns.list

列出广告客户中的广告系列。

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

HTTP 请求

GET https://displayvideo.googleapis.com/v3/advertisers/{advertiserId}/campaigns

网址采用 gRPC 转码语法。

路径参数

参数
advertiserId

string (int64 format)

要列出广告系列的广告客户的 ID。

查询参数

参数
pageSize

integer

请求的页面大小。 必须介于 1 和 200 之间。如果未指定，则默认为 100。
pageToken

string

标识服务器应返回的结果页面的令牌。通常，这是上一次调用 campaigns.list 方法时返回的 nextPageToken 值。如果未指定，则返回第一页的结果。
orderBy

string

表示要按哪个字段对此列表进行排序。可接受的值包括：

  • displayName（默认）
  • entityStatus
  • updateTime

默认排序顺序为升序。如需将字段指定为降序，应在字段名称中添加后缀“desc”。示例：displayName desc。
filter

string

允许按广告系列字段进行过滤。

支持的语法：

  • 过滤表达式由一个或多个限制条件组成。
  • 您可以使用 AND 或 OR 逻辑运算符组合限制条件。一系列限制隐式使用 AND。
  • 限制的格式为 {field} {operator} {value}。
  • updateTime 字段必须使用 GREATER THAN OR EQUAL TO (>=) 或 LESS THAN OR EQUAL TO (<=) 运算符。
  • 所有其他字段都必须使用 EQUALS (=) 运算符。

支持的字段：

  • campaignId
  • displayName
  • entityStatus
  • updateTime（以 ISO 8601 格式输入，或 YYYY-MM-DDTHH:MM:SSZ）

示例：

  • 某个广告客户名下的所有 ENTITY_STATUS_ACTIVE 或 ENTITY_STATUS_PAUSED 广告系列：(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")
  • 更新时间早于或等于 2020-11-04T18:54:47Z（ISO 8601 格式）的所有广告系列：updateTime<="2020-11-04T18:54:47Z"
  • 更新时间晚于或等于 2020-11-04T18:54:47Z（ISO 8601 格式）的所有广告系列：updateTime>="2020-11-04T18:54:47Z"

此字段的长度不应超过 500 个字符。

如需了解详情，请参阅我们的过滤 LIST 请求指南。

请求正文

请求正文必须为空。

响应正文

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "campaigns": [
    {
      object (Campaign)
    }
  ],
  "nextPageToken": string
}
字段
campaigns[]

object (Campaign)

广告系列列表。

如果为空，则此列表将不存在。
nextPageToken

string

用于检索下一页结果的令牌。在后续对 campaigns.list 方法的调用中，将此值传入 pageToken 字段，以检索下一页结果。

授权范围

需要以下 OAuth 范围之一：

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

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