Class DataSourceChart

DataSourceChart

既存のデータソース グラフにアクセスして変更します。

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

メソッド

メソッド戻り値の型概要
cancelDataRefresh()DataSourceChartこのオブジェクトに関連付けられているデータ更新が現在実行中の場合は、その更新をキャンセルします。
forceRefreshData()DataSourceChart現在の状態に関係なく、このオブジェクトのデータを更新します。
getDataSource()DataSourceオブジェクトがリンクされているデータソースを取得します。
getStatus()DataExecutionStatusオブジェクトのデータ実行ステータスを取得します。
refreshData()DataSourceChartオブジェクトのデータを更新します。
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() メソッドを使用して、特定のデータソース タイプでデータの実行を有効にします。

戻る

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

承認

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

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

forceRefreshData()

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

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

戻る

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

承認

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

getStatus()

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

戻る

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

承認

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

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

refreshData()

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

現在 error 状態の場合、例外をスローします。DataSource#updateSpec() を使用して仕様を更新します。このメソッドは、データソースの予期しない編集を防ぐために forceRefreshData() よりも優先されます。

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

戻る

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

承認

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