Method: people.searchDirectoryPeople

Memberikan daftar profil domain dan kontak domain di direktori domain pengguna terautentikasi yang cocok dengan kueri penelusuran.

Permintaan HTTP

GET https://people.googleapis.com/v1/people:searchDirectoryPeople

URL menggunakan sintaksis gRPC Transcoding.

Parameter kueri

Parameter
query

string

Wajib diisi. Kueri awalan yang cocok dengan kolom pada orang tersebut. TIDAK menggunakan readMask untuk menentukan kolom yang akan dicocokkan.

readMask

string (FieldMask format)

Wajib diisi. Mask kolom untuk membatasi kolom mana pada setiap orang yang ditampilkan. Beberapa kolom dapat ditentukan dengan memisahkannya dengan koma. Nilai yang valid adalah:

  • addresses
  • ageRanges
  • biografi
  • ulang tahun
  • calendarUrls
  • dataklien
  • coverFoto
  • alamatEmail
  • acara
  • ID eksternal
  • gender
  • imClients
  • minat
  • lokalitas
  • lokasi
  • channel
  • metadata
  • Kata Kunci Lain-Lain
  • nama
  • nama panggilan
  • pekerjaan
  • organisasi
  • nomor telepon
  • foto
  • hubungan
  • sipAddress
  • keterampilan
  • Url
  • Buatan pengguna
sources[]

enum (DirectorySourceType)

Wajib diisi. Sumber direktori yang akan ditampilkan.

mergeSources[]

enum (DirectoryMergeSourceType)

Opsional. Data tambahan untuk digabungkan ke sumber direktori jika terhubung melalui kunci join yang diverifikasi seperti alamat email atau nomor telepon.

pageSize

integer

Opsional. Jumlah orang yang akan disertakan dalam respons. Nilai yang valid adalah antara 1 dan 500, inklusif. Jika tidak ditetapkan atau ditetapkan ke 0, nilai defaultnya adalah 100.

pageToken

string

Opsional. Token halaman, diterima dari respons nextPageToken sebelumnya. Berikan ini untuk mengambil halaman berikutnya.

Saat melakukan penomoran halaman, semua parameter lain yang diberikan ke [people.searchDirectoryPeople][google.people.v1.SearchDirectoryPeople] harus cocok dengan panggilan pertama yang memberikan token halaman.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Jika berhasil, isi respons memuat data dengan struktur berikut:

Respons terhadap permintaan untuk orang di direktori domain pengguna yang diautentikasi yang cocok dengan kueri yang ditentukan.

Representasi JSON
{
  "people": [
    {
      object (Person)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
Kolom
people[]

object (Person)

Daftar orang dalam direktori domain yang cocok dengan kueri.

nextPageToken

string

Token yang dapat dikirim sebagai pageToken untuk mengambil halaman berikutnya. Jika kolom ini dihilangkan, tidak ada halaman berikutnya.

totalSize

integer

Jumlah total item dalam daftar tanpa penomoran halaman.

Cakupan Otorisasi

Memerlukan cakupan OAuth berikut ini:

  • https://www.googleapis.com/auth/directory.readonly

Untuk mendapatkan informasi lebih lanjut, lihat Panduan otorisasi.