多媒體和Video 360 API v2 將於
2024 年 9 月 3 日停用。請在此之前
遷移至第 3 版,以免服務中斷。
Method: users.list
透過集合功能整理內容
你可以依據偏好儲存及分類內容。
列出目前使用者可存取的使用者。如果兩位使用者擁有同一夥伴或廣告客戶的使用者角色,他們就能互相存取。
這個方法有專屬的驗證規定。使用這個方法前,請先參閱管理使用者指南中的必要條件。
「試試這個方法」功能不適用於此方法。
HTTP 要求
GET https://displayvideo.googleapis.com/v1/users
這個網址使用 gRPC 轉碼語法。
查詢參數
參數 |
pageSize |
integer
要求的頁面大小。必須介於 1 至 200 之間。如果未指定,則預設值為 100 。
|
pageToken |
string
用於識別伺服器應傳回之結果頁面的符記。一般而言,這是從先前呼叫 users.list 方法傳回的 nextPageToken 值。如果未指定,系統將傳回第一頁的結果。
|
orderBy |
string
清單排序依據的欄位。可接受的值為:
預設的排序順序是遞增。如要為欄位指定遞減順序,請在後方加上「desc」即可加入欄位名稱。例如 displayName desc 。
|
filter |
string
可依使用者欄位進行篩選。 支援的語法:
- 篩選器運算式由一或多個限制組成。
- 限制可用邏輯運算子
AND 合併。
- 限制的形式為
{field} {operator} {value} 。
budget.budget_segments.date_range.end_date 欄位必須使用 LESS THAN (<) 運算子。
displayName and emailfield must use the HAS (:)` 運算子。
- 所有其他欄位都必須使用
EQUALS (=) 運算子。
支援的欄位:
assignedUserRole.advertiserId
assignedUserRole.entityType
- 這是
AssignedUserRole 的合成欄位,用於篩選。代表要指派使用者角色的實體類型。有效值為 Partner 和 Advertiser 。
assignedUserRole.parentPartnerId
- 這是
AssignedUserRole 的合成欄位,用於篩選。指出獲派使用者角色的實體的上層合作夥伴。
assignedUserRole.partnerId
assignedUserRole.userRole
displayName
email
範例:
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"
這個欄位的長度不得超過 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 總覽。
除非另有註明,否則本頁面中的內容是採用創用 CC 姓名標示 4.0 授權,程式碼範例則為阿帕契 2.0 授權。詳情請參閱《Google Developers 網站政策》。Java 是 Oracle 和/或其關聯企業的註冊商標。
上次更新時間:2024-08-22 (世界標準時間)。
[{
"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":"其他"
}]
{
"lastModified": "上次更新時間:2024-08-22 (世界標準時間)。",
"confidential": False
}