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