डेवलपर की गाइड की खास जानकारी

चेतावनी: यह पेज, Google के पुराने एपीआई यानी कि Google Data API के बारे में है. यह सिर्फ़ उन एपीआई के बारे में है जो Google Data API डायरेक्ट्री में मौजूद हैं. इनमें से कई एपीआई को नए एपीआई से बदला गया है. किसी नए एपीआई के बारे में जानकारी पाने के लिए, उस नए एपीआई के दस्तावेज़ देखें. नए एपीआई से अनुरोधों को अनुमति देने के बारे में जानकारी पाने के लिए, Google खाते की पुष्टि करना और अनुमति देना देखें.

Google का उद्देश्य विश्व की जानकारी संगठित करना और उसे वैश्विक रूप से पहुंच-योग्य और उपयोगी बनाना है. इसमें, जानकारी को वेब ब्राउज़र के अलावा, किसी दूसरे प्लैटफ़ॉर्म पर ऐक्सेस करना और Google से बाहर की सेवाओं को ऐक्सेस करना शामिल है.

Google Data प्रोटोकॉल, बाहरी डेवलपर को नए ऐप्लिकेशन लिखने का सुरक्षित तरीका देता है. इससे असली उपयोगकर्ता, Google के कई प्रॉडक्ट से सेव किए गए डेटा को ऐक्सेस और अपडेट कर सकते हैं. बाहरी डेवलपर, Google डेटा प्रोटोकॉल का इस्तेमाल सीधे तौर पर कर सकते हैं. इसके अलावा, वे क्लाइंट लाइब्रेरी से उपलब्ध, काम करने वाली किसी भी प्रोग्रामिंग भाषा का इस्तेमाल कर सकते हैं.

दर्शक

दस्तावेज़ों का यह सेट उन सभी के लिए है जिन्हें Google डेटा प्रोटोकॉल को समझना है. भले ही आप भाषा-विशिष्ट क्लाइंट लाइब्रेरी का उपयोग करने वाला कोड लिखना चाहें, लेकिन अगर आप यह समझना चाहते हैं कि क्लाइंट-लाइब्रेरी के ऐब्स्ट्रैक्शन लेयर के नीचे क्या चल रहा है, तो यह दस्तावेज़ सेट आपके लिए उपयोगी हो सकता है.

अगर आपको किसी खास एपीआई के लिए, डेवलपर की गाइड का इस्तेमाल करना है, तो Google डेटा प्रोटोकॉल एपीआई डायरेक्ट्री पर जाएं.

अगर आपको अपनी पसंदीदा प्रोग्रामिंग भाषा में किसी एपीआई को ऐक्सेस करना है, तो क्लाइंट लाइब्रेरी डाउनलोड पेज पर जाएं.

बैकग्राउंड

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

ध्यान दें: एपीआई देने वाले Google के प्रॉडक्ट को, कभी-कभी इन दस्तावेज़ों के साथ-साथ अन्य दस्तावेज़ों में भी सेवाएं कहा जाता है.

अगर सीधे Google डेटा प्रोटोकॉल का इस्तेमाल करने वाला कोड लिखा जाता है, तो एपीआई GET या POST जैसे एचटीटीपी अनुरोधों का इस्तेमाल करके एपीआई को ऐक्सेस कर लेता है. इन अनुरोधों के साथ, Google प्रॉडक्ट के ज़रिए सेव किया गया डेटा, डेटा फ़ीड के रूप में वायर के ज़रिए बार-बार ट्रांसफ़र किया जाता है. डेटा फ़ीड सिर्फ़ स्ट्रक्चर्ड सूचियां होती हैं, जिनमें डेटा होता है. पहले, प्राइमरी फ़ीड फ़ॉर्मैट AtomPub एक्सएमएल होता था. अब JSON या JavaScript ऑब्जेक्ट नोटेशन भी वैकल्पिक फ़ॉर्मैट के तौर पर उपलब्ध है.

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

एपीआई या एपीआई वर्शन के लिए उपलब्ध खास भाषाओं के बारे में ज़्यादा जानकारी के लिए, प्रॉडक्ट के हिसाब से दिए गए दस्तावेज़ देखें.

प्रोटोकॉल के वर्शन

प्रोटोकॉल वर्शन 2.0 बनाम प्रोटोकॉल वर्शन 1.0

ऐटम पब्लिशिंग प्रोटोकॉल को आखिरी रूप देने से पहले, Google डेटा प्रोटोकॉल का पहला वर्शन बनाया गया था. Google डेटा प्रोटोकॉल का दूसरा वर्शन, AtomPub के आरएफ़सी 5023 मानक का पूरी तरह पालन करता है.

Google डेटा प्रोटोकॉल के वर्शन 2.0 में, ये सुविधाएं भी शामिल हैं:

• एचटीटीपी ई-टैग. ऐसा वेब स्टैंडर्ड जो आपके क्लाइंट ऐप्लिकेशन को एचटीटीपी कैश मेमोरी का बेहतर इस्तेमाल करने में मदद करता है. प्रोटोकॉल v2.0 की सुविधा देने वाली क्लाइंट लाइब्रेरी में शामिल सेवाएं, अपने-आप ई-टैग हैंडल करती हैं.
• कुछ हिस्से का जवाब और कुछ अपडेट (प्रयोग के तौर पर). वे सुविधाएं जिनकी मदद से आप कम डेटा ट्रांसफ़र करने वाले अनुरोध कर सकते हैं. केवल उस जानकारी के लिए अनुरोध करें जो आपको वास्तव में चाहिए, या केवल ऐसे डेटा वाले अपडेट भेजकर, जिन्हें आप वास्तव में बदलना चाहते हैं, आपका क्लाइंट ऐप्लिकेशन नेटवर्क, CPU, और मेमोरी संसाधनों के उपयोग में बहुत कुशलता से काम कर सकता है. फ़िलहाल, आंशिक जवाब और आंशिक अपडेट सिर्फ़ कुछ प्रॉडक्ट के लिए उपलब्ध हैं. प्रॉडक्ट से जुड़े खास दस्तावेज़ देखें और जानें कि आपके एपीआई पर यह सुविधा काम करती है या नहीं.

आपका ऐप्लिकेशन अपडेट किया जा रहा है

जिस एपीआई का इस्तेमाल किया जा रहा है अगर वह प्रोटोकॉल के नए वर्शन पर बनाया गया है, तो उसके दस्तावेज़ में प्रोटोकॉल v2.0 की सुविधा शामिल होती है. आम तौर पर, हम सुझाव देते हैं कि आप अपने क्लाइंट ऐप्लिकेशन को अपने एपीआई के लिए उपलब्ध सबसे नए वर्शन में अपग्रेड कर लें.

क्लाइंट-लाइब्रेरी-आधारित क्लाइंट को अपडेट करना

अगर आपके क्लाइंट ऐप्लिकेशन में Java क्लाइंट लाइब्रेरी या .NET क्लाइंट लाइब्रेरी जैसी क्लाइंट लाइब्रेरी का इस्तेमाल किया जाता है, तो इसमें एपीआई का ऐसा वर्शन हो सकता है जो प्रोटोकॉल v2.0 सुविधाओं के साथ काम करता हो. पता लगाने के लिए, उस Google प्रॉडक्ट के एपीआई दस्तावेज़ देखें जिसका इस्तेमाल करके आप यह पता लगा सकते हैं कि नीचे दी गई दोनों बातें सही हैं या नहीं:

• एपीआई का यह वर्शन, Google Data प्रोटोकॉल v2.0 की सुविधाओं के साथ काम करता है.
• आप जिस क्लाइंट लाइब्रेरी का इस्तेमाल कर रहे हैं वह उस एपीआई वर्शन के साथ भी काम करती है.

अगर क्लाइंट लाइब्रेरी इसमें काम करती है और आपको अपना मौजूदा ऐप्लिकेशन अपडेट करना है, तो क्लाइंट लाइब्रेरी का नया वर्शन डाउनलोड करें और इस्तेमाल करें. आपके सभी कोड अब भी काम करते हैं. क्लाइंट लाइब्रेरी, प्रोटोकॉल v2.0 के बदलावों को मैनेज करती है.

किसी रॉ एचटीटीपी क्लाइंट को अपडेट करना

अगर आपने Google डेटा प्रोटोकॉल का इस्तेमाल करके सीधे अपना क्लाइंट ऐप्लिकेशन लिखा है, तो आपको ये बदलाव करने होंगे:

• ऐसे वर्शन अनुरोध जो डिफ़ॉल्ट नहीं हैं. आपके भेजे गए हर एचटीटीपी अनुरोध में एक एचटीटीपी वर्शन हेडर (GData-Version: X.0) जोड़ें. यहां X, एपीआई का वह वर्शन है जो Google Data प्रोटोकॉल v2.0 की सुविधाओं के साथ काम करता है. इसके अलावा, हर अनुरोध के यूआरएल में क्वेरी पैरामीटर (v=X.0) जोड़ें. यहां X एपीआई का सही वर्शन है. अगर बाद के किसी वर्शन के बारे में जानकारी नहीं दी जाती है, तो आपके अनुरोध एपीआई के नए वर्शन के साथ काम करने वाले डिफ़ॉल्ट वर्शन पर भेजे जाते हैं.
• सब कुछ एक जैसा होना चाहिए. अगर आप ऐसे एपीआई का कोई वर्शन इस्तेमाल कर रहे थे जिसमें 'एक साथ कई काम करने के लिए सुविधा' काम करती थी, तो आपको अपना अपडेट बदलना पड़ सकता है. साथ ही, ETag का इस्तेमाल करने के लिए कोड को मिटाना पड़ सकता है. ज़्यादा जानकारी के लिए, Google डेटा प्रोटोकॉल संदर्भ दस्तावेज़ का ETag सेक्शन पढ़ें और उस सेवा के लिए प्रोटोकॉल डेवलपर की गाइड के अपडेट करें और मिटाएं सेक्शन को पढ़ें जिसका इस्तेमाल आपके क्लाइंट ऐप्लिकेशन में किया जा रहा है.
• खुद से बनाएं या यूआरआई में बदलाव करें. अगर आपके क्लाइंट को फ़ीड या एंट्री के लिए, खुद की जानकारी ट्रैक करने या यूआरआई में बदलाव करने की ज़रूरत पड़ती है, तो हो सकता है कि वे यूआरआई बदल गए हों. नया यूआरआई पाने के लिए, पुराने यूआरआई का इस्तेमाल करके आइटम के लिए फिर से अनुरोध करें, लेकिन अनुरोध को वर्शन X.0 अनुरोध के रूप में मार्क करें, जहां X Google डेटा प्रोटोकॉल v2.0 सुविधाओं के साथ काम करने वाला एपीआई का वर्शन है. सर्वर, नए यूआरआई सहित नए एंट्री पेज दिखाता है जिसे आप पुराने यूआरआई की जगह पर सेव कर सकते हैं.
• नेमस्पेस यूआरआई. अगर आपका क्लाइंट Google Data प्रोटोकॉल API नेमस्पेस यूआरआई को लोकल तौर पर सेव करता है या उसे हार्ड कोड किया गया है, तो आपको उन्हें अपडेट करना होगा:
  • AtomPub नाम स्थान (प्रीफ़िक्स app) को http://purl.org/atom/app से बदलकर http://www.w3.org/2007/app कर दिया गया है.
  • OpenSearch नेमस्पेस (प्रीफ़िक्स openSearch) को http://a9.com/-/spec/opensearchrss/1.0/ से बदलकर http://a9.com/-/spec/opensearch/1.1/ कर दिया गया है.