Method: people.searchDirectoryPeople

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

คำขอ HTTP

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

URL ใช้ไวยากรณ์การแปลง gRPC

พารามิเตอร์การค้นหา

พารามิเตอร์
query

string

ต้องระบุ คํานําหน้าคําค้นหาที่ตรงกับช่องของบุคคลนั้น ไม่ใช้ ReadMask เพื่อกําหนดช่องที่ต้องการจับคู่
readMask

string (FieldMask format)

ต้องระบุ มาสก์ช่องเพื่อจํากัดช่องที่จะแสดงต่อคนแต่ละคน คุณระบุช่องหลายช่องได้โดยคั่นด้วยคอมมา ค่าที่ใช้ได้มีดังนี้

  • ที่อยู่
  • ช่วงอายุ
  • ชีวประวัติ
  • วันเกิด
  • URL ของปฏิทิน
  • ClientData
  • รูปภาพปก
  • อีเมล
  • กิจกรรม
  • รหัสภายนอก
  • เพศ
  • imClients
  • ความสนใจ
  • ภาษา
  • สถานที่ตั้ง
  • ของช่อง
  • ข้อมูลเมตา
  • คีย์เวิร์ดเบ็ดเตล็ด
  • ชื่อ
  • ชื่อเล่น
  • อาชีพ
  • องค์กร
  • หมายเลขโทรศัพท์
  • รูปภาพ
  • ความสัมพันธ์
  • ที่อยู่ SIP
  • ทักษะ
  • URL
  • ผู้ใช้กําหนด
sources[]

enum (DirectorySourceType)

ต้องระบุ แหล่งที่มาของไดเรกทอรีที่จะแสดง
mergeSources[]

enum (DirectoryMergeSourceType)

ไม่บังคับ ข้อมูลเพิ่มเติมที่จะรวมเข้ากับแหล่งที่มาของไดเรกทอรี หากคีย์ดังกล่าวเชื่อมต่อกันผ่านคีย์ผนวกที่ได้รับการยืนยัน เช่น อีเมลหรือหมายเลขโทรศัพท์
pageSize

integer

ไม่บังคับ จํานวนคนที่จะรวมในคําตอบ ค่าที่ใช้ได้จะอยู่ระหว่าง 1 ถึง 500 ค่าเริ่มต้นจะเป็น 100 หากไม่ได้ตั้งค่าไว้หรือตั้งค่าเป็น 0
pageToken

string

ไม่บังคับ โทเค็นหน้า ได้รับจากการตอบกลับก่อนหน้า nextPageToken ระบุหน้านี้เพื่อเรียกข้อมูลหน้าต่อไป

เมื่อใส่เลขหน้า พารามิเตอร์อื่นๆ ทั้งหมดที่ส่งไปยัง [people.searchDirectoryPeople][google.people.v1.SearchDirectoryPeople] จะต้องตรงกับการเรียกใช้แรกที่ระบุโทเค็นของหน้าเว็บ

เนื้อหาของคำขอ

เนื้อหาของคำขอต้องว่างเปล่า

เนื้อหาการตอบกลับ

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การตอบกลับคําขอสําหรับผู้คนในไดเรกทอรีของโดเมนของผู้ใช้ที่ตรวจสอบสิทธิ์แล้วซึ่งตรงกับการค้นหาที่ระบุ

การแสดง JSON 
{
  "people": [
    {
      object (Person)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
ช่อง
people[]

object (Person)

รายชื่อผู้คนในไดเรกทอรีของโดเมนที่ตรงกับคําค้นหา
nextPageToken

string

โทเค็น ซึ่งสามารถส่งเป็น pageToken เพื่อดึงหน้าถัดไปได้ หากเว้นช่องนี้ไว้ จะไม่มีหน้าต่อๆ ไป
totalSize

integer

จํานวนรายการทั้งหมดในรายการโดยไม่ต้องใส่เลขหน้า

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/directory.readonly

สําหรับข้อมูลเพิ่มเติม โปรดดูคู่มือการให้สิทธิ์