Method: users.list

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

此方法有獨特的驗證要求。使用這個方法前，請先參閱《管理使用者指南》中的必要條件。

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

HTTP 要求

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

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

查詢參數

參數
pageSize

integer

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

string

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

string

用來排序清單的欄位。可接受的值如下：

  • displayName (預設)

預設排序順序為遞增。如要針對欄位指定遞減順序，則應於欄位名稱後方加上「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 Overview。