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 \- データオブジェクト。

承認

このメソッドを使用するスクリプトには、次の 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