- Yêu cầu HTTP
- Tham số đường dẫn
- Tham số truy vấn
- Nội dung yêu cầu
- Nội dung phản hồi
- Phạm vi uỷ quyền
- SortOrder
- Hãy làm thử!
Cung cấp danh sách danh bạ của người dùng đã xác thự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
, 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ó syncToken
được đặt thành true.PersonMetadata.deleted
Khi
hoặc pageToken
đượ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.syncToken
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ệ đã thay đổi.
Yêu cầu HTTP
GET https://people.googleapis.com/v1/{resourceName=people/*}/connections
URL sử dụng cú pháp Chuyển mã gRPC.
Tham số đường dẫn
Thông số | |
---|---|
resourceName |
Bắt buộc. Tên tài nguyên để trả về kết nối. Chỉ |
Tham số truy vấn
Thông số | |
---|---|
pageToken |
Không bắt buộc. Mã thông báo trang, nhận được từ phản hồi trước đó Khi phân trang, tất cả các tham số khác được cung cấp cho |
pageSize |
Không bắt buộc. Số lượng kết nối cần đưa vào phản hồ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. |
sortOrder |
Không bắt buộc. Thứ tự sắp xếp các mối kết nối. Giá trị mặc định là |
requestSyncToken |
Không bắt buộc. Liệu phản hồi có trả về Thông tin chi tiết khác về hoạt động đồng bộ hóa tại |
syncToken |
Không bắt buộc. Mã thông báo đồng bộ hoá, nhận được từ phản hồi trước đó Khi đồng bộ hoá, mọi tham số khác được cung cấp cho Thông tin chi tiết khác về hoạt động đồng bộ hóa tại |
requestMask |
Không bắt buộc. KHÔNG DÙNG NỮA (Vui lòng sử dụng Một mặt nạ để giới hạn kết quả trong một nhóm nhỏ các trường chứa người dùng. |
personFields |
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à:
|
sources[] |
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à |
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 kết nối 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 |
---|
{
"connections": [
{
object ( |
Trường | |
---|---|
connections[] |
Danh sách những người có kết nối với người yêu cầu. |
nextPageToken |
Mã thông báo này có thể được gửi dưới dạng |
nextSyncToken |
Mã thông báo có thể được gửi dưới dạng |
totalPeople |
KHÔNG DÙNG NỮA (Vui lòng sử dụng tổng số Mục) Tổng số người trong danh sách mà không phân trang. |
totalItems |
Tổng số mục trong danh sách không phân trang. |
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.
SortOrder
Thứ tự sắp xếp danh sách kết nối. Tính năng này chỉ được dùng nếu không có yêu cầu đồng bộ hoá.
Enum | |
---|---|
LAST_MODIFIED_ASCENDING |
Sắp xếp mọi người theo thời điểm họ được thay đổi; các mục nhập cũ hơn trước. |
LAST_MODIFIED_DESCENDING |
Sắp xếp mọi người theo thời điểm họ được thay đổi; những mục mới hơn xếp trước. |
FIRST_NAME_ASCENDING |
Sắp xếp mọi người theo tên. |
LAST_NAME_ASCENDING |
Sắp xếp mọi người theo họ. |