Class Spreadsheet

электронная таблица

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

Методы

Метод Тип возврата Краткое описание
add Developer Metadata(key) Spreadsheet Добавляет метаданные разработчика с указанным ключом в электронную таблицу верхнего уровня.
add Developer Metadata(key, visibility) Spreadsheet Добавляет метаданные разработчика с указанным ключом и видимостью в электронную таблицу.
add Developer Metadata(key, value) Spreadsheet Добавляет метаданные разработчика с указанным ключом и значением в электронную таблицу.
add Developer Metadata(key, value, visibility) Spreadsheet Добавляет метаданные разработчика с указанным ключом, значением и видимостью в электронную таблицу.
add Editor(emailAddress) Spreadsheet Добавляет данного пользователя в список редакторов Spreadsheet .
add Editor(user) Spreadsheet Добавляет данного пользователя в список редакторов Spreadsheet .
add Editors(emailAddresses) Spreadsheet Добавляет заданный массив пользователей в список редакторов Spreadsheet .
add Menu(name, subMenus) void Создает новое меню в пользовательском интерфейсе электронной таблицы.
add Viewer(emailAddress) Spreadsheet Добавляет данного пользователя в список читателей Spreadsheet .
add Viewer(user) Spreadsheet Добавляет данного пользователя в список читателей Spreadsheet .
add Viewers(emailAddresses) Spreadsheet Добавляет заданный массив пользователей в список читателей Spreadsheet .
append Row(rowContents) Sheet Добавляет строку внизу текущей области данных на листе.
auto Resize Column(columnPosition) Sheet Устанавливает ширину данного столбца в соответствии с его содержимым.
copy(name) Spreadsheet Копирует таблицу и возвращает новую.
create Developer Metadata Finder() Developer Metadata Finder Возвращает Developer Metadata Finder для поиска метаданных разработчика в пределах этой электронной таблицы.
create Text Finder(findText) Text Finder Создает средство поиска текста для электронной таблицы, которое можно использовать для поиска и замены текста в электронной таблице.
delete Active Sheet() Sheet Удаляет текущий активный лист.
delete Column(columnPosition) Sheet Удаляет столбец в заданной позиции столбца.
delete Columns(columnPosition, howMany) void Удаляет несколько столбцов, начиная с заданной позиции столбца.
delete Row(rowPosition) Sheet Удаляет строку в заданной позиции.
delete Rows(rowPosition, howMany) void Удаляет несколько строк, начиная с заданной позиции строки.
delete Sheet(sheet) void Удаляет указанный лист.
duplicate Active Sheet() Sheet Дублирует активный лист и делает его активным.
get Active Cell() Range Возвращает активную ячейку на этом листе.
get Active Range() Range Возвращает выбранный диапазон на активном листе или null , если активного диапазона нет.
get Active Range List() Range List Возвращает список активных диапазонов на активном листе или null , если активных диапазонов нет.
get Active Sheet() Sheet Получает активный лист в электронной таблице.
get As(contentType) Blob Верните данные внутри этого объекта в виде большого двоичного объекта, преобразованного в указанный тип контента.
get Bandings() Banding[] Возвращает все полосы в этой таблице.
get Blob() Blob Верните данные внутри этого объекта в виде большого двоичного объекта.
get Column Width(columnPosition) Integer Получает ширину в пикселях данного столбца.
get Current Cell() Range Возвращает текущую ячейку на активном листе или null если текущей ячейки нет.
get Data Range() Range Возвращает Range соответствующий измерениям, в которых присутствуют данные.
get Data Source Formulas() Data Source Formula[] Получает все формулы источника данных.
get Data Source Pivot Tables() Data Source Pivot Table[] Получает все сводные таблицы источника данных.
get Data Source Refresh Schedules() Data Source Refresh Schedule[] Получает расписания обновления этой электронной таблицы.
get Data Source Sheets() Data Source Sheet[] Возвращает все листы источников данных в электронной таблице.
get Data Source Tables() Data Source Table[] Получает все таблицы источников данных.
get Data Sources() Data Source[] Возвращает все источники данных в электронной таблице.
get Developer Metadata() Developer Metadata[] Получает метаданные разработчика, связанные с электронной таблицей верхнего уровня.
get Editors() User[] Получает список редакторов этой Spreadsheet .
get Form Url() String Возвращает URL-адрес формы, которая отправляет ответы в эту электронную таблицу, или null если с этой электронной таблицей не связана никакая форма.
get Frozen Columns() Integer Возвращает количество замороженных столбцов.
get Frozen Rows() Integer Возвращает количество замороженных строк.
get Id() String Получает уникальный идентификатор этой электронной таблицы.
get Images() Over Grid Image[] Возвращает все изображения поверх сетки на листе.
get Iterative Calculation Convergence Threshold() Number Возвращает пороговое значение, используемое во время итеративного расчета.
get Last Column() Integer Возвращает позицию последнего столбца с содержимым.
get Last Row() Integer Возвращает позицию последней строки, содержащей контент.
get Max Iterative Calculation Cycles() Integer Возвращает максимальное количество итераций, которое можно использовать во время итеративного расчета.
get Name() String Получает имя документа.
get Named Ranges() Named Range[] Получает все именованные диапазоны в этой электронной таблице.
get Num Sheets() Integer Возвращает количество листов в этой электронной таблице.
get Owner() User Возвращает владельца документа или null для документа на общем диске.
get Predefined Spreadsheet Themes() Spreadsheet Theme[] Возвращает список предопределенных тем.
get Protections(type) Protection[] Получает массив объектов, представляющих все защищенные диапазоны или листы в электронной таблице.
get Range(a1Notation) Range Возвращает диапазон, указанный в нотации A1 или нотации R1C1.
get Range By Name(name) Range Возвращает именованный диапазон или null , если диапазон с данным именем не найден.
get Range List(a1Notations) Range List Возвращает коллекцию Range List , представляющую диапазоны на одном листе, указанном непустым списком нотаций A1 или нотаций R1C1.
get Recalculation Interval() Recalculation Interval Возвращает интервал расчета для этой электронной таблицы.
get Row Height(rowPosition) Integer Получает высоту в пикселях данной строки.
get Selection() Selection Возвращает текущий Selection в электронной таблице.
get Sheet By Id(id) Sheet Получает лист с заданным идентификатором.
get Sheet By Name(name) Sheet Возвращает лист с заданным именем.
get Sheet Id() Integer Возвращает идентификатор листа, представленного этим объектом.
get Sheet Name() String Возвращает имя листа.
get Sheet Values(startRow, startColumn, numRows, numColumns) Object[][] Возвращает прямоугольную сетку значений для этого диапазона, начиная с заданных координат.
get Sheets() Sheet[] Получает все листы в этой электронной таблице.
get Spreadsheet Locale() String Получает языковой стандарт электронной таблицы.
get Spreadsheet Theme() Spreadsheet Theme Возвращает текущую тему электронной таблицы или null , если тема не применена.
get Spreadsheet Time Zone() String Получает часовой пояс для электронной таблицы.
get Url() String Возвращает URL-адрес данной электронной таблицы.
get Viewers() User[] Получает список читателей и комментаторов этой Spreadsheet .
hide Column(column) void Скрывает столбец или столбцы в заданном диапазоне.
hide Row(row) void Скрывает строки в заданном диапазоне.
insert Column After(afterPosition) Sheet Вставляет столбец после заданной позиции столбца.
insert Column Before(beforePosition) Sheet Вставляет столбец перед заданной позицией столбца.
insert Columns After(afterPosition, howMany) Sheet Вставляет заданное количество столбцов после заданной позиции столбца.
insert Columns Before(beforePosition, howMany) Sheet Вставляет несколько столбцов перед заданной позицией столбца.
insert Data Source Sheet(spec) Data Source Sheet Вставляет новый Data Source Sheet в электронную таблицу и начинает выполнение данных.
insert Image(blobSource, column, row) Over Grid Image Вставляет Spreadsheet в виде изображения в документ в заданную строку и столбец.
insert Image(blobSource, column, row, offsetX, offsetY) Over Grid Image Вставляет Spreadsheet в виде изображения в документ в заданную строку и столбец со смещением в пикселях.
insert Image(url, column, row) Over Grid Image Вставляет изображение в документ в заданную строку и столбец.
insert Image(url, column, row, offsetX, offsetY) Over Grid Image Вставляет изображение в документ в заданную строку и столбец со смещением в пикселях.
insert Row After(afterPosition) Sheet Вставляет строку после заданной позиции строки.
insert Row Before(beforePosition) Sheet Вставляет строку перед заданной позицией строки.
insert Rows After(afterPosition, howMany) Sheet Вставляет несколько строк после заданной позиции строки.
insert Rows Before(beforePosition, howMany) Sheet Вставляет несколько строк перед заданной позицией строки.
insert Sheet() Sheet Вставляет новый лист в электронную таблицу, используя имя листа по умолчанию.
insert Sheet(sheetIndex) Sheet Вставляет новый лист в электронную таблицу по заданному индексу.
insert Sheet(sheetIndex, options) Sheet Вставляет новый лист в электронную таблицу по заданному индексу и использует дополнительные дополнительные аргументы.
insert Sheet(options) Sheet Вставляет новый лист в электронную таблицу, используя имя листа по умолчанию и дополнительные дополнительные аргументы.
insert Sheet(sheetName) Sheet Вставляет новый лист в электронную таблицу с заданным именем.
insert Sheet(sheetName, sheetIndex) Sheet Вставляет новый лист в электронную таблицу с заданным именем по заданному индексу.
insert Sheet(sheetName, sheetIndex, options) Sheet Вставляет новый лист в электронную таблицу с заданным именем по заданному индексу и использует дополнительные расширенные аргументы.
insert Sheet(sheetName, options) Sheet Вставляет новый лист в электронную таблицу с заданным именем и использует дополнительные дополнительные аргументы.
insert Sheet With Data Source Table(spec) Sheet Вставляет новый лист в электронную таблицу, создает Data Source Table охватывающую весь лист с заданной спецификацией источника данных, и начинает выполнение данных.
is Column Hidden By User(columnPosition) Boolean Возвращает, скрыт ли данный столбец пользователем.
is Iterative Calculation Enabled() Boolean Возвращает, активирован ли итеративный расчет в этой электронной таблице.
is Row Hidden By Filter(rowPosition) Boolean Возвращает, скрыта ли данная строка фильтром (а не представлением фильтра).
is Row Hidden By User(rowPosition) Boolean Возвращает, скрыта ли данная строка пользователем.
move Active Sheet(pos) void Перемещает активный лист на заданную позицию в списке листов.
move Chart To Object Sheet(chart) Sheet Создает новый лист Sheet Type.OBJECT и перемещает в него предоставленную диаграмму.
refresh All Data Sources() void Обновляет все поддерживаемые источники данных и связанные с ними объекты источников данных, пропуская недопустимые объекты источников данных.
remove Editor(emailAddress) Spreadsheet Удаляет данного пользователя из списка редакторов Spreadsheet .
remove Editor(user) Spreadsheet Удаляет данного пользователя из списка редакторов Spreadsheet .
remove Menu(name) void Удаляет меню, добавленное с помощью add Menu(name, subMenus) .
remove Named Range(name) void Удаляет именованный диапазон с заданным именем.
remove Viewer(emailAddress) Spreadsheet Удаляет данного пользователя из списка читателей и комментаторов Spreadsheet .
remove Viewer(user) Spreadsheet Удаляет данного пользователя из списка читателей и комментаторов Spreadsheet .
rename(newName) void Переименовывает документ.
rename Active Sheet(newName) void Переименовывает текущий активный лист, присваивая ему новое имя.
reset Spreadsheet Theme() Spreadsheet Theme Удаляет примененную тему и устанавливает тему по умолчанию в электронной таблице.
set Active Range(range) Range Устанавливает указанный диапазон в качестве active range на активном листе, при этом верхняя левая ячейка диапазона становится current cell .
set Active Range List(rangeList) Range List Устанавливает указанный список диапазонов в качестве active ranges на активном листе.
set Active Selection(range) Range Устанавливает активную область выбора для этого листа.
set Active Selection(a1Notation) Range Устанавливает активный выбор, как указано в нотации A1 или нотации R1C1.
set Active Sheet(sheet) Sheet Устанавливает данный лист в качестве активного листа в электронной таблице.
set Active Sheet(sheet, restoreSelection) Sheet Устанавливает данный лист в качестве активного листа в электронной таблице с возможностью восстановления самого последнего выбора на этом листе.
set Column Width(columnPosition, width) Sheet Устанавливает ширину данного столбца в пикселях.
set Current Cell(cell) Range Устанавливает указанную ячейку в качестве current cell .
set Frozen Columns(columns) void Замораживает заданное количество столбцов.
set Frozen Rows(rows) void Замораживает заданное количество строк.
set Iterative Calculation Convergence Threshold(minThreshold) Spreadsheet Устанавливает минимальное пороговое значение для итеративного расчета.
set Iterative Calculation Enabled(isEnabled) Spreadsheet Устанавливает, активирован ли итеративный расчет в этой электронной таблице.
set Max Iterative Calculation Cycles(maxIterations) Spreadsheet Задает максимальное количество итераций расчета, которое должно быть выполнено во время итеративного расчета.
set Named Range(name, range) void Называет диапазон.
set Recalculation Interval(recalculationInterval) Spreadsheet Устанавливает, как часто должна выполняться перерасчет таблицы.
set Row Height(rowPosition, height) Sheet Устанавливает высоту данной строки в пикселях.
set Spreadsheet Locale(locale) void Устанавливает локаль электронной таблицы.
set Spreadsheet Theme(theme) Spreadsheet Theme Устанавливает тему в электронной таблице.
set Spreadsheet Time Zone(timezone) void Устанавливает часовой пояс для электронной таблицы.
show(userInterface) void Отображает пользовательский компонент пользовательского интерфейса в диалоговом окне, центрированном в области просмотра браузера пользователя.
sort(columnPosition) Sheet Сортирует лист по столбцам по возрастанию.
sort(columnPosition, ascending) Sheet Сортирует лист по столбцу.
toast(msg) void Показывает всплывающее окно в правом нижнем углу таблицы с данным сообщением.
toast(msg, title) void Показывает всплывающее окно в правом нижнем углу таблицы с указанным сообщением и заголовком.
toast(msg, title, timeoutSeconds) void Показывает всплывающее окно в правом нижнем углу таблицы с заданным заголовком и сообщением, которое остается видимым в течение определенного периода времени.
unhide Column(column) void Отображает столбец в заданном диапазоне.
unhide Row(row) void Отображает строку в заданном диапазоне.
update Menu(name, subMenus) void Обновляет меню, добавленное с помощью add Menu(name, subMenus) .
wait For All Data Executions Completion(timeoutInSeconds) void Ожидает завершения всех текущих выполнений в электронной таблице, время ожидания истекает через указанное количество секунд.

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

add Developer Metadata(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

add Developer Metadata(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 Developer Metadata Visibility Видимость новых метаданных разработчика.

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

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

Авторизация

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

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

add Developer Metadata(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

add Developer Metadata(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 Developer Metadata Visibility Видимость новых метаданных разработчика.

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

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

Авторизация

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

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

add Editor(emailAddress)

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

Параметры

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

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

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

Авторизация

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

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

add Editor(user)

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

Параметры

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

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

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

Авторизация

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

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

add Editors(emailAddresses)

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

Параметры

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

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

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

Авторизация

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

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

add Menu(name, subMenus)

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

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

// The onOpen function is executed automatically every time a Spreadsheet is
// loaded
function onOpen() {
  const ss = SpreadsheetApp.getActiveSpreadsheet();
  const 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 Имя создаваемого меню.
sub Menus Object[] Массив карт JavaScript с параметрами name и function Name . Вы можете использовать функции из включенных библиотек, например Library.libFunction1 .

Авторизация

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

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

add Viewer(emailAddress)

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

Параметры

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

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

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

Авторизация

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

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

add Viewer(user)

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

Параметры

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

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

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

Авторизация

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

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

add Viewers(emailAddresses)

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

Параметры

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

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

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

Авторизация

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

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

append Row(rowContents)

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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']);

Параметры

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

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

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

Авторизация

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

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

auto Resize Column(columnPosition)

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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);

Параметры

Имя Тип Описание
column Position 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
const 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

create Developer Metadata Finder()

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

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

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

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


create Text Finder(findText)

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

const spreadsheet = SpreadsheetApp.getActiveSpreadsheet();

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

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

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

Параметры

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

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

Text FinderText Finder для электронной таблицы.


delete Active Sheet()

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

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

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

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

Авторизация

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

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

delete Column(columnPosition)

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

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

Параметры

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

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

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

Авторизация

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

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

delete Columns(columnPosition, howMany)

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

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

Параметры

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

Авторизация

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

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

delete Row(rowPosition)

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

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

Параметры

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

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

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

Авторизация

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

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

delete Rows(rowPosition, howMany)

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

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

Параметры

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

Авторизация

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

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

delete Sheet(sheet)

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

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

Параметры

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

Авторизация

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

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

duplicate Active Sheet()

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

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

get Active Cell()

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

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

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

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

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

Авторизация

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

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

get Active Range()

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

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

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

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

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

Авторизация

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

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

См. также


get Active Range List()

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

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

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

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

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

Авторизация

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

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

См. также


get Active Sheet()

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

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

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

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

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


get As(contentType)

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

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

Параметры

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

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

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


get Bandings()

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

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

get Blob()

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

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

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


get Column Width(columnPosition)

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

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

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

Параметры

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

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

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

Авторизация

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

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

get Current Cell()

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

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

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

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

Авторизация

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

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

get Data Range()

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

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

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

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

// This logs the spreadsheet in CSV format with a trailing comma
for (let i = 0; i < values.length; i++) {
  let row = '';
  for (let 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

get Data Source Formulas()

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

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

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

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

Авторизация

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

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

get Data Source Pivot Tables()

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

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

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

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

Авторизация

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

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

get Data Source Refresh Schedules()

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

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

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

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

Авторизация

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

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

get Data Source Sheets()

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

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

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

Data Source Sheet[] — массив всех листов источников данных.

Авторизация

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

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

get Data Source Tables()

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

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

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

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

Авторизация

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

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

get Data Sources()

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

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

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

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

Авторизация

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

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

get Developer Metadata()

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

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

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

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

Авторизация

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

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

get Editors()

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

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

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

Авторизация

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

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

get Form Url()

Возвращает 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

get Frozen Columns()

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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

get Frozen Rows()

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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

get Id()

Получает уникальный идентификатор этой электронной таблицы. Идентификатор электронной таблицы можно извлечь из ее 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 — уникальный идентификатор (или ключ) электронной таблицы.


get Images()

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

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

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

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

Авторизация

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

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

get Iterative Calculation Convergence Threshold()

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

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

get Last Column()

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

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

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

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

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

Авторизация

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

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

get Last Row()

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

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

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

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

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

Авторизация

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

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

get Max Iterative Calculation Cycles()

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

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

get Name()

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

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

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

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

Авторизация

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

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

get Named Ranges()

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

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

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

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

Авторизация

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

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

get Num Sheets()

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

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

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

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


get Owner()

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

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

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

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

Авторизация

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

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

get Predefined Spreadsheet Themes()

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

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

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

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

Авторизация

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

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

get Protections(type)

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

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

Параметры

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

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

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

Авторизация

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

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

get Range(a1Notation)

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

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

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

Параметры

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

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

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

Авторизация

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

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

get Range By Name(name)

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

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

Параметры

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

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

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


get Range List(a1Notations)

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

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

Параметры

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

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

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

Авторизация

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

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

get Recalculation Interval()

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

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

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

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

Авторизация

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

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

get Row Height(rowPosition)

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

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

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

Параметры

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

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

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

Авторизация

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

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

get Selection()

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

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

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

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

Авторизация

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

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

get Sheet By Id(id)

Получает лист с заданным идентификатором. Используйте Sheet.getSheetId() .

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheetById(12345);

Параметры

Имя Тип Описание
id Integer Идентификатор листа, который нужно получить.

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

Sheet — лист с заданным идентификатором или null , если лист не найден.


get Sheet By Name(name)

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

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

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

Параметры

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

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

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


get Sheet Id()

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

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

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

Logger.log(sheet.getSheetId());

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

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

Авторизация

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

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

get Sheet Name()

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

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

Logger.log(sheet.getSheetName());

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

String — имя листа

Авторизация

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

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

get Sheet Values(startRow, startColumn, numRows, numColumns)

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

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

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

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

Параметры

Имя Тип Описание
start Row Integer Положение стартового ряда.
start Column Integer Положение стартовой колонны.
num Rows Integer Количество строк, для которых возвращаются значения.
num Columns Integer Количество столбцов, для которых возвращаются значения.

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

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

Авторизация

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

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

get Sheets()

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

// The code below logs the name of the second sheet
const sheets = SpreadsheetApp.getActiveSpreadsheet().getSheets();
// Iterates through the sheets and logs the name and ID of each sheet.
for (const sheet of sheets) {
  Logger.log(`name: ${sheet.getName()}, ID: ${sheet.getSheetId()}`);
}

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

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


get Spreadsheet 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',
);

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

get Spreadsheet Theme()

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

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

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

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

Авторизация

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

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

get Spreadsheet Time Zone()

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

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

get Url()

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

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

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

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

Авторизация

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

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

get Viewers()

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

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

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

Авторизация

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

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

hide Column(column)

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

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

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

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

Параметры

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

Авторизация

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

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

hide Row(row)

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

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

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

Параметры

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

Авторизация

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

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

insert Column After(afterPosition)

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

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

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

Параметры

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

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

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

Авторизация

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

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

insert Column Before(beforePosition)

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

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

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

Параметры

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

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

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

Авторизация

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

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

insert Columns After(afterPosition, howMany)

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

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

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

Параметры

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

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

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

Авторизация

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

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

insert Columns Before(beforePosition, howMany)

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

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

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

Параметры

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

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

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

Авторизация

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

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

insert Data Source Sheet(spec)

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

Выдает исключение, если тип источника данных не включен. Используйте методы Spreadsheet App#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 Data Source Spec Спецификация источника данных для вставки.

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

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

Авторизация

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

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

insert Image(blobSource, column, row)

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

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

const binaryData = [];  // TODO(developer): Replace with your binary data.
const blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1);

Параметры

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

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

Over Grid Image — вставленное изображение.

Авторизация

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

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

insert Image(blobSource, column, row, offsetX, offsetY)

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

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

const binaryData = [];  // TODO(developer): Replace with your binary data.
const blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1, 10, 10);

Параметры

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

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

Over Grid Image — вставленное изображение.

Авторизация

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

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

insert Image(url, column, row)

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

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

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

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

Параметры

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

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

Over Grid Image — вставленное изображение.

Авторизация

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

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

insert Image(url, column, row, offsetX, offsetY)

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

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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 Вертикальное смещение от угла ячейки в пикселях.

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

Over Grid Image — вставленное изображение.

Авторизация

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

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

insert Row After(afterPosition)

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

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

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

Параметры

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

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

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

Авторизация

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

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

insert Row Before(beforePosition)

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

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

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

Параметры

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

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

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

Авторизация

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

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

insert Rows After(afterPosition, howMany)

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

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

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

Параметры

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

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

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

Авторизация

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

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

insert Rows Before(beforePosition, howMany)

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

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

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

Параметры

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

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

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

Авторизация

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

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

insert Sheet()

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

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

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

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

Авторизация

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

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

insert Sheet(sheetIndex)

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

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

Параметры

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

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

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

Авторизация

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

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

insert Sheet(sheetIndex, options)

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

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

Параметры

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

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

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

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

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

Авторизация

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

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

insert Sheet(options)

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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

insert Sheet(sheetName)

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

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

Параметры

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

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

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

Авторизация

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

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

insert Sheet(sheetName, sheetIndex)

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

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

Параметры

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

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

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

Авторизация

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

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

insert Sheet(sheetName, sheetIndex, options)

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

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

Параметры

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

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

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

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

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

Авторизация

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

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

insert Sheet(sheetName, options)

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

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

Параметры

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

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

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

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

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

Авторизация

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

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

insert Sheet With Data Source Table(spec)

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

Выдает исключение, если тип источника данных не включен. Используйте методы Spreadsheet App#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',
);

// 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 Data Source Spec Спецификация источника данных для вставки.

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

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

Авторизация

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

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

is Column Hidden By User(columnPosition)

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

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

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

Параметры

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

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

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

Авторизация

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

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

is Iterative Calculation Enabled()

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

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

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

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

Авторизация

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

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

is Row Hidden By Filter(rowPosition)

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

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

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

Параметры

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

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

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

Авторизация

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

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

is Row Hidden By User(rowPosition)

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

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

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

Параметры

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

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

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

Авторизация

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

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

move Active Sheet(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.
const spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
// Gets the "first" sheet and activates it.
const 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

move Chart To Object Sheet(chart)

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

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

Параметры

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

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

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

Авторизация

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

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

refresh All Data Sources()

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

Используйте методы Spreadsheet App#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

remove Editor(emailAddress)

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

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

Параметры

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

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

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

Авторизация

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

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

remove Editor(user)

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

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

Параметры

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

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

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

Авторизация

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

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

remove Menu(name)

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

// The onOpen function is executed automatically every time a Spreadsheet is
// loaded
function onOpen() {
  const ss = SpreadsheetApp.getActiveSpreadsheet();
  ss.addMenu('badMenu', [
    {name: 'remove bad menu', functionName: 'removeBadMenu'},
    {name: 'foo', functionName: 'foo'},
  ]);
}
function removeBadMenu() {
  const 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

remove Named Range(name)

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

// The code below creates a new named range "foo", and then remove it.
const 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

remove Viewer(emailAddress)

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

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

Параметры

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

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

Spreadsheet — эта Spreadsheet для создания цепочки.

Авторизация

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

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

remove Viewer(user)

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

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

Параметры

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

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

Spreadsheet — эта Spreadsheet для создания цепочек.

Авторизация

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

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

rename(newName)

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
ss.rename('This is the new name');

Параметры

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

Авторизация

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

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

rename Active Sheet(newName)

Переименовывает текущий активный лист, присваивая ему новое имя.

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

Параметры

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

Авторизация

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

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

reset Spreadsheet Theme()

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

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

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

Spreadsheet Theme — тема по умолчанию.

Авторизация

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

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

set Active Range(range)

Устанавливает указанный диапазон в качестве active range на активном листе, при этом верхняя левая ячейка диапазона становится current cell .

const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
const range = sheet.getRange('A1:D4');
sheet.setActiveRange(range);

const selection = sheet.getSelection();
// Current cell: A1
const currentCell = selection.getCurrentCell();
// Active Range: A1:D4
const activeRange = selection.getActiveRange();

Параметры

Имя Тип Описание
range Range Диапазон, который необходимо установить в качестве активного диапазона.

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

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

Авторизация

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

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

set Active Range List(rangeList)

Устанавливает указанный список диапазонов в качестве active ranges на активном листе. Последний диапазон в списке устанавливается как active range .

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['D4', 'B2:C4']);
sheet.setActiveRangeList(rangeList);

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

Параметры

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

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

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

Авторизация

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

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

set Active Selection(range)

Устанавливает активную область выбора для этого листа.

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

const range = sheet.getRange('A1:D4');
sheet.setActiveSelection(range);

Параметры

Имя Тип Описание
range Range Диапазон, который будет установлен в качестве активного выбора.

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

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

Авторизация

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

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

set Active Selection(a1Notation)

Устанавливает активный выбор, как указано в нотации A1 или нотации R1C1.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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

set Active Sheet(sheet)

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

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

Параметры

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

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

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

Авторизация

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

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

set Active Sheet(sheet, restoreSelection)

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

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

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

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

Параметры

Имя Тип Описание
sheet Sheet Новый активный лист.
restore Selection Boolean Если true , самый последний выбор нового активного листа становится выбранным снова, когда новый лист становится активным; если false , новый лист становится активным без изменения текущего выбора.

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

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

Авторизация

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

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

set Column Width(columnPosition, width)

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

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

// Sets the first column to a width of 200 pixels
sheet.setColumnWidth(1, 200);

Параметры

Имя Тип Описание
column Position Integer Позиция данного столбца, которую нужно установить.
width Integer Ширина в пикселях, которую необходимо установить.

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

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

Авторизация

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

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

set Current Cell(cell)

Устанавливает указанную ячейку в качестве current cell .

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

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

Примечание. Указанный Range должен состоять из одной ячейки, иначе будет выдано исключение.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
const cell = sheet.getRange('B5');
sheet.setCurrentCell(cell);

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

Параметры

Имя Тип Описание
cell Range Ячейка, которую необходимо установить в качестве текущей.

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

Range — вновь установленная текущая ячейка

Авторизация

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

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

set Frozen Columns(columns)

Замораживает заданное количество столбцов. Если ноль, столбцы не замораживаются.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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

set Frozen Rows(rows)

Замораживает заданное количество строк. Если ноль, строки не замораживаются.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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

set Iterative Calculation Convergence Threshold(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());

Параметры

Имя Тип Описание
min Threshold Number Минимальный порог сходимости (должен быть неотрицательным).

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

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

Авторизация

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

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

set Iterative Calculation Enabled(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());

Параметры

Имя Тип Описание
is Enabled Boolean true , если итеративный расчет должен быть включен; false в противном случае.

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

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

Авторизация

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

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

set Max Iterative Calculation Cycles(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());

Параметры

Имя Тип Описание
max Iterations Integer Максимальное количество итераций расчета (от 1 до 10 000).

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

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

Авторизация

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

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

set Named Range(name, range)

Называет диапазон.

// The code below creates a new named range "TaxRates" in the active spreadsheet
const 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

set Recalculation Interval(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);

Параметры

Имя Тип Описание
recalculation Interval Recalculation Interval Новый интервал перерасчета.

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

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

Авторизация

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

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

set Row Height(rowPosition, height)

Устанавливает высоту данной строки в пикселях. По умолчанию строки увеличиваются в соответствии с содержимым ячейки. Если вы хотите принудительно установить строки на указанную высоту, используйте Sheet.setRowHeightsForced(startRow, numRows, height) .

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

// Sets the first row to a height of 200 pixels
sheet.setRowHeight(1, 200);

Параметры

Имя Тип Описание
row Position Integer Положение строки, которую нужно изменить.
height Integer Высота в пикселях, которую необходимо установить.

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

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

Авторизация

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

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

set Spreadsheet Locale(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

set Spreadsheet Theme(theme)

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

const spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
// The code below sets the second predefined theme as the current theme of the
// spreadsheet.
const predefinedThemesList = spreadsheet.getPredefinedSpreadsheetThemes();
spreadsheet.setSpreadsheetTheme(predefinedThemesList[1]);

Параметры

Имя Тип Описание
theme Spreadsheet Theme Тема для применения.

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

Spreadsheet Theme — новая текущая тема.

Авторизация

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

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

set Spreadsheet Time Zone(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 Часовой пояс, указанный в «длинном» формате (например, «Америка/Нью_Йорк», как указано на сайте Joda.org ).

Авторизация

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

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

show(userInterface)

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

Если серверный сценарий ранее отображал диалог, который еще не был закрыт, то существующий диалог заменяется пользовательским интерфейсом нового запрошенного диалога.

Следующий фрагмент кода отображает простое приложение Html Service в диалоговом окне с указанным заголовком, высотой и шириной:

const 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.

Параметры

Имя Тип Описание
user Interface Object Html Output .

Авторизация

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

  • https://www.googleapis.com/auth/script.container.ui

sort(columnPosition)

Сортирует лист по столбцам по возрастанию.

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

// Sorts the sheet by the first column, ascending
sheet.sort(1);

Параметры

Имя Тип Описание
column Position Integer Столбец для сортировки.

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

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

Авторизация

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

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

sort(columnPosition, ascending)

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

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

// Sorts the sheet by the first column, descending
sheet.sort(1, false);

Параметры

Имя Тип Описание
column Position 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 Необязательное название тоста.
timeout Seconds Number Таймаут в секундах; если null , время всплывающего уведомления по умолчанию составляет 5 секунд; если отрицательный, тост остается до тех пор, пока не будет отклонен.

Авторизация

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

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

unhide Column(column)

Отображает столбец в заданном диапазоне.

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

// This unhides the first column if it was previously hidden
const range = sheet.getRange('A1');
sheet.unhideColumn(range);

Параметры

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

Авторизация

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

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

unhide Row(row)

Отображает строку в заданном диапазоне.

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

// This unhides the first row if it was previously hidden
const range = sheet.getRange('A1');
sheet.unhideRow(range);

Параметры

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

Авторизация

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

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

update Menu(name, subMenus)

Обновляет меню, которое было добавлено в add Menu(name, subMenus) . Работает точно так же, как add Menu(name, subMenus) .

const ss = SpreadsheetApp.getActiveSpreadsheet();
const menuEntries = [];
menuEntries.push({name: 'Lone Menu Entry', functionName: 'function1'});
ss.updateMenu('addMenuExample', menuEntries);

Параметры

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

Авторизация

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

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

wait For All Data Executions Completion(timeoutInSeconds)

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

Параметры

Имя Тип Описание
timeout In Seconds Integer Время дождаться выполнения данных, в считанные секунды. Максимум - 300 секунд.

Авторизация

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

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

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