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)
  },
  "suggestionResponses": [
    {
      object (SuggestionResponse)
    }
  ],
  "commentUpdateState": enum (CommentUpdateState)
}
फ़ील्ड
documentId

string

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

object (Response)

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

object (WriteControl)

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

object (SuggestionResponse)

वे सुझाव जिन पर हर अपडेट का असर पड़ा. यह अपडेट के साथ 1:1 मैप करता है.
commentUpdateState

enum (CommentUpdateState)

बैच अनुरोध में टिप्पणी के अपडेट लागू किए गए थे या नहीं.

अनुमति पाने के लिंक

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

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

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

WriteControl

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

JSON के काेड में दिखाना 
{
  "writeMode": enum (WriteMode),

  "requiredRevisionId": string,
  "targetRevisionId": string
}
फ़ील्ड
writeMode

enum (WriteMode)

दस्तावेज़ में अनुरोध किए गए अपडेट कैसे लागू किए जाने चाहिए.

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

string

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

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

string

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

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

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

WriteMode

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

Enums
WRITE_MODE_UNSPECIFIED राइट मोड के बारे में नहीं बताया गया है. डिफ़ॉल्ट रूप से, EDIT के तरीके का इस्तेमाल किया जाता है.
EDIT सभी अपडेट को सामान्य बदलावों के तौर पर लागू करें.
SUGGEST सभी अपडेट को सुझाव के तौर पर लागू करें.

SuggestionResponse

वे सुझाव जिन पर किसी अपडेट का असर पड़ा है.

JSON के काेड में दिखाना 
{
  "createdSuggestionIds": [
    string
  ],
  "updatedSummarySuggestionIds": [
    string
  ],
  "deletedSuggestionIds": [
    string
  ],
  "acceptedSuggestionIds": [
    string
  ],
  "rejectedSuggestionIds": [
    string
  ]
}
फ़ील्ड
createdSuggestionIds[]

string

अपडेट के दौरान बनाए गए सुझावों के आईडी.
updatedSummarySuggestionIds[]

string

उन सुझावों के आईडी जिनकी खास जानकारी को अपडेट के दौरान अपडेट किया गया था.
deletedSuggestionIds[]

string

अपडेट के दौरान मिटाए गए सुझावों के आईडी.
acceptedSuggestionIds[]

string

अपडेट के दौरान स्वीकार किए गए सुझावों के आईडी.
rejectedSuggestionIds[]

string

उन सुझावों के आईडी जिन्हें अपडेट के दौरान अस्वीकार कर दिया गया था.

CommentUpdateState

बैच अनुरोध में टिप्पणी के अपडेट का स्टेटस.

Enums
COMMENT_UPDATE_STATE_UNSPECIFIED टिप्पणी के अपडेट की स्थिति के बारे में कोई जानकारी नहीं है.
NO_UPDATES_REQUESTED बैच अनुरोध में, टिप्पणी से जुड़े किसी अपडेट का अनुरोध नहीं किया गया था.
ALL_SAVED टिप्पणी से जुड़े अपडेट के सभी अनुरोध, बैच अनुरोध में लागू कर दिए गए हैं.
ALL_FAILED_UNKNOWN_REASON टिप्पणी में किए गए सभी अनुरोधित बदलाव नहीं किए जा सके.