Class SpreadsheetApp

SpreadsheetApp

Acessar e criar arquivos do Planilhas Google. Esta é a classe mãe do serviço de planilha.

Propriedades

PropriedadeTipoDescrição
AutoFillSeriesAutoFillSeriesUma enumeração dos tipos de séries usadas para calcular valores preenchidos automaticamente.
BandingThemeBandingThemeUma enumeração dos possíveis temas de faixa.
BooleanCriteriaBooleanCriteriaUma enumeração de critérios booleanos de formatação condicional.
BorderStyleBorderStyleUma enumeração dos estilos válidos para definir bordas em um Range.
ColorTypeColorTypeUma enumeração dos possíveis tipos de cor.
CopyPasteTypeCopyPasteTypeUma enumeração dos possíveis tipos de colagem.
DataExecutionErrorCodeDataExecutionErrorCodeUma enumeração dos possíveis códigos de erro de execução de dados.
DataExecutionStateDataExecutionStateUma enumeração dos possíveis estados de execução de dados.
DataSourceParameterTypeDataSourceParameterTypeUma enumeração dos possíveis tipos de parâmetro da fonte de dados.
DataSourceRefreshScopeDataSourceRefreshScopeUma enumeração de possíveis escopos de atualização da fonte de dados.
DataSourceTypeDataSourceTypeUma enumeração dos possíveis tipos de fontes de dados.
DataValidationCriteriaDataValidationCriteriaUma enumeração que representa os critérios de validação de dados que podem ser definidos em um intervalo.
DateTimeGroupingRuleTypeDateTimeGroupingRuleTypeUma enumeração da regra de agrupamento de data e hora.
DeveloperMetadataLocationTypeDeveloperMetadataLocationTypeUma enumeração de possíveis tipos de locais de metadados do desenvolvedor.
DeveloperMetadataVisibilityDeveloperMetadataVisibilityUma enumeração das possíveis visibilidades de metadados do desenvolvedor.
DimensionDimensionUma enumeração das possíveis dimensões de uma planilha.
DirectionDirectionUma enumeração das possíveis direções que se pode mover em uma planilha usando as teclas de seta.
FrequencyTypeFrequencyTypeUma enumeração dos possíveis tipos de frequência.
GroupControlTogglePositionGroupControlTogglePositionUma enumeração das posições em que o controle de grupo pode estar.
InterpolationTypeInterpolationTypeUma enumeração de tipos de interpolação de gradiente de formato condicional.
PivotTableSummarizeFunctionPivotTableSummarizeFunctionUma enumeração das funções que podem ser usadas para resumir valores em uma tabela dinâmica.
PivotValueDisplayTypePivotValueDisplayTypeUma enumeração das maneiras como um valor dinâmico pode ser exibido.
ProtectionTypeProtectionTypeUma enumeração que representa as partes de uma planilha que podem ser protegidas contra edições.
RecalculationIntervalRecalculationIntervalUma enumeração dos intervalos possíveis que podem ser usados no recálculo da planilha.
RelativeDateRelativeDateUma enumeração de opções de data relativa para calcular um valor a ser usado em BooleanCriteria baseado em data.
SheetTypeSheetTypeUma enumeração dos diferentes tipos de páginas que podem existir em uma planilha.
SortOrderSortOrderUma enumeração da ordem de classificação.
TextDirectionTextDirectionUma enumeração de direções de texto válidas.
TextToColumnsDelimiterTextToColumnsDelimiterUma enumeração dos delimitadores predefinidos para divisão de texto em colunas.
ThemeColorTypeThemeColorTypeUma enumeração dos possíveis tipos de cores do tema.
ValueTypeValueTypeUma enumeração de tipos de valor retornados por Range.getValue() e Range.getValues() da classe Range do serviço Planilha. Os valores de enumeração listados abaixo são além de Number, Boolean, Date ou String.
WrapStrategyWrapStrategyUma enumeração das estratégias usadas para unir células.

Métodos

MétodoTipo de retornoBreve descrição
create(name)SpreadsheetCria uma nova planilha com o nome informado.
create(name, rows, columns)SpreadsheetCria uma nova planilha com o nome e o número especificado de linhas e colunas.
enableAllDataSourcesExecution()voidAtiva a execução de dados para todos os tipos de fontes de dados.
enableBigQueryExecution()voidAtiva a execução de dados para fontes do BigQuery.
flush()voidAplica todas as alterações pendentes na planilha.
getActive()SpreadsheetRetorna a planilha ativa no momento ou null se não houver nenhuma.
getActiveRange()RangeRetorna o intervalo selecionado na página ativa ou null se não houver um intervalo ativo.
getActiveRangeList()RangeListRetorna a lista de intervalos ativos na página ativa ou null se não houver intervalos selecionados.
getActiveSheet()SheetExtrai a página ativa em uma planilha.
getActiveSpreadsheet()SpreadsheetRetorna a planilha ativa no momento ou null se não houver nenhuma.
getCurrentCell()RangeRetorna a célula atual (destacada) selecionada em um dos intervalos ativos na página ativa ou null se não houver célula atual.
getSelection()SelectionRetorna o Selection atual na planilha.
getUi()UiRetorna 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.
newCellImage()CellImageBuilderCria um builder para uma CellImage.
newColor()ColorBuilderCria um builder para uma Color.
newConditionalFormatRule()ConditionalFormatRuleBuilderCria um builder para uma regra de formatação condicional.
newDataSourceSpec()DataSourceSpecBuilderCria um builder para uma DataSourceSpec.
newDataValidation()DataValidationBuilderCria um builder para uma regra de validação de dados.
newFilterCriteria()FilterCriteriaBuilderCria um builder para uma FilterCriteria.
newRichTextValue()RichTextValueBuilderCria um builder para um valor de Rich Text.
newTextStyle()TextStyleBuilderCria um builder para um estilo de texto.
open(file)SpreadsheetAbre a planilha que corresponde ao objeto File especificado.
openById(id)SpreadsheetAbre a planilha com o ID fornecido.
openByUrl(url)SpreadsheetAbre a planilha com o URL fornecido.
setActiveRange(range)RangeDefine o intervalo especificado como active range, com a célula superior esquerda no intervalo como current cell.
setActiveRangeList(rangeList)RangeListDefine a lista de intervalos especificada como o active ranges.
setActiveSheet(sheet)SheetDefine a página ativa em uma planilha.
setActiveSheet(sheet, restoreSelection)SheetDefine a página ativa em uma planilha, com a opção de restaurar a seleção mais recente nessa página.
setActiveSpreadsheet(newActiveSpreadsheet)voidDefine a planilha ativa.
setCurrentCell(cell)RangeDefine a célula especificada como current cell.

Documentação detalhada

create(name)

Cria uma nova planilha com o nome informado.

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

NomeTipoDescrição
nameStringO nome da planilha.

Retorno

Spreadsheet: uma nova planilha

Autorização

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

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

create(name, rows, columns)

Cria uma nova planilha com o nome 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

NomeTipoDescrição
nameStringO nome da planilha.
rowsIntegerO número de linhas da planilha.
columnsIntegerO número de colunas da planilha.

Retorno

Spreadsheet: uma nova planilha

Autorização

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

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

enableAllDataSourcesExecution()

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

A execução de dados gerará uma exceção se o tipo de fonte de dados não estiver 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 exigem autorização com um ou mais dos seguintes escopos:

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

enableBigQueryExecution()

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

A execução de dados para a fonte de dados do BigQuery gera uma exceção se não estiver 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 exigem autorização com um ou mais dos seguintes escopos:

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

flush()

Aplica todas as alterações pendentes na planilha.

Às vezes, as operações de 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á em execução.

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

getActive()

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

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

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

Retorno

Spreadsheet: o objeto ativo da planilha.

Autorização

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

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

getActiveRange()

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 intervalo selecionado.

Geralmente, significa o intervalo que um usuário selecionou na planilha ativa, mas, em uma função personalizada, isso se refere à célula que está sendo recalculada.

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

Retorno

Range: o intervalo ativo.

Autorização

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

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

getActiveRangeList()

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 destacada atual é colocado por último na lista.

Se houver um único intervalo selecionado, a chamada vai ser getActiveRange().

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

Retorno

RangeList: a lista de intervalos ativos.

Autorização

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

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

getActiveSheet()

Extrai a página ativa em uma planilha.

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

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

Retorno

Sheet: o objeto da planilha ativo.

Autorização

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

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

getActiveSpreadsheet()

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

Retorno

Spreadsheet: o objeto ativo da planilha.

Autorização

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

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

getCurrentCell()

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

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

Retorno

Range: a célula atual

Autorização

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

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

getSelection()

Retorna o Selection atual na planilha.

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

Retorno

Selection: a seleção atual

Autorização

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

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

getUi()

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ó pode interagir com a IU da instância atual de uma planilha aberta e somente se o script estiver vinculado à planilha. Para mais informações, consulte os guias sobre menus e 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();
}

Retorno

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


newCellImage()

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

Retorno

CellImageBuilder: o novo builder.


newColor()

Cria um builder para uma Color.

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

Retorno

ColorBuilder: o novo builder.


newConditionalFormatRule()

Cria um builder 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);

Retorno

ConditionalFormatRuleBuilder: o novo builder.


newDataSourceSpec()

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

Retorno

DataSourceSpecBuilder: o novo builder.


newDataValidation()

Cria um builder 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);

Retorno

DataValidationBuilder: o novo builder.


newFilterCriteria()

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

Retorno

FilterCriteriaBuilder: o novo builder


newRichTextValue()

Cria um builder 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);

Retorno

RichTextValueBuilder: o novo builder.


newTextStyle()

Cria um builder 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);

Retorno

TextStyleBuilder: o novo builder.


open(file)

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

NomeTipoDescrição
fileFileO arquivo a ser aberto.

Retorno

Spreadsheet: a planilha

Autorização

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

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

openById(id)

Abre a planilha com o ID fornecido. O ID da planilha pode ser extraído do URL dela. 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

NomeTipoDescrição
idStringO identificador exclusivo da planilha.

Retorno

Spreadsheet: o objeto da planilha com o ID fornecido.

Autorização

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

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

openByUrl(url)

Abre a planilha com o URL fornecido. Uma exceção de script é gerada 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

NomeTipoDescrição
urlStringO URL da planilha.

Retorno

Spreadsheet: o objeto da planilha com o URL fornecido.

Autorização

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

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

setActiveRange(range)

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 no intervalo escolhido.

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

NomeTipoDescrição
rangeRangeO intervalo que se tornará ativo.

Retorno

Range: o novo intervalo ativo.


setActiveRangeList(rangeList)

Define a lista de intervalos especificada como o active ranges. O último intervalo da lista é definido como o 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

NomeTipoDescrição
rangeListRangeListLista de intervalos a selecionar.

Retorno

RangeList: a lista de intervalos selecionados recentemente.

Autorização

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

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

setActiveSheet(sheet)

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

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

Parâmetros

NomeTipoDescrição
sheetSheetA nova página ativa.

Retorno

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


setActiveSheet(sheet, restoreSelection)

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

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

NomeTipoDescrição
sheetSheetA nova página ativa.
restoreSelectionBooleanSe for true, a seleção mais recente da nova página ativa será selecionada novamente quando a nova planilha ficar ativa. Se false, a nova página ficará ativa sem alterar a seleção atual.

Retorno

Sheet: a nova página ativa.

Autorização

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

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

setActiveSpreadsheet(newActiveSpreadsheet)

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

NomeTipoDescrição
newActiveSpreadsheetSpreadsheetA planilha que será a planilha ativa.

setCurrentCell(cell)

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 a célula atual.

Se a célula especificada não estiver presente em nenhum intervalo selecionado, a seleção atual 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

NomeTipoDescrição
cellRangeA célula a ser definida como a célula atual.

Retorno

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

Autorização

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

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