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

Class Range

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

Методы

Метод	Тип возврата	Краткое описание
`activate()`	`Range`	Устанавливает указанный диапазон в качестве `active range` , при этом верхняя левая ячейка диапазона становится `current cell` .
`activate As Current Cell()`	`Range`	Устанавливает указанную ячейку в качестве `current cell` .
`add Developer Metadata(key)`	`Range`	Добавляет метаданные разработчика с указанным ключом в диапазон.
`add Developer Metadata(key, visibility)`	`Range`	Добавляет метаданные разработчика с указанным ключом и видимостью в диапазон.
`add Developer Metadata(key, value)`	`Range`	Добавляет метаданные разработчика с указанным ключом и значением в диапазон.
`add Developer Metadata(key, value, visibility)`	`Range`	Добавляет метаданные разработчика с указанным ключом, значением и видимостью в диапазон.
`apply Column Banding()`	`Banding`	Применяет к диапазону тему группировки столбцов по умолчанию.
`apply Column Banding(bandingTheme)`	`Banding`	Применяет указанную тему объединения столбцов к диапазону.
`apply Column Banding(bandingTheme, showHeader, showFooter)`	`Banding`	Применяет указанную тему объединения столбцов к диапазону с указанными настройками верхнего и нижнего колонтитула.
`apply Row Banding()`	`Banding`	Применяет к диапазону тему группировки строк по умолчанию.
`apply Row Banding(bandingTheme)`	`Banding`	Применяет указанную тему объединения строк к диапазону.
`apply Row Banding(bandingTheme, showHeader, showFooter)`	`Banding`	Применяет указанную тему объединения строк к диапазону с указанными настройками верхнего и нижнего колонтитула.
`auto Fill(destination, series)`	`void`	Заполняет `destination Range` данными на основе данных в этом диапазоне.
`auto Fill To Neighbor(series)`	`void`	Вычисляет диапазон для заполнения новыми данными на основе соседних ячеек и автоматически заполняет этот диапазон новыми значениями на основе данных, содержащихся в этом диапазоне.
`break Apart()`	`Range`	Снова разбейте все ячейки с несколькими столбцами в диапазоне на отдельные ячейки.
`can Edit()`	`Boolean`	Определяет, имеет ли пользователь разрешение на редактирование каждой ячейки диапазона.
`check()`	`Range`	Изменяет состояние флажков в диапазоне на «отмечено».
`clear()`	`Range`	Очищает диапазон содержимого и форматов.
`clear(options)`	`Range`	Очищает диапазон содержимого, формата, правил проверки данных и/или комментариев, как указано с помощью заданных дополнительных параметров.
`clear Content()`	`Range`	Очищает содержимое диапазона, оставляя форматирование нетронутым.
`clear Data Validations()`	`Range`	Очищает правила проверки данных для диапазона.
`clear Format()`	`Range`	Очищает форматирование для этого диапазона.
`clear Note()`	`Range`	Очищает заметку в данной ячейке или ячейках.
`collapse Groups()`	`Range`	Сворачивает все группы, которые полностью содержатся в диапазоне.
`copy Format To Range(gridId, column, columnEnd, row, rowEnd)`	`void`	Скопируйте форматирование диапазона в указанное место.
`copy Format To Range(sheet, column, columnEnd, row, rowEnd)`	`void`	Скопируйте форматирование диапазона в указанное место.
`copy To(destination)`	`void`	Копирует данные из диапазона ячеек в другой диапазон ячеек.
`copy To(destination, copyPasteType, transposed)`	`void`	Копирует данные из диапазона ячеек в другой диапазон ячеек.
`copy To(destination, options)`	`void`	Копирует данные из диапазона ячеек в другой диапазон ячеек.
`copy Values To Range(gridId, column, columnEnd, row, rowEnd)`	`void`	Скопируйте содержимое диапазона в указанное место.
`copy Values To Range(sheet, column, columnEnd, row, rowEnd)`	`void`	Скопируйте содержимое диапазона в указанное место.
`create Data Source Pivot Table(dataSource)`	`Data Source Pivot Table`	Создает пустую сводную таблицу источника данных из источника данных, привязанную к первой ячейке в этом диапазоне.
`create Data Source Table(dataSource)`	`Data Source Table`	Создает пустую таблицу источника данных из источника данных, привязанную к первой ячейке в этом диапазоне.
`create Developer Metadata Finder()`	`Developer Metadata Finder`	Возвращает DeveloperMetadataFinderApi для поиска метаданных разработчика в пределах этого диапазона.
`create Filter()`	`Filter`	Создает фильтр и применяет его к указанному диапазону на листе.
`create Pivot Table(sourceData)`	`Pivot Table`	Создает пустую сводную таблицу из указанных `source Data` привязанных к первой ячейке в этом диапазоне.
`create Text Finder(findText)`	`Text Finder`	Создает поисковик текста для диапазона, который может находить и заменять текст в этом диапазоне.
`delete Cells(shiftDimension)`	`void`	Удаляет этот диапазон ячеек.
`expand Groups()`	`Range`	Разворачивает свернутые группы, диапазон которых или переключатель управления пересекаются с этим диапазоном.
`getA1Notation()`	`String`	Возвращает строковое описание диапазона в нотации A1.
`get Background()`	`String`	Возвращает цвет фона верхней левой ячейки диапазона (например, `'#ffffff'` ).
`get Background Object()`	`Color`	Возвращает цвет фона верхней левой ячейки диапазона.
`get Background Objects()`	`Color[][]`	Возвращает цвета фона ячеек в диапазоне.
`get Backgrounds()`	`String[][]`	Возвращает цвета фона ячеек в диапазоне (например, `'#ffffff'` ).
`get Bandings()`	`Banding[]`	Возвращает все полосы, примененные к любым ячейкам в этом диапазоне.
`get Cell(row, column)`	`Range`	Возвращает данную ячейку в диапазоне.
`get Column()`	`Integer`	Возвращает начальную позицию столбца для этого диапазона.
`get Data Region()`	`Range`	Возвращает копию диапазона, расширенного по четырем кардинальным `Direction` , чтобы охватить все соседние ячейки с данными в них.
`get Data Region(dimension)`	`Range`	Возвращает копию расширенного диапазона `Direction.UP` и `Direction.DOWN` если указанное измерение — `Dimension.ROWS` , или `Direction.NEXT` и `Direction.PREVIOUS` если измерение — `Dimension.COLUMNS` .
`get Data Source Formula()`	`Data Source Formula`	Возвращает `Data Source Formula` для первой ячейки диапазона или `null` , если ячейка не содержит формулу источника данных.
`get Data Source Formulas()`	`Data Source Formula[]`	Возвращает `Data Source Formula` для ячеек в диапазоне.
`get Data Source Pivot Tables()`	`Data Source Pivot Table[]`	Получает все сводные таблицы источника данных, пересекающие диапазон.
`get Data Source Tables()`	`Data Source Table[]`	Получает все таблицы источников данных, пересекающие диапазон.
`get Data Source Url()`	`String`	Возвращает URL-адрес данных в этом диапазоне, который можно использовать для создания диаграмм и запросов.
`get Data Table()`	`Data Table`	Верните данные внутри этого объекта в виде DataTable.
`get Data Table(firstRowIsHeader)`	`Data Table`	Верните данные внутри этого диапазона в виде DataTable.
`get Data Validation()`	`Data Validation`	Возвращает правило проверки данных для левой верхней ячейки диапазона.
`get Data Validations()`	`Data Validation[][]`	Возвращает правила проверки данных для всех ячеек диапазона.
`get Developer Metadata()`	`Developer Metadata[]`	Получает метаданные разработчика, связанные с этим диапазоном.
`get Display Value()`	`String`	Возвращает отображаемое значение верхней левой ячейки диапазона.
`get Display Values()`	`String[][]`	Возвращает прямоугольную сетку значений для этого диапазона.
`get Filter()`	`Filter`	Возвращает фильтр на листе, которому принадлежит этот диапазон, или `null` если на листе нет фильтра.
`get Font Color Object()`	`Color`	Возвращает цвет шрифта ячейки в верхнем левом углу диапазона.
`get Font Color Objects()`	`Color[][]`	Возвращает цвета шрифта ячеек в диапазоне.
`get Font Families()`	`String[][]`	Возвращает семейства шрифтов ячеек в диапазоне.
`get Font Family()`	`String`	Возвращает семейство шрифтов ячейки в верхнем левом углу диапазона.
`get Font Line()`	`String`	Получает стиль линии ячейки в верхнем левом углу диапазона ( `'underline'` , `'line-through'` или `'none'` ).
`get Font Lines()`	`String[][]`	Получает стиль линии ячеек в диапазоне ( `'underline'` , `'line-through'` или `'none'` ).
`get Font Size()`	`Integer`	Возвращает размер шрифта в пунктах ячейки в верхнем левом углу диапазона.
`get Font Sizes()`	`Integer[][]`	Возвращает размеры шрифта ячеек в диапазоне.
`get Font Style()`	`String`	Возвращает стиль шрифта ( `'italic'` или `'normal'` ) ячейки в верхнем левом углу диапазона.
`get Font Styles()`	`String[][]`	Возвращает стили шрифта ячеек в диапазоне.
`get Font Weight()`	`String`	Возвращает толщину шрифта (обычный/жирный) ячейки в верхнем левом углу диапазона.
`get Font Weights()`	`String[][]`	Возвращает толщину шрифта ячеек в диапазоне.
`get Formula()`	`String`	Возвращает формулу (нотация A1) для верхней левой ячейки диапазона или пустую строку, если ячейка пуста или не содержит формулы.
`get Formula R1C1()`	`String`	Возвращает формулу (нотацию R1C1) для данной ячейки или `null` , если ее нет.
`get Formulas()`	`String[][]`	Возвращает формулы (обозначение A1) для ячеек диапазона.
`get Formulas R1C1()`	`String[][]`	Возвращает формулы (нотация R1C1) для ячеек диапазона.
`get Grid Id()`	`Integer`	Возвращает идентификатор сетки родительского листа диапазона.
`get Height()`	`Integer`	Возвращает высоту диапазона.
`get Horizontal Alignment()`	`String`	Возвращает горизонтальное выравнивание текста (слева/по центру/справа) ячейки в верхнем левом углу диапазона.
`get Horizontal Alignments()`	`String[][]`	Возвращает горизонтальное выравнивание ячеек в диапазоне.
`get Last Column()`	`Integer`	Возвращает конечную позицию столбца.
`get Last Row()`	`Integer`	Возвращает позицию конечной строки.
`get Merged Ranges()`	`Range[]`	Возвращает массив объектов `Range` , представляющих объединенные ячейки, которые либо полностью находятся в текущем диапазоне, либо содержат хотя бы одну ячейку в текущем диапазоне.
`get Next Data Cell(direction)`	`Range`	Начиная с ячейки в первом столбце и строке диапазона, возвращает следующую ячейку в заданном направлении, которая является краем непрерывного диапазона ячеек с данными в них, или ячейку на краю электронной таблицы в этом направлении.
`get Note()`	`String`	Возвращает ноту, связанную с заданным диапазоном.
`get Notes()`	`String[][]`	Возвращает примечания, связанные с ячейками диапазона.
`get Num Columns()`	`Integer`	Возвращает количество столбцов в этом диапазоне.
`get Num Rows()`	`Integer`	Возвращает количество строк в этом диапазоне.
`get Number Format()`	`String`	Получите формат числа или даты в верхней левой ячейке заданного диапазона.
`get Number Formats()`	`String[][]`	Возвращает форматы чисел или дат для ячеек в диапазоне.
`get Rich Text Value()`	`Rich Text Value`	Возвращает значение форматированного текста для верхней левой ячейки диапазона или `null` , если значение ячейки не является текстом.
`get Rich Text Values()`	`Rich Text Value[][]`	Возвращает значения форматированного текста для ячеек в диапазоне.
`get Row()`	`Integer`	Возвращает позицию строки для этого диапазона.
`get Row Index()`	`Integer`	Возвращает позицию строки для этого диапазона.
`get Sheet()`	`Sheet`	Возвращает лист, которому принадлежит этот диапазон.
`get Text Direction()`	`Text Direction`	Возвращает направление текста для верхней левой ячейки диапазона.
`get Text Directions()`	`Text Direction[][]`	Возвращает направления текста для ячеек в диапазоне.
`get Text Rotation()`	`Text Rotation`	Возвращает настройки поворота текста для верхней левой ячейки диапазона.
`get Text Rotations()`	`Text Rotation[][]`	Возвращает настройки поворота текста для ячеек в диапазоне.
`get Text Style()`	`Text Style`	Возвращает стиль текста для верхней левой ячейки диапазона.
`get Text Styles()`	`Text Style[][]`	Возвращает стили текста для ячеек в диапазоне.
`get Value()`	`Object`	Возвращает значение верхней левой ячейки диапазона.
`get Values()`	`Object[][]`	Возвращает прямоугольную сетку значений для этого диапазона.
`get Vertical Alignment()`	`String`	Возвращает вертикальное выравнивание (сверху/среди/снизу) ячейки в верхнем левом углу диапазона.
`get Vertical Alignments()`	`String[][]`	Возвращает вертикальное выравнивание ячеек в диапазоне.
`get Width()`	`Integer`	Возвращает ширину диапазона в столбцах.
`get Wrap()`	`Boolean`	Возвращает, переносится ли текст в ячейке.
`get Wrap Strategies()`	`Wrap Strategy[][]`	Возвращает стратегии переноса текста для ячеек в диапазоне.
`get Wrap Strategy()`	`Wrap Strategy`	Возвращает стратегию переноса текста для верхней левой ячейки диапазона.
`get Wraps()`	`Boolean[][]`	Возвращает, переносится ли текст в ячейках.
`insert Cells(shiftDimension)`	`Range`	Вставляет пустые ячейки в этот диапазон.
`insert Checkboxes()`	`Range`	Вставляет флажки в каждую ячейку диапазона, настроив `true` для отмеченного и `false` для неотмеченного.
`insert Checkboxes(checkedValue)`	`Range`	Вставляет флажки в каждую ячейку диапазона, настроенную с пользовательским значением для отмеченного и пустой строкой для непроверенного.
`insert Checkboxes(checkedValue, uncheckedValue)`	`Range`	Вставляет флажки в каждую ячейку диапазона с настраиваемыми значениями для отмеченного и неотмеченного состояний.
`is Blank()`	`Boolean`	Возвращает `true` если диапазон полностью пуст.
`is Checked()`	`Boolean`	Возвращает, имеют ли все ячейки в диапазоне состояние флажка «отмечено».
`is End Column Bounded()`	`Boolean`	Определяет, привязан ли конец диапазона к определенному столбцу.
`is End Row Bounded()`	`Boolean`	Определяет, привязан ли конец диапазона к определенной строке.
`is Part Of Merge()`	`Boolean`	Возвращает `true` , если ячейки в текущем диапазоне перекрывают любые объединенные ячейки.
`is Start Column Bounded()`	`Boolean`	Определяет, привязано ли начало диапазона к определенному столбцу.
`is Start Row Bounded()`	`Boolean`	Определяет, привязано ли начало диапазона к определенной строке.
`merge()`	`Range`	Объединяет ячейки диапазона в один блок.
`merge Across()`	`Range`	Объедините ячейки диапазона по столбцам диапазона.
`merge Vertically()`	`Range`	Объединяет ячейки диапазона вместе.
`move To(target)`	`void`	Вырежьте и вставьте (как формат, так и значения) из этого диапазона в целевой диапазон.
`offset(rowOffset, columnOffset)`	`Range`	Возвращает новый диапазон, смещенный от этого диапазона на заданное количество строк и столбцов (которое может быть отрицательным).
`offset(rowOffset, columnOffset, numRows)`	`Range`	Возвращает новый диапазон относительно текущего диапазона, верхняя левая точка которого смещена от текущего диапазона на заданные строки и столбцы и имеет заданную высоту в ячейках.
`offset(rowOffset, columnOffset, numRows, numColumns)`	`Range`	Возвращает новый диапазон относительно текущего диапазона, верхняя левая точка которого смещена от текущего диапазона на заданные строки и столбцы и имеет заданную высоту и ширину в ячейках.
`protect()`	`Protection`	Создает объект, который может защитить диапазон от редактирования, за исключением пользователей, имеющих разрешение.
`randomize()`	`Range`	Рандомизирует порядок строк в заданном диапазоне.
`remove Checkboxes()`	`Range`	Удаляет все флажки из диапазона.
`remove Duplicates()`	`Range`	Удаляет строки в этом диапазоне, содержащие значения, которые являются дубликатами значений в любой предыдущей строке.
`remove Duplicates(columnsToCompare)`	`Range`	Удаляет строки в этом диапазоне, содержащие значения в указанных столбцах, которые являются дубликатами значений любой предыдущей строки.
`set Background(color)`	`Range`	Устанавливает цвет фона всех ячеек в диапазоне в нотации CSS (например, `'#ffffff'` или `'white'` ).
`set Background Object(color)`	`Range`	Устанавливает цвет фона для всех ячеек диапазона.
`set Background Objects(color)`	`Range`	Устанавливает прямоугольную сетку цветов фона (размеры должны соответствовать этому диапазону).
`set Background RGB(red, green, blue)`	`Range`	Устанавливает фон заданного цвета, используя значения RGB (целые числа от 0 до 255 включительно).
`set Backgrounds(color)`	`Range`	Устанавливает прямоугольную сетку цветов фона (размеры должны соответствовать этому диапазону).
`set Border(top, left, bottom, right, vertical, horizontal)`	`Range`	Устанавливает свойство границы.
`set Border(top, left, bottom, right, vertical, horizontal, color, style)`	`Range`	Устанавливает свойство границы с цветом и/или стилем.
`set Data Validation(rule)`	`Range`	Устанавливает одно правило проверки данных для всех ячеек диапазона.
`set Data Validations(rules)`	`Range`	Устанавливает правила проверки данных для всех ячеек диапазона.
`set Font Color(color)`	`Range`	Устанавливает цвет шрифта в нотации CSS (например `'#ffffff'` или `'white'` ).
`set Font Color Object(color)`	`Range`	Устанавливает цвет шрифта данного диапазона.
`set Font Color Objects(colors)`	`Range`	Устанавливает прямоугольную сетку цветов шрифта (размеры должны соответствовать этому диапазону).
`set Font Colors(colors)`	`Range`	Устанавливает прямоугольную сетку цветов шрифта (размеры должны соответствовать этому диапазону).
`set Font Families(fontFamilies)`	`Range`	Устанавливает прямоугольную сетку семейств шрифтов (размеры должны соответствовать этому диапазону).
`set Font Family(fontFamily)`	`Range`	Устанавливает семейство шрифтов, например «Arial» или «Helvetica».
`set Font Line(fontLine)`	`Range`	Устанавливает стиль линии шрифта для данного диапазона ( `'underline'` , `'line-through'` или `'none'` ).
`set Font Lines(fontLines)`	`Range`	Устанавливает прямоугольную сетку стилей линий (размеры должны соответствовать этому диапазону).
`set Font Size(size)`	`Range`	Устанавливает размер шрифта, при этом размер является размером точки, который будет использоваться.
`set Font Sizes(sizes)`	`Range`	Устанавливает прямоугольную сетку размеров шрифта (размеры должны соответствовать этому диапазону).
`set Font Style(fontStyle)`	`Range`	Установите стиль шрифта для данного диапазона ( `'italic'` или `'normal'` ).
`set Font Styles(fontStyles)`	`Range`	Устанавливает прямоугольную сетку стилей шрифта (размеры должны соответствовать этому диапазону).
`set Font Weight(fontWeight)`	`Range`	Установите толщину шрифта для данного диапазона (обычный/жирный).
`set Font Weights(fontWeights)`	`Range`	Устанавливает прямоугольную сетку толщины шрифта (размеры должны соответствовать этому диапазону).
`set Formula(formula)`	`Range`	Обновляет формулу для этого диапазона.
`set Formula R1C1(formula)`	`Range`	Обновляет формулу для этого диапазона.
`set Formulas(formulas)`	`Range`	Устанавливает прямоугольную сетку формул (размеры должны соответствовать этому диапазону).
`set Formulas R1C1(formulas)`	`Range`	Устанавливает прямоугольную сетку формул (размеры должны соответствовать этому диапазону).
`set Horizontal Alignment(alignment)`	`Range`	Установите горизонтальное выравнивание (слева направо) для заданного диапазона (слева/по центру/справа).
`set Horizontal Alignments(alignments)`	`Range`	Устанавливает прямоугольную сетку горизонтальных выравниваний.
`set Note(note)`	`Range`	Устанавливает ноту на заданное значение.
`set Notes(notes)`	`Range`	Устанавливает прямоугольную сетку нот (должна соответствовать размерам этого диапазона).
`set Number Format(numberFormat)`	`Range`	Устанавливает формат числа или даты для данной строки форматирования.
`set Number Formats(numberFormats)`	`Range`	Устанавливает прямоугольную сетку форматов чисел или дат (размеры должны соответствовать этому диапазону).
`set Rich Text Value(value)`	`Range`	Устанавливает значение форматированного текста для ячеек в диапазоне.
`set Rich Text Values(values)`	`Range`	Устанавливает прямоугольную сетку значений форматированного текста.
`set Show Hyperlink(showHyperlink)`	`Range`	Устанавливает, должны ли в диапазоне отображаться гиперссылки.
`set Text Direction(direction)`	`Range`	Устанавливает направление текста для ячеек в диапазоне.
`set Text Directions(directions)`	`Range`	Устанавливает прямоугольную сетку направлений текста.
`set Text Rotation(degrees)`	`Range`	Задает настройки поворота текста для ячеек в диапазоне.
`set Text Rotation(rotation)`	`Range`	Задает настройки поворота текста для ячеек в диапазоне.
`set Text Rotations(rotations)`	`Range`	Устанавливает прямоугольную сетку вращения текста.
`set Text Style(style)`	`Range`	Устанавливает стиль текста для ячеек в диапазоне.
`set Text Styles(styles)`	`Range`	Устанавливает прямоугольную сетку стилей текста.
`set Value(value)`	`Range`	Устанавливает значение диапазона.
`set Values(values)`	`Range`	Устанавливает прямоугольную сетку значений (размеры должны соответствовать этому диапазону).
`set Vertical Alignment(alignment)`	`Range`	Установите вертикальное выравнивание (сверху вниз) для заданного диапазона (сверху/середине/снизу).
`set Vertical Alignments(alignments)`	`Range`	Устанавливает прямоугольную сетку вертикальных трасс (размеры должны соответствовать этому диапазону).
`set Vertical Text(isVertical)`	`Range`	Определяет, следует ли размещать текст в ячейках диапазона.
`set Wrap(isWrapEnabled)`	`Range`	Установите перенос ячеек данного диапазона.
`set Wrap Strategies(strategies)`	`Range`	Устанавливает прямоугольную сетку стратегий переноса.
`set Wrap Strategy(strategy)`	`Range`	Устанавливает стратегию переноса текста для ячеек в диапазоне.
`set Wraps(isWrapEnabled)`	`Range`	Устанавливает прямоугольную сетку политик переноса слов (размеры должны соответствовать этому диапазону).
`shift Column Group Depth(delta)`	`Range`	Изменяет глубину группировки столбцов диапазона на указанную величину.
`shift Row Group Depth(delta)`	`Range`	Изменяет глубину группировки строк диапазона на указанную величину.
`sort(sortSpecObj)`	`Range`	Сортирует ячейки в заданном диапазоне по указанному столбцу и порядку.
`split Text To Columns()`	`void`	Разбивает столбец текста на несколько столбцов на основе автоматически определенного разделителя.
`split Text To Columns(delimiter)`	`void`	Разбивает столбец текста на несколько столбцов, используя указанную строку в качестве пользовательского разделителя.
`split Text To Columns(delimiter)`	`void`	Разбивает столбец текста на несколько столбцов на основе указанного разделителя.
`trim Whitespace()`	`Range`	Обрезает пробелы (например, пробелы, табуляции или новые строки) в каждой ячейке в этом диапазоне.
`uncheck()`	`Range`	Изменяет состояние флажков в диапазоне на «не отмечено».

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

Метод	Тип возврата	Краткое описание
`get Font Color()`	`String`	Возвращает цвет шрифта ячейки в верхнем левом углу диапазона в нотации CSS (например, `'#ffffff'` или `'white'` ).
`get Font Colors()`	`String[][]`	Возвращает цвета шрифта ячеек в диапазоне в нотации CSS (например `'#ffffff'` или `'white'` ).

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

`activate()`

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

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
const range = sheet.getRange('A1:D10');
range.activate();

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

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

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

`activate As Current Cell()`

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

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

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

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

// Gets the first sheet of the spreadsheet.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// Gets the cell B5 and sets it as the active cell.
const range = sheet.getRange('B5');
const currentCell = range.activateAsCurrentCell();

// Logs the activated cell.
console.log(currentCell.getA1Notation());

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

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

Авторизация

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

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

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

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

// Gets row 2 on the sheet.
const range = sheet.getRange('2:2');

// Adds the key 'NAME' to the developer metadata for row 2.
range.addDeveloperMetadata('NAME');

// Gets the metadata and logs it to the console.
const developerMetaData = range.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());

Параметры

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

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

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

Авторизация

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

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

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

// Gets row 2 on Sheet1.
const range = sheet.getRange('2:2');

// Adds the key 'NAME' and sets the developer metadata visibility to 'DOCUMENT'
// for row 2 on Sheet1.
range.addDeveloperMetadata(
    'NAME',
    SpreadsheetApp.DeveloperMetadataVisibility.DOCUMENT,
);

// Gets the updated metadata info and logs it to the console.
const developerMetaData = range.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(developerMetaData.getVisibility().toString());

Параметры

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

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

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

Авторизация

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

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

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

// Gets row 2 of Sheet1.
const range = sheet.getRange('2:2');

// Adds the key 'NAME' and sets the value to 'GOOGLE' for the metadata of row 2.
range.addDeveloperMetadata('NAME', 'GOOGLE');

// Gets the metadata and logs it to the console.
const developerMetaData = range.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(developerMetaData.getValue());

Параметры

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

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

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

Авторизация

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

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

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

// Gets row 2 on the sheet.
const range = sheet.getRange('2:2');

// Adds the key 'NAME', sets the value to 'GOOGLE', and sets the visibility
// to PROJECT for row 2 on the sheet.
range.addDeveloperMetadata(
    'NAME',
    'GOOGLE',
    SpreadsheetApp.DeveloperMetadataVisibility.PROJECT,
);

// Gets the updated metadata info and logs it to the console.
const developerMetaData = range.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(developerMetaData.getValue());
console.log(developerMetaData.getVisibility().toString());

Параметры

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

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

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

Авторизация

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

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

`apply Column Banding()`

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

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

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

// Gets row 2 on the sheet.
const range = sheet.getRange('2:2');

// Applies column banding to row 2.
const colBanding = range.applyColumnBanding();

// Gets the first banding on the sheet and logs the color of the header column.
console.log(
    sheet.getBandings()[0]
        .getHeaderColumnColorObject()
        .asRgbColor()
        .asHexString(),
);

// Gets the first banding on the sheet and logs the color of the second column.
console.log(
    sheet.getBandings()[0]
        .getSecondColumnColorObject()
        .asRgbColor()
        .asHexString(),
);

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

Banding — новый бандинг.

Авторизация

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

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

`apply Column Banding(bandingTheme)`

Применяет указанную тему объединения столбцов к диапазону. По умолчанию полоса имеет цвет верхнего колонтитула и не имеет цвета нижнего колонтитула.

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

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

// Gets row 2 on the sheet.
const range = sheet.getRange('2:2');

// Applies the INDIGO color banding theme to the columns in row 2.
const colBanding = range.applyColumnBanding(SpreadsheetApp.BandingTheme.INDIGO);

// Gets the first banding on the sheet and logs the color of the second column.
console.log(
    sheet.getBandings()[0]
        .getSecondColumnColorObject()
        .asRgbColor()
        .asHexString(),
);

Параметры

Имя	Тип	Описание
`banding Theme`	`Banding Theme`	Цветовая тема, применяемая к столбцам в диапазоне.

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

Banding — новый бандинг.

Авторизация

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

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

`apply Column Banding(bandingTheme, showHeader, showFooter)`

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

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

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

// Gets rows 12-22 on the sheet.
const range = sheet.getRange('12:22');

// Applies the BLUE color banding theme to rows 12-22.
// Sets the header visibility to false and the footer visibility to true.
const colBanding = range.applyColumnBanding(
    SpreadsheetApp.BandingTheme.BLUE,
    false,
    true,
);

// Gets the banding color and logs it to the console.
console.log(
    sheet.getBandings()[0]
        .getSecondColumnColorObject()
        .asRgbColor()
        .asHexString(),
);

// Gets the header color object and logs it to the console. Returns null because
// the header visibility is set to false.
console.log(sheet.getBandings()[0].getHeaderColumnColorObject());

// Gets the footer color and logs it to the console.
console.log(
    sheet.getBandings()[0]
        .getFooterColumnColorObject()
        .asRgbColor()
        .asHexString(),
);

Параметры

Имя	Тип	Описание
`banding Theme`	`Banding Theme`	Цветовая тема, применяемая к столбцам в диапазоне.
`show Header`	`Boolean`	Если `true` , цвет заголовка темы полосы применяется к первому столбцу.
`show Footer`	`Boolean`	Если `true` , цвет нижнего колонтитула темы полосы применяется к последнему столбцу.

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

Banding — новый бандинг.

Авторизация

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

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

`apply Row Banding()`

Применяет к диапазону тему группировки строк по умолчанию. По умолчанию полоса имеет цвет верхнего колонтитула и не имеет цвета нижнего колонтитула.

// Opens the spreadsheet 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 rows 1-30 on Sheet1.
const range = sheet.getRange('1:30');

// Applies row banding to rows 1-30.
range.applyRowBanding();

// Gets the hex color of the second banded row.
const secondRowColor =
    range.getBandings()[0].getSecondRowColorObject().asRgbColor().asHexString();

// Logs the hex color to console.
console.log(secondRowColor);

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

Banding — Бандинг.

Авторизация

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

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

`apply Row Banding(bandingTheme)`

Применяет указанную тему объединения строк к диапазону. По умолчанию полоса имеет цвет верхнего колонтитула и не имеет цвета нижнего колонтитула.

// Opens the spreadsheet 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 rows 1-30 on Sheet1.
const range = sheet.getRange('1:30');

// Applies the INDIGO row banding theme to rows 1-30.
range.applyRowBanding(SpreadsheetApp.BandingTheme.INDIGO);

// Gets the hex color of the second banded row.
const secondRowColor =
    range.getBandings()[0].getSecondRowColorObject().asRgbColor().asHexString();

// Logs the hex color to console.
console.log(secondRowColor);

Параметры

Имя	Тип	Описание
`banding Theme`	`Banding Theme`	Цветовая тема, применяемая к строкам в диапазоне.

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

Banding — новый бандинг.

Авторизация

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

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

`apply Row Banding(bandingTheme, showHeader, showFooter)`

Применяет указанную тему объединения строк к диапазону с указанными настройками верхнего и нижнего колонтитула.

// Opens the spreadsheet 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 rows 1-30 on Sheet1.
const range = sheet.getRange('1:30');

// Applies the INDIGO row banding to rows 1-30 and
// specifies to hide the header and show the footer.
range.applyRowBanding(SpreadsheetApp.BandingTheme.INDIGO, false, true);

Параметры

Имя	Тип	Описание
`banding Theme`	`Banding Theme`	Цветовая тема, применяемая к строкам в диапазоне.
`show Header`	`Boolean`	Если `true` , цвет заголовка темы полосы применяется к первой строке.
`show Footer`	`Boolean`	Если `true` , цвет нижнего колонтитула темы полосы применяется к последней строке.

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

Banding — новый бандинг.

Авторизация

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

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

`auto Fill(destination, series)`

Заполняет destination Range данными на основе данных в этом диапазоне. Новые значения также определяются указанным типом series . Диапазон назначения должен содержать этот диапазон и расширять его только в одном направлении. Например, следующее заполняет A1:A20 серией возрастающих чисел на основе текущих значений в A1:A4 :

const sheet = SpreadsheetApp.getActiveSheet();

// Has values [1, 2, 3, 4].
const sourceRange = sheet.getRange('A1:A4');
// The range to fill with values.
const destination = sheet.getRange('A1:A20');

// Inserts new values in A5:A20, continuing the pattern expressed in A1:A4
sourceRange.autoFill(destination, SpreadsheetApp.AutoFillSeries.DEFAULT_SERIES);

Параметры

Имя	Тип	Описание
`destination`	`Range`	Диапазон, который будет автоматически заполнен значениями. Диапазон назначения должен содержать этот диапазон и расширять его только в одном направлении (вверх, вниз, влево или вправо).
`series`	`Auto Fill Series`	Тип серии автозаполнения, которая должна использоваться для расчета новых значений. Эффект этого ряда различается в зависимости от типа и объема исходных данных.

Авторизация

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

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

`auto Fill To Neighbor(series)`

Вычисляет диапазон для заполнения новыми данными на основе соседних ячеек и автоматически заполняет этот диапазон новыми значениями на основе данных, содержащихся в этом диапазоне. Эти новые значения также определяются указанным типом series .

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

Например, если A1:A20 заполнен серией возрастающих чисел и этот метод вызывается для диапазона B1:B4 , который содержит серию дат, новые значения вставляются только в B5:B20 . Таким образом, эти новые значения «прилипают» к ячейкам, содержащим значения в столбце A.

const sheet = SpreadsheetApp.getActiveSheet();

// A1:A20 has values [1, 2, 3, ... 20].
// B1:B4 has values [1/1/2017, 1/2/2017, ...]
const sourceRange = sheet.getRange('B1:B4');

// Results in B5:B20 having values [1/5/2017, ... 1/20/2017]
sourceRange.autoFillToNeighbor(SpreadsheetApp.AutoFillSeries.DEFAULT_SERIES);

Параметры

Имя	Тип	Описание
`series`	`Auto Fill Series`	Тип серии автозаполнения, которая должна использоваться для расчета новых значений. Эффект этого ряда различается в зависимости от типа и объема исходных данных.

Авторизация

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

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

`break Apart()`

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

Вызов этой функции для диапазона эквивалентен выбору диапазона и нажатии «Формат» > «Объединить ячейки» > «Разъединить» .

// Opens the spreadsheet 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 range A1:C6 on Sheet1.
const range = sheet.getRange('A1:C6');

// Unmerges the range A1:C6 into individual cells.
range.breakApart();

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

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

Авторизация

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

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

`can Edit()`

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

// Opens the spreadsheet 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 range A1:C6 on Sheet1.
const range = sheet.getRange('A1:C6');

// Logs whether the user has permission to edit every cell in the range.
console.log(range.canEdit());

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

Boolean — true , если у пользователя есть разрешение на редактирование каждой ячейки диапазона; false в противном случае.

Авторизация

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

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

`check()`

Изменяет состояние флажков в диапазоне на «отмечено». Игнорирует ячейки в диапазоне, которые в данный момент не содержат настроенное отмеченное или непроверенное значение.

// Changes the state of cells which currently contain either the checked or
// unchecked value configured in the range A1:B10 to 'checked'.
const range = SpreadsheetApp.getActive().getRange('A1:B10');
range.check();

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

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

Авторизация

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

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

`clear()`

Очищает диапазон содержимого и форматов.

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

const range = sheet.getRange('A1:D10');
range.clear();

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

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

Авторизация

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

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

`clear(options)`

Очищает диапазон содержимого, формата, правил проверки данных и/или комментариев, как указано с помощью заданных дополнительных параметров. По умолчанию все данные удаляются.

// The code below clears range C2:G7 in the active sheet, but preserves the
// format, data validation rules, and comments.
SpreadsheetApp.getActiveSheet().getRange(2, 3, 6, 5).clear({
  contentsOnly: true
});

Параметры

Имя	Тип	Описание
`options`	`Object`	Объект JavaScript, задающий дополнительные параметры, как указано ниже.

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

Имя	Тип	Описание
`comments Only`	`Boolean`	Очистить ли только комментарии.
`contents Only`	`Boolean`	Очищать ли только содержимое.
`format Only`	`Boolean`	Очистить ли только формат; Обратите внимание, что очистка формата также очищает правила проверки данных.
`validations Only`	`Boolean`	Следует ли очищать только правила проверки данных.
`skip Filtered Rows`	`Boolean`	Следует ли избегать очистки отфильтрованных строк.

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

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

Авторизация

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

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

`clear Content()`

Очищает содержимое диапазона, оставляя форматирование нетронутым.

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

const range = sheet.getRange('A1:D10');
range.clearContent();

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

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

Авторизация

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

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

`clear Data Validations()`

Очищает правила проверки данных для диапазона.

// Clear the data validation rules for cells A1:B5.
const range = SpreadsheetApp.getActive().getRange('A1:B5');
range.clearDataValidations();

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

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

Авторизация

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

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

`clear Format()`

Очищает форматирование для этого диапазона.

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

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

const range = sheet.getRange('A1:D10');
range.clearFormat();

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

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

Авторизация

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

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

`clear Note()`

Очищает заметку в данной ячейке или ячейках.

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

const range = sheet.getRange('A1:D10');
range.clearNote();

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

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

Авторизация

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

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

`collapse Groups()`

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

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

// All row and column groups within the range are collapsed.
range.collapseGroups();

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

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

Авторизация

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

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

`copy Format To Range(gridId, column, columnEnd, row, rowEnd)`

Скопируйте форматирование диапазона в указанное место. Если место назначения больше или меньше исходного диапазона, то источник соответственно повторяется или усекается. Обратите внимание, что этот метод копирует только форматирование.

Подробное описание параметра GridId см. в разделе get Grid Id() .

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

const range = source.getRange('B2:D4');

// This copies the formatting in B2:D4 in the source sheet to
// D4:F6 in the sheet with gridId 1555299895. Note that you can get the gridId
// of a sheet by calling sheet.getSheetId() or range.getGridId().
range.copyFormatToRange(1555299895, 4, 6, 4, 6);

Параметры

Имя	Тип	Описание
`grid Id`	`Integer`	Уникальный идентификатор листа в электронной таблице, независимо от его положения.
`column`	`Integer`	Первый столбец целевого диапазона.
`column End`	`Integer`	Конечный столбец целевого диапазона.
`row`	`Integer`	Начальная строка целевого диапазона.
`row End`	`Integer`	Конечная строка целевого диапазона.

Авторизация

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

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

См. также

get Grid Id()

`copy Format To Range(sheet, column, columnEnd, row, rowEnd)`

const ss = SpreadsheetApp.getActiveSpreadsheet();
const source = ss.getSheets()[0];
const destination = ss.getSheets()[1];

const range = source.getRange('B2:D4');

// This copies the formatting in B2:D4 in the source sheet to
// D4:F6 in the second sheet
range.copyFormatToRange(destination, 4, 6, 4, 6);

Параметры

Имя	Тип	Описание
`sheet`	`Sheet`	Целевой лист.
`column`	`Integer`	Первый столбец целевого диапазона.
`column End`	`Integer`	Конечный столбец целевого диапазона.
`row`	`Integer`	Начальная строка целевого диапазона.
`row End`	`Integer`	Конечная строка целевого диапазона.

Авторизация

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

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

`copy To(destination)`

Копирует данные из диапазона ячеек в другой диапазон ячеек. Копируются как значения, так и форматирование.

// The code below copies the first 5 columns over to the 6th column.
const sheet = SpreadsheetApp.getActiveSheet();
const rangeToCopy = sheet.getRange(1, 1, sheet.getMaxRows(), 5);
rangeToCopy.copyTo(sheet.getRange(1, 6));

Параметры

Имя	Тип	Описание
`destination`	`Range`	Диапазон назначения для копирования; важна только позиция верхней левой ячейки.

Авторизация

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

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

`copy To(destination, copyPasteType, transposed)`

Копирует данные из диапазона ячеек в другой диапазон ячеек.

// The code below copies only the values of the first 5 columns over to the 6th
// column.
const sheet = SpreadsheetApp.getActiveSheet();
sheet.getRange('A:E').copyTo(
    sheet.getRange('F1'),
    SpreadsheetApp.CopyPasteType.PASTE_VALUES,
    false,
);

Параметры

Имя	Тип	Описание
`destination`	`Range`	Диапазон назначения для копирования; важна только позиция верхней левой ячейки.
`copy Paste Type`	`Copy Paste Type`	Тип, указывающий, как содержимое диапазона вставляется в место назначения.
`transposed`	`Boolean`	Следует ли вставлять диапазон в транспонированной ориентации.

Авторизация

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

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

`copy To(destination, options)`

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

// The code below copies only the values of the first 5 columns over to the 6th
// column.
const sheet = SpreadsheetApp.getActiveSheet();
sheet.getRange('A:E').copyTo(sheet.getRange('F1'), {contentsOnly: true});

Параметры

Имя	Тип	Описание
`destination`	`Range`	Диапазон назначения для копирования; важна только позиция верхней левой ячейки.
`options`	`Object`	Объект JavaScript, задающий дополнительные параметры, как указано ниже.

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

Имя	Тип	Описание
`format Only`	`Boolean`	означает, что следует копировать только формат
`contents Only`	`Boolean`	обозначает, что следует копировать только содержимое

Авторизация

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

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

`copy Values To Range(gridId, column, columnEnd, row, rowEnd)`

Скопируйте содержимое диапазона в указанное место. Если место назначения больше или меньше исходного диапазона, то источник соответственно повторяется или усекается.

Подробное описание параметра GridId см. в разделе get Grid Id() .

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

const range = source.getRange('B2:D4');

// This copies the data in B2:D4 in the source sheet to
// D4:F6 in the sheet with gridId 0
range.copyValuesToRange(0, 4, 6, 4, 6);

Параметры

Имя	Тип	Описание
`grid Id`	`Integer`	Уникальный идентификатор листа в электронной таблице, независимо от его положения.
`column`	`Integer`	Первый столбец целевого диапазона.
`column End`	`Integer`	Конечный столбец целевого диапазона.
`row`	`Integer`	Начальная строка целевого диапазона.
`row End`	`Integer`	Конечная строка целевого диапазона.

Авторизация

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

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

См. также

get Grid Id()

`copy Values To Range(sheet, column, columnEnd, row, rowEnd)`

const ss = SpreadsheetApp.getActiveSpreadsheet();
const source = ss.getSheets()[0];
const destination = ss.getSheets()[1];

const range = source.getRange('B2:D4');

// This copies the data in B2:D4 in the source sheet to
// D4:F6 in the second sheet
range.copyValuesToRange(destination, 4, 6, 4, 6);

Параметры

Имя	Тип	Описание
`sheet`	`Sheet`	Целевой лист.
`column`	`Integer`	Первый столбец целевого диапазона.
`column End`	`Integer`	Конечный столбец целевого диапазона.
`row`	`Integer`	Начальная строка целевого диапазона.
`row End`	`Integer`	Конечная строка целевого диапазона.

Авторизация

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

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

`create Data Source Pivot Table(dataSource)`

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

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

const spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
const anchorCell = spreadsheet.getSheets()[0].getRange('A1');
const dataSource = spreadsheet.getDataSources()[0];

const pivotTable = anchorCell.createDataSourcePivotTable(dataSource);
pivotTable.addRowGroup('dataColumnA');
pivotTable.addColumnGroup('dataColumnB');
pivotTable.addPivotValue(
    'dataColumnC',
    SpreadsheetApp.PivotTableSummarizeFunction.SUM,
);
pivotTable.addFilter(
    'dataColumnA',
    SpreadsheetApp.newFilterCriteria().whenTextStartsWith('A').build(),
);

Параметры

Имя	Тип	Описание
`data Source`	`Data Source`	Источник данных, на основе которого создается сводная таблица.

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

Data Source Pivot Table — вновь созданная сводная таблица источника данных.

Авторизация

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

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

`create Data Source Table(dataSource)`

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

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

const spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
const anchorCell = spreadsheet.getSheets()[0].getRange('A1');
const dataSource = spreadsheet.getDataSources()[0];

const dataSourceTable =
    anchorCell.createDataSourceTable(dataSource)
        .addColumns('dataColumnA', 'dataColumnB', 'dataColumnC')
        .addSortSpec('dataColumnA', true)    // ascending=true
        .addSortSpec('dataColumnB', false);  // ascending=false

Параметры

Имя	Тип	Описание
`data Source`	`Data Source`	Источник данных, на основе которого создается сводная таблица.

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

Data Source Table — вновь созданная таблица источника данных.

Авторизация

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

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

`create Developer Metadata Finder()`

Возвращает DeveloperMetadataFinderApi для поиска метаданных разработчика в пределах этого диапазона. Метаданные находятся в пределах диапазона только в том случае, если они полностью содержатся в этом диапазоне. Например, метаданные, связанные со строкой «3:3», не входят в диапазон «A1:D5», но находятся в пределах диапазона «1:5».

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

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

// Gets the range A1:C6.
const range = sheet.getRange('A1:C6');

// Creates a developer metadata finder to search for metadata in the scope of
// this range.
const developerMetaDataFinder = range.createDeveloperMetadataFinder();

// Logs information about the developer metadata finder to the console.
const developerMetaData = developerMetaDataFinder.find()[0];
console.log(developerMetaData.getKey());
console.log(developerMetaData.getValue());
console.log(developerMetaData.getVisibility().toString());

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

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

`create Filter()`

Создает фильтр и применяет его к указанному диапазону на листе. На листе нельзя создать более одного фильтра. Чтобы получить доступ к фильтру и изменить его после его создания, используйте get Filter() или Sheet.getFilter() .

const ss = SpreadsheetApp.getActiveSheet();
const range = ss.getRange('A1:C20');

// Creates a new filter and applies it to the range A1:C20 on the active sheet.
function createFilter() {
  range.createFilter();
}
// Gets the filter and applies criteria that only shows cells that aren't empty.
function getFilterAddCriteria() {
  const filter = range.getFilter();
  const criteria =
      SpreadsheetApp.newFilterCriteria().whenCellNotEmpty().build();
  filter.setColumnFilterCriteria(2, criteria);
}

Используйте этот метод для создания фильтров для листов Grid — типа листа по умолчанию. Листы сетки — это листы, которые не подключены к базе данных. Чтобы создать другие типы фильтров, обратитесь к следующему:

Создайте фильтр сводной таблицы с помощью Pivot Table.addFilter(sourceDataColumn, filterCriteria)
Создайте фильтр для листа, подключенного к базе данных, с помощью Data Source Sheet.addFilter(columnName, filterCriteria)
Создайте фильтр для сводной таблицы, подключенной к базе данных, с помощью Data Source Pivot Table.addFilter(columnName, filterCriteria)

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

Filter — Новый фильтр.

Авторизация

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

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

`create Pivot Table(sourceData)`

Создает пустую сводную таблицу из указанных source Data привязанных к первой ячейке в этом диапазоне.

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

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

// Gets cell A1 as a range in order to place the pivot table.
const range = sheet.getRange('A1');

// Gets the range of the source data for the pivot table.
const dataRange = sheet.getRange('E12:G20');

// Creates an empty pivot table from the specified source data.
const pivotTable = range.createPivotTable(dataRange);

// Logs the values from the pivot table's source data to the console.
console.log(pivotTable.getSourceDataRange().getValues());

Параметры

Имя	Тип	Описание
`source Data`	`Range`	Данные для создания сводной таблицы.

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

Pivot Table — вновь созданная Pivot Table .

Авторизация

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

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

`create Text Finder(findText)`

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

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

// Creates  a text finder for the range.
const textFinder = range.createTextFinder('dog');

// Returns the first occurrence of 'dog'.
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 Finder — Text Finder по диапазону.

`delete Cells(shiftDimension)`

Удаляет этот диапазон ячеек. Существующие данные на листе по указанному измерению смещаются в сторону удаленного диапазона.

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

const range = sheet.getRange('A1:D10');
range.deleteCells(SpreadsheetApp.Dimension.COLUMNS);

Параметры

Имя	Тип	Описание
`shift Dimension`	`Dimension`	Измерение, по которому можно сместить существующие данные.

Авторизация

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

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

`expand Groups()`

Разворачивает свернутые группы, диапазон которых или переключатель управления пересекаются с этим диапазоном. Местоположение переключателя управления — это индекс, по которому отображается переключатель управления, непосредственно до или после группы в зависимости от настроек. Если в одном месте находится более одной группы, расширяется самая мелкая группа.

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

// All row and column groups within the range are expanded.
range.expandGroups();

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

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

Авторизация

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

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

`getA1Notation()`

Возвращает строковое описание диапазона в нотации A1.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange(1, 1, 2, 5);

// Logs "A1:E2"
Logger.log(range.getA1Notation());

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

String — Строковое описание диапазона в нотации A1.

Авторизация

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

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

`get Background()`

Возвращает цвет фона верхней левой ячейки диапазона (например, '#ffffff' ).

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

const cell = sheet.getRange('B5');
Logger.log(cell.getBackground());

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

String — цветовой код фона.

Авторизация

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

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

`get Background Object()`

Возвращает цвет фона верхней левой ячейки диапазона.

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

const cell = sheet.getRange('B5');
Logger.log(cell.getBackgroundObject().asRgbColor().asHexString());

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

Color — цвет фона верхней левой ячейки диапазона.

Авторизация

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

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

`get Background Objects()`

Возвращает цвета фона ячеек в диапазоне.

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

const range = sheet.getRange('B5:C6');
const bgColors = range.getBackgroundObjects();
for (const i in bgColors) {
  for (const j in bgColors[i]) {
    Logger.log(bgColors[i][j].asRgbColor().asHexString());
  }
}

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

Color[][] — Двумерный массив цветов фона.

Авторизация

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

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

`get Backgrounds()`

Возвращает цвета фона ячеек в диапазоне (например, '#ffffff' ).

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

const range = sheet.getRange('B5:C6');
const bgColors = range.getBackgrounds();
for (const i in bgColors) {
  for (const j in bgColors[i]) {
    Logger.log(bgColors[i][j]);
  }
}

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

String[][] — Двумерный массив цветовых кодов фона.

Авторизация

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

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

`get Bandings()`

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

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

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

// Sets a range.
const range = sheet.getRange('A1:K50');

// Gets the banding info for the range.
const bandings = range.getBandings();

// Logs the second row color for each banding to the console.
for (const banding of bandings) {
  console.log(banding.getSecondRowColor());
}

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

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

Авторизация

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

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

`get Cell(row, column)`

Возвращает данную ячейку в диапазоне.

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

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

// The row and column here are relative to the range
// getCell(1,1) in this code returns the cell at B2
const cell = range.getCell(1, 1);
Logger.log(cell.getValue());

Параметры

Имя	Тип	Описание
`row`	`Integer`	Строка ячейки относительно диапазона.
`column`	`Integer`	Столбец ячейки относительно диапазона.

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

Range — диапазон, содержащий одну ячейку с указанными координатами.

Авторизация

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

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

`get Column()`

Возвращает начальную позицию столбца для этого диапазона.

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

const range = sheet.getRange('B2:D4');
// Logs "2.0"
Logger.log(range.getColumn());

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

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

Авторизация

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

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

`get Data Region()`

Возвращает копию диапазона, расширенного по четырем кардинальным Direction , чтобы охватить все соседние ячейки с данными в них. Если диапазон окружен пустыми ячейками, не считая ячеек по диагоналям, возвращается сам диапазон. Это похоже на выбор диапазона и нажатие Ctrl+A в редакторе.

// Assume the active spreadsheet is blank.
const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
sheet.getRange('C2').setValue(100);
sheet.getRange('B3').setValue(100);
sheet.getRange('D3').setValue(100);
sheet.getRange('C4').setValue(100);
// Logs "B2:D4"
Logger.log(sheet.getRange('C3').getDataRegion().getA1Notation());

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

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

Авторизация

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

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

`get Data Region(dimension)`

Возвращает копию расширенного диапазона Direction.UP и Direction.DOWN если указанное измерение — Dimension.ROWS , или Direction.NEXT и Direction.PREVIOUS если измерение — Dimension.COLUMNS . Расширение диапазона основано на обнаружении данных рядом с диапазоном, которые организованы в виде таблицы. Расширенный диапазон охватывает все соседние ячейки с данными в них по указанному измерению, включая границы таблицы. Если исходный диапазон окружен пустыми ячейками по указанному измерению, возвращается сам диапазон. Этот метод аналогичен выбору диапазона и вводу Ctrl+Space для столбцов или Shift+Space для строк в редакторе.

// Assume the active spreadsheet is blank.
const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
sheet.getRange('C2').setValue(100);
sheet.getRange('B3').setValue(100);
sheet.getRange('D3').setValue(100);
sheet.getRange('C4').setValue(100);
// Logs "C2:C4"
Logger.log(
    sheet.getRange('C3')
        .getDataRegion(SpreadsheetApp.Dimension.ROWS)
        .getA1Notation(),
);
// Logs "B3:D3"
Logger.log(
    sheet.getRange('C3')
        .getDataRegion(SpreadsheetApp.Dimension.COLUMNS)
        .getA1Notation(),
);

Параметры

Имя	Тип	Описание
`dimension`	`Dimension`	Измерение, по которому можно расширить диапазон.

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

Range — область данных диапазона или диапазон, охватывающий каждый столбец или каждую строку, охватываемую исходным диапазоном.

Авторизация

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

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

`get Data Source Formula()`

Возвращает Data Source Formula для первой ячейки диапазона или null , если ячейка не содержит формулу источника данных.

// 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 the range A1 on Sheet1.
const range = sheet.getRange('A1');

// Gets the data source formula from cell A1.
const dataSourceFormula = range.getDataSourceFormula();

// Gets the formula.
const formula = dataSourceFormula.getFormula();

// Logs the formula.
console.log(formula);

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

Data Source Formula — Data Source Formula для ячейки.

Авторизация

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

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

`get Data Source Formulas()`

Возвращает Data Source Formula для ячеек в диапазоне.

// 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 the range A1:B5 on Sheet1.
const range = sheet.getRange('A1:B5');

// Gets an array of the data source formulas in the range A1:B5.
const dataSourceFormulas = range.getDataSourceFormulas();

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

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

Data Source Formula[] — Массив 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 the range A1:G50 on Sheet1.
const range = sheet.getRange('A1:G50');

// Gets an array of the data source pivot tables in the range A1:G50.
const dataSourcePivotTables = range.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 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 the range A1:G50 on Sheet1.
const range = sheet.getRange('A1:G50');

// Gets the first data source table in the range A1:G50.
const dataSourceTable = range.getDataSourceTables()[0];

// Logs the time of the last completed data execution on the data source table.
console.log(dataSourceTable.getStatus().getLastExecutionTime());

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

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

Авторизация

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

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

`get Data Source Url()`

Возвращает URL-адрес данных в этом диапазоне, который можно использовать для создания диаграмм и запросов.

Код.gs

function doGet() {
  const ss = SpreadsheetApp.openById(
      '1khO6hBWTNNyvyyxvob7aoZTI9ZvlqqASNeq0e29Tw2c',
  );
  const sheet = ss.getSheetByName('ContinentData');
  const range = sheet.getRange('A1:B8');

  const template = HtmlService.createTemplateFromFile('piechart');
  template.dataSourceUrl = range.getDataSourceUrl();
  return template.evaluate();
}

диаграмма.html

<!DOCTYPE html>
<html>
  <head>
    <!--Load the AJAX API-->
    <script type="text/javascript" src="https://www.gstatic.com/charts/loader.js"></script>
    <script type="text/javascript">
      // Load the Visualization API and the corechart package.
      google.charts.load('current', {'packages': ['corechart']});

      // Set a callback to run when the Google Visualization API is loaded.
      google.charts.setOnLoadCallback(queryData);

      function queryData() {
        var query = new google.visualization.Query('<?= dataSourceUrl ?>');
        query.send(drawChart);
      }

      // Callback that creates and populates a data table,
      // instantiates the pie chart, passes in the data and
      // draws it.
      function drawChart(response) {
        if (response.isError()) {
          alert('Error: ' + response.getMessage() + ' ' + response.getDetailedMessage());
          return;
        }
        var data = response.getDataTable();

        // Set chart options.
        var options = {
          title: 'Population by Continent',
          width: 400,
          height: 300
        };

        // Instantiate and draw the chart, passing in some options.
        var chart = new google.visualization.PieChart(document.getElementById('chart_div'));
        chart.draw(data, options);
      }
    </script>
  </head>
  <body>
    <!-- Div that holds the pie chart. -->
    <div id="chart_div"></div>
  </body>
</html>

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

String — URL-адрес этого диапазона в качестве источника данных, который можно передавать в другие API, например в диаграммы.

Авторизация

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

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

`get Data Table()`

Верните данные внутри этого объекта в виде DataTable.

// 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 the range A1:B7 on Sheet1.
const range = sheet.getRange('A1:B7');

// Gets the range A1:B7 as a data table. The values in each column must be of
// the same type.
const datatable = range.getDataTable();

// Uses the Charts service to build a bar chart from the data table.
// This doesn't build an embedded chart. To do that, use
// sheet.newChart().addRange() instead.
const chart = Charts.newBarChart()
                  .setDataTable(datatable)
                  .setOption('title', 'Your Chart Title Here')
                  .build();

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

Data Table — данные в виде таблицы данных.

`get Data Table(firstRowIsHeader)`

Верните данные внутри этого диапазона в виде DataTable.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('A1:B7');

// Calling this method with "true" sets the first line to be the title of the
// axes
const datatable = range.getDataTable(true);

// Note that this doesn't build an EmbeddedChart, so you can't just use
// Sheet#insertChart(). To do that, use sheet.newChart().addRange() instead.
const chart = Charts.newBarChart()
                  .setDataTable(datatable)
                  .setOption('title', 'Your Title Here')
                  .build();

Параметры

Имя	Тип	Описание
`first Row Is Header`	`Boolean`	Считать ли первую строку заголовком.

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

Data Table — данные в виде таблицы данных.

Авторизация

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

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

`get Data Validation()`

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

// Log information about the data validation rule for cell A1.
const cell = SpreadsheetApp.getActive().getRange('A1');
const rule = cell.getDataValidation();
if (rule != null) {
  const criteria = rule.getCriteriaType();
  const args = rule.getCriteriaValues();
  Logger.log('The data validation rule is %s %s', criteria, args);
} else {
  Logger.log('The cell does not have a data validation rule.');
}

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

Data Validation — правило проверки данных для верхней левой ячейки диапазона.

Авторизация

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

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

`get Data Validations()`

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

// Change existing data validation rules that require a date in 2013 to require
// a date in 2014.
const oldDates = [new Date('1/1/2013'), new Date('12/31/2013')];
const newDates = [new Date('1/1/2014'), new Date('12/31/2014')];
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange(1, 1, sheet.getMaxRows(), sheet.getMaxColumns());
const rules = range.getDataValidations();

for (let i = 0; i < rules.length; i++) {
  for (let j = 0; j < rules[i].length; j++) {
    const rule = rules[i][j];

    if (rule != null) {
      const criteria = rule.getCriteriaType();
      const args = rule.getCriteriaValues();

      if (criteria === SpreadsheetApp.DataValidationCriteria.DATE_BETWEEN &&
          args[0].getTime() === oldDates[0].getTime() &&
          args[1].getTime() === oldDates[1].getTime()) {
        // Create a builder from the existing rule, then change the dates.
        rules[i][j] = rule.copy().withCriteria(criteria, newDates).build();
      }
    }
  }
}
range.setDataValidations(rules);

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

Data Validation[][] — двумерный массив правил проверки данных, связанных с ячейками в диапазоне.

Авторизация

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

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 file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

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

// Gets row 2 on Sheet1.
const range = sheet.getRange('2:2');

// Adds metadata to row 2.
range.addDeveloperMetadata('NAME', 'GOOGLE');

// Logs the metadata to console.
for (const metadata of range.getDeveloperMetadata()) {
  console.log(`${metadata.getKey()}: ${metadata.getValue()}`);
}

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

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

Авторизация

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

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

`get Display Value()`

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

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

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

// Gets cell A30 and sets its value to 'Test code.'
const cell = sheet.getRange('A30');
cell.setValue('Test code');

// Gets the value and logs it to the console.
console.log(cell.getDisplayValue());

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

String — отображаемое значение в этой ячейке.

Авторизация

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

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

`get Display Values()`

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

Возвращает двумерный массив отображаемых значений, индексированных по строкам, а затем по столбцам. Значения представляют собой объекты String . Отображаемое значение учитывает форматирование даты, времени и валюты, включая форматы, применяемые автоматически языковыми настройками электронной таблицы. Пустые ячейки представлены пустой строкой в массиве. Помните, что хотя индекс диапазона начинается с 1, 1 , массив JavaScript индексируется с [0][0] .

// The code below gets the displayed values for the range C2:G8
// in the active spreadsheet.  Note that this is a JavaScript array.
const values =
    SpreadsheetApp.getActiveSheet().getRange(2, 3, 6, 4).getDisplayValues();
Logger.log(values[0][0]);

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

String[][] — Двумерный массив значений.

Авторизация

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

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

`get Filter()`

Возвращает фильтр на листе, которому принадлежит этот диапазон, или null если на листе нет фильтра.

const ss = SpreadsheetApp.getActiveSheet();
const range = ss.getRange('A1:C20');
// Gets the existing filter on the sheet that the given range belongs to.
const filter = range.getFilter();

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

Filter — Фильтр.

Авторизация

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

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

`get Font Color Object()`

Возвращает цвет шрифта ячейки в верхнем левом углу диапазона.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('B2:D4');

Logger.log(range.getFontColorObject().asRgbColor().asHexString());

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

Color — цвет шрифта верхней левой ячейки диапазона.

Авторизация

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

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

`get Font Color Objects()`

Возвращает цвета шрифта ячеек в диапазоне.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('B2:D4');

const results = range.getFontColorObjects();

for (const i in results) {
  for (const j in results[i]) {
    Logger.log(results[i][j].asRgbColor().asHexString());
  }
}

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

Color[][] — двумерный массив цветов шрифта, связанный с ячейками в диапазоне.

Авторизация

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

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

`get Font Families()`

Возвращает семейства шрифтов ячеек в диапазоне.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('B2:D4');

const results = range.getFontFamilies();

for (const i in results) {
  for (const j in results[i]) {
    Logger.log(results[i][j]);
  }
}

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

String[][] — двумерный массив семейств шрифтов, связанных с ячейками в диапазоне.

Авторизация

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

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

`get Font Family()`

Возвращает семейство шрифтов ячейки в верхнем левом углу диапазона.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('B2:D4');

Logger.log(range.getFontFamily());

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

String — семейство шрифтов ячейки.

Авторизация

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

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

`get Font Line()`

Получает линейный стиль ячейки в верхнем левом углу диапазона ( 'underline' , 'line-through' или 'none' ).

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('B2:D4');

Logger.log(range.getFontLine());

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

String - линия шрифта.

Авторизация

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

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

`get Font Lines()`

Получает стиль линии ячеек в диапазоне ( 'underline' , 'line-through' или 'none' ).

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('B2:D4');

const results = range.getFontLines();

for (const i in results) {
  for (const j in results[i]) {
    Logger.log(results[i][j]);
  }
}

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

String[][] -двухмерный массив линий шрифтов, связанных с ячейками в диапазоне.

Авторизация

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

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

`get Font Size()`

Возвращает размер шрифта в размере точки ячейки в верхнем левом углу диапазона.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('B2:D4');

Logger.log(range.getFontSize());

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

Integer - размер шрифта в размере точки.

Авторизация

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

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

`get Font Sizes()`

Возвращает размеры шрифтов ячеек в диапазоне.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('B2:D4');

const results = range.getFontSizes();

for (const i in results) {
  for (const j in results[i]) {
    Logger.log(results[i][j]);
  }
}

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

Integer[][] -двумерный массив размеров шрифтов текста, связанных с ячейками в диапазоне.

Авторизация

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

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

`get Font Style()`

Возвращает стиль шрифта ( 'italic' или 'normal' ) ячейки в верхнем левом углу диапазона.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('B2:D4');

Logger.log(range.getFontStyle());

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

String - стиль шрифта текста в ячейке.

Авторизация

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

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

`get Font Styles()`

Возвращает стили шрифта ячеек в диапазоне.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('B2:D4');

const results = range.getFontStyles();

for (const i in results) {
  for (const j in results[i]) {
    Logger.log(results[i][j]);
  }
}

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

String[][] -двухмерный массив стилей шрифтов текста, связанных с ячейками в диапазоне.

Авторизация

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

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

`get Font Weight()`

Возвращает вес шрифта (нормальный/жирный) ячейку в верхнем левом углу диапазона.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('B2:D4');

Logger.log(range.getFontWeight());

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

String - вес шрифта текста в ячейке.

Авторизация

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

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

`get Font Weights()`

Возвращает веса шрифта клеток в диапазоне.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('B2:D4');

const results = range.getFontWeights();

for (const i in results) {
  for (const j in results[i]) {
    Logger.log(results[i][j]);
  }
}

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

String[][] -двухмерный массив веса шрифтов текста, связанных с ячеек в диапазоне.

Авторизация

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

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

`get Formula()`

Возвращает формулу (обозначения A1) для верхней левой ячейки диапазона или пустой строки, если ячейка пуста или не содержит формулы.

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

// This assumes you have a function in B5 that sums up
// B2:B4
const range = sheet.getRange('B5');

// Logs the calculated value and the formula
Logger.log(
    'Calculated value: %s Formula: %s',
    range.getValue(),
    range.getFormula(),
);

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

String - формула для ячейки.

Авторизация

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

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

`get Formula R1C1()`

Возвращает формулу (обозначения R1C1) для данной ячейки или null , если нет.

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

const range = sheet.getRange('B5');
const formula = range.getFormulaR1C1();
Logger.log(formula);

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

String - формула в нотации R1C1.

Авторизация

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

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

`get Formulas()`

Возвращает формулы (обозначения A1) для ячеек в диапазоне. Записи в 2D -массиве представляют собой пустые строки для ячеек без формулы.

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

const range = sheet.getRange('B5:C6');
const formulas = range.getFormulas();
for (const i in formulas) {
  for (const j in formulas[i]) {
    Logger.log(formulas[i][j]);
  }
}

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

String[][] -двумерный массив формул в формате строки.

Авторизация

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

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

`get Formulas R1C1()`

Возвращает формулы (обозначения R1C1) для ячеек в диапазоне. Записи в 2D -массиве являются null для ячеек без формулы.

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

const range = sheet.getRange('B5:C6');
const formulas = range.getFormulasR1C1();
for (const i in formulas) {
  for (const j in formulas[i]) {
    Logger.log(formulas[i][j]);
  }
}

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

String[][] -двухмерный массив формул в обозначениях R1C1.

Авторизация

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

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

`get Grid Id()`

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

// Log the grid ID of the first sheet (by tab position) in the spreadsheet.
const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('B2:D4');

Logger.log(range.getGridId());

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

Integer - идентификатор сетки родительского листа.

Авторизация

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

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

`get Height()`

Возвращает высоту диапазона.

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

const range = sheet.getRange('B2:D4');
// logs 3.0
Logger.log(range.getHeight());

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

Integer - высота диапазона.

Авторизация

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

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

`get Horizontal Alignment()`

Возвращает горизонтальное выравнивание текста (левое/центр/справа) ячейки в верхнем левом углу диапазона.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('B2:D4');

Logger.log(range.getHorizontalAlignment());

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

String - горизонтальное выравнивание текста в ячейке.

Авторизация

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

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

`get Horizontal Alignments()`

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('B2:D4');

const results = range.getHorizontalAlignments();

for (const i in results) {
  for (const j in results[i]) {
    Logger.log(results[i][j]);
  }
}

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

String[][] -двухмерный массив горизонтальных выравниваний текста, связанных с ячейками в диапазоне.

Авторизация

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

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

const range = sheet.getRange('B2:D4');
// Logs "4.0"
Logger.log(range.getLastColumn());

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

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

const range = sheet.getRange('B2:D4');
// Logs "4.0"
Logger.log(range.getLastRow());

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

Integer - позиция окончательного ряда диапазона в электронной таблице.

Авторизация

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

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

`get Merged Ranges()`

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

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

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

const mergedRanges = range.getMergedRanges();
for (let i = 0; i < mergedRanges.length; i++) {
  Logger.log(mergedRanges[i].getA1Notation());
  Logger.log(mergedRanges[i].getDisplayValue());
}

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

Range[] - массив объектов Range , представляющие объединенные ячейки, перекрывающие диапазон.

`get Next Data Cell(direction)`

Начиная с ячейки в первом столбце и строке диапазона, возвращает следующую ячейку в данном направлении, которое является краем смежного диапазона ячеек с данными в них или ячейки на краю электронной таблицы в этом направлении. Это эквивалентно вводу Ctrl+[arrow key] в редакторе.

// Assume the active spreadsheet is blank.
const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

const range = sheet.getRange('C3:E5');
// Logs "C1"
Logger.log(range.getNextDataCell(SpreadsheetApp.Direction.UP).getA1Notation());

Параметры

Имя	Тип	Описание
`direction`	`Direction`	Направление, в котором можно найти следующую ячейку региона данных.

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

Range - ячейка края региона данных или ячейка на краю электронной таблицы.

Авторизация

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

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

`get Note()`

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('B2:D4');

Logger.log(range.getNote());

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

String - примечание, связанное с данной ячейкой.

Авторизация

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

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

`get Notes()`

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('B2:D4');

const results = range.getNotes();

for (const i in results) {
  for (const j in results[i]) {
    Logger.log(results[i][j]);
  }
}

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

String[][] -двухмерный массив нот, связанные с ячеек в диапазоне.

Авторизация

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

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

`get Num Columns()`

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

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

const range = sheet.getRange('B2:D5');
Logger.log(range.getNumColumns());

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

Integer - количество столбцов в этом диапазоне.

Авторизация

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

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

`get Num Rows()`

Возвращает количество рядов в этом диапазоне.

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

const range = sheet.getRange('B2:D5');
Logger.log(range.getNumRows());

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

Integer - количество рядов в этом диапазоне.

Авторизация

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

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

`get Number Format()`

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

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

const cell = sheet.getRange('C4');
Logger.log(cell.getNumberFormat());

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

String -формат чисел верхней левой ячейки диапазона.

Авторизация

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

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

`get Number Formats()`

Возвращает число или форматы даты для ячеек в диапазоне. Возвращенные шаблоны формата описаны в документации API листов .

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

const range = sheet.getRange('B5:C6');
const formats = range.getNumberFormats();
for (const i in formats) {
  for (const j in formats[i]) {
    Logger.log(formats[i][j]);
  }
}

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

String[][] -двумерный массив чисел форматов.

Авторизация

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

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

`get Rich Text Value()`

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

// Gets the Rich Text value of cell D4.
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('D4:F6');
const richText = range.getRichTextValue();
console.log(richText.getText());

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

Rich Text Value - богатое значение текста верхней левой ячейки в диапазоне или null , если значение ячейки не является текстом.

Авторизация

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

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

`get Rich Text Values()`

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

// Gets the Rich Text values for all cells in range B5:C6
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('B5:C6');
const values = range.getRichTextValues();

for (let i = 0; i < values.length; i++) {
  for (let j = 0; j < values[i].length; j++) {
    console.log(values[i][j].getText());
  }
}

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

Rich Text Value[][] -двумерный массив богатых текстовых значений.

Авторизация

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

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

`get Row()`

Возвращает позицию строки для этого диапазона. Идентично получить индекс строки () .

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

const range = sheet.getRange('B2');
Logger.log(range.getRow());

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

Integer - позиция строки диапазона.

Авторизация

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

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

`get Row Index()`

Возвращает позицию строки для этого диапазона. Идентично, чтобы получить ряд () .

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

const range = sheet.getRange('B2');
Logger.log(range.getRowIndex());

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

Integer - позиция строки диапазона.

Авторизация

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

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

См. также

get Row()

`get Sheet()`

Возвращает лист, которому принадлежит этот диапазон.

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

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

// Gets the range A1:D10 on Sheet1.
const range = sheet.getRange('A1:D10');

// Gets the sheet that the range belongs to.
const rangeSheet = range.getSheet();

// Gets the sheet name and logs it to the console.
console.log(rangeSheet.getName());

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

Sheet - лист, которому принадлежит этот диапазон.

Авторизация

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

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

`get Text Direction()`

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

// Get the text direction of cell B1.
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('B1:D4');
Logger.log(range.getTextDirection());

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

Text Direction - направление текста верхней левой ячейки в диапазоне.

Авторизация

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

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

`get Text Directions()`

Возвращает текстовые направления для ячеек в диапазоне. Записи в 2D -массиве являются null для ячеек с использованием автоматического обнаружения.

// Get the text directions for all cells in range B5:C6
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('B5:C6');
const directions = range.getTextDirections();

for (let i = 0; i < directions.length; i++) {
  for (let j = 0; j < directions[i].length; j++) {
    Logger.log(directions[i][j]);
  }
}

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

Text Direction[][] -двумерный массив текстовых направлений.

Авторизация

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

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

`get Text Rotation()`

Возвращает настройки поворота текста для верхней левой ячейки диапазона.

// Log the text rotation settings for a cell.
const sheet = SpreadsheetApp.getActiveSheet();

const cell = sheet.getRange('A1');
Logger.log(cell.getTextRotation());

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

Text Rotation - настройки поворота текста.

Авторизация

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

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

`get Text Rotations()`

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

const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('B2:D4');

const results = range.getTextRotations();

for (const i in results) {
  for (const j in results[i]) {
    const rotation = results[i][j];
    Logger.log('Cell [%s, %s] has text rotation: %v', i, j, rotation);
  }
}

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

Text Rotation[][] -двумерная массива поворота текста, связанного с ячейками в диапазоне.

Авторизация

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

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

`get Text Style()`

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

// Get the text style of cell D4.
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('D4:F6');
const style = range.getTextStyle();
Logger.log(style);

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

Text Style - текстовый стиль верхней левой ячейки в диапазоне.

Авторизация

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

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

`get Text Styles()`

Возвращает стили текста для ячеек в диапазоне.

// Get the text styles for all cells in range B5:C6
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('B5:C6');
const styles = range.getTextStyles();

for (let i = 0; i < styles.length; i++) {
  for (let j = 0; j < styles[i].length; j++) {
    Logger.log(styles[i][j]);
  }
}

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

Text Style[][] -двухмерный массив стилей текста.

Авторизация

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

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

`get Value()`

Возвращает значение верхней левой ячейки в диапазоне. Значение может иметь Number типов, Boolean , Date или String в зависимости от значения ячейки. Пустые ячейки возвращают пустую строку.

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

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

// Gets the range A1:D10 on Sheet1.
const range = sheet.getRange('A1:D10');

// Gets the value of the top-left cell in the range and logs it to the console.
console.log(range.getValue());

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

Object - значение в этой ячейке.

Авторизация

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

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

`get Values()`

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

Возвращает двумерный массив значений, проиндексированный по строке, затем по столбцу. Значения могут иметь Number типов, Boolean , Date или String , в зависимости от значения ячейки. Пустые ячейки представлены пустой строкой в массиве. Помните, что в то время как индекс диапазона начинается с 1, 1 , массив JavaScript индексируется из [0][0] .

// The code below gets the values for the range C2:G8
// in the active spreadsheet.  Note that this is a JavaScript array.
const values = SpreadsheetApp.getActiveSheet().getRange(2, 3, 6, 4).getValues();
Logger.log(values[0][0]);

В веб -приложениях значение Date не является юридическим параметром. get Values() не возвращает данные в веб -приложение, если диапазон содержит ячейку со значением Date . Вместо этого преобразуйте все значения, извлеченные из листа в поддерживаемый примитив JavaScript, как Number , Boolean или String .

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

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

Авторизация

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

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

`get Vertical Alignment()`

Возвращает вертикальное выравнивание (верхняя/средняя/нижняя) ячейки в верхнем левом углу диапазона.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('B2:D4');

Logger.log(range.getVerticalAlignment());

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

String - вертикальное выравнивание текста в ячейке.

Авторизация

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

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

`get Vertical Alignments()`

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('B2:D4');

const results = range.getVerticalAlignments();

for (const i in results) {
  for (const j in results[i]) {
    Logger.log(results[i][j]);
  }
}

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

String[][] -двухмерный массив вертикальных выравниваний текста, связанных с ячейками в диапазоне.

Авторизация

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

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

`get Width()`

Возвращает ширину диапазона в столбцах.

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

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

// Gets the range A1:D10 on Sheet1.
const range = sheet.getRange('A1:D10');

// Gets the width of the range in number of columns and logs it to the console.
console.log(range.getWidth());

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

Integer - количество столбцов в диапазоне.

Авторизация

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

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

`get Wrap()`

Возвращает ли текст в клеточных обертках. Чтобы получить более детальную стратегию обертывания, используйте get Wrap Strategy() .

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('B2:D4');

Logger.log(range.getWrap());

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

Boolean - будь то текст в этой ячейке или нет.

Авторизация

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

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

`get Wrap Strategies()`

Возвращает стратегии обертки текста для ячеек в диапазоне.

// Get the text wrapping strategies for all cells in range B5:C6
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('B5:C6');
const strategies = range.getWrapStrategies();

for (let i = 0; i < strategies.length; i++) {
  for (let j = 0; j < strategies[i].length; j++) {
    Logger.log(strategies[i][j]);
  }
}

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

Wrap Strategy[][] -двумерный массив стратегий обертывания текста.

Авторизация

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

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

`get Wrap Strategy()`

Возвращает стратегию обертывания текста для верхней левой ячейки диапазона.

// Get the text wrapping strategy of cell B1.
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('B1:D4');
Logger.log(range.getWrapStrategy());

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

Wrap Strategy - стратегия обертывания текста верхней левой ячейки в диапазоне.

Авторизация

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

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

`get Wraps()`

Возвращает ли текст в ячейках. Чтобы получить более гранулирующую стратегию обертывания, используйте get Wrap Strategies() .

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('B2:D4');

const results = range.getVerticalAlignments();

for (const i in results) {
  for (const j in results[i]) {
    const isWrapped = results[i][j];
    if (isWrapped) {
      Logger.log('Cell [%s, %s] has wrapped text', i, j);
    }
  }
}

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

Boolean[][] -двумерный массив вертикальных выравниваний текста, связанных с клетками в диапазоне.

Авторизация

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

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

`insert Cells(shiftDimension)`

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

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

const range = sheet.getRange('A1:D10');
range.insertCells(SpreadsheetApp.Dimension.COLUMNS);

Параметры

Имя	Тип	Описание
`shift Dimension`	`Dimension`	Измерение, в течение которого можно сдвинуть существующие данные.

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

`insert Checkboxes()`

Вставьте флажки в каждую ячейку в диапазоне, настроенные с true для проверки и false для неконтролируемой. Устанавливает значение всех ячеек в диапазоне до false .

const range = SpreadsheetApp.getActive().getRange('A1:B10');

// Inserts checkboxes into each cell in the range A1:B10 configured with 'true'
// for checked and 'false' for unchecked. Also, sets the value of each cell in
// the range A1:B10 to 'false'.
range.insertCheckboxes();

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

`insert Checkboxes(checkedValue)`

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

const range = SpreadsheetApp.getActive().getRange('A1:B10');

// Inserts checkboxes into each cell in the range A1:B10 configured with 'yes'
// for checked and the empty string for unchecked. Also, sets the value of each
// cell in the range A1:B10 to
//  the empty string.
range.insertCheckboxes('yes');

Параметры

Имя	Тип	Описание
`checked Value`	`Object`	Проверенное значение для проверки данных флажки.

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

`insert Checkboxes(checkedValue, uncheckedValue)`

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

const range = SpreadsheetApp.getActive().getRange('A1:B10');

// Inserts checkboxes into each cell in the range A1:B10 configured with 'yes'
// for checked and 'no' for unchecked. Also, sets the value of each cell in the
// range A1:B10 to 'no'.
range.insertCheckboxes('yes', 'no');

Параметры

Имя	Тип	Описание
`checked Value`	`Object`	Проверенное значение для проверки данных флажки.
`unchecked Value`	`Object`	Непропретированное значение для проверки данных флага.

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

`is Blank()`

Возвращает true если диапазон совершенно пуст.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('B2:D4');

Logger.log(range.isBlank());

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

Boolean - true , если диапазон пуст; false в противном случае.

Авторизация

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

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

`is Checked()`

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

const range = SpreadsheetApp.getActive().getRange('A1:A3');

// Inserts checkboxes and sets each cell value to 'no' in the range A1:A3.
range.insertCheckboxes('yes', 'no');

const range1 = SpreadsheetApp.getActive().getRange('A1');
range1.setValue('yes');
// Sets the value of isRange1Checked as true as it contains the checked value.
const isRange1Checked = range1.isChecked();

const range2 = SpreadsheetApp.getActive().getRange('A2');
range2.setValue('no');
// Sets the value of isRange2Checked as false as it contains the unchecked
// value.
const isRange2Checked = range2.isChecked();

const range3 = SpreadsheetApp.getActive().getRange('A3');
range3.setValue('random');
// Sets the value of isRange3Checked as null, as it contains an invalid checkbox
// value.
const isRange3Checked = range3.isChecked();

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

Boolean - true , если все ячейки в диапазоне проверены, false , если все ячейки в диапазоне не контролированы или null , если какие -либо ячейки не контролированы или не имеют проверки данных флажона.

Авторизация

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

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

`is End Column Bounded()`

Определяет, связан ли конец диапазона с определенным столбцом. Например, для диапазонов A1:B10 или B:B , которые связаны с столбцами в конце диапазона, этот метод возвращает true ; Для диапазонов 3:7 или A1:5 , которые связаны только с определенными рядами в конце диапазона, этот метод возвращает false .

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

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

// Gets the range A1:D10 on Sheet1.
const range = sheet.getRange('A1:D10');

// Determines if the end of the range is bound to a particular column and logs
// it to the console.
console.log(range.isEndColumnBounded());

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

Boolean - true , если конец диапазона связан с определенным столбцом; false в противном случае.

Авторизация

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

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

`is End Row Bounded()`

Определяет, связан ли конец диапазона с определенной строкой. Например, для диапазонов A1:B10 или 3:7 , которые связаны с рядами в конце диапазона, этот метод возвращает true ; Для диапазонов B:B или A1:C , которые связаны только с определенными столбцами в конце диапазона, этот метод возвращает false .

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

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

// Gets the range A1:D10 on Sheet1.
const range = sheet.getRange('A1:D10');

// Determines if the end of the range is bound to a particular row and logs it
// to the console.
console.log(range.isEndRowBounded());

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

Boolean - true если конец диапазона связан с определенным рядом; false в противном случае.

Авторизация

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

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

`is Part Of Merge()`

Возвращает true , если ячейки в диапазоне тока перекрывают любые объединенные ячейки.

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

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

// True if any of the cells in A1:B3 is included in a merge.
const isPartOfMerge = range.isPartOfMerge();

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

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

`is Start Column Bounded()`

Определяет, связан ли начало диапазона с определенным столбцом. Например, для диапазонов A1:B10 или B:B , которые связаны с столбцами в начале диапазона, этот метод возвращает true ; Для диапазона 3:7 , который связан только с строкой в начале диапазона, этот метод возвращает false .

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

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

// Gets the range A1:D10 on Sheet1.
const range = sheet.getRange('A1:D10');

// Determines if the start of the range is bound to a particular column and logs
// it to the console.
console.log(range.isStartColumnBounded());

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

Boolean - true , если начало диапазона связано с определенным столбцом; false в противном случае.

Авторизация

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

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

`is Start Row Bounded()`

Определяет, связан ли начало диапазона с определенной строкой. Например, для диапазонов A1:B10 или 3:7 , которые связаны с рядами в начале диапазона, этот метод возвращает true ; Для диапазона B:B , который связан только с определенным столбцом в начале диапазона, этот метод возвращает false .

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

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

// Gets the range A1:D10 on Sheet1.
const range = sheet.getRange('A1:D10');

// Determines if the start of the range is bound to a particular row and logs it
// to the console.
console.log(range.isStartRowBounded());

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

Boolean - true , если начало диапазона связано с определенной строкой; false в противном случае.

Авторизация

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

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

`merge()`

Объединяет ячейки в диапазоне вместе в один блок.

const sheet = SpreadsheetApp.getActiveSheet();

// The code below 2-dimensionally merges the cells in A1 to B3
sheet.getRange('A1:B3').merge();

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

`merge Across()`

Объедините ячейки в диапазоне в колоннах диапазона.

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

// The code below merges cells C5:E5 into one cell
const range1 = sheet.getRange('C5:E5');
range1.mergeAcross();

// The code below creates 2 horizontal cells, F5:H5 and F6:H6
const range2 = sheet.getRange('F5:H6');
range2.mergeAcross();

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

`merge Vertically()`

Объединяет клетки в диапазоне вместе.

const sheet = SpreadsheetApp.getActiveSheet();

// The code below vertically merges the cells in A1 to A10
sheet.getRange('A1:A10').mergeVertically();

// The code below creates 3 merged columns: B1 to B10, C1 to C10, and D1 to D10
sheet.getRange('B1:D10').mergeVertically();

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

`move To(target)`

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

// The code below moves the first 5 columns over to the 6th column
const sheet = SpreadsheetApp.getActiveSheet();
sheet.getRange('A1:E').moveTo(sheet.getRange('F1'));

Параметры

Имя	Тип	Описание
`target`	`Range`	Целевой диапазон для копирования этого диапазона; Только позиция верхней левой ячейки актуальна.

Авторизация

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

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

`offset(rowOffset, columnOffset)`

Возвращает новый диапазон, который смещен из этого диапазона на заданное количество строк и столбцов (что может быть отрицательным). Новый диапазон имеет тот же размер, что и исходный диапазон.

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

const cell = sheet.getRange('A1');

// newCell references B2
const newCell = cell.offset(1, 1);

Параметры

Имя	Тип	Описание
`row Offset`	`Integer`	Количество рядов вниз от верхней левой ячейки диапазона; Отрицательные значения представляют ряды из верхней левой ячейки диапазона.
`column Offset`	`Integer`	Количество столбцов прямо из верхней левой ячейки диапазона; Отрицательные значения представляют столбцы, оставшиеся от верхней левой ячейки диапазона.

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

Range - этот диапазон, для цепочки.

`offset(rowOffset, columnOffset, numRows)`

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

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

const cell = sheet.getRange('A1');

// newCell references B2:B3
const newRange = cell.offset(1, 1, 2);

Параметры

Имя	Тип	Описание
`row Offset`	`Integer`	Количество рядов вниз от верхней левой ячейки диапазона; Отрицательные значения представляют ряды из верхней левой ячейки диапазона.
`column Offset`	`Integer`	Количество столбцов прямо из верхней левой ячейки диапазона; Отрицательные значения представляют столбцы, оставшиеся от верхней левой ячейки диапазона.
`num Rows`	`Integer`	Высота в рядах нового диапазона.

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

Range - этот диапазон, для цепочки.

`offset(rowOffset, columnOffset, numRows, numColumns)`

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

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

const cell = sheet.getRange('A1');

// newCell references B2:C3
const newRange = cell.offset(1, 1, 2, 2);

Параметры

Имя	Тип	Описание
`row Offset`	`Integer`	Количество рядов вниз от верхней левой ячейки диапазона; Отрицательные значения представляют ряды из верхней левой ячейки диапазона.
`column Offset`	`Integer`	Количество столбцов прямо из верхней левой ячейки диапазона; Отрицательные значения представляют столбцы, оставшиеся от верхней левой ячейки диапазона.
`num Rows`	`Integer`	Высота в рядах нового диапазона.
`num Columns`	`Integer`	Ширина в столбцах нового диапазона.

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

Range - этот диапазон, для цепочки.

`protect()`

Создает объект, который может защитить диапазон от редактирования, за исключением пользователей, которые имеют разрешение. До тех пор, пока сценарий фактически не изменит список редакторов для диапазона (по вызову Protection.removeEditor(emailAddress) , Protection.removeEditor(user) , Protection.removeEditors(emailAddresses) , Protection.addEditor(emailAddress) , Protection.addEditor(user) , Protection.addEditors(emailAddresses) или установление нового значения для Protection.setDomainEdit(editable) ), разрешения отражают разрешения самой электронной таблицы, что эффективно означает, что диапазон остается незащищенным. Если диапазон уже защищен, этот метод создает новый защищенный диапазон, который перекрывает существующий. Если ячейка защищена несколькими защищенными диапазонами, и любой из них не позволяет конкретному пользователю редактировать ячейку, то этому пользователю не разрешается редактировать ячейку.

// Protect range A1:B10, then remove all other users from the list of editors.
const ss = SpreadsheetApp.getActive();
const range = ss.getRange('A1:B10');
const protection = range.protect().setDescription('Sample protected range');

// Ensure the current user is an editor before removing others. Otherwise, if
// the user's edit permission comes from a group, the script throws an exception
// upon removing the group.
const me = Session.getEffectiveUser();
protection.addEditor(me);
protection.removeEditors(protection.getEditors());
if (protection.canDomainEdit()) {
  protection.setDomainEdit(false);
}

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

Protection - объект, представляющий настройки защиты.

Авторизация

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

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

`randomize()`

Рандомизирует порядок рядов в данном диапазоне.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('A1:C7');

// Randomizes the range
range.randomize();

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

`remove Checkboxes()`

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

const range = SpreadsheetApp.getActive().getRange('A1:B10');

// Inserts checkboxes and sets each cell value to 'no' in the range A1:B10.
range.insertCheckboxes('yes', 'no');

const range1 = SpreadsheetApp.getActive().getRange('A1');
range1.setValue('yes');
// Removes the checkbox data validation in cell A1 and clears its value.
range1.removeCheckboxes();

const range2 = SpreadsheetApp.getActive().getRange('A2');
range2.setValue('random');
// Removes the checkbox data validation in cell A2 but does not clear its value.
range2.removeCheckboxes();

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

`remove Duplicates()`

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('B1:D7');

// Remove duplicate rows in the range.
range.removeDuplicates();

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

Range - полученный диапазон после удаления дубликатов. Размер диапазона уменьшается на ряд для каждой удаленной строки.

Авторизация

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

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

`remove Duplicates(columnsToCompare)`

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('B1:D7');

// Remove rows which have duplicate values in column B.
range.removeDuplicates([2]);

// Remove rows which have duplicate values in both columns B and D.
range.removeDuplicates([2, 4]);

Параметры

Имя	Тип	Описание
`columns To Compare`	`Integer[]`	Столбцы для анализа для дублирования значений. Если столбцы не предоставляются, то все столбцы анализируются на дубликаты.

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

Авторизация

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

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

`set Background(color)`

Устанавливает цвет фона всех ячеек в диапазоне в нотации CSS (например, '#ffffff' или 'white' ).

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

const range = sheet.getRange('B2:D5');
range.setBackground('red');

Параметры

Имя	Тип	Описание
`color`	`String`	Цветовой код в нотации CSS (например `'#ffffff'` или `'white'` ); `null` значение сбрасывает цвет.

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

`set Background Object(color)`

Устанавливает цвет фона всех ячеек в диапазоне.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const bgColor = SpreadsheetApp.newColor()
                    .setThemeColor(SpreadsheetApp.ThemeColorType.BACKGROUND)
                    .build();

const range = sheet.getRange('B2:D5');
range.setBackgroundObject(bgColor);

Параметры

Имя	Тип	Описание
`color`	`Color`	Цвет фона для установки; `null` значение сбрасывает цвет фона.

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

`set Background Objects(color)`

Устанавливает прямоугольную сетку цветов фона (необходимо соответствовать размерам этого диапазона).

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

const colorAccent1 = SpreadsheetApp.newColor()
                         .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT1)
                         .build();
const colorAccent2 = SpreadsheetApp.newColor()
                         .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT2)
                         .build();
const colorAccent3 = SpreadsheetApp.newColor()
                         .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT3)
                         .build();
const colorAccent4 = SpreadsheetApp.newColor()
                         .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT4)
                         .build();

const colors = [
  [colorAccent1, colorAccent2],
  [colorAccent3, colorAccent4],
];

const cell = sheet.getRange('B5:C6');
cell.setBackgroundObjects(colors);

Параметры

Имя	Тип	Описание
`color`	`Color[][]`	Двумерный массив цветов; `null` значения сбросить цвет.

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

`set Background RGB(red, green, blue)`

Устанавливает фон на заданный цвет с использованием значений RGB (целые числа от 0 до 255 включительно).

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

const cell = sheet.getRange('B2');

// Sets the background to white
cell.setBackgroundRGB(255, 255, 255);

// Sets the background to red
cell.setBackgroundRGB(255, 0, 0);

Параметры

Имя	Тип	Описание
`red`	`Integer`	Красное значение в обозначениях RGB.
`green`	`Integer`	Зеленое значение в обозначениях RGB.
`blue`	`Integer`	Синее значение в обозначениях RGB.

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

`set Backgrounds(color)`

Устанавливает прямоугольную сетку цветов фона (необходимо соответствовать размерам этого диапазона). Цвета в нотации CSS (такие как '#ffffff' или 'white' ).

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

const colors = [
  ['red', 'white', 'blue'],
  ['#FF0000', '#FFFFFF', '#0000FF'],  // These are the hex equivalents
];

const cell = sheet.getRange('B5:D6');
cell.setBackgrounds(colors);

Параметры

Имя	Тип	Описание
`color`	`String[][]`	Двумерный массив цветов в нотации CSS (например `'#ffffff'` или `'white'` ); `null` значения сбросить цвет.

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

`set Border(top, left, bottom, right, vertical, horizontal)`

Устанавливает собственность границы. Допустимые значения являются true (ON), false (OFF) и null (без изменений).

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

const cell = sheet.getRange('B2');
// Sets borders on the top and bottom, but leaves the left and right unchanged
cell.setBorder(true, null, true, null, false, false);

Параметры

Имя	Тип	Описание
`top`	`Boolean`	`true` для границы, `false` ни для одного, `null` без изменений.
`left`	`Boolean`	`true` для границы, `false` ни для одного, `null` без изменений.
`bottom`	`Boolean`	`true` для границы, `false` ни для одного, `null` без изменений.
`right`	`Boolean`	`true` для границы, `false` ни для одного, `null` без изменений.
`vertical`	`Boolean`	`true` для внутренних вертикальных границ, `false` для ни одного, `null` без изменений.
`horizontal`	`Boolean`	`true` для внутренних горизонтальных границ, `false` ни для одного, `null` без изменений.

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

`set Border(top, left, bottom, right, vertical, horizontal, color, style)`

Устанавливает свойство границы с цветом и/или стилем. Допустимые значения являются true (ON), false (OFF) и null (без изменений). Для цвета используйте цвет в нотации CSS (например, '#ffffff' или 'white' ).

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

const cell = sheet.getRange('B2');
// Sets borders on the top and bottom, but leaves the left and right unchanged
// Also sets the color to "red", and the border to "DASHED".
cell.setBorder(
    true,
    null,
    true,
    null,
    false,
    false,
    'red',
    SpreadsheetApp.BorderStyle.DASHED,
);

Параметры

Имя	Тип	Описание
`top`	`Boolean`	`true` для границы, `false` ни для одного, `null` без изменений.
`left`	`Boolean`	`true` для границы, `false` ни для одного, `null` без изменений.
`bottom`	`Boolean`	`true` для границы, `false` ни для одного, `null` без изменений.
`right`	`Boolean`	`true` для границы, `false` ни для одного, `null` без изменений.
`vertical`	`Boolean`	`true` для внутренних вертикальных границ, `false` для ни одного, `null` без изменений.
`horizontal`	`Boolean`	`true` для внутренних горизонтальных границ, `false` ни для одного, `null` без изменений.
`color`	`String`	Цвет в нотации CSS (например, `'#ffffff'` или `'white'` ), `null` для цвета по умолчанию (черный).
`style`	`Border Style`	Стиль для границ, `null` для стиля по умолчанию (твердый).

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

`set Data Validation(rule)`

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

// Set the data validation rule for cell A1 to require a value from B1:B10.
const cell = SpreadsheetApp.getActive().getRange('A1');
const range = SpreadsheetApp.getActive().getRange('B1:B10');
const rule =
    SpreadsheetApp.newDataValidation().requireValueInRange(range).build();
cell.setDataValidation(rule);

Параметры

Имя	Тип	Описание
`rule`	`Data Validation`	Правило проверки данных для установки или `null` для удаления проверки данных.

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

`set Data Validations(rules)`

Устанавливает правила проверки данных для всех ячеек в диапазоне. Этот метод принимает двухмерный массив проверки данных, индексируемый по строке, затем по столбцу. Размеры массива должны соответствовать размерам диапазона.

// Set the data validation rules for Sheet1!A1:B5 to require a value from
// Sheet2!A1:A10.
const destinationRange =
    SpreadsheetApp.getActive().getSheetByName('Sheet1').getRange('A1:B5');
const sourceRange =
    SpreadsheetApp.getActive().getSheetByName('Sheet2').getRange('A1:A10');
const rule =
    SpreadsheetApp.newDataValidation().requireValueInRange(sourceRange).build();
const rules = destinationRange.getDataValidations();
for (let i = 0; i < rules.length; i++) {
  for (let j = 0; j < rules[i].length; j++) {
    rules[i][j] = rule;
  }
}
destinationRange.setDataValidations(rules);

Параметры

Имя	Тип	Описание
`rules`	`Data Validation[][]`	Двумерный массив правил проверки данных для установки; `null` значения Удалите проверку данных.

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

`set Font Color(color)`

Устанавливает цвет шрифта в нотации CSS (например '#ffffff' или 'white' ).

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

const cell = sheet.getRange('B2');
cell.setFontColor('red');

Параметры

Имя	Тип	Описание
`color`	`String`	Цвет шрифта в нотации CSS (например `'#ffffff'` или `'white'` ); `null` значение сбрасывает цвет.

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

`set Font Color Object(color)`

Устанавливает цвет шрифта данного диапазона.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const color = SpreadsheetApp.newColor()
                  .setThemeColor(SpreadsheetApp.ThemeColorType.TEXT)
                  .build();

const cell = sheet.getRange('B2');
cell.setFontColor(color);

Параметры

Имя	Тип	Описание
`color`	`Color`	Цвет шрифта для установки; `null` значение сбрасывает цвет.

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

`set Font Color Objects(colors)`

Устанавливает прямоугольную сетку цветов шрифта (должен соответствовать размерам этого диапазона).

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

const colorAccent1 = SpreadsheetApp.newColor()
                         .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT1)
                         .build();
const colorAccent2 = SpreadsheetApp.newColor()
                         .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT2)
                         .build();
const colorAccent3 = SpreadsheetApp.newColor()
                         .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT3)
                         .build();
const colorAccent4 = SpreadsheetApp.newColor()
                         .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT4)
                         .build();

const colors = [
  [colorAccent1, colorAccent2],
  [colorAccent3, colorAccent4],
];

const cell = sheet.getRange('B5:C6');
cell.setFontColorObjects(colors);

Параметры

Имя	Тип	Описание
`colors`	`Color[][]`	Двумерный массив цветов; `null` значения сбросить цвет шрифта.

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

`set Font Colors(colors)`

Устанавливает прямоугольную сетку цветов шрифта (должен соответствовать размерам этого диапазона). Цвета в нотации CSS (такие как '#ffffff' или 'white' ).

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

const colors = [
  ['red', 'white', 'blue'],
  ['#FF0000', '#FFFFFF', '#0000FF'],  // These are the hex equivalents
];

const cell = sheet.getRange('B5:D6');
cell.setFontColors(colors);

Параметры

Имя	Тип	Описание
`colors`	`Object[][]`	Двумерный массив цветов в нотации CSS (например `'#ffffff'` или `'white'` ); `null` значения сбросить цвет.

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

`set Font Families(fontFamilies)`

Устанавливает прямоугольную сетку семейств шрифтов (должен соответствовать размерам этого диапазона). Примерами семейств шрифтов являются «ариальные» или «helvetica».

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

const fonts = [
  ['Arial', 'Helvetica', 'Verdana'],
  ['Courier New', 'Arial', 'Helvetica'],
];

const cell = sheet.getRange('B2:D3');
cell.setFontFamilies(fonts);

Параметры

Имя	Тип	Описание
`font Families`	`Object[][]`	Двумерный набор семей шрифтов; `null` ценности сброшены семейство шрифтов.

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

`set Font Family(fontFamily)`

Устанавливает семью шрифтов, такую как «ариальная» или «helvetica».

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

const cell = sheet.getRange('B2');
cell.setFontFamily('Helvetica');

Параметры

Имя	Тип	Описание
`font Family`	`String`	Семья шрифтов, чтобы установить; `null` стоимость сбрасывает семью шрифтов.

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

`set Font Line(fontLine)`

Устанавливает стиль линии шрифта данного диапазона ( 'underline' , 'line-through' или 'none' ).

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

const cell = sheet.getRange('B2');
cell.setFontLine('line-through');

Параметры

Имя	Тип	Описание
`font Line`	`String`	Стиль линии шрифта, либо `'underline'` , `'line-through'` или `'none'` ; `null` значение сбрасывает стиль линии шрифта.

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

`set Font Lines(fontLines)`

Устанавливает прямоугольную сетку стилей линий (должен соответствовать размерам этого диапазона).

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

// The size of the two-dimensional array must match the size of the range.
const fontLines = [['underline', 'line-through', 'none']];

const range = sheet.getRange('B2:D2');
range.setFontLines(fontLines);

Параметры

Имя	Тип	Описание
`font Lines`	`Object[][]`	Двумерный массив стилей линейки шрифтов ( `'underline'` , `'line-through'` или `'none'` ); `null` значения сбрасывают стиль линии шрифта.

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

`set Font Size(size)`

Устанавливает размер шрифта, причем размер - размер точки для использования.

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

const cell = sheet.getRange('B2');
cell.setFontSize(20);

Параметры

Имя	Тип	Описание
`size`	`Integer`	Размер шрифта в размере точки.

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

`set Font Sizes(sizes)`

Устанавливает прямоугольную сетку размеров шрифтов (должен соответствовать размерам этого диапазона). Размеры в точках.

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

// The size of the two-dimensional array must match the size of the range.
const fontSizes = [[16, 20, 24]];

const range = sheet.getRange('B2:D2');
range.setFontSizes(fontSizes);

Параметры

Имя	Тип	Описание
`sizes`	`Object[][]`	Двумерный массив размеров.

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

`set Font Style(fontStyle)`

Установите стиль шрифта для данного диапазона ( 'italic' или 'normal' ).

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

const cell = sheet.getRange('B2');
cell.setFontStyle('italic');

Параметры

Имя	Тип	Описание
`font Style`	`String`	Стиль шрифта, либо `'italic'` , либо `'normal'` ; `null` значение сбрасывает стиль шрифта.

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

`set Font Styles(fontStyles)`

Устанавливает прямоугольную сетку стилей шрифтов (должен соответствовать размерам этого диапазона).

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

// The size of the two-dimensional array must match the size of the range.
const fontStyles = [['italic', 'normal']];

const range = sheet.getRange('B2:C2');
range.setFontStyles(fontStyles);

Параметры

Имя	Тип	Описание
`font Styles`	`Object[][]`	Двумерный массив стилей шрифтов, либо `'italic'` либо `'normal'` ; `null` значения сбросить стиль шрифта.

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

`set Font Weight(fontWeight)`

Установите вес шрифта для данного диапазона (нормальный/жирный).

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

const cell = sheet.getRange('B2');
cell.setFontWeight('bold');

Параметры

Имя	Тип	Описание
`font Weight`	`String`	Вес шрифта, либо `'bold'` или `'normal'` ; `null` значение сбрасывает вес шрифта.

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

`set Font Weights(fontWeights)`

Устанавливает прямоугольную сетку веса шрифтов (должен соответствовать размерам этого диапазона). Примером веса шрифта является «смелым».

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

// The size of the two-dimensional array must match the size of the range.
const fontStyles = [['bold', 'bold', 'normal']];

const range = sheet.getRange('B2:D2');
range.setFontWeights(fontStyles);

Параметры

Имя	Тип	Описание
`font Weights`	`Object[][]`	Двумерный массив весов шрифтов, либо `'bold'` или `'normal'` ; `null` значения сброшены веса шрифта.

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

`set Formula(formula)`

Обновляет формулу для этого диапазона. Данная формула должна быть в нотации A1.

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

const cell = sheet.getRange('B5');
cell.setFormula('=SUM(B3:B4)');

Параметры

Имя	Тип	Описание
`formula`	`String`	Строка, представляющая формулу для установки для ячейки.

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

`set Formula R1C1(formula)`

Обновляет формулу для этого диапазона. Данная формула должна быть в обозначениях R1C1.

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

const cell = sheet.getRange('B5');
// This sets the formula to be the sum of the 3 rows above B5
cell.setFormulaR1C1('=SUM(R[-3]C[0]:R[-1]C[0])');

Параметры

Имя	Тип	Описание
`formula`	`String`	Строка формула.

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

`set Formulas(formulas)`

Устанавливает прямоугольную сетку формул (должен соответствовать размерам этого диапазона). Данные формулы должны быть в нотации A1. Этот метод принимает двухмерный массив формул, проиндексированный по строке, затем по столбцу. Размеры массива должны соответствовать размерам диапазона.

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

// This sets the formulas to be a row of sums, followed by a row of averages
// right below. The size of the two-dimensional array must match the size of the
// range.
const formulas = [
  ['=SUM(B2:B4)', '=SUM(C2:C4)', '=SUM(D2:D4)'],
  ['=AVERAGE(B2:B4)', '=AVERAGE(C2:C4)', '=AVERAGE(D2:D4)'],
];

const cell = sheet.getRange('B5:D6');
cell.setFormulas(formulas);

Параметры

Имя	Тип	Описание
`formulas`	`String[][]`	Двумерная строковая массива формул.

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

`set Formulas R1C1(formulas)`

Устанавливает прямоугольную сетку формул (должен соответствовать размерам этого диапазона). Данные формулы должны быть в обозначениях R1C1.

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

// This creates formulas for a row of sums, followed by a row of averages.
const sumOfRowsAbove = '=SUM(R[-3]C[0]:R[-1]C[0])';
const averageOfRowsAbove = '=AVERAGE(R[-4]C[0]:R[-2]C[0])';

// The size of the two-dimensional array must match the size of the range.
const formulas = [
  [sumOfRowsAbove, sumOfRowsAbove, sumOfRowsAbove],
  [averageOfRowsAbove, averageOfRowsAbove, averageOfRowsAbove],
];

const cell = sheet.getRange('B5:D6');
// This sets the formula to be the sum of the 3 rows above B5.
cell.setFormulasR1C1(formulas);

Параметры

Имя	Тип	Описание
`formulas`	`String[][]`	Двумерный массив формул в формате R1C1.

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

`set Horizontal Alignment(alignment)`

Установите горизонтальное (слева направо) выравнивание для данного диапазона (слева/центр/справа).

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

const cell = sheet.getRange('B2');
cell.setHorizontalAlignment('center');

Параметры

Имя	Тип	Описание
`alignment`	`String`	Выравнивание, либо `'left'` , `'center'` или `'normal'` ; `null` значение сбрасывает выравнивание.

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

`set Horizontal Alignments(alignments)`

Устанавливает прямоугольную сетку горизонтальных выравниваний. См. set Horizontal Alignment(alignment)

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

// The size of the two-dimensional array must match the size of the range.
const horizontalAlignments = [['left', 'right', 'center']];

const range = sheet.getRange('B2:D2');
range.setHorizontalAlignments(horizontalAlignments);

Параметры

Имя	Тип	Описание
`alignments`	`Object[][]`	Двумерный массив выравниваний, либо `'left'` , `'center'` или `'normal'` ; `null` значение сбрасывает выравнивание.

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

См. также

set Horizontal Alignment(alignment)

`set Note(note)`

Устанавливает примечание к данному значению.

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

const cell = sheet.getRange('B2');
cell.setNote('This is a note');

Параметры

Имя	Тип	Описание
`note`	`String`	Значение примечания для установки для диапазона; `null` значение удаляет ноту.

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

`set Notes(notes)`

Устанавливает прямоугольную сетку нот (должен соответствовать размерам этого диапазона).

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

// The size of the two-dimensional array must match the size of the range.
const notes = [
  ['it goes', 'like this', 'the fourth, the fifth'],
  ['the minor fall', 'and the', 'major lift'],
];

const cell = sheet.getRange('B2:D3');
cell.setNotes(notes);

Параметры

Имя	Тип	Описание
`notes`	`Object[][]`	Двумерный набор заметок; `null` значения Удалите примечание.

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

См. также

set Note(note)

`set Number Format(numberFormat)`

Устанавливает номер или формат даты данной строке форматирования. Принятые шаблоны формата описаны в документации API листов .

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

const cell = sheet.getRange('B2');
// Always show 3 decimal points
cell.setNumberFormat('0.000');

Параметры

Имя	Тип	Описание
`number Format`	`String`	Строка числа формата.

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

`set Number Formats(numberFormats)`

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

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

// The size of the two-dimensional array must match the size of the range.
const formats = [['0.000', '0,000,000', '$0.00']];

const range = sheet.getRange('B2:D2');
range.setNumberFormats(formats);

Параметры

Имя	Тип	Описание
`number Formats`	`Object[][]`	Двумерный массив численных форматов.

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

`set Rich Text Value(value)`

Устанавливает богатое значение текста для ячеек в диапазоне.

// Sets all cells in range B2:D4 to have the text "Hello world", with "Hello"
// bolded.
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('B2:D4');
const bold = SpreadsheetApp.newTextStyle().setBold(true).build();
const richText = SpreadsheetApp.newRichTextValue()
                     .setText('Hello world')
                     .setTextStyle(0, 5, bold)
                     .build();
range.setRichTextValue(richText);

Параметры

Имя	Тип	Описание
`value`	`Rich Text Value`	Желаемое богатое значение текста.

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

`set Rich Text Values(values)`

Устанавливает прямоугольную сетку богатых значений текста.

// Sets the cells in range A1:A2 to have Rich Text values.
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:A2');
const bold = SpreadsheetApp.newTextStyle().setBold(true).build();
const italic = SpreadsheetApp.newTextStyle().setItalic(true).build();
const richTextA1 = SpreadsheetApp.newRichTextValue()
                       .setText('This cell is bold')
                       .setTextStyle(bold)
                       .build();
const richTextA2 = SpreadsheetApp.newRichTextValue()
                       .setText('bold words, italic words')
                       .setTextStyle(0, 11, bold)
                       .setTextStyle(12, 24, italic)
                       .build();
range.setRichTextValues([[richTextA1], [richTextA2]]);

Параметры

Имя	Тип	Описание
`values`	`Rich Text Value[][]`	Желаемые богатые текстовые значения.

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

`set Show Hyperlink(showHyperlink)`

Устанавливает, должен ли диапазон показывать гиперссылки.

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

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

// Gets cell A30 and sets its hyperlink value.
const range = sheet.getRange('A30');
range.setValue('https://www.example.com');

// Sets cell A30 to show hyperlinks.
range.setShowHyperlink(true);

Параметры

Имя	Тип	Описание
`show Hyperlink`	`Boolean`	Чтобы показать гиперссылку или нет.

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

`set Text Direction(direction)`

Устанавливает направление текста для ячеек в диапазоне. Если указанное направление является null , направление выводится, а затем устанавливается.

// Sets right-to-left text direction for the range.
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('B5:C6');
range.setTextDirection(SpreadsheetApp.TextDirection.RIGHT_TO_LEFT);

Параметры

Имя	Тип	Описание
`direction`	`Text Direction`	Желаемое направление текста; Если `null` направление выводится перед настройкой.

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

`set Text Directions(directions)`

Устанавливает прямоугольную сетку текстовых направлений. Если указанное направление является null , направление выводится, а затем устанавливается.

// Copies all of the text directions from range A1:B2 over to range C5:D6.
const sheet = SpreadsheetApp.getActiveSheet();
const range1 = sheet.getRange('A1:B2');
const range2 = sheet.getRange('C5:D6');

range2.setTextRotations(range1.getTextDirections());

Параметры

Имя	Тип	Описание
`directions`	`Text Direction[][]`	Желаемые текстовые направления; Если указанное направление является `null` оно выводится перед настройкой.

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

`set Text Rotation(degrees)`

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

Для направления слева направо положительные углы находятся в направлении против часовой стрелки, тогда как для справа налево они находятся в направлении по часовой стрелке.

// Sets all cell's in range B2:D4 to have text rotated up 45 degrees.
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('B2:D4');

range.setTextRotation(45);

Параметры

Имя	Тип	Описание
`degrees`	`Integer`	Желаемый угол между стандартной ориентацией и желаемой ориентацией. Для слева направо положительные углы находятся в направлении против часовой стрелки.

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

`set Text Rotation(rotation)`

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

// Sets all cell's in range B2:D4 to have the same text rotation settings as
// cell A1.
const sheet = SpreadsheetApp.getActiveSheet();

const rotation = sheet.getRange('A1').getTextRotation();

sheet.getRange('B2:D4').setTextRotation(rotation);

Параметры

Имя	Тип	Описание
`rotation`	`Text Rotation`	Желаемые настройки поворота текста.

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

`set Text Rotations(rotations)`

Устанавливает прямоугольную сетку текстовых вращений.

// Copies all of the text rotations from range A1:B2 over to range C5:D6.
const sheet = SpreadsheetApp.getActiveSheet();
const range1 = sheet.getRange('A1:B2');
const range2 = sheet.getRange('C5:D6');

range2.setTextRotations(range1.getTextRotations());

Параметры

Имя	Тип	Описание
`rotations`	`Text Rotation[][]`	Желаемые настройки поворота текста.

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

`set Text Style(style)`

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

// Sets the cells in range C5:D6 to have underlined size 15 font.
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('C5:D6');
const style =
    SpreadsheetApp.newTextStyle().setFontSize(15).setUnderline(true).build();
range.setTextStyle(style);

Параметры

Имя	Тип	Описание
`style`	`Text Style`	Желаемый стиль текста.

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

`set Text Styles(styles)`

Устанавливает прямоугольную сетку стилей текста.

// Sets text styles for cells in range A1:B2
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:B2');
const bold = SpreadsheetApp.newTextStyle().setBold(true).build();
const otherStyle = SpreadsheetApp.newTextStyle()
                       .setBold(true)
                       .setUnderline(true)
                       .setItalic(true)
                       .setForegroundColor('#335522')
                       .setFontSize(44)
                       .build();
range.setTextStyles([
  [bold, otherStyle],
  [otherStyle, bold],
]);

Параметры

Имя	Тип	Описание
`styles`	`Text Style[][]`	Желаемый текст стили.

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

`set Value(value)`

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

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

const cell = sheet.getRange('B2');
cell.setValue(100);

Параметры

Имя	Тип	Описание
`value`	`Object`	Значение для диапазона.

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

`set Values(values)`

Устанавливает прямоугольную сетку значений (должен соответствовать размерам этого диапазона). Если значение начинается с = , оно интерпретируется как формула.

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

// The size of the two-dimensional array must match the size of the range.
const values = [['2.000', '1,000,000', '$2.99']];

const range = sheet.getRange('B2:D2');
range.setValues(values);

Параметры

Имя	Тип	Описание
`values`	`Object[][]`	Двумерный массив значений.

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

`set Vertical Alignment(alignment)`

Установите вертикальное (сверху вниз) выравнивание для данного диапазона (верхний/средний/внизу).

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

const cell = sheet.getRange('B2');
cell.setVerticalAlignment('middle');

Параметры

Имя	Тип	Описание
`alignment`	`String`	Выравнивание, либо `'top'` , `'middle'` или `'bottom'` ; `null` значение сбрасывает выравнивание.

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

`set Vertical Alignments(alignments)`

Устанавливает прямоугольную сетку вертикальных выравниваний (должен соответствовать размерам этого диапазона).

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

// The size of the two-dimensional array must match the size of the range.
const alignments = [['top', 'middle', 'bottom']];

const range = sheet.getRange('B2:D2');
range.setVerticalAlignments(alignments);

Параметры

Имя	Тип	Описание
`alignments`	`Object[][]`	Двумерный массив выравниваний, либо `'top'` , `'middle'` или `'bottom'` ; `null` значение сбрасывает выравнивание.

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

См. также

set Vertical Alignment(alignment)

`set Vertical Text(isVertical)`

Устанавливает, складывает ли текст для ячеек в диапазоне. Если текст сложен вертикально, настройка вращения текста степени игнорируется.

// Sets all cell's in range B2:D4 to have vertically stacked text.
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('B2:D4');

range.setVerticalText(true);

Параметры

Имя	Тип	Описание
`is Vertical`	`Boolean`	Сделать ли текст.

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

`set Wrap(isWrapEnabled)`

Установите клеточную упаковку данного диапазона.

Ячейки с обертыванием включены (по умолчанию) изменять размер для отображения своего полного содержимого. Ячейки с отключенными отключенными отображаются как можно больше в ячейке, не изменяя размер и не работая до нескольких линий.

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

const cell = sheet.getRange('B2');
cell.setWrap(true);

Параметры

Имя	Тип	Описание
`is Wrap Enabled`	`Boolean`	Овернуть текст или нет.

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

`set Wrap Strategies(strategies)`

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

// Copies all of the wrap strategies from range A1:B2 over to range C5:D6.
const sheet = SpreadsheetApp.getActiveSheet();
const range1 = sheet.getRange('A1:B2');
const range2 = sheet.getRange('C5:D6');

range2.setWrapStrategies(range1.getWrapStrategies());

Параметры

Имя	Тип	Описание
`strategies`	`Wrap Strategy[][]`	Желаемые стратегии упаковки.

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

`set Wrap Strategy(strategy)`

Устанавливает стратегию обертывания текста для ячеек в диапазоне.

// Sets all cells in range B2:D4 to use the clip wrap strategy.
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('B2:D4');

range.setWrapStrategy(SpreadsheetApp.WrapStrategy.CLIP);

Параметры

Имя	Тип	Описание
`strategy`	`Wrap Strategy`	Желаемая стратегия упаковки.

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

`set Wraps(isWrapEnabled)`

Устанавливает прямоугольную сетку политик обертывания слов (должен соответствовать размерам этого диапазона). Ячейки с обертыванием включены (по умолчанию) изменять размер для отображения своего полного содержимого. Ячейки с отключенными отключенными отображаются как можно больше в ячейке, не изменяя размер и не работая до нескольких линий.

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

// The size of the two-dimensional array must match the size of the range.
const wraps = [[true, true, false]];

const range = sheet.getRange('B2:D2');
range.setWraps(wraps);

Параметры

Имя	Тип	Описание
`is Wrap Enabled`	`Object[][]`	Двумерный массив переменных упаковки, которые определяют, обернуть ли текст в ячейку или нет.

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

См. также

set Wrap(isWrapEnabled)

`shift Column Group Depth(delta)`

Изменяет глубину группировки столбца диапазона на указанное количество.

Это имеет эффект создания, модификации или удаления групп, которые пересекаются с диапазоном. Для положительных дельт группы создаются и/или изменены; Для негативных дельт группы разрушаются и/или изменены.

Это не влияет при уменьшении глубины группы ниже нуля или выше восьми.

Если column group control position BEFORE , это бросает ошибку при попытке сместить глубину первой строки.

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

// The column grouping depth is increased by 1.
range.shiftColumnGroupDepth(1);

// The column grouping depth is decreased by 1.
range.shiftColumnGroupDepth(-1);

Параметры

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

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

Range - этот диапазон, для цепочки.

Броски

Error - при попытке сдвинуть глубину первого столбца, когда управляющее положение является Group Control Toggle Position.BEFORE

Авторизация

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

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

`shift Row Group Depth(delta)`

Изменяет глубину группы ряд диапазона на указанное количество.

Это не влияет при уменьшении глубины группы ниже нуля или выше восьми.

Если row group control position BEFORE , это бросает ошибку при попытке сместить глубину первой строки.

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

// The row grouping depth is increased by 1.
range.shiftRowGroupDepth(1);

// The row grouping depth is decreased by 1.
range.shiftRowGroupDepth(-1);

Параметры

Имя	Тип	Описание
`delta`	`Integer`	Сумма, на которую можно изменить глубину группы в этом диапазоне.

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

Range - этот диапазон, для цепочки.

Броски

Error - при попытке сместить глубину первой строки, когда управляющее положение является Group Control Toggle Position.BEFORE

Авторизация

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

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

`sort(sortSpecObj)`

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('A1:C7');

// Sorts by the values in the first column (A)
range.sort(1);

// Sorts by the values in the second column (B)
range.sort(2);

// Sorts descending by column B
range.sort({column: 2, ascending: false});

// Sorts descending by column B, then ascending by column A
// Note the use of an array
range.sort([
  {column: 2, ascending: false},
  {column: 1, ascending: true},
]);

// For rows that are sorted in ascending order, the "ascending" parameter is
// optional, and just an integer with the column can be used instead. Note that
// in general, keeping the sort specification consistent results in more
// readable code. You can express the earlier sort as:
range.sort([{column: 2, ascending: false}, 1]);

// Alternatively, if you want all columns to be in ascending order, you can use
// the following (this makes column 2 ascending)
range.sort([2, 1]);
// ... which is equivalent to
range.sort([
  {column: 2, ascending: true},
  {column: 1, ascending: true},
]);

Параметры

Имя	Тип	Описание
`sort Spec Obj`	`Object`	Столбцы для сортировки.

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

`split Text To Columns()`

Разбивает столбец текста в несколько столбцов на основе автоматического детектива.

// A1:A3 has the following values:
//           A                  B                 C
// 1 |one,one,one      |                 |                 |
// 2 |two,two,two      |                 |                 |
// 3 |three,three,three|                 |                 |

const range = SpreadsheetApp.getActiveSheet().getRange('A1:A3');
range.splitTextToColumns();

// Result after splitting the text to columns:
//           A                  B                 C
// 1 |one              |one              |one              |
// 2 |two              |two              |two              |
// 3 |three            |three            |three            |

Авторизация

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

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

`split Text To Columns(delimiter)`

Разбивает столбец текста в несколько столбцов, используя указанную строку в качестве пользовательского разделителя.

// A1:A3 has the following values:
//           A                  B                 C
// 1 |one#one#one      |                 |                 |
// 2 |two#two#two      |                 |                 |
// 3 |three#three#three|                 |                 |

const range = SpreadsheetApp.getActiveSheet().getRange('A1:A3');
range.splitTextToColumns('#');

// Result after splitting the text to columns:
//           A                  B                 C
// 1 |one              |one              |one              |
// 2 |two              |two              |two              |
// 3 |three            |three            |three            |

Параметры

Имя	Тип	Описание
`delimiter`	`String`	Пользовательский разделитель для разделения.

Авторизация

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

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

`split Text To Columns(delimiter)`

Разбивает столбец текста в несколько столбцов на основе указанного разделителя.

// A1:A3 has the following values:
//           A                  B                 C
// 1 |one;one;one      |                 |                 |
// 2 |two;two;two      |                 |                 |
// 3 |three;three;three|                 |                 |

const range = SpreadsheetApp.getActiveSheet().getRange('A1:A3');
range.splitTextToColumns(SpreadsheetApp.TextToColumnsDelimiter.SEMICOLON);

// Result after splitting the text to columns:
//           A                  B                 C
// 1 |one              |one              |one              |
// 2 |two              |two              |two              |
// 3 |three            |three            |three            |

Параметры

Имя	Тип	Описание
`delimiter`	`Text To Columns Delimiter`	Заданный разделитель, чтобы разделить.

Авторизация

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

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

`trim Whitespace()`

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

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
const range = sheet.getRange('A1:A4');
range.activate();
range.setValues([
  ' preceding space',
  'following space ',
  'two  middle  spaces',
  '   =SUM(1,2)',
]);

range.trimWhitespace();

const values = range.getValues();
// Values are ['preceding space', 'following space', 'two middle spaces',
// '=SUM(1,2)']

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

`uncheck()`

Изменяет состояние флажок в диапазоне на «неконтролируемое». Игнорирует ячейки в диапазоне, которые в настоящее время не содержат ни настроенного, ни неконтролируемого значения.

// Changes the state of cells which currently contain either the checked or
// unchecked value configured in the range A1:B10 to 'unchecked'.
const range = SpreadsheetApp.getActive().getRange('A1:B10');
range.uncheck();

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

Range - этот диапазон, для цепочки.

Авторизация

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

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

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

`get Font Color()`

Устарел. Заменен на get Font Color Object()

Возвращает цвет шрифта ячейки в верхнем левом углу диапазона, в нотации CSS (например, '#ffffff' или 'white' ).

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('B2:D4');

Logger.log(range.getFontColor());

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

String - цвет шрифта в нотации CSS (например '#ffffff' или 'white' ).

Авторизация

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

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

`get Font Colors()`

Устарел. Заменен на get Font Color Objects()

Возвращает цвета шрифта ячеек в диапазоне в нотации CSS (например '#ffffff' или 'white' ).

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('B2:D4');

const results = range.getFontColors();

for (const i in results) {
  for (const j in results[i]) {
    Logger.log(results[i][j]);
  }
}

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

String[][] -двухмерный массив цветов шрифтов, связанных с ячейками в диапазоне.

Авторизация

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

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