ระบุรายการโปรไฟล์ของโดเมนและรายชื่อติดต่อของโดเมนในไดเรกทอรีโดเมนของผู้ใช้ที่ผ่านการตรวจสอบสิทธิ์แล้วซึ่งตรงกับคำค้นหา
คำขอ HTTP
GET https://people.googleapis.com/v1/people:searchDirectoryPeople
URL ใช้ไวยากรณ์การแปลง gRPC
พารามิเตอร์การค้นหา
พารามิเตอร์ | |
---|---|
query |
ต้องระบุ คำค้นหาคำนำหน้าที่ตรงกับช่องในบุคคล ไม่ใช้ readMask ในการระบุฟิลด์ที่จะจับคู่ |
readMask |
ต้องระบุ ฟิลด์มาสก์เพื่อจํากัดว่าจะให้ระบบแสดงช่องใดของผู้ใช้แต่ละราย คุณระบุได้หลายช่องโดยคั่นด้วยเครื่องหมายคอมมา ค่าที่ใช้ได้มีดังนี้
|
sources[] |
ต้องระบุ แหล่งที่มาของไดเรกทอรีที่จะแสดงผล |
mergeSources[] |
ไม่บังคับ ข้อมูลเพิ่มเติมที่จะรวมกับแหล่งที่มาของไดเรกทอรี หากเชื่อมต่อกันผ่านคีย์สำหรับการรวมที่ยืนยันแล้ว เช่น อีเมลหรือหมายเลขโทรศัพท์ |
pageSize |
ไม่บังคับ จำนวนคนที่จะรวมในคำตอบ ค่าที่ใช้ได้ต้องอยู่ระหว่าง 1 ถึง 500 ค่าเริ่มต้นคือ 100 หากไม่ได้ตั้งค่าไว้หรือตั้งค่าเป็น 0 |
pageToken |
ไม่บังคับ โทเค็นของหน้าเว็บที่ได้รับจากการตอบกลับก่อนหน้านี้ เมื่อใส่เลขหน้า พารามิเตอร์อื่นๆ ทั้งหมดที่ส่งไปยัง [ |
เนื้อหาของคำขอ
เนื้อหาของคำขอต้องว่างเปล่า
เนื้อหาการตอบกลับ
การตอบกลับคำขอสำหรับบุคคลในไดเรกทอรีโดเมนของผู้ใช้ที่ผ่านการตรวจสอบสิทธิ์ซึ่งตรงกับการค้นหาที่ระบุ
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
การแสดง JSON |
---|
{
"people": [
{
object ( |
ช่อง | |
---|---|
people[] |
รายชื่อบุคคลในไดเรกทอรีของโดเมนที่ตรงกับคำค้นหา |
nextPageToken |
โทเค็นที่ส่งเป็น |
totalSize |
จํานวนรายการทั้งหมดในรายการโดยไม่มีการใส่เลขหน้า |
ขอบเขตการให้สิทธิ์
ต้องใช้ขอบเขต OAuth ต่อไปนี้
https://www.googleapis.com/auth/directory.readonly
โปรดดูข้อมูลเพิ่มเติมที่คู่มือการให้สิทธิ์