Method: spreadsheets.values.batchUpdateByDataFilter

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

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

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

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

पाथ पैरामीटर

पैरामीटर
spreadsheetId

string

उस स्प्रेडशीट का आईडी जिसे अपडेट करना है.

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

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

जेएसओएन के काेड में दिखाना
{
  "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 रेंडर करने का विकल्प है.

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

किसी स्प्रेडशीट में वैल्यू की रेंज अपडेट करते समय दिया गया जवाब.

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

जेएसओएन के काेड में दिखाना
{
  "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

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

डेटा फ़िल्टर की वैल्यू की सीमा

वैल्यू की ऐसी रेंज जिनकी जगह की जानकारी DataFilter ने दी हो.

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

object (DataFilter)

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

majorDimension

enum (Dimension)

वैल्यू का मेजर डाइमेंशन.

values[]

array (ListValue format)

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

UpdateValuesByDataFilterResponse

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

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

string

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

updatedRows

integer

पंक्ति की कम से कम एक सेल की अपडेट की गई संख्या.

updatedColumns

integer

कॉलम की संख्या, जहां कॉलम में कम से कम एक सेल अपडेट किया गया था.

updatedCells

integer

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

dataFilter

object (DataFilter)

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

updatedData

object (ValueRange)

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