People API

מספק גישה למידע על פרופילים ואנשי קשר.

שירות: people.googleapis.com

כדי לקרוא לשירות הזה, מומלץ להשתמש בספריות הלקוח ש-Google מספקת. אם האפליקציה שלכם צריכה להשתמש בספריות משלכם כדי לקרוא לשירות הזה, תוכלו להשתמש בפרטים הבאים כשתשלחו את בקשות ה-API.

מסמך Discovery

מסמך Discovery הוא מפרט קריא למחשבים שמיועד לתיאור ולשימוש בממשקי API ל-REST. הוא משמש לבניית ספריות לקוח, יישומי פלאגין ל-IDE וכלים אחרים שיוצרים אינטראקציה עם Google APIs. שירות אחד יכול לספק כמה מסמכי גילוי. השירות הזה מספק את מסמך הגילוי הבא:

נקודת הקצה של השירות

נקודת קצה של שירות היא כתובת URL בסיסית שמציינת את כתובת הרשת של שירות ה-API. לשירות אחד יכולות להיות כמה נקודות קצה של שירות. לשירות הזה יש את נקודת הקצה הבאה של השירות, וכל מזהי ה-URI הבאים הם יחסיים לנקודת הקצה של השירות:

  • https://people.googleapis.com

משאב REST: v1.contactGroups

שיטות
batchGet GET /v1/contactGroups:batchGet
כדי להציג רשימה של קבוצות של אנשי קשר שבבעלות המשתמש המאומת, צריך לציין רשימה של שמות המשאבים של קבוצת אנשי הקשר.
create POST /v1/contactGroups
יוצרים קבוצה חדשה של אנשי קשר בבעלות המשתמש המאומת.
delete DELETE /v1/{resourceName=contactGroups/*}
כדי למחוק קבוצת אנשי קשר קיימת שבבעלות המשתמש המאומת, יש לציין שם משאב של קבוצת אנשי קשר.
get GET /v1/{resourceName=contactGroups/*}
כדי לקבל קבוצה ספציפית של אנשי קשר שבבעלות המשתמש המאומת, יש לציין שם משאב של קבוצת אנשי קשר.
list GET /v1/contactGroups
רשימה של כל הקבוצות של אנשי הקשר שבבעלות המשתמש המאומת.
update PUT /v1/{contactGroup.resourceName=contactGroups/*}
מעדכנים את השם של קבוצת אנשי קשר קיימת שבבעלות המשתמש המאומת.

משאב REST: v1.contactGroups.members

שיטות
modify POST /v1/{resourceName=contactGroups/*}/members:modify
משנים את החברים בקבוצת אנשי קשר שבבעלות המשתמש המאומת.

משאב REST: v1.otherContacts

שיטות
copyOtherContactToMyContactsGroup POST /v1/{resourceName=otherContacts/*}:copyOtherContactToMyContactsGroup

מעתיק 'איש קשר אחר' לאיש קשר חדש בקבוצה 'אנשי הקשר שלי' של המשתמש

יש לשלוח בקשות לשינויים עבור אותו משתמש ברצף כדי למנוע זמן אחזור ארוך יותר וכישלונות.
list GET /v1/otherContacts
ברשימה את כל 'אנשי הקשר האחרים', כלומר אנשי קשר שלא נכללים בקבוצה של אנשי קשר.
search GET /v1/otherContacts:search
המדיניות הזו מספקת רשימה של אנשי קשר מתוך אנשי הקשר האחרים של המשתמש המאומת שתואמים לשאילתת החיפוש.

משאב ל-REST: v1.people

שיטות
batchCreateContacts POST /v1/people:batchCreateContacts

יצירת קבוצה של אנשי קשר חדשים והחזרת PersonResponses עבור

יש לשלוח בקשות לשינויים עבור אותו משתמש ברצף כדי למנוע זמן אחזור ארוך יותר וכישלונות.
batchDeleteContacts POST /v1/people:batchDeleteContacts
מחיקת קבוצה של אנשי קשר.
batchUpdateContacts POST /v1/people:batchUpdateContacts
עדכון קבוצה של אנשי קשר והחזרת מפה של שמות המשאבים ל-PersonResponses עבור אנשי הקשר המעודכנים.
createContact POST /v1/people:createContact
יוצרים איש קשר חדש ומחזירים את המשאב של המשתמש הזה.
deleteContact DELETE /v1/{resourceName=people/*}:deleteContact
מחיקת איש קשר.
deleteContactPhoto DELETE /v1/{resourceName=people/*}:deleteContactPhoto
מחיקת תמונה של איש קשר.
get GET /v1/{resourceName=people/*}
מספק מידע על אדם על ידי ציון שם משאב.
getBatchGet GET /v1/people:batchGet
האפשרות הזו מספקת מידע על רשימה של אנשים ספציפיים על ידי ציון רשימה של שמות המשאבים הנדרשים.
listDirectoryPeople GET /v1/people:listDirectoryPeople
מספקת רשימה של פרופילים בדומיין ואנשי קשר מהדומיין בספריית הדומיינים של המשתמש המאומת.
searchContacts GET /v1/people:searchContacts
המדיניות הזו מספקת רשימה של אנשי קשר שבאנשי הקשר המקובצים של המשתמש המאומת שתואמים לשאילתת החיפוש.
searchDirectoryPeople GET /v1/people:searchDirectoryPeople
המדיניות הזו מספקת רשימה של פרופילים בדומיין ואנשי קשר מהדומיין של המשתמש המאומת בספריית הדומיין שתואמים לשאילתת החיפוש.
updateContact PATCH /v1/{person.resourceName=people/*}:updateContact
מעדכנים את הנתונים של איש קשר קיים.
updateContactPhoto PATCH /v1/{resourceName=people/*}:updateContactPhoto
עדכון התמונה של איש הקשר.

משאב ל-REST: v1.people.connections

שיטות
list GET /v1/{resourceName=people/*}/connections
מספקת רשימה של אנשי הקשר של המשתמש המאומת.