अनुरोध और जवाब

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

अगर हो सके, तो एक से ज़्यादा अनुरोधों को एक कॉल में ग्रुप करने के लिए, batchUpdate का इस्तेमाल करें. इससे कोटा बचता है और परफ़ॉर्मेंस बेहतर हो सकती है. ज़्यादा जानकारी के लिए, इस्तेमाल की सीमाएं देखें.

एक साथ कई आइटम अपडेट करने की कार्रवाइयां

एक साथ कई आइटम अपडेट करने के कई तरह के अनुरोध होते हैं. यहां अलग-अलग कैटगरी में बांटकर, अनुरोध के टाइप के बारे में जानकारी दी गई है.

ऑब्जेक्ट	जोड़ें / डालें	अपडेट करना / बदलना	मिटाएं
टेक्स्ट	InsertTextRequest	ReplaceAllTextRequest
स्टाइल	CreateParagraphBulletsRequest	UpdateTextStyleRequest UpdateParagraphStyleRequest UpdateTableCellStyleRequest UpdateTableRowStyleRequest UpdateDocumentStyleRequest UpdateSectionStyleRequest	DeleteParagraphBulletsRequest
नाम वाली रेंज	CreateNamedRangeRequest	ReplaceNamedRangeContentRequest	DeleteNamedRangeRequest DeleteContentRangeRequest
इमेज	InsertInlineImageRequest	ReplaceImageRequest
टेबल	InsertTableRequest InsertTableRowRequest InsertTableColumnRequest	UpdateTableColumnPropertiesRequest MergeTableCellsRequest UnmergeTableCellsRequest PinTableHeaderRowsRequest	DeleteTableRowRequest DeleteTableColumnRequest
पेज ऑब्जेक्ट (इसमें हेडर और फ़ुटर शामिल हैं)	InsertPageBreakRequest CreateHeaderRequest CreateFooterRequest CreateFootnoteRequest InsertSectionBreakRequest		DeletePositionedObjectRequest DeleteHeaderRequest DeleteFooterRequest

मिलते-जुलते विषय

• Google Docs दस्तावेज़ का स्ट्रक्चर
• स्ट्रक्चर में बदलाव करने के नियम और व्यवहार
• एक साथ कई अनुरोध करना