Method: googleAudiences.list

列出 Google 受众群体。

顺序由 orderBy 参数定义。

HTTP 请求

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

网址采用 gRPC 转码语法。

查询参数

参数
pageSize

integer

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

string

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

string

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

  • googleAudienceId（默认）
  • displayName

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

string

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

支持的语法：

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

支持的字段：

  • displayName

示例：

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

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

如需了解详情，请参阅我们的过滤 LIST 请求指南。
联合参数 accessor。必需。用于标识请求是在哪个 DV360 实体中发出的。LIST 请求将仅返回 accessor 中标识的 DV360 实体可以访问的 Google 受众群体实体。accessor 只能是下列其中一项：
partnerId

string (int64 format)

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

string (int64 format)

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

请求正文

请求正文必须为空。

响应正文

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

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

object (GoogleAudience)

Google 受众群体的列表。

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

string

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

授权范围

需要以下 OAuth 范围：

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

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