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

इस गाइड में, अनुरोध और रिस्पॉन्स के मुख्य तरीकों के बारे में बताया गया है. ये तरीके, 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 body दिखाते हैं. इसमें response ऑब्जेक्ट की सूची होती है. अन्य अनुरोधों के लिए, जानकारी दिखाने की ज़रूरत नहीं होती और कोई रिप्लाई नहीं दिखाया जाता. रिस्पॉन्स सूची में मौजूद ऑब्जेक्ट, उसी इंडेक्स क्रम में होते हैं जो संबंधित अनुरोध में होता है.

एक साथ कई अनुरोध करने के लिए, एक लोकप्रिय पैटर्न कुछ ऐसा दिखता है:

requests = []
requests.append(first request)
requests.append(second request)
...

body = ... & requests & ...

...batchUpdate(body)

Docs के एपीआई कॉल को एक साथ करने का तरीका जानने के लिए, बैच रिक्वेस्ट के सबसे सही तरीके देखें. साथ ही, अनुरोध और जवाब के टाइप के लिए, documents.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