People API ช่วยให้คุณทําสิ่งต่อไปนี้ได้
- อ่านและจัดการรายชื่อติดต่อของผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว
- อ่านและคัดลอก "รายชื่อติดต่ออื่นๆ" ของผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว
- อ่านข้อมูลโปรไฟล์ของผู้ใช้ที่ตรวจสอบสิทธิ์แล้วและรายชื่อติดต่อ
- อ่านโปรไฟล์และรายชื่อติดต่อของโดเมน
ตัวอย่างเช่น สมมติว่าผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว Jen มี Fabian และ Ranjith ในรายชื่อติดต่อส่วนตัว เมื่อแอปเรียก
people.connections.list ให้อ่านรายการการเชื่อมต่อ เจนจะแสดงหน้าจอขอความยินยอมที่ขอให้แอปเข้าถึงรายการ หาก Jen ยินยอม แอปจะอ่านรายการที่มี person resources สําหรับ Fabian และ Ranjith
หากแอปต้องใช้ข้อมูลสําหรับบุคคลใดโดยเฉพาะ ก็จะเรียกใช้ people.get โดยใช้ชื่อทรัพยากรเพื่อรับ person resource ของบุคคลนั้นได้
แอปยังจัดการรายชื่อติดต่อโดยการสร้างรายชื่อติดต่อใหม่โดยใช้ people.createContact, อัปเดตรายชื่อติดต่อที่มีอยู่ซึ่งอ่านจาก
people.connections.list โดยใช้ people.updateContact และลบรายชื่อติดต่อโดยใช้ people.deleteContact
ผู้ใช้ Google Workspace ยังแสดงโปรไฟล์โดเมนและข้อมูลติดต่อของโดเมนโดยใช้ people.listDirectoryPeople หรือค้นหาโดยใช้ people.searchDirectoryPeople ได้ด้วย
มุมมองการผสานรวมข้อมูลบุคคล
ข้อมูลผู้คนที่ API อ่านอ่านจะผสานรวมมาจากแหล่งที่มาที่หลากหลาย ขึ้นอยู่กับเงื่อนไขต่อไปนี้
| แหล่งที่มา | เงื่อนไข |
|---|---|
| ข้อมูลโปรไฟล์ Google สาธารณะ | ตลอดเวลา |
| ข้อมูลโปรไฟล์โดเมน Google Workspace | ผู้ดูแลระบบโดเมนได้เปิดใช้การแชร์รายชื่อติดต่อและโปรไฟล์ภายนอกของข้อมูลที่มีขอบเขตระดับโดเมน และได้รับขอบเขต
directory.readonly แล้ว |
| ข้อมูลโปรไฟล์ส่วนตัว ของผู้ใช้ที่ผ่านการตรวจสอบสิทธิ์ | รายการหนึ่งๆ มีขอบเขต profile รายการ |
| รายชื่อติดต่อของผู้ใช้ที่ได้รับการตรวจสอบแล้ว | contacts
ขอบเขต ให้สิทธิ์แล้ว |
ทําความเข้าใจข้อมูลบุคคลที่ผสาน
ข้อมูลของบุคคลหนึ่งมาจากแหล่งที่มาหลัก 1 ประเภท ข้อมูลจากแหล่งที่มาอื่นๆ จะรวมเข้าเข้ากับข้อมูลนี้หากแหล่งที่มาเชื่อมต่อกันผ่านที่อยู่อีเมล หมายเลขโทรศัพท์ หรือ URL ของโปรไฟล์ที่ได้รับการยืนยัน วิธีเขียนเว็บไซต์อาจมีลักษณะดังนี้
| แหล่งที่มาหลัก | รายชื่อติดต่อ | โปรไฟล์ | โปรไฟล์โดเมนของ Google Workspace | รายชื่อติดต่อในโดเมน Google Workspace | การใช้งาน |
|---|---|---|---|---|---|
| รายชื่อติดต่อ | 1 | 0+ | 0+ | 0+ | แสดงผลสําหรับปลายทางส่วนใหญ่ |
| โปรไฟล์ | 0+ | 1 | 0 หรือ 1 | 0 | ส่งคืนใน people.get เมื่อบุคคลนั้นใช้ผู้ใช้ที่ลงชื่อเข้าใช้ หรือสมัครใช้บัญชี Google ของผู้ใช้รายอื่น |
| ข้อมูลติดต่อของโดเมน | 0+ | 0 | 0 | 1 | ส่งคืนอุปกรณ์แล้วใน people.listDirectoryPeople หรือ people.searchDirectoryPeople |
เฉพาะปลายทางที่แก้ไขได้เท่านั้นที่แก้ไขรายชื่อติดต่อตามรายชื่อติดต่อได้ ไม่รองรับการเปลี่ยนรูปแบบโปรไฟล์และโดเมน