Method: documents.batchUpdate

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

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

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

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

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

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

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 खराब अनुरोध की गड़बड़ी दिखाता है.

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

string

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

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

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