Cung cấp danh sách các hồ sơ trên miền và danh bạ miền trong thư mục miền của người dùng đã xác thực.
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ê thư mục người đã thay đổi.
Yêu cầu HTTP
GET https://people.googleapis.com/v1/people:listDirectoryPeople
URL sử dụng cú pháp Chuyển mã gRPC.
Tham số truy vấn
Thông số | |
---|---|
readMask |
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[] |
Bắt buộc. Các nguồn thư mục sẽ trả về. |
mergeSources[] |
Không bắt buộc. Dữ liệu bổ sung để hợp nhất vào các nguồn thư mục nếu chúng được kết nối thông qua khoá kết hợp đã xác minh, chẳng hạn như địa chỉ email hoặc số điện thoại. |
pageSize |
Không bắt buộc. Số người 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. |
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 |
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 |
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 một yêu cầu tới thư mục miền 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 |
---|
{
"people": [
{
object ( |
Trường | |
---|---|
people[] |
Danh sách người dùng trong thư mục miền. |
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 |
Phạm vi uỷ quyền
Yêu cầu phạm vi OAuth sau:
https://www.googleapis.com/auth/directory.readonly
Để biết thêm thông tin, hãy xem bài viết Hướng dẫn uỷ quyền.