Method: people.listDirectoryPeople

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

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

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

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

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

คำขอ HTTP

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

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

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

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

string (FieldMask format)

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

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

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