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
  • ความสนใจ
  • ภาษา
  • สถานที่ตั้ง
  • ของช่อง
  • ข้อมูลเมตา
  • miscKeywords
  • ชื่อ
  • ชื่อเล่น
  • อาชีพ
  • องค์กร
  • phoneNumbers
  • รูปภาพ
  • ความสัมพันธ์
  • sipAddresses
  • ทักษะ
  • URL
  • 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

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