Class DataSource

DataSource

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

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

Methods

メソッド戻り値の型概要
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リンクされたデータソース オブジェクトの現在の実行がすべて完了するまで待機し、指定された秒数後にタイムアウトします。

詳細なドキュメント

createCalculatedColumn(name, formula)

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

パラメータ

名前説明
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()

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

リターン

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

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

リターン

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