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

以半形逗號分隔的結構定義名稱清單。系統會擷取這些結構定義的所有欄位。只有在 projection=custom 時才應設定。
maxResults

integer

要傳回的結果數上限。
orderBy

enum (OrderBy)

用來排序結果的資料欄
pageToken

string

用於指定清單中下一頁的符記
projection

enum (Projection)

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

string

查詢字串搜尋。格式應為「」。完整說明文件請見 https: //developers.google.com/workspace/admin/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

詳情請參閱授權指南。

EventType

訂閱事件類型

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

排序依據

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

預測值

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

SortOrder

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

ViewType

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