此页面由 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.getValue()` 和 `Range.getValues()` 从 Google 表格服务的 Range 类返回的值类型的枚举。除了 `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`	使用给定网址打开电子表格。
`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
const ssNew = SpreadsheetApp.create('Finances');
Logger.log(ssNew.getUrl());

参数

名称	类型	说明
`name`	`String`	电子表格的名称。

Spreadsheet - 新建电子表格

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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
const ssNew = SpreadsheetApp.create('Finances', 50, 5);
Logger.log(ssNew.getUrl());

参数

名称	类型	说明
`name`	`String`	电子表格的名称。
`rows`	`Integer`	电子表格的行数。
`columns`	`Integer`	电子表格的列数。

Spreadsheet - 新建电子表格

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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() {
  const sheet = SpreadsheetApp.getActiveSheet();
  for (let 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 - 活动的 Spreadsheet 对象

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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.
const colorObject = SpreadsheetApp.getActiveRange().getBackgroundObject();
// Assume the color has ColorType.RGB.
Logger.log(colorObject.asRgbColor().asHexString());

Range - 有效范围。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`getActiveRangeList()`

返回活动工作表中的有效范围列表，如果未选择任何范围，则返回 null。包含当前突出显示单元格的活动范围会放在列表的最后。

如果只选择了一个范围，则此操作的行为类似于 getActiveRange() 调用。

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

RangeList - 有效范围的列表

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`getActiveSheet()`

获取电子表格中的活动工作表。

电子表格中的活动工作表是指在电子表格界面中显示的工作表。

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

Sheet - 活动的 Sheet 对象

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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 - 活动的 Spreadsheet 对象

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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.
const currentCell = SpreadsheetApp.getCurrentCell();

Range - 当前单元格

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`getSelection()`

返回电子表格中的当前 Selection。

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

Selection - 当前选择

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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 创建构建器。

const 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.
const sheet = SpreadsheetApp.getActive().getActiveSheet();
const range = sheet.getRange('A1:B3');
const rule = SpreadsheetApp.newConditionalFormatRule()
                 .whenNumberBetween(1, 10)
                 .setBackground('#FF0000')
                 .setRanges([range])
                 .build();
const 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()`

为数据验证规则创建构建器。

const cell = SpreadsheetApp.getActive().getRange('A1');
const 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.
const cell = SpreadsheetApp.getActive().getRange('A1');
const bold = SpreadsheetApp.newTextStyle().setBold(true).build();
const 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.
const range = SpreadsheetApp.getActive().getRange('A1:B3');
const 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.
const files = DriveApp.searchFiles(
    `starred = true and mimeType = "${MimeType.GOOGLE_SHEETS}"`,
);
while (files.hasNext()) {
  const spreadsheet = SpreadsheetApp.open(files.next());
  const sheet = spreadsheet.getSheets()[0];
  Logger.log(sheet.getName());
}

参数

名称	类型	说明
`file`	`File`	要打开的文件。

Spreadsheet - 电子表格

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`openById(id)`

打开具有指定 ID 的电子表格。您可以从电子表格的网址中提取电子表格 ID。例如，在网址 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).
const ss = SpreadsheetApp.openById('abc1234567');
Logger.log(ss.getName());

参数

名称	类型	说明
`id`	`String`	电子表格的唯一标识符。

Spreadsheet - 具有指定 ID 的 Google 表格对象

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`openByUrl(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).
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc1234567/edit',
);
console.log(ss.getName());

参数

名称	类型	说明
`url`	`String`	电子表格的网址。

Spreadsheet - 具有指定网址的电子表格对象。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`setActiveRange(range)`

将指定范围设置为 active range，并将范围中的左上角单元格设置为 current cell。

电子表格界面会显示包含所选范围的工作表，并选择所选范围中定义的单元格。

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

const selection = SpreadsheetApp.getSelection();
// Current cell: C1
const currentCell = selection.getCurrentCell();
// Active Range: C1:D4
const 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.
const rangeList = SpreadsheetApp.getActiveSheet().getRanges(['D4', 'B2:C4']);
SpreadsheetApp.setActiveRangeList(rangeList);

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

参数

名称	类型	说明
`rangeList`	`RangeList`	要选择的范围列表。

RangeList - 新选择的范围列表

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`setActiveSheet(sheet)`

设置电子表格中的活动工作表。Google 表格界面会显示所选的工作表，除非该工作表属于其他电子表格。

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

参数

名称	类型	说明
`sheet`	`Sheet`	新的活动工作表。

Sheet - 已成为新活动表格的表格

`setActiveSheet(sheet, restoreSelection)`

设置电子表格中的活动工作表，并可选择恢复该工作表中的最近选择。Google 表格界面会显示所选的工作表，除非该工作表属于其他电子表格。

const spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
const firstSheet = spreadsheet.getSheets()[0];
const 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
const range = spreadsheet.getActiveSheet().getSelection().getActiveRange();
Logger.log(range.getA1Notation());

参数

名称	类型	说明
`sheet`	`Sheet`	新的活动工作表。
`restoreSelection`	`Boolean`	如果为 `true`，则新活动工作表的最新选择会在该工作表变为活动状态时重新选中；如果为 `false`，则新工作表会变为活动状态，而不会更改当前的选择。

Sheet - 新的活动工作表

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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
const ss = SpreadsheetApp.openById('1234567890');
SpreadsheetApp.setActiveSpreadsheet(ss);

参数

名称	类型	说明
`newActiveSpreadsheet`	`Spreadsheet`	要设为活动电子表格的电子表格。

`setCurrentCell(cell)`

将指定单元格设置为 current cell。

如果指定的单元格位于已选范围内，则该范围会成为活动范围，该单元格会成为当前单元格。

如果指定的单元格不在任何所选范围内，则系统会移除现有选择，并将该单元格设为当前单元格和活动范围。

注意：指定的 Range 必须由一个单元格组成，否则此方法会抛出异常。

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

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

参数

名称	类型	说明
`cell`	`Range`	要设置为当前单元格的单元格。

Range - 新设置的当前单元格

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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