इस गाइड में, Google Docs API के मुख्य अनुरोध और रिस्पॉन्स के तरीकों के बारे में बताया गया है. साथ ही, यह भी बताया गया है कि किसी दस्तावेज़ को बैच में कैसे अपडेट किया जा सकता है.
Google Docs API को शुरू करने के लिए, एचटीटीपी अनुरोध का इस्तेमाल किया जा सकता है. इसके अलावा, किसी खास भाषा की क्लाइंट लाइब्रेरी में शुरू करने के तरीके का इस्तेमाल करके भी इसे शुरू किया जा सकता है. ये मोटे तौर पर एक जैसे हैं.
Google Docs एपीआई एक एचटीटीपी रिस्पॉन्स देता है, जिसमें आम तौर पर अनुरोध किए जाने के नतीजे शामिल होते हैं. अनुरोध करने के लिए क्लाइंट लाइब्रेरी का इस्तेमाल करते समय, रिस्पॉन्स, भाषा के हिसाब से खास तरीके से दिखाए जाते हैं.
अनुरोध के तरीके
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 रेफ़रंस दस्तावेज़ देखें.
बैच अपडेट कार्रवाइयां
एक साथ अपडेट करने के कई तरह के अनुरोध होते हैं. यहां अलग-अलग कैटगरी में बांटे गए अनुरोध टाइप के बारे में ज़्यादा जानकारी दी गई है.
मिलते-जुलते विषय
- Google Docs के दस्तावेज़ का स्ट्रक्चर
- बदलाव करने के बुनियादी नियम और व्यवहार
- एक साथ किए जाने वाले अनुरोध