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ệ. "Danh bạ khác" thường là những 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 kèm theo lý do "EXPIRED_SYNC_TOKEN". Trong trường hợp xảy ra lỗi này, các ứng dụng nên thực hiện yêu cầu đồng bộ hoá đầy đủ mà không cần có syncToken.

Trang đầu tiên của yêu cầu đồng bộ hoá đầy đủ sẽ có 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 syncToken được chỉ định, các tài nguyên đã xoá kể từ lần đồng bộ hoá gần nhất sẽ được trả về dưới dạng một người với PersonMetadata.deleted được đặt thành true.

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

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

Hãy xem ví dụ về việc sử dụng trong phần Liệt kê những người liên hệ khác của người dùng đã có 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

Tham 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 mã 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ố lượng "Người liên hệ khác" để thêm vào câu trả lời. Các giá trị hợp lệ nằm trong khoảng từ 1 đến 1000. Giá trị mặc định là 100 nếu không được đặt hoặc được đặt thành 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 đối tượng 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 đặt đối tượng này trong yêu cầu syncToken.

Bạn có thể xem thêm thông tin chi tiết về hoạt động đồng bộ hoá 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 đã thay đổi kể từ yêu cầu gần đây nhất.

Khi đồng bộ hoá, 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 đồng bộ hoá.

Bạn có thể xem thêm thông tin chi tiết về hoạt động đồng bộ hoá tại otherContacts.list.
readMask

string (FieldMask format)

Bắt buộc. Mặt nạ trường để hạn chế các trường mà mỗi người dùng được trả về. 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ệ tuỳ thuộc vào loại ReadSourceType được sử dụng.

Nếu bạn sử dụng READ_SOURCE_TYPE_CONTACT, thì các giá trị hợp lệ sẽ là:

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

Nếu bạn sử dụng READ_SOURCE_TYPE_PROFILE, thì các giá trị hợp lệ sẽ là:

  • địa chỉ
  • ageRanges
  • tiểu sử
  • ngày sinh
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • sự kiện
  • externalIds
  • giới tính
  • imClients
  • sở thích
  • ngôn ngữ
  • vị trí
  • của kênh
  • siêu dữ liệu
  • miscKeywords
  • tên
  • biệt hiệu
  • nghề nghiệp
  • tổ chức
  • phoneNumbers
  • ảnh
  • quan hệ
  • sipAddresses
  • kỹ năng
  • url
  • 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 đặt.

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

Bạn không được 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ề "Người liên hệ khác" của người dùng đã được 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. "Danh bạ khác" chỉ hỗ trợ một số ít trường. Xem ListOtherContactsRequest.request_mask để biết thêm thông tin chi tiết.
nextPageToken

string

Mã thông báo 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ì sẽ không có trang tiếp theo.
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 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 Hướng dẫn uỷ quyền.