ה-People API מאפשר:
- קריאה וניהול של אנשי הקשר של המשתמש המאומת
- קריאה והעתקה של 'אנשי קשר נוספים' של המשתמש המאומת
- לקרוא פרטי פרופיל עבור משתמשים מאומתים ואנשי הקשר שלהם
- קריאת פרופילים ואנשי קשר מהדומיין
לדוגמה, נניח שלמשתמש המאומת, ג'ן, יש את פביאן וראנג'ית' באנשי הקשר הפרטיים שלה. כשהאפליקציה מתקשרת אל 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. |
| אנשי הקשר של המשתמש המאומת | קיבלנו את ההיקף ב-contacts. |
הסבר על נתוני אנשים שמוזגו
הנתונים לגבי אדם נגזרים מסוג מקור עיקרי אחד. נתונים ממקורות אחרים ממוזגים עם הנתונים האלה אם המקורות מקושרים באמצעות כתובות אימייל, מספרי טלפון או כתובות אתרים של פרופילים מאומתים. אלה הדרכים שבהן המשתמש יכול להיכתב:
| מקור עיקרי | אנשי קשר | פרופילים | פרופילים של דומיינים ב-Google Workspace | אנשי קשר בדומיין Google Workspace | Usage |
|---|---|---|---|---|---|
| Contact | 1 | 0+ | 0+ | 0+ | הוחזרה עבור רוב נקודות הקצה |
| פרופיל | 0+ | 1 | 0 או 1 | 0 | הוחזרה לחשבון people.get כשנעשה בה שימוש כדי להשיג את המשתמש למשתמש המחובר או כדי לחפש אדם בשביל חשבון Google של משתמש אחר. |
| איש קשר של דומיין | 0+ | 0 | 0 | 1 | הוחזרה: people.listDirectoryPeople או people.searchDirectoryPeople. |
אפשר לשנות רק אנשים המבוססים על אנשי קשר באמצעות נקודות קצה של מוטציה. אין תמיכה במוטציות של אנשי קשר בפרופיל ובדומיין.