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

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

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

パラメータ

名前	型	説明
`columnName`	`String`	このフィルタを適用する列の名前。
`filterCriteria`	`FilterCriteria`	適用するフィルタ条件。

戻る

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

指定した列の幅を自動的に調整します。

パラメータ

名前	型	説明
`columnName`	`String`	列の名前。

戻る

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

承認

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

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

`autoResizeColumns(columnNames)`

指定した列の幅を自動的に調整します。

パラメータ

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

戻る

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() をご覧ください。

戻る

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

承認

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

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

`getColumnWidth(columnName)`

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

パラメータ

名前	型	説明
`columnName`	`String`	列の名前。

戻る

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

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

パラメータ

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

戻る

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

承認

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

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

`getSheetValues(columnName, startRow, numRows)`

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

パラメータ

名前	型	説明
`columnName`	`String`	値を取得するデータソースの列名。
`startRow`	`Integer`	値の取得を開始する行位置。
`numRows`	`Integer`	取得する行数。

戻る

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() よりも優先されます。

戻る

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

承認

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

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

`removeFilters(columnName)`

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

パラメータ

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

戻る

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

承認

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

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

`removeSortSpec(columnName)`

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

パラメータ

名前	型	説明
`columnName`	`String`	列の名前。

戻る

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

承認

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

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

`setColumnWidth(columnName, width)`

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

パラメータ

名前	型	説明
`columnName`	`String`	列の名前。
`width`	`Integer`	列の新しい幅。

戻る

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

承認

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

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

`setColumnWidths(columnNames, width)`

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

パラメータ

名前	型	説明
`columnNames`	`String[]`	更新する列名のリスト。
`width`	`Integer`	列の新しい幅。

戻る

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

承認

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

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

`setSortSpec(columnName, ascending)`

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

パラメータ

名前	型	説明
`columnName`	`String`	並べ替える列の名前。
`ascending`	`Boolean`	`true` の場合は列を昇順で並べ替え、`false` の場合は列を降順で並べ替えます。

戻る

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

承認

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

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

`setSortSpec(columnName, sortOrder)`

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

パラメータ

名前	型	説明
`columnName`	`String`	並べ替える列の名前。
`sortOrder`	`SortOrder`	並べ替え順序。

戻る

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

承認

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

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

`waitForCompletion(timeoutInSeconds)`

指定された秒数経過後にタイムアウトし、現在の実行が完了するまで待機します。タイムアウト時に実行が完了しなかった場合は例外をスローしますが、データ実行はキャンセルしません。

パラメータ

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

戻る

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

承認

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

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