Class DataSource

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 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