Class DataSourceSheet

DataSourceSheet

既存のデータソース シートにアクセスして変更する。新しいデータソース シートを作成するには、Spreadsheet.insertDataSourceSheet(spec) を使用します。

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

メソッド

メソッド戻り値の型概要
addFilter(columnName, filterCriteria)DataSourceSheetデータソース シートに適用されているフィルタを追加します。
asSheet()Sheetデータソース シートを通常のシート オブジェクトとして返します。
autoResizeColumn(columnName)DataSourceSheet指定した列の幅を自動的に変更します。
autoResizeColumns(columnNames)DataSourceSheet指定した列の幅を自動的に変更します。
cancelDataRefresh()DataSourceSheet現在実行中のこのオブジェクトに関連付けられているデータの更新をキャンセルします。
forceRefreshData()DataSourceSheet現在の状態に関係なく、このオブジェクトのデータを更新します。
getColumnWidth(columnName)Integer指定された列の幅を返します。
getDataSource()DataSourceオブジェクトがリンクされているデータソースを取得します。
getFilters()DataSourceSheetFilter[]データソース シートに適用されているすべてのフィルタを返します。
getSheetValues(columnName)Object[]指定された列名のデータソース シートのすべての値を返します。
getSheetValues(columnName, startRow, numRows)Object[]指定された列名のデータソース シートのすべての値を返します。 開始行（1 を基準とする）から、指定された numRows まで。
getSortSpecs()SortSpec[]データソース シートのすべての並べ替え仕様を取得します。
getStatus()DataExecutionStatusオブジェクトのデータ実行ステータスを取得します。
refreshData()DataSourceSheetオブジェクトのデータを更新します。
removeFilters(columnName)DataSourceSheetデータソース シートの列に適用されているすべてのフィルタを削除します。
removeSortSpec(columnName)DataSourceSheetデータソース シートの列の並べ替え指定を削除します。
setColumnWidth(columnName, width)DataSourceSheet指定された列の幅を設定します。
setColumnWidths(columnNames, width)DataSourceSheet指定された列の幅を設定します。
setSortSpec(columnName, ascending)DataSourceSheetデータソース シートの列で並べ替え仕様を設定します。
setSortSpec(columnName, sortOrder)DataSourceSheetデータソース シートの列で並べ替え仕様を設定します。
waitForCompletion(timeoutInSeconds)DataExecutionStatus現在の実行が完了するまで待機し、指定された秒数が経過するとタイムアウトします。

詳細なドキュメント

addFilter(columnName, filterCriteria)

データソース シートに適用されているフィルタを追加します。

パラメータ

名前型説明
columnNameStringこのフィルタを適用する列の名前。
filterCriteriaFilterCriteria適用するフィルタ条件。

戻る

DataSourceSheet - メソッド チェーン用のデータソース シート。

承認

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

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

asSheet()

データソース シートを通常のシート オブジェクトとして返します。

戻る

Sheet - 通常のシート。

承認

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

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

autoResizeColumn(columnName)

指定した列の幅を自動的に変更します。

パラメータ

名前型説明
columnNameString列の名前。

戻る

DataSourceSheet - チェーン用のデータソース シート。

承認

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

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

autoResizeColumns(columnNames)

指定した列の幅を自動的に変更します。

パラメータ

名前型説明
columnNamesString[]更新する列名のリスト。

戻る

DataSourceSheet - チェーン用のデータソース シート。

承認

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

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

cancelDataRefresh()

現在実行中のこのオブジェクトに関連付けられているデータの更新をキャンセルします。

この例では、数式の更新をキャンセルする方法を示します。 

const spreadsheet = SpreadsheetApp.getActive();
const formula = spreadsheet.getDataSourceFormulas()[0];
// Cancel the ongoing refresh on the formula.
formula.cancelDataRefresh();

データソース タイプが有効になっていない場合、例外をスローします。 SpreadsheetApp#enable...Execution() メソッドを使用して、特定のデータソースのデータ実行を有効にする あります。

戻る

DataSourceSheet - データ オブジェクト。

承認

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

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

forceRefreshData()

現在の状態に関係なく、このオブジェクトのデータを更新します。refreshData() を表示: 詳しく見ていきますこのオブジェクトで現在実行中の更新をキャンセルする場合は、cancelDataRefresh() をご覧ください。

データソース タイプが有効になっていない場合、例外をスローします。SpreadsheetApp#enable...Execution() メソッドを使用して、特定のデータソースのデータ実行を有効にする あります。

戻る

DataSourceSheet - データ オブジェクト。

承認

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

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

getColumnWidth(columnName)

指定された列の幅を返します。

パラメータ

名前型説明
columnNameString列の名前。

戻る

Integer - 列の幅。列がデフォルトの幅を使用する場合は null。

承認

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

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

getDataSource()

オブジェクトがリンクされているデータソースを取得します。

戻る

DataSource - データソース。

承認

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

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

getFilters()

データソース シートに適用されているすべてのフィルタを返します。

戻る

DataSourceSheetFilter[] - データソース シートに適用されているすべてのフィルタの配列。

承認

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

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

getSheetValues(columnName)

指定された列名のデータソース シートのすべての値を返します。

パラメータ

名前型説明
columnNameString値を取得するデータソースの列名。

戻る

Object[] - 値の 1 次元配列。

承認

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

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

getSheetValues(columnName, startRow, numRows)

指定された列名のデータソース シートのすべての値を返します。 開始行（1 を基準とする）から、指定された numRows まで。

パラメータ

名前型説明
columnNameString値をフェッチするデータソースの列名。
startRowInteger値の取得を開始する行の位置。
numRowsInteger取得する行数。

戻る

Object[] - 値の 1 次元配列。

承認

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

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

getSortSpecs()

データソース シートのすべての並べ替え仕様を取得します。

戻る

SortSpec[] - 並べ替え仕様のリスト。

承認

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

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

getStatus()

オブジェクトのデータ実行ステータスを取得します。

戻る

DataExecutionStatus - データの実行ステータス。

承認

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

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

refreshData()

オブジェクトのデータを更新します。

現在 error 状態の場合、例外をスローします。DataSource#updateSpec() を使用して仕様を更新します。メソッドは次のとおりです。 データソースで予期しない編集が行われないように、forceRefreshData() より優先します。

データソース タイプが有効になっていない場合、例外をスローします。SpreadsheetApp#enable...Execution() メソッドを使用して、特定のデータソースのデータ実行を有効にする あります。

戻る

DataSourceSheet - データ オブジェクト。

承認

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

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

removeFilters(columnName)

データソース シートの列に適用されているすべてのフィルタを削除します。

パラメータ

名前型説明
columnNameStringフィルタを削除する列の名前。

戻る

DataSourceSheet - メソッド チェーン用のデータソース シート。

承認

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

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

removeSortSpec(columnName)

データソース シートの列の並べ替え指定を削除します。

パラメータ

名前型説明
columnNameString列の名前。

戻る

DataSourceSheet - チェーン用のデータソース シート。

承認

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

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

setColumnWidth(columnName, width)

指定された列の幅を設定します。

パラメータ

名前型説明
columnNameString列の名前。
widthInteger列の新しい幅。

戻る

DataSourceSheet - チェーン用のデータソース シート。

承認

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

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

setColumnWidths(columnNames, width)

指定された列の幅を設定します。

パラメータ

名前型説明
columnNamesString[]更新する列名のリスト。
widthInteger列の新しい幅。

戻る

DataSourceSheet - チェーン用のデータソース シート。

承認

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

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

setSortSpec(columnName, ascending)

データソース シートの列で並べ替え仕様を設定します。

パラメータ

名前型説明
columnNameString並べ替える列の名前。
ascendingBooleantrue の場合、列を昇順で並べ替えます。false の場合、並べ替える 降順で並べ替えます

戻る

DataSourceSheet - チェーン用のデータソース シート。

承認

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

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

setSortSpec(columnName, sortOrder)

データソース シートの列で並べ替え仕様を設定します。

パラメータ

名前型説明
columnNameString並べ替える列の名前。
sortOrderSortOrder並べ替え順序。

戻る

DataSourceSheet - チェーン用のデータソース シート。

承認

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

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

waitForCompletion(timeoutInSeconds)

現在の実行が完了するまで待機し、指定された秒数が経過するとタイムアウトします。 タイムアウト時に実行が完了していない場合に例外をスローしますが、 データの実行に集中できます

パラメータ

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

戻る

DataExecutionStatus - データの実行ステータス。

承認

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

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