Method: users.watch

Memantau 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 dari domain ini saja. Untuk menampilkan semua pengguna di kolom pelanggan, isi kolom multi-domain."

customer

string

ID yang tidak dapat diubah dari akun Google Workspace. Dalam kasus multi-domain, isi kolom ini, bukan domain, untuk mengambil semua pengguna pelanggan.

event

enum (EventType)

Peristiwa untuk diamati.

customFieldMask

string

Daftar nama skema yang dipisahkan koma. Semua kolom dari skema ini akan diambil. Penetapan ini hanya boleh ditetapkan saat project=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

Kueri string penelusuran. Harus dalam format "". Dokumentasi lengkap ada di https: //developers.google.com/admin-sdk/directory/v1/guides/search-users

showDeleted

string

Jika ditetapkan ke benar (true), 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 secara 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.

Jenis Peristiwa

Jenis peristiwa Langganan

Enumerasi
ADD Acara Buatan Pengguna
DELETE Peristiwa yang Dihapus Pengguna
MAKE_ADMIN Peristiwa Perubahan Status Admin Pengguna
UNDELETE Peristiwa Pembatalan Penghapusan Pengguna
UPDATE Peristiwa yang Diperbarui Pengguna

PesanOleh

Enumerasi
EMAIL Email utama pengguna.
FAMILY_NAME Nama keluarga pengguna.
GIVEN_NAME Nama depan pengguna.

Projection

Enumerasi
BASIC Jangan sertakan kolom kustom untuk pengguna.
CUSTOM Sertakan kolom kustom dari skema yang disebutkan di customFieldMask.
FULL Sertakan semua kolom yang terkait dengan pengguna ini.

SortOrder

Enumerasi
ASCENDING Urutan naik.
DESCENDING Urutan menurun.

ViewType

Enumerasi
admin_view Hasilnya mencakup kolom khusus administrator dan domain-publik.
domain_public Hasil hanya menyertakan kolom untuk pengguna yang dapat dilihat oleh pengguna lainnya di domain.