Method: users.watch
Zadbaj o dobrą organizację dzięki kolekcji
Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.
Sprawdza zmiany na liście użytkowników.
Żądanie HTTP
POST https://admin.googleapis.com/admin/directory/v1/users/watch
Adres URL używa składni transkodowania gRPC.
Parametry zapytania
| Parametry |
domain |
string
Nazwa domeny. Wypełnij to pole, aby pobierać dane tylko o użytkownikach z tej domeny. Aby zamiast tego zwrócić wszystkich użytkowników w polu klienta wypełnianym z wielu domen”.
|
customer |
string
Niezmienny identyfikator konta Google Workspace. W przypadku wielu domen, aby pobrać wszystkich użytkowników klienta, wypełnij to pole zamiast pola domeny.
|
event |
enum (EventType)
Zdarzenia, na które należy zwrócić uwagę
|
customFieldMask |
string
Lista nazw schematów rozdzielona przecinkami. Pobierane są wszystkie pola z tych schematów. Wartość ta powinna być ustawiona tylko wtedy, gdy projection=custom.
|
maxResults |
integer
Maksymalna liczba wyników do zwrócenia.
|
orderBy |
enum (OrderBy)
Kolumna używana do sortowania wyników
|
pageToken |
string
Token określający następną stronę na liście
|
projection |
enum (Projection)
Który podzbiór pól ma zostać pobrany dla tego użytkownika.
|
query |
string
wyszukiwanie za pomocą ciągu zapytania; powinna mieć format „”. Pełną dokumentację znajdziesz na stronie https: //developers.google.com/workspace/admin/directory/v1/guides/search-users;
|
showDeleted |
string
Jeśli ma wartość prawda, pobiera listę usuniętych użytkowników. (wartość domyślna to false)
|
sortOrder |
enum (SortOrder)
Określa, czy wyniki mają zostać zwrócone w kolejności rosnącej czy malejącej.
|
viewType |
enum (ViewType)
Określa, czy należy pobrać widok użytkownika tylko dla administratora czy widok publiczny dla całej domeny. Więcej informacji znajdziesz w artykule Pobieranie użytkownika jako użytkownik bez uprawnień administratora.
|
Treść żądania
Treść żądania zawiera wystąpienie elementu SubscriptionChannel.
Treść odpowiedzi
W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu SubscriptionChannel.
Zakresy autoryzacji
Wymaga jednego z tych zakresów 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
Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.
EventType
Typ zdarzenia subskrypcji
| Wartości w polu enum |
ADD |
Zdarzenie utworzone przez użytkownika |
DELETE |
Zdarzenie usunięcia użytkownika |
MAKE_ADMIN |
Zdarzenie zmiany stanu administratora użytkownika |
UNDELETE |
Zdarzenie nieusunięcia użytkownika |
UPDATE |
Zdarzenie aktualizacji użytkownika |
OrderBy
| Wartości w polu enum |
EMAIL |
Podstawowy adres e-mail użytkownika. |
FAMILY_NAME |
Nazwisko użytkownika. |
GIVEN_NAME |
Imię użytkownika. |
Odwzorowanie
| Wartości w polu enum |
BASIC |
Nie uwzględniaj żadnych pól niestandardowych dotyczących użytkownika. |
CUSTOM |
Uwzględnij pola niestandardowe ze schematów wymienionych w customFieldMask. |
FULL |
Uwzględnij wszystkie pola powiązane z tym użytkownikiem. |
SortOrder
| Wartości w polu enum |
ASCENDING |
rosnąco; |
DESCENDING |
w kolejności malejącej. |
ViewType
| Wartości w polu enum |
admin_view |
Wyniki obejmują pola tylko dla administratora i pola publiczne w domenie. |
domain_public |
Wyniki obejmują tylko pola użytkownika, które są publicznie widoczne dla innych użytkowników w domenie. |
O ile nie stwierdzono inaczej, treść tej strony jest objęta licencją Creative Commons – uznanie autorstwa 4.0, a fragmenty kodu są dostępne na licencji Apache 2.0. Szczegółowe informacje na ten temat zawierają zasady dotyczące witryny Google Developers. Java jest zastrzeżonym znakiem towarowym firmy Oracle i jej podmiotów stowarzyszonych.
Ostatnia aktualizacja: 2025-07-25 UTC.
[null,null,["Ostatnia aktualizacja: 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. |"]]
