Method: people.searchDirectoryPeople

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

คำขอ HTTP

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

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

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

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

string

ต้องระบุ คำค้นหาคำนำหน้าที่ตรงกับช่องในบุคคล ไม่ใช้ readMask ในการระบุฟิลด์ที่จะจับคู่
readMask

string (FieldMask format)

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

  • ที่อยู่
  • ageRanges
  • ชีวประวัติ
  • วันเกิด
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • กิจกรรม
  • externalIds
  • เพศ
  • imClients
  • ความสนใจ
  • locales
  • สถานที่ตั้ง
  • ของช่อง
  • ข้อมูลเมตา
  • miscKeywords
  • names
  • ชื่อเล่น
  • อาชีพ
  • organizations
  • phoneNumbers
  • ภาพถ่าย
  • ความสัมพันธ์
  • sipAddresses
  • ทักษะ
  • urls
  • userDefined
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

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