Class DataSource

DataSource

存取及修改現有資料來源。如要使用新資料來源建立資料來源表格，請參閱 DataSourceTable。

「這個類別」只能搭配連結至資料庫的資料使用。

方法

方法傳回類型簡短說明
cancelAllLinkedDataSourceObjectRefreshes()void取消所有目前正在執行的資料來源物件重新整理作業，這些物件已連結至這個資料來源。
createCalculatedColumn(name, formula)DataSourceColumn建立計算結果欄。
createDataSourcePivotTableOnNewSheet()DataSourcePivotTable在新工作表的第一個儲存格中，根據這個資料來源建立資料來源資料透視表。
createDataSourceTableOnNewSheet()DataSourceTable在新工作表的第一個儲存格中，根據這個資料來源建立資料來源資料表。
getCalculatedColumnByName(columnName)DataSourceColumn傳回資料來源中符合資料欄名稱的計算結果欄。
getCalculatedColumns()DataSourceColumn[]傳回資料來源中所有計算結果欄。
getColumns()DataSourceColumn[]傳回資料來源中的所有資料欄。
getDataSourceSheets()DataSourceSheet[]傳回與此資料來源相關聯的資料來源工作表。
getSpec()DataSourceSpec取得資料來源規格。
refreshAllLinkedDataSourceObjects()void重新整理所有連結到資料來源的資料來源物件。
updateSpec(spec)DataSource更新資料來源規格，並重新整理與此屬性連結的資料來源物件 內含新規格的資料來源
updateSpec(spec, refreshAllLinkedObjects)DataSource更新資料來源規格，並使用新規格重新整理連結的 data source sheets。
waitForAllDataExecutionsCompletion(timeoutInSeconds)void等待連結資料來源物件目前的所有執行作業都完成後，逾時 指定的秒數過後

內容詳盡的說明文件

cancelAllLinkedDataSourceObjectRefreshes()

針對已連結至這個資料來源的資料來源物件，取消目前執行的所有重新整理作業。

本範例說明如何取消資料來源的所有重新整理作業。

SpreadsheetApp.enableBigQueryExecution();
const dataSource = spreadsheet.getDataSources()[0];
dataSource.cancelAllLinkedDataSourceObjectRefreshes();

如果未啟用資料來源類型，就會擲回例外狀況。使用 SpreadsheetApp#enable...Execution() 方法為特定資料啟用資料執行程序 來源類型。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

createCalculatedColumn(name, formula)

建立計算結果欄。這個方法僅適用於 BigQuery 資料來源。

參數

名稱類型說明
nameString計算結果欄的名稱。
formulaString計算結果欄公式。

回攻員

DataSourceColumn：新建立的計算結果欄。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

createDataSourcePivotTableOnNewSheet()

在新工作表的第一個儲存格中，根據這個資料來源建立資料來源資料透視表。身為 則會將新工作表設為目前使用中的工作表。

回攻員

DataSourcePivotTable：新建的資料來源資料透視表。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

createDataSourceTableOnNewSheet()

在新工作表的第一個儲存格中，根據這個資料來源建立資料來源資料表。並將新試算表設為活動試算表。

這個方法僅適用於 BigQuery 資料來源。

回攻員

DataSourceTable：新建的資料來源資料表。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

getCalculatedColumnByName(columnName)

傳回資料來源中符合資料欄名稱的計算結果欄。

參數

名稱類型說明
columnNameString要取得的計算結果欄名稱。

回攻員

DataSourceColumn：符合資料欄名稱的計算結果資料欄，如果沒有的話，則傳回 null 計算結果欄

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

getCalculatedColumns()

傳回資料來源中所有計算結果欄。

DataSourceType.LOOKER 類型的資料來源規格會傳回空白陣列。

回攻員

DataSourceColumn[]：資料來源中所有計算結果欄的陣列。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

getColumns()

傳回資料來源中的所有資料欄。

回攻員

DataSourceColumn[]：資料來源中所有 DataSourceColumn 的陣列。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

getDataSourceSheets()

傳回與這個資料來源相關聯的資料來源工作表。

回攻員

DataSourceSheet[]：資料來源工作表陣列。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

getSpec()

取得資料來源規格。

回攻員

DataSourceSpec：資料來源規格。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

refreshAllLinkedDataSourceObjects()

重新整理所有連結到資料來源的資料來源物件。

如果未啟用資料來源類型，就會擲回例外狀況。使用 SpreadsheetApp#enable...Execution() 方法為特定資料啟用資料執行程序 來源類型。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

updateSpec(spec)

更新資料來源規格，並重新整理與此屬性連結的資料來源物件 內含新規格的資料來源

如果未啟用資料來源類型，就會擲回例外狀況。使用 SpreadsheetApp#enable...Execution() 方法為特定資料啟用資料執行程序 來源類型。

如果資料來源規格類型與 目前的資料來源類型

參數

名稱類型說明
specDataSourceSpec要更新的資料來源規格。

回攻員

DataSource：資料來源。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

updateSpec(spec, refreshAllLinkedObjects)

更新資料來源規格，並使用新規格重新整理連結的 data source sheets。

如果未啟用資料來源類型，就會擲回例外狀況。使用 SpreadsheetApp#enable...Execution() 方法，為特定資料來源類型啟用資料執行程序。

如果資料來源規格類型與 目前的資料來源類型

參數

名稱類型說明
specDataSourceSpec要更新的資料來源規格。
refreshAllLinkedObjectsBoolean如果設為 true，也會重新整理所有資料來源物件 與這個資料來源建立連結

回攻員

DataSource：資料來源。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

waitForAllDataExecutionsCompletion(timeoutInSeconds)

等待連結資料來源物件目前的所有執行作業都完成後，逾時 指定的秒數過後如果執行作業未完成，就會擲回例外狀況 但不會取消資料執行作業

參數

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

授權

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

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