Method: people.searchContacts

Menyediakan daftar kontak dalam grup kontak pengguna terautentikasi yang cocok dengan kueri penelusuran. Kueri cocok dengan kolom names, nickNames, emailAddresses, phoneNumbers, dan organizations kontak yang berasal dari sumber CONTACT.

PENTING: Sebelum melakukan penelusuran, klien harus mengirim permintaan pemanasan dengan kueri kosong untuk memperbarui cache. Lihat https://developers.google.com/people/v1/contacts#search_the_users_contacts

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter kueri

Parameter
query

string

Wajib. Kueri teks biasa untuk permintaan. Kueri digunakan untuk mencocokkan frasa awalan kolom pada seseorang. Misalnya, seseorang dengan nama "foo name" cocok dengan kueri seperti "f", "fo", "foo", "foo n", "nam", dll., tetapi bukan "oo n".
pageSize

integer

Opsional. Jumlah hasil yang akan ditampilkan. Default-nya adalah 10 jika kolom tidak disetel, atau disetel ke 0. Nilai yang lebih besar dari 30 akan dibatasi hingga 30.
readMask

string (FieldMask format)

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

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

enum (ReadSourceType)

Opsional. Mask untuk jenis sumber yang akan ditampilkan. Jika tidak disetel, setelan defaultnya adalah READ_SOURCE_TYPE_CONTACT.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Jika berhasil, isi respons akan berisi instance SearchResponse.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Untuk informasi selengkapnya, lihat Panduan otorisasi.