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

Class Spreadsheet

Доступ и изменение файлов Google Sheets. Обычными операциями являются добавление новых листов и добавление соавторов.

Методы

Метод	Тип возврата	Краткое описание
`addDeveloperMetadata(key)`	`Spreadsheet`	Добавляет метаданные разработчика с указанным ключом в электронную таблицу верхнего уровня.
`addDeveloperMetadata(key, visibility)`	`Spreadsheet`	Добавляет метаданные разработчика с указанным ключом и видимостью в электронную таблицу.
`addDeveloperMetadata(key, value)`	`Spreadsheet`	Добавляет метаданные разработчика с указанным ключом и значением в электронную таблицу.
`addDeveloperMetadata(key, value, visibility)`	`Spreadsheet`	Добавляет метаданные разработчика с указанным ключом, значением и видимостью в электронную таблицу.
`addEditor(emailAddress)`	`Spreadsheet`	Добавляет данного пользователя в список редакторов `Spreadsheet` .
`addEditor(user)`	`Spreadsheet`	Добавляет данного пользователя в список редакторов `Spreadsheet` .
`addEditors(emailAddresses)`	`Spreadsheet`	Добавляет заданный массив пользователей в список редакторов `Spreadsheet` .
`addMenu(name, subMenus)`	`void`	Создает новое меню в пользовательском интерфейсе электронной таблицы.
`addViewer(emailAddress)`	`Spreadsheet`	Добавляет данного пользователя в список читателей `Spreadsheet` .
`addViewer(user)`	`Spreadsheet`	Добавляет данного пользователя в список читателей `Spreadsheet` .
`addViewers(emailAddresses)`	`Spreadsheet`	Добавляет заданный массив пользователей в список читателей `Spreadsheet` .
`appendRow(rowContents)`	`Sheet`	Добавляет строку внизу текущей области данных на листе.
`autoResizeColumn(columnPosition)`	`Sheet`	Устанавливает ширину данного столбца в соответствии с его содержимым.
`copy(name)`	`Spreadsheet`	Копирует таблицу и возвращает новую.
`createDeveloperMetadataFinder()`	`DeveloperMetadataFinder`	Возвращает `DeveloperMetadataFinder` для поиска метаданных разработчика в пределах этой электронной таблицы.
`createTextFinder(findText)`	`TextFinder`	Создает средство поиска текста для электронной таблицы, которое можно использовать для поиска и замены текста в электронной таблице.
`deleteActiveSheet()`	`Sheet`	Удаляет текущий активный лист.
`deleteColumn(columnPosition)`	`Sheet`	Удаляет столбец в заданной позиции столбца.
`deleteColumns(columnPosition, howMany)`	`void`	Удаляет несколько столбцов, начиная с заданной позиции столбца.
`deleteRow(rowPosition)`	`Sheet`	Удаляет строку в заданной позиции.
`deleteRows(rowPosition, howMany)`	`void`	Удаляет несколько строк, начиная с заданной позиции строки.
`deleteSheet(sheet)`	`void`	Удаляет указанный лист.
`duplicateActiveSheet()`	`Sheet`	Дублирует активный лист и делает его активным.
`getActiveCell()`	`Range`	Возвращает активную ячейку на этом листе.
`getActiveRange()`	`Range`	Возвращает выбранный диапазон на активном листе или `null` , если активного диапазона нет.
`getActiveRangeList()`	`RangeList`	Возвращает список активных диапазонов на активном листе или `null` , если активных диапазонов нет.
`getActiveSheet()`	`Sheet`	Получает активный лист в электронной таблице.
`getAs(contentType)`	`Blob`	Верните данные внутри этого объекта в виде большого двоичного объекта, преобразованного в указанный тип контента.
`getBandings()`	`Banding[]`	Возвращает все полосы в этой таблице.
`getBlob()`	`Blob`	Верните данные внутри этого объекта в виде большого двоичного объекта.
`getColumnWidth(columnPosition)`	`Integer`	Получает ширину в пикселях данного столбца.
`getCurrentCell()`	`Range`	Возвращает текущую ячейку на активном листе или `null` , если текущей ячейки нет.
`getDataRange()`	`Range`	Возвращает `Range` , соответствующий измерениям, в которых присутствуют данные.
`getDataSourceFormulas()`	`DataSourceFormula[]`	Получает все формулы источника данных.
`getDataSourcePivotTables()`	`DataSourcePivotTable[]`	Получает все сводные таблицы источника данных.
`getDataSourceRefreshSchedules()`	`DataSourceRefreshSchedule[]`	Получает расписания обновления этой электронной таблицы.
`getDataSourceSheets()`	`DataSourceSheet[]`	Возвращает все листы источников данных в электронной таблице.
`getDataSourceTables()`	`DataSourceTable[]`	Получает все таблицы источников данных.
`getDataSources()`	`DataSource[]`	Возвращает все источники данных в электронной таблице.
`getDeveloperMetadata()`	`DeveloperMetadata[]`	Получает метаданные разработчика, связанные с электронной таблицей верхнего уровня.
`getEditors()`	`User[]`	Получает список редакторов этой `Spreadsheet` .
`getFormUrl()`	`String`	Возвращает URL-адрес формы, которая отправляет ответы в эту электронную таблицу, или `null` , если с этой электронной таблицей не связана никакая форма.
`getFrozenColumns()`	`Integer`	Возвращает количество замороженных столбцов.
`getFrozenRows()`	`Integer`	Возвращает количество замороженных строк.
`getId()`	`String`	Получает уникальный идентификатор этой электронной таблицы.
`getImages()`	`OverGridImage[]`	Возвращает все изображения поверх сетки на листе.
`getIterativeCalculationConvergenceThreshold()`	`Number`	Возвращает пороговое значение, используемое во время итеративного расчета.
`getLastColumn()`	`Integer`	Возвращает позицию последнего столбца с содержимым.
`getLastRow()`	`Integer`	Возвращает позицию последней строки, содержащей контент.
`getMaxIterativeCalculationCycles()`	`Integer`	Возвращает максимальное количество итераций, которое можно использовать во время итеративного расчета.
`getName()`	`String`	Получает имя документа.
`getNamedRanges()`	`NamedRange[]`	Получает все именованные диапазоны в этой электронной таблице.
`getNumSheets()`	`Integer`	Возвращает количество листов в этой электронной таблице.
`getOwner()`	`User`	Возвращает владельца документа или `null` для документа на общем диске.
`getPredefinedSpreadsheetThemes()`	`SpreadsheetTheme[]`	Возвращает список предопределенных тем.
`getProtections(type)`	`Protection[]`	Получает массив объектов, представляющих все защищенные диапазоны или листы в электронной таблице.
`getRange(a1Notation)`	`Range`	Возвращает диапазон, указанный в нотации A1 или нотации R1C1.
`getRangeByName(name)`	`Range`	Возвращает именованный диапазон или `null` , если диапазон с данным именем не найден.
`getRangeList(a1Notations)`	`RangeList`	Возвращает коллекцию `RangeList` , представляющую диапазоны на одном листе, заданные непустым списком нотаций A1 или нотаций R1C1.
`getRecalculationInterval()`	`RecalculationInterval`	Возвращает интервал расчета для этой электронной таблицы.
`getRowHeight(rowPosition)`	`Integer`	Получает высоту в пикселях данной строки.
`getSelection()`	`Selection`	Возвращает текущий `Selection` в электронной таблице.
`getSheetByName(name)`	`Sheet`	Возвращает лист с заданным именем.
`getSheetId()`	`Integer`	Возвращает идентификатор листа, представленного этим объектом.
`getSheetName()`	`String`	Возвращает имя листа.
`getSheetValues(startRow, startColumn, numRows, numColumns)`	`Object[][]`	Возвращает прямоугольную сетку значений для этого диапазона, начиная с заданных координат.
`getSheets()`	`Sheet[]`	Получает все листы в этой электронной таблице.
`getSpreadsheetLocale()`	`String`	Получает языковой стандарт электронной таблицы.
`getSpreadsheetTheme()`	`SpreadsheetTheme`	Возвращает текущую тему электронной таблицы или `null` , если тема не применена.
`getSpreadsheetTimeZone()`	`String`	Получает часовой пояс для электронной таблицы.
`getUrl()`	`String`	Возвращает URL-адрес данной электронной таблицы.
`getViewers()`	`User[]`	Получает список читателей и комментаторов этой `Spreadsheet` .
`hideColumn(column)`	`void`	Скрывает столбец или столбцы в заданном диапазоне.
`hideRow(row)`	`void`	Скрывает строки в заданном диапазоне.
`insertColumnAfter(afterPosition)`	`Sheet`	Вставляет столбец после заданной позиции столбца.
`insertColumnBefore(beforePosition)`	`Sheet`	Вставляет столбец перед заданной позицией столбца.
`insertColumnsAfter(afterPosition, howMany)`	`Sheet`	Вставляет заданное количество столбцов после заданной позиции столбца.
`insertColumnsBefore(beforePosition, howMany)`	`Sheet`	Вставляет несколько столбцов перед заданной позицией столбца.
`insertDataSourceSheet(spec)`	`DataSourceSheet`	Вставляет новый `DataSourceSheet` в электронную таблицу и начинает выполнение данных.
`insertImage(blobSource, column, row)`	`OverGridImage`	Вставляет `Spreadsheet` в виде изображения в документ в заданную строку и столбец.
`insertImage(blobSource, column, row, offsetX, offsetY)`	`OverGridImage`	Вставляет `Spreadsheet` в виде изображения в документ в заданную строку и столбец со смещением в пикселях.
`insertImage(url, column, row)`	`OverGridImage`	Вставляет изображение в документ в заданную строку и столбец.
`insertImage(url, column, row, offsetX, offsetY)`	`OverGridImage`	Вставляет изображение в документ в заданную строку и столбец со смещением в пикселях.
`insertRowAfter(afterPosition)`	`Sheet`	Вставляет строку после заданной позиции строки.
`insertRowBefore(beforePosition)`	`Sheet`	Вставляет строку перед заданной позицией строки.
`insertRowsAfter(afterPosition, howMany)`	`Sheet`	Вставляет несколько строк после заданной позиции строки.
`insertRowsBefore(beforePosition, howMany)`	`Sheet`	Вставляет несколько строк перед заданной позицией строки.
`insertSheet()`	`Sheet`	Вставляет новый лист в электронную таблицу, используя имя листа по умолчанию.
`insertSheet(sheetIndex)`	`Sheet`	Вставляет новый лист в электронную таблицу по заданному индексу.
`insertSheet(sheetIndex, options)`	`Sheet`	Вставляет новый лист в электронную таблицу по заданному индексу и использует дополнительные дополнительные аргументы.
`insertSheet(options)`	`Sheet`	Вставляет новый лист в электронную таблицу, используя имя листа по умолчанию и дополнительные дополнительные аргументы.
`insertSheet(sheetName)`	`Sheet`	Вставляет новый лист в электронную таблицу с заданным именем.
`insertSheet(sheetName, sheetIndex)`	`Sheet`	Вставляет новый лист в электронную таблицу с заданным именем по заданному индексу.
`insertSheet(sheetName, sheetIndex, options)`	`Sheet`	Вставляет новый лист в электронную таблицу с заданным именем по заданному индексу и использует дополнительные расширенные аргументы.
`insertSheet(sheetName, options)`	`Sheet`	Вставляет новый лист в электронную таблицу с заданным именем и использует дополнительные дополнительные аргументы.
`insertSheetWithDataSourceTable(spec)`	`Sheet`	Вставляет новый лист в электронную таблицу, создает `DataSourceTable` , охватывающую весь лист с заданной спецификацией источника данных, и начинает выполнение данных.
`isColumnHiddenByUser(columnPosition)`	`Boolean`	Возвращает, скрыт ли данный столбец пользователем.
`isIterativeCalculationEnabled()`	`Boolean`	Возвращает, активирован ли итеративный расчет в этой электронной таблице.
`isRowHiddenByFilter(rowPosition)`	`Boolean`	Возвращает, скрыта ли данная строка фильтром (а не представлением фильтра).
`isRowHiddenByUser(rowPosition)`	`Boolean`	Возвращает, скрыта ли данная строка пользователем.
`moveActiveSheet(pos)`	`void`	Перемещает активный лист на заданную позицию в списке листов.
`moveChartToObjectSheet(chart)`	`Sheet`	Создает новый лист `SheetType.OBJECT` и перемещает в него предоставленную диаграмму.
`refreshAllDataSources()`	`void`	Обновляет все поддерживаемые источники данных и связанные с ними объекты источников данных, пропуская недопустимые объекты источников данных.
`removeEditor(emailAddress)`	`Spreadsheet`	Удаляет данного пользователя из списка редакторов `Spreadsheet` .
`removeEditor(user)`	`Spreadsheet`	Удаляет данного пользователя из списка редакторов `Spreadsheet` .
`removeMenu(name)`	`void`	Удаляет меню, добавленное с помощью `addMenu(name, subMenus)` .
`removeNamedRange(name)`	`void`	Удаляет именованный диапазон с заданным именем.
`removeViewer(emailAddress)`	`Spreadsheet`	Удаляет данного пользователя из списка читателей и комментаторов `Spreadsheet` .
`removeViewer(user)`	`Spreadsheet`	Удаляет данного пользователя из списка читателей и комментаторов `Spreadsheet` .
`rename(newName)`	`void`	Переименовывает документ.
`renameActiveSheet(newName)`	`void`	Переименовывает текущий активный лист, присваивая ему новое имя.
`resetSpreadsheetTheme()`	`SpreadsheetTheme`	Удаляет примененную тему и устанавливает тему по умолчанию в электронной таблице.
`setActiveRange(range)`	`Range`	Устанавливает указанный диапазон в качестве `active range` на активном листе, при этом верхняя левая ячейка диапазона становится `current cell` .
`setActiveRangeList(rangeList)`	`RangeList`	Устанавливает указанный список диапазонов в качестве `active ranges` на активном листе.
`setActiveSelection(range)`	`Range`	Устанавливает активную область выбора для этого листа.
`setActiveSelection(a1Notation)`	`Range`	Устанавливает активный выбор, как указано в нотации A1 или нотации R1C1.
`setActiveSheet(sheet)`	`Sheet`	Устанавливает данный лист в качестве активного листа в электронной таблице.
`setActiveSheet(sheet, restoreSelection)`	`Sheet`	Устанавливает данный лист в качестве активного листа в электронной таблице с возможностью восстановления самого последнего выбора на этом листе.
`setColumnWidth(columnPosition, width)`	`Sheet`	Устанавливает ширину данного столбца в пикселях.
`setCurrentCell(cell)`	`Range`	Устанавливает указанную ячейку в качестве `current cell` .
`setFrozenColumns(columns)`	`void`	Замораживает заданное количество столбцов.
`setFrozenRows(rows)`	`void`	Замораживает заданное количество строк.
`setIterativeCalculationConvergenceThreshold(minThreshold)`	`Spreadsheet`	Устанавливает минимальное пороговое значение для итеративного расчета.
`setIterativeCalculationEnabled(isEnabled)`	`Spreadsheet`	Устанавливает, активирован ли итеративный расчет в этой электронной таблице.
`setMaxIterativeCalculationCycles(maxIterations)`	`Spreadsheet`	Задает максимальное количество итераций расчета, которое должно быть выполнено во время итеративного расчета.
`setNamedRange(name, range)`	`void`	Называет диапазон.
`setRecalculationInterval(recalculationInterval)`	`Spreadsheet`	Устанавливает, как часто должна выполняться перерасчет таблицы.
`setRowHeight(rowPosition, height)`	`Sheet`	Устанавливает высоту данной строки в пикселях.
`setSpreadsheetLocale(locale)`	`void`	Устанавливает локаль электронной таблицы.
`setSpreadsheetTheme(theme)`	`SpreadsheetTheme`	Устанавливает тему в электронной таблице.
`setSpreadsheetTimeZone(timezone)`	`void`	Устанавливает часовой пояс для электронной таблицы.
`show(userInterface)`	`void`	Отображает пользовательский компонент пользовательского интерфейса в диалоговом окне, центрированном в области просмотра браузера пользователя.
`sort(columnPosition)`	`Sheet`	Сортирует лист по столбцам по возрастанию.
`sort(columnPosition, ascending)`	`Sheet`	Сортирует лист по столбцу.
`toast(msg)`	`void`	Показывает всплывающее окно в правом нижнем углу таблицы с данным сообщением.
`toast(msg, title)`	`void`	Показывает всплывающее окно в правом нижнем углу таблицы с указанным сообщением и заголовком.
`toast(msg, title, timeoutSeconds)`	`void`	Показывает всплывающее окно в правом нижнем углу таблицы с заданным заголовком и сообщением, которое остается видимым в течение определенного периода времени.
`unhideColumn(column)`	`void`	Отображает столбец в заданном диапазоне.
`unhideRow(row)`	`void`	Отображает строку в заданном диапазоне.
`updateMenu(name, subMenus)`	`void`	Обновляет меню, добавленное с помощью `addMenu(name, subMenus)` .
`waitForAllDataExecutionsCompletion(timeoutInSeconds)`	`void`	Ожидает завершения всех текущих выполнений в электронной таблице, время ожидания истекает через указанное количество секунд.

Устаревшие методы

Метод	Тип возврата	Краткое описание
`getSheetProtection()`	`PageProtection`	Возвращает экземпляр `PageProtection` , описывающий разрешения для текущего листа.
`isAnonymousView()`	`Boolean`	Указывает, разрешен ли документ анонимный просмотр.
`isAnonymousWrite()`	`Boolean`	Указывает, разрешено ли внесение изменений в документ анонимными пользователями.
`setAnonymousAccess(anonymousReadAllowed, anonymousWriteAllowed)`	`void`	Устанавливает политику документа по анонимному чтению и записи.
`setSheetProtection(permissions)`	`void`	Устанавливает разрешения для текущего листа.

Подробная документация

`addDeveloperMetadata(key)`

Добавляет метаданные разработчика с указанным ключом в электронную таблицу верхнего уровня.

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

// Adds the key 'NAME' in the developer metadata for the spreadsheet.
ss.addDeveloperMetadata('NAME')

// Gets the first developer metadata object and logs its key.
const developerMetaData = ss.getDeveloperMetadata()[0]
console.log(developerMetaData.getKey())

Параметры

Имя	Тип	Описание
`key`	`String`	Ключ для новых метаданных разработчика.

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

Spreadsheet — эта электронная таблица для связывания.

Авторизация

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

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

`addDeveloperMetadata(key, visibility)`

Добавляет метаданные разработчика с указанным ключом и видимостью в электронную таблицу.

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

// Adds the key 'NAME' in the developer metadata for the spreadsheet and sets the visibility
// to the developer project that created the metadata.
ss.addDeveloperMetadata('NAME', SpreadsheetApp.DeveloperMetadataVisibility.PROJECT);

// Gets the first developer metadata object and logs its key and visibility setting.
const developerMetaData = ss.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(`Key: ${developerMetaData.getKey()},
.             Visibility: ${developerMetaData.getVisibility()}`);

Параметры

Имя	Тип	Описание
`key`	`String`	Ключ для новых метаданных разработчика.
`visibility`	`DeveloperMetadataVisibility`	Видимость новых метаданных разработчика.

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

Spreadsheet — эта электронная таблица для связывания.

Авторизация

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

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

`addDeveloperMetadata(key, value)`

Добавляет метаданные разработчика с указанным ключом и значением в электронную таблицу.

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

// Adds the key 'NAME' and sets the value to 'GOOGLE' in the developer metadata for the
// spreadsheet.
ss.addDeveloperMetadata('NAME', 'GOOGLE');

// Gets the first developer metadata object and logs its key and value.
const developerMetaData = ss.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(`Key: ${developerMetaData.getKey()}, Value: ${developerMetaData.getValue()}`);

Параметры

Имя	Тип	Описание
`key`	`String`	Ключ для новых метаданных разработчика.
`value`	`String`	Значение новых метаданных разработчика.

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

Spreadsheet — эта электронная таблица для связывания.

Авторизация

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

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

`addDeveloperMetadata(key, value, visibility)`

Добавляет метаданные разработчика с указанным ключом, значением и видимостью в электронную таблицу.

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

// Adds the key 'NAME', sets the value to 'GOOGLE', and sets the visibility
// to any developer project with document access.
ss.addDeveloperMetadata('NAME', 'GOOGLE', SpreadsheetApp.DeveloperMetadataVisibility.DOCUMENT);

// Gets the first developer metadata object and logs its key, value, and visibility setting.
const developerMetaData = ss.getDeveloperMetadata()[0];
console.log(`Key: ${developerMetaData.getKey()},
             Value: ${developerMetaData.getValue()},
             Visibility: ${developerMetaData.getVisibility()}`);

Параметры

Имя	Тип	Описание
`key`	`String`	Ключ для новых метаданных разработчика.
`value`	`String`	Значение новых метаданных разработчика.
`visibility`	`DeveloperMetadataVisibility`	Видимость новых метаданных разработчика.

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

Spreadsheet — эта электронная таблица для связывания.

Авторизация

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

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

`addEditor(emailAddress)`

Добавляет данного пользователя в список редакторов Spreadsheet . Если пользователь уже был в списке зрителей, этот метод удаляет пользователя из списка зрителей.

Параметры

Имя	Тип	Описание
`emailAddress`	`String`	Адрес электронной почты пользователя, которого требуется добавить.

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

Spreadsheet — эта Spreadsheet для связывания.

Авторизация

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

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

`addEditor(user)`

Параметры

Имя	Тип	Описание
`user`	`User`	Представление добавляемого пользователя.

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

Spreadsheet — эта Spreadsheet для связывания.

Авторизация

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

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

`addEditors(emailAddresses)`

Добавляет заданный массив пользователей в список редакторов Spreadsheet . Если кто-либо из пользователей уже был в списке зрителей, этот метод удаляет его из списка зрителей.

Параметры

Имя	Тип	Описание
`emailAddresses`	`String[]`	Массив адресов электронной почты пользователей, которых нужно добавить.

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

Spreadsheet — эта Spreadsheet для связывания.

Авторизация

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

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

`addMenu(name, subMenus)`

Создает новое меню в пользовательском интерфейсе электронной таблицы.

Каждый пункт меню запускает определяемую пользователем функцию. Обычно вы хотите вызвать его из функции onOpen() , чтобы меню автоматически создавалось при загрузке электронной таблицы.

// The onOpen function is executed automatically every time a Spreadsheet is loaded
function onOpen() {
  var ss = SpreadsheetApp.getActiveSpreadsheet();
  var menuEntries = [];
  // When the user clicks on "addMenuExample" then "Menu Entry 1", the function function1 is
  // executed.
  menuEntries.push({name: "Menu Entry 1", functionName: "function1"});
  menuEntries.push(null); // line separator
  menuEntries.push({name: "Menu Entry 2", functionName: "function2"});

  ss.addMenu("addMenuExample", menuEntries);
}

Параметры

Имя	Тип	Описание
`name`	`String`	Имя создаваемого меню.
`subMenus`	`Object[]`	Массив карт JavaScript с параметрами `name` и `functionName` . Вы можете использовать функции из включенных библиотек, например `Library.libFunction1` .

Авторизация

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

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

`addViewer(emailAddress)`

Добавляет данного пользователя в список читателей Spreadsheet . Если пользователь уже был в списке редакторов, этот метод не имеет никакого эффекта.

Параметры

Имя	Тип	Описание
`emailAddress`	`String`	Адрес электронной почты пользователя, которого требуется добавить.

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

Spreadsheet — эта Spreadsheet для связывания.

Авторизация

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

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

`addViewer(user)`

Параметры

Имя	Тип	Описание
`user`	`User`	Представление добавляемого пользователя.

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

Spreadsheet — эта Spreadsheet для связывания.

Авторизация

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

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

`addViewers(emailAddresses)`

Добавляет заданный массив пользователей в список читателей Spreadsheet . Если кто-то из пользователей уже был в списке редакторов, на них этот метод не действует.

Параметры

Имя	Тип	Описание
`emailAddresses`	`String[]`	Массив адресов электронной почты пользователей, которых нужно добавить.

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

Spreadsheet — эта Spreadsheet для связывания.

Авторизация

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

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

`appendRow(rowContents)`

Добавляет строку внизу текущей области данных на листе. Если содержимое ячейки начинается с = , оно интерпретируется как формула.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Appends a new row with 3 columns to the bottom of the current
// data region in the sheet containing the values in the array.
sheet.appendRow(["a man", "a plan", "panama"]);

Параметры

Имя	Тип	Описание
`rowContents`	`Object[]`	Массив значений, которые нужно вставить после последней строки листа.

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

Sheet — лист, полезный для объединения методов.

Авторизация

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

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

`autoResizeColumn(columnPosition)`

Устанавливает ширину данного столбца в соответствии с его содержимым.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

sheet.getRange('a1').setValue('Whenever it is a damp, drizzly November in my soul...');

// Sets the first column to a width which fits the text
sheet.autoResizeColumn(1);

Параметры

Имя	Тип	Описание
`columnPosition`	`Integer`	Положение данного столбца для изменения размера.

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

Sheet — лист, полезный для цепочки методов.

Авторизация

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

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

`copy(name)`

Копирует таблицу и возвращает новую.

// This code makes a copy of the current spreadsheet and names it appropriately
var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.copy("Copy of " + ss.getName());

Параметры

Имя	Тип	Описание
`name`	`String`	Название копии.

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

Spreadsheet — эта электронная таблица для связывания.

Авторизация

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

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

`createDeveloperMetadataFinder()`

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

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

// Adds developer metadata to the spreadsheet.
ss.addDeveloperMetadata('NAME', 'CHARLIE');
ss.addDeveloperMetadata('COMPANY', 'EXAMPLE ORGANIZATION');
ss.addDeveloperMetadata('TECHNOLOGY', 'JAVASCRIPT');

// Creates a developer metadata finder.
const developerMetadataFinder = ss.createDeveloperMetadataFinder();

// Finds the developer metadata objects with 'COMPANY' as the key.
const googleMetadataFromSpreadsheet = developerMetadataFinder.withKey('COMPANY').find();

// Gets the first result of developer metadata that has the key 'COMPANY' and logs its value.
console.log(googleMetadataFromSpreadsheet[0].getValue());

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

DeveloperMetadataFinder — средство поиска метаданных разработчика для поиска метаданных в области этой электронной таблицы.

`createTextFinder(findText)`

Создает средство поиска текста для электронной таблицы, которое можно использовать для поиска и замены текста в электронной таблице. Поиск начинается с первого листа таблицы.

var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();

// Creates  a text finder.
var textFinder = spreadsheet.createTextFinder('dog');

// Returns the first occurrence of 'dog' in the spreadsheet.
var firstOccurrence = textFinder.findNext();

// Replaces the last found occurrence of 'dog' with 'cat' and returns the number
// of occurrences replaced.
var numOccurrencesReplaced = findOccurrence.replaceWith('cat');

Параметры

Имя	Тип	Описание
`findText`	`String`	Текст для поиска.

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

TextFinder — TextFinder для электронной таблицы.

`deleteActiveSheet()`

Удаляет текущий активный лист.

// The code below deletes the currently active sheet and stores the new active sheet in a
// variable
var newSheet = SpreadsheetApp.getActiveSpreadsheet().deleteActiveSheet();

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

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

Авторизация

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

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

`deleteColumn(columnPosition)`

Удаляет столбец в заданной позиции столбца.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Columns start at "1" - this deletes the first column
sheet.deleteColumn(1);

Параметры

Имя	Тип	Описание
`columnPosition`	`Integer`	Позиция столбца, начиная с 1 для первого столбца.

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

Sheet — лист, полезный для цепочки методов.

Авторизация

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

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

`deleteColumns(columnPosition, howMany)`

Удаляет несколько столбцов, начиная с заданной позиции столбца.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Columns start at "1" - this deletes the first two columns
sheet.deleteColumns(1, 2);

Параметры

Имя	Тип	Описание
`columnPosition`	`Integer`	Позиция первого удаляемого столбца.
`howMany`	`Integer`	Количество столбцов, которые необходимо удалить.

Авторизация

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

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

`deleteRow(rowPosition)`

Удаляет строку в заданной позиции.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Rows start at "1" - this deletes the first row
sheet.deleteRow(1);

Параметры

Имя	Тип	Описание
`rowPosition`	`Integer`	Позиция строки, начиная с 1 для первой строки.

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

Sheet — лист, полезный для цепочки методов.

Авторизация

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

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

`deleteRows(rowPosition, howMany)`

Удаляет несколько строк, начиная с заданной позиции строки.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Rows start at "1" - this deletes the first two rows
sheet.deleteRows(1, 2);

Параметры

Имя	Тип	Описание
`rowPosition`	`Integer`	Позиция первой удаляемой строки.
`howMany`	`Integer`	Количество строк, которые необходимо удалить.

Авторизация

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

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

`deleteSheet(sheet)`

Удаляет указанный лист.

// The code below deletes the specified sheet.
var ss = SpreadsheetApp.getActive();
var sheet = ss.getSheetByName('My Sheet');
ss.deleteSheet(sheet);

Параметры

Имя	Тип	Описание
`sheet`	`Sheet`	Лист, который нужно удалить.

Авторизация

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

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

`duplicateActiveSheet()`

Дублирует активный лист и делает его активным.

// The code below makes a duplicate of the active sheet
SpreadsheetApp.getActiveSpreadsheet().duplicateActiveSheet();

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

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

Авторизация

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

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

`getActiveCell()`

Возвращает активную ячейку на этом листе.

Примечание. Предпочтительнее использовать getCurrentCell() , который возвращает текущую выделенную ячейку.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Returns the active cell
var cell = sheet.getActiveCell();

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

Range — текущая активная ячейка

Авторизация

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

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

`getActiveRange()`

Возвращает выбранный диапазон на активном листе или null , если активного диапазона нет. Если выбрано несколько диапазонов, этот метод возвращает только последний выбранный диапазон.

Термин «активный диапазон» относится к диапазону, который пользователь выбрал на активном листе, но в пользовательской функции он относится к активно пересчитываемой ячейке.

var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
var activeRange = sheet.getActiveRange();

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

Range — активный диапазон

Авторизация

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

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

См. также

setActiveRange(range)

`getActiveRangeList()`

Возвращает список активных диапазонов на активном листе или null , если активных диапазонов нет.

Если выбран один диапазон, это действует как вызов getActiveRange() .

var sheet = SpreadsheetApp.getActiveSheet();
// Returns the list of active ranges.
var activeRangeList = sheet.getActiveRangeList();

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

RangeList — список активных диапазонов

Авторизация

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

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

См. также

setActiveRangeList(rangeList)

`getActiveSheet()`

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

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

var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();

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

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

`getAs(contentType)`

Верните данные внутри этого объекта в виде большого двоичного объекта, преобразованного в указанный тип контента. Этот метод добавляет к имени файла соответствующее расширение, например «myfile.pdf». Однако предполагается, что часть имени файла, следующая за последней точкой (если таковая имеется), является существующим расширением, которое следует заменить. Следовательно, «Список покупок.25.12.2014» становится «Список покупок.12.25.pdf».

Чтобы просмотреть ежедневные квоты на конверсии, см. Квоты для сервисов Google . На вновь созданные домены Google Workspace могут временно распространяться более строгие квоты.

Параметры

Имя	Тип	Описание
`contentType`	`String`	Тип MIME, в который требуется преобразовать. Для большинства больших двоичных объектов единственным допустимым вариантом является `'application/pdf'` . Для изображений в формате BMP, GIF, JPEG или PNG также допустимо любое из `'image/bmp'` , `'image/gif'` , `'image/jpeg'` или `'image/png'` . Для документа Google Docs также допустимо использование `'text/markdown'` .

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

Blob — данные в виде большого двоичного объекта.

`getBandings()`

Возвращает все полосы в этой таблице.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, 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 an array of the bandings in the spreadsheet.
const bandings = ss.getBandings();

// Logs the range of the first banding in the spreadsheet to the console.
console.log(bandings[0].getRange().getA1Notation());

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

Banding[] — полосы в этой таблице.

Авторизация

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

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

`getBlob()`

Верните данные внутри этого объекта в виде большого двоичного объекта.

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

Blob — данные в виде большого двоичного объекта.

`getColumnWidth(columnPosition)`

Получает ширину в пикселях данного столбца.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Columns start at 1
Logger.log(sheet.getColumnWidth(1));

Параметры

Имя	Тип	Описание
`columnPosition`	`Integer`	Положение колонны для проверки.

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

Integer — ширина столбца в пикселях.

Авторизация

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

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

`getCurrentCell()`

Возвращает текущую ячейку на активном листе или null , если текущей ячейки нет. Текущая ячейка — это ячейка, которая находится в фокусе в пользовательском интерфейсе Google Таблиц и выделена темной рамкой. Никогда не бывает более одной текущей ячейки. Когда пользователь выбирает один или несколько диапазонов ячеек, одна из выбранных ячеек является текущей.

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

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

Range — текущая ячейка

Авторизация

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

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

`getDataRange()`

Возвращает Range , соответствующий измерениям, в которых присутствуют данные.

Это функционально эквивалентно созданию диапазона, ограниченного A1 и (Sheet.getLastColumn(), Sheet.getLastRow()).

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This represents ALL the data
var range = sheet.getDataRange();
var values = range.getValues();

// This logs the spreadsheet in CSV format with a trailing comma
for (var i = 0; i < values.length; i++) {
  var row = "";
  for (var j = 0; j < values[i].length; j++) {
    if (values[i][j]) {
      row = row + values[i][j];
    }
    row = row + ",";
  }
  Logger.log(row);
}

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

Range — диапазон, состоящий из всех данных в электронной таблице.

Авторизация

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

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

`getDataSourceFormulas()`

Получает все формулы источника данных.

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

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

// Gets an array of the data source formulas on Sheet1.
// To get an array of data source formulas for the entire spreadsheet,
// replace 'sheet' with 'ss'.
const dataSourceFormulas = sheet.getDataSourceFormulas();

// Logs the first data source formula in the array.
console.log(dataSourceFormulas[0].getFormula());

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

DataSourceFormula[] — Список формул источника данных.

Авторизация

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

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

`getDataSourcePivotTables()`

Получает все сводные таблицы источника данных.

// 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets an array of the data source pivot tables on Sheet1.
// To get an array of data source pivot tables for the entire
// spreadsheet, replace 'sheet' with 'ss'.
const dataSourcePivotTables = sheet.getDataSourcePivotTables();

// Logs the last time that the first pivot table in the array was refreshed.
console.log(dataSourcePivotTables[0].getStatus().getLastRefreshedTime());

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

DataSourcePivotTable[] — список сводных таблиц источников данных.

Авторизация

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

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

`getDataSourceRefreshSchedules()`

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

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

// Activates BigQuery operations for the connected spreadsheet.
SpreadsheetApp.enableBigQueryExecution();

// Gets the frequency type of the first referesh schedule in the array.
const frequencyType = ss.getDataSourceRefreshSchedules()[0]
                        .getFrequency()
                        .getFrequencyType()
                        .toString();

// Logs the frequency type to the console.
console.log(frequencyType);

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

DataSourceRefreshSchedule[] — графики обновления этой электронной таблицы.

Авторизация

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

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

`getDataSourceSheets()`

Возвращает все листы источников данных в электронной таблице.

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

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, 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 the first data source sheet in the spreadsheet.
const dataSource = ss.getDataSourceSheets()[0];

// Gets the name of the data source sheet.
console.log(dataSource.asSheet().getName());

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

DataSourceSheet[] — Массив всех листов источников данных.

Авторизация

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

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

`getDataSourceTables()`

Получает все таблицы источников данных.

// 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets an array of data source tables on Sheet1.
// To get an array of data source tables for the entire spreadsheet,
// replace 'sheet' with 'ss'.
const dataSourceTables = sheet.getDataSourceTables();

// Logs the last completed data execution time on the first data source table.
console.log(dataSourceTables[0].getStatus().getLastExecutionTime());

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

DataSourceTable[] — Список таблиц источников данных.

Авторизация

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

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

`getDataSources()`

Возвращает все источники данных в электронной таблице.

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

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, 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 the data sources on the spreadsheet.
const dataSources = ss.getDataSources();

// Logs the name of the first column on the first data source.
console.log(dataSources[0].getColumns()[0].getName());

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

DataSource[] — Массив всех источников данных.

Авторизация

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

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

`getDeveloperMetadata()`

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

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, 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');

// Adds 'Google' as a key to the spreadsheet metadata.
ss.addDeveloperMetadata('Google');

// Gets the spreadsheet's metadata.
const ssMetadata = ss.getDeveloperMetadata();

// Gets the first set of the spreadsheet's metadata and logs the key to the console.
console.log(ssMetadata[0].getKey());

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

DeveloperMetadata[] — метаданные разработчика, связанные с этим диапазоном.

Авторизация

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

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

`getEditors()`

Получает список редакторов этой Spreadsheet .

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

User[] — Массив пользователей с разрешением на редактирование.

Авторизация

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

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

`getFormUrl()`

Возвращает URL-адрес формы, которая отправляет ответы в эту электронную таблицу, или null , если с этой электронной таблицей не связана никакая форма. Если несколько форм отправляют ответы в эту таблицу, возвращаемый URL-адрес формы не определен. В качестве альтернативы ассоциации URL-адресов для каждой формы листа можно получить с помощью метода Sheet.getFormUrl() .

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, 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 the form URL from the spreadsheet.
const formUrl = ss.getFormUrl();

// Logs the form URL to the console.
console.log(formUrl);

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

String — URL-адрес формы, которая размещает свои ответы в этой электронной таблице, или null если эта электронная таблица не имеет связанной формы.

Авторизация

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

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

`getFrozenColumns()`

Возвращает количество замороженных столбцов.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

Logger.log("Number of frozen columns: %s", sheet.getFrozenColumns());

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

Integer — количество замороженных столбцов.

Авторизация

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

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

`getFrozenRows()`

Возвращает количество замороженных строк.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

Logger.log("Number of frozen rows: %s", sheet.getFrozenRows());

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

Integer — количество замороженных строк.

Авторизация

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

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

`getId()`

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

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

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

String — уникальный идентификатор (или ключ) электронной таблицы.

`getImages()`

Возвращает все изображения поверх сетки на листе.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, 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 the over-the-grid images from Sheet1.
// To get the over-the-grid images from the entire spreadsheet, use ss.getImages() instead.
const images = sheet.getImages();

// For each image, logs the anchor cell in A1 notation.
for (const image of images) {
 console.log(image.getAnchorCell().getA1Notation());
}

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

OverGridImage[] — Массив изображений поверх сетки.

Авторизация

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

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

`getIterativeCalculationConvergenceThreshold()`

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

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, 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');

// Sets the iterative calculation convergence threshold for the spreadsheet.
ss.setIterativeCalculationConvergenceThreshold(2);

// Logs the threshold to the console.
console.log(ss.getIterativeCalculationConvergenceThreshold());

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

Number — Порог сходимости.

Авторизация

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

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

`getLastColumn()`

Возвращает позицию последнего столбца с содержимым.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This logs the value in the very last cell of this sheet
var lastRow = sheet.getLastRow();
var lastColumn = sheet.getLastColumn();
var lastCell = sheet.getRange(lastRow, lastColumn);
Logger.log(lastCell.getValue());

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

Integer — последний столбец листа, содержащий контент.

Авторизация

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

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

`getLastRow()`

Возвращает позицию последней строки, содержащей контент.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This logs the value in the very last cell of this sheet
var lastRow = sheet.getLastRow();
var lastColumn = sheet.getLastColumn();
var lastCell = sheet.getRange(lastRow, lastColumn);
Logger.log(lastCell.getValue());

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

Integer — последняя строка листа, содержащая контент.

Авторизация

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

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

`getMaxIterativeCalculationCycles()`

Возвращает максимальное количество итераций, которое можно использовать во время итеративного расчета.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, 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');

// Sets the max iterative calculation cycles for the spreadsheet.
ss.setMaxIterativeCalculationCycles(10);

// Logs the max iterative calculation cycles to the console.
console.log(ss.getMaxIterativeCalculationCycles());

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

Integer — максимальное количество итераций расчета.

Авторизация

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

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

`getName()`

Получает имя документа.

var ss = SpreadsheetApp.getActiveSpreadsheet();
Logger.log(ss.getName());

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

String — имя электронной таблицы.

Авторизация

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

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

`getNamedRanges()`

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

// The code below logs the name of the first named range.
var namedRanges = SpreadsheetApp.getActiveSpreadsheet().getNamedRanges();
for (var i = 0; i < namedRanges.length; i++) {
  Logger.log(namedRanges[i].getName());
}

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

NamedRange[] — Массив всех именованных диапазонов в электронной таблице.

Авторизация

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

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

`getNumSheets()`

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

// The code below logs the number of sheets in the active spreadsheet.
Logger.log(SpreadsheetApp.getActiveSpreadsheet().getNumSheets());

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

Integer — количество листов в электронной таблице.

`getOwner()`

Возвращает владельца документа или null для документа на общем диске.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var owner = ss.getOwner();
Logger.log(owner.getEmail());

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

User — владелец документа или null если документ находится на общем диске.

Авторизация

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

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

`getPredefinedSpreadsheetThemes()`

Возвращает список предопределенных тем.

// The code below returns the list of predefined themes.
var predefinedThemesList = SpreadsheetApp.getActiveSpreadsheet()
                               .getPredefinedSpreadsheetThemes();

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

SpreadsheetTheme[] — Список предопределенных тем.

Авторизация

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

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

`getProtections(type)`

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

// Remove all range protections in the spreadsheet that the user has permission to edit.
var ss = SpreadsheetApp.getActive();
var protections = ss.getProtections(SpreadsheetApp.ProtectionType.RANGE);
for (var i = 0; i < protections.length; i++) {
  var protection = protections[i];
  if (protection.canEdit()) {
    protection.remove();
  }
}

// Remove all sheet protections in the spreadsheet that the user has permission to edit.
var ss = SpreadsheetApp.getActive();
var protections = ss.getProtections(SpreadsheetApp.ProtectionType.SHEET);
for (var i = 0; i < protections.length; i++) {
  var protection = protections[i];
  if (protection.canEdit()) {
    protection.remove();
  }
}

Параметры

Имя	Тип	Описание
`type`	`ProtectionType`	Тип защищенной области: `SpreadsheetApp.ProtectionType.RANGE` или `SpreadsheetApp.ProtectionType.SHEET` .

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

Protection[] — Массив объектов, представляющих все защищенные диапазоны или листы в электронной таблице.

Авторизация

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

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

`getRange(a1Notation)`

Возвращает диапазон, указанный в нотации A1 или нотации R1C1.

// Get a range A1:D4 on sheet titled "Invoices"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var range = ss.getRange("Invoices!A1:D4");

// Get cell A1 on the first sheet
var sheet = ss.getSheets()[0];
var cell = sheet.getRange("A1");

Параметры

Имя	Тип	Описание
`a1Notation`	`String`	Возвращаемый диапазон, как указано в нотации A1 или нотации R1C1.

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

Range — диапазон в указанном месте.

Авторизация

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

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

`getRangeByName(name)`

Возвращает именованный диапазон или null , если диапазон с данным именем не найден. Если несколько листов электронной таблицы используют одно и то же имя диапазона, укажите имя листа без дополнительных кавычек — например, getRangeByName('TaxRates') или getRangeByName('Sheet Name!TaxRates') , но не getRangeByName('"Sheet Name"!TaxRates') .

// Log the number of columns for the range named 'TaxRates' in the active spreadsheet.
var range = SpreadsheetApp.getActiveSpreadsheet().getRangeByName('TaxRates');
if (range != null) {
  Logger.log(range.getNumColumns());
}

Параметры

Имя	Тип	Описание
`name`	`String`	Имя диапазона, который требуется получить.

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

Range — диапазон ячеек с заданным именем.

`getRangeList(a1Notations)`

Возвращает коллекцию RangeList , представляющую диапазоны на одном листе, заданные непустым списком нотаций A1 или нотаций R1C1.

// Get a list of ranges A1:D4, F1:H4.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
var rangeList  = sheet.getRangeList(['A1:D4', 'F1:H4']);

Параметры

Имя	Тип	Описание
`a1Notations`	`String[]`	Список возвращаемых диапазонов, как указано в нотации A1 или нотации R1C1.

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

RangeList — список диапазонов в указанном месте.

Авторизация

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

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

`getRecalculationInterval()`

Возвращает интервал расчета для этой электронной таблицы.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, 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');

// Logs the calculation interval for the spreadsheet to the console.
console.log(ss.getRecalculationInterval().toString());

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

RecalculationInterval — интервал вычислений для этой электронной таблицы.

Авторизация

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

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

`getRowHeight(rowPosition)`

Получает высоту в пикселях данной строки.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Rows start at 1
Logger.log(sheet.getRowHeight(1));

Параметры

Имя	Тип	Описание
`rowPosition`	`Integer`	Положение строки для проверки.

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

Integer — высота строки в пикселях.

Авторизация

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

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

`getSelection()`

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

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

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

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

Авторизация

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

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

`getSheetByName(name)`

Возвращает лист с заданным именем.

Если несколько листов имеют одинаковое имя, возвращается самый левый. Возвращает null , если листа с данным именем нет.

// The code below logs the index of a sheet named "Expenses"
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheetByName("Expenses");
if (sheet != null) {
  Logger.log(sheet.getIndex());
}

Параметры

Имя	Тип	Описание
`name`	`String`	Имя листа, который нужно получить.

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

Sheet — лист с заданным именем.

`getSheetId()`

Возвращает идентификатор листа, представленного этим объектом.

Это уникальный идентификатор листа. Идентификатор — это монотонно возрастающее целое число, присваиваемое во время создания листа и не зависящее от положения листа. Это полезно в сочетании с такими методами, как Range.copyFormatToRange(gridId, column, columnEnd, row, rowEnd) , которые принимают gridId , а не экземпляр Sheet .

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

Logger.log(sheet.getSheetId());

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

Integer — идентификатор листа, уникальный для электронной таблицы.

Авторизация

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

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

`getSheetName()`

Возвращает имя листа.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

Logger.log(sheet.getSheetName());

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

String — имя листа

Авторизация

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

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

`getSheetValues(startRow, startColumn, numRows, numColumns)`

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// The two samples below produce the same output
var values = sheet.getSheetValues(1, 1, 3, 3);
Logger.log(values);

var range = sheet.getRange(1, 1, 3, 3);
values = range.getValues();
Logger.log(values);

Параметры

Имя	Тип	Описание
`startRow`	`Integer`	Положение стартового ряда.
`startColumn`	`Integer`	Положение стартовой колонны.
`numRows`	`Integer`	Количество строк, для которых возвращаются значения.
`numColumns`	`Integer`	Количество столбцов, для которых возвращаются значения.

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

Object[][] — двумерный массив значений

Авторизация

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

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

`getSheets()`

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

// The code below logs the name of the second sheet
var sheets = SpreadsheetApp.getActiveSpreadsheet().getSheets();
if (sheets.length > 1) {
  Logger.log(sheets[1].getName());
}

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

Sheet[] — Массив всех листов в электронной таблице.

`getSpreadsheetLocale()`

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

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, 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 the spreadsheet locale.
const ssLocale = ss.getSpreadsheetLocale();

// Logs the locale to the console.
console.log(ssLocale);

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

String — языковой стандарт электронной таблицы.

Авторизация

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

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

`getSpreadsheetTheme()`

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

// The code below returns the current theme of the spreadsheet.
var currentTheme = SpreadsheetApp.getActiveSpreadsheet().getSpreadsheetTheme();

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

SpreadsheetTheme — текущая примененная тема.

Авторизация

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

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

`getSpreadsheetTimeZone()`

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

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, 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');

// Sets the time zone of the spreadsheet.
ss.setSpreadsheetTimeZone('America/New_York');

// Gets the time zone of the spreadsheet.
const ssTimeZone = ss.getSpreadsheetTimeZone();

// Logs the time zone to the console.
console.log(ssTimeZone);

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

String — часовой пояс, указанный в «длинном» формате (например, «Америка/Нью_Йорк», как указано на Joda.org ).

Авторизация

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

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

`getUrl()`

Возвращает URL-адрес данной электронной таблицы.

var ss = SpreadsheetApp.getActiveSpreadsheet();
Logger.log(ss.getUrl());

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

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

Авторизация

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

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

`getViewers()`

Получает список читателей и комментаторов этой Spreadsheet .

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

User[] — Массив пользователей с разрешением на просмотр или комментирование.

Авторизация

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

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

`hideColumn(column)`

Скрывает столбец или столбцы в заданном диапазоне.

let ss = SpreadsheetApp.getActiveSpreadsheet();
let sheet = ss.getSheets()[0];

// This hides the first column
let range = sheet.getRange("A1");
sheet.hideColumn(range);

// This hides the first 3 columns
let range = sheet.getRange("A:C");
sheet.hideColumn(range);

Параметры

Имя	Тип	Описание
`column`	`Range`	Диапазон столбцов, который нужно скрыть.

Авторизация

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

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

`hideRow(row)`

Скрывает строки в заданном диапазоне.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This hides the first row
var range = sheet.getRange("A1");
sheet.hideRow(range);

Параметры

Имя	Тип	Описание
`row`	`Range`	Диапазон строк, который нужно скрыть.

Авторизация

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

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

`insertColumnAfter(afterPosition)`

Вставляет столбец после заданной позиции столбца.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This inserts a column after the first column position
sheet.insertColumnAfter(1);

Параметры

Имя	Тип	Описание
`afterPosition`	`Integer`	Столбец, после которого следует добавить новый столбец.

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

Sheet — лист, полезный для цепочки методов.

Авторизация

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

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

`insertColumnBefore(beforePosition)`

Вставляет столбец перед заданной позицией столбца.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This inserts a column in the first column position
sheet.insertColumnBefore(1);

Параметры

Имя	Тип	Описание
`beforePosition`	`Integer`	Столбец, перед которым следует добавить новый столбец.

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

Sheet — лист, полезный для цепочки методов.

Авторизация

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

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

`insertColumnsAfter(afterPosition, howMany)`

Вставляет заданное количество столбцов после заданной позиции столбца.

let ss = SpreadsheetApp.getActiveSpreadsheet();
let sheet = ss.getSheets()[0];

// Inserts two columns after the first column on the first sheet of the spreadsheet.
sheet.insertColumnsAfter(1,2);

Параметры

Имя	Тип	Описание
`afterPosition`	`Integer`	Столбец, после которого следует добавить новый столбец.
`howMany`	`Integer`	Количество столбцов для вставки.

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

Sheet — лист, полезный для цепочки методов.

Авторизация

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

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

`insertColumnsBefore(beforePosition, howMany)`

Вставляет несколько столбцов перед заданной позицией столбца.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This inserts five columns before the first column
sheet.insertColumnsBefore(1, 5);

Параметры

Имя	Тип	Описание
`beforePosition`	`Integer`	Столбец, перед которым следует добавить новый столбец.
`howMany`	`Integer`	Количество столбцов для вставки.

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

Sheet — лист, полезный для цепочки методов.

Авторизация

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

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

`insertDataSourceSheet(spec)`

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

Выдает исключение, если тип источника данных не включен. Используйте методы SpreadsheetApp#enable...Execution() чтобы включить выполнение данных для определенного типа источника данных.

// Activates BigQuery operations.
SpreadsheetApp.enableBigQueryExecution();

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

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

Параметры

Имя	Тип	Описание
`spec`	`DataSourceSpec`	Спецификация источника данных для вставки.

Возврат

DataSourceSheet — новый лист источника данных.

Авторизация

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

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

`insertImage(blobSource, column, row)`

Вставляет Spreadsheet в виде изображения в документ в заданную строку и столбец. Размер изображения извлекается из содержимого большого двоичного объекта. Максимальный поддерживаемый размер большого двоичного объекта — 2 МБ.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1);

Параметры

Имя	Тип	Описание
`blobSource`	`BlobSource`	Большой двоичный объект, содержащий содержимое изображения, тип MIME и (необязательно) имя.
`column`	`Integer`	Положение столбца.
`row`	`Integer`	Позиция строки.

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

OverGridImage — Вставленное изображение.

Авторизация

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

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

`insertImage(blobSource, column, row, offsetX, offsetY)`

Вставляет Spreadsheet в виде изображения в документ в заданную строку и столбец со смещением в пикселях. Размер изображения извлекается из содержимого большого двоичного объекта. Максимальный поддерживаемый размер большого двоичного объекта — 2 МБ.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1, 10, 10);

Параметры

Имя	Тип	Описание
`blobSource`	`BlobSource`	Большой двоичный объект, содержащий содержимое изображения, тип MIME и (необязательно) имя.
`column`	`Integer`	Положение столбца.
`row`	`Integer`	Позиция строки.
`offsetX`	`Integer`	Горизонтальное смещение от угла ячейки в пикселях.
`offsetY`	`Integer`	Вертикальное смещение от угла ячейки в пикселях.

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

OverGridImage — Вставленное изображение.

Авторизация

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

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

`insertImage(url, column, row)`

Вставляет изображение в документ в заданную строку и столбец.

Предоставленный URL-адрес должен быть общедоступным.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

sheet.insertImage("https://www.google.com/images/srpr/logo3w.png", 1, 1);

Параметры

Имя	Тип	Описание
`url`	`String`	URL-адрес изображения.
`column`	`Integer`	Положение столбца сетки.
`row`	`Integer`	Положение строки сетки.

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

OverGridImage — Вставленное изображение.

Авторизация

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

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

`insertImage(url, column, row, offsetX, offsetY)`

Вставляет изображение в документ в заданную строку и столбец со смещением в пикселях.

Предоставленный URL-адрес должен быть общедоступным.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

sheet.insertImage("https://www.google.com/images/srpr/logo3w.png", 1, 1, 10, 10);

Параметры

Имя	Тип	Описание
`url`	`String`	URL-адрес изображения.
`column`	`Integer`	Положение столбца.
`row`	`Integer`	Позиция строки.
`offsetX`	`Integer`	Горизонтальное смещение от угла ячейки в пикселях.
`offsetY`	`Integer`	Вертикальное смещение от угла ячейки в пикселях.

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

OverGridImage — Вставленное изображение.

Авторизация

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

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

`insertRowAfter(afterPosition)`

Вставляет строку после заданной позиции строки.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This inserts a row after the first row position
sheet.insertRowAfter(1);

Параметры

Имя	Тип	Описание
`afterPosition`	`Integer`	Строка, после которой должна быть добавлена новая строка.

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

Sheet — лист, полезный для цепочки методов.

Авторизация

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

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

`insertRowBefore(beforePosition)`

Вставляет строку перед заданной позицией строки.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This inserts a row before the first row position
sheet.insertRowBefore(1);

Параметры

Имя	Тип	Описание
`beforePosition`	`Integer`	Строка, перед которой должна быть добавлена новая строка.

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

Sheet — лист, полезный для цепочки методов.

Авторизация

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

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

`insertRowsAfter(afterPosition, howMany)`

Вставляет несколько строк после заданной позиции строки.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This inserts five rows after the first row
sheet.insertRowsAfter(1, 5);

Параметры

Имя	Тип	Описание
`afterPosition`	`Integer`	Строка, после которой должны быть добавлены новые строки.
`howMany`	`Integer`	Количество строк для вставки.

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

Sheet — лист, полезный для цепочки методов.

Авторизация

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

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

`insertRowsBefore(beforePosition, howMany)`

Вставляет несколько строк перед заданной позицией строки.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This inserts five rows before the first row
sheet.insertRowsBefore(1, 5);

Параметры

Имя	Тип	Описание
`beforePosition`	`Integer`	Строка, перед которой должны быть добавлены новые строки.
`howMany`	`Integer`	Количество строк для вставки.

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

Sheet — лист, полезный для цепочки методов.

Авторизация

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

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

`insertSheet()`

Вставляет новый лист в электронную таблицу, используя имя листа по умолчанию. Новый лист становится активным.

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.insertSheet();

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

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

Авторизация

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

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

`insertSheet(sheetIndex)`

Вставляет новый лист в электронную таблицу по заданному индексу. Новый лист становится активным.

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.insertSheet(1);

Параметры

Имя	Тип	Описание
`sheetIndex`	`Integer`	Индекс вновь созданного листа. Чтобы вставить лист первым в электронную таблицу, установите для него значение 0.

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

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

Авторизация

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

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

`insertSheet(sheetIndex, options)`

Вставляет новый лист в электронную таблицу по заданному индексу и использует дополнительные дополнительные аргументы. Новый лист становится активным.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var templateSheet = ss.getSheetByName('Sales');
ss.insertSheet(1, {template: templateSheet});

Параметры

Имя	Тип	Описание
`sheetIndex`	`Integer`	Индекс вновь созданного листа. Чтобы вставить лист первым в электронную таблицу, установите для него значение 0.
`options`	`Object`	Необязательные расширенные аргументы JavaScript.

Расширенные параметры

Имя	Тип	Описание
`template`	`Sheet`	Все данные из объекта листа шаблона копируются на новый лист. Шаблон листа должен быть одним из листов объекта Электронная таблица.

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

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

Авторизация

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

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

`insertSheet(options)`

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var templateSheet = ss.getSheetByName('Sales');
ss.insertSheet({template: templateSheet});

Параметры

Имя	Тип	Описание
`options`	`Object`	Необязательные расширенные аргументы JavaScript, перечисленные ниже.

Расширенные параметры

Имя	Тип	Описание
`template`	`Sheet`	Все данные из объекта листа шаблона копируются на новый лист. Шаблон листа должен быть одним из листов этого объекта электронной таблицы.

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

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

Авторизация

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

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

`insertSheet(sheetName)`

Вставляет новый лист в электронную таблицу с заданным именем. Новый лист становится активным.

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.insertSheet('My New Sheet');

Параметры

Имя	Тип	Описание
`sheetName`	`String`	Имя нового листа.

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

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

Авторизация

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

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

`insertSheet(sheetName, sheetIndex)`

Вставляет новый лист в электронную таблицу с заданным именем по заданному индексу. Новый лист становится активным.

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.insertSheet('My New Sheet', 1);

Параметры

Имя	Тип	Описание
`sheetName`	`String`	Имя нового листа.
`sheetIndex`	`Integer`	Индекс вновь созданного листа. Чтобы вставить лист первым в электронную таблицу, установите для него значение 0.

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

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

Авторизация

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

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

`insertSheet(sheetName, sheetIndex, options)`

Вставляет новый лист в электронную таблицу с заданным именем по заданному индексу и использует дополнительные расширенные аргументы. Новый лист становится активным.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var templateSheet = ss.getSheetByName('Sales');
ss.insertSheet('My New Sheet', 1, {template: templateSheet});

Параметры

Имя	Тип	Описание
`sheetName`	`String`	Имя нового листа.
`sheetIndex`	`Integer`	Индекс вновь вставленного листа. Чтобы вставить лист первым в электронную таблицу, установите для него значение 0.
`options`	`Object`	Необязательные расширенные аргументы JavaScript.

Расширенные параметры

Имя	Тип	Описание
`template`	`Sheet`	Все данные из объекта листа шаблона копируются на новый лист. Шаблон листа должен быть одним из листов объекта Электронная таблица.

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

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

Авторизация

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

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

`insertSheet(sheetName, options)`

Вставляет новый лист в электронную таблицу с заданным именем и использует дополнительные дополнительные аргументы. Новый лист становится активным.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var templateSheet = ss.getSheetByName('Sales');
ss.insertSheet('My New Sheet', {template: templateSheet});

Параметры

Имя	Тип	Описание
`sheetName`	`String`	Имя нового листа.
`options`	`Object`	Необязательные расширенные аргументы JavaScript.

Расширенные параметры

Имя	Тип	Описание
`template`	`Sheet`	Все данные из объекта листа шаблона копируются на новый лист. Шаблон листа должен быть одним из листов объекта Электронная таблица.

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

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

Авторизация

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

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

`insertSheetWithDataSourceTable(spec)`

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

// Activates BigQuery operations.
SpreadsheetApp.enableBigQueryExecution();

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

// Adds a sheet and sets cell A1 as the parameter cell.
const parameterCell = ss.insertSheet('parameterSheet').getRange('A1');

// Sets the value of the parameter cell to 'Duke'.
parameterCell.setValue('Duke');

const query = 'select * from `bigquery-public-data`.`ncaa_basketball`.' +
  '`mbb_historical_tournament_games` WHERE win_school_ncaa = @SCHOOL';

// Adds a data source with a query parameter.
// TODO(developer): Update the project ID to your own Google Cloud project ID.
const dataSourceSpec = SpreadsheetApp.newDataSourceSpec()
 .asBigQuery()
 .setProjectId('project-id-1')
 .setRawQuery(query)
 .setParameterFromCell('SCHOOL', 'parameterSheet!A1')
 .build();

// Adds sheets for the data source and data source table to the spreadsheet.
ss.insertSheetWithDataSourceTable(dataSourceSpec);

Параметры

Имя	Тип	Описание
`spec`	`DataSourceSpec`	Спецификация источника данных для вставки.

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

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

Авторизация

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

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

`isColumnHiddenByUser(columnPosition)`

Возвращает, скрыт ли данный столбец пользователем.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Columns start at 1
Logger.log(sheet.isColumnHiddenByUser(1));

Параметры

Имя	Тип	Описание
`columnPosition`	`Integer`	Положение колонны для проверки.

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

Boolean — true , если столбец скрыт, в противном случае false .

Авторизация

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

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

`isIterativeCalculationEnabled()`

Возвращает, активирован ли итеративный расчет в этой электронной таблице.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, 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');

// Activates iterative calculation on the spreadsheet.
ss.setIterativeCalculationEnabled(true);

// Logs whether iterative calculation is activated for the spreadsheet.
console.log(ss.isIterativeCalculationEnabled());

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

Boolean — true , если активирован итеративный расчет, в противном случае false .

Авторизация

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

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

`isRowHiddenByFilter(rowPosition)`

Возвращает, скрыта ли данная строка фильтром (а не представлением фильтра).

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Rows start at 1
Logger.log(sheet.isRowHiddenByFilter(1));

Параметры

Имя	Тип	Описание
`rowPosition`	`Integer`	Положение строки для проверки.

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

Boolean — true , если строка скрыта, в противном случае false .

Авторизация

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

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

`isRowHiddenByUser(rowPosition)`

Возвращает, скрыта ли данная строка пользователем.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Rows start at 1
Logger.log(sheet.isRowHiddenByUser(1));

Параметры

Имя	Тип	Описание
`rowPosition`	`Integer`	Положение строки для проверки.

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

Boolean — true , если строка скрыта, в противном случае false .

Авторизация

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

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

`moveActiveSheet(pos)`

Перемещает активный лист на заданную позицию в списке листов. Выдает исключение, если позиция отрицательная или превышает количество листов.

// This example assumes that there are 2 sheets in the current
// active spreadsheet: one named "first" in position 1 and another named "second"
// in position 2.
var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
// Gets the "first" sheet and activates it.
var sheet = spreadsheet.getSheetByName("first").activate();

// Logs 'Current index of sheet: 1'
console.log("Current index of sheet: %s", sheet.getIndex());

spreadsheet.moveActiveSheet(2);

// Logs 'New index of sheet: 2'
console.log("New index of sheet: %s", sheet.getIndex());

Параметры

Имя	Тип	Описание
`pos`	`Integer`	Позиция с 1 индексом, в которую необходимо переместить активный лист в списке листов.

Авторизация

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

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

`moveChartToObjectSheet(chart)`

Создает новый лист SheetType.OBJECT и перемещает в него предоставленную диаграмму. Если диаграмма уже находится на отдельном листе, этот лист возвращается без создания нового.

var sheet = SpreadsheetApp.getActiveSheet();
var chart = sheet.newChart().setPosition(1, 1, 0, 0).build();
sheet.insertChart(chart);
var objectSheet = SpreadsheetApp.getActive().moveChartToObjectSheet(chart);

Параметры

Имя	Тип	Описание
`chart`	`EmbeddedChart`	График для перемещения.

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

Sheet — лист, на котором находится диаграмма.

Авторизация

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

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

`refreshAllDataSources()`

Обновляет все поддерживаемые источники данных и связанные с ними объекты источников данных, пропуская недопустимые объекты источников данных.

Используйте методы SpreadsheetApp#enable...Execution() чтобы включить выполнение данных для определенного типа источника данных.

// Activates BigQuery operations.
SpreadsheetApp.enableBigQueryExecution();

// 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 the first data source sheet on the spreadsheet.
const dataSheet = ss.getDataSourceSheets()[0];

// Refreshes all data sources on the spreadsheet.
ss.refreshAllDataSources();

// Logs the last refreshed time of the first data source sheet.
console.log(`Last refresh time: ${dataSheet.getStatus().getLastRefreshedTime()}`);

Авторизация

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

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

`removeEditor(emailAddress)`

Удаляет данного пользователя из списка редакторов Spreadsheet . Этот метод не блокирует доступ пользователей Spreadsheet если они принадлежат к классу пользователей, имеющих общий доступ, например, если Spreadsheet используется во всем домене пользователя или если Spreadsheet находится на общем диске, доступном пользователю. может получить доступ.

Для файлов на Диске это также удаляет пользователя из списка зрителей.

Параметры

Имя	Тип	Описание
`emailAddress`	`String`	Адрес электронной почты пользователя, которого необходимо удалить.

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

Spreadsheet — эта Spreadsheet для связывания.

Авторизация

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

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

`removeEditor(user)`

Для файлов на Диске это также удаляет пользователя из списка зрителей.

Параметры

Имя	Тип	Описание
`user`	`User`	Представление пользователя, которого нужно удалить.

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

Spreadsheet — эта Spreadsheet для связывания.

Авторизация

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

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

`removeMenu(name)`

Удаляет меню, добавленное с помощью addMenu(name, subMenus) . Аргумент name должен иметь то же значение, что и соответствующий вызов addMenu(name, subMenus) .

// The onOpen function is executed automatically every time a Spreadsheet is loaded
function onOpen() {
  var ss = SpreadsheetApp.getActiveSpreadsheet();
  ss.addMenu("badMenu", [{name: "remove bad menu", functionName: "removeBadMenu"},
                                       {name: "foo", functionName: "foo"}]);
}
function removeBadMenu() {
  var ss = SpreadsheetApp.getActiveSpreadsheet();
  ss.removeMenu("badMenu");  // name must match the name used when added the menu
}
function foo(){
// Do nothing
}

Параметры

Имя	Тип	Описание
`name`	`String`	Имя меню, которое нужно удалить.

Авторизация

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

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

`removeNamedRange(name)`

Удаляет именованный диапазон с заданным именем. Выдает исключение, если в электронной таблице не найден диапазон с данным именем.

// The code below creates a new named range "foo", and then remove it.
var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.setNamedRange("foo", ss.getActiveRange());
ss.removeNamedRange("foo");

Параметры

Имя	Тип	Описание
`name`	`String`	Имя диапазона.

Авторизация

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

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

`removeViewer(emailAddress)`

Удаляет данного пользователя из списка читателей и комментаторов Spreadsheet . Этот метод не имеет эффекта, если пользователь является редактором, а не зрителем или комментатором. Этот метод также не блокирует доступ пользователей Spreadsheet если они принадлежат к классу пользователей, имеющих общий доступ — например, если Spreadsheet используется всем доменом пользователя или если Spreadsheet находится на общем диске, который Пользователь может получить доступ.

Для файлов диска это также удаляет пользователя из списка редакторов.

Параметры

Имя	Тип	Описание
`emailAddress`	`String`	Адрес электронной почты пользователя для удаления.

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

Spreadsheet - эта Spreadsheet для цепочки.

Авторизация

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

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

`removeViewer(user)`

Удаляет данного пользователя из списка зрителей и комментаторов для Spreadsheet . Этот метод не влияет, если пользователь является редактором, а не зрителем. Этот метод также не блокирует пользователям доступа к Spreadsheet если они принадлежат классу пользователей, которые имеют общий доступ - например, если Spreadsheet совместно со всей доменом пользователя или если Spreadsheet находится на общем диске, что в Пользователь может получить доступ.

Для файлов диска это также удаляет пользователя из списка редакторов.

Параметры

Имя	Тип	Описание
`user`	`User`	Представление пользователя для удаления.

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

Spreadsheet - эта Spreadsheet для цепочки.

Авторизация

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

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

`rename(newName)`

Переименование документа.

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.rename("This is the new name");

Параметры

Имя	Тип	Описание
`newName`	`String`	Новое имя для документа.

Авторизация

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

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

`renameActiveSheet(newName)`

Переименование текущего активного листа в заданное новое имя.

// The code below renames the active sheet to "Hello world"
SpreadsheetApp.getActiveSpreadsheet().renameActiveSheet("Hello world");

Параметры

Имя	Тип	Описание
`newName`	`String`	Новое имя для текущего активного листа.

Авторизация

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

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

`resetSpreadsheetTheme()`

Удаляет примененную тему и устанавливает тему по умолчанию в электронной таблице.

// The code below applies default theme on the spreadsheet.
SpreadsheetApp.getActiveSpreadsheet().resetSpreadsheetTheme();

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

SpreadsheetTheme - тема по умолчанию.

Авторизация

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

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

`setActiveRange(range)`

Устанавливает указанный диапазон в качестве active range в активном листе, с верхней левой ячейкой в диапазоне в качестве current cell .

var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
var range = sheet.getRange('A1:D4');
sheet.setActiveRange(range);

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

Параметры

Имя	Тип	Описание
`range`	`Range`	Диапазон для установки в качестве активного диапазона.

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

Range - недавно активный диапазон

Авторизация

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

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

`setActiveRangeList(rangeList)`

Устанавливает указанный список диапазонов в качестве active ranges в активном листе. Последний диапазон в списке установлен в качестве active range .

var sheet = SpreadsheetApp.getActiveSheet();
var rangeList = sheet.getRangeList(['D4', 'B2:C4']);
sheet.setActiveRangeList(rangeList);

var selection = sheet.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 - недавно выбранный список диапазонов

Авторизация

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

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

`setActiveSelection(range)`

Устанавливает область активного выбора для этого листа.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("A1:D4");
sheet.setActiveSelection(range);

Параметры

Имя	Тип	Описание
`range`	`Range`	Диапазон для установки в качестве активного выбора.

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

Range - недавно активный диапазон

Авторизация

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

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

`setActiveSelection(a1Notation)`

Устанавливает активный выбор, как указано в обозначениях A1 или обозначениях R1C1.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

sheet.setActiveSelection("A1:D4");

Параметры

Имя	Тип	Описание
`a1Notation`	`String`	Диапазон для установки как активного, как указано в обозначениях A1 или обозначениях R1C1.

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

Range - недавно активный диапазон

Авторизация

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

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

`setActiveSheet(sheet)`

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

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

Параметры

Имя	Тип	Описание
`sheet`	`Sheet`	Лист для установки в качестве активного листа.

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

Sheet - Активный лист.

Авторизация

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

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

`setActiveSheet(sheet, restoreSelection)`

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

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

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

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

Авторизация

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

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

`setColumnWidth(columnPosition, width)`

Устанавливает ширину данного столбца в пикселях.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Sets the first column to a width of 200 pixels
sheet.setColumnWidth(1, 200);

Параметры

Имя	Тип	Описание
`columnPosition`	`Integer`	Положение данного столбца для установки.
`width`	`Integer`	Ширина в пикселях, чтобы установить его на.

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

Sheet - лист, полезный для цепочки методов

Авторизация

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

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

`setCurrentCell(cell)`

Устанавливает указанную ячейку в качестве current cell .

Если указанная ячейка присутствует в уже выбранном диапазоне, то этот диапазон становится активным диапазоном с ячейкой в качестве ячейки тока.

Если указанная ячейка отсутствует в каком -либо выбранном диапазоне, то любой существующий выбор удаляется, а ячейка становится ячейкой тока и активным диапазоном.

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

var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
var cell = sheet.getRange('B5');
sheet.setCurrentCell(cell);

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

Параметры

Имя	Тип	Описание
`cell`	`Range`	Ячейка для установки в качестве текущей ячейки.

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

Range - вновь установленная тока ячейка

Авторизация

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

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

`setFrozenColumns(columns)`

Замораживает заданное количество столбцов. Если ноль, колонны не заморожены.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Freezes the first column
sheet.setFrozenColumns(1);

Параметры

Имя	Тип	Описание
`columns`	`Integer`	Количество столбцов для замораживания.

Авторизация

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

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

`setFrozenRows(rows)`

Замораживает заданное количество рядов. Если ноль, ряды не заморожены.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Freezes the first row
sheet.setFrozenRows(1);

Параметры

Имя	Тип	Описание
`rows`	`Integer`	Количество рядов заморозить.

Авторизация

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

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

`setIterativeCalculationConvergenceThreshold(minThreshold)`

Устанавливает минимальное пороговое значение для итеративного расчета. Когда результаты последовательного расчета различаются на меньшее, чем это значение, итеративное расчет останавливается. Это значение должно быть неотрицательным, а по умолчанию-до 0,05.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, 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');

// Sets the iterative calculation convergence threshold for the spreadsheet.
ss.setIterativeCalculationConvergenceThreshold(2);

// Logs the threshold to the console.
console.log(ss.getIterativeCalculationConvergenceThreshold());

Параметры

Имя	Тип	Описание
`minThreshold`	`Number`	Минимальный порог сходимости (должен быть неотрицательным).

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

Spreadsheet - эта таблица, для цепочки.

Авторизация

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

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

`setIterativeCalculationEnabled(isEnabled)`

Устанавливает, активируется ли итеративное расчет в этой таблице. Если максимальное количество циклов расчетов и порога сходимости ранее не были установлены при активации расчета, они по умолчанию до 50 и 0,05 соответственно. Если кто -то был установлен ранее, они сохраняют свои предыдущие значения.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, 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');

// Activates iterative calculation on the spreadsheet.
ss.setIterativeCalculationEnabled(true);

// Logs whether iterative calculation is activated for the spreadsheet.
console.log(ss.isIterativeCalculationEnabled());

Параметры

Имя	Тип	Описание
`isEnabled`	`Boolean`	`true` , если итеративное расчет должен быть включен; `false` в противном случае.

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

Spreadsheet - эта таблица, для цепочки.

Авторизация

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

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

`setMaxIterativeCalculationCycles(maxIterations)`

Устанавливает максимальное количество итераций расчета, которые должны выполняться во время итеративного расчета. Это значение должно быть от 1 до 10 000 (включительно), а по умолчанию - до 50.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, 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');

// Sets the max iterative calculation cycles for the spreadsheet.
ss.setMaxIterativeCalculationCycles(10);

// Logs the max iterative calculation cycles to the console.
console.log(ss.getMaxIterativeCalculationCycles());

Параметры

Имя	Тип	Описание
`maxIterations`	`Integer`	Максимальное количество итераций расчета (от 1 до 10 000).

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

Spreadsheet - эта таблица, для цепочки.

Авторизация

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

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

`setNamedRange(name, range)`

Называет диапазон.

// The code below creates a new named range "TaxRates" in the active spreadsheet
var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.setNamedRange("TaxRates", SpreadsheetApp.getActiveRange());

Параметры

Имя	Тип	Описание
`name`	`String`	Имя, чтобы дать диапазон.
`range`	`Range`	Спецификация диапазона.

Авторизация

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

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

`setRecalculationInterval(recalculationInterval)`

Устанавливает, как часто эта электронная таблица должна пересчитывать.

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

// Sets the  calculation interval for the spreadsheet to 'ON_CHANGE'.
const interval = ss.setRecalculationInterval(SpreadsheetApp.RecalculationInterval.ON_CHANGE);

// Logs the calculation interval to the console.
console.log(interval);

Параметры

Имя	Тип	Описание
`recalculationInterval`	`RecalculationInterval`	Новый интервал пересчета.

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

Spreadsheet - эта таблица, для цепочки.

Авторизация

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

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

`setRowHeight(rowPosition, height)`

Устанавливает высоту строки заданного строки в пикселях. По умолчанию ряды растут, чтобы соответствовать содержимому ячейки. Если вы хотите заставить ряды до указанной высоты, используйте Sheet.setRowHeightsForced(startRow, numRows, height) .

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Sets the first row to a height of 200 pixels
sheet.setRowHeight(1, 200);

Параметры

Имя	Тип	Описание
`rowPosition`	`Integer`	Позиция строки для изменения.
`height`	`Integer`	Высота в пикселях, чтобы установить его.

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

Sheet - Лист, полезный для цепочки методов.

Авторизация

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

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

`setSpreadsheetLocale(locale)`

Устанавливает локаль электронной таблицы.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, 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');

// Sets the spreadsheet locale.
ss.setSpreadsheetLocale('fr');

// Gets the spreadsheet locale.
const ssLocale = ss.getSpreadsheetLocale();

// Logs the locale to the console.
console.log(ssLocale);

Параметры

Имя	Тип	Описание
`locale`	`String`	Код локализации для использования (например, «en ',' fr 'или' en_us ').

Авторизация

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

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

`setSpreadsheetTheme(theme)`

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

var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
// The code below sets the second predefined theme as the current theme of the spreadsheet.
var predefinedThemesList = spreadsheet.getPredefinedSpreadsheetThemes();
spreadsheet.setSpreadsheetTheme(predefinedThemesList[1]);

Параметры

Имя	Тип	Описание
`theme`	`SpreadsheetTheme`	Тема для применения.

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

SpreadsheetTheme - новая текущая тема.

Авторизация

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

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

`setSpreadsheetTimeZone(timezone)`

Устанавливает часовой пояс для электронной таблицы.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, 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');

// Sets the time zone of the spreadsheet.
ss.setSpreadsheetTimeZone('America/New_York');

// Gets the time zone of the spreadsheet.
const ssTimeZone = ss.getSpreadsheetTimeZone();

// Logs the time zone to the console.
console.log(ssTimeZone);

Параметры

Имя	Тип	Описание
`timezone`	`String`	Часовой пояс, указанный в «длинном» формате (например, «America/new_york», как указано Joda.org ).

Авторизация

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

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

`show(userInterface)`

Отображает пользовательский компонент пользовательского интерфейса в диалоге, ориентированном на просмотр браузера пользователя. Выполнение скрипта на стороне сервера не приостановлено. Чтобы общаться со стороной сервера, компонент пользовательского интерфейса должен сделать асинхронные обратные вызовы с скриптом на стороне сервера.

Если сценарий на стороне сервера ранее отображался диалог, который еще не был отклонен, то существующий диалог заменяется на пользовательский интерфейс в недавно запрошенном диалоговом окне.

Следующий фрагмент кода отображает простое приложение HtmlService в диалоге с указанным заголовком, высотой и шириной:

var htmlApp = HtmlService
    .createHtmlOutput('<p>A change of speed, a change of style...</p>')
    .setTitle('My HtmlService Application')
    .setWidth(250)
    .setHeight(300);

SpreadsheetApp.getActiveSpreadsheet().show(htmlApp);

// The script resumes execution immediately after showing the dialog.

Параметры

Имя	Тип	Описание
`userInterface`	`Object`	`HtmlOutput` .

Авторизация

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

https://www.googleapis.com/auth/script.container.ui

`sort(columnPosition)`

Сортирует лист по столбцу, восходящий.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Sorts the sheet by the first column, ascending
sheet.sort(1);

Параметры

Имя	Тип	Описание
`columnPosition`	`Integer`	Столбец для сортировки.

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

Sheet - лист, полезный для цепочки методов

Авторизация

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

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

`sort(columnPosition, ascending)`

Сортирует лист по столбцу. Принимает параметр для указания восходящего или спуска.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Sorts the sheet by the first column, descending
sheet.sort(1, false);

Параметры

Имя	Тип	Описание
`columnPosition`	`Integer`	Столбец для сортировки.
`ascending`	`Boolean`	`true` для восходящих сортов, `false` для спуска.

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

Sheet - лист, полезный для цепочки методов

Авторизация

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

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

`toast(msg)`

Показывает всплывающее окно в правом нижнем углу электронной таблицы с данным сообщением.

// Show a popup with the message "Task started".
SpreadsheetApp.getActiveSpreadsheet().toast('Task started');

Параметры

Имя	Тип	Описание
`msg`	`String`	Сообщение должно быть показано в тосте.

Авторизация

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

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

`toast(msg, title)`

Показывает всплывающее окно в правом нижнем углу электронной таблицы с данным сообщением и заголовком.

// Show a popup with the title "Status" and the message "Task started".
SpreadsheetApp.getActiveSpreadsheet().toast('Task started', 'Status');

Параметры

Имя	Тип	Описание
`msg`	`String`	Сообщение должно быть показано в тосте.
`title`	`String`	Необязательное название тоста.

Авторизация

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

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

`toast(msg, title, timeoutSeconds)`

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

// Show a 3-second popup with the title "Status" and the message "Task started".
SpreadsheetApp.getActiveSpreadsheet().toast('Task started', 'Status', 3);

Параметры

Имя	Тип	Описание
`msg`	`String`	Сообщение должно быть показано в тосте.
`title`	`String`	Необязательное название тоста.
`timeoutSeconds`	`Number`	Тайм -аут в секундах; Если `null` , тосты по умолчанию до 5 секунд; Если отрицательно, тост остается до увольнения.

Авторизация

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

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

`unhideColumn(column)`

Не приведет к столбцу в данном диапазоне.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This unhides the first column if it was previously hidden
var range = sheet.getRange("A1");
sheet.unhideColumn(range);

Параметры

Имя	Тип	Описание
`column`	`Range`	Диапазон для неправомерного, если скрыт.

Авторизация

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

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

`unhideRow(row)`

Не поддается ряд в данном диапазоне.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This unhides the first row if it was previously hidden
var range = sheet.getRange("A1");
sheet.unhideRow(range);

Параметры

Имя	Тип	Описание
`row`	`Range`	Диапазон для неправомерного, если скрыт.

Авторизация

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

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

`updateMenu(name, subMenus)`

Обновляет меню, которое было добавлено addMenu(name, subMenus) . Работает точно так же, как addMenu(name, subMenus) .

var ss = SpreadsheetApp.getActiveSpreadsheet();
var menuEntries = [];
menuEntries.push({name: "Lone Menu Entry", functionName: "function1"});
ss.updateMenu("addMenuExample", menuEntries);

Параметры

Имя	Тип	Описание
`name`	`String`	Имя меню для обновления.
`subMenus`	`Object[]`	Массив карт JavaScript с параметрами `name` и `functionName` . Вы можете использовать функции из включенных библиотек, таких как `Library.libFunction1` .

Авторизация

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

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

`waitForAllDataExecutionsCompletion(timeoutInSeconds)`

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

Параметры

Имя	Тип	Описание
`timeoutInSeconds`	`Integer`	Время дождаться выполнения данных, в считанные секунды. Максимум - 300 секунд.

Авторизация

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

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

Устаревшие методы

`getSheetProtection()`

Устарело. Для электронных таблиц, созданных в более новой версии Google Sheets, используйте Sheet.getProtections(type) , которая возвращает более мощный класс Protection . Хотя этот метод устарел, он остается доступным для совместимости с более старой версией листов

Возвращает экземпляр PageProtection , описывающий разрешения для текущего листа.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var permissions = sheet.getSheetProtection();

permissions.setProtected(true);
permissions.addUser("user@example.com");

// Logs the users that have access to edit this sheet. Note that this
// is different from access to the entire spreadsheet - getUsers()
// only returns users if permissions.isProtected() is set to true.
var users = permissions.getUsers();
Logger.log(users);

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

PageProtection - объект, описывающий разрешения на доступ к листу

Авторизация

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

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

`isAnonymousView()`

Устарело. По состоянию на январь 2014 года эта функция устарела и недоступна в новой версии Google Sheets.

Указывает, позволяет ли документ анонимный просмотр. Поскольку это больше не поддерживается в новой версии Google Sheets , используйте File.getSharingAccess() и File.getSharingPermission() вместо этого.

// Determine if the document allows anonymous viewing via the Drive API.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var file = DriveApp.getFileById(ss.getId());
var access = file.getSharingAccess();
var permission = file.getSharingPermission();
var isAnonymousAccess =
    access == DriveApp.Access.ANYONE || access == DriveApp.Access.ANYONE_WITH_LINK;
var isAnonymousEdit = isAnonymousAccess && permission != DriveApp.Permission.NONE;

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

Boolean - true , если документ позволяет анонимный просмотр, false в противном случае.

Авторизация

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

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

См. также

Drive Service

`isAnonymousWrite()`

Устарело. По состоянию на январь 2014 года эта функция устарела и недоступна в новой версии Google Sheets.

Указывает, разрешает ли документ редакторы от анонимных пользователей. Поскольку это больше не поддерживается в новой версии Google Sheets , используйте File.getSharingAccess() и File.getSharingPermission() вместо этого.

// Determine if the document allow anonymous edits via the Drive API.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var file = DriveApp.getFileById(ss.getId());
var access = file.getSharingAccess();
var permission = file.getSharingPermission();
var isAnonymousAccess =
    access == DriveApp.Access.ANYONE || access == DriveApp.Access.ANYONE_WITH_LINK;
var isAnonymousEdit = isAnonymousAccess && permission == DriveApp.Permission.EDIT;

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

Boolean - true , если документ позволяет анонимно редактировать, false в противном случае.

Авторизация

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

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

См. также

Drive Service

`setAnonymousAccess(anonymousReadAllowed, anonymousWriteAllowed)`

Устарело. По состоянию на январь 2014 года эта функция устарела и недоступна в новой версии Google Sheets.

Устанавливает политику документа по анонимному чтению и письму. Поскольку это больше не поддерживается в новой версии Google Sheets , используйте File.setSharing(accessType, permissionType) в качестве альтернативы.

// Set the document's policy on anonymous reading and writing via the Drive API.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var file = DriveApp.getFileById(ss.getId());

// Set anonymous read.
file.setSharing(DriveApi.Access.ANYONE, DriveApi.Permission.VIEW);

// Set anonymous write.
file.setSharing(DriveApi.Access.ANYONE, DriveApi.Permission.EDIT);

// Disable anonymous access.
file.setSharing(DriveApi.Access.PRIVATE, file.getSharingPermission());

Параметры

Имя	Тип	Описание
`anonymousReadAllowed`	`Boolean`	`true` разрешить анонимные чтения; `false` в противном случае.
`anonymousWriteAllowed`	`Boolean`	`true` разрешить анонимные чтения; `false` в противном случае.

Авторизация

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

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

См. также

isAnonymousView()
isAnonymousWrite()
Drive Service

`setSheetProtection(permissions)`

Устарело. Для электронных таблиц, созданных в более новой версии Google Sheets, используйте Sheet.protect() Protection Хотя этот метод устарел, он остается доступным для совместимости с более старой версией листов

Устанавливает разрешения для текущего листа.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var permissions = sheet.getSheetProtection();

// This copies the permissions on the first sheet to the second sheet
var sheetToClonePermissionsTo = ss.getSheets()[1];
sheetToClonePermissionsTo.setSheetProtection(permissions);

Параметры

Имя	Тип	Описание
`permissions`	`PageProtection`	Объект доступа разрешений для установки на этом листе.

Авторизация

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

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