इस गाइड में Google Docs API के मुख्य अनुरोध और रिस्पॉन्स के तरीकों के बारे में बताया गया है. साथ ही, यह भी बताया गया है कि किसी दस्तावेज़ को बैच में कैसे अपडेट किया जा सकता है.
Google Docs API को शुरू करने के लिए, एचटीटीपी अनुरोध का इस्तेमाल किया जा सकता है. इसके अलावा, किसी खास भाषा में क्लाइंट लाइब्रेरी में, शुरू करने के तरीके का इस्तेमाल किया जा सकता है. मोटे तौर पर, ये दोनों शर्तें एक जैसी हैं.
Google Docs API एक एचटीटीपी रिस्पॉन्स दिखाता है, जिसमें आम तौर पर अनुरोध शुरू करने का नतीजा शामिल होता है. अनुरोध करने के लिए क्लाइंट लाइब्रेरी का इस्तेमाल करते समय, जवाब एक भाषा के हिसाब से दिए जाते हैं.
अनुरोध के तरीके
Docs API में, ये तरीके इस्तेमाल किए जा सकते हैं:
documents.create: कोई खाली Google Docs दस्तावेज़ बनाएं.documents.get: तय किए गए दस्तावेज़ का पूरा इंस्टेंस दिखाएं. दस्तावेज़ के कॉन्टेंट, फ़ॉर्मैटिंग, और दूसरी सुविधाओं को एक्सट्रैक्ट करने के लिए, लौटाए गए JSON को पार्स किया जा सकता है.documents.batchUpdate: दस्तावेज़ में अपने-आप लागू होने के लिए, बदलाव करने के अनुरोधों की सूची सबमिट करें और नतीजों की सूची दें.
टारगेट दस्तावेज़ की जानकारी देने के लिए, documents.get और documents.batchUpdate तरीकों को पैरामीटर के तौर पर documentId की ज़रूरत होती है. documents.create तरीका, बनाए गए दस्तावेज़ का एक इंस्टेंस दिखाता है, जिसमें से documentId को पढ़ा जा सकता है. documentId के बारे में ज़्यादा जानकारी के लिए, दस्तावेज़ आईडी देखें.
बैच अपडेट
documents.batchUpdate तरीका, request ऑब्जेक्ट की एक सूची लेता है. हर ऑब्जेक्ट, एक अनुरोध करता है. उदाहरण के लिए, पहले पैराग्राफ़ को फ़ॉर्मैट करें और फिर
इनलाइन इमेज जोड़ें. हर अनुरोध को लागू किए जाने से पहले उसकी पुष्टि की जाती है.
साथ ही, अनुरोधों को उसी क्रम में प्रोसेस किया जाता है जिस क्रम में वे बैच रिक्वेस्ट में दिखते हैं.
बैच अपडेट के सभी अनुरोध अपने आप लागू हो जाते हैं. इसका मतलब है कि अगर कोई अनुरोध मान्य नहीं है, तो पूरा अपडेट पूरा नहीं होता और कोई भी (संभावित निर्भर) बदलाव लागू नहीं किए जाते.
कुछ documents.batchUpdate तरीके, लागू किए गए अनुरोधों के बारे में जानकारी के साथ जवाब देते हैं. इन तरीकों से, ऐसा रिस्पॉन्स बॉडी मिलता है जिसमें response ऑब्जेक्ट की सूची होती है. अन्य अनुरोधों को जानकारी लौटाने और खाली
जवाब दिखाने की ज़रूरत नहीं होती. जवाब की सूची में मौजूद ऑब्जेक्ट, संबंधित अनुरोध की तरह ही इंडेक्स क्रम का इस्तेमाल करते हैं.
बैच अनुरोध करने का लोकप्रिय पैटर्न इस तरह दिखता है:
requests = []
requests.append(first request)
requests.append(second request)
...
body = ... & requests & ...
...batchUpdate(body)
Docs API कॉल को एक साथ करने के तरीके से जुड़ी पूरी जानकारी पाने के लिए, बैच के लिए अनुरोध करने के सबसे सही तरीके देखें. साथ ही, अनुरोध और जवाब के टाइप से जुड़े दस्तावेज़ documents.batchUpdate देखें.
बैच अपडेट कार्रवाइयां
बैच अपडेट करने के अनुरोध कई तरह के होते हैं. यहां अनुरोध के टाइप के बारे में बताया गया है. साथ ही, इन्हें अलग-अलग कैटगरी में बांटा गया है.