Method: people.searchDirectoryPeople

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 khớp với cụm từ tìm kiếm.

Yêu cầu HTTP

GET https://people.googleapis.com/v1/people:searchDirectoryPeople

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số truy vấn

Thông số
query

string

Bắt buộc. Truy vấn tạo tiền tố khớp với các trường trong người. KHÔNG sử dụng readMask để xác định những trường cần so khớp.
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
  • locales
  • 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 500. 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.searchDirectoryPeople][google.people.v1.SearchDirectoryPeople] phải khớp với lệnh gọi đầu tiên đã cung cấp mã thông báo trang.

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ề người trong thư mục miền của người dùng đã xác thực khớp với truy vấn được chỉ định.

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,
  "totalSize": integer
}
Trường
people[]

object (Person)

Danh sách những người trong thư mục miền khớp với truy vấ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.
totalSize

integer

Tổng số mục trong danh sách mà không phân trang.

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.