Esta página foi traduzida pela API Cloud Translation.

Class SpreadsheetApp

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

Propriedades

Propriedade	Tipo	Descrição
`AutoFillSeries`	`AutoFillSeries`	Uma enumeração dos tipos de série usados para calcular valores preenchidos automaticamente.
`BandingTheme`	`BandingTheme`	Uma enumeração dos possíveis temas de faixas.
`BooleanCriteria`	`BooleanCriteria`	Uma enumeração de critérios booleanos de formatação condicional.
`BorderStyle`	`BorderStyle`	Uma enumeração dos estilos válidos para definir bordas em um `Range`.
`ColorType`	`ColorType`	Uma enumeração de possíveis tipos de cores.
`CopyPasteType`	`CopyPasteType`	Uma enumeração dos possíveis tipos de colagem.
`DataExecutionErrorCode`	`DataExecutionErrorCode`	Uma enumeração dos possíveis códigos de erro de execução de dados.
`DataExecutionState`	`DataExecutionState`	Uma enumeração dos possíveis estados de execução de dados.
`DataSourceParameterType`	`DataSourceParameterType`	Uma enumeração dos possíveis tipos de parâmetros da fonte de dados.
`DataSourceRefreshScope`	`DataSourceRefreshScope`	Uma enumeração de possíveis escopos de atualização da fonte de dados.
`DataSourceType`	`DataSourceType`	Uma enumeração dos possíveis tipos de fonte de dados.
`DataValidationCriteria`	`DataValidationCriteria`	Uma enumeração que representa os critérios de validação de dados que podem ser definidos em um intervalo.
`DateTimeGroupingRuleType`	`DateTimeGroupingRuleType`	Uma enumeração de regras de agrupamento de data e hora.
`DeveloperMetadataLocationType`	`DeveloperMetadataLocationType`	Uma enumeração de possíveis tipos de local de metadados do desenvolvedor.
`DeveloperMetadataVisibility`	`DeveloperMetadataVisibility`	Uma enumeração das possíveis visibilidades de metadados do desenvolvedor.
`Dimension`	`Dimension`	Uma enumeração das dimensões possíveis de uma planilha.
`Direction`	`Direction`	Uma enumeração das direções possíveis em que uma pessoa pode se mover em uma planilha usando as teclas de seta.
`FrequencyType`	`FrequencyType`	Uma enumeração de possíveis tipos de frequência.
`GroupControlTogglePosition`	`GroupControlTogglePosition`	Uma enumeração das posições em que o botão de controle de grupo pode estar.
`InterpolationType`	`InterpolationType`	Uma enumeração de tipos de interpolação de gradiente de formatação condicional.
`PivotTableSummarizeFunction`	`PivotTableSummarizeFunction`	Uma enumeração das funções que podem ser usadas para resumir valores em uma tabela dinâmica.
`PivotValueDisplayType`	`PivotValueDisplayType`	Uma enumeração das maneiras como um valor de pivot pode ser mostrado.
`ProtectionType`	`ProtectionType`	Uma enumeração que representa as partes de uma planilha que podem ser protegidas contra edições.
`RecalculationInterval`	`RecalculationInterval`	Uma enumeração dos intervalos possíveis que podem ser usados no recalculo da planilha.
`RelativeDate`	`RelativeDate`	Uma enumeração de opções de data relativa para calcular um valor a ser usado em `BooleanCriteria` com base na data.
`SheetType`	`SheetType`	Uma enumeração dos diferentes tipos de planilhas que podem existir em uma planilha.
`SortOrder`	`SortOrder`	Uma enumeração da ordem de classificação.
`TextDirection`	`TextDirection`	Uma enumeração de rotas em texto válidas.
`TextToColumnsDelimiter`	`TextToColumnsDelimiter`	Uma enumeração dos delimitadores predefinidos para dividir o texto em colunas.
`ThemeColorType`	`ThemeColorType`	Uma enumeração de possíveis tipos de cores de tema.
`ValueType`	`ValueType`	Uma 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 adicionais a `Number`, `Boolean`, `Date` ou `String`.
`WrapStrategy`	`WrapStrategy`	Uma enumeração das estratégias usadas para unir células.

Métodos

Método	Tipo de retorno	Breve descrição
`create(name)`	`Spreadsheet`	Cria uma nova planilha com o nome fornecido.
`create(name, rows, columns)`	`Spreadsheet`	Cria uma planilha com o nome e o número de linhas e colunas especificados.
`enableAllDataSourcesExecution()`	`void`	Ativa a execução de dados para todos os tipos de fontes de dados.
`enableBigQueryExecution()`	`void`	Ativa a execução de dados para fontes de dados do BigQuery.
`enableLookerExecution()`	`void`	Ativa a execução de dados para as fontes de dados do Looker.
`flush()`	`void`	Aplica todas as mudanças pendentes na planilha.
`getActive()`	`Spreadsheet`	Retorna a planilha ativa no momento ou `null` se não houver nenhuma.
`getActiveRange()`	`Range`	Retorna o intervalo selecionado na planilha ativa ou `null` se não houver um intervalo ativo.
`getActiveRangeList()`	`RangeList`	Retorna a lista de intervalos ativos na planilha ativa ou `null` se não houver intervalos selecionados.
`getActiveSheet()`	`Sheet`	Retorna a página ativa em uma planilha.
`getActiveSpreadsheet()`	`Spreadsheet`	Retorna a planilha ativa no momento ou `null` se não houver nenhuma.
`getCurrentCell()`	`Range`	Retorna a célula atual (realçada) selecionada em um dos intervalos ativos na folha ativa ou `null` se não houver uma célula atual.
`getSelection()`	`Selection`	Retorna o `Selection` atual na planilha.
`getUi()`	`Ui`	Retorna uma instância do ambiente de interface do usuário da planilha que permite que o script adicione recursos como menus, caixas de diálogo e barras laterais.
`newCellImage()`	`CellImageBuilder`	Cria um builder para uma `CellImage`.
`newColor()`	`ColorBuilder`	Cria um builder para uma `Color`.
`newConditionalFormatRule()`	`ConditionalFormatRuleBuilder`	Cria um builder para uma regra de formatação condicional.
`newDataSourceSpec()`	`DataSourceSpecBuilder`	Cria um builder para uma `DataSourceSpec`.
`newDataValidation()`	`DataValidationBuilder`	Cria um builder para uma regra de validação de dados.
`newFilterCriteria()`	`FilterCriteriaBuilder`	Cria um builder para uma `FilterCriteria`.
`newRichTextValue()`	`RichTextValueBuilder`	Cria um builder para um valor de rich text.
`newTextStyle()`	`TextStyleBuilder`	Cria um builder para um estilo de texto.
`open(file)`	`Spreadsheet`	Abre a planilha correspondente ao objeto File fornecido.
`openById(id)`	`Spreadsheet`	Abre a planilha com o ID fornecido.
`openByUrl(url)`	`Spreadsheet`	Abre a planilha com o URL fornecido.
`setActiveRange(range)`	`Range`	Define o intervalo especificado como `active range`, com a célula superior esquerda no intervalo como `current cell`.
`setActiveRangeList(rangeList)`	`RangeList`	Define a lista especificada de intervalos como `active ranges`.
`setActiveSheet(sheet)`	`Sheet`	Define a página ativa em uma planilha.
`setActiveSheet(sheet, restoreSelection)`	`Sheet`	Define a página ativa em uma planilha, com a opção de restaurar a seleção mais recente nesta página.
`setActiveSpreadsheet(newActiveSpreadsheet)`	`void`	Define a planilha ativa.
`setCurrentCell(cell)`	`Range`	Define a célula especificada como `current cell`.

Documentação detalhada

`create(name)`

Cria uma nova planilha com o nome fornecido.

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

Parâmetros

Nome	Tipo	Descrição
`name`	`String`	O nome da planilha.

Retornar

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 planilha com o nome e o número de linhas e colunas especificados.

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

Parâmetros

Nome	Tipo	Descrição
`name`	`String`	O nome da planilha.
`rows`	`Integer`	O número de linhas da planilha.
`columns`	`Integer`	O número de colunas da planilha.

Retornar

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 gera uma exceção se o tipo de origem de dados não estiver ativado. Use esse método para ativar a execução de dados em todos os tipos de origem 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 de dados 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

`enableLookerExecution()`

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

A execução de dados para a origem de dados do Looker gera uma exceção se não estiver ativada.

// Turns data execution on for Looker data sources.
SpreadsheetApp.enableLookerExecution();

// 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
// associated Looker data.
ss.getDataSourceSheets()[0].refreshData();

`flush()`

Aplica todas as mudanças pendentes na planilha.

As operações de planilha às vezes são agrupadas para melhorar o desempenho, como ao fazer várias chamadas para Range.getValue(). No entanto, às vezes é importante garantir que todas as mudanças pendentes sejam feitas imediatamente, por exemplo, para mostrar 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() {
  const sheet = SpreadsheetApp.getActiveSheet();
  for (let 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 receber 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());

Retornar

Spreadsheet: o objeto de planilha 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

`getActiveRange()`

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

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

// The code below logs the background color for the active range.
const 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 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 planilha 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 um único intervalo for selecionado, ele vai se comportar como uma chamada getActiveRange().

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

Retornar

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

Retorna a página ativa em uma planilha.

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

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

Retornar

Sheet: o objeto de 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());

Retornar

Spreadsheet: o objeto de planilha 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

`getCurrentCell()`

Retorna a célula atual (realçada) selecionada em um dos intervalos ativos na folha ativa ou null se não houver uma célula atual.

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

Retornar

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.

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

Retornar

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 que o script adicione recursos como menus, caixas de diálogo e barras laterais. Um script só pode interagir com a interface da instância atual de uma planilha aberta e somente se estiver vinculado a ela. Para mais informações, consulte os guias de 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();
}

Retornar

Ui: uma instância do ambiente de interface do usuário dessa 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);

Retornar

CellImageBuilder: o novo builder.

`newColor()`

Cria um builder para uma Color.

const rgbColor = SpreadsheetApp.newColor().setRgbColor('#FF0000').build();

Retornar

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.
const sheet = SpreadsheetApp.getActive().getActiveSheet();
const range = sheet.getRange('A1:B3');
const rule = SpreadsheetApp.newConditionalFormatRule()
                 .whenNumberBetween(1, 10)
                 .setBackground('#FF0000')
                 .setRanges([range])
                 .build();
const rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Retornar

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

Retornar

DataSourceSpecBuilder: o novo builder.

`newDataValidation()`

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

const cell = SpreadsheetApp.getActive().getRange('A1');
const 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.

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

Retornar

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.
const cell = SpreadsheetApp.getActive().getRange('A1');
const bold = SpreadsheetApp.newTextStyle().setBold(true).build();
const value = SpreadsheetApp.newRichTextValue()
                  .setText('Hello world')
                  .setTextStyle(0, 5, bold)
                  .build();
cell.setRichTextValue(value);

Retornar

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.
const range = SpreadsheetApp.getActive().getRange('A1:B3');
const style = SpreadsheetApp.newTextStyle()
                  .setForegroundColor('red')
                  .setFontSize(22)
                  .setBold(true)
                  .setUnderline(true)
                  .build();
range.setTextStyle(style);

Retornar

TextStyleBuilder: o novo builder.

`open(file)`

Abre a planilha correspondente ao objeto File fornecido.

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

Parâmetros

Nome	Tipo	Descrição
`file`	`File`	O arquivo a ser aberto.

Retornar

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 de uma 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).
const ss = SpreadsheetApp.openById('abc1234567');
Logger.log(ss.getName());

Parâmetros

Nome	Tipo	Descrição
`id`	`String`	O identificador exclusivo da planilha.

Retornar

Spreadsheet: o objeto "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. Gera 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).
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc1234567/edit',
);
console.log(ss.getName());

Parâmetros

Nome	Tipo	Descrição
`url`	`String`	O URL da planilha.

Retornar

Spreadsheet: o objeto de 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 interface da planilha mostra 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.
const range =
    SpreadsheetApp.getActiveSpreadsheet().getSheets()[0].getRange('C1:D4');
SpreadsheetApp.setActiveRange(range);

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

Parâmetros

Nome	Tipo	Descrição
`range`	`Range`	O intervalo que será o ativo.

Retornar

Range: o novo intervalo ativo

`setActiveRangeList(rangeList)`

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

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

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

Parâmetros

Nome	Tipo	Descrição
`rangeList`	`RangeList`	A lista de intervalos a serem selecionados.

Retornar

RangeList: a lista de intervalos recém-selecionada

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 interface do app Planilhas Google mostra 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.
const spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
SpreadsheetApp.setActiveSheet(spreadsheet.getSheets()[1]);

Parâmetros

Nome	Tipo	Descrição
`sheet`	`Sheet`	A nova página ativa.

Retornar

Sheet: a planilha que se tornou a nova planilha ativa

`setActiveSheet(sheet, restoreSelection)`

Define a página ativa em uma planilha, com a opção de restaurar a seleção mais recente nesta página. A interface das Planilhas Google mostra a página escolhida, a menos que ela pertença a uma planilha diferente.

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

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

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

Parâmetros

Nome	Tipo	Descrição
`sheet`	`Sheet`	A nova página ativa.
`restoreSelection`	`Boolean`	Se `true`, a seleção mais recente da nova planilha ativa será selecionada novamente quando a nova planilha for ativada. Se `false`, a nova planilha será ativada sem mudar a seleção atual.

Retornar

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
const ss = SpreadsheetApp.openById('1234567890');
SpreadsheetApp.setActiveSpreadsheet(ss);

Parâmetros

Nome	Tipo	Descrição
`newActiveSpreadsheet`	`Spreadsheet`	A planilha que será 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 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 de 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.
const cell =
    SpreadsheetApp.getActiveSpreadsheet().getSheets()[0].getRange('B5');
SpreadsheetApp.setCurrentCell(cell);

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

Parâmetros

Nome	Tipo	Descrição
`cell`	`Range`	A célula a ser definida como a atual.

Retornar

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