Method: users.watch
Koleksiyonlar ile düzeninizi koruyun
İçeriği tercihlerinize göre kaydedin ve kategorilere ayırın.
Kullanıcı listesinde değişiklikleri izler.
HTTP isteği
POST https://admin.googleapis.com/admin/directory/v1/users/watch
URL, gRPC Kod Dönüştürme söz dizimini kullanır.
Sorgu parametreleri
Parametreler |
domain |
string
Alanın adı. Yalnızca bu alandan kullanıcı almak için bu alanı doldurun. Çok alan adında tüm kullanıcıları döndürmek için müşteri alanını doldurun."
|
customer |
string
Google Workspace hesabının değişmeyen kimliği. Birden fazla alan varsa bir müşterinin tüm kullanıcılarını almak için alan yerine bu alanı doldurun.
|
event |
enum (EventType )
İzlemeniz gereken etkinlikler.
|
customFieldMask |
string
Şema adlarının virgülle ayrılmış listesi. Bu şemalardaki tüm alanlar getirilir. Bu ayar yalnızca projection=custom olduğunda yapılmalıdır.
|
maxResults |
integer
Döndürülecek maksimum sonuç sayısı.
|
orderBy |
enum (OrderBy )
Sonuçları sıralamak için kullanılacak sütun
|
pageToken |
string
Listede sonraki sayfayı belirtmek için jeton
|
projection |
enum (Projection )
Bu kullanıcı için hangi alan alt kümesinin getirileceği.
|
query |
string
Sorgu dizesi araması. "" biçiminde olmalıdır. Tam dokümanlar https: //developers.google.com/workspace/admin/directory/v1/guides/search-users adresindedir.
|
showDeleted |
string
Doğru değerine ayarlanırsa silinen kullanıcıların listesini alır. (Varsayılan: false)
|
sortOrder |
enum (SortOrder )
Sonuçların artan düzende mi yoksa azalan düzende mi döndürüleceğini belirtir.
|
viewType |
enum (ViewType )
Kullanıcının yalnızca yöneticilere açık olan görünümünü mi yoksa alan genelinde herkese açık görünümünü mü getireceğini belirtir. Daha fazla bilgi için Yönetici olmayan bir kullanıcıyı alma başlıklı makaleyi inceleyin.
|
İstek içeriği
İstek metni, SubscriptionChannel
öğesinin bir örneğini içerir.
Yanıt gövdesi
Başarılıysa yanıt metni, SubscriptionChannel
öğesinin bir örneğini içerir.
Yetkilendirme kapsamları
Aşağıdaki OAuth kapsamlarından birini gerektirir:
https://www.googleapis.com/auth/admin.directory.user
https://www.googleapis.com/auth/admin.directory.user.readonly
https://www.googleapis.com/auth/cloud-platform
Daha fazla bilgi için Yetkilendirme kılavuzuna bakın.
EventType
Abonelik etkinliğinin türü
Sıralamalar |
ADD |
Kullanıcı Tarafından Oluşturulan Etkinlik |
DELETE |
Kullanıcı Silme Etkinliği |
MAKE_ADMIN |
Kullanıcı Yönetici Durumu Değişiklik Etkinliği |
UNDELETE |
Kullanıcının Silme İşlemini Geri Alma Etkinliği |
UPDATE |
Kullanıcı Güncellenen Etkinlik |
Şuna göre sırala
Sıralamalar |
EMAIL |
Kullanıcının birincil e-postası. |
FAMILY_NAME |
Kullanıcının soyadı. |
GIVEN_NAME |
Kullanıcıya verilen ad. |
Projeksiyon
Sıralamalar |
BASIC |
Kullanıcı için özel alan eklemeyin. |
CUSTOM |
customFieldMask parametresinde belirtilen şemalardaki özel alanları ekleyin. |
FULL |
Bu kullanıcıyla ilişkili tüm alanları ekleyin. |
SortOrder
Sıralamalar |
ASCENDING |
Artan düzen. |
DESCENDING |
Azalan düzen. |
ViewType
Sıralamalar |
admin_view |
Sonuçlar hem yalnızca yöneticiye ait hem de alanda herkese açık alanları içerir. |
domain_public |
Sonuçlar yalnızca kullanıcının alandaki diğer kullanıcılar tarafından herkese açık olarak görülebilen alanlarını içerir. |
Aksi belirtilmediği sürece bu sayfanın içeriği Creative Commons Atıf 4.0 Lisansı altında ve kod örnekleri Apache 2.0 Lisansı altında lisanslanmıştır. Ayrıntılı bilgi için Google Developers Site Politikaları'na göz atın. Java, Oracle ve/veya satış ortaklarının tescilli ticari markasıdır.
Son güncelleme tarihi: 2025-07-25 UTC.
[null,null,["Son güncelleme tarihi: 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. |"]]