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 पर सेट किया गया हो.