Method: users.watch
Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
Wartet auf Änderungen in der Nutzerliste.
HTTP-Anfrage
POST https://admin.googleapis.com/admin/directory/v1/users/watch
Die URL verwendet die Syntax der gRPC-Transcodierung.
Abfrageparameter
| Parameter |
domain |
string
Name der Domain. Füllen Sie dieses Feld aus, um nur Nutzer aus dieser Domain zu erhalten. Wenn Sie alle Nutzer in einer mehrdomänenfähigen Umgebung zurückgeben möchten, füllen Sie stattdessen das Kundenfeld aus."
|
customer |
string
Die unveränderliche ID des Google Workspace-Kontos. Wenn Sie mehrere Domains haben, füllen Sie dieses Feld anstelle der Domain aus, um alle Nutzer für einen Kunden abzurufen.
|
event |
enum (EventType)
Wichtige Ereignisse
|
customFieldMask |
string
Durch Kommas getrennte Liste von Schemanamen. Alle Felder aus diesen Schemas werden abgerufen. Dieser sollte nur festgelegt werden, wenn „projection“ auf „custom“ gesetzt ist.
|
maxResults |
integer
Maximale Anzahl der zurückzugebenden Ergebnisse.
|
orderBy |
enum (OrderBy)
Spalte, die zum Sortieren der Ergebnisse verwendet werden soll
|
pageToken |
string
Token, um die nächste Seite in der Liste anzugeben
|
projection |
enum (Projection)
Welche Teilmenge von Feldern für diesen Nutzer abgerufen werden soll.
|
query |
string
Abfragestring-Suche Muss das Format „“ haben. Die vollständige Dokumentation finden Sie unter https: //developers.google.com/workspace/admin/directory/v1/guides/search-users.
|
showDeleted |
string
Wenn diese Option auf „true“ gesetzt ist, wird die Liste der gelöschten Nutzer abgerufen. (Standardeinstellung: false)
|
sortOrder |
enum (SortOrder)
Ob die Ergebnisse in aufsteigender oder absteigender Reihenfolge zurückgegeben werden sollen.
|
viewType |
enum (ViewType)
Gibt an, ob die öffentliche Ansicht des Nutzers nur für Administratoren oder domainweit abgerufen werden soll. Weitere Informationen finden Sie im Hilfeartikel Nutzer als Nichtadministrator abrufen.
|
Anfragetext
Der Anfragetext enthält eine Instanz von SubscriptionChannel.
Antworttext
Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von SubscriptionChannel.
Autorisierungsbereiche
Erfordert einen der folgenden OAuth-Bereiche:
https://www.googleapis.com/auth/admin.directory.user
https://www.googleapis.com/auth/admin.directory.user.readonly
https://www.googleapis.com/auth/cloud-platform
Weitere Informationen finden Sie im Leitfaden zur Autorisierung.
EventType
| Enums |
ADD |
Von Nutzern erstelltes Ereignis |
DELETE |
Vom Nutzer gelöschtes Ereignis |
MAKE_ADMIN |
Ereignis: Änderung des Admin-Status eines Nutzers |
UNDELETE |
Ereignis: Nutzer wiederhergestellt |
UPDATE |
Von Nutzern aktualisiertes Ereignis |
OrderBy
| Enums |
EMAIL |
Primäre E-Mail-Adresse des Nutzers. |
FAMILY_NAME |
Der Nachname des Nutzers. |
GIVEN_NAME |
Der Vorname des Nutzers. |
Projektion
| Enums |
BASIC |
Fügen Sie keine benutzerdefinierten Felder für den Nutzer hinzu. |
CUSTOM |
Fügen Sie benutzerdefinierte Felder aus Schemas hinzu, die in „customFieldMask“ erwähnt werden. |
FULL |
Fügen Sie alle mit diesem Nutzer verknüpften Felder hinzu. |
SortOrder
| Enums |
ASCENDING |
Aufsteigende Reihenfolge. |
DESCENDING |
Absteigende Reihenfolge. |
ViewType
| Enums |
admin_view |
Die Ergebnisse enthalten sowohl Felder, die nur für Administratoren sichtbar sind, als auch Felder, die für alle Domainnutzer sichtbar sind. |
domain_public |
Die Ergebnisse enthalten nur Felder für den Nutzer, die für andere Nutzer in der Domain öffentlich sichtbar sind. |
Sofern nicht anders angegeben, sind die Inhalte dieser Seite unter der Creative Commons Attribution 4.0 License und Codebeispiele unter der Apache 2.0 License lizenziert. Weitere Informationen finden Sie in den Websiterichtlinien von Google Developers. Java ist eine eingetragene Marke von Oracle und/oder seinen Partnern.
Zuletzt aktualisiert: 2025-07-25 (UTC).
[null,null,["Zuletzt aktualisiert: 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. |"]]
