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