Method: spreadsheets.values.batchUpdateByDataFilter

स्प्रेडशीट की एक या उससे ज़्यादा रेंज में वैल्यू सेट करता है. कॉलर को स्प्रेडशीट आईडी, एक valueInputOption, और एक या उससे ज़्यादा DataFilterValueRanges बताने होंगे.

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

POST https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/values:batchUpdateByDataFilter

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

पाथ पैरामीटर

पैरामीटर
spreadsheetId

string

अपडेट की जाने वाली स्प्रेडशीट का आईडी.

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

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

JSON के काेड में दिखाना 
{
  "valueInputOption": enum (ValueInputOption),
  "data": [
    {
      object (DataFilterValueRange)
    }
  ],
  "includeValuesInResponse": boolean,
  "responseValueRenderOption": enum (ValueRenderOption),
  "responseDateTimeRenderOption": enum (DateTimeRenderOption)
}
फ़ील्ड
valueInputOption

enum (ValueInputOption)

इनपुट डेटा को कैसे समझा जाना चाहिए.
data[]

object (DataFilterValueRange)

स्प्रेडशीट में लागू की जाने वाली नई वैल्यू. अगर तय की गई DataFilter से एक से ज़्यादा रेंज मैच होती हैं, तो तय की गई वैल्यू उन सभी रेंज पर लागू होती हैं.
includeValuesInResponse

boolean

यह तय करता है कि अपडेट के जवाब में, अपडेट की गई सेल की वैल्यू शामिल होनी चाहिए या नहीं. डिफ़ॉल्ट रूप से, जवाबों में अपडेट की गई वैल्यू शामिल नहीं होती हैं. हर BatchUpdateValuesResponse.responses में मौजूद updatedData फ़ील्ड में अपडेट की गई वैल्यू होती हैं. अगर लिखी गई रेंज, असल में लिखी गई रेंज से बड़ी थी, तो जवाब में अनुरोध की गई रेंज की सभी वैल्यू शामिल होती हैं. हालांकि, आखिर में मौजूद खाली पंक्तियों और कॉलम को शामिल नहीं किया जाता.
responseValueRenderOption

enum (ValueRenderOption)

इससे यह तय होता है कि रिस्पॉन्स में वैल्यू को कैसे रेंडर किया जाना चाहिए. रेंडर करने का डिफ़ॉल्ट विकल्प FORMATTED_VALUE है.
responseDateTimeRenderOption

enum (DateTimeRenderOption)

इससे यह तय होता है कि जवाब में तारीखों, समय, और अवधियों को कैसे रेंडर किया जाना चाहिए. अगर responseValueRenderOption FORMATTED_VALUE है, तो इसे अनदेखा कर दिया जाता है. dateTime के लिए रेंडर करने का डिफ़ॉल्ट विकल्प SERIAL_NUMBER है.

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

स्प्रेडशीट में वैल्यू की रेंज अपडेट करने पर मिलने वाला रिस्पॉन्स.

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

JSON के काेड में दिखाना 
{
  "spreadsheetId": string,
  "totalUpdatedRows": integer,
  "totalUpdatedColumns": integer,
  "totalUpdatedCells": integer,
  "totalUpdatedSheets": integer,
  "responses": [
    {
      object (UpdateValuesByDataFilterResponse)
    }
  ]
}
फ़ील्ड
spreadsheetId

string

वह स्प्रेडशीट जिसमें अपडेट लागू किए गए थे.
totalUpdatedRows

integer

उन पंक्तियों की कुल संख्या जिनमें कम से कम एक सेल अपडेट की गई थी.
totalUpdatedColumns

integer

उन कॉलम की कुल संख्या जिनमें कॉलम की कम से कम एक सेल अपडेट की गई थी.
totalUpdatedCells

integer

अपडेट की गई सेल की कुल संख्या.
totalUpdatedSheets

integer

उन शीट की कुल संख्या जिनमें शीट की कम से कम एक सेल अपडेट की गई थी.
responses[]

object (UpdateValuesByDataFilterResponse)

हर रेंज के लिए जवाब अपडेट हो गया.

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

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

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

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

DataFilterValueRange

वैल्यू की एक सीमा, जिसकी जगह DataFilter से तय की जाती है.

JSON के काेड में दिखाना 
{
  "dataFilter": {
    object (DataFilter)
  },
  "majorDimension": enum (Dimension),
  "values": [
    array
  ]
}
फ़ील्ड
dataFilter

object (DataFilter)

स्प्रेडशीट में वैल्यू की जगह की जानकारी देने वाला डेटा फ़िल्टर.
majorDimension

enum (Dimension)

वैल्यू का मुख्य डाइमेंशन.
values[]

array (ListValue format)

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

UpdateValuesByDataFilterResponse

स्प्रेडशीट में डेटा फ़िल्टर की मदद से, वैल्यू की रेंज अपडेट करने पर मिलने वाला रिस्पॉन्स.

JSON के काेड में दिखाना 
{
  "updatedRange": string,
  "updatedRows": integer,
  "updatedColumns": integer,
  "updatedCells": integer,
  "dataFilter": {
    object (DataFilter)
  },
  "updatedData": {
    object (ValueRange)
  }
}
फ़ील्ड
updatedRange

string

A1 नोटेशन में वह रेंज जिस पर अपडेट लागू किए गए थे.
updatedRows

integer

उन पंक्तियों की संख्या जिनमें कम से कम एक सेल अपडेट की गई थी.
updatedColumns

integer

उन कॉलम की संख्या जिनमें कॉलम की कम से कम एक सेल अपडेट की गई थी.
updatedCells

integer

अपडेट की गई सेल की संख्या.
dataFilter

object (DataFilter)

वह डेटा फ़िल्टर जिसने अपडेट की गई रेंज को चुना.
updatedData

object (ValueRange)

सभी अपडेट लागू होने के बाद, dataFilter से मैच होने वाली रेंज में सेल की वैल्यू. यह सिर्फ़ तब शामिल किया जाता है, जब अनुरोध का includeValuesInResponse फ़ील्ड true था.