Method: customLists.list

列出自定义名单。

顺序由 orderBy 参数定义。

HTTP 请求

GET https://displayvideo.googleapis.com/v5/customLists

网址采用 gRPC 转码语法。

查询参数

参数
pageSize

integer

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

string

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

string

用于对列表进行排序的字段。可接受的值包括：

  • customListId（默认）
  • displayName

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

string

允许按自定义列表字段进行过滤。

支持的语法：

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

支持的字段：

  • displayName

示例：

  • 显示名称中包含“Google”的所有自定义名单：displayName:"Google"。

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

如需了解详情，请参阅我们的过滤 LIST 请求指南。
必需。标识发出请求的 DV360 实体。LIST 请求只会返回 accessor 中标识的 DV360 实体可访问的自定义名单实体。以下是互斥字段的列表。在响应中，最多只能设置其中一个字段：
advertiserId

string (int64 format)

有权访问所提取自定义名单的 DV360 广告客户的 ID。
互斥字段结束。

请求正文

请求正文必须为空。

响应正文

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

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

object (CustomList)

自定义名单列表。

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

string

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

授权范围

需要以下 OAuth 范围：

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

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