Class DataSourceFormula

DataSourceFormula

既存のデータソースの数式にアクセスして変更する。新しいデータソース式を作成するには、Range.setFormula(formula) を使用します。

このクラスは、データベースに接続されているデータでのみ使用してください。

方法

メソッド戻り値の型概要
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 - データ オブジェクト。

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

forceRefreshData()

現在の状態に関係なく、このオブジェクトのデータを更新します。詳しくは、refreshData() をご覧ください。このオブジェクトの現在実行中の更新をキャンセルする場合は、cancelDataRefresh() をご覧ください。

データソース タイプが有効になっていない場合は、例外をスローします。特定のデータソース タイプでデータ実行を有効にするには、SpreadsheetApp#enable...Execution() メソッドを使用します。

リターン

DataSourceFormula - データ オブジェクト。

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

getAnchorCell()

このデータソースの数式が固定されているセルを表す Range を返します。

リターン

Range - アンカーセル。

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

getDataSource()

オブジェクトがリンクされているデータソースを取得します。

リターン

DataSource - データソース。

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

getDisplayValue()

データソースの式の表示値を返します。

リターン

String - 表示する値。

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

getFormula()

このデータソースの数式を返します。

リターン

String - 数式。

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

getStatus()

オブジェクトのデータ実行ステータスを取得します。

リターン

DataExecutionStatus - データ実行ステータス。

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

refreshData()

オブジェクトのデータを更新します。

現在 error 状態の場合は、例外をスローします。DataSource#updateSpec() を使用して仕様を更新します。データソースで予期しない編集が行われないように、この方法は forceRefreshData() よりも推奨されています。

データソース タイプが有効になっていない場合は、例外をスローします。特定のデータソース タイプでデータ実行を有効にするには、SpreadsheetApp#enable...Execution() メソッドを使用します。

リターン

DataSourceFormula - データ オブジェクト。

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

setFormula(formula)

数式を更新します。

パラメータ

名前型説明
formulaString新しい数式。

リターン

DataSourceFormula - チェーンで使用するデータソース数式。

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

waitForCompletion(timeoutInSeconds)

現在の実行が完了するまで待機し、指定された秒数後にタイムアウトします。タイムアウト時に実行が完了していない場合、例外をスローしますが、データ実行はキャンセルされません。

パラメータ

名前型説明
timeoutInSecondsIntegerデータ実行の待機時間（秒）。最大値は 300 秒です。

リターン

DataExecutionStatus - データ実行ステータス。

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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