Method: accountTypes.accounts.userLists.list

列出 UserLists。

授权标头：

此方法支持以下可选标头，用于定义 API 如何授权请求访问：

  • login-account：（可选）凭据的 Google 账号是用户的账号的资源名称。如果未设置，则默认为请求的账号。格式： accountTypes/{loginAccountType}/accounts/{loginAccountId}
  • linked-account：（可选）与 login-account 建立了产品关联的账号的资源名称。格式： accountTypes/{linkedAccountType}/accounts/{linkedAccountId}

HTTP 请求

GET https://datamanager.googleapis.com/v1/{parent=accountTypes/*/accounts/*}/userLists

网址采用 gRPC 转码语法。

路径参数

参数
parent

string

必需。拥有此用户名单集合的父级账号。格式：accountTypes/{accountType}/accounts/{account}

查询参数

参数
pageSize

integer

可选。要返回的用户名单的最大数量。服务返回的值可能小于此值。如果未指定，则最多返回 50 个用户名单。最大值为 1,000；大于 1,000 的值将被强制转换为 1,000。
pageToken

string

可选。从之前的 userLists.list 调用接收的页面令牌。利用其进行后续页面检索。

进行分页时，提供给 userLists.list 的所有其他参数必须与提供页面令牌的调用匹配。
filter

string

可选。一个过滤字符串。所有字段都需要位于每个条件的左侧（例如：display_name = "list 1"）。字段必须使用全驼峰式大小写或全蛇形命名法指定。请勿混用驼峰式大小写和蛇形命名法。

支持的操作：

  • AND
  • =
  • !=
  • >
  • >=
  • <
  • <=
  • :（具有）

支持的函数： - IN(field, value1, value2, ...)：如果字段与任何值匹配，则返回 true。示例：IN(display_name, "name1", "name2")

支持的字段：

  • id
  • display_name
  • description
  • membership_status
  • integration_code
  • access_reason
  • ingested_user_list_info.upload_key_types

请求正文

请求正文必须为空。

响应正文

针对 userLists.list 的响应消息。

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

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

object (UserList)

指定账号中的用户名单。
nextPageToken

string

可作为 pageToken 发送并用于检索下一页的令牌。如果省略此字段，则不存在后续页面。

授权范围

需要以下 OAuth 作用域：

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