Class SpreadsheetApp

Cria uma nova planilha com o nome fornecido.

// The code below creates a new spreadsheet "Finances" and logs the URL for it
var ssNew = SpreadsheetApp.create("Finances");
Logger.log(ssNew.getUrl());

Parâmetros

Retornar

Spreadsheet: uma nova planilha

Autorização

Os scripts que usam esse método requerem autorização com um ou mais dos seguintes escopos:

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

Cria uma nova planilha com o nome fornecido e o número especificado de linhas e colunas.

// The code below creates a new spreadsheet "Finances" with 50 rows and 5 columns and logs the
// URL for it
var ssNew = SpreadsheetApp.create("Finances", 50, 5);
Logger.log(ssNew.getUrl());

Parâmetros

Retornar

Spreadsheet: uma nova planilha

Autorização

Os scripts que usam esse método requerem autorização com um ou mais dos seguintes escopos:

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

Ativa a execução de dados para todos os tipos de fontes de dados.

A execução de dados gera uma exceção quando o tipo de fonte de dados não está ativado. Use esse método para ativar a execução de dados para todos os tipos de fonte de dados.

// Turns data execution on for all types of data sources.
SpreadsheetApp.enableAllDataSourcesExecution();

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

// Gets the first data source sheet in the spreadsheet and refreshes the data.
ss.getDataSourceSheets()[0].refreshData();

Autorização

Os scripts que usam esse método requerem autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/bigquery.readonly

Ativa a execução de dados para fontes de dados do BigQuery.

A execução de dados da fonte de dados do BigQuery gera uma exceção quando essa opção não está ativada.

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

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

// Gets the first data source sheet in the spreadsheet and refreshes the BigQuery data.
ss.getDataSourceSheets()[0].refreshData();

Autorização

Os scripts que usam esse método requerem autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/bigquery.readonly

Aplica todas as alterações pendentes à planilha.

Às vezes, as operações da planilha são agrupadas para melhorar o desempenho, como ao fazer várias chamadas para Range.getValue(). No entanto, às vezes você pode querer garantir que todas as alterações pendentes sejam feitas imediatamente, por exemplo, para mostrar os dados dos usuários enquanto um script está sendo executado.

// The code below changes the background color of cells A1 and B1 twenty times. You should be
// able to see the updates live in the spreadsheet. If flush() is not called, the updates may
// be applied live or may all be applied at once when the script completes.
function colors() {
  var sheet = SpreadsheetApp.getActiveSheet();
  for (var i = 0; i < 20; i++) {
    if ((i % 2) == 0) {
      sheet.getRange('A1').setBackground('green');
      sheet.getRange('B1').setBackground('red');
    } else {
      sheet.getRange('A1').setBackground('red');
      sheet.getRange('B1').setBackground('green');
    }
    SpreadsheetApp.flush();
  }
}

Retorna a planilha ativa no momento ou null, se não houver nenhuma.

As funções que são executadas no contexto de uma planilha podem ter uma referência ao objeto da planilha correspondente chamando essa função.

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

Retornar

Spreadsheet: o objeto Spreadsheet ativo

Autorização

Os scripts que usam esse método requerem autorização com um ou mais dos seguintes escopos:

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

Retorna o intervalo selecionado na página ativa ou null se não houver um intervalo ativo. Se vários intervalos forem selecionados, esse método retornará apenas o último.

Isso geralmente significa o intervalo que um usuário selecionou na página ativa. No entanto, em uma função personalizada, a célula é recalculada ativamente.

// The code below logs the background color for the active range.
var colorObject = SpreadsheetApp.getActiveRange().getBackgroundObject();
// Assume the color has ColorType.RGB.
Logger.log(colorObject.asRgbColor().asHexString());

Retornar

Range: o intervalo ativo.

Autorização

Os scripts que usam esse método requerem autorização com um ou mais dos seguintes escopos:

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

Retorna a lista de intervalos ativos na página ativa ou null se não houver intervalos selecionados. O intervalo ativo que contém a célula realçada atual é colocado por último na lista.

Se houver um único intervalo selecionado, ele se comportará como uma chamada getActiveRange().

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

Retornar

RangeList: a lista de intervalos ativos

Autorização

Os scripts que usam esse método requerem autorização com um ou mais dos seguintes escopos:

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

Obtém a página ativa em uma planilha.

A página ativa em uma planilha é aquela que está sendo exibida na IU da planilha.

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

Retornar

Sheet: o objeto Planilha ativo

Autorização

Os scripts que usam esse método requerem autorização com um ou mais dos seguintes escopos:

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

Retorna a planilha ativa no momento ou null, se não houver nenhuma.

As funções executadas no contexto de uma planilha podem receber uma referência ao objeto Spreadsheet correspondente chamando essa função.

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

Retornar

Spreadsheet: o objeto Spreadsheet ativo

Autorização

Os scripts que usam esse método requerem autorização com um ou mais dos seguintes escopos:

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

Retorna a célula atual (destacada) selecionada em um dos intervalos ativos na página ativa ou null se não houver uma célula atual.

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

Retornar

Range — a célula atual

Autorização

Os scripts que usam esse método requerem autorização com um ou mais dos seguintes escopos:

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

Retorna o Selection atual na planilha.

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

Retornar

Selection: a seleção atual

Autorização

Os scripts que usam esse método requerem autorização com um ou mais dos seguintes escopos:

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

Retorna uma instância do ambiente de interface do usuário da planilha que permite ao script adicionar recursos como menus, caixas de diálogo e barras laterais. Um script só poderá interagir com a IU da instância atual de uma planilha aberta e somente se estiver vinculado à planilha. Para mais informações, consulte os guias de menus, caixas de diálogo e barras laterais.

// Add a custom menu to the active spreadsheet, including a separator and a sub-menu.
function onOpen(e) {
  SpreadsheetApp.getUi()
      .createMenu('My Menu')
      .addItem('My menu item', 'myFunction')
      .addSeparator()
      .addSubMenu(SpreadsheetApp.getUi().createMenu('My sub-menu')
          .addItem('One sub-menu item', 'mySecondFunction')
          .addItem('Another sub-menu item', 'myThirdFunction'))
      .addToUi();
}

Retornar

Ui: uma instância do ambiente de interface do usuário desta planilha.

Cria um builder para uma CellImage.

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

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

// Gets cell A1 on Sheet1.
const range = sheet.getRange('A1');

// Builds an image using a source URL.
const cellImage = SpreadsheetApp.newCellImage()
  .setSourceUrl('https://www.gstatic.com/images/branding/productlogos/apps_script/v10/web-64dp/logo_apps_script_color_1x_web_64dp.png')
  .build();

// Sets the image in cell A1.
range.setValue(cellImage);

Retornar

CellImageBuilder: o novo builder.

Cria um builder para uma Color.

var rgbColor = SpreadsheetApp.newColor().setRgbColor("#FF0000").build();

Retornar

ColorBuilder: o novo builder.

Cria um construtor para uma regra de formatação condicional.

// Adds a conditional format rule to a sheet that causes all cells in range A1:B3 to turn red
// if they contain a number between 1 and 10.
var sheet = SpreadsheetApp.getActive().getActiveSheet();
var range = sheet.getRange('A1:B3');
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenNumberBetween(1, 10)
    .setBackground("#FF0000")
    .setRanges([range])
    .build()
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Retornar

ConditionalFormatRuleBuilder: o novo builder.

Cria um builder para uma DataSourceSpec.

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

// Enables BigQuery.
SpreadsheetApp.enableBigQueryExecution();

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

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

Retornar

DataSourceSpecBuilder: o novo builder.

Cria um construtor para uma regra de validação de dados.

var cell = SpreadsheetApp.getActive().getRange('A1');
var rule = SpreadsheetApp.newDataValidation()
    .requireNumberBetween(1, 100)
    .setAllowInvalid(false)
    .setHelpText('Number must be between 1 and 100.')
    .build();
cell.setDataValidation(rule);

Retornar

DataValidationBuilder: o novo builder.

Cria um builder para uma FilterCriteria.

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

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

// Sets the range to A1:D20.
const range = sheet.getRange('A1:D20');

// Creates a filter and applies it to the specified range.
range.createFilter();

// Gets the current filter for the range and creates filter criteria that only shows cells
// that aren't empty.
const filter = range.getFilter();
const criteria = SpreadsheetApp.newFilterCriteria().whenCellNotEmpty().build();

// Sets the criteria to  column C.
filter.setColumnFilterCriteria(3, criteria);

Retornar

FilterCriteriaBuilder: o novo builder

Cria um construtor para um valor de Rich Text.

// Sets cell A1 to have the text "Hello world", with "Hello" bolded.
var cell = SpreadsheetApp.getActive().getRange('A1');
var bold = SpreadsheetApp.newTextStyle().setBold(true).build();
var value = SpreadsheetApp.newRichTextValue()
    .setText("Hello world")
    .setTextStyle(0, 5, bold)
    .build();
cell.setRichTextValue(value);

Retornar

RichTextValueBuilder: o novo builder.

Cria um construtor para um estilo de texto.

// Sets range A1:B3 to have red, size 22, bolded, underlined text.
var range = SpreadsheetApp.getActive().getRange('A1:B3');
var style = SpreadsheetApp.newTextStyle()
    .setForegroundColor("red")
    .setFontSize(22)
    .setBold(true)
    .setUnderline(true)
    .build();
range.setTextStyle(style);

Retornar

TextStyleBuilder: o novo builder.

Abre a planilha que corresponde ao objeto File especificado.

// Get any starred spreadsheets from Google Drive, then open the spreadsheets and log the name
// of the first sheet within each spreadsheet.
var files = DriveApp.searchFiles(
    'starred = true and mimeType = "' + MimeType.GOOGLE_SHEETS + '"');
while (files.hasNext()) {
  var spreadsheet = SpreadsheetApp.open(files.next());
  var sheet = spreadsheet.getSheets()[0];
  Logger.log(sheet.getName());
}

Parâmetros

Retornar

Spreadsheet — a planilha

Autorização

Os scripts que usam esse método requerem autorização com um ou mais dos seguintes escopos:

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

Abre a planilha com o código fornecido. Um ID de planilha pode ser extraído de seu URL. Por exemplo, o ID da planilha no URL https://docs.google.com/spreadsheets/d/abc1234567/edit#gid=0 é "abc1234567".

// The code below opens a spreadsheet using its ID and logs the name for it.
// Note that the spreadsheet is NOT physically opened on the client side.
// It is opened on the server only (for modification by the script).
var ss = SpreadsheetApp.openById("abc1234567");
Logger.log(ss.getName());

Parâmetros

Retornar

Spreadsheet: o objeto da planilha com o código fornecido

Autorização

Os scripts que usam esse método requerem autorização com um ou mais dos seguintes escopos:

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

Abre a planilha com o URL fornecido. Emite uma exceção de script se o URL não existir ou o usuário não tiver permissão para acessá-lo.

// Opens a spreadsheet by its URL and logs its name.
// Note that the spreadsheet doesn't physically open on the client side.
// It opens on the server only (for modification by the script).
var ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc1234567/edit');
console.log(ss.getName());

Parâmetros

Retornar

Spreadsheet: o objeto da planilha com o URL fornecido.

Autorização

Os scripts que usam esse método requerem autorização com um ou mais dos seguintes escopos:

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

Define o intervalo especificado como active range, com a célula superior esquerda no intervalo como current cell.

A IU da planilha exibe a página que contém o intervalo escolhido e seleciona as células definidas nesse intervalo.

// The code below sets range C1:D4 in the first sheet as the active range.
var range = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0].getRange('C1:D4');
SpreadsheetApp.setActiveRange(range);

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

Parâmetros

Retornar

Range: o novo intervalo ativo.

Define a lista especificada de intervalos como active ranges. O último intervalo da lista é definido como active range.

// The code below sets ranges [D4, B2:C4] in the active sheet as the active ranges.
var rangeList = SpreadsheetApp.getActiveSheet().getRanges(['D4', 'B2:C4']);
SpreadsheetApp.setActiveRangeList(rangeList);

var selection = SpreadsheetApp.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();

Parâmetros

Retornar

RangeList: a lista de intervalos recém-selecionada

Autorização

Os scripts que usam esse método requerem autorização com um ou mais dos seguintes escopos:

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

Define a página ativa em uma planilha. A IU do Planilhas Google exibirá a página escolhida, a menos que ela pertença a uma planilha diferente.

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

Parâmetros

Retornar

Sheet: a página que se tornou a nova página ativa

Define a página ativa em uma planilha, com a opção de restaurar a seleção mais recente nessa página. A IU do Planilhas Google exibirá a página escolhida, a menos que ela pertença a uma planilha diferente.

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

Parâmetros

Retornar

Sheet: a nova página ativa.

Autorização

Os scripts que usam esse método requerem autorização com um ou mais dos seguintes escopos:

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

Define a planilha ativa.

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

Parâmetros

Define a célula especificada como current cell.

Se a célula especificada estiver presente em um intervalo já selecionado, esse intervalo se tornará o intervalo ativo com a célula como célula atual.

Se a célula especificada não estiver presente em nenhum intervalo selecionado, a seleção existente será removida e a célula se tornará a célula atual e o intervalo ativo.

Observação: o Range especificado precisa consistir em uma célula. Caso contrário, esse método gerará uma exceção.

// The code below sets the cell B5 in the first sheet as the current cell.
var cell = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0].getRange('B5');
SpreadsheetApp.setCurrentCell(cell);

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

Parâmetros

Retornar

Range: a célula atual recém-definida.

Autorização

Os scripts que usam esse método requerem autorização com um ou mais dos seguintes escopos:

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