Method: users.watch
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Surveille les modifications apportées à la liste des utilisateurs.
Requête HTTP
POST https://admin.googleapis.com/admin/directory/v1/users/watch
L'URL utilise la syntaxe de transcodage gRPC.
Paramètres de requête
| Paramètres |
domain |
string
Nom du domaine. Complétez ce champ pour n'obtenir que des utilisateurs de ce domaine. Pour renvoyer tous les utilisateurs d'un domaine multidomaine, remplissez plutôt le champ "client"."
|
customer |
string
ID immuable du compte Google Workspace. En cas de multidomaine, pour récupérer tous les utilisateurs d'un client, remplissez ce champ au lieu du domaine.
|
event |
enum (EventType)
Événements à surveiller.
|
customFieldMask |
string
Liste de noms de schémas séparés par une virgule. Tous les champs de ces schémas sont récupérés. Ce paramètre ne doit être défini que lorsque projection=custom.
|
maxResults |
integer
Nombre maximal de résultats sur une page.
|
orderBy |
enum (OrderBy)
Colonne à utiliser pour trier les résultats
|
pageToken |
string
Jeton permettant de spécifier la page suivante de la liste
|
projection |
enum (Projection)
Sous-ensemble de champs à extraire pour cet utilisateur.
|
query |
string
Recherche avec une chaîne de requête. Doit être au format "". La documentation complète est disponible à l'adresse https: //developers.google.com/workspace/admin/directory/v1/guides/search-users.
|
showDeleted |
string
Si la valeur est définie sur "true", la liste des utilisateurs supprimés est récupérée. (valeur par défaut : "false")
|
sortOrder |
enum (SortOrder)
Indique si les résultats doivent être renvoyés par ordre croissant ou décroissant.
|
viewType |
enum (ViewType)
Indique si la vue publique de l'utilisateur doit être récupérée pour les administrateurs uniquement ou pour l'ensemble du domaine. Pour en savoir plus, consultez Récupérer un utilisateur en tant que non-administrateur.
|
Corps de la requête
Le corps de la requête contient une instance de SubscriptionChannel.
Corps de la réponse
Si la requête aboutit, le corps de la réponse contient une instance de SubscriptionChannel.
Champs d'application des autorisations
Nécessite l'un des champs d'application OAuth suivants :
https://www.googleapis.com/auth/admin.directory.user
https://www.googleapis.com/auth/admin.directory.user.readonly
https://www.googleapis.com/auth/cloud-platform
Pour en savoir plus, consultez le guide d'autorisation.
EventType
Type de l'événement "Subscription" (Abonnement)
| Enums |
ADD |
Événement créé par l'utilisateur |
DELETE |
Événement "Utilisateur supprimé" |
MAKE_ADMIN |
Événement de modification de l'état de l'administrateur des utilisateurs |
UNDELETE |
Événement de non-suppression d'un compte utilisateur |
UPDATE |
Événement de mise à jour de l'utilisateur |
OrderBy
| Enums |
EMAIL |
Adresse e-mail principale de l'utilisateur. |
FAMILY_NAME |
Nom de famille de l'utilisateur. |
GIVEN_NAME |
Prénom de l'utilisateur. |
Projection
| Enums |
BASIC |
N'incluez aucun champ personnalisé pour l'utilisateur. |
CUSTOM |
Inclure les champs personnalisés des schémas mentionnés dans customFieldMask. |
FULL |
Incluez tous les champs associés à cet utilisateur. |
SortOrder
| Enums |
ASCENDING |
par ordre croissant. |
DESCENDING |
Ordre décroissant. |
ViewType
| Enums |
admin_view |
Les résultats incluent à la fois les champs réservés aux administrateurs et les champs publics du domaine. |
domain_public |
Les résultats n'incluent que les champs de l'utilisateur qui sont visibles publiquement par les autres utilisateurs du domaine. |
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/25 (UTC).
[null,null,["Dernière mise à jour le 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. |"]]
