Method: spreadsheets.getByDataFilter

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

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

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

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

  • includeGridData पैरामीटर को true पर सेट करें. अगर फ़ील्ड मास्क सेट किया गया है, तो 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

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

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

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

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

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

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

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