Class Spreadsheet

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

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

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

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

Параметры

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

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

Авторизация

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

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

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

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

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

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

Параметры

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

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

Авторизация

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

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

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

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

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

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

Параметры

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

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

Авторизация

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

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

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

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

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

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

Параметры

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

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

Авторизация

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

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

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

Параметры

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

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

Авторизация

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

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

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

Параметры

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

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

Авторизация

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

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

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

Параметры

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

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

Авторизация

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

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

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

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

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

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

Параметры

Авторизация

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

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

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

Параметры

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

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

Авторизация

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

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

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

Параметры

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

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

Авторизация

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

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

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

Параметры

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

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

Авторизация

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

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

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

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

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

Параметры

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

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

Авторизация

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

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

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

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

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

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

Параметры

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

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

Авторизация

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

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

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

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

Параметры

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

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

Авторизация

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

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

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

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

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

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

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

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

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

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

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

var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();

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

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

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

Параметры

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

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

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

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

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

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

Авторизация

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

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

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

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

Параметры

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

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

Авторизация

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

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

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

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

Параметры

Авторизация

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

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

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

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

Параметры

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

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

Авторизация

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

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

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

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

Параметры

Авторизация

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

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

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

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

Параметры

Авторизация

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

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

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

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

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

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

Авторизация

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

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

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

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

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

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

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

Авторизация

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

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

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

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

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

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

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

Авторизация

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

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

См. также

• set Active Range(range)

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

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

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

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

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

Авторизация

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

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

См. также

• set Active Range List(rangeList)

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

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

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

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

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

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

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

Параметры

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

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

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

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

// Gets an array of the bandings in the spreadsheet.
const bandings = ss.getBandings();

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

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

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

Авторизация

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

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

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

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

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

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

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

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

Параметры

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

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

Авторизация

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

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

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

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

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

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

Авторизация

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

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

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

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

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

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

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

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

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

Авторизация

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

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

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

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

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

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

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

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

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

Авторизация

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

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

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

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

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

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

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

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

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

Авторизация

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

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

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

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

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

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

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

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

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

Авторизация

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

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

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

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

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

// Gets the first data source sheet in the spreadsheet.
const dataSource = ss.getDataSourceSheets()[0];

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

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

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

Авторизация

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

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

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

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

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

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

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

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

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

Авторизация

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

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

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

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

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

// Gets the data sources on the spreadsheet.
const dataSources = ss.getDataSources();

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

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

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

Авторизация

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

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

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

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

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

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

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

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

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

Авторизация

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

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

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

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

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

Авторизация

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

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

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

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

// Gets the form URL from the spreadsheet.
const formUrl = ss.getFormUrl();

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

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

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

Авторизация

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

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

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

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

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

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

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

Авторизация

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

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

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

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

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

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

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

Авторизация

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

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

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

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

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

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

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

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

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

// Gets the over-the-grid images from Sheet1.
// To get the over-the-grid images from the entire spreadsheet, use ss.getImages() instead.
const images = sheet.getImages();

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

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

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

Авторизация

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

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

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

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

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

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

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

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

Авторизация

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

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

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

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

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

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

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

Авторизация

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

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

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

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

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

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

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

Авторизация

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

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

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

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

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

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

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

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

Авторизация

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

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

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

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

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

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

Авторизация

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

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

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

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

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

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

Авторизация

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

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

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

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

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

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

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

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

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

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

Авторизация

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

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

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

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

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

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

Авторизация

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

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

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

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

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

Параметры

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

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

Авторизация

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

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

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

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

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

Параметры

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

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

Авторизация

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

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

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

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

Параметры

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

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

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

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

Параметры

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

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

Авторизация

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

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

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

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

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

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

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

Авторизация

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

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

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

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

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

Параметры

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

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

Авторизация

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

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

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

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

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

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

Авторизация

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

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

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

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

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

Параметры

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

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

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

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

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

Logger.log(sheet.getSheetId());

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

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

Авторизация

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

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

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

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

Logger.log(sheet.getSheetName());

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

String — имя листа

Авторизация

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

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

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

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

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

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

Параметры

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

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

Авторизация

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

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

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

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

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

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

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

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

// Gets the spreadsheet locale.
const ssLocale = ss.getSpreadsheetLocale();

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

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

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

Авторизация

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

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

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

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

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

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

Авторизация

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

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

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

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

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

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

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

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

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

Авторизация

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

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

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

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

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

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

Авторизация

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

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

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

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

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

Авторизация

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

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

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

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

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

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

Параметры

Авторизация

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

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

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

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

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

Параметры

Авторизация

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

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

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

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

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

Параметры

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

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

Авторизация

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

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

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

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

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

Параметры

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

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

Авторизация

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

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

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

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

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

Параметры

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

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

Авторизация

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

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

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

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

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

Параметры

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

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

Авторизация

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

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

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

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

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

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

// Builds a data source specification.
// TODO (developer): Update the project ID to your own Google Cloud project ID.
const dataSourceSpec = SpreadsheetApp.newDataSourceSpec()
 .asBigQuery()
 .setProjectId('project-id-1')
 .setTableProjectId('bigquery-public-data')
 .setDatasetId('ncaa_basketball')
 .setTableId('mbb_historical_teams_games')
 .build();

// Adds the data source and its data to the spreadsheet.
ss.insertDataSourceSheet(dataSourceSpec);

Параметры

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

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

Авторизация

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

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

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

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

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

Параметры

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

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

Авторизация

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

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

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

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

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

Параметры

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

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

Авторизация

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

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

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

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

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

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

Параметры

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

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

Авторизация

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

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

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

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

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

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

Параметры

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

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

Авторизация

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

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

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

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

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

Параметры

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

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

Авторизация

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

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

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

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

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

Параметры

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

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

Авторизация

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

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

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

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

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

Параметры

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

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

Авторизация

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

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

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

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

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

Параметры

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

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

Авторизация

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

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

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

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

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

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

Авторизация

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

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

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

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

Параметры

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

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

Авторизация

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

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

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

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

Параметры

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

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

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

Авторизация

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

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

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

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

Параметры

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

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

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

Авторизация

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

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

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

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

Параметры

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

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

Авторизация

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

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

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

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

Параметры

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

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

Авторизация

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

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

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

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

Параметры

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

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

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

Авторизация

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

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

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

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

Параметры

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

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

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

Авторизация

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

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

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

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

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

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

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

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

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

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

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

Параметры

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

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

Авторизация

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

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

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

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

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

Параметры

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

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

Авторизация

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

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

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

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

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

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

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

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

Авторизация

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

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

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

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

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

Параметры

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

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

Авторизация

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

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

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

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

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

Параметры

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

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

Авторизация

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

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

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

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

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

spreadsheet.moveActiveSheet(2);

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

Параметры

Авторизация

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

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

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

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

Параметры

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

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

Авторизация

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

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

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

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

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

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

// Gets the first data source sheet on the spreadsheet.
const dataSheet = ss.getDataSourceSheets()[0];

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

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

Авторизация

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

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

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

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

Параметры

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

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

Авторизация

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

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

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

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

Параметры

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

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

Авторизация

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

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

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

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

Параметры

Авторизация

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

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

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

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

Параметры

Авторизация

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

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

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

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

Параметры

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

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

Авторизация

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

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

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

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

Параметры

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

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

Авторизация

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

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

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

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

Параметры

Авторизация

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

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

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

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

Параметры

Авторизация

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

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

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

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

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

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

Авторизация

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

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

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

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

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

Параметры

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

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

Авторизация

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

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

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

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

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

Параметры

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

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

Авторизация

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

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

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

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

var range = sheet.getRange("A1:D4");
sheet.setActiveSelection(range);

Параметры

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

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

Авторизация

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

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

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

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

sheet.setActiveSelection("A1:D4");

Параметры

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

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

Авторизация

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

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

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

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

Параметры

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

Sheet - Активный лист.

Авторизация

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

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

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

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

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

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

Параметры

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

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

Авторизация

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

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

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

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

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

Параметры

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

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

Авторизация

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

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

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

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

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

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

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

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

Параметры

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

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

Авторизация

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

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

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

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

// Freezes the first column
sheet.setFrozenColumns(1);

Параметры

Авторизация

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

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

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

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

// Freezes the first row
sheet.setFrozenRows(1);

Параметры

Авторизация

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

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

Устанавливает минимальное пороговое значение для итеративного расчета. Когда результаты последовательного расчета различаются на меньшее, чем это значение, итеративное расчет останавливается. Это значение должно быть неотрицательным, а по умолчанию-до 0,05.

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

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

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

Параметры

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

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

Авторизация

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

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

Устанавливает, активируется ли итеративное расчет в этой таблице. Если максимальное количество циклов расчетов и порога сходимости ранее не были установлены при активации расчета, они по умолчанию до 50 и 0,05 соответственно. Если кто -то был установлен ранее, они сохраняют свои предыдущие значения.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Activates iterative calculation on the spreadsheet.
ss.setIterativeCalculationEnabled(true);

// Logs whether iterative calculation is activated for the spreadsheet.
console.log(ss.isIterativeCalculationEnabled());

Параметры

Возвращаться

Spreadsheet - эта таблица, для цепочки.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

Устанавливает максимальное количество итераций расчета, которые должны выполняться во время итеративного расчета. Это значение должно быть от 1 до 10 000 (включительно), а по умолчанию - до 50.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Sets the max iterative calculation cycles for the spreadsheet.
ss.setMaxIterativeCalculationCycles(10);

// Logs the max iterative calculation cycles to the console.
console.log(ss.getMaxIterativeCalculationCycles());

Параметры

Возвращаться

Spreadsheet - эта таблица, для цепочки.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

Называет диапазон.

// The code below creates a new named range "TaxRates" in the active spreadsheet
var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.setNamedRange("TaxRates", SpreadsheetApp.getActiveRange());

Параметры

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

Устанавливает, как часто эта электронная таблица должна пересчитывать.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Sets the  calculation interval for the spreadsheet to 'ON_CHANGE'.
const interval = ss.setRecalculationInterval(SpreadsheetApp.RecalculationInterval.ON_CHANGE);

// Logs the calculation interval to the console.
console.log(interval);

Параметры

Возвращаться

Spreadsheet - эта таблица, для цепочки.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

Устанавливает высоту строки заданного строки в пикселях. По умолчанию ряды растут, чтобы соответствовать содержимому ячейки. Если вы хотите заставить ряды до указанной высоты, используйте Sheet.setRowHeightsForced(startRow, numRows, height) .

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Sets the first row to a height of 200 pixels
sheet.setRowHeight(1, 200);

Параметры

Возвращаться

Sheet - Лист, полезный для цепочки методов.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

Устанавливает локаль электронной таблицы.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Sets the spreadsheet locale.
ss.setSpreadsheetLocale('fr');

// Gets the spreadsheet locale.
const ssLocale = ss.getSpreadsheetLocale();

// Logs the locale to the console.
console.log(ssLocale);

Параметры

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

Устанавливает тему на электронной таблице.

var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
// The code below sets the second predefined theme as the current theme of the spreadsheet.
var predefinedThemesList = spreadsheet.getPredefinedSpreadsheetThemes();
spreadsheet.setSpreadsheetTheme(predefinedThemesList[1]);

Параметры

Возвращаться

Spreadsheet Theme - новая текущая тема.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

Устанавливает часовой пояс для электронной таблицы.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Sets the time zone of the spreadsheet.
ss.setSpreadsheetTimeZone('America/New_York');

// Gets the time zone of the spreadsheet.
const ssTimeZone = ss.getSpreadsheetTimeZone();

// Logs the time zone to the console.
console.log(ssTimeZone);

Параметры

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

Отображает пользовательский компонент пользовательского интерфейса в диалоге, ориентированном на просмотр браузера пользователя. Выполнение скрипта на стороне сервера не приостановлено. Чтобы общаться со стороной сервера, компонент пользовательского интерфейса должен сделать асинхронные обратные вызовы с скриптом на стороне сервера.

Если сценарий на стороне сервера ранее отображался диалог, который еще не был отклонен, то существующий диалог заменяется на пользовательский интерфейс в недавно запрошенном диалоговом окне.

Следующий фрагмент кода отображает простое приложение Html Service в диалоге с указанным заголовком, высотой и шириной:

var htmlApp = HtmlService
    .createHtmlOutput('<p>A change of speed, a change of style...</p>')
    .setTitle('My HtmlService Application')
    .setWidth(250)
    .setHeight(300);

SpreadsheetApp.getActiveSpreadsheet().show(htmlApp);

// The script resumes execution immediately after showing the dialog.

Параметры

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

• https://www.googleapis.com/auth/script.container.ui

Сортирует лист по столбцу, восходящий.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Sorts the sheet by the first column, ascending
sheet.sort(1);

Параметры

Возвращаться

Sheet - лист, полезный для цепочки методов

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

Сортирует лист по столбцу. Принимает параметр для указания восходящего или спуска.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Sorts the sheet by the first column, descending
sheet.sort(1, false);

Параметры

Возвращаться

Sheet - лист, полезный для цепочки методов

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

Показывает всплывающее окно в правом нижнем углу электронной таблицы с данным сообщением.

// Show a popup with the message "Task started".
SpreadsheetApp.getActiveSpreadsheet().toast('Task started');

Параметры

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

Показывает всплывающее окно в правом нижнем углу электронной таблицы с данным сообщением и заголовком.

// Show a popup with the title "Status" and the message "Task started".
SpreadsheetApp.getActiveSpreadsheet().toast('Task started', 'Status');

Параметры

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

Показывает всплывающее окно в правом нижнем углу электронной таблицы с данным заголовком и сообщением, которое остается видимым в течение определенного времени.

// Show a 3-second popup with the title "Status" and the message "Task started".
SpreadsheetApp.getActiveSpreadsheet().toast('Task started', 'Status', 3);

Параметры

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

Не приведет к столбцу в данном диапазоне.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This unhides the first column if it was previously hidden
var range = sheet.getRange("A1");
sheet.unhideColumn(range);

Параметры

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

Не поддается ряд в данном диапазоне.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This unhides the first row if it was previously hidden
var range = sheet.getRange("A1");
sheet.unhideRow(range);

Параметры

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

Обновляет меню, которое было добавлено в add Menu(name, subMenus) . Работает точно так же, как add Menu(name, subMenus) .

var ss = SpreadsheetApp.getActiveSpreadsheet();
var menuEntries = [];
menuEntries.push({name: "Lone Menu Entry", functionName: "function1"});
ss.updateMenu("addMenuExample", menuEntries);

Параметры

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

Ожидает до завершения всех текущих выполнений в таблице, выходящей после предоставленного количества секунд. Выбрасывает исключение, если выполнения не завершены при выходе из строя, но не отменяет выполнения данных.

Параметры

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets