Method: documents.batchUpdate

दस्तावेज़ में एक या उससे ज़्यादा अपडेट लागू करता है.

लागू करने से पहले, हर request की पुष्टि की जाती है. अगर कोई अनुरोध अमान्य है, तो पूरा अनुरोध पूरा नहीं होगा और कुछ भी लागू नहीं होगा.

कुछ अनुरोधों के बगल में replies होता है. इससे आपको यह जानकारी मिलती है कि उन्हें कैसे लागू किया जाता है. अन्य अनुरोधों के लिए जानकारी देने की ज़रूरत नहीं है. ये सभी खाली जवाब देते हैं. जवाबों का क्रम, अनुरोधों के क्रम से मेल खाता है.

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

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

एचटीटीपी अनुरोध

POST https://docs.googleapis.com/v1/documents/{documentId}:batchUpdate

यूआरएल में gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल किया गया है.

पाथ पैरामीटर

पैरामीटर
documentId

string

अपडेट किए जाने वाले दस्तावेज़ का आईडी.

अनुरोध का मुख्य भाग

अनुरोध के मुख्य भाग में नीचे दिए गए स्ट्रक्चर वाला डेटा होता है:

JSON के काेड में दिखाना 
{
  "requests": [
    {
      object (Request)
    }
  ],
  "writeControl": {
    object (WriteControl)
  }
}
फ़ील्ड
requests[]

object (Request)

दस्तावेज़ में लागू किए जाने वाले अपडेट की सूची.
writeControl

object (WriteControl)

यह कंट्रोल करता है कि डेटा लिखने के अनुरोध कैसे लागू किए जाते हैं.

जवाब का मुख्य भाग

documents.batchUpdate के अनुरोध का जवाब.

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

JSON के काेड में दिखाना 
{
  "documentId": string,
  "replies": [
    {
      object (Response)
    }
  ],
  "writeControl": {
    object (WriteControl)
  }
}
फ़ील्ड
documentId

string

उस दस्तावेज़ का आईडी जिस पर अपडेट लागू किए गए थे.
replies[]

object (Response)

अपडेट का जवाब. यह अपडेट के साथ 1:1 मैप करता है. हालांकि, कुछ अनुरोधों के जवाब खाली हो सकते हैं.
writeControl

object (WriteControl)

अनुरोध लागू करने के बाद, अपडेट किया गया लिखने का कंट्रोल.

अनुमति के दायरे

इसके लिए, OAuth के इनमें से किसी एक स्कोप की ज़रूरत होती है:

  • https://www.googleapis.com/auth/documents
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file

ज़्यादा जानकारी के लिए, अनुमति से जुड़ी गाइड देखें.

WriteControl

यह कंट्रोल करता है कि डेटा लिखने के अनुरोध कैसे लागू किए जाते हैं.

JSON के काेड में दिखाना 
{

  // Union field control can be only one of the following:
  "requiredRevisionId": string,
  "targetRevisionId": string
  // End of list of possible types for union field control.
}
फ़ील्ड
यूनियन फ़ील्ड control. यह तय करता है कि दस्तावेज़ के किस वर्शन में डेटा लिखा जाए. साथ ही, यह भी तय करता है कि अगर वह वर्शन, दस्तावेज़ का मौजूदा वर्शन नहीं है, तो अनुरोध का क्या करना चाहिए. अगर कोई भी फ़ील्ड तय नहीं किया गया है, तो अपडेट सबसे नए बदलाव पर लागू होते हैं. control इनमें से कोई एक हो सकता है:
requiredRevisionId

string

उस दस्तावेज़ का revision ID जिस पर लिखने का अनुरोध लागू किया गया है. यह revision ID ज़रूरी नहीं है. अगर यह दस्तावेज़ का नया वर्शन नहीं है, तो अनुरोध प्रोसेस नहीं किया जाता और 400 गलत अनुरोध वाली गड़बड़ी का मैसेज दिखता है.

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

string

उस दस्तावेज़ का वैकल्पिक टारगेट revision ID जिस पर लिखने का अनुरोध लागू किया गया है.

अगर एपीआई का इस्तेमाल करके दस्तावेज़ को पढ़ने के बाद, सहयोगी ने उसमें बदलाव किए हैं, तो लिखने के इस अनुरोध से किए गए बदलाव, सहयोगी के बदलावों के बाद लागू होते हैं. इससे दस्तावेज़ का नया वर्शन बन जाता है. इसमें, साथ मिलकर काम करने वाले व्यक्ति के बदलाव और अनुरोध में किए गए बदलाव, दोनों शामिल होते हैं. साथ ही, Docs सर्वर, एक-दूसरे से मेल न खाने वाले बदलावों को ठीक कर देता है. टारगेट रिविज़न आईडी का इस्तेमाल करते समय, एपीआई क्लाइंट को दस्तावेज़ के साथ काम करने वाले किसी अन्य व्यक्ति के तौर पर देखा जा सकता है.

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