既存のデータソースの数式にアクセスして変更する。新しいデータソース式を作成するには、Range.setFormula(formula) 関数を使用します。
このクラスは、データベースに接続されているデータでのみ使用します。
Methods
| メソッド | 戻り値の型 | 概要 |
|---|---|---|
forceRefreshData() | DataSourceFormula | 現在の状態に関係なく、このオブジェクトのデータを更新します。 |
getAnchorCell() | Range | このデータソース式が固定されているセルを表す Range を返します。 |
getDataSource() | DataSource | オブジェクトがリンクされているデータソースを取得します。 |
getDisplayValue() | String | データソースの数式の表示値を返します。 |
getFormula() | String | このデータソース式の数式を返します。 |
getStatus() | DataExecutionStatus | オブジェクトのデータ実行ステータスを取得します。 |
refreshData() | DataSourceFormula | オブジェクトのデータを更新します。 |
setFormula(formula) | DataSourceFormula | 数式を更新します。 |
waitForCompletion(timeoutInSeconds) | DataExecutionStatus | 現在の実行が完了するまで待機し、指定された秒数後にタイムアウトします。 |
詳細なドキュメント
forceRefreshData()
現在の状態に関係なく、このオブジェクトのデータを更新します。詳しくは、refreshData() をご覧ください。
データソース タイプが有効になっていない場合、例外をスローします。特定のデータソース タイプに対してデータ実行を有効にするには、SpreadsheetApp#enable...Execution() メソッドを使用します。
リターン
DataSourceFormula - データ オブジェクト。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getAnchorCell()
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)
数式を更新します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
formula | String | 新しい数式。 |
リターン
DataSourceFormula - チェーンで使用するデータソースの数式。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
waitForCompletion(timeoutInSeconds)
現在の実行が完了するまで待機し、指定された秒数後にタイムアウトします。 タイムアウト時に実行が完了していない場合に例外をスローしますが、データ実行はキャンセルしません。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
timeoutInSeconds | Integer | データ実行の待機時間（秒単位）。最大値は 300 秒です。 |
リターン
DataExecutionStatus - データ実行ステータス。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets