Method: spreadsheets.values.batchGetByDataFilter

यह फ़ंक्शन, तय किए गए डेटा फ़िल्टर से मेल खाने वाली वैल्यू की एक या उससे ज़्यादा रेंज दिखाता है. ज़्यादा जानकारी के लिए, मेटाडेटा को पढ़ना, लिखना, और खोजना लेख पढ़ें.

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

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

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

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

पाथ पैरामीटर

पैरामीटर
spreadsheetId

string

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

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

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

JSON के काेड में दिखाना
{
  "dataFilters": [
    {
      object (DataFilter)
    }
  ],
  "majorDimension": enum (Dimension),
  "valueRenderOption": enum (ValueRenderOption),
  "dateTimeRenderOption": enum (DateTimeRenderOption)
}
फ़ील्ड
dataFilters[]

object (DataFilter)

डेटा फ़िल्टर का इस्तेमाल, वैल्यू की उन रेंज को मैच करने के लिए किया जाता है जिन्हें वापस पाना है. जवाब में, वे रेंज शामिल होती हैं जो बताए गए किसी भी डेटा फ़िल्टर से मेल खाती हैं.

majorDimension

enum (Dimension)

वह मुख्य डाइमेंशन जिसका इस्तेमाल नतीजों में किया जाना चाहिए.

उदाहरण के लिए, अगर स्प्रेडशीट का डेटा A1=1,B1=2,A2=3,B2=4 है, तो उस रेंज को चुनने और majorDimension=ROWS सेट करने का अनुरोध करने पर, [[1,2],[3,4]] मिलता है. वहीं, majorDimension=COLUMNS सेट करने का अनुरोध करने पर, [[1,3],[2,4]] मिलता है.

valueRenderOption

enum (ValueRenderOption)

आउटपुट में वैल्यू कैसे दिखाई जानी चाहिए. डिफ़ॉल्ट रेंडर विकल्प FORMATTED_VALUE है.

dateTimeRenderOption

enum (DateTimeRenderOption)

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

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

DataFilters से चुनी गई स्प्रेडशीट में, वैल्यू की एक से ज़्यादा रेंज वापस पाने पर मिलने वाला जवाब.

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

JSON फ़ॉर्मैट में दिखाया गया है
{
  "spreadsheetId": string,
  "valueRanges": [
    {
      object (MatchedValueRange)
    }
  ]
}
फ़ील्ड
spreadsheetId

string

उस स्प्रेडशीट का आईडी जिससे डेटा वापस पाया गया था.

valueRanges[]

object (MatchedValueRange)

अनुरोध की गई वैल्यू और उनसे मेल खाने वाले डेटा फ़िल्टर की सूची.

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

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

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

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

MatchedValueRange

वैल्यू की वह रेंज जिससे एक या उससे ज़्यादा डेटा फ़ाइलर का मिलान हुआ है.

JSON के काेड में दिखाना
{
  "valueRange": {
    object (ValueRange)
  },
  "dataFilters": [
    {
      object (DataFilter)
    }
  ]
}
फ़ील्ड
valueRange

object (ValueRange)

DataFilter से मैच की गई वैल्यू.

dataFilters[]

object (DataFilter)

अनुरोध में मौजूद वह DataFilters जो वैल्यू की रेंज से मेल खाता है.