באמצעות Domain Shared Contacts API, האפליקציות שלכם יכולות לקבל ולעדכן אנשי קשר חיצוניים ששותפו עם כל המשתמשים בדומיין ב-Google Workspace. כל המשתמשים בדומיין של Google Workspace יכולים לראות את אנשי הקשר המשותפים, וכל שירותי Google יכולים לגשת לרשימת אנשי הקשר.
האפליקציה שלכם יכולה להשתמש ב-Domain Shared Contacts API כדי ליצור אנשי קשר משותפים, לערוך או למחוק אנשי קשר משותפים קיימים ולבצע שאילתות לאנשי קשר משותפים שתואמים לקריטריונים מסוימים.
ה-API של כתובות האימייל המשותפות בדומיין זמין רק לחשבונות Google Workspace. כדי להשתמש ב-API, צריך להפעיל את Domain Shared Contacts API במסוף Admin. יכול להיות שיחלפו עד 24 שעות לפני שהשינויים באנשי הקשר המשותפים יבואו לידי ביטוי בהשלמה האוטומטית של כתובות האימייל ובמנהל אנשי הקשר.
בנוסף למידע על היכולות של API של אנשי הקשר המשותפים בדומיין, במסמך הזה מפורטות דוגמאות לניהול אנשי קשר באמצעות XML ו-HTTP. אחרי שתסיימו לקרוא את המסמך הזה, תוכלו לקרוא מידע נוסף על האינטראקציה עם ה-API באמצעות ספריות הלקוח שלנו.
קהל
המסמך הזה מיועד למפתחים שרוצים לכתוב אפליקציות לקוח שיכולות לבצע פעולות על רשימות אנשי הקשר של Google באמצעות HTTP ו-XML. ההנחה במסמך הזה היא שיש לכם הבנה בעקרונות הבסיסיים של פרוטוקול Google Data APIs.
אם אתם משתמשים במערכת הפעלה UNIX ואתם רוצים לנסות את הדוגמאות במסמך הזה בלי לכתוב קוד, תוכלו להשתמש בכלי שורת הפקודה של UNIX curl או wget. כך משתמשים ב-cURL עם שירותי Google Data
עקרונות
הגרסה הזו של Domain Shared Contacts API פועלת לפי העקרונות של Google Data APIs. ממשקי Google Data API מבוססים על פורמטים של סינדיקציה של Atom 1.0 ו-RSS 2.0, בנוסף לפרוטוקול Atom Publishing.
ציון גרסה
בכל בקשה ששולחים באמצעות Domain Shared Contacts API צריך לציין את הגרסה 3.0 של ה-API:
GData-Version: 3.0
אם אין לכם אפשרות להגדיר כותרות HTTP, תוכלו לציין את v=3.0
כפרמטר של שאילתה בכתובת ה-URL, אבל מומלץ להשתמש בשיטה של כותרת ה-HTTP.