ממשק ה-API של אנשי הקשר הושבת ב-19 בינואר 2022. במדריך הזה מוסבר על שינויים בשדות, בנקודות קצה ובהיקפי הרשאות במהלך המעבר ל-People API.
סקירה כללית
ל-People API יש את אותה פונקציונליות כמו של Contacts API הקודם בכל הפיצ'רים, מלבד אנשי קשר נוספים:
לאדמינים יש הרשאות קריאה בלבד ל'אנשי קשר אחרים' בהיקף החדש. מאחר שאין תמיכה בשליחה של אותות שינוי/כתיבה חזרה ל'אנשי קשר אחרים', המשתמשים שלכם יצטרכו להוסיף את 'איש קשר אחר' כ'אנשי הקשר שלי' אם הם ירצו לעדכן את שדות הנתונים שלו.
אפשר לקרוא ב-API רק פרטים בסיסיים ליצירת קשר של 'אנשי קשר אחרים'. לדוגמה, שם מלא, כתובת אימייל ומספר טלפון.
בנוסף, ההיקף הישן של 'אנשי קשר' (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:billingInformation | miscKeywords (type=OUTLOOK_BILLING_INFORMATION) |
| gContact:יום הולדת | ימי הולדת |
| gContact:calendarLink | calendarUrls |
| gContact:directoryשרת | miscKeywords (type=OUTLOOK_DIRECTORY_SERVER) |
| gContact:אירוע | אירועים |
| gContact:extendedProperty | clientData |
| gContact:externalId | externalIds |
| gContact:fileAs | fileAses |
| gContact:מגדר | מגדרים |
| gContact:groupMembershipInfo | memberships.contactGroupMembership |
| gContact:תחביבים | תחומי עניין |
| gContact:ראשי תיבות | DEPRECATED כינויים (type=INITIALS) |
| gContact:jot type='home' | miscKeywords (type=Home) |
| gContact:jot type='keywords' | miscKeywords (type=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:שפה | שפות |
| gContact:maidenName | כינויים הוצאו משימוש (type=MAIDEN_NAME) |
| gContact:קילומטראז' | miscKeywords (type=OUTLOOK_MILEAGE) |
| gContact:כינוי | כינויים (type=DEFAULT) |
| gContact:עיסוק | מקצועות |
| gContact:עדיפות | miscKeywords (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:delete | metadata.deleted |
| gd:email | emailAddresses |
| gd:im | imClients |
| gd:ארגון | organizations |
| gd:phoneNumber | phoneNumbers |
| 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.
- העתקת אנשי קשר אחרים באמצעות
otherContacts.copyOtherContactToMyContactsGroup.
נקודות קצה (endpoints) של רשימת כתובות גלובלית
נדרש היקף הרשאות אחד (https://www.googleapis.com/auth/directory.readonly).
- הצגת רשימה של כל הפרופילים והאנשי הקשר בספרייה
people.listDirectoryPeople. - חיפוש אנשי קשר ופרופילים מהספרייה
people.searchDirectoryPeople.
קבוצות אנשי קשר
מיפוי שדות
| שדה קבוצת אנשי קשר בממשק ה-API של אנשי הקשר | שדה קבוצת אנשי קשר שלPeople API |
|---|---|
| atom:updated | metadata.updateTime |
| atom:title | name |
| atom:content | name |
| gd:delete | 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 נדרשים היקפים חדשים כדי לגשת לנתונים של 'אנשי קשר נוספים' או ספרייה. למעלה פרטים על ההיקפים הנדרשים.
פרטים נוספים זמינים במאמר בנושא בקשות הרשאה.
ספריות לקוח
- בנושא Apps Script, ראו שירות אנשים מתקדם.
- אפשר לקרוא מידע נוסף על שפות נתמכות במאמר בנושא התקנת ספריות לקוח.