Method: advertisers.reachForecast.retrievePlannableUserLists

检索可用于预测的第一方和第三方用户名单。

HTTP 请求

GET https://displayvideo.googleapis.com/v4/advertisers/{advertiserId}/reachForecast:retrievePlannableUserLists

网址采用 gRPC 转码语法。

路径参数

参数
advertiserId

string (int64 format)

必需。要检索可规划用户名单的广告客户的 ID。

查询参数

参数
pageSize

integer

可选。请求的页面大小。必须介于 1 和 5000 之间。如果未指定，则默认值为 5000。
pageToken

string

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

string

可选。允许按可规划用户名单属性进行过滤。

支持的语法：

  • 过滤表达式由一个或多个限制条件组成。
  • 限制条件可以通过 AND 或 OR 逻辑运算符进行组合。
  • 限制条件的形式为 {field} {operator} {value}。
  • displayName 字段必须使用 HAS (:) 运算符。
  • 所有其他字段都必须使用 EQUALS (=) 运算符。

支持的字段：

  • plannableStatus
  • displayName
  • userListType
  • name

示例：

  • 所有可规划用户名单：plannableStatus="PLANNABLE"
  • 显示名称包含“Shopping”的可规划用户名单：plannableStatus="PLANNABLE" AND displayName:"Shopping"
  • 第一方用户名单：userListType="FIRST_PARTY"

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

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

请求正文

请求正文必须为空。

响应正文

针对 reachForecast.retrievePlannableUserLists 的响应。

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

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

object (PlannableUserList)

仅限输出。可规划用户名单的列表。
nextPageToken

string

仅限输出。用于检索下一页结果的令牌。

授权范围

需要以下 OAuth 范围：

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

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

PlannableUserList

用于覆盖面预测的可规划用户名单。

JSON 表示法 
{
  "displayName": string,
  "userListType": enum (UserListType),
  "name": string,
  "plannableStatus": enum (PlannableStatus)
}
字段
displayName

string

仅限输出。用户名单的显示名称。
userListType

enum (UserListType)

仅限输出。用户名单的类型。
name

string

仅限输出。用于标识用户名单的资源名称。

格式：advertisers/{advertiserId}/userLists/{user_list_id}
plannableStatus

enum (PlannableStatus)

仅限输出。用户名单的可规划性状态。

UserListType

用户名单的类型。

枚举
USER_LIST_TYPE_UNSPECIFIED 未指定的用户名单类型。
FIRST_PARTY 第一方用户名单。
THIRD_PARTY 第三方用户名单。

PlannableStatus

指示名单是否可规划的状态。

枚举
PLANNABLE_STATUS_UNSPECIFIED 未指定的可规划性状态。
PLANNABLE 用户名单可规划。
UNPLANNABLE 用户名单不可规划。