शुरुआती जानकारी

Google Docs API से, आपको दस्तावेज़ बनाने और उनमें बदलाव करने की सुविधा मिलती है.

ऐप्लिकेशन, उपयोगकर्ता और सिस्टम से मिले डेटा, दोनों से बेहतर दस्तावेज़ बनाने के लिए Docs API के साथ इंटिग्रेट कर सकते हैं. एपीआई की मदद से ये काम किए जा सकते हैं:

  • प्रोसेस अपने-आप होना
  • एक साथ कई दस्तावेज़ बनाएं
  • इनवॉइस या कॉन्ट्रैक्ट जनरेट करें

एपीआई की खास जानकारी

दस्तावेज़ संसाधन से, Docs API को शुरू करने के तरीक़ों की जानकारी मिलती है.

एपीआई के तरीके

नीचे दिए गए तरीकों की मदद से, Google Docs दस्तावेज़ बनाए जा सकते हैं, उन्हें पढ़ा जा सकता है, और अपडेट किया जा सकता है:

  • दस्तावेज़ बनाने के लिए, documents.create का इस्तेमाल करें.
  • किसी तय दस्तावेज़ का कॉन्टेंट वापस पाने के लिए, documents.get का इस्तेमाल करें.
  • किसी दस्तावेज़ पर अपडेट का सेट अपने-आप पूरा करने के लिए, documents.batchUpdate का इस्तेमाल करें.

टारगेट दस्तावेज़ के बारे में बताने के लिए, get और batchUpdate तरीकों को पैरामीटर के तौर पर documentId (नीचे देखें) की ज़रूरत होती है. create का तरीका, बनाए गए दस्तावेज़ का एक इंस्टेंस दिखाता है, जिससे आईडी को पढ़ा जा सकता है.

बैच अपडेट

batchUpdate का तरीका, अनुरोध के लिए ऑब्जेक्ट की सूची बनाता है. इस सूची में, उसी क्रम में अपडेट किए जाते हैं जिस क्रम में वे बैच अनुरोध में दिखते हैं. बैच अपडेट में मौजूद अपडेट, एटॉमल रूप से लागू किए जाते हैं. इसका मतलब है कि अगर कोई अनुरोध मान्य नहीं है, तो पूरा अपडेट पूरा नहीं हो पाता और कोई भी (संभावित तौर पर निर्भर) बदलाव लागू नहीं होता है.

batchUpdate तरीका, रिस्पॉन्स ऑब्जेक्ट की सूची दिखाता है. इस सूची में मौजूद ऑब्जेक्ट, संबंधित अनुरोध की तरह ही इंडेक्स क्रम में रखते हैं.

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

दस्तावेज़ आईडी

दस्तावेज़ आईडी किसी दस्तावेज़ का रेफ़रंस देते हैं और उन्हें यूआरएल से लिया जा सकता है:

https://docs.google.com/document/d/documentId/edit

documentId एक खास स्ट्रिंग होती है, जिसमें अक्षर, संख्या, और कुछ खास वर्ण होते हैं. नीचे दिए गए रेगुलर एक्सप्रेशन का इस्तेमाल Google Docs यूआरएल से दस्तावेज़ आईडी निकालने के लिए किया जा सकता है:

/document/d/([a-zA-Z0-9-_]+)

अगर आप Google Drive API के बारे में जानते हैं, तो documentId, फ़ाइल संसाधन के आईडी से जुड़ा होता है.

दस्तावेज़ में जगहें: इंडेक्स

जब किसी दस्तावेज़ के कॉन्टेंट में बदलाव किया जाता है, तो हर अपडेट किसी जगह पर या दस्तावेज़ में किसी भी रेंज में होता है. इन जगहों और रेंज को indexes का इस्तेमाल करके तय किया जाता है, जो कि एक शामिल दस्तावेज़ सेगमेंट में ऑफ़सेट को दिखाता है. इंडेक्स और उन्हें इस्तेमाल करने के तरीके के बारे में ज़्यादा जानने के लिए, Google Docs के दस्तावेज़ का स्ट्रक्चर कॉन्सेप्ट गाइड देखें.

दस्तावेज़ अपडेट करने का वर्कफ़्लो

नया दस्तावेज़ बनाना और उसमें अपने-आप जानकारी भरने की प्रोसेस आसान है. ऐसा इसलिए, क्योंकि चिंता करने की कोई बात मौजूद नहीं है और न ही कोई सहयोगी है जो दस्तावेज़ की स्थिति में बदलाव कर सके. सैद्धान्तिक तौर पर, यह इस क्रम के डायग्राम में काम करता है:

नया दस्तावेज़ बनाने और उसमें जानकारी भरने के लिए वर्कफ़्लो.

किसी मौजूदा दस्तावेज़ को अपडेट करना ज़्यादा मुश्किल है. किसी दस्तावेज़ को अपडेट करने के लिए काम के कॉल करने से पहले, आपको दस्तावेज़ की मौजूदा स्थिति को जानने की ज़रूरत होगी: इसमें कौनसे एलिमेंट शामिल हैं, उन एलिमेंट में क्या कॉन्टेंट है, और ये सभी आइटम दस्तावेज़ में कहां मौजूद हैं. इस क्रम के डायग्राम में बताया गया है कि यह कैसे काम करता है:

दस्तावेज़ को अपडेट करने के लिए वर्कफ़्लो.

इस डायग्राम में ऐसे वर्कफ़्लो को शामिल नहीं किया गया है जिनमें एक ही दस्तावेज़ में, अन्य सहयोगियों के साथ मिलकर काम करने वाले अपडेट किए गए हों. इस विषय पर चर्चा करने के लिए, साथ मिलकर काम करने की योजना बनाएं.