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