Class DataSourceFormula

DataSourceFormula

存取及修改現有資料來源公式。如要建立新的資料來源公式，請使用 Range.setFormula(formula)。

請只將這個類別用於連結至 BigQuery 資料庫的資料。

方法

方法	傳回類型	簡短說明
cancelDataRefresh()	DataSourceFormula	如果與這個物件相關的資料重新整理作業正在執行，系統會取消作業。
forceRefreshData()	DataSourceFormula	無論目前狀態為何，都會重新整理這個物件的資料。
getAnchorCell()	Range	傳回Range，代表這個資料來源公式的錨定儲存格。
getDataSource()	DataSource	取得物件連結的資料來源。
getDisplayValue()	String	傳回資料來源公式的顯示值。
getFormula()	String	傳回這個資料來源公式的公式。
getStatus()	DataExecutionStatus	取得物件的資料執行狀態。
refreshData()	DataSourceFormula	重新整理物件的資料。
setFormula(formula)	DataSourceFormula	更新公式。
waitForCompletion(timeoutInSeconds)	DataExecutionStatus	等待目前執行作業完成，並在指定秒數後逾時。

內容詳盡的說明文件

cancelDataRefresh()

如果與這個物件相關的資料重新整理作業正在執行，系統會取消作業。

這個範例說明如何取消公式重新整理。

const spreadsheet = SpreadsheetApp.getActive();
const formula = spreadsheet.getDataSourceFormulas()[0];
// Cancel the ongoing refresh on the formula.
formula.cancelDataRefresh();

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

回攻員

DataSourceFormula：資料物件。

授權

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

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

---

forceRefreshData()

無論目前狀態為何，都會重新整理這個物件的資料。詳情請參閱 refreshData()。如要取消目前正在進行的物件重新整理作業，請參閱 cancelDataRefresh()。

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

回攻員

DataSourceFormula：資料物件。

授權

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

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

---

getAnchorCell()

傳回Range，代表這個資料來源公式的錨定儲存格。

回攻員

Range：錨點儲存格。

授權

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

• 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

---

getDisplayValue()

傳回資料來源公式的顯示值。

回攻員

String：顯示值。

授權

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

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

---

getFormula()

傳回這個資料來源公式的公式。

回攻員

String：公式。

授權

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

• 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() 方法，為特定資料來源類型啟用資料執行程序。

回攻員

DataSourceFormula：資料物件。

授權

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

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

---

setFormula(formula)

更新公式。

參數

名稱	類型	說明
formula	String	新公式。

回攻員

DataSourceFormula：用於串連的資料來源公式。

授權

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

• 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