Method: advertisers.campaigns.list

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

具体顺序由 orderBy 形参定义。如果未指定 entityStatusfilter,则结果中将不会包含具有 ENTITY_STATUS_ARCHIVED 的广告系列。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
advertiserId

string (int64 format)

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

查询参数

参数
pageSize

integer

请求的页面大小。必须介于 1200 之间。如果未指定,则默认为 100

pageToken

string

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

orderBy

string

列表排序所依据的字段。可接受的值包括:

  • displayName(默认)
  • entityStatus
  • updateTime

默认排序顺序为升序。要为字段指定降序,则应在字段名称中添加后缀“desc”。示例:displayName desc

filter

string

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

支持的语法:

  • 过滤条件表达式由一项或多项限制组成。
  • 限制可以通过 ANDOR 逻辑运算符合并。一系列限制隐式使用 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_ACTIVEENTITY_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 概览