Method: people.listDirectoryPeople

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 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 bạn chỉ định pageToken hoặc syncToken, 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.

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

string (FieldMask format)

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à:

  • địa chỉ
  • độ tuổi
  • 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 (DirectorySourceType)

Bắt buộc. Nguồn thư mục cần trả về.

mergeSources[]

enum (DirectoryMergeSourceType)

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

integer

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

string

Không bắt buộc. Mã thông báo trang, nhận được từ một phản hồi nextPageToken trước đó. Cung cấp giá trị 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 giá trị 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 giá trị này trên yêu cầu syncToken.

Thông tin chi tiết khác về hành vi đồng bộ hoá tại people.listDirectoryPeople.

syncToken

string

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

Thông tin chi tiết khác về hành vi đồng bộ hoá 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 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 (Person)
    }
  ],
  "nextPageToken": string,
  "nextSyncToken": string
}
Trường
people[]

object (Person)

Danh sách những người trong thư mục miền.

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 bạn bỏ qua trường này, 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á.

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.