Method: people.searchContacts

Tetap teratur dengan koleksi Simpan dan kategorikan konten berdasarkan preferensi Anda.

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

PENTING: Sebelum melakukan penelusuran, klien harus mengirimkan 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 diisi. Kueri teks biasa untuk permintaan. Kueri digunakan untuk mencocokkan frasa awalan kolom pada seseorang. Misalnya, seseorang dengan nama "nama foo" cocok dengan kueri seperti "f", "fo", "foo", "foo n", "nam", dll., tetapi tidak "oo n".
pageSize

integer

Opsional. Jumlah hasil yang akan ditampilkan. Jika tidak ditetapkan, ditetapkan ke 10 atau ditetapkan ke 0. Nilai yang lebih besar dari 30 akan dibatasi hingga 30.
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 (ReadSourceType)

Opsional. Masker dari jenis sumber yang akan ditampilkan. Jika tidak ditetapkan, setelan defaultnya adalah READ_SOURCE_TYPE_CONTACT.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Jika berhasil, isi respons memuat instance SearchResponse.

Cakupan Otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Untuk mendapatkan informasi lebih lanjut, lihat Panduan otorisasi.