Method: users.watch
Оптимизируйте свои подборки
Сохраняйте и классифицируйте контент в соответствии со своими настройками.
Отслеживает изменения в списке пользователей.
HTTP-запрос
POST https://admin.googleapis.com/admin/directory/v1/users/watch
URL-адрес использует синтаксис транскодирования gRPC .
Параметры запроса
| Параметры |
|---|
domain | string Имя домена. Заполните это поле, чтобы получить пользователей только из этого домена. Чтобы вернуть всех пользователей в многодоменном поле, заполните поле клиента». |
customer | string Неизменяемый идентификатор аккаунта Google Workspace. В случае нескольких доменов, чтобы получить всех пользователей для клиента, заполните это поле вместо домена. |
event | enum ( EventType ) События, за которыми стоит следить. |
customFieldMask | string Список имен схем, разделенных запятыми. Все поля из этих схем извлекаются. Это значение следует устанавливать только в том случае, если проекция = 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, извлекается список удаленных пользователей. (По умолчанию: ложь) |
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
Дополнительную информацию см. в руководстве по авторизации .
тип события
| Перечисления |
|---|
ADD | Созданное пользователем событие |
DELETE | Событие, удаленное пользователем |
MAKE_ADMIN | Событие изменения статуса администратора пользователя |
UNDELETE | Событие восстановления пользователя |
UPDATE | Событие, обновленное пользователем |
Заказ по
| Перечисления |
|---|
EMAIL | Основной адрес электронной почты пользователя. |
FAMILY_NAME | Фамилия пользователя. |
GIVEN_NAME | Имя пользователя. |
Проекция
| Перечисления |
|---|
BASIC | Не включайте никаких настраиваемых полей для пользователя. |
CUSTOM | Включите настраиваемые поля из схем, упомянутых в customFieldMask. |
FULL | Включите все поля, связанные с этим пользователем. |
Сортировать
| Перечисления |
|---|
ASCENDING | Восходящий порядок. |
DESCENDING | Нисходящий порядок. |
Тип просмотра
| Перечисления |
|---|
admin_view | Результаты включают как поля, доступные только администратору, так и поля, общедоступные для домена. |
domain_public | Результаты включают только поля для пользователя, которые публично видны другим пользователям в домене. |
Если не указано иное, контент на этой странице предоставляется по лицензии Creative Commons "С указанием авторства 4.0", а примеры кода – по лицензии Apache 2.0. Подробнее об этом написано в правилах сайта. Java – это зарегистрированный товарный знак корпорации Oracle и ее аффилированных лиц.
Последнее обновление: 2025-07-25 UTC.
[null,null,["Последнее обновление: 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. |"]]
