Menyediakan daftar profil domain dan kontak domain di direktori domain pengguna yang diautentikasi yang cocok dengan kueri penelusuran.
Permintaan HTTP
GET https://people.googleapis.com/v1/people:searchDirectoryPeople
URL menggunakan sintaksis gRPC Transcoding.
Parameter kueri
Parameter | |
---|---|
query |
Wajib. Kueri awalan yang cocok dengan kolom pada orang. TIDAK menggunakan readMask untuk menentukan kolom yang akan dicocokkan. |
readMask |
Wajib. Mask kolom untuk membatasi kolom mana pada setiap orang yang ditampilkan. Beberapa kolom dapat ditentukan dengan memisahkannya menggunakan koma. Nilai yang valid adalah:
|
sources[] |
Wajib. Sumber direktori yang akan ditampilkan. |
mergeSources[] |
Opsional. Data tambahan untuk digabungkan ke dalam sumber direktori jika terhubung melalui kunci gabungan terverifikasi seperti alamat email atau nomor telepon. |
pageSize |
Opsional. Jumlah orang yang akan disertakan dalam respons. Nilai yang valid adalah antara 1 dan 500, inklusif. Jika tidak disetel atau disetel ke 0, defaultnya adalah 100. |
pageToken |
Opsional. Token halaman, diterima dari respons sebelumnya Saat melakukan penomoran halaman, semua parameter lain yang diberikan ke [ |
Isi permintaan
Isi permintaan harus kosong.
Isi respons
Respons terhadap permintaan untuk orang di direktori domain pengguna terautentikasi yang cocok dengan kueri yang ditentukan.
Jika berhasil, isi respons memuat data dengan struktur berikut:
Representasi JSON |
---|
{
"people": [
{
object ( |
Kolom | |
---|---|
people[] |
Daftar orang di direktori domain yang cocok dengan kueri. |
nextPageToken |
Token, yang dapat dikirim sebagai |
totalSize |
Jumlah total item dalam daftar tanpa penomoran halaman. |
Cakupan otorisasi
Memerlukan cakupan OAuth berikut ini:
https://www.googleapis.com/auth/directory.readonly
Untuk informasi selengkapnya, lihat Panduan otorisasi.