Method: users.list
透過集合功能整理內容
你可以依據偏好儲存及分類內容。
列出目前使用者可存取的使用者。如果兩位使用者在同一個夥伴或廣告主中擁有使用者角色,則這兩個使用者都能存取彼此。
HTTP 要求
GET https://displayvideo.googleapis.com/v1beta2/users
這個網址使用 gRPC 轉碼語法。
查詢參數
參數 |
pageSize |
integer
要求的頁面大小。必須介於 1 至 100 之間。如果未指定,則預設為 100 。
|
pageToken |
string
識別伺服器應傳回之結果頁面的符記。通常這是先前呼叫 users.list 方法後傳回的 nextPageToken 值。如未指定,系統會傳回第一頁的結果。
|
orderBy |
string
清單排序依據的欄位。可接受的值為:
預設的排序順序是遞增。如要為欄位指定遞減順序,請在欄位名稱中加入後置字串「desc」。例如 displayName desc 。
|
filter |
string
可依使用者屬性進行篩選。 支援的語法:
- 篩選器運算式由一或多項限制組成。
- 限制可以用邏輯運算子
AND 合併。
- 限制的形式為
{field} {operator} {value} 。
- 運算子必須是
CONTAINS (:) 或 EQUALS (=) 。
- 下列欄位的運算子必須是
CONTAINS (:) :
- 下列欄位的運算子必須是
EQUALS (=) :
assignedUserRole.userRole
assignedUserRole.partnerId
assignedUserRole.advertiserId
assignedUserRole.entityType :AssignUserRole 的合成欄位,用於篩選。識別使用者角色獲派的實體類型。有效值為 Partner 和 Advertiser 。
assignedUserRole.parentPartnerId :AssignUserRole 的合成欄位,用於篩選。用於識別指派使用者角色的實體上層合作夥伴。
示例:
- displayName 包含
foo :displayName:"foo"
- 擁有
bar 電子郵件地址的使用者:email:"bar"
- 所有具備標準使用者角色的使用者:
assignedUserRole.userRole="STANDARD"
- 具備合作夥伴 123 使用者角色的所有使用者:
assignedUserRole.partnerId="123"
- 所有具備廣告主 123 使用者角色的使用者:
assignedUserRole.advertiserId="123"
- 具備夥伴層級使用者角色的所有使用者:
entityType="PARTNER"
- 具備夥伴 123 和夥伴 123 底下廣告主的所有使用者角色:
parentPartnerId="123"
這個欄位的長度不得超過 500 個字元。
|
回應主體
如果成功,回應主體即會包含具有以下結構的資料:
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 和/或其關聯企業的註冊商標。
上次更新時間:2023-12-02 (世界標準時間)。
[{
"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":"其他"
}]