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 है, तो इसे अनदेखा कर दिया जाता है. तारीख और समय के रेंडर होने का डिफ़ॉल्ट विकल्प 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 मौजूद होता है.