Domain Shared Contacts API की खास जानकारी

Domain Shared Contacts API की मदद से, आपके ऐप्लिकेशन को बाहरी संपर्क मिलते हैं. साथ ही, वे Google Workspace डोमेन के सभी उपयोगकर्ताओं के साथ शेयर किए जाते हैं. शेयर किए गए संपर्क, Google Workspace डोमेन के सभी उपयोगकर्ताओं को दिखते हैं. साथ ही, Google की सभी सेवाओं के पास संपर्क सूची को ऐक्सेस करने की अनुमति होती है.

चेतावनी: Domain Shared Contacts API का इस्तेमाल सिर्फ़ बाहरी संपर्कों के लिए किया जाता है. इस एपीआई का इस्तेमाल करके, डोमेन (इंटरनल) उपयोगकर्ताओं या ग्रुप के लिए संपर्क जानकारी बनाने पर, उन उपयोगकर्ताओं और ग्रुप के लिए संपर्क जानकारी डुप्लीकेट हो सकती है. इससे अनचाही समस्याएं हो सकती हैं. Google Workspace डोमेन (इंटरनल) के उपयोगकर्ताओं की संपर्क जानकारी पाने और उसे अपडेट करने के लिए, Directory API का इस्तेमाल करें.

आपका ऐप्लिकेशन, Domain Shared Contacts API का इस्तेमाल करके शेयर किए गए संपर्क बना सकता है. साथ ही, शेयर किए गए मौजूदा संपर्कों में बदलाव कर सकता है या उन्हें मिटा सकता है. इसके अलावा, शेयर किए गए ऐसे संपर्कों के लिए क्वेरी कर सकता है जो किसी खास मानदंड से मेल खाते हों.

Domain Shared Contacts API, सिर्फ़ Google Workspace खातों के लिए उपलब्ध है. एपीआई का इस्तेमाल करने के लिए, Admin console में Domain Shared Contacts API चालू करें. शेयर किए गए संपर्क में किए गए बदलावों को ईमेल पते के अपने-आप पूरे होने की सुविधा और संपर्क मैनेजर में दिखने में 24 घंटे लग सकते हैं.

इस दस्तावेज़ में, Domain Shared Contacts API की सुविधाओं के बारे में जानकारी दी गई है. साथ ही, इसमें XML और एचटीटीपी का इस्तेमाल करके, संपर्कों को मैनेज करने के तरीके के बारे में उदाहरण दिए गए हैं. इस दस्तावेज़ को पढ़ने के बाद, हमारी क्लाइंट लाइब्रेरी का इस्तेमाल करके, एपीआई से इंटरैक्ट करने के बारे में ज़्यादा जानें.

ऑडियंस

यह दस्तावेज़ उन डेवलपर के लिए है जो ऐसे क्लाइंट ऐप्लिकेशन लिखना चाहते हैं जो एचटीटीपी और एक्सएमएल का इस्तेमाल करके, Google की संपर्क सूचियों में बदलाव कर सकते हैं. इस दस्तावेज़ में यह माना गया है कि आपको Google Data APIs प्रोटोकॉल के बुनियादी सिद्धांतों के बारे में जानकारी है.

अगर UNIX ऑपरेटिंग सिस्टम का इस्तेमाल किया जा रहा है और आपको इस दस्तावेज़ में दिए गए उदाहरणों को बिना कोई कोड लिखे आज़माना है, तो UNIX कमांड-लाइन यूटिलिटी curl या wget का इस्तेमाल करें. Google की डेटा सेवाओं के साथ cURL का इस्तेमाल करने का तरीका जानें.

सिद्धांत

Domain Shared Contacts API का यह वर्शन, Google Data APIs के सिद्धांतों का पालन करता है. Google Data API, ऐटम पब्लिशिंग प्रोटोकॉल के साथ-साथ, ऐटम 1.0 और आरएसएस 2.0 सिंडिकेशन फ़ॉर्मैट पर आधारित होते हैं.

कोई वर्शन तय करना

Domain Shared Contacts API का इस्तेमाल करके भेजे जाने वाले हर अनुरोध में, एपीआई के 3.0 वर्शन के बारे में जानकारी होनी चाहिए:

GData-Version: 3.0

अगर एचटीटीपी हेडर सेट नहीं किए जा सकते, तो यूआरएल में v=3.0 को क्वेरी पैरामीटर के तौर पर सेट किया जा सकता है. हालांकि, एचटीटीपी हेडर का इस्तेमाल करने का सुझाव दिया जाता है.

ध्यान दें: क्लाइंट लाइब्रेरी, वर्शन हेडर अपने-आप उपलब्ध कराती हैं. इसलिए, क्लाइंट लाइब्रेरी का इस्तेमाल करते समय, v=3.0 क्वेरी पैरामीटर का इस्तेमाल न करें.