Method: users.watch
Mantieni tutto organizzato con le raccolte
Salva e classifica i contenuti in base alle tue preferenze.
Controlla le modifiche nell'elenco degli utenti.
Richiesta HTTP
POST https://admin.googleapis.com/admin/directory/v1/users/watch
L'URL utilizza la sintassi di transcodifica gRPC.
Parametri di query
| Parametri |
domain |
string
Nome del dominio. Compila questo campo per ottenere gli utenti solo da questo dominio. Per restituire tutti gli utenti in un campo cliente multidominio, compila il campo cliente."
|
customer |
string
ID immutabile dell'account Google Workspace. In caso di più domini, per recuperare tutti gli utenti di un cliente, compila questo campo anziché il dominio.
|
event |
enum (EventType)
Eventi a cui prestare attenzione.
|
customFieldMask |
string
Elenco separato da virgole di nomi di schemi. Vengono recuperati tutti i campi di questi schemi. Questo valore deve essere impostato solo quando projection=custom.
|
maxResults |
integer
Il numero massimo di risultati da restituire.
|
orderBy |
enum (OrderBy)
Colonna da utilizzare per ordinare i risultati
|
pageToken |
string
Token per specificare la pagina successiva nell'elenco
|
projection |
enum (Projection)
Il sottoinsieme di campi da recuperare per questo utente.
|
query |
string
Ricerca nella stringa di query. Deve avere il formato "". La documentazione completa è disponibile all'indirizzo https: //developers.google.com/workspace/admin/directory/v1/guides/search-users
|
showDeleted |
string
Se impostato su true, recupera l'elenco degli utenti eliminati. (valore predefinito: false)
|
sortOrder |
enum (SortOrder)
Indica se i risultati devono essere restituiti in ordine crescente o decrescente.
|
viewType |
enum (ViewType)
Indica se recuperare la visualizzazione pubblica solo per gli amministratori o a livello di dominio dell'utente. Per saperne di più, vedi Recuperare un utente come utente non amministratore.
|
Corpo della richiesta
Il corpo della richiesta contiene un'istanza di SubscriptionChannel.
Corpo della risposta
In caso di esito positivo, il corpo della risposta contiene un'istanza di SubscriptionChannel.
Ambiti di autorizzazione
Richiede uno dei seguenti ambiti 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
Per ulteriori informazioni, consulta la Guida all'autorizzazione.
EventType
Tipo di evento Subscription
| Enum |
ADD |
Evento creato dall'utente |
DELETE |
Evento utente eliminato |
MAKE_ADMIN |
Evento di modifica dello stato amministratore utente |
UNDELETE |
Evento di annullamento dell'eliminazione dell'utente |
UPDATE |
Evento di aggiornamento utente |
OrderBy
| Enum |
EMAIL |
Indirizzo email principale dell'utente. |
FAMILY_NAME |
Il cognome dell'utente. |
GIVEN_NAME |
Nome dell'utente. |
Projection
| Enum |
BASIC |
Non includere campi personalizzati per l'utente. |
CUSTOM |
Includi i campi personalizzati dagli schemi menzionati in customFieldMask. |
FULL |
Includi tutti i campi associati a questo utente. |
SortOrder
| Enum |
ASCENDING |
Ordine crescente. |
DESCENDING |
Ordine decrescente. |
ViewType
| Enum |
admin_view |
I risultati includono sia i campi riservati agli amministratori sia quelli pubblici del dominio. |
domain_public |
I risultati includono solo i campi per l'utente che sono visibili pubblicamente agli altri utenti del dominio. |
Salvo quando diversamente specificato, i contenuti di questa pagina sono concessi in base alla licenza Creative Commons Attribution 4.0, mentre gli esempi di codice sono concessi in base alla licenza Apache 2.0. Per ulteriori dettagli, consulta le norme del sito di Google Developers. Java è un marchio registrato di Oracle e/o delle sue consociate.
Ultimo aggiornamento 2025-07-25 UTC.
[null,null,["Ultimo aggiornamento 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. |"]]
