Method: users.watch

透過集合功能整理內容 你可以依據偏好儲存及分類內容。

留意使用者清單的變化。

HTTP 要求

POST https://admin.googleapis.com/admin/directory/v1/users/watch

此網址使用 gRPC 轉碼語法。

查詢參數

參數
domain

string

網域名稱。這個欄位只能只取得這個網域的使用者。如要改為傳回多網域填寫客戶欄位中的所有使用者，
customer

string

Google Workspace 帳戶的固定 ID。如果是多重網域，為客戶擷取所有使用者，請填入這個欄位，而非網域。
event

enum (EventType)

要監控的活動。
customFieldMask

string

以半形逗號分隔的結構定義名稱清單，系統會擷取這些結構定義中的所有欄位。只有在 投影=自訂項目時才需要設定。
maxResults

integer

要傳回的結果數上限。
orderBy

enum (OrderBy)

用於排序結果的資料欄
pageToken

string

用於指定清單中下一頁的權杖
projection

enum (Projection)

要為這位使用者擷取哪些欄位欄位。
query

string

查詢字串搜尋。格式應為「"」，完整說明文件的網址為：https: //developers.google.com/admin-sdk/directory/v1/guides/search-users
showDeleted

string

如果設為 true，系統會擷取已刪除的使用者清單。(預設值為 false)
sortOrder

enum (SortOrder)

要以遞增或遞減順序傳回結果。
viewType

enum (ViewType)

擷取使用者的管理員層級或全網域公開檢視。詳情請參閱以非管理員的身分擷取使用者。

要求主體

要求主體包含 SubscriptionChannel 的例項。

回應主體

如果成功，回應主體會包含 SubscriptionChannel 的執行例項。

授權範圍

需要下列其中一種 OAuth 範圍：

  • https://www.googleapis.com/auth/admin.directory.user
  • https://www.googleapis.com/auth/admin.directory.user.readonly
  • https://www.googleapis.com/auth/cloud-platform

詳情請參閱 OAuth 2.0 總覽。

EventType

訂閱事件類型

列舉
ADD 使用者建立的事件
DELETE 使用者刪除的活動
MAKE_ADMIN 使用者管理員狀態變更事件
UNDELETE 使用者已取消刪除的活動
UPDATE 使用者更新的活動

OrderBy

列舉
EMAIL 使用者的主要電子郵件地址。
FAMILY_NAME 使用者的姓氏。
GIVEN_NAME 使用者輸入的名稱。

Projection

列舉
BASIC 請勿向使用者顯示任何自訂欄位。
CUSTOM 加入 customFieldMask 中提及的結構定義自訂欄位。
FULL 加入與這位使用者相關聯的所有欄位。

SortOrder

列舉
ASCENDING 遞增排序。
DESCENDING 遞減順序。

查看類型

列舉
admin_view 結果包含僅限管理員和網域公開的欄位。
domain_public 結果只包含對網域中其他使用者公開的使用者欄位。