存取及修改現有資料來源。如要使用新資料來源建立資料來源資料表,請參閱
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)
建立計算結果欄。
參數
名稱 | 類型 | 說明 |
---|---|---|
name | String | 計算結果欄的名稱。 |
formula | String | 計算結果欄公式。 |
回攻員
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()
在新工作表的第一個儲存格中,根據這個資料來源建立資料來源資料表。一起 即可將新工作表設為使用中的工作表。
回攻員
DataSourceTable
:新建的資料來源資料表。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getCalculatedColumnByName(columnName)
傳回資料來源中符合資料欄名稱的計算結果欄。
參數
名稱 | 類型 | 說明 |
---|---|---|
columnName | String | 要取得的計算結果欄名稱。 |
回攻員
DataSourceColumn
:符合資料欄名稱的計算結果資料欄,如果沒有的話,則傳回 null
計算結果欄
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getCalculatedColumns()
傳回資料來源中所有計算結果欄。
回攻員
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()
方法為特定資料啟用資料執行程序
來源類型。
參數
名稱 | 類型 | 說明 |
---|---|---|
spec | DataSourceSpec | 要更新的資料來源規格。 |
回攻員
DataSource
:資料來源。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
updateSpec(spec, refreshAllLinkedObjects)
更新資料來源規格,並使用新規格重新整理連結的 data
source sheets
。
如果未啟用資料來源類型,就會擲回例外狀況。使用 SpreadsheetApp#enable...Execution()
方法為特定資料啟用資料執行程序
來源類型。
參數
名稱 | 類型 | 說明 |
---|---|---|
spec | DataSourceSpec | 要更新的資料來源規格。 |
refreshAllLinkedObjects | Boolean | 如果設為 true ,也會重新整理所有資料來源物件
與這個資料來源建立連結 |
回攻員
DataSource
:資料來源。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
waitForAllDataExecutionsCompletion(timeoutInSeconds)
等待連結資料來源物件目前的所有執行作業都完成後,逾時 指定的秒數過後如果執行作業未完成,就會擲回例外狀況 但不會取消資料執行作業
參數
名稱 | 類型 | 說明 |
---|---|---|
timeoutInSeconds | Integer | 等待資料執行的時間,以秒為單位。上限為 300 個 秒內請求驗證碼。 |
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets