ระบุรายการโปรไฟล์ของโดเมนและรายชื่อติดต่อของโดเมนในไดเรกทอรีโดเมนของผู้ใช้ที่ตรวจสอบสิทธิ์แล้วซึ่งตรงกับคําค้นหา
คำขอ 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
สําหรับข้อมูลเพิ่มเติม โปรดดูคู่มือการให้สิทธิ์