存取及修改現有的資料來源。如要建立包含新資料來源的資料來源資料表,請參閱 DataSourceTable
。
請僅將這個類別用於連結至資料庫的資料。
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
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 | 會等到已連結資料來源物件目前的所有執行作業完成,並在提供的秒數過後逾時。 |
內容詳盡的說明文件
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