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. Kueri awalan yang cocok dengan kolom di orang. TIDAK menggunakan readMask untuk menentukan kolom yang akan dicocokkan.
readMask

string (FieldMask format)

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

  • alamat
  • ageRanges
  • biografi
  • ulang tahun
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • acara
  • externalIds
  • gender
  • imClients
  • minat
  • locales
  • lokasi
  • channel
  • metadata
  • miscKeywords
  • nama
  • nama panggilan
  • pekerjaan
  • organizations
  • phoneNumbers
  • foto
  • hubungan
  • sipAddresses
  • keterampilan
  • Url
  • userDefined
sources[]

enum (DirectorySourceType)

Wajib. Sumber direktori yang akan ditampilkan.
mergeSources[]

enum (DirectoryMergeSourceType)

Opsional. Data tambahan untuk digabungkan ke sumber direktori jika terhubung melalui kunci join terverifikasi 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, setelan defaultnya adalah 100.
pageToken

string

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

Saat memberi nomor halaman, semua parameter lain yang diberikan untuk [people.searchDirectoryPeople][google.people.v1.SearchDirectoryPeople] harus cocok dengan panggilan pertama yang menyediakan token halaman.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Respons terhadap permintaan untuk orang-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 (Person)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
Kolom
people[]

object (Person)

Daftar orang di direktori domain yang cocok dengan kueri.
nextPageToken

string

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

integer

Jumlah total item dalam daftar tanpa penomoran halaman.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

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

Untuk informasi selengkapnya, lihat Panduan otorisasi.