सबसे अच्छे नतीजों के लिए सबसे सही तरीके

Google Docs API का इस्तेमाल करते समय, आपको कई सिद्धांतों का पालन करना चाहिए. इनमें शामिल हैं:

  • परफ़ॉर्मेंस के लिए, पीछे की ओर बदलाव करें
  • साथ मिलकर काम करने का प्लान बनाएं
  • का इस्तेमाल करके पक्का करें कि राज्य एक जैसा है WriteControl फ़ील्ड
  • टैब को ध्यान में रखें

इन सेक्शन में इन सिद्धांतों के बारे में बताया गया है.

परफ़ॉर्मेंस के लिए, पीछे की ओर बदलाव करें

बस एक कॉल में documents.batchUpdate तरीका है, तो अपने अनुरोधों को इंडेक्स की जगह का घटता क्रम. इससे अलग-अलग सोर्स से पता लगाने की ज़रूरत नहीं पड़ती. प्रविष्टि और हटाने के कारण सूची में हुए परिवर्तन.

साथ मिलकर काम करने का प्लान बनाएं

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

किसी दस्तावेज़ के दूसरे तरीके के कॉल में किस तरह बदलाव हो सकता है.

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

WriteControl की मदद से स्थिति को एक जैसा बनाए रखना

किसी दस्तावेज़ को पढ़ने के बाद उसे अपडेट करने पर, प्रतिस्पर्धी बदलावों को WriteControl फ़ील्ड की वैल्यू को documents.batchUpdate तरीके में सेट करें. WriteControl अधिकार देता है लिखने के अनुरोधों को कैसे रन किया जाएगा.

यहां इसका इस्तेमाल करने का तरीका बताया गया है:

  1. दस्तावेज़ पाने के लिए, documents.get तरीका और सेव करें यह revisionId मिले हुए documents संसाधन से.
  2. अपडेट के अनुरोध लिखें.
  3. वैकल्पिक WriteControl शामिल करें दो विकल्पों में से एक वाला ऑब्जेक्ट:
    1. requiredRevisionId फ़ील्ड कोrevisionId वह दस्तावेज़ जिस पर लिखने का अनुरोध लागू किया गया है. अगर दस्तावेज़ में बदलाव किया गया था एपीआई ने पढ़ने का अनुरोध किया है, इसलिए डेटा एक्सपोर्ट करने के अनुरोध को प्रोसेस नहीं किया गया है कोई गड़बड़ी दिखाता है.
    2. targetRevisionId फ़ील्ड को दस्तावेज़ के revisionId पर सेट किया गया है लिखने का अनुरोध इस पर लागू होता है. अगर दस्तावेज़ एपीआई पढ़ने का अनुरोध, लिखने के अनुरोध से जुड़े बदलाव सहयोगी की सूची में किए गए बदलाव. अनुरोध के नतीजे में ये दोनों चीज़ें शामिल होती हैं लिखने का अनुरोध और सहयोगी, दस्तावेज़ का संशोधन. दस्तावेज़ सर्वर ज़िम्मेदार है का इस्तेमाल करें.

WriteControl का इस्तेमाल करके, बैच रिक्वेस्ट बनाने के उदाहरण के लिए, देखें इस बैच अनुरोध का उदाहरण.

टैब को ध्यान में रखें

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

यहां बताया गया है कि आपको क्या याद रखना है:

  1. includeTabsContent पैरामीटर को true पर सेट करें. इसके लिए, documents.get तरीका किसी दस्तावेज़ में सभी टैब से कॉन्टेंट वापस पाने के लिए. डिफ़ॉल्ट रूप से, सभी टैब नहीं कॉन्टेंट लौटाया जाता है.
  2. हर एक Request को लागू करने के लिए टैब के आईडी तय करें के लिए documents.batchUpdate तरीका. हर Request इसमें अपडेट लागू करने के लिए, टैब तय करने का तरीका शामिल है. डिफ़ॉल्ट रूप से, अगर कोई टैब निर्दिष्ट नहीं किया गया है, Request ज़्यादातर मामलों में दस्तावेज़ के पहले टैब पर लागू होगा. देखें Request से॰ दस्तावेज़ देखें.