Эта страница переведена с помощью Cloud Translation API.

Class SpreadsheetApp

Доступ и создание файлов Google Sheets. Этот класс является родительским классом для службы электронных таблиц .

Характеристики

Свойство	Тип	Описание
`Auto Fill Series`	`Auto Fill Series`	Перечисление типов рядов, используемых для расчета автоматически заполняемых значений.
`Banding Theme`	`Banding Theme`	Перечень возможных тем оформления.
`Boolean Criteria`	`Boolean Criteria`	Перечисление логических критериев условного форматирования.
`Border Style`	`Border Style`	Перечисление допустимых стилей для установки границ `Range` .
`Color Type`	`Color Type`	Перечисление возможных цветотипов.
`Copy Paste Type`	`Copy Paste Type`	Перечень возможных типов пасты.
`Data Execution Error Code`	`Data Execution Error Code`	Перечень возможных кодов ошибок выполнения данных.
`Data Execution State`	`Data Execution State`	Перечисление возможных состояний выполнения данных.
`Data Source Parameter Type`	`Data Source Parameter Type`	Перечисление возможных типов параметров источника данных.
`Data Source Refresh Scope`	`Data Source Refresh Scope`	Перечень возможных областей обновления источника данных.
`Data Source Type`	`Data Source Type`	Перечисление возможных типов источников данных.
`Data Validation Criteria`	`Data Validation Criteria`	Перечисление, представляющее критерии проверки данных, которые можно задать для диапазона.
`Date Time Grouping Rule Type`	`Date Time Grouping Rule Type`	Перечисление правила группировки даты и времени.
`Developer Metadata Location Type`	`Developer Metadata Location Type`	Перечень возможных типов расположения метаданных разработчика.
`Developer Metadata Visibility`	`Developer Metadata Visibility`	Перечень возможных возможностей видимости метаданных разработчика.
`Dimension`	`Dimension`	Перечисление возможных размеров электронной таблицы.
`Direction`	`Direction`	Перечисление возможных направлений, в которых можно перемещаться по электронной таблице с помощью клавиш со стрелками.
`Frequency Type`	`Frequency Type`	Перечень возможных типов частот.
`Group Control Toggle Position`	`Group Control Toggle Position`	Перечень положений, в которых может находиться переключатель группового управления.
`Interpolation Type`	`Interpolation Type`	Перечисление типов интерполяции градиента условного формата.
`Pivot Table Summarize Function`	`Pivot Table Summarize Function`	Перечисление функций, которые можно использовать для суммирования значений в сводной таблице.
`Pivot Value Display Type`	`Pivot Value Display Type`	Перечисление способов отображения сводного значения.
`Protection Type`	`Protection Type`	Перечисление, представляющее части электронной таблицы, которые можно защитить от изменений.
`Recalculation Interval`	`Recalculation Interval`	Перечисление возможных интервалов, которые можно использовать при пересчете электронной таблицы.
`Relative Date`	`Relative Date`	Перечисление параметров относительной даты для вычисления значения, которое будет использоваться в `Boolean Criteria` на основе даты.
`Sheet Type`	`Sheet Type`	Перечисление различных типов листов, которые могут существовать в электронной таблице.
`Sort Order`	`Sort Order`	Перечисление порядка сортировки.
`Text Direction`	`Text Direction`	Перечень допустимых направлений текста.
`Text To Columns Delimiter`	`Text To Columns Delimiter`	Перечисление предустановленных разделителей для разделения текста на столбцы.
`Theme Color Type`	`Theme Color Type`	Перечень возможных цветовых типов темы.
`Value Type`	`Value Type`	Перечисление типов значений, возвращаемых методами `Range.getValue()` и `Range.getValues()` из класса Range службы электронных таблиц. Перечисленные ниже значения перечисления дополняют `Number` , `Boolean` , `Date` или `String` .
`Wrap Strategy`	`Wrap Strategy`	Перечень стратегий, используемых для переноса ячеек.

Методы

Метод	Тип возврата	Краткое описание
`create(name)`	`Spreadsheet`	Создает новую электронную таблицу с заданным именем.
`create(name, rows, columns)`	`Spreadsheet`	Создает новую электронную таблицу с заданным именем и указанным количеством строк и столбцов.
`enable All Data Sources Execution()`	`void`	Включает выполнение данных для всех типов источников данных.
`enable Big Query Execution()`	`void`	Включает выполнение данных для источников данных BigQuery.
`enable Looker Execution()`	`void`	Включает выполнение данных для источников данных Looker.
`flush()`	`void`	Применяет все ожидающие изменения таблицы.
`get Active()`	`Spreadsheet`	Возвращает текущую активную электронную таблицу или `null` , если ее нет.
`get Active Range()`	`Range`	Возвращает выбранный диапазон на активном листе или `null` , если активного диапазона нет.
`get Active Range List()`	`Range List`	Возвращает список активных диапазонов на активном листе или `null` , если диапазоны не выбраны.
`get Active Sheet()`	`Sheet`	Получает активный лист в электронной таблице.
`get Active Spreadsheet()`	`Spreadsheet`	Возвращает текущую активную электронную таблицу или `null` , если ее нет.
`get Current Cell()`	`Range`	Возвращает текущую (выделенную) ячейку, выбранную в одном из активных диапазонов на активном листе, или `null` если текущей ячейки нет.
`get Selection()`	`Selection`	Возвращает текущий `Selection` в электронной таблице.
`get Ui()`	`Ui`	Возвращает экземпляр среды пользовательского интерфейса электронной таблицы, который позволяет сценарию добавлять такие функции, как меню, диалоговые окна и боковые панели.
`new Cell Image()`	`Cell Image Builder`	Создает построитель для `Cell Image` .
`new Color()`	`Color Builder`	Создает построитель для `Color` .
`new Conditional Format Rule()`	`Conditional Format Rule Builder`	Создает построитель для правила условного форматирования.
`new Data Source Spec()`	`Data Source Spec Builder`	Создает построитель для `Data Source Spec` .
`new Data Validation()`	`Data Validation Builder`	Создает построитель для правила проверки данных.
`new Filter Criteria()`	`Filter Criteria Builder`	Создает построитель для `Filter Criteria` .
`new Rich Text Value()`	`Rich Text Value Builder`	Создает построитель для значения форматированного текста.
`new Text Style()`	`Text Style Builder`	Создает построитель для текстового стиля.
`open(file)`	`Spreadsheet`	Открывает электронную таблицу, соответствующую данному объекту File.
`open By Id(id)`	`Spreadsheet`	Открывает таблицу с указанным идентификатором.
`open By Url(url)`	`Spreadsheet`	Открывает таблицу с указанным URL-адресом.
`set Active Range(range)`	`Range`	Устанавливает указанный диапазон в качестве `active range` , при этом верхняя левая ячейка диапазона становится `current cell` .
`set Active Range List(rangeList)`	`Range List`	Устанавливает указанный список диапазонов в качестве `active ranges` .
`set Active Sheet(sheet)`	`Sheet`	Устанавливает активный лист в электронной таблице.
`set Active Sheet(sheet, restoreSelection)`	`Sheet`	Устанавливает активный лист в электронной таблице с возможностью восстановить самый последний выбор на этом листе.
`set Active Spreadsheet(newActiveSpreadsheet)`	`void`	Устанавливает активную электронную таблицу.
`set Current Cell(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

`enable All Data Sources Execution()`

Включает выполнение данных для всех типов источников данных.

При выполнении данных выдается исключение, если тип источника данных не включен. Используйте этот метод, чтобы включить выполнение данных для всех типов источников данных.

// 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

`enable Big Query Execution()`

Включает выполнение данных для источников данных 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

`enable Looker Execution()`

Включает выполнение данных для источников данных 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();
  }
}

`get Active()`

Возвращает текущую активную электронную таблицу или null , если ее нет.

Функции, выполняемые в контексте электронной таблицы, могут получить ссылку на соответствующий объект электронной таблицы, вызвав эту функцию.

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

Возвращаться

Spreadsheet — активный объект электронной таблицы.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

`get Active Range()`

Возвращает выбранный диапазон на активном листе или 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

`get Active Range List()`

Возвращает список активных диапазонов на активном листе или null , если диапазоны не выбраны. Активный диапазон, содержащий текущую выделенную ячейку, помещается последним в списке.

Если выбран один диапазон, это ведет себя как вызов get Active Range() .

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

Возвращаться

Range List — список активных диапазонов.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

`get Active Sheet()`

Получает активный лист в электронной таблице.

Активный лист в электронной таблице — это лист, который отображается в пользовательском интерфейсе электронной таблицы.

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

Возвращаться

Sheet — активный объект Листа.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

`get Active Spreadsheet()`

Возвращает текущую активную электронную таблицу или null , если ее нет.

Функции, выполняемые в контексте электронной таблицы, могут получить ссылку на соответствующий объект Spreadsheet , вызвав эту функцию.

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

Возвращаться

Spreadsheet — активный объект электронной таблицы.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

`get Current Cell()`

Возвращает текущую (выделенную) ячейку, выбранную в одном из активных диапазонов на активном листе, или 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

`get Selection()`

Возвращает текущий Selection в электронной таблице.

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

Возвращаться

Selection — текущий выбор

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

`get Ui()`

Возвращает экземпляр среды пользовательского интерфейса электронной таблицы, который позволяет сценарию добавлять такие функции, как меню, диалоговые окна и боковые панели. Сценарий может взаимодействовать только с пользовательским интерфейсом текущего экземпляра открытой электронной таблицы и только в том случае, если сценарий привязан к электронной таблице. Дополнительную информацию см. в руководствах по меню , диалоговым окнам и боковым панелям .

// 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 — экземпляр среды пользовательского интерфейса этой электронной таблицы.

`new Cell Image()`

Создает построитель для Cell Image .

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

Возвращаться

Cell Image Builder — новый конструктор.

`new Color()`

Создает построитель для Color .

const rgbColor = SpreadsheetApp.newColor().setRgbColor('#FF0000').build();

Возвращаться

Color Builder — Новый строитель.

`new Conditional Format Rule()`

Создает построитель для правила условного форматирования.

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

Возвращаться

Conditional Format Rule Builder — новый построитель.

`new Data Source Spec()`

Создает построитель для Data Source Spec .

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

Возвращаться

Data Source Spec Builder — новый конструктор.

`new Data Validation()`

Создает построитель для правила проверки данных.

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

Возвращаться

Data Validation Builder — новый конструктор.

`new Filter Criteria()`

Создает построитель для Filter Criteria .

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

Возвращаться

Filter Criteria Builder — новый конструктор

`new Rich Text Value()`

Создает построитель для значения форматированного текста.

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

Возвращаться

Rich Text Value Builder — новый построитель.

`new Text Style()`

Создает построитель для текстового стиля.

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

Возвращаться

Text Style Builder — новый конструктор.

`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

`open By Id(id)`

Открывает таблицу с указанным идентификатором. Идентификатор электронной таблицы можно извлечь из ее URL-адреса. Например, идентификатор электронной таблицы в URL-адресе https://docs.google.com/spreadsheets/d/abc1234567/edit#gid=0 — «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 — объект «Электронная таблица» с заданным идентификатором.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

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

Параметры

Имя	Тип	Описание
`url`	`String`	URL-адрес электронной таблицы.

Возвращаться

Spreadsheet — объект электронной таблицы с заданным URL-адресом.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

`set Active Range(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 — новый активный диапазон.

`set Active Range List(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();

Параметры

Имя	Тип	Описание
`range List`	`Range List`	Список диапазонов для выбора.

Возвращаться

Range List — вновь выбранный список диапазонов.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

`set Active Sheet(sheet)`

Устанавливает активный лист в электронной таблице. Пользовательский интерфейс Google Sheets отображает выбранный лист, если только он не принадлежит другой электронной таблице.

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

Параметры

Имя	Тип	Описание
`sheet`	`Sheet`	Новый активный лист.

Возвращаться

Sheet — лист, который стал новым активным листом.

`set Active Sheet(sheet, restoreSelection)`

Устанавливает активный лист в электронной таблице с возможностью восстановить самый последний выбор на этом листе. Пользовательский интерфейс Google Sheets отображает выбранный лист, если только он не принадлежит другой электронной таблице.

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`	Новый активный лист.
`restore Selection`	`Boolean`	Если `true` , последний выбор нового активного листа становится выбранным снова, когда новый лист становится активным; если `false` , новый лист становится активным без изменения текущего выбора.

Возвращаться

Sheet — новый активный лист.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

`set Active Spreadsheet(newActiveSpreadsheet)`

Устанавливает активную электронную таблицу.

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

Параметры

Имя	Тип	Описание
`new Active Spreadsheet`	`Spreadsheet`	Таблица, которую необходимо сделать активной.

`set Current Cell(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