Method: people.listDirectoryPeople

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 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ê 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

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. 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 (DirectorySourceType)

Bắt buộc. Các nguồn thư mục sẽ trả về.
mergeSources[]

enum (DirectoryMergeSourceType)

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

integer

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

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 people.listDirectoryPeople phải khớp với lệnh gọi đầu tiên đã cung cấp mã thông báo trang.
requestSyncToken

boolean

Không bắt buộc. Liệu phản hồi có trả về nextSyncToken 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 people.listDirectoryPeople.
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 people.listDirectoryPeople 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 people.listDirectoryPeople.

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 (Person)
    }
  ],
  "nextPageToken": string,
  "nextSyncToken": string
}
Trường
people[]

object (Person)

Danh sách người dùng trong thư mục miền.
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á.

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.