Method: users.watch
Sử dụng bộ sưu tập để sắp xếp ngăn nắp các trang
Lưu và phân loại nội dung dựa trên lựa chọn ưu tiên của bạn.
Theo dõi các thay đổi trong danh sách người dùng.
Yêu cầu HTTP
POST https://admin.googleapis.com/admin/directory/v1/users/watch
URL sử dụng cú pháp Chuyển mã gRPC.
Tham số truy vấn
| Thông số |
domain |
string
Tên miền. Điền vào trường này để chỉ nhận người dùng từ miền này. Để trả về tất cả người dùng trong trường khách hàng điền nhiều miền."
|
customer |
string
Mã nhận dạng không thể thay đổi của tài khoản Google Workspace. Trong trường hợp nhiều miền, để tìm nạp tất cả người dùng cho một khách hàng, hãy điền vào trường này thay vì miền.
|
event |
enum (EventType)
Các sự kiện cần chú ý.
|
customFieldMask |
string
Danh sách tên giản đồ được phân tách bằng dấu phẩy. Tất cả các trường trong các giản đồ này đều được tìm nạp. Bạn chỉ nên đặt giá trị này khi projection=custom.
|
maxResults |
integer
Số lượng kết quả tối đa cần trả về.
|
orderBy |
enum (OrderBy)
Cột dùng để sắp xếp kết quả
|
pageToken |
string
Mã thông báo để chỉ định trang tiếp theo trong danh sách
|
projection |
enum (Projection)
Nhóm nhỏ các trường cần tìm nạp cho người dùng này.
|
query |
string
Tìm kiếm bằng chuỗi truy vấn. Phải có dạng "". Bạn có thể xem tài liệu đầy đủ tại https: //developers.google.com/workspace/admin/directory/v1/guides/search-users
|
showDeleted |
string
Nếu bạn đặt thành đúng, thì hệ thống sẽ truy xuất danh sách người dùng đã xoá. (Mặc định: false)
|
sortOrder |
enum (SortOrder)
Liệu có trả về kết quả theo thứ tự tăng dần hay giảm dần hay không.
|
viewType |
enum (ViewType)
Liệu có tìm nạp chế độ xem công khai trên toàn miền dành cho quản trị viên hoặc chế độ xem công khai trên toàn miền dành cho người dùng hay không. Để biết thêm thông tin, hãy xem bài viết Truy xuất người dùng khi không phải là quản trị viên.
|
Nội dung yêu cầu
Nội dung yêu cầu chứa một bản sao của SubscriptionChannel.
Nội dung phản hồi
Nếu thành công, nội dung phản hồi sẽ chứa một phiên bản của SubscriptionChannel.
Phạm vi uỷ quyền
Yêu cầu một trong các phạm vi OAuth sau:
https://www.googleapis.com/auth/admin.directory.user
https://www.googleapis.com/auth/admin.directory.user.readonly
https://www.googleapis.com/auth/cloud-platform
Để biết thêm thông tin, hãy xem Hướng dẫn uỷ quyền.
EventType
Loại sự kiện Subscription
| Enum |
ADD |
Sự kiện do người dùng tạo |
DELETE |
Sự kiện do người dùng xoá |
MAKE_ADMIN |
Sự kiện thay đổi trạng thái quản trị viên của người dùng |
UNDELETE |
Sự kiện huỷ xoá người dùng |
UPDATE |
Sự kiện người dùng đã cập nhật |
OrderBy
| Enum |
EMAIL |
Email chính của người dùng. |
FAMILY_NAME |
Họ của người dùng. |
GIVEN_NAME |
Tên của người dùng. |
Dự đoán
| Enum |
BASIC |
Không thêm trường tuỳ chỉnh nào cho người dùng. |
CUSTOM |
Bao gồm các trường tuỳ chỉnh từ các giản đồ được đề cập trong customFieldMask. |
FULL |
Bao gồm tất cả các trường liên kết với người dùng này. |
SortOrder
| Enum |
ASCENDING |
Thứ tự tăng dần. |
DESCENDING |
Thứ tự giảm dần. |
ViewType
| Enum |
admin_view |
Kết quả bao gồm cả các trường chỉ dành cho quản trị viên và các trường công khai trong miền. |
domain_public |
Kết quả chỉ bao gồm các trường cho người dùng mà người dùng khác trong miền có thể xem công khai. |
Trừ phi có lưu ý khác, nội dung của trang này được cấp phép theo Giấy phép ghi nhận tác giả 4.0 của Creative Commons và các mẫu mã lập trình được cấp phép theo Giấy phép Apache 2.0. Để biết thông tin chi tiết, vui lòng tham khảo Chính sách trang web của Google Developers. Java là nhãn hiệu đã đăng ký của Oracle và/hoặc các đơn vị liên kết với Oracle.
Cập nhật lần gần đây nhất: 2025-07-25 UTC.
[null,null,["Cập nhật lần gần đây nhất: 2025-07-25 UTC."],[],[],null,["# Method: users.watch\n\nWatches for changes in users list.\n\n### HTTP request\n\n`POST https://admin.googleapis.com/admin/directory/v1/users/watch`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `domain` | `string` Name of the domain. Fill this field to get users from only this domain. To return all users in a multi-domain fill customer field instead.\" |\n| `customer` | `string` Immutable ID of the Google Workspace account. In case of multi-domain, to fetch all users for a customer, fill this field instead of domain. |\n| `event` | `enum (`[EventType](/workspace/admin/directory/reference/rest/v1/users/watch#EventType)`)` Events to watch for. |\n| `customFieldMask` | `string` Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom. |\n| `maxResults` | `integer` Maximum number of results to return. |\n| `orderBy` | `enum (`[OrderBy](/workspace/admin/directory/reference/rest/v1/users/watch#OrderBy)`)` Column to use for sorting results |\n| `pageToken` | `string` Token to specify next page in the list |\n| `projection` | `enum (`[Projection](/workspace/admin/directory/reference/rest/v1/users/watch#Projection)`)` What subset of fields to fetch for this user. |\n| `query` | `string` Query string search. Should be of the form \"\". Complete documentation is at https: //developers.google.com/workspace/admin/directory/v1/guides/search-users |\n| `showDeleted` | `string` If set to true, retrieves the list of deleted users. (Default: false) |\n| `sortOrder` | `enum (`[SortOrder](/workspace/admin/directory/reference/rest/v1/users/watch#SortOrder)`)` Whether to return results in ascending or descending order. |\n| `viewType` | `enum (`[ViewType](/workspace/admin/directory/reference/rest/v1/users/watch#ViewType)`)` Whether to fetch the administrator-only or domain-wide public view of the user. For more information, see [Retrieve a user as a non-administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin). |\n\n### Request body\n\nThe request body contains an instance of [SubscriptionChannel](/workspace/admin/directory/reference/rest/v1/SubscriptionChannel).\n\n### Response body\n\nIf successful, the response body contains an instance of [SubscriptionChannel](/workspace/admin/directory/reference/rest/v1/SubscriptionChannel).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/admin.directory.user`\n- `\n https://www.googleapis.com/auth/admin.directory.user.readonly`\n- `\n https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent).\n\nEventType\n---------\n\nType of the Subscription event\n\n| Enums ||\n|--------------|--------------------------------|\n| `ADD` | User Created Event |\n| `DELETE` | User Deleted Event |\n| `MAKE_ADMIN` | User Admin Status Change Event |\n| `UNDELETE` | User Undeleted Event |\n| `UPDATE` | User Updated Event |\n\nOrderBy\n-------\n\n| Enums ||\n|---------------|----------------------------|\n| `EMAIL` | Primary email of the user. |\n| `FAMILY_NAME` | User's family name. |\n| `GIVEN_NAME` | User's given name. |\n\nProjection\n----------\n\n| Enums ||\n|----------|------------------------------------------------------------------|\n| `BASIC` | Do not include any custom fields for the user. |\n| `CUSTOM` | Include custom fields from schemas mentioned in customFieldMask. |\n| `FULL` | Include all fields associated with this user. |\n\nSortOrder\n---------\n\n| Enums ||\n|--------------|-------------------|\n| `ASCENDING` | Ascending order. |\n| `DESCENDING` | Descending order. |\n\nViewType\n--------\n\n| Enums ||\n|-----------------|--------------------------------------------------------------------------------------------------|\n| `admin_view` | Results include both administrator-only and domain-public fields. |\n| `domain_public` | Results only include fields for the user that are publicly visible to other users in the domain. |"]]
