このページは 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