Class DataSourceSheet

資料來源工作表

存取及修改現有資料來源工作表。如要建立新的資料來源工作表，請使用 Spreadsheet.insertDataSourceSheet(spec)。

請只將這個類別用於與資料庫連線的資料。

方法

方法傳回類型簡短說明
addFilter(columnName, filterCriteria)DataSourceSheet新增套用至資料來源工作表的篩選器。
asSheet()Sheet以一般工作表物件的形式傳回資料來源工作表。
autoResizeColumn(columnName)DataSourceSheet自動調整指定欄的寬度。
autoResizeColumns(columnNames)DataSourceSheet自動調整指定資料欄的寬度。
cancelDataRefresh()DataSourceSheet如果與這個物件相關的資料重新整理作業正在執行，系統會取消作業。
forceRefreshData()DataSourceSheet無論目前狀態為何，都會重新整理這個物件的資料。
getColumnWidth(columnName)Integer|null傳回指定資料欄的寬度。
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：資料欄的寬度，或 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