مخاطبین API در 19 ژانویه 2022 رد شد. از این راهنما برای اطلاع از تغییرات فیلدها، نقاط پایانی و دامنه مجوزها هنگام مهاجرت به People API استفاده کنید.
بررسی اجمالی
People API عملکردی مشابه با API قدیمی Contacts برای همه ویژگی‌ها دارد، با استثناهای زیر برای سایر مخاطبین :
مدیران از طریق محدوده جدید مجوزهای فقط خواندنی برای "مخاطبین دیگر" دارند. از آنجایی که ارسال سیگنال‌های جهش/نوشتن به «مخاطبین دیگر» پشتیبانی نمی‌شود، کاربران شما در صورتی که می‌خواهند فیلدهای داده آن را به‌روزرسانی کنند، باید مخاطب دیگر را به عنوان مخاطب من اضافه کنند.
فقط اطلاعات تماس اولیه برای "دیگر مخاطبین" را می توان از طریق API خواند. به عنوان مثال، نام کامل، آدرس ایمیل و شماره تلفن.
علاوه بر این، محدوده قدیمی مخاطبین ( https://www.google.com/m8/feeds )، که دسترسی به اطلاعات مخاطبین شخصی و دایرکتوری را فراهم می‌کرد، با دامنه‌های زیر جایگزین می‌شود:
- برای دسترسی به مخاطبین شخصی:
https://www.googleapis.com/auth/contacts - برای دسترسی به اطلاعات دایرکتوری:
https://www.googleapis.com/auth/directory.readonly
مخاطب
نقشه برداری فیلدها
| فیلد تماس | فیلد شخص |
|---|---|
| اتم: محتوا | بیوگرافی ها |
| atom:link rel='http://schemas.google.com/contacts/2008/rel#photo' | عکس ها |
| اتم: عنوان | نام ها |
| gContact:billingInformation | miscKeywords (نوع=OUTLOOK_BILLING_INFORMATION) |
| gContact: تولد | تولدها |
| gContact:calendarLink | calendarUrls |
| gContact:directoryServer | miscKeywords (نوع=OUTLOOK_DIRECTORY_SERVER) |
| gContact: رویداد | مناسبت ها |
| gContact:extendedProperty | کلاینت دیتا |
| gContact:externalId | شناسه های خارجی |
| gContact:fileAs | fileAses |
| gContact: جنسیت | جنسیت ها |
| gContact:groupMembershipInfo | Members.contactGroupMembership |
| gContact: سرگرمی | منافع |
| gContact: initials | نام مستعار منسوخ شده (نوع=INITIALS) |
| gContact:jot type='home' | miscKeywords (type=HOME) |
| gContact:jot type='keywords' | miscKeywords (نوع=OUTLOOK_KEYWORD) |
| gContact:jot type='other' | miscKeywords (type=OTHER) |
| gContact:jot type='user' | miscKeywords (type=OUTLOOK_USER) |
| gContact:jot type='work' | miscKeywords (type=WORK) |
| gContact:language | زبان ها |
| gContact:maidenName | نام مستعار منسوخ شده (نوع=MAIDEN_NAME) |
| gContact: مسافت پیموده شده | miscKeywords (نوع=OUTLOOK_MILEAGE) |
| gContact:نام مستعار | نام مستعار (نوع = پیش فرض) |
| gContact:occupation | مشاغل |
| gContact: اولویت | miscKeywords (نوع=OUTLOOK_PRIORITY) |
| gContact:relation | روابط |
| gContact:sensitivity | miscKeywords (نوع=OUTLOOK_SENSITIVITY) |
| gContact:shortName | نام مستعار منسوخ شده (نوع=SHORT_NAME) |
| gContact:subject | miscKeywords (نوع=OUTLOOK_SUBJECT) |
| gContact:userDefinedField | تعریف شده توسط کاربر |
| gContact:website | آدرس های اینترنتی |
| gContact:yomiName | names.phonetic_full_name |
| gd:حذف شد | metadata.deleted |
| gd: ایمیل | آدرس ایمیل |
| gd:im | imClients |
| gd: سازمان | سازمان های |
| gd: شماره تلفن | شماره تلفن ها |
| gd:postalAddress | addresses.formattedValue |
| gd: کجا | اقامتگاه ها |
| 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 نیاز دارد.
- عکس مخاطب را با استفاده از
people.updateContactPhotoبه‌روزرسانی کنید. - یک عکس مخاطب را با استفاده از
people.deleteContactPhotoحذف کنید.
سایر نقاط پایانی مخاطبین
خواندن
سایر مخاطبین فقط خواندنی هستند و فقط 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 scope نیاز دارد.
- سایر مخاطبین را با استفاده از
otherContacts.copyOtherContactToMyContactsGroupکپی کنید.
نقاط پایانی فهرست نشانی جهانی
به https://www.googleapis.com/auth/directory.readonly دامنه نیاز دارد.
- لیست تمام مخاطبین دایرکتوری و نمایه ها
people.listDirectoryPeople. - جستجوی فهرست مخاطبین و نمایه ها
people.searchDirectoryPeople.
گروه های تماس
نقشه برداری فیلدها
| فیلد گروه تماس API مخاطبین | فیلد گروه تماس API People |
|---|---|
| اتم: به روز شد | metadata.updateTime |
| اتم: عنوان | نام |
| اتم: محتوا | نام |
| gd:حذف شد | metadata.deleted |
| سیستم گروه | 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 برای دسترسی به "دیگر مخاطبین" یا داده های دایرکتوری به محدوده های جدیدی نیاز دارد. برای دامنه های مورد نیاز به جزئیات بالا مراجعه کنید.
برای جزئیات بیشتر، به درخواست‌های مجاز مراجعه کنید.
کتابخانه های مشتری
- برای Apps Script، به Advanced People Service مراجعه کنید.
- برای سایر زبان های پشتیبانی شده، به نصب کتابخانه های مشتری مراجعه کنید.