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