Method: otherContacts.list

Liệt kê tất cả "Người liên hệ khác", tức là những người liên hệ không có trong nhóm người liên hệ. "Người liên hệ khác" thường là những người liên hệ được tạo tự động từ các lần tương tác.

Mã thông báo đồng bộ hoá sẽ hết hạn sau 7 ngày kể từ khi đồng bộ hoá toàn bộ. Yêu cầu có mã thông báo đồng bộ hoá đã hết hạn sẽ gặp lỗi google.rpc.ErrorInfo với lý do là "EXPIRED_SYNC_TOKEN". Trong trường hợp xảy ra lỗi như vậy, ứng dụng nên tạo yêu cầu đồng bộ hoá đầy đủ mà không cần syncToken.

Trang đầu tiên của yêu cầu đồng bộ hoá đầy đủ có một hạn mức bổ sung. Nếu vượt quá hạn mức, hàm sẽ trả về lỗi 429. Hạn mức này là cố định và không thể tăng lên.

Khi bạn chỉ định syncToken, những tài nguyên bị xoá kể từ lần đồng bộ hoá gần đây nhất sẽ được trả về dưới dạng một người có PersonMetadata.deleted được đặt thành true.

Khi pageToken hoặc syncToken được chỉ định, tất cả các tham số yêu cầu khác phải khớp với lệnh gọi đầu tiên.

Hoạt động ghi có thể có độ trễ truyền tải vài phút đối với các yêu cầu đồng bộ hoá. Đồng bộ hoá tăng dần không dành cho các trường hợp sử dụng đọc sau khi ghi.

Xem ví dụ về cách sử dụng tại Liệt kê những người liên hệ khác của người dùng đã thay đổi.

Yêu cầu HTTP

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

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

Tham số truy vấn

Thông số
pageToken

string

Không bắt buộc. Mã thông báo trang, nhận được từ phản hồi trước đó nextPageToken. Cung cấp URL này để truy xuất trang tiếp theo.

Khi phân trang, tất cả các tham số khác được cung cấp cho otherContacts.list phải khớp với lệnh gọi đầu tiên đã cung cấp mã thông báo trang.
pageSize

integer

Không bắt buộc. Số "Người liên hệ khác" cần đưa vào câu trả lời. Các giá trị hợp lệ nằm trong khoảng từ 1 đến 1.000 (tính cả 2 giá trị này). Giá trị mặc định là 100 nếu không được đặt hoặc được đặt là 0.
requestSyncToken

boolean

Không bắt buộc. Liệu phản hồi có trả về nextSyncToken trên trang kết quả cuối cùng hay không. Bạn có thể dùng hàm này để nhận các thay đổi gia tăng kể từ yêu cầu gần đây nhất bằng cách thiết lập theo yêu cầu syncToken.

Thông tin chi tiết khác về hoạt động đồng bộ hóa tại otherContacts.list.
syncToken

string

Không bắt buộc. Mã thông báo đồng bộ hoá, nhận được từ phản hồi trước đó nextSyncToken Cung cấp mã này để chỉ truy xuất các tài nguyên được thay đổi kể từ yêu cầu gần đây nhất.

Khi đồng bộ hoá, mọi tham số khác được cung cấp cho otherContacts.list phải khớp với lệnh gọi đầu tiên đã cung cấp mã đồng bộ hoá.

Thông tin chi tiết khác về hoạt động đồng bộ hóa tại otherContacts.list.
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. Giá trị nào hợp lệ phụ thuộc vào loại ReadSourceType được dùng.

Nếu READ_SOURCE_TYPE_CONTACT được sử dụng, các giá trị hợp lệ là:

  • emailAddresses
  • siêu dữ liệu
  • names
  • phoneNumbers
  • ảnh

Nếu READ_SOURCE_TYPE_PROFILE được sử dụ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.

Trường này có thể có các giá trị sau:

Bạn không được phép chỉ định READ_SOURCE_TYPE_PROFILE mà không chỉ định READ_SOURCE_TYPE_CONTACT.

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

Phản hồi cho yêu cầu về "Danh bạ khác" của người dùng đã xác thực.

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "otherContacts": [
    {
      object (Person)
    }
  ],
  "nextPageToken": string,
  "nextSyncToken": string,
  "totalSize": integer
}
Trường
otherContacts[]

object (Person)

Danh sách "Người liên hệ khác" được trả về dưới dạng Tài nguyên cá nhân. Mục "Người liên hệ khác" chỉ hỗ trợ một số trường. Hãy xem ListOtherContactsRequest.request_mask để biết thêm thông tin chi tiết.
nextPageToken

string

Mã thông báo này có thể được gửi dưới dạng pageToken để truy xuất trang tiếp theo. Nếu trường này bị bỏ qua, thì không có trang tiếp theo nào.
nextSyncToken

string

Mã thông báo có thể được gửi dưới dạng syncToken để truy xuất các thay đổi kể từ yêu cầu gần đây nhất. Yêu cầu phải đặt requestSyncToken để trả về mã thông báo đồng bộ hoá.
totalSize

integer

Tổng số người liên hệ khác trong danh sách không được phân trang.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

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

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