Method: spreadsheets.getByDataFilter

दिए गए आईडी पर मौजूद स्प्रेडशीट दिखाता है. कॉल करने वाले को स्प्रेडशीट आईडी बताना होगा.

यह तरीका, spreadsheets.get से अलग है. इसकी मदद से, dataFilters पैरामीटर की मदद से यह चुना जा सकता है कि स्प्रेडशीट डेटा के कौनसे सबसेट दिखाने हैं. एक से ज़्यादा DataFilters तय किए जा सकते हैं. एक या उससे ज़्यादा डेटा फ़िल्टर तय करने पर, स्प्रेडशीट के वे हिस्से दिखते हैं जो किसी भी फ़िल्टर से मैच होने वाली रेंज से इंटरसेक्शन करते हैं.

डिफ़ॉल्ट रूप से, ग्रिड में मौजूद डेटा नहीं दिखाया जाता. ग्रिड डेटा को इनमें से किसी एक तरीके से शामिल किया जा सकता है:

  • एचटीटीपी में fields यूआरएल पैरामीटर का इस्तेमाल करके, अपने पसंदीदा फ़ील्ड की सूची बनाने के लिए फ़ील्ड मास्क तय करें

  • includeGridData पैरामीटर को 'सही' पर सेट करें. अगर कोई फ़ील्ड मास्क सेट है, तो includeGridData पैरामीटर को अनदेखा कर दिया जाता है

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

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

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

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

पाथ पैरामीटर

पैरामीटर
spreadsheetId

string

वह स्प्रेडशीट जिसका अनुरोध करना है.

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

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

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

object (DataFilter)

DataFilters का इस्तेमाल करके, यह चुना जाता है कि स्प्रेडशीट से कौनसी रेंज वापस लाई जाएंगी.

includeGridData

boolean

अगर ग्रिड डेटा दिखाना है, तो True पर सेट करें. अगर अनुरोध में फ़ील्ड मास्क सेट किया गया है, तो इस पैरामीटर को अनदेखा कर दिया जाता है.

excludeTablesInBandedRanges

boolean

अगर टेबल को बैंड की गई रेंज में शामिल नहीं करना है, तो True पर सेट करें. अगर इसकी वैल्यू सेट नहीं की गई है, तो यह 'गलत है' पर सेट होती है.

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

कामयाब रहने पर, जवाब के मुख्य हिस्से में Spreadsheet का एक इंस्टेंस शामिल किया जाता है.

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

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

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

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