Domain Shared Contacts API की मदद से, आपके ऐप्लिकेशन उन बाहरी संपर्कों को ऐक्सेस और अपडेट कर सकते हैं जिन्हें Google Workspace डोमेन के सभी उपयोगकर्ताओं के साथ शेयर किया गया है. शेयर किए गए संपर्क, Google Workspace डोमेन के सभी उपयोगकर्ताओं को दिखते हैं. साथ ही, Google की सभी सेवाओं के पास संपर्क सूची का ऐक्सेस होता है.
आपका ऐप्लिकेशन, शेयर किए गए संपर्क बनाने, शेयर किए गए मौजूदा संपर्कों में बदलाव करने या उन्हें मिटाने के लिए, Domain Shared Contacts API का इस्तेमाल कर सकता है. साथ ही, किसी खास शर्त से मैच करने वाले शेयर किए गए संपर्कों के लिए क्वेरी भी कर सकता है.
डोमेन में शेयर किए गए संपर्क को मैनेज करने वाला एपीआई, सिर्फ़ Google Workspace खातों के लिए उपलब्ध है. एपीआई का इस्तेमाल करने के लिए, Admin console में Domain Shared Contacts API को चालू करें. शेयर किए गए संपर्क में किए गए बदलावों को ईमेल पते के अपने-आप भरने की सुविधा और संपर्क मैनेजर में दिखने में 24 घंटे लग सकते हैं.
इस दस्तावेज़ में, डोमेन में शेयर किए गए संपर्कों के एपीआई की सुविधाओं के बारे में जानकारी दी गई है. साथ ही, इसमें एक्सएमएल और एचटीटीपी का इस्तेमाल करके संपर्कों को मैनेज करने के उदाहरण भी दिए गए हैं. इस दस्तावेज़ को पढ़ने के बाद, हमारी क्लाइंट लाइब्रेरी का इस्तेमाल करके, एपीआई के साथ इंटरैक्ट करने के बारे में ज़्यादा जानें.
ऑडियंस
यह दस्तावेज़ उन डेवलपर के लिए है जो ऐसे क्लाइंट ऐप्लिकेशन लिखना चाहते हैं जो एचटीटीपी और एक्सएमएल का इस्तेमाल करके, Google की संपर्क सूचियों में बदलाव कर सकें. इस दस्तावेज़ में यह माना गया है कि आपने Google Data API प्रोटोकॉल के बुनियादी सिद्धांतों को समझ लिया है.
अगर आपने UNIX ऑपरेटिंग सिस्टम का इस्तेमाल किया है और आपको कोई कोड लिखे बिना इस दस्तावेज़ में दिए गए उदाहरणों को आज़माना है, तो UNIX कमांड-लाइन की सुविधाओं curl या wget का इस्तेमाल करें. Google की डेटा सेवाओं के साथ cURL का इस्तेमाल करने का तरीका जानें.
सिद्धांत
Domain Shared Contacts API का यह वर्शन, Google Data API के सिद्धांतों का पालन करता है. Google Data API, Atom पब्लिशिंग प्रोटोकॉल के साथ-साथ, Atom 1.0 और आरएसएस 2.0, दोनों सिंडिकेशन फ़ॉर्मैट पर आधारित हैं.
कोई वर्शन चुनना
Domain Shared Contacts API का इस्तेमाल करके भेजे गए हर अनुरोध में, एपीआई के 3.0 वर्शन के बारे में जानकारी होनी चाहिए:
GData-Version: 3.0
अगर एचटीटीपी हेडर सेट नहीं किए जा सकते, तो यूआरएल में v=3.0 को क्वेरी पैरामीटर के तौर पर दिखाया जा सकता है. हालांकि, एचटीटीपी हेडर का तरीका इस्तेमाल करने का सुझाव दिया जाता है.