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

詳情請參閱授權指南。

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 搜尋結果只會包含網域中其他使用者可公開檢視的欄位。