Method: users.watch
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Observa mudanças na lista de usuários.
Solicitação HTTP
POST https://admin.googleapis.com/admin/directory/v1/users/watch
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de consulta
| Parâmetros |
domain |
string
Nome do domínio. Preencha este campo para receber usuários somente deste domínio. Para retornar todos os usuários em um campo de preenchimento do cliente com vários domínios."
|
customer |
string
ID imutável da conta do Google Workspace. No caso de vários domínios, para buscar todos os usuários de um cliente, preencha este campo em vez de "domain".
|
event |
enum (EventType)
Eventos a serem observados.
|
customFieldMask |
string
Lista de nomes de esquemas separados por vírgulas. Todos os campos desses esquemas são buscados. Ele só deve ser definido quando projection=custom.
|
maxResults |
integer
Número máximo de resultados a serem retornados.
|
orderBy |
enum (OrderBy)
Coluna a ser usada para classificar os resultados
|
pageToken |
string
Token para especificar a próxima página da lista
|
projection |
enum (Projection)
Qual subconjunto de campos buscar para esse usuário.
|
query |
string
Pesquisa de string de consulta. Precisa estar no formato "". A documentação completa está em https: //developers.google.com/workspace/admin/directory/v1/guides/search-users
|
showDeleted |
string
Se definido como "true", recupera a lista de usuários excluídos. (Padrão: false)
|
sortOrder |
enum (SortOrder)
Se os resultados serão retornados em ordem crescente ou decrescente.
|
viewType |
enum (ViewType)
Indica se a visualização pública do usuário é somente para administradores ou para todo o domínio. Para mais informações, consulte Recuperar um usuário como não administrador.
|
Corpo da solicitação
O corpo da solicitação contém uma instância de SubscriptionChannel.
Corpo da resposta
Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de SubscriptionChannel.
Escopos de autorização
Requer um dos seguintes escopos do 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 mais informações, consulte o guia de autorização.
EventType
Tipo de evento de assinatura
| Enums |
ADD |
Evento criado pelo usuário |
DELETE |
Evento de exclusão de usuário |
MAKE_ADMIN |
Evento de mudança de status de administrador do usuário |
UNDELETE |
Evento de restauração de exclusão do usuário |
UPDATE |
Evento de atualização do usuário |
OrderBy
| Enums |
EMAIL |
E-mail principal do usuário. |
FAMILY_NAME |
Sobrenome do usuário. |
GIVEN_NAME |
Nome do usuário. |
Projeção
| Enums |
BASIC |
Não inclua campos personalizados para o usuário. |
CUSTOM |
Incluir campos personalizados de esquemas mencionados em customFieldMask. |
FULL |
Inclua todos os campos associados a esse usuário. |
SortOrder
| Enums |
ASCENDING |
Ordem crescente. |
DESCENDING |
Ordem decrescente. |
ViewType
| Enums |
admin_view |
Os resultados incluem campos somente para administradores e públicos do domínio. |
domain_public |
Os resultados incluem apenas os campos do usuário que são visíveis publicamente para outros usuários no domínio. |
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-07-25 UTC.
[null,null,["Última atualização 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. |"]]
