Method: customers.userLists.list

列出由指定广告数据中心客户管理的用户名单。

HTTP 请求

GET https://adsdatahub.googleapis.com/v1/{parent=customers/*}/userLists

网址采用 gRPC 转码语法。

路径参数

参数
parent

string

必需。父级客户资源名称，例如 'customers/123'。

查询参数

参数
pageSize

integer

要返回的商品数量上限。如果为 0，服务器将确定要返回的用户列表的数量。
pageToken

string

上一个调用返回的页面令牌，用于请求下一页结果。
filter

string

过滤条件示例：title = "user*”” & title = "*name*” - AND -type = FREQUENCY_BASED AND createEmail = "creator@email.com" AND listSize > 10 AND fillTime > "2012-04-21-21-04-21
view

enum (UserListView)

指定要在每个用户列表中包含的字段。
showDeleted

boolean

如果此政策设为 true，已删除的用户名单将会包含在响应中。

请求正文

请求正文必须为空。

响应正文

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

对 userLists.list 请求的响应。包含由指定广告数据中心客户管理的用户名单。

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

object (UserList)

用户列表。
nextPageToken

string

可用于请求下一个结果页面的令牌。如果没有其他结果，则此字段为空。

授权范围

需要以下 OAuth 作用域：

  • https://www.googleapis.com/auth/adsdatahub

用户名单视图

用于指明要在 [userLists.list] API 返回的每个用户列表中包含哪些字段的枚举。

枚举
USER_LIST_VIEW_UNSPECIFIED 默认值 / 未设置值。该 API 将默认为 FULL 视图。
BASIC 包含除 [recipientAdsDataLinks] 以外的字段。
FULL 包含所有内容。