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 जिस पर लिखने का अनुरोध लागू किया गया है. यह ज़रूरी नहीं है. अगर यह दस्तावेज़ का नया वर्शन नहीं है, तो अनुरोध को प्रोसेस नहीं किया जाता है. साथ ही, गड़बड़ी का मैसेज '400 Bad Request' मिलता है.

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

string

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

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

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