Method: users.list

列出当前用户可以访问的用户。如果两个用户在同一合作伙伴或广告客户中担任用户角色,那么他们可以互相访问。

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

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

HTTP 请求

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

网址采用 gRPC 转码语法。

查询参数

参数
pageSize

integer

请求的页面大小。必须介于 1200 之间。如果未指定,则默认为 100

pageToken

string

标识服务器应返回的结果页面的令牌。通常,这是上一次调用 users.list 方法后返回的 nextPageToken 值。如果未指定,将返回第一页结果。

orderBy

string

列表排序所依据的字段。可接受的值包括:

  • displayName(默认)

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

filter

string

允许按用户字段过滤。

支持的语法:

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

支持的字段:

  • assignedUserRole.advertiserId
  • assignedUserRole.entityType:这是用于过滤的 AssignedUserRole 的合成字段。标识分配了用户角色的实体类型。有效值为 PartnerAdvertiser
  • 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 概览