既存のデータソースにアクセスして変更する。新しいデータソースでデータソース テーブルを作成するには、DataSourceTable
をご覧ください。
このクラスは、データベースに接続されているデータでのみ使用してください。
方法
詳細なドキュメント
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()
updateSpec(spec)
データソース仕様を更新し、このデータソースにリンクされているデータソース オブジェクトを新しい仕様で更新します。
データソース タイプが有効になっていない場合は、例外をスローします。特定のデータソース タイプのデータ実行を有効にするには、SpreadsheetApp#enable...Execution()
メソッドを使用します。
パラメータ
名前 | 型 | 説明 |
---|---|---|
spec | DataSourceSpec | 更新に使用するデータソース仕様。 |
リターン
DataSource
- データソース。
認可
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
updateSpec(spec, refreshAllLinkedObjects)
データソース仕様を更新し、リンクされている data
source sheets
を新しい仕様に更新します。
データソース タイプが有効になっていない場合は、例外をスローします。特定のデータソース タイプのデータ実行を有効にするには、SpreadsheetApp#enable...Execution()
メソッドを使用します。
パラメータ
名前 | 型 | 説明 |
---|---|---|
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