Method: advertisers.list

列出当前用户可访问的广告客户。

具体顺序由 orderBy 形参定义。

必须提供单个 partnerId。不支持跨合作伙伴商品详情。

HTTP 请求

GET https://displayvideo.googleapis.com/v2/advertisers

网址采用 gRPC 转码语法。

查询参数

参数
partnerId

string (int64 format)

必需。所提取的广告客户都应所属的合作伙伴的 ID。系统一次只能为 1 个合作伙伴列出广告客户。

pageSize

integer

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

pageToken

string

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

orderBy

string

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

  • displayName(默认)
  • entityStatus
  • updateTime

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

filter

string

允许按广告客户字段过滤。

支持的语法:

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

支持的字段:

  • advertiserId
  • displayName
  • entityStatus
  • updateTime(ISO 8601 格式输入或 YYYY-MM-DDTHH:MM:SSZ

示例:

  • 一个合作伙伴名下的所有有效广告客户:entityStatus="ENTITY_STATUS_ACTIVE"
  • 更新时间小于或等于 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 表示法
{
  "advertisers": [
    {
      object (Advertiser)
    }
  ],
  "nextPageToken": string
}
字段
advertisers[]

object (Advertiser)

广告客户列表。

如果为空,则不存在此列表。

nextPageToken

string

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

授权范围

需要以下 OAuth 作用域:

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

有关详情,请参阅 OAuth 2.0 概览