Class DataSource

データソース

既存のデータソースにアクセスして変更する。新しいデータソースを使用してデータソース テーブルを作成する方法については、DataSourceTable をご覧ください。

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

メソッド

メソッド戻り値の型概要
cancelAllLinkedDataSourceObjectRefreshes()voidこのデータソースにリンクされているデータソース オブジェクトの現在実行中の更新をすべてキャンセルします。
createCalculatedColumn(name, formula)DataSourceColumn計算された列を作成します。
createDataSourcePivotTableOnNewSheet()DataSourcePivotTableこのデータソースから、新しいシートの最初のセルにデータソース ピボット テーブルを作成します。
createDataSourceTableOnNewSheet()DataSourceTableこのデータソースから、新しいシートの最初のセルにデータソース テーブルを作成します。
getCalculatedColumnByName(columnName)DataSourceColumn列名に一致するデータソース内の計算列を返します。
getCalculatedColumns()DataSourceColumn[]データソース内のすべての計算列を返します。
getColumns()DataSourceColumn[]データソース内のすべての列を返します。
getDataSourceSheets()DataSourceSheet[]このデータソースに関連付けられているデータソースシートを返します。
getSpec()DataSourceSpecデータソース仕様を取得します。
refreshAllLinkedDataSourceObjects()voidデータソースにリンクされているすべてのデータソース オブジェクトを更新します。
updateSpec(spec)DataSourceデータソース仕様を更新し、このデータソースにリンクされているデータソース オブジェクトを新しい仕様で更新します。
updateSpec(spec, refreshAllLinkedObjects)DataSourceデータソースの仕様を更新し、リンクされた data source sheets を新しい仕様で更新します。
waitForAllDataExecutionsCompletion(timeoutInSeconds)voidリンクされたデータソース オブジェクトの現在の実行がすべて完了するまで待機し、指定された秒数経過後にタイムアウトします。

詳細なドキュメント

cancelAllLinkedDataSourceObjectRefreshes()

このデータソースにリンクされているデータソース オブジェクトの現在実行中の更新をすべてキャンセルします。

この例は、データソースのすべての更新をキャンセルする方法を示しています。

SpreadsheetApp.enableBigQueryExecution();
const spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
const dataSource = spreadsheet.getDataSources()[0];
dataSource.cancelAllLinkedDataSourceObjectRefreshes();

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

承認

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

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

createCalculatedColumn(name, formula)

計算された列を作成します。この方法は、BigQuery データソースでのみ使用できます。

パラメータ

名前型説明
nameString計算列の名前。
formulaString計算された列の数式。

戻る

DataSourceColumn - 新しく作成された計算列。

承認

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

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

createDataSourcePivotTableOnNewSheet()

このデータソースから、新しいシートの最初のセルにデータソース ピボット テーブルを作成します。副作用として、新しいシートがアクティブなシートになります。

戻る

DataSourcePivotTable - 新しく作成されたデータソース ピボット テーブル。

承認

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

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

createDataSourceTableOnNewSheet()

このデータソースから、新しいシートの最初のセルにデータソース テーブルを作成します。副作用として、新しいシートがアクティブなシートになります。

この方法は、BigQuery データソースでのみ使用できます。

戻る

DataSourceTable - 新しく作成されたデータソース テーブル。

承認

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

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

getCalculatedColumnByName(columnName)

列名に一致するデータソース内の計算列を返します。

パラメータ

名前型説明
columnNameString取得する計算列の名前。

戻る

DataSourceColumn - 列名に一致する計算列。そのような計算列がない場合、null です。

承認

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

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

getCalculatedColumns()

データソース内のすべての計算列を返します。

DataSourceType.LOOKER タイプのデータソース仕様は空の配列を返します。

戻る

DataSourceColumn[] - データソース内のすべての計算列の配列。

承認

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

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

getColumns()

データソース内のすべての列を返します。

戻る

DataSourceColumn[] - データソース内のすべての DataSourceColumn の配列。

承認

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

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

getDataSourceSheets()

このデータソースに関連付けられているデータソースシートを返します。

戻る

DataSourceSheet[] - データソースシートの配列。

承認

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

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

getSpec()

データソース仕様を取得します。

戻る

DataSourceSpec - データソースの仕様。

承認

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

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

refreshAllLinkedDataSourceObjects()

データソースにリンクされているすべてのデータソース オブジェクトを更新します。

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

承認

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

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

updateSpec(spec)

データソース仕様を更新し、このデータソースにリンクされているデータソース オブジェクトを新しい仕様で更新します。

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

データソース仕様のタイプが現在のデータソース タイプと異なる場合は、例外をスローします。

パラメータ

名前型説明
specDataSourceSpec更新するデータソース仕様。

戻る

DataSource - データソース。

承認

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

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

updateSpec(spec, refreshAllLinkedObjects)

データソースの仕様を更新し、リンクされた data source sheets を新しい仕様で更新します。

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

データソース仕様のタイプが現在のデータソース タイプと異なる場合は、例外をスローします。

パラメータ

名前型説明
specDataSourceSpec更新するデータソース仕様。
refreshAllLinkedObjectsBooleantrue の場合、このデータソースにリンクされているすべてのデータソース オブジェクトも更新されます。

戻る

DataSource - データソース。

承認

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

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

waitForAllDataExecutionsCompletion(timeoutInSeconds)

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

パラメータ

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

承認

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

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