Method: spreadsheets.getByDataFilter

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

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

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

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

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

बड़ी स्प्रेडशीट के लिए, सबसे सही तरीके के तौर पर, सिर्फ़ अपनी पसंद के खास स्प्रेडशीट फ़ील्ड फिर से पाएं.

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

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

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

पाथ पैरामीटर

पैरामीटर
spreadsheetId

string

अनुरोध के लिए स्प्रेडशीट.

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

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

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

object (DataFilter)

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

includeGridData

boolean

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

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

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

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

इनमें से किसी एक OAuth दायरे की ज़रूरत होती है:

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

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