Method: users.list

列出当前用户可访问的用户。如果两个用户在同一合作伙伴或广告客户中拥有用户角色，则他们可以相互访问。

此方法有独特的身份验证要求。在使用此方法之前，请先阅读管理用户指南中的前提条件。

“试用此方法”功能不适用于此方法。

HTTP 请求

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

网址采用 gRPC 转码语法。

查询参数

参数
pageSize

integer

请求的页面大小。 必须介于 1 到 200 之间。如果未指定，则默认为 100。
pageToken

string

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

string

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

  • displayName（默认）

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

string

允许按用户字段进行过滤。

支持的语法：

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

支持的字段：

  • assignedUserRole.advertiserId
  • assignedUserRole.entityType：这是 AssignedUserRole 的合成字段，用于过滤。标识用户角色分配到的实体类型。有效值为 Partner 和 Advertiser。
  • assignedUserRole.parentPartnerId：这是 AssignedUserRole 的合成字段，用于过滤。标识用户角色所分配到的实体的父级合作伙伴。
  • assignedUserRole.partnerId
  • assignedUserRole.userRole
  • displayName
  • email
  • lastLoginTime（采用 ISO 8601 格式或 YYYY-MM-DDTHH:MM:SSZ 格式输入）

示例：

  • displayName 包含“foo”的用户：displayName:"foo"
  • email 包含“bar”的用户：email:"bar"
  • 所有具有标准用户角色的用户：assignedUserRole.userRole="STANDARD"
  • 拥有合作伙伴 123 的用户角色的所有用户：assignedUserRole.partnerId="123"
  • 拥有广告客户 123 的用户角色的所有用户：assignedUserRole.advertiserId="123"
  • 具有合作伙伴级别用户角色的所有用户：entityType="PARTNER"
  • 对于合作伙伴 123 及其下属广告客户，所有担任用户角色的用户：parentPartnerId="123"
  • 上次登录时间不早于 2023-01-01T00:00:00Z（ISO 8601 格式）的所有用户：lastLoginTime>="2023-01-01T00:00:00Z"

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

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

请求正文

请求正文必须为空。

响应正文

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

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

object (User)

用户列表。

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

string

用于检索下一页结果的令牌。在后续调用 users.list 方法时，在 pageToken 字段中传递此值，以检索下一页结果。如果没有更多结果需返回，系统将不提供此令牌。

授权范围

需要以下 OAuth 范围：

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

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