Acessar e criar arquivos das Planilhas Google. Essa classe é a classe mãe do serviço de planilha.
Propriedades
| Propriedade | Tipo | Descrição |
|---|---|---|
Auto | Auto | Uma enumeração dos tipos de série usados para calcular valores preenchidos automaticamente. |
Banding | Banding | Uma enumeração dos possíveis temas de banding. |
Boolean | Boolean | Uma enumeração de critérios booleanos de formatação condicional. |
Border | Border | Uma enumeração dos estilos válidos para definir bordas em um Range. |
Color | Color | Uma enumeração de possíveis tipos de cores. |
Copy | Copy | Uma enumeração dos tipos de colagem possíveis. |
Data | Data | Uma enumeração dos possíveis códigos de erro de execução de dados. |
Data | Data | Uma enumeração dos possíveis estados de execução de dados. |
Data | Data | Uma enumeração dos possíveis tipos de parâmetros de fonte de dados. |
Data | Data | Uma enumeração dos possíveis escopos de atualização da fonte de dados. |
Data | Data | Uma enumeração dos tipos de fontes de dados possíveis. |
Data | Data | Uma enumeração que representa os critérios de validação de dados que podem ser definidos em um intervalo. |
Date | Date | Uma enumeração de regra de agrupamento de data e hora. |
Developer | Developer | Uma enumeração de possíveis tipos de local de metadados do desenvolvedor. |
Developer | Developer | 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 possíveis direções em que é possível se mover em uma planilha usando as teclas de seta. |
Frequency | Frequency | Uma enumeração de possíveis tipos de frequência. |
Group | Group | Uma enumeração das posições em que a alternância de controle de grupo pode estar. |
Interpolation | Interpolation | Uma enumeração de tipos de interpolação de gradiente de formatação condicional. |
Pivot | Pivot | Uma enumeração das funções que podem ser usadas para resumir valores em uma tabela dinâmica. |
Pivot | Pivot | Uma enumeração das maneiras como um valor de pivô pode ser exibido. |
Protection | Protection | Uma enumeração que representa as partes de uma planilha que podem ser protegidas contra edições. |
Recalculation | Recalculation | Uma enumeração dos possíveis intervalos que podem ser usados no recálculo da planilha. |
Relative | Relative | Uma enumeração de opções de data relativa para calcular um valor a ser usado em Boolean com base em datas. |
Sheet | Sheet | Uma enumeração dos diferentes tipos de páginas que podem existir em uma planilha. |
Sort | Sort | Uma enumeração da ordem de classificação. |
Text | Text | Uma enumeração de rotas em texto válidas. |
Text | Text | Uma enumeração dos delimitadores predefinidos para dividir texto em colunas. |
Theme | Theme | Uma enumeração de possíveis tipos de cores de tema. |
Value | Value | Uma enumeração de tipos de valores retornados por Range.getValue() e Range.getValues() da classe "Range" do serviço de planilhas. Os valores de enumeração listados abaixo são adicionais a Number, Boolean, Date ou String. |
Wrap | Wrap | Uma enumeração das estratégias usadas para ajustar células. |
Métodos
| Método | Tipo de retorno | Breve descrição |
|---|---|---|
create(name) | Spreadsheet | Cria uma planilha com o nome especificado. |
create(name, rows, columns) | Spreadsheet | Cria uma planilha com o nome e o número de linhas e colunas especificados. |
enable | void | Ativa a execução de dados para todos os tipos de fontes de dados. |
enable | void | Ativa a execução de dados para fontes de dados do BigQuery. |
enable | void | Ativa a execução de dados para fontes de dados do Looker. |
flush() | void | Aplica todas as mudanças pendentes na planilha. |
get | Spreadsheet | Retorna a planilha ativa no momento ou null se não houver nenhuma. |
get | Range | Retorna o intervalo selecionado na planilha ativa ou null se não houver um intervalo ativo. |
get | Range | Retorna a lista de intervalos ativos na planilha ativa ou null se não houver intervalos selecionados. |
get | Sheet | Recebe a página ativa em uma planilha. |
get | Spreadsheet | Retorna a planilha ativa no momento ou null se não houver nenhuma. |
get | Range|null | Retorna a célula atual (destacada) selecionada em um dos intervalos ativos na
planilha ativa ou null se não houver uma célula atual. |
get | Selection | Retorna o Selection atual na planilha. |
get | Ui | Retorna uma instância do ambiente da interface do usuário da planilha que permite ao script adicionar recursos como menus, caixas de diálogo e barras laterais. |
new | Cell | Cria um builder para um Cell. |
new | Color | Cria um builder para um Color. |
new | Conditional | Cria um builder para uma regra de formatação condicional. |
new | Data | Cria um builder para um Data. |
new | Data | Cria um builder para uma regra de validação de dados. |
new | Filter | Cria um builder para um Filter. |
new | Rich | Cria um builder para um valor de rich text. |
new | Text | Cria um builder para um estilo de texto. |
open(file) | Spreadsheet | Abre a planilha que corresponde ao objeto de arquivo especificado. |
open | Spreadsheet | Abre a planilha com o ID especificado. |
open | Spreadsheet | Abre a planilha com o URL especificado. |
set | Range | Define o intervalo especificado como o active range, com a célula superior esquerda no intervalo como o current cell. |
set | Range | Define a lista especificada de intervalos como o active ranges. |
set | Sheet | Define a página ativa em uma planilha. |
set | Sheet | Define a planilha ativa em uma planilha, com a opção de restaurar a seleção mais recente nessa planilha. |
set | void | Define a planilha ativa. |
set | Range | Define a célula especificada como current cell. |
Documentação detalhada
create(name)
Cria uma planilha com o nome especificado.
// 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
enable All Data Sources Execution()
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 fonte de dados não estiver ativado. Use esse método para ativar a execução de dados em todos os tipos de fontes 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
enable Big Query Execution()
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
enable Looker Execution()
Ativa a execução de dados para fontes de dados do Looker.
A execução de dados para a fonte 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.
Às vezes, as operações de planilha são agrupadas para melhorar a performance, como ao fazer várias chamadas para "Range.getValue()". No entanto, talvez você queira garantir que todas as mudanças pendentes sejam feitas imediatamente, por exemplo, para mostrar dados aos 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(); } }
get Active()
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.getActive().getUrl());
Retornar
Spreadsheet: 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
get Active Range()
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.
// 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
get Active Range List()
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 houver um único intervalo selecionado, isso vai se comportar como uma chamada get.
// Returns the list of active ranges. const rangeList = SpreadsheetApp.getActiveRangeList();
Retornar
Range: 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
get Active Sheet()
Recebe a página ativa em uma planilha.
A página ativa em uma planilha é aquela que está sendo mostrada na interface do usuário.
// 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
get Active Spreadsheet()
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 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
get Current Cell()
Retorna a célula atual (destacada) selecionada em um dos intervalos ativos na
planilha 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|null: 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
get Selection()
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
get Ui()
Retorna uma instância do ambiente da 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 interface da instância atual de uma planilha aberta e apenas 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 da interface do usuário desta planilha
new Cell Image()
Cria um builder para um Cell.
// 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
Cell: o novo builder.
new Color()
Cria um builder para um Color.
const rgbColor = SpreadsheetApp.newColor().setRgbColor('#FF0000').build();
Retornar
Color: o novo builder.
new Conditional Format Rule()
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
Conditional: o novo builder.
new Data Source Spec()
Cria um builder para um Data.
// Opens the spreadsheet file by its URL. If you created your script from within // a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() // instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl( 'https://docs.google.com/spreadsheets/d/abc123456/edit', ); // 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
Data: o novo builder.
new Data Validation()
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
Data: o novo builder.
new Filter Criteria()
Cria um builder para um Filter.
// 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
Filter: o novo builder
new Rich Text Value()
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
Rich: o novo builder.
new Text Style()
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
Text: o novo builder.
open(file)
Abre a planilha que corresponde ao objeto de arquivo especificado.
// 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
open By Id(id)
Abre a planilha com o ID especificado. 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 de planilha com o ID especificado
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
open By Url(url)
Abre a planilha com o URL especificado. Gera uma exceção de script se o URL não existir ou se o usuário não tiver permissão para acessar.
// 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 especificado.
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
set Active Range(range)
Define o intervalo especificado como o active range, com a célula superior esquerda no intervalo como o current cell.
A interface da planilha mostra a página que contém o intervalo escolhido e seleciona as células definidas nele.
// 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 a ser definido como o intervalo ativo. |
Retornar
Range: o novo intervalo ativo
set Active Range List(rangeList)
Define a lista especificada de intervalos como o 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 |
|---|---|---|
range | Range | A lista de intervalos a serem selecionados. |
Retornar
Range: 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
set Active Sheet(sheet)
Define a página ativa em uma planilha. A interface do Google Planilhas mostra a planilha 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 planilha ativa. |
Retornar
Sheet: a planilha que foi definida como a nova planilha ativa
set Active Sheet(sheet, restoreSelection)
Define a planilha ativa em uma planilha, com a opção de restaurar a seleção mais recente nessa planilha. A interface do Google Planilhas 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 planilha ativa. |
restore | 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 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
set Active Spreadsheet(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 |
|---|---|---|
new | Spreadsheet | A planilha que será ativada. |
set Current Cell(cell)
Define a célula especificada como current cell.
Se a célula especificada estiver em um intervalo já selecionado, esse intervalo vai 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 vai 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