Method: combinedAudiences.list

列出组合的受众群体。

顺序由 orderBy 参数定义。

HTTP 请求

GET https://displayvideo.googleapis.com/v3/combinedAudiences

网址采用 gRPC 转码语法。

查询参数

参数
pageSize

integer

请求的页面大小。 必须介于 1200 之间。如果未指定,则默认为 100。如果指定的值无效,则返回错误代码 INVALID_ARGUMENT

pageToken

string

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

orderBy

string

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

  • combinedAudienceId(默认)
  • displayName

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

filter

string

允许按组合受众群体字段进行过滤。

支持的语法:

  • 组合受众群体的过滤条件表达式最多只能包含一个限制条件。
  • 限制的格式为 {field} {operator} {value}
  • 所有字段都必须使用 HAS (:) 运算符。

支持的字段:

  • displayName

示例:

  • 显示名称包含“Google”的所有组合受众群体:displayName : "Google"

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

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

联合参数 accessor。必需。用于标识请求是在哪个 DV360 实体内发出的。LIST 请求将仅返回可供 accessor 中标识的 DV360 实体访问的组合受众群体实体。accessor 只能是下列其中一项:
partnerId

string (int64 format)

有权访问所提取的组合受众群体的合作伙伴的 ID。

advertiserId

string (int64 format)

有权访问提取的组合受众群体的广告客户的 ID。

请求正文

请求正文必须为空。

响应正文

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

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

object (CombinedAudience)

组合的受众群体列表。

如果为空,则不会显示此列表。

nextPageToken

string

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

授权范围

需要以下 OAuth 范围:

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

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