Method: people.searchContacts

Cung cấp danh sách địa chỉ liên hệ trong danh bạ được nhóm của người dùng đã xác thực phù hợp với truy vấn tìm kiếm. Truy vấn khớp trên các trường names, nickNames, emailAddresses, phoneNumbers và organizations của một mục liên hệ từ nguồn CONTACT.

QUAN TRỌNG: Trước khi tìm kiếm, ứng dụng cần gửi yêu cầu khởi động kèm theo truy vấn trống để cập nhật bộ nhớ đệm. Xem https://developers.google.com/people/v1/contacts#search_the_users_contacts

Yêu cầu HTTP

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

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số truy vấn

Thông số
query

string

Bắt buộc. Truy vấn dưới dạng văn bản thuần tuý cho yêu cầu. Truy vấn được dùng để so khớp các cụm từ tiền tố của các trường trên một người. Ví dụ: một người có tên "foo name" khớp với các cụm từ tìm kiếm như "f", "fo", "foo", "foo n", "nam", v.v. chứ không phải "oo n".
pageSize

integer

Không bắt buộc. Số lượng kết quả trả về. Giá trị mặc định là 10 nếu bạn không đặt trường hoặc đặt thành 0. Giá trị lớn hơn 30 sẽ giới hạn ở mức 30.
readMask

string (FieldMask format)

Bắt buộc. Mặt nạ cho trường (field mask) để hạn chế những trường được trả về cho mỗi người. Bạn có thể chỉ định nhiều trường bằng cách dùng dấu phẩy phân tách các trường. Các giá trị hợp lệ là:

  • các địa chỉ
  • ageRanges
  • tiểu sử
  • sinh nhật
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • sự kiện
  • externalIds
  • giới tính
  • imClients
  • sở thích
  • locales
  • vị trí
  • của kênh
  • siêu dữ liệu
  • miscKeywords
  • names
  • biệt hiệu
  • nghề nghiệp
  • organizations
  • phoneNumbers
  • ảnh
  • quan hệ
  • sipAddresses
  • kỹ năng
  • urls
  • userDefined
sources[]

enum (ReadSourceType)

Không bắt buộc. Mặt nạ cho biết các loại nguồn cần trả về. Giá trị mặc định là READ_SOURCE_TYPE_CONTACT nếu không được đặt.

Nội dung yêu cầu

Nội dung yêu cầu phải trống.

Nội dung phản hồi

Nếu thành công, nội dung phản hồi sẽ chứa một phiên bản của SearchResponse.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau đây:

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

Để biết thêm thông tin, hãy xem bài viết Hướng dẫn uỷ quyền.