Cung cấp danh sách hồ sơ miền và địa chỉ liên hệ trên miền trong thư mục miền của người dùng đã xác thực.
Khi
đượ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 syncToken
được đặt thành true.PersonMetadata.deleted
Khi bạn chỉ định
hoặc pageToken
, 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
Các yêu cầu đồng bộ hoá có thể bị trễ truyền tải vài phút đối với các yêu cầu ghi. Tính năng đồ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.
Hãy xem ví dụ về cách sử dụng tại phần Liệt kê những người trong thư mục đã 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ạ trường để hạn chế những trường nào trên mỗi người được trả về. Bạn có thể chỉ định nhiều trường bằng cách phân tách các trường đó bằng dấu phẩy. Các giá trị hợp lệ là:
|
sources[] |
Bắt buộc. Nguồn thư mục cần trả về. |
mergeSources[] |
Không bắt buộc. Dữ liệu bổ sung cần 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 các 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. Giá trị hợp lệ nằm trong khoảng từ 1 đến 1000. Mặc định là 100 nếu không được đặt hoặc được đặt thành 0. |
pageToken |
Không bắt buộc. Mã thông báo trang, nhận được từ một phản hồi 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ề hành vi đồng bộ hoá tại |
syncToken |
Không bắt buộc. Mã thông báo đồng bộ hoá, nhận được từ một phản hồi trước đó Khi đồng bộ hoá, tất cả các tham số khác được cung cấp cho Thông tin chi tiết khác về hành vi đồng bộ hoá 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 yêu cầu về 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 những người trong thư mục miền. |
nextPageToken |
Mã thông báo 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 Hướng dẫn uỷ quyền.