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

以半形逗號分隔的結構定義名稱清單。系統會擷取這些結構定義中的所有欄位。只有在 投影=custom 時，才需要設定這個選項。
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

詳情請參閱授權指南。

EventType

訂閱事件的類型

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

OrderBy

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

投影

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

SortOrder

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

ViewType

列舉
admin_view 結果包含管理員專用和網域公開欄位。
domain_public 結果只包含網域內其他使用者能公開檢視的欄位。