このページは Cloud Translation API によって翻訳されました。

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

計算された列を作成します。

パラメータ

名前	型	説明
`name`	`String`	計算された列の名前。
`formula`	`String`	計算された列の数式。

戻る

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()`

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

戻る

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

承認

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

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

`getCalculatedColumnByName(columnName)`

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

パラメータ

名前	型	説明
`columnName`	`String`	取得する計算済み列の名前。

戻る

DataSourceColumn - 列名と一致する計算された列。一致する列がない場合は null 計算済みの列です。

承認

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

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

`getCalculatedColumns()`

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

戻る

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()`

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

承認

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

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

`updateSpec(spec)`

データソース仕様を更新し、これにリンクされたデータソースオブジェクトを更新します。新しい仕様に置き換えます。

パラメータ

名前	型	説明
`spec`	`DataSourceSpec`	更新に使用するデータソース仕様。

戻る

DataSource - データソース。

承認

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

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

`updateSpec(spec, refreshAllLinkedObjects)`

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

パラメータ

名前	型	説明
`spec`	`DataSourceSpec`	更新に使用するデータソース仕様。
`refreshAllLinkedObjects`	`Boolean`	`true` の場合、すべてのデータソースオブジェクトも更新します。このデータソースとリンクしています

戻る

DataSource - データソース。

承認

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

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

`waitForAllDataExecutionsCompletion(timeoutInSeconds)`

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

パラメータ

名前	型	説明
`timeoutInSeconds`	`Integer`	データの実行を待機する時間（秒単位）。上限は 300 です秒です。

承認

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

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