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 |
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 |
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à:
|
sources[] |
Bắt buộc. Các nguồn thư mục sẽ trả về. |
mergeSources[] |
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 |
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 |
Không bắt buộc. Mã thông báo trang, nhận được từ phản hồi trước đó Khi phân trang, mọi tham số khác được cung cấp cho [ |
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 ( |
Trường | |
---|---|
people[] |
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 |
Mã thông báo này có thể được gửi dưới dạng |
totalSize |
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.