展示广告和Video 360 API v2 将于
2024 年 9 月 3 日停用。请在此之前
迁移到 v3,以免服务中断。
Method: users.list
使用集合让一切井井有条
根据您的偏好保存内容并对其进行分类。
列出当前用户可以访问的用户。如果两个用户拥有同一个合作伙伴或广告客户的用户角色,那么他们可以互相访问。
此方法具有唯一身份验证要求。在使用此方法之前,请阅读我们的“管理用户”指南中的前提条件。
“试试此方法”链接功能不适用于此方法。
HTTP 请求
GET https://displayvideo.googleapis.com/v2/users
网址采用 gRPC 转码语法。
查询参数
参数 |
pageSize |
integer
请求的页面大小。必须介于 1 到 200 之间。如果未指定,则默认为 100 。
|
pageToken |
string
用于标识服务器应返回的结果页面的令牌。通常,这是上次调用 users.list 方法后返回的 nextPageToken 值。如果未指定,则返回第一页结果。
|
orderBy |
string
列表排序所依据的字段。可接受的值包括:
默认排序顺序为升序。如需指定字段的降序顺序,请添加后缀“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 中担任用户角色的所有用户以及对合作伙伴 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 概览。
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2024-08-21。
[{
"type": "thumb-down",
"id": "missingTheInformationINeed",
"label":"没有我需要的信息"
},{
"type": "thumb-down",
"id": "tooComplicatedTooManySteps",
"label":"太复杂/步骤太多"
},{
"type": "thumb-down",
"id": "outOfDate",
"label":"内容需要更新"
},{
"type": "thumb-down",
"id": "translationIssue",
"label":"翻译问题"
},{
"type": "thumb-down",
"id": "samplesCodeIssue",
"label":"示例/代码问题"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"其他"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"易于理解"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"解决了我的问题"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"其他"
}]
{
"last_modified": "最后更新时间 (UTC):2024-08-21。",
"state": ""
}