คำแนะนำในการย้ายข้อมูล API รายชื่อติดต่อ

Contacts API ยุติการให้บริการแล้วเมื่อวันที่ 19 มกราคม 2022 ใช้คู่มือนี้เพื่อดูข้อมูลเกี่ยวกับการเปลี่ยนแปลงของช่อง ปลายทาง และขอบเขตการให้สิทธิ์เมื่อย้ายข้อมูลไปยัง People API

ภาพรวม

People API มีฟังก์ชันการทำงานเหมือนกับ Contacts API เดิมสำหรับฟีเจอร์ทั้งหมด โดยมีข้อยกเว้นดังต่อไปนี้สำหรับ Contacts อื่นๆ

  • ผู้ดูแลระบบมีสิทธิ์ระดับอ่านอย่างเดียวสำหรับ "รายชื่อติดต่ออื่นๆ" ผ่านขอบเขตใหม่ เนื่องจากระบบไม่รองรับการส่งสัญญาณเปลี่ยนแปลง/เขียนกลับไปยัง "รายชื่อติดต่ออื่นๆ" ผู้ใช้ของคุณจึงต้องเพิ่มรายชื่อติดต่ออื่นๆ เป็นรายชื่อติดต่อของฉันหากต้องการอัปเดตช่องข้อมูลของรายชื่อติดต่อดังกล่าว

  • คุณอ่านเฉพาะข้อมูลติดต่อพื้นฐานสำหรับ "รายชื่อติดต่ออื่นๆ" ผ่าน API ได้ ตัวอย่างเช่น ชื่อเต็ม อีเมล และหมายเลขโทรศัพท์

นอกจากนี้ ขอบเขต Contacts แบบเก่า (https://www.google.com/m8/feeds) ซึ่งให้การเข้าถึงทั้งรายชื่อติดต่อส่วนบุคคลและข้อมูลไดเรกทอรีจะมีการแทนที่ด้วยขอบเขตต่อไปนี้

  • วิธีเข้าถึงรายชื่อติดต่อส่วนบุคคล https://www.googleapis.com/auth/contacts
  • วิธีเข้าถึงข้อมูลไดเรกทอรี: https://www.googleapis.com/auth/directory.readonly

รายชื่อติดต่อ

การแมปช่อง

ฟิลด์รายชื่อติดต่อ ฟิลด์บุคคล
atom:content ชีวประวัติ
atom:link rel='http://schemas.google.com/contacts/2008/rel#photo' รูปภาพ
atom:title names
gContact:ข้อมูลการเรียกเก็บเงิน miscKeywords (type=OUTLOOK_BILLING_INFORMATION)
gContact:วันเกิด วันเกิด
ลิงก์ปฏิทิน gContact: calendarUrls
gContact:directoryServer miscKeywords (type=OUTLOOK_DIRECTORY_SERVER)
gContact:กิจกรรม กิจกรรม
gContact:extendedProperty clientData
gContact:externalId externalIds
gContact:fileAs fileAses
gContact:gender เพศ
gContact:groupข้อมูลการเป็นสมาชิก memberships.contactGroupMembership
gContact:งานอดิเรก ความสนใจ
gContact:initials ชื่อเล่นเลิกใช้งานแล้ว (type=INITIALS)
gContact:jot type='home' miscKeywords (type=HOME)
gContact:jot type='คำหลัก' miscKeywords (type=OUTLOOK_KEYWORD)
gContact:jot type='อื่นๆ' miscKeywords (type=OTHER)
gContact:jot type='ผู้ใช้' miscKeywords (type=OUTLOOK_USER)
gContact:jot type='งาน' miscKeywords (type=WORK)
gContact:ภาษา ภาษา
gContact:maidenName ชื่อเล่น (type=MAIDEN_NAME) เลิกใช้งานแล้ว
gContact:ระยะทาง miscKeyword (type=OUTLOOK_MILEAGE)
gContact:ชื่อเล่น ชื่อเล่น (type=ค่าเริ่มต้น)
gContact:occupation อาชีพ
gContact:ลำดับความสำคัญ miscKeyword (type=OUTLOOK_PRIORITY)
gContact:ความสัมพันธ์ ความสัมพันธ์
gContact:ความไว miscKeywords (type=OUTLOOK_SENSITIVITY)
gContact:shortName ชื่อเล่น (type=SHORT_NAME)เลิกใช้งานแล้ว
gContact:subject miscKeywords (type=OUTLOOK_SUBJECT)
gContact:userdefinedField userDefined
gContact:เว็บไซต์ urls
gContact:yomiName names.phonetic_full_name
gd:ลบแล้ว metadata.deleted
gd:email emailAddresses
gd:im imClients
gd:องค์กร organizations
gd:phoneNumber phoneNumbers
gd:postalAddress addresses.formattedValue
gd:where ที่อยู่อาศัย
gd:structuredPostalAddress ที่อยู่

ปลายทางรายชื่อติดต่อส่วนบุคคล

อ่านแล้ว

ต้องมีขอบเขต https://www.googleapis.com/auth/contacts หรือ https://www.googleapis.com/auth/contacts.readonly

  • อ่านรายชื่อติดต่อที่เฉพาะเจาะจงรายการเดียว people.get
  • อ่านรายชื่อติดต่อที่เจาะจงหลายๆ รายการ people.getBatchGet
  • อ่านรายชื่อติดต่อโดยใช้ people.connections.list

เปลี่ยนแปลง

ต้องใช้ขอบเขต https://www.googleapis.com/auth/contacts เปลี่ยนแปลงช่องรายชื่อติดต่อทั้งหมด ยกเว้นรูปภาพ

  • สร้างรายชื่อติดต่อโดยใช้ people.createContact
  • อัปเดตรายชื่อติดต่อที่มีอยู่โดยใช้ people.updateContact
  • ลบรายชื่อติดต่อโดยใช้ people.deleteContact

การเปลี่ยนรูปภาพ

ต้องใช้ขอบเขต https://www.googleapis.com/auth/contacts

ปลายทางอื่นๆ ของรายชื่อติดต่อ

อ่านแล้ว

รายชื่อติดต่ออื่นๆ จะเป็นแบบอ่านอย่างเดียว และจะส่งคืนเฉพาะช่อง names, emailAddresses และ phoneNumbers เท่านั้น

ต้องใช้ขอบเขต https://www.googleapis.com/auth/contacts.other.readonly

  • อ่านรายชื่อติดต่ออื่นๆ โดยใช้ otherContacts.list

คัดลอก

ต้องใช้ขอบเขต https://www.googleapis.com/auth/contacts.other.readonly และ https://www.googleapis.com/auth/contacts

ปลายทางรายการที่อยู่ร่วม

ต้องใช้ขอบเขต https://www.googleapis.com/auth/directory.readonly

  • แสดงรายชื่อติดต่อและโปรไฟล์ของไดเรกทอรีทั้งหมด people.listDirectoryPeople
  • ค้นหารายชื่อติดต่อและโปรไฟล์ของไดเรกทอรี people.searchDirectoryPeople

กลุ่มรายชื่อติดต่อ

การแมปช่อง

ช่องกลุ่มรายชื่อติดต่อของ Contacts API ฟิลด์กลุ่มรายชื่อติดต่อของ People API
atom:อัปเดท metadata.updateTime
atom:title name
atom:content name
gd:ลบแล้ว metadata.deleted
systemGroup groupType=SYSTEM_CONTACT_GROUP

ปลายทาง

อ่านแล้ว

ต้องมีขอบเขต https://www.googleapis.com/auth/contacts หรือ https://www.googleapis.com/auth/contacts.readonly

  • ค้นหากลุ่มรายชื่อติดต่อที่ต้องการโดยใช้ people.contactGroups.get
  • แสดงรายการกลุ่มรายชื่อติดต่อโดยใช้ people.contactGroups.list

เปลี่ยนแปลง

ต้องใช้ขอบเขต https://www.googleapis.com/auth/contacts

  • สร้างกลุ่มรายชื่อติดต่อโดยใช้ people.contactGroups.create
  • อัปเดตกลุ่มรายชื่อติดต่อโดยใช้ people.contactGroups.update
  • ลบกลุ่มรายชื่อติดต่อโดยใช้ people.contactGroups.delete

  • เพิ่มหรือนำรายชื่อติดต่อออกจากกลุ่มรายชื่อติดต่อโดยใช้ people.contactGroups.members.modify

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

ขอบเขตเดิม https://www.google.com/m8/feeds เป็นชื่อแทนสำหรับขอบเขต https://www.googleapis.com/auth/contacts ซึ่งหมายความว่าการให้สิทธิ์ OAuth ที่มีอยู่ซึ่งมีขอบเขตเดิมจะใช้ได้กับปลายทางใน People API ที่จำเป็นต้องใช้ขอบเขต https://www.googleapis.com/auth/contacts การอ่านและเขียนรายชื่อติดต่อและกลุ่มรายชื่อติดต่อจะทำงานกับขอบเขตเดิม

People API ต้องใช้ขอบเขตใหม่ในการเข้าถึง "รายชื่อติดต่ออื่นๆ" หรือข้อมูลไดเรกทอรี โปรดดูรายละเอียดขอบเขตที่กำหนดด้านบน

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

ไลบรารีของไคลเอ็นต์