Method: users.watch
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Detecta cambios en la lista de usuarios.
Solicitud HTTP
POST https://admin.googleapis.com/admin/directory/v1/users/watch
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de consulta
| Parámetros |
domain |
string
Es el nombre del dominio. Completa este campo para obtener usuarios solo de este dominio. Para mostrar todos los usuarios en un campo de cliente de varios dominios, completa el campo "customer".
|
customer |
string
Es el ID inmutable de la cuenta de Google Workspace. En el caso de varios dominios, para recuperar todos los usuarios de un cliente, completa este campo en lugar del dominio.
|
event |
enum (EventType)
Eventos a tener en cuenta
|
customFieldMask |
string
Lista de nombres de esquemas separados por comas. Se recuperan todos los campos de estos esquemas. Solo se debe establecer cuando projection=custom.
|
maxResults |
integer
Cantidad máxima de resultados que se mostrarán.
|
orderBy |
enum (OrderBy)
Es la columna que se usará para ordenar los resultados.
|
pageToken |
string
Token para especificar la página siguiente en la lista
|
projection |
enum (Projection)
Es el subconjunto de campos que se recuperarán para este usuario.
|
query |
string
Búsqueda de cadenas de consulta Debe tener el formato "". La documentación completa se encuentra en https: //developers.google.com/workspace/admin/directory/v1/guides/search-users
|
showDeleted |
string
Si se establece como verdadero, recupera la lista de usuarios borrados. (valor predeterminado: false)
|
sortOrder |
enum (SortOrder)
Si se devuelven resultados en orden ascendente o descendente.
|
viewType |
enum (ViewType)
Indica si se debe recuperar la vista pública del usuario solo para administradores o para todo el dominio. Para obtener más información, consulta Cómo recuperar un usuario como no administrador.
|
Cuerpo de la solicitud
El cuerpo de la solicitud contiene una instancia de SubscriptionChannel.
Cuerpo de la respuesta
Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de SubscriptionChannel.
Alcances de autorización
Se necesita uno de los siguientes permisos de 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
Para obtener más información, consulta la Guía de autorización.
EventType
Tipo de evento de Subscription
| Enumeraciones |
ADD |
Evento creado por el usuario |
DELETE |
Evento de eliminación de usuario |
MAKE_ADMIN |
Evento de cambio de estado de administrador de usuarios |
UNDELETE |
Evento de recuperación de usuario |
UPDATE |
Evento de actualización del usuario |
OrderBy
| Enumeraciones |
EMAIL |
Es el correo electrónico principal del usuario. |
FAMILY_NAME |
Es el apellido del usuario. |
GIVEN_NAME |
Es el nombre del usuario. |
Proyección
| Enumeraciones |
BASIC |
No incluyas ningún campo personalizado para el usuario. |
CUSTOM |
Incluye campos personalizados de los esquemas mencionados en customFieldMask. |
FULL |
Incluye todos los campos asociados con este usuario. |
SortOrder
| Enumeraciones |
ASCENDING |
Orden ascendente. |
DESCENDING |
Orden descendente. |
ViewType
| Enumeraciones |
admin_view |
Los resultados incluyen campos de solo administrador y de dominio público. |
domain_public |
Los resultados solo incluyen campos del usuario que son visibles públicamente para otros usuarios del dominio. |
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2025-07-25 (UTC)
[null,null,["Última actualización: 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. |"]]
