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

Class SpreadsheetApp

Google スプレッドシートファイルにアクセスして作成する。このクラスは、スプレッドシートサービスの親クラスです。

プロパティ

プロパティ	タイプ	説明
`AutoFillSeries`	`AutoFillSeries`	自動入力された値の計算に使用される系列の型を列挙します。
`BandingTheme`	`BandingTheme`	考えられるバンディングテーマの列挙。
`BooleanCriteria`	`BooleanCriteria`	条件付き書式のブール型条件の列挙型です。
`BorderStyle`	`BorderStyle`	`Range` の枠線の設定に有効なスタイルの列挙。
`ColorType`	`ColorType`	使用可能な色の型の列挙型。
`CopyPasteType`	`CopyPasteType`	可能な貼り付けタイプの列挙型。
`DataExecutionErrorCode`	`DataExecutionErrorCode`	発生する可能性のあるデータ実行エラーコードの列挙。
`DataExecutionState`	`DataExecutionState`	データ実行の状態を列挙したものです。
`DataSourceParameterType`	`DataSourceParameterType`	使用可能なデータソースのパラメータ型の列挙型。
`DataSourceRefreshScope`	`DataSourceRefreshScope`	データソース更新スコープの列挙。
`DataSourceType`	`DataSourceType`	有効なデータソースタイプの列挙。
`DataValidationCriteria`	`DataValidationCriteria`	範囲に設定できるデータの入力規則を表す列挙型。
`DateTimeGroupingRuleType`	`DateTimeGroupingRuleType`	日時のグループ化ルールの列挙。
`DeveloperMetadataLocationType`	`DeveloperMetadataLocationType`	デベロッパーメタデータのロケーションタイプの列挙。
`DeveloperMetadataVisibility`	`DeveloperMetadataVisibility`	デベロッパーメタデータの公開設定のリスト。
`Dimension`	`Dimension`	スプレッドシートで使用可能なディメンションの列挙。
`Direction`	`Direction`	矢印を使用してスプレッドシート内で移動できる可能性のある方向の列挙できます。
`FrequencyType`	`FrequencyType`	有効な頻度タイプの列挙。
`GroupControlTogglePosition`	`GroupControlTogglePosition`	グループコントロールの切り替えが配置可能な位置を列挙したものです。
`InterpolationType`	`InterpolationType`	条件付き形式勾配補間タイプの列挙型。
`PivotTableSummarizeFunction`	`PivotTableSummarizeFunction`	ピボットテーブル内の値を集計するために使用できる関数の列挙です。
`PivotValueDisplayType`	`PivotValueDisplayType`	ピボット値の表示方法の列挙。
`ProtectionType`	`ProtectionType`	編集から保護できるスプレッドシートの各部分を表す列挙型。
`RecalculationInterval`	`RecalculationInterval`	スプレッドシートの再計算で使用できる間隔の列挙。
`RelativeDate`	`RelativeDate`	日付ベースの `BooleanCriteria` で使用する値を計算するための相対日付オプションの列挙。
`SheetType`	`SheetType`	スプレッドシートに含めることができるさまざまな種類のシートを列挙します。
`SortOrder`	`SortOrder`	並べ替え順序の列挙。
`TextDirection`	`TextDirection`	有効なテキスト方向の列挙。
`TextToColumnsDelimiter`	`TextToColumnsDelimiter`	テキストを列に分割するためのプリセット区切り文字の列挙。
`ThemeColorType`	`ThemeColorType`	テーマのカラータイプの列挙。
`ValueType`	`ValueType`	スプレッドシートサービスの Range クラスから `Range.getValue()` と `Range.getValues()` によって返される値の型の列挙型。列挙値 `Number`、`Boolean`、`Date`、`String` に加えて、以下のリストに示すリストがあります。
`WrapStrategy`	`WrapStrategy`	セルの折り返しに使用する戦略の列挙。

メソッド

メソッド	戻り値の型	概要
`create(name)`	`Spreadsheet`	指定した名前で新しいスプレッドシートを作成します。
`create(name, rows, columns)`	`Spreadsheet`	指定した名前、指定された行数と列数で新しいスプレッドシートを作成します。
`enableAllDataSourcesExecution()`	`void`	すべてのタイプのデータソースに対してデータ実行を有効にします。
`enableBigQueryExecution()`	`void`	BigQuery データソースのデータ実行を有効にします。
`enableLookerExecution()`	`void`	Looker データソースのデータ実行を有効にします。
`flush()`	`void`	スプレッドシートの保留中の変更をすべて適用します。
`getActive()`	`Spreadsheet`	現在アクティブなスプレッドシートを返します。アクティブなスプレッドシートがない場合、`null` を返します。
`getActiveRange()`	`Range`	アクティブシートで選択した範囲を返します。アクティブ範囲がない場合は `null` を返します。
`getActiveRangeList()`	`RangeList`	アクティブシート内のアクティブな範囲のリストを返します。範囲がない場合は `null` を返します。選択済みです。
`getActiveSheet()`	`Sheet`	スプレッドシート内のアクティブなシートを取得します。
`getActiveSpreadsheet()`	`Spreadsheet`	現在アクティブなスプレッドシートを返します。スプレッドシートがない場合は `null` を返します。
`getCurrentCell()`	`Range`	現在のセル（ハイライト表示されたセル）で、アクティブシート。現在のセルがない場合は `null`。
`getSelection()`	`Selection`	スプレッドシート内の現在の `Selection` を返します。
`getUi()`	`Ui`	スクリプトによる操作を許可するスプレッドシートのユーザーインターフェース環境のインスタンスを返します。メニュー、ダイアログ、サイドバーなどの機能を追加できます。
`newCellImage()`	`CellImageBuilder`	`CellImage` のビルダーを作成します。
`newColor()`	`ColorBuilder`	`Color` のビルダーを作成します。
`newConditionalFormatRule()`	`ConditionalFormatRuleBuilder`	条件付き書式ルールのビルダーを作成します。
`newDataSourceSpec()`	`DataSourceSpecBuilder`	`DataSourceSpec` のビルダーを作成します。
`newDataValidation()`	`DataValidationBuilder`	データ入力規則のビルダーを作成します。
`newFilterCriteria()`	`FilterCriteriaBuilder`	`FilterCriteria` のビルダーを作成します。
`newRichTextValue()`	`RichTextValueBuilder`	リッチテキスト値のビルダーを作成します。
`newTextStyle()`	`TextStyleBuilder`	テキストスタイルのビルダーを作成します。
`open(file)`	`Spreadsheet`	指定された File オブジェクトに対応するスプレッドシートを開きます。
`openById(id)`	`Spreadsheet`	指定された ID のスプレッドシートを開きます。
`openByUrl(url)`	`Spreadsheet`	指定された URL のスプレッドシートを開きます。
`setActiveRange(range)`	`Range`	指定された範囲を `active range` として設定します。範囲内の左側のセルを `current cell` として指定します。
`setActiveRangeList(rangeList)`	`RangeList`	指定された範囲リストを `active ranges` として設定します。
`setActiveSheet(sheet)`	`Sheet`	スプレッドシート内のアクティブなシートを設定します。
`setActiveSheet(sheet, restoreSelection)`	`Sheet`	スプレッドシート内のアクティブなシートを設定します。最新の選択内容を復元するオプションもあります。確認できます。
`setActiveSpreadsheet(newActiveSpreadsheet)`	`void`	アクティブなスプレッドシートを設定します。
`setCurrentCell(cell)`	`Range`	指定されたセルを `current cell` として設定します。

詳細なドキュメント

`create(name)`

指定した名前で新しいスプレッドシートを作成します。

// The code below creates a new spreadsheet "Finances" and logs the URL for it
var ssNew = SpreadsheetApp.create("Finances");
Logger.log(ssNew.getUrl());

パラメータ

名前	型	説明
`name`	`String`	スプレッドシートの名前。

戻る

Spreadsheet - 新しいスプレッドシート

承認

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

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

`create(name, rows, columns)`

指定した名前、指定された行数と列数で新しいスプレッドシートを作成します。

// The code below creates a new spreadsheet "Finances" with 50 rows and 5 columns and logs the
// URL for it
var ssNew = SpreadsheetApp.create("Finances", 50, 5);
Logger.log(ssNew.getUrl());

パラメータ

名前	型	説明
`name`	`String`	スプレッドシートの名前。
`rows`	`Integer`	スプレッドシートの行数。
`columns`	`Integer`	スプレッドシートの列数。

戻る

Spreadsheet - 新しいスプレッドシート

承認

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

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

`enableAllDataSourcesExecution()`

すべてのタイプのデータソースに対してデータ実行を有効にします。

データソースタイプがオンになっていない場合、データの実行は例外をスローします。この方法を使用すべてのデータソースタイプに対してデータ実行を有効にします。

// Turns data execution on for all types of data sources.
SpreadsheetApp.enableAllDataSourcesExecution();

// Opens the spreadsheet file by its ID. If you created your script from a Google Sheets file,
// use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

// Gets the first data source sheet in the spreadsheet and refreshes the data.
ss.getDataSourceSheets()[0].refreshData();

承認

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

https://www.googleapis.com/auth/bigquery.readonly

`enableBigQueryExecution()`

BigQuery データソースのデータ実行を有効にします。

有効になっていない場合、BigQuery データソースのデータの実行は例外をスローします。

// Turns data execution on for BigQuery data sources.
SpreadsheetApp.enableBigQueryExecution();

// Opens the spreadsheet file by its ID. If you created your script from a Google Sheets file,
// use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

// Gets the first data source sheet in the spreadsheet and refreshes the BigQuery data.
ss.getDataSourceSheets()[0].refreshData();

承認

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

https://www.googleapis.com/auth/bigquery.readonly

`enableLookerExecution()`

Looker データソースのデータ実行を有効にします。

有効になっていない場合、Looker データソースのデータの実行は例外をスローします。

// Turns data execution on for Looker data sources.
SpreadsheetApp.enableLookerExecution();

// Opens the spreadsheet file by its ID. If you created your script from a Google Sheets file,
// use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

// Gets the first data source sheet in the spreadsheet and refreshes the associated Looker
// data.
ss.getDataSourceSheets()[0].refreshData();

`flush()`

スプレッドシートの保留中の変更をすべて適用します。

スプレッドシートの操作は、パフォーマンスを高めるために次のような形でバンドルされることがあります。 Range.getValue() を複数回呼び出している場合。とはいえ、すべてのリソースにたとえば、スクリプトの実行中にユーザーデータを表示するなど、保留中の変更はすぐに行われます。

// The code below changes the background color of cells A1 and B1 twenty times. You should be
// able to see the updates live in the spreadsheet. If flush() is not called, the updates may
// be applied live or may all be applied at once when the script completes.
function colors() {
  var sheet = SpreadsheetApp.getActiveSheet();
  for (var i = 0; i < 20; i++) {
    if ((i % 2) == 0) {
      sheet.getRange('A1').setBackground('green');
      sheet.getRange('B1').setBackground('red');
    } else {
      sheet.getRange('A1').setBackground('red');
      sheet.getRange('B1').setBackground('green');
    }
    SpreadsheetApp.flush();
  }
}

`getActive()`

現在アクティブなスプレッドシートを返します。スプレッドシートがない場合は null を返します。

スプレッドシートのコンテキストで実行される関数は、対応する Spreadsheet オブジェクトです。

// The code below logs the URL for the active spreadsheet.
Logger.log(SpreadsheetApp.getActive().getUrl());

戻る

Spreadsheet - アクティブなスプレッドシートオブジェクト

承認

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

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

`getActiveRange()`

アクティブシートで選択した範囲を返します。アクティブ範囲がない場合は null を返します。条件複数の範囲が選択されている場合、このメソッドでは、最後に選択された範囲のみが返されます。

これは通常、ユーザーがアクティブシートで選択した範囲ですが、カスタムシートではアクティブに再計算されているセルを指します。

// The code below logs the background color for the active range.
var colorObject = SpreadsheetApp.getActiveRange().getBackgroundObject();
// Assume the color has ColorType.RGB.
Logger.log(colorObject.asRgbColor().asHexString());

戻る

Range - 有効範囲。

承認

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

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

`getActiveRangeList()`

アクティブシート内のアクティブな範囲のリストを返します。範囲がない場合は null を返します。選択済みです。現在ハイライト表示されているセルを含むアクティブ範囲がリストの最後に配置されます。

範囲が 1 つ選択されている場合、これは getActiveRange() 呼び出しとして動作します。

// Returns the list of active ranges.
var rangeList = SpreadsheetApp.getActiveRangeList();

戻る

RangeList - アクティブな範囲のリスト

承認

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

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

`getActiveSheet()`

スプレッドシート内のアクティブなシートを取得します。

スプレッドシート内のアクティブなシートとは、スプレッドシートに表示されているシートのことです。 UI です。

// The code below logs the name of the active sheet.
Logger.log(SpreadsheetApp.getActiveSheet().getName());

戻る

Sheet - アクティブなシートオブジェクト

承認

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

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

`getActiveSpreadsheet()`

現在アクティブなスプレッドシートを返します。スプレッドシートがない場合は null を返します。

スプレッドシートのコンテキストで実行される関数は、この関数を呼び出して、対応する Spreadsheet オブジェクトを取得します。

// The code below logs the URL for the active spreadsheet.
Logger.log(SpreadsheetApp.getActiveSpreadsheet().getUrl());

戻る

Spreadsheet - アクティブなスプレッドシートオブジェクト

承認

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

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

`getCurrentCell()`

現在のセル（ハイライト表示されたセル）で、アクティブシート。現在のセルがない場合は null。

// Returns the current highlighted cell in the one of the active ranges.
var currentCell = SpreadsheetApp.getCurrentCell();

戻る

Range - 現在のセル

承認

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

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

`getSelection()`

スプレッドシート内の現在の Selection を返します。

var selection = SpreadsheetApp.getSelection();
var currentCell = selection.getCurrentCell();

戻る

Selection - 現在の選択

承認

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

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

`getUi()`

スクリプトによる操作を許可するスプレッドシートのユーザーインターフェース環境のインスタンスを返します。メニュー、ダイアログ、サイドバーなどの機能を追加できます。スクリプトがやり取りできるのは、スクリプトがスプレッドシートにバインドされている場合にのみ、開かれているスプレッドシートの現在のインスタンスを取得します。詳細については、次をご覧ください: メニュー、ダイアログ、サイドバーのガイド。

// Add a custom menu to the active spreadsheet, including a separator and a sub-menu.
function onOpen(e) {
  SpreadsheetApp.getUi()
      .createMenu('My Menu')
      .addItem('My menu item', 'myFunction')
      .addSeparator()
      .addSubMenu(SpreadsheetApp.getUi().createMenu('My sub-menu')
          .addItem('One sub-menu item', 'mySecondFunction')
          .addItem('Another sub-menu item', 'myThirdFunction'))
      .addToUi();
}

戻る

Ui - このスプレッドシートのユーザーインターフェース環境のインスタンス

`newCellImage()`

CellImage のビルダーを作成します。

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets cell A1 on Sheet1.
const range = sheet.getRange('A1');

// Builds an image using a source URL.
const cellImage = SpreadsheetApp.newCellImage()
  .setSourceUrl('https://www.gstatic.com/images/branding/productlogos/apps_script/v10/web-64dp/logo_apps_script_color_1x_web_64dp.png')
  .build();

// Sets the image in cell A1.
range.setValue(cellImage);

戻る

CellImageBuilder - 新しいビルダー。

`newColor()`

Color のビルダーを作成します。

var rgbColor = SpreadsheetApp.newColor().setRgbColor("#FF0000").build();

戻る

ColorBuilder - 新しいビルダー。

`newConditionalFormatRule()`

条件付き書式ルールのビルダーを作成します。

// Adds a conditional format rule to a sheet that causes all cells in range A1:B3 to turn red
// if they contain a number between 1 and 10.
var sheet = SpreadsheetApp.getActive().getActiveSheet();
var range = sheet.getRange('A1:B3');
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenNumberBetween(1, 10)
    .setBackground("#FF0000")
    .setRanges([range])
    .build()
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

戻る

ConditionalFormatRuleBuilder - 新しいビルダー。

`newDataSourceSpec()`

DataSourceSpec のビルダーを作成します。

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Enables BigQuery.
SpreadsheetApp.enableBigQueryExecution();

// Builds a data source specification.
// TODO (developer): Update the project ID to your own Google Cloud project ID.
const dataSourceSpec = SpreadsheetApp.newDataSourceSpec()
  .asBigQuery()
  .setProjectId('project-id-1')
  .setTableProjectId('bigquery-public-data')
  .setDatasetId('ncaa_basketball')
  .setTableId('mbb_historical_teams_games')
  .build();

// Adds the data source and its data to the spreadsheet.
ss.insertDataSourceSheet(dataSourceSpec);

戻る

DataSourceSpecBuilder - 新しいビルダー。

`newDataValidation()`

データ入力規則のビルダーを作成します。

var cell = SpreadsheetApp.getActive().getRange('A1');
var rule = SpreadsheetApp.newDataValidation()
    .requireNumberBetween(1, 100)
    .setAllowInvalid(false)
    .setHelpText('Number must be between 1 and 100.')
    .build();
cell.setDataValidation(rule);

戻る

DataValidationBuilder - 新しいビルダー。

`newFilterCriteria()`

FilterCriteria のビルダーを作成します。

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Sets the range to A1:D20.
const range = sheet.getRange('A1:D20');

// Creates a filter and applies it to the specified range.
range.createFilter();

// Gets the current filter for the range and creates filter criteria that only shows cells
// that aren't empty.
const filter = range.getFilter();
const criteria = SpreadsheetApp.newFilterCriteria().whenCellNotEmpty().build();

// Sets the criteria to  column C.
filter.setColumnFilterCriteria(3, criteria);

戻る

FilterCriteriaBuilder - 新しいビルダー

`newRichTextValue()`

リッチテキスト値のビルダーを作成します。

// Sets cell A1 to have the text "Hello world", with "Hello" bolded.
var cell = SpreadsheetApp.getActive().getRange('A1');
var bold = SpreadsheetApp.newTextStyle().setBold(true).build();
var value = SpreadsheetApp.newRichTextValue()
    .setText("Hello world")
    .setTextStyle(0, 5, bold)
    .build();
cell.setRichTextValue(value);

戻る

RichTextValueBuilder - 新しいビルダー。

`newTextStyle()`

テキストスタイルのビルダーを作成します。

// Sets range A1:B3 to have red, size 22, bolded, underlined text.
var range = SpreadsheetApp.getActive().getRange('A1:B3');
var style = SpreadsheetApp.newTextStyle()
    .setForegroundColor("red")
    .setFontSize(22)
    .setBold(true)
    .setUnderline(true)
    .build();
range.setTextStyle(style);

戻る

TextStyleBuilder - 新しいビルダー。

`open(file)`

指定された File オブジェクトに対応するスプレッドシートを開きます。

// Get any starred spreadsheets from Google Drive, then open the spreadsheets and log the name
// of the first sheet within each spreadsheet.
var files = DriveApp.searchFiles(
    'starred = true and mimeType = "' + MimeType.GOOGLE_SHEETS + '"');
while (files.hasNext()) {
  var spreadsheet = SpreadsheetApp.open(files.next());
  var sheet = spreadsheet.getSheets()[0];
  Logger.log(sheet.getName());
}

パラメータ

名前	型	説明
`file`	`File`	開くファイル。

戻る

Spreadsheet - スプレッドシート

承認

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

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

`openById(id)`

指定された ID のスプレッドシートを開きます。スプレッドシート ID は URL から抽出できます。対象たとえば、URL https://docs.google.com/spreadsheets/d/abc1234567/edit#gid=0 のスプレッドシート ID は「abc1234567」です。

// The code below opens a spreadsheet using its ID and logs the name for it.
// Note that the spreadsheet is NOT physically opened on the client side.
// It is opened on the server only (for modification by the script).
var ss = SpreadsheetApp.openById("abc1234567");
Logger.log(ss.getName());

パラメータ

名前	型	説明
`id`	`String`	スプレッドシートの一意の識別子。

戻る

Spreadsheet - 指定された ID のスプレッドシートオブジェクト

承認

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

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

`openByUrl(url)`

指定された URL のスプレッドシートを開きます。URL が存在しない場合、スクリプト例外をスローします。アクセス権がない場合もあります。

// Opens a spreadsheet by its URL and logs its name.
// Note that the spreadsheet doesn't physically open on the client side.
// It opens on the server only (for modification by the script).
var ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc1234567/edit');
console.log(ss.getName());

パラメータ

名前	型	説明
`url`	`String`	スプレッドシートの URL。

戻る

Spreadsheet - 指定された URL を持つスプレッドシートオブジェクト。

承認

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

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

`setActiveRange(range)`

指定された範囲を active range として設定します。範囲内の左側のセルを current cell として指定します。

選択した範囲を含むシートが表示され、セルを選択するスプレッドシートの UI 表示されます。

// The code below sets range C1:D4 in the first sheet as the active range.
var range = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0].getRange('C1:D4');
SpreadsheetApp.setActiveRange(range);

var selection = SpreadsheetApp.getSelection();
// Current cell: C1
var currentCell = selection.getCurrentCell();
// Active Range: C1:D4
var activeRange = selection.getActiveRange();

パラメータ

名前	型	説明
`range`	`Range`	有効範囲にする範囲。

戻る

Range - 新しいアクティブ範囲

`setActiveRangeList(rangeList)`

指定された範囲リストを active ranges として設定します。最後の active range として設定されます。

// The code below sets ranges [D4, B2:C4] in the active sheet as the active ranges.
var rangeList = SpreadsheetApp.getActiveSheet().getRanges(['D4', 'B2:C4']);
SpreadsheetApp.setActiveRangeList(rangeList);

var selection = SpreadsheetApp.getSelection();
// Current cell: B2
var currentCell = selection.getCurrentCell();
// Active range: B2:C4
var activeRange = selection.getActiveRange();
// Active range list: [D4, B2:C4]
var activeRangeList = selection.getActiveRangeList();

パラメータ

名前	型	説明
`rangeList`	`RangeList`	選択する範囲のリスト。

戻る

RangeList - 新しく選択された範囲のリスト

承認

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

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

`setActiveSheet(sheet)`

スプレッドシート内のアクティブなシートを設定します。選択したシートが Google スプレッドシートの UI に表示されます。シートは別のスプレッドシートに属しています。

// The code below makes the 2nd sheet active in the active spreadsheet.
var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
SpreadsheetApp.setActiveSheet(spreadsheet.getSheets()[1]);

パラメータ

名前	型	説明
`sheet`	`Sheet`	新しいアクティブシート。

戻る

Sheet - 新しいアクティブシートとなったシート

`setActiveSheet(sheet, restoreSelection)`

スプレッドシート内のアクティブなシートを設定します。最新の選択内容を復元するオプションもあります。確認できます。Google スプレッドシートの UI には、選択したシートが表示されます。

var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
var firstSheet = spreadsheet.getSheets()[0];
var secondSheet = spreadsheet.getSheets()[1];
// Set the first sheet as the active sheet and select the range D4:F4.
spreadsheet.setActiveSheet(firstSheet).getRange('D4:F4').activate();

// Switch to the second sheet to do some work.
spreadsheet.setActiveSheet(secondSheet);
// Switch back to first sheet, and restore its selection.
spreadsheet.setActiveSheet(firstSheet, true);

// The selection of first sheet is restored, and it logs D4:F4
var range = spreadsheet.getActiveSheet().getSelection().getActiveRange();
Logger.log(range.getA1Notation());

パラメータ

名前	型	説明
`sheet`	`Sheet`	新しいアクティブシート。
`restoreSelection`	`Boolean`	`true` の場合、新しいアクティブシートの最新の選択新しいシートがアクティブになると、再度選択されます。`false` の場合、新しいシート有効になります。

戻る

Sheet - 新しいアクティブシート

承認

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

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

`setActiveSpreadsheet(newActiveSpreadsheet)`

アクティブなスプレッドシートを設定します。

// The code below makes the spreadsheet with key "1234567890" the active spreadsheet
var ss = SpreadsheetApp.openById("1234567890");
SpreadsheetApp.setActiveSpreadsheet(ss);

パラメータ

名前	型	説明
`newActiveSpreadsheet`	`Spreadsheet`	アクティブなスプレッドシートにするスプレッドシート。

`setCurrentCell(cell)`

指定されたセルを current cell として設定します。

指定したセルが、すでに選択されている範囲内に存在する場合、その範囲は現在のセルとして選択されます。

指定したセルが選択した範囲にない場合、既存の選択範囲は削除され、そのセルが現在のセルとそのアクティブ範囲になります。

注: 指定する Range は 1 つのセルで構成する必要があります。それ以外の場合は、このメソッドを使用します。例外をスローします。

// The code below sets the cell B5 in the first sheet as the current cell.
var cell = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0].getRange('B5');
SpreadsheetApp.setCurrentCell(cell);

var selection = SpreadsheetApp.getSelection();
// Current cell: B5
var currentCell = selection.getCurrentCell();

パラメータ

名前	型	説明
`cell`	`Range`	現在のセルとして設定するセル。

戻る

Range - 新しく設定された現在のセル

承認

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

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