既存のデータソース シートにアクセスして変更します。新しいデータソース シートを作成するには、Spreadsheet.insertDataSourceSheet(spec)
を使用します。
このクラスは、データベースに接続されているデータでのみ使用してください。
方法
詳細なドキュメント
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()
をご覧ください。
データソース タイプが有効になっていない場合は、例外をスローします。特定のデータソース タイプでデータ実行を有効にするには、SpreadsheetApp#enable...Execution()
メソッドを使用します。
リターン
DataSourceSheet
- データ オブジェクト。
認可
このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getColumnWidth(columnName)
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)
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()
よりも推奨されています。
データソース タイプが有効になっていない場合は、例外をスローします。特定のデータソース タイプでデータ実行を有効にするには、SpreadsheetApp#enable...Execution()
メソッドを使用します。
リターン
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