本頁面由 Cloud Translation API 翻譯而成。

Class 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)`

新增套用至資料來源工作表的篩選器。

參數

名稱	類型	說明
`columnName`	`String`	要套用這個篩選器的資料欄名稱。
`filterCriteria`	`FilterCriteria`	要套用的篩選條件。

回攻員

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)`

自動調整指定欄的寬度。

參數

名稱	類型	說明
`columnName`	`String`	資料欄名稱。

回攻員

DataSourceSheet：這個資料來源工作表，用於鏈結。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`autoResizeColumns(columnNames)`

自動調整指定欄的寬度。

參數

名稱	類型	說明
`columnNames`	`String[]`	要更新的資料欄名稱清單。

回攻員

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)`

傳回指定資料欄的寬度。

參數

名稱	類型	說明
`columnName`	`String`	資料欄名稱。

回攻員

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)`

傳回指定資料欄名稱的資料來源工作表所有值。

參數

名稱	類型	說明
`columnName`	`String`	要擷取值的資料來源欄名稱。

回攻員

Object[]：值的一維陣列。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`getSheetValues(columnName, startRow, numRows)`

傳回指定資料欄名稱的資料來源工作表所有值，從提供的起始資料列 (以 1 為基準) 到提供的 numRows。

參數

名稱	類型	說明
`columnName`	`String`	要擷取值的資料來源欄名稱。
`startRow`	`Integer`	開始擷取值的資料列位置。
`numRows`	`Integer`	要擷取的資料列數量。

回攻員

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)`

移除套用至資料來源工作表資料欄的所有篩選器。

參數

名稱	類型	說明
`columnName`	`String`	要移除篩選器的資料欄名稱。

回攻員

DataSourceSheet：資料來源工作表，用於方法鏈結。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`removeSortSpec(columnName)`

移除資料來源工作表中資料欄的排序規格。

參數

名稱	類型	說明
`columnName`	`String`	資料欄的名稱。

回攻員

DataSourceSheet：資料來源工作表，用於鏈結。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`setColumnWidth(columnName, width)`

設定指定資料欄的寬度。

參數

名稱	類型	說明
`columnName`	`String`	資料欄名稱。
`width`	`Integer`	資料欄的新寬度。

回攻員

DataSourceSheet：這個資料來源工作表，用於鏈結。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`setColumnWidths(columnNames, width)`

設定指定資料欄的寬度。

參數

名稱	類型	說明
`columnNames`	`String[]`	要更新的資料欄名稱清單。
`width`	`Integer`	資料欄的新寬度。

回攻員

DataSourceSheet：這個資料來源工作表，用於鏈結。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`setSortSpec(columnName, ascending)`

設定資料來源工作表中某一欄的排序規格。

參數

名稱	類型	說明
`columnName`	`String`	要排序的資料欄名稱。
`ascending`	`Boolean`	如果是 `true`，則以遞增順序排序資料欄；如果是 `false`，則以遞減順序排序資料欄。

回攻員

DataSourceSheet：資料來源工作表，用於鏈結。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`setSortSpec(columnName, sortOrder)`

設定資料來源工作表中某一欄的排序規格。

參數

名稱	類型	說明
`columnName`	`String`	要排序的資料欄名稱。
`sortOrder`	`SortOrder`	排序順序。

回攻員

DataSourceSheet：資料來源工作表，用於鏈結。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`waitForCompletion(timeoutInSeconds)`

等待目前執行作業完成，並在指定秒數後逾時。如果在逾時時未完成執行作業，則會擲回例外狀況，但不會取消資料執行作業。

參數

名稱	類型	說明
`timeoutInSeconds`	`Integer`	等待資料執行作業的時間 (以秒為單位)。上限為 300 秒。

回攻員

DataExecutionStatus：資料執行狀態。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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