Method: users.list

列出目前使用者可存取的使用者。如果兩位使用者在同一個夥伴或廣告主中擁有使用者角色，則這兩個使用者都能存取彼此。

這個方法有獨特的驗證需求。使用這個方法前，請先詳閱管理使用者指南中的先決條件。

「試用這個方法」功能不適用於這個方法。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

查詢參數

參數
pageSize

integer

要求的頁面大小。必須介於 1 至 200 之間。如果未指定，則預設為 100。
pageToken

string

識別伺服器應傳回之結果頁面的符記。通常這是先前呼叫 users.list 方法後傳回的 nextPageToken 值。如未指定，系統會傳回第一頁的結果。
orderBy

string

清單排序依據的欄位。可接受的值為：

  • displayName (預設)

預設的排序順序是遞增。如要為欄位指定遞減順序，請在欄位名稱中加入後置字串「desc」。例如 displayName desc。
filter

string

允許依使用者欄位進行篩選。

支援的語法：

  • 篩選器運算式由一或多項限制組成。
  • 限制可以用邏輯運算子 AND 合併。
  • 限制的形式為 {field} {operator} {value}。
  • budget.budget_segments.date_range.end_date 欄位必須使用 LESS THAN (<) 運算子。
  • displayName andemailfield must use theHAS (:)` 運算子。
  • 所有其他欄位都必須使用 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 總覽。