Class DataSourceSheet

DataSourceSheet

मौजूदा डेटा सोर्स शीट को ऐक्सेस करें और उसमें बदलाव करें. नई डेटा सोर्स शीट बनाने के लिए, Spreadsheet.insertDataSourceSheet(spec) का इस्तेमाल करें.

इस क्लास का इस्तेमाल सिर्फ़ ऐसे डेटा के साथ करें जो डेटाबेस से कनेक्ट हो.

तरीके

तरीकारिटर्न टाइपसंक्षिप्त विवरण
addFilter(columnName, filterCriteria)DataSourceSheetडेटा सोर्स की शीट पर लागू किया गया फ़िल्टर जोड़ता है.
asSheet()Sheetडेटा सोर्स की शीट को सामान्य शीट ऑब्जेक्ट के तौर पर दिखाता है.
autoResizeColumn(columnName)DataSourceSheetतय किए गए कॉलम की चौड़ाई को अपने-आप बदल देता है.
autoResizeColumns(columnNames)DataSourceSheetतय किए गए कॉलम की चौड़ाई का साइज़ अपने-आप बदल देता है.
cancelDataRefresh()DataSourceSheetअगर इस ऑब्जेक्ट का डेटा अभी चालू है, तो इससे जुड़ा डेटा रीफ़्रेश होना रद्द हो जाता है.
forceRefreshData()DataSourceSheetइस ऑब्जेक्ट के डेटा को रीफ़्रेश करता है, भले ही मौजूदा स्थिति कुछ भी हो.
getColumnWidth(columnName)Integerतय किए गए कॉलम की चौड़ाई दिखाता है.
getDataSource()DataSourceउस डेटा सोर्स को फ़ेच करता है जिससे ऑब्जेक्ट लिंक किया गया है.
getFilters()DataSourceSheetFilter[]डेटा सोर्स की शीट पर लगाए गए सभी फ़िल्टर दिखाता है.
getSheetValues(columnName)Object[]दिए गए कॉलम के नाम के लिए, डेटा सोर्स शीट की सभी वैल्यू दिखाता है.
getSheetValues(columnName, startRow, numRows)Object[]यह फ़ंक्शन दिए गए कॉलम के नाम के लिए, डेटा सोर्स शीट की सभी वैल्यू दिखाता है. यह वैल्यू दी गई शुरुआती पंक्ति (आधारित 1) और दी गई numRows तक की होती है.
getSortSpecs()SortSpec[]डेटा सोर्स शीट में क्रम से लगाने के सभी निर्देश देता है.
getStatus()DataExecutionStatusऑब्जेक्ट के डेटा एक्ज़ीक्यूशन की स्थिति की जानकारी देता है.
refreshData()DataSourceSheetऑब्जेक्ट का डेटा रीफ़्रेश करता है.
removeFilters(columnName)DataSourceSheetडेटा सोर्स की शीट के कॉलम पर लगाए गए सभी फ़िल्टर हटा देता है.
removeSortSpec(columnName)DataSourceSheetडेटा सोर्स शीट में कॉलम का क्रम तय करने का तरीका हटा दिया जाता है.
setColumnWidth(columnName, width)DataSourceSheetबताए गए कॉलम की चौड़ाई सेट करता है.
setColumnWidths(columnNames, width)DataSourceSheetबताए गए कॉलम की चौड़ाई सेट करता है.
setSortSpec(columnName, ascending)DataSourceSheetडेटा सोर्स शीट में किसी कॉलम पर, क्रम से लगाने का तरीका सेट करता है.
setSortSpec(columnName, sortOrder)DataSourceSheetडेटा सोर्स शीट में किसी कॉलम पर, क्रम से लगाने का तरीका सेट करता है.
waitForCompletion(timeoutInSeconds)DataExecutionStatusमौजूदा निष्पादन पूरा होने तक इंतज़ार करता है, दिए गए सेकंड के बाद टाइम आउट हो जाता है.

ज़्यादा जानकारी वाला दस्तावेज़

addFilter(columnName, filterCriteria)

डेटा सोर्स की शीट पर लागू किया गया फ़िल्टर जोड़ता है.

पैरामीटर

नामटाइपब्यौरा
columnNameStringउस कॉलम का नाम जिस पर यह फ़िल्टर लागू करना है.
filterCriteriaFilterCriteriaलागू करने के लिए फ़िल्टर की शर्तें.

रिटर्न

DataSourceSheet — मेथड चेन के लिए डेटा सोर्स शीट.

अनुमति

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, इनमें से एक या उससे ज़्यादा दायरे के साथ अनुमति देना ज़रूरी होता है:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

asSheet()

डेटा सोर्स की शीट को सामान्य शीट ऑब्जेक्ट के तौर पर दिखाता है.

रिटर्न

Sheet — सामान्य शीट.

अनुमति

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, इनमें से एक या उससे ज़्यादा दायरे के साथ अनुमति देना ज़रूरी होता है:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

autoResizeColumn(columnName)

तय किए गए कॉलम की चौड़ाई को अपने-आप बदल देता है.

पैरामीटर

नामटाइपब्यौरा
columnNameStringकॉलम का नाम.

रिटर्न

DataSourceSheet — यह डेटा सोर्स शीट, चेन बनाने के लिए है.

अनुमति

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, इनमें से एक या उससे ज़्यादा दायरे के साथ अनुमति देना ज़रूरी होता है:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

autoResizeColumns(columnNames)

तय किए गए कॉलम की चौड़ाई का साइज़ अपने-आप बदल देता है.

पैरामीटर

नामटाइपब्यौरा
columnNamesString[]अपडेट किए जाने वाले कॉलम के नामों की सूची.

रिटर्न

DataSourceSheet — यह डेटा सोर्स शीट, चेन बनाने के लिए है.

अनुमति

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, इनमें से एक या उससे ज़्यादा दायरे के साथ अनुमति देना ज़रूरी होता है:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

cancelDataRefresh()

अगर इस ऑब्जेक्ट का डेटा अभी चालू है, तो इससे जुड़ा डेटा रीफ़्रेश होना रद्द हो जाता है.

इस उदाहरण में, फ़ॉर्मूला रीफ़्रेश को रद्द करने का तरीका बताया गया है.

const spreadsheet = SpreadsheetApp.getActive();
const formula = spreadsheet.getDataSourceFormulas()[0];
// Cancel the ongoing refresh on the formula.
formula.cancelDataRefresh();

डेटा सोर्स का टाइप चालू न होने पर, अपवाद माना जाता है. किसी खास तरह के डेटा सोर्स से जुड़ा डेटा चलाने के लिए, SpreadsheetApp#enable...Execution() तरीके का इस्तेमाल करें.

रिटर्न

DataSourceSheet — डेटा ऑब्जेक्ट.

अनुमति

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, इनमें से एक या उससे ज़्यादा दायरे के साथ अनुमति देना ज़रूरी होता है:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

forceRefreshData()

इस ऑब्जेक्ट के डेटा को रीफ़्रेश करता है, भले ही मौजूदा स्थिति कुछ भी हो. ज़्यादा जानकारी के लिए, refreshData() पर जाएं. अगर आपको इस ऑब्जेक्ट के अभी चल रहे रीफ़्रेश को रद्द करना है, तो cancelDataRefresh() देखें.

डेटा सोर्स का टाइप चालू न होने पर, अपवाद माना जाता है. किसी खास तरह के डेटा सोर्स से जुड़ा डेटा चलाने के लिए, SpreadsheetApp#enable...Execution() तरीके का इस्तेमाल करें.

रिटर्न

DataSourceSheet — डेटा ऑब्जेक्ट.

अनुमति

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, इनमें से एक या उससे ज़्यादा दायरे के साथ अनुमति देना ज़रूरी होता है:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getColumnWidth(columnName)

तय किए गए कॉलम की चौड़ाई दिखाता है.

पैरामीटर

नामटाइपब्यौरा
columnNameStringकॉलम का नाम.

रिटर्न

Integer — कॉलम की चौड़ाई या अगर कॉलम में डिफ़ॉल्ट चौड़ाई का इस्तेमाल किया गया है, तो null.

अनुमति

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, इनमें से एक या उससे ज़्यादा दायरे के साथ अनुमति देना ज़रूरी होता है:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getDataSource()

उस डेटा सोर्स को फ़ेच करता है जिससे ऑब्जेक्ट लिंक किया गया है.

रिटर्न

DataSource — डेटा सोर्स.

अनुमति

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, इनमें से एक या उससे ज़्यादा दायरे के साथ अनुमति देना ज़रूरी होता है:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getFilters()

डेटा सोर्स की शीट पर लगाए गए सभी फ़िल्टर दिखाता है.

रिटर्न

DataSourceSheetFilter[] — डेटा सोर्स शीट पर लागू किए गए सभी फ़िल्टर का कलेक्शन.

अनुमति

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, इनमें से एक या उससे ज़्यादा दायरे के साथ अनुमति देना ज़रूरी होता है:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getSheetValues(columnName)

दिए गए कॉलम के नाम के लिए, डेटा सोर्स शीट की सभी वैल्यू दिखाता है.

पैरामीटर

नामटाइपब्यौरा
columnNameStringउस डेटा सोर्स कॉलम का नाम जिसके लिए वैल्यू फ़ेच करनी है.

रिटर्न

Object[] — वैल्यू का एक डाइमेंशन वाला कलेक्शन.

अनुमति

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, इनमें से एक या उससे ज़्यादा दायरे के साथ अनुमति देना ज़रूरी होता है:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getSheetValues(columnName, startRow, numRows)

यह फ़ंक्शन दिए गए कॉलम के नाम के लिए, डेटा सोर्स शीट की सभी वैल्यू दिखाता है. यह वैल्यू दी गई शुरुआती पंक्ति (आधारित 1) और दी गई numRows तक की होती है.

पैरामीटर

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

रिटर्न

Object[] — वैल्यू का एक डाइमेंशन वाला कलेक्शन.

अनुमति

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, इनमें से एक या उससे ज़्यादा दायरे के साथ अनुमति देना ज़रूरी होता है:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getSortSpecs()

डेटा सोर्स शीट में क्रम से लगाने के सभी निर्देश देता है.

रिटर्न

SortSpec[] — क्रम से लगाने के निर्देशों की सूची.

अनुमति

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, इनमें से एक या उससे ज़्यादा दायरे के साथ अनुमति देना ज़रूरी होता है:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getStatus()

ऑब्जेक्ट के डेटा एक्ज़ीक्यूशन की स्थिति की जानकारी देता है.

रिटर्न

DataExecutionStatus — डेटा प्रोसेस होने का स्टेटस.

अनुमति

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, इनमें से एक या उससे ज़्यादा दायरे के साथ अनुमति देना ज़रूरी होता है:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

refreshData()

ऑब्जेक्ट का डेटा रीफ़्रेश करता है.

अगर वर्तमान में error स्थिति में है, तो अपवाद फेंकता है. खास जानकारी को अपडेट करने के लिए, DataSource#updateSpec() का इस्तेमाल करें. डेटा सोर्स में अनचाहे बदलावों को रोकने के लिए, इस तरीके को forceRefreshData() पर प्राथमिकता दी जाती है.

डेटा सोर्स का टाइप चालू न होने पर, अपवाद माना जाता है. किसी खास तरह के डेटा सोर्स से जुड़ा डेटा चलाने के लिए, SpreadsheetApp#enable...Execution() तरीके का इस्तेमाल करें.

रिटर्न

DataSourceSheet — डेटा ऑब्जेक्ट.

अनुमति

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, इनमें से एक या उससे ज़्यादा दायरे के साथ अनुमति देना ज़रूरी होता है:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

removeFilters(columnName)

डेटा सोर्स की शीट के कॉलम पर लगाए गए सभी फ़िल्टर हटा देता है.

पैरामीटर

नामटाइपब्यौरा
columnNameStringउस कॉलम का नाम जिससे फ़िल्टर हटाने हैं.

रिटर्न

DataSourceSheet — मेथड चेन के लिए डेटा सोर्स शीट.

अनुमति

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, इनमें से एक या उससे ज़्यादा दायरे के साथ अनुमति देना ज़रूरी होता है:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

removeSortSpec(columnName)

डेटा सोर्स शीट में कॉलम का क्रम तय करने का तरीका हटा दिया जाता है.

पैरामीटर

नामटाइपब्यौरा
columnNameStringकॉलम का नाम.

रिटर्न

DataSourceSheet — चेन बनाने के लिए, डेटा सोर्स शीट.

अनुमति

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, इनमें से एक या उससे ज़्यादा दायरे के साथ अनुमति देना ज़रूरी होता है:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setColumnWidth(columnName, width)

बताए गए कॉलम की चौड़ाई सेट करता है.

पैरामीटर

नामटाइपब्यौरा
columnNameStringकॉलम का नाम.
widthIntegerकॉलम के लिए नई चौड़ाई.

रिटर्न

DataSourceSheet — यह डेटा सोर्स शीट, चेन बनाने के लिए है.

अनुमति

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, इनमें से एक या उससे ज़्यादा दायरे के साथ अनुमति देना ज़रूरी होता है:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setColumnWidths(columnNames, width)

बताए गए कॉलम की चौड़ाई सेट करता है.

पैरामीटर

नामटाइपब्यौरा
columnNamesString[]अपडेट किए जाने वाले कॉलम के नामों की सूची.
widthIntegerकॉलम के लिए नई चौड़ाई.

रिटर्न

DataSourceSheet — यह डेटा सोर्स शीट, चेन बनाने के लिए है.

अनुमति

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, इनमें से एक या उससे ज़्यादा दायरे के साथ अनुमति देना ज़रूरी होता है:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setSortSpec(columnName, ascending)

डेटा सोर्स शीट में किसी कॉलम पर, क्रम से लगाने का तरीका सेट करता है.

पैरामीटर

नामटाइपब्यौरा
columnNameStringक्रम से लगाने के लिए कॉलम का नाम.
ascendingBooleanअगर वैल्यू true है, तो कॉलम को बढ़ते क्रम में लगाएं. अगर false है, तो कॉलम को घटते क्रम में लगाएं.

रिटर्न

DataSourceSheet — चेन बनाने के लिए, डेटा सोर्स शीट.

अनुमति

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, इनमें से एक या उससे ज़्यादा दायरे के साथ अनुमति देना ज़रूरी होता है:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setSortSpec(columnName, sortOrder)

डेटा सोर्स शीट में किसी कॉलम पर, क्रम से लगाने का तरीका सेट करता है.

पैरामीटर

नामटाइपब्यौरा
columnNameStringक्रम से लगाने के लिए कॉलम का नाम.
sortOrderSortOrderक्रम से लगाने का क्रम.

रिटर्न

DataSourceSheet — चेन बनाने के लिए, डेटा सोर्स शीट.

अनुमति

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, इनमें से एक या उससे ज़्यादा दायरे के साथ अनुमति देना ज़रूरी होता है:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

waitForCompletion(timeoutInSeconds)

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

पैरामीटर

नामटाइपब्यौरा
timeoutInSecondsIntegerडेटा प्रोसेस होने तक इंतज़ार करने का समय (सेकंड में). यह अवधि ज़्यादा से ज़्यादा 300 सेकंड हो सकती है.

रिटर्न

DataExecutionStatus — डेटा प्रोसेस होने का स्टेटस.

अनुमति

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, इनमें से एक या उससे ज़्यादा दायरे के साथ अनुमति देना ज़रूरी होता है:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets