Method: users.watch
Tetap teratur dengan koleksi
Simpan dan kategorikan konten berdasarkan preferensi Anda.
Mengamati perubahan dalam daftar pengguna.
Permintaan HTTP
POST https://admin.googleapis.com/admin/directory/v1/users/watch
URL menggunakan sintaksis gRPC Transcoding.
Parameter kueri
| Parameter |
domain |
string
Nama domain. Isi kolom ini untuk mendapatkan pengguna hanya dari domain ini. Untuk menampilkan semua pengguna di kolom isi pelanggan multi-domain."
|
customer |
string
ID yang tidak dapat diubah dari akun Google Workspace. Jika ada beberapa domain, untuk mengambil semua pengguna bagi pelanggan, isi kolom ini, bukan domain.
|
event |
enum (EventType)
Peristiwa yang akan dipantau.
|
customFieldMask |
string
Daftar nama skema yang dipisahkan koma. Semua kolom dari skema ini diambil. Kolom ini hanya boleh ditetapkan jika projection=custom.
|
maxResults |
integer
Jumlah hasil maksimum yang akan ditampilkan.
|
orderBy |
enum (OrderBy)
Kolom yang akan digunakan untuk mengurutkan hasil
|
pageToken |
string
Token untuk menentukan halaman berikutnya dalam daftar
|
projection |
enum (Projection)
Subkumpulan kolom yang akan diambil untuk pengguna ini.
|
query |
string
Penelusuran string kueri. Harus dalam bentuk "". Dokumentasi lengkapnya ada di https: //developers.google.com/workspace/admin/directory/v1/guides/search-users
|
showDeleted |
string
Jika disetel ke benar, akan mengambil daftar pengguna yang dihapus. (Default: false)
|
sortOrder |
enum (SortOrder)
Apakah akan menampilkan hasil dalam urutan menaik atau menurun.
|
viewType |
enum (ViewType)
Apakah akan mengambil tampilan publik pengguna khusus administrator atau di seluruh domain. Untuk informasi selengkapnya, lihat Mengambil pengguna sebagai non-administrator.
|
Isi permintaan
Isi permintaan memuat instance SubscriptionChannel.
Isi respons
Jika berhasil, isi respons memuat instance SubscriptionChannel.
Cakupan otorisasi
Memerlukan salah satu cakupan OAuth berikut:
https://www.googleapis.com/auth/admin.directory.user
https://www.googleapis.com/auth/admin.directory.user.readonly
https://www.googleapis.com/auth/cloud-platform
Untuk mengetahui informasi selengkapnya, lihat Panduan otorisasi.
EventType
Jenis peristiwa Langganan
| Enum |
ADD |
Peristiwa yang Dibuat Pengguna |
DELETE |
Peristiwa Penghapusan Pengguna |
MAKE_ADMIN |
Peristiwa Perubahan Status Admin Pengguna |
UNDELETE |
Peristiwa Penghapusan Pengguna Dibatalkan |
UPDATE |
Peristiwa Pengguna Diperbarui |
OrderBy
| Enum |
EMAIL |
Email utama pengguna. |
FAMILY_NAME |
Nama belakang pengguna. |
GIVEN_NAME |
Nama depan pengguna. |
Proyeksi
| Enum |
BASIC |
Jangan sertakan kolom kustom apa pun untuk pengguna. |
CUSTOM |
Sertakan kolom kustom dari skema yang disebutkan di customFieldMask. |
FULL |
Sertakan semua kolom yang terkait dengan pengguna ini. |
SortOrder
| Enum |
ASCENDING |
Urutan menaik. |
DESCENDING |
Urutan menurun. |
ViewType
| Enum |
admin_view |
Hasilnya mencakup kolom khusus administrator dan kolom publik domain. |
domain_public |
Hasil hanya menyertakan kolom untuk pengguna yang terlihat secara publik oleh pengguna lain di domain. |
Kecuali dinyatakan lain, konten di halaman ini dilisensikan berdasarkan Lisensi Creative Commons Attribution 4.0, sedangkan contoh kode dilisensikan berdasarkan Lisensi Apache 2.0. Untuk mengetahui informasi selengkapnya, lihat Kebijakan Situs Google Developers. Java adalah merek dagang terdaftar dari Oracle dan/atau afiliasinya.
Terakhir diperbarui pada 2025-07-25 UTC.
[null,null,["Terakhir diperbarui pada 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. |"]]
