Method: people.searchDirectoryPeople

Cung cấp danh sách các hồ sơ trên 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 truy vấn 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. Thêm tiền tố truy vấn 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ạ 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 500 (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, mọi 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 của 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 dành cho những 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 người dùng trong thư mục miền phù hợp với cụm từ tìm kiếm.
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.
totalSize

integer

Tổng số mục trong danh sách 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 bài viết Hướng dẫn uỷ quyền.