Class DataSource

DataSource

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

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

メソッド

メソッド戻り値の型概要
cancelAllLinkedDataSourceObjectRefreshes()voidこのデータソースにリンクされているデータソース オブジェクトの現在実行中の更新をすべてキャンセルします。
createCalculatedColumn(name, formula)DataSourceColumn計算された列を作成します。
createDataSourcePivotTableOnNewSheet()DataSourcePivotTableこのデータソースから、新しいシートの最初のセルにデータソース ピボット テーブルを作成します。
createDataSourceTableOnNewSheet()DataSourceTableこのデータソースから、新しいシートの最初のセルにデータソース テーブルを作成します。
getCalculatedColumnByName(columnName)DataSourceColumn|null列名に一致するデータソース内の計算された列を返します。
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 \- 列名に一致する計算された列。そのような計算された列がない場合は 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