Method: people.listDirectoryPeople

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

เมื่อระบุ syncToken ระบบจะแสดงผลทรัพยากรที่ลบตั้งแต่การซิงค์ครั้งล่าสุดเป็นบุคคลที่มีการตั้งค่า PersonMetadata.deleted เป็น "จริง"

เมื่อระบุ pageToken หรือ syncToken พารามิเตอร์คําขออื่นๆ ทั้งหมดต้องตรงกับการเรียกครั้งแรก

การเขียนอาจมีความล่าช้าในการนำไปใช้งานหลายนาทีสำหรับคำขอซิงค์ การซิงค์ที่เพิ่มขึ้นไม่ได้มีไว้สำหรับกรณีการใช้งานแบบอ่านหลังเขียน

ดูตัวอย่างการใช้งานได้ที่แสดงรายการผู้ใช้ไดเรกทอรีที่มีการเปลี่ยนแปลง

คำขอ HTTP

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

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

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

พารามิเตอร์
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 ถึง 1, 000 ค่าเริ่มต้นเป็น 100 หากไม่ได้ตั้งค่าหรือตั้งค่าเป็น 0
pageToken

string

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

เมื่อใส่เลขหน้า พารามิเตอร์อื่นๆ ทั้งหมดที่ระบุให้กับ people.listDirectoryPeople ต้องตรงกับการเรียกใช้ครั้งแรกที่ให้โทเค็นของหน้าเว็บ
requestSyncToken

boolean

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

ดูรายละเอียดเพิ่มเติมเกี่ยวกับลักษณะการซิงค์ได้ที่ people.listDirectoryPeople
syncToken

string

ไม่บังคับ โทเค็นการซิงค์ ได้รับจากการตอบกลับก่อนหน้า nextSyncToken ระบุโทเค็นนี้เพื่อเรียกข้อมูลเฉพาะทรัพยากรที่มีการเปลี่ยนแปลงนับจากคำขอล่าสุด

ขณะซิงค์ พารามิเตอร์อื่นๆ ทั้งหมดที่ระบุให้กับ people.listDirectoryPeople ต้องตรงกับการเรียกใช้ครั้งแรกที่ให้โทเค็นการซิงค์

ดูรายละเอียดเพิ่มเติมเกี่ยวกับลักษณะการซิงค์ได้ที่ people.listDirectoryPeople

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

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

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

การตอบสนองต่อคำขอไดเรกทอรีโดเมนของผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว

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

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

object (Person)

รายชื่อบุคคลในไดเรกทอรีของโดเมน
nextPageToken

string

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

string

โทเค็นที่ส่งในฐานะ syncToken เพื่อเรียกข้อมูลการเปลี่ยนแปลงนับตั้งแต่คำขอล่าสุดได้ คำขอต้องตั้งค่า requestSyncToken เพื่อส่งคืนโทเค็นการซิงค์

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

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

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

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