Acessar e modificar planilhas. As operações comuns são renomear uma planilha e acessar objetos de intervalo dela.
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
activate() | Sheet | Ativa essa página. |
add | Sheet | Adiciona metadados do desenvolvedor com a chave especificada à planilha. |
add | Sheet | Adiciona metadados do desenvolvedor com a chave e a visibilidade especificadas à planilha. |
add | Sheet | Adiciona metadados do desenvolvedor com a chave e o valor especificados à planilha. |
add | Sheet | Adiciona metadados do desenvolvedor com a chave, o valor e a visibilidade especificados à planilha. |
append | Sheet | Anexar uma linha à parte de baixo da região de dados atual na planilha. |
as | Data | Retorna a planilha como Data se ela for do tipo Sheet ou null . |
auto | Sheet | Define a largura da coluna para ajustar o conteúdo. |
auto | Sheet | Define a largura de todas as colunas a partir da posição da coluna especificada para ajustar o conteúdo. |
auto | Sheet | Define a altura de todas as linhas a partir da posição da linha especificada para ajustar o conteúdo. |
clear() | Sheet | Limpa a planilha de conteúdo e informações de formatação. |
clear(options) | Sheet | Limpa a página de sumário e/ou o formato, conforme especificado com as opções avançadas fornecidas. |
clear | void | Remove todas as regras de formatação condicional da planilha. |
clear | Sheet | Limpa a folha de conteúdo, preservando as informações de formatação. |
clear | Sheet | Limpa a formatação da planilha, preservando o conteúdo. |
clear | Sheet | Limpa a folha de todas as anotações. |
collapse | Sheet | Recolhe todos os grupos de colunas na página. |
collapse | Sheet | Recolhe todos os grupos de linhas na página. |
copy | Sheet | Copia a página para uma planilha específica, que pode ser a mesma da origem. |
create | Developer | Retorna um Developer para encontrar metadados do desenvolvedor no escopo desta
folha. |
create | Text | Cria um localizador de texto para a planilha, que pode encontrar e substituir texto nela. |
delete | Sheet | Exclui a coluna na posição especificada. |
delete | void | Exclui um número de colunas a partir da posição especificada. |
delete | Sheet | Exclui a linha na posição especificada. |
delete | void | Exclui um número de linhas a partir da posição especificada. |
expand | Sheet | Abre todos os grupos de colunas na página. |
expand | Sheet | Abre todos os grupos de linhas na página. |
expand | Sheet | Expande todos os grupos de colunas até a profundidade especificada e recolhe todos os outros. |
expand | Sheet | Abre todos os grupos de linhas até a profundidade especificada e fecha todos os outros. |
get | Range | Retorna a célula ativa nesta página. |
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
ativos. |
get | Banding[] | Retorna todas as faixas nesta página. |
get | Embedded | Retorna uma matriz de gráficos nesta página. |
get | Group | Retorna o grupo de colunas no índice e na profundidade de grupo especificados. |
get | Group | Retorna o Group para todos os grupos de colunas na planilha. |
get | Integer | Retorna a profundidade do grupo da coluna no índice especificado. |
get | Integer | Recebe a largura em pixels da coluna especificada. |
get | Conditional | Receba todas as regras de formatação condicional nesta página. |
get | Range | Retorna a célula atual na planilha ativa ou null se não houver uma célula atual. |
get | Range | Retorna um Range correspondente às dimensões em que os dados estão presentes. |
get | Data | Recebe todas as fórmulas da fonte de dados. |
get | Data | Recebe todas as tabelas dinâmicas da fonte de dados. |
get | Data | Recebe todas as tabelas da fonte de dados. |
get | Developer | Receba todos os metadados do desenvolvedor associados a esta página. |
get | Drawing[] | Retorna uma matriz de desenhos na página. |
get | Filter | Retorna o filtro nesta página ou null se não houver um filtro. |
get | String | Retorna o URL do formulário que envia as respostas para essa página ou null se ela
não tiver um formulário associado. |
get | Integer | Retorna o número de colunas congeladas. |
get | Integer | Retorna o número de linhas congeladas. |
get | Over | Retorna todas as imagens fora da grade na página. |
get | Integer | Consegue a posição da planilha na planilha pai. |
get | Integer | Retorna a posição da última coluna com conteúdo. |
get | Integer | Retorna a posição da última linha com conteúdo. |
get | Integer | Retorna o número atual de colunas na planilha, independentemente do conteúdo. |
get | Integer | Retorna o número atual de linhas na planilha, independentemente do conteúdo. |
get | String | Retorna o nome da planilha. |
get | Named | Recebe todos os intervalos nomeados nesta página. |
get | Spreadsheet | Retorna o Spreadsheet que contém essa planilha. |
get | Pivot | Retorna todas as tabelas dinâmicas na página. |
get | Protection[] | Recebe uma matriz de objetos que representam todos os intervalos protegidos na planilha ou uma matriz de um único elemento que representa a proteção na própria planilha. |
get | Range | Retorna o intervalo com a célula superior esquerda nas coordenadas especificadas. |
get | Range | Retorna o intervalo com a célula superior esquerda nas coordenadas especificadas e com o número de linhas especificado. |
get | Range | Retorna o intervalo com a célula superior esquerda nas coordenadas especificadas com o número de linhas e colunas especificado. |
get | Range | Retorna o intervalo especificado na notação A1 ou R1C1. |
get | Range | Retorna a coleção Range que representa os intervalos na mesma planilha especificados
por uma lista não vazia de notações A1 ou R1C1. |
get | Group | Retorna o grupo de linhas no índice e na profundidade de grupo especificados. |
get | Group | Retorna o Group para todos os grupos de linhas na planilha. |
get | Integer | Retorna a profundidade do grupo da linha no índice especificado. |
get | Integer | Recebe a altura em pixels da linha especificada. |
get | Selection | Retorna o Selection atual na planilha. |
get | Integer | Retorna o ID da planilha representada por este objeto. |
get | String | Retorna o nome da planilha. |
get | Object[][] | Retorna a grade retangular de valores para esse intervalo, começando nas coordenadas especificadas. |
get | Slicer[] | Retorna uma matriz de seções na planilha. |
get | Color | Recebe a cor da guia da página ou null se ela não tiver cor. |
get | Sheet | Retorna o tipo da planilha. |
has | Boolean | Retorna true se as linhas de grade da planilha estiverem ocultas. Caso contrário, retorna false . |
hide | void | Oculta a coluna ou as colunas no intervalo especificado. |
hide | void | Oculta uma única coluna no índice fornecido. |
hide | void | Oculta uma ou mais colunas consecutivas a partir do índice especificado. |
hide | void | Oculta as linhas no intervalo especificado. |
hide | void | Oculta a linha no índice especificado. |
hide | void | Oculta uma ou mais linhas consecutivas a partir do índice especificado. |
hide | Sheet | Oculta esta página. |
insert | void | Adiciona um novo gráfico a esta página. |
insert | Sheet | Insere uma coluna após a posição da coluna especificada. |
insert | Sheet | Insere uma coluna antes da posição da coluna especificada. |
insert | void | Insere uma coluna em branco em uma página no local especificado. |
insert | void | Insere uma ou mais colunas em branco consecutivas em uma planilha, começando no local especificado. |
insert | Sheet | Insere um determinado número de colunas após a posição da coluna especificada. |
insert | Sheet | Insere um número de colunas antes da posição da coluna especificada. |
insert | Over | Insere um Blob como uma imagem no documento em uma determinada linha e coluna. |
insert | Over | Insere um Blob como uma imagem no documento em uma determinada linha e coluna, com um
deslocamento de pixel. |
insert | Over | Insere uma imagem no documento em uma determinada linha e coluna. |
insert | Over | Insere uma imagem no documento em uma determinada linha e coluna, com um deslocamento de pixel. |
insert | Sheet | Insere uma linha após a posição da linha especificada. |
insert | Sheet | Insere uma linha antes da posição da linha especificada. |
insert | void | Insere uma linha em branco em uma página no local especificado. |
insert | void | Insere uma ou mais linhas em branco consecutivas em uma planilha, começando no local especificado. |
insert | Sheet | Insere um número de linhas após a posição da linha especificada. |
insert | Sheet | Insere um número de linhas antes da posição de linha especificada. |
insert | Slicer | Adiciona um novo seletor a esta página. |
insert | Slicer | Adiciona um novo seletor a esta página. |
is | Boolean | Retorna se a coluna especificada está oculta pelo usuário. |
is | Boolean | Retorna true se o layout da planilha for da direita para a esquerda. |
is | Boolean | Retorna se a linha especificada está oculta por um filtro (não uma visualização de filtro). |
is | Boolean | Retorna se a linha especificada está oculta pelo usuário. |
is | Boolean | Retorna true se a planilha estiver oculta. |
move | void | Move as colunas selecionadas pelo intervalo especificado para a posição indicada pelo destination . |
move | void | Move as linhas selecionadas pelo intervalo especificado para a posição indicada pelo destination . |
new | Embedded | Retorna um builder para criar um novo gráfico para esta página. |
protect() | Protection | Cria um objeto que pode impedir que a planilha seja editada, exceto por usuários que têm permissão. |
remove | void | Remove um gráfico da planilha pai. |
set | Range | Define o intervalo especificado como active range na página ativa, com
a célula superior esquerda no intervalo como current cell . |
set | Range | Define a lista especificada de intervalos como active ranges na
folha ativa. |
set | Range | Define a região de seleção ativa para esta página. |
set | Range | Define a seleção ativa, conforme especificado na notação A1 ou R1C1. |
set | Sheet | Define a posição do controle de grupo de colunas na planilha. |
set | Sheet | Define a largura da coluna especificada em pixels. |
set | Sheet | Define a largura das colunas especificadas em pixels. |
set | void | Substitui todas as regras de formatação condicional na planilha pelas regras de entrada. |
set | Range | Define a célula especificada como current cell . |
set | void | Congelar o número especificado de colunas. |
set | void | Congelar o número especificado de linhas. |
set | Sheet | Oculta ou mostra as linhas de grade da página. |
set | Sheet | Define o nome da planilha. |
set | Sheet | Define ou desativa o layout da página da direita para a esquerda. |
set | Sheet | Define a posição do controle de grupo de linhas na planilha. |
set | Sheet | Define a altura da linha em pixels. |
set | Sheet | Define a altura das linhas especificadas em pixels. |
set | Sheet | Define a altura das linhas especificadas em pixels. |
set | Sheet | Define a cor da guia da planilha. |
set | Sheet | Define a cor da guia da planilha. |
show | void | Mostra a coluna no índice fornecido. |
show | void | Mostra uma ou mais colunas consecutivas a partir do índice especificado. |
show | void | Mostra a linha no índice especificado. |
show | void | Mostra uma ou mais linhas consecutivas a partir do índice especificado. |
show | Sheet | Torna a página visível. |
sort(columnPosition) | Sheet | Classifica uma página por coluna, em ordem crescente. |
sort(columnPosition, ascending) | Sheet | Ordena uma página por coluna. |
unhide | void | Mostra a coluna no intervalo especificado. |
unhide | void | Mostra a linha no intervalo especificado. |
update | void | Atualiza o gráfico nesta página. |
Documentação detalhada
activate()
Ativa essa página. Não altera a planilha em si, apenas a noção da planilha ativa da página pai.
// This example assumes there is a sheet named "first" const ss = SpreadsheetApp.getActiveSpreadsheet(); const first = ss.getSheetByName('first'); first.activate();
Retornar
Sheet
: a página recém-ativada.
add Developer Metadata(key)
Adiciona metadados do desenvolvedor com a chave especificada à planilha.
// 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 a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Adds the key 'NAME' to the developer metadata for the sheet. sheet.addDeveloperMetadata('NAME'); // Gets the updated metadata info and logs it to the console. console.log(sheet.getDeveloperMetadata()[0].getKey());
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
key | String | A chave dos novos metadados do desenvolvedor. |
Retornar
Sheet
: esta página, para encadeamento.
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
add Developer Metadata(key, visibility)
Adiciona metadados do desenvolvedor com a chave e a visibilidade especificadas à planilha.
// 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 a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Adds the key 'NAME' and sets the developer metadata visibility to PROJECT // for the sheet. sheet.addDeveloperMetadata( 'NAME', SpreadsheetApp.DeveloperMetadataVisibility.PROJECT, ); // Gets the updated metadata info and logs it to the console. const developerMetaData = sheet.getDeveloperMetadata()[0]; console.log(developerMetaData.getKey()); console.log(developerMetaData.getVisibility().toString());
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
key | String | A chave dos novos metadados do desenvolvedor. |
visibility | Developer | A visibilidade dos novos metadados do desenvolvedor. |
Retornar
Sheet
: esta página, para encadeamento.
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
add Developer Metadata(key, value)
Adiciona metadados do desenvolvedor com a chave e o valor especificados à planilha.
// 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 a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Adds the key 'COMPANY' with the value 'TECH' to the developer metadata for // the sheet. sheet.addDeveloperMetadata('COMPANY', 'TECH'); // Gets the updated metadata info and logs it to the console. const developerMetaData = sheet.getDeveloperMetadata()[0]; console.log(developerMetaData.getKey()); console.log(developerMetaData.getValue());
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
key | String | A chave dos novos metadados do desenvolvedor. |
value | String | O valor dos novos metadados do desenvolvedor. |
Retornar
Sheet
: esta página, para encadeamento.
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
add Developer Metadata(key, value, visibility)
Adiciona metadados do desenvolvedor com a chave, o valor e a visibilidade especificados à planilha.
// 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 a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Adds the key 'COMPANY' with the value 'TECH' to the developer metadata and // sets the visibility to DOCUMENT for the sheet. sheet.addDeveloperMetadata( 'COMPANY', 'TECH', SpreadsheetApp.DeveloperMetadataVisibility.DOCUMENT, ); // Gets the updated metadata info and logs it to the console. const developerMetaData = sheet.getDeveloperMetadata()[0]; console.log(developerMetaData.getKey()); console.log(developerMetaData.getValue()); console.log(developerMetaData.getVisibility().toString());
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
key | String | A chave dos novos metadados do desenvolvedor. |
value | String | O valor dos novos metadados do desenvolvedor. |
visibility | Developer | A visibilidade dos novos metadados do desenvolvedor. |
Retornar
Sheet
: esta página, para encadeamento.
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
append Row(rowContents)
Anexar uma linha à parte de baixo da região de dados atual na planilha. Se o conteúdo de uma célula começar
com =
, ele será interpretado como uma fórmula.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Appends a new row with 3 columns to the bottom of the current // data region in the sheet containing the values in the array. sheet.appendRow(['a man', 'a plan', 'panama']);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
row | Object[] | Uma matriz de valores a serem inseridos após a última linha da planilha. |
Retornar
Sheet
: a planilha, útil para encadeamento de métodos.
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
as Data Source Sheet()
Retorna a planilha como Data
se ela for do tipo Sheet
ou null
.
// Opens the spreadsheet file by its URL. If you created your script from within // a Google Sheets file, you can useSpreadsheetApp.getActiveSpreadsheet() // instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl( 'https://docs.google.com/spreadsheets/d/abc123456/edit', ); // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets the data source sheet value if the sheet is of type // SpreadsheetApp.SheetType.DATASOURCE, otherwise this returns a null value. const dataSourceSheet = sheet.asDataSourceSheet(); // Gets the data source sheet value and logs it to the console. console.log(dataSourceSheet); console.log(sheet.getType().toString());
Retornar
Data
: uma planilha de origem de dados.
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
auto Resize Column(columnPosition)
Define a largura da coluna para ajustar o conteúdo.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; sheet.getRange('a1').setValue( 'Whenever it is a damp, drizzly November in my soul...'); // Sets the first column to a width which fits the text sheet.autoResizeColumn(1);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
column | Integer | A posição da coluna a ser redimensionada. |
Retornar
Sheet
: a planilha, útil para encadeamento de métodos
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
auto Resize Columns(startColumn, numColumns)
Define a largura de todas as colunas a partir da posição da coluna especificada para ajustar o conteúdo.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Sets the first 15 columns to a width that fits their text. sheet.autoResizeColumns(1, 15);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
start | Integer | A coluna inicial a ser redimensionada automaticamente. |
num | Integer | O número de colunas que vão ser redimensionadas automaticamente. |
Retornar
Sheet
: esta página, para encadeamento.
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
auto Resize Rows(startRow, numRows)
Define a altura de todas as linhas a partir da posição da linha especificada para ajustar o conteúdo.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Sets the first 15 rows to a height that fits their text. sheet.autoResizeRows(1, 15);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
start | Integer | A linha inicial para redimensionar automaticamente. |
num | Integer | O número de linhas para redimensionamento automático. |
Retornar
Sheet
: esta página, para encadeamento.
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
clear()
Limpa a planilha de conteúdo e informações de formatação.
// This example assumes there is a sheet named "first" const ss = SpreadsheetApp.getActiveSpreadsheet(); const first = ss.getSheetByName('first'); first.clear();
Retornar
Sheet
: a planilha limpa.
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
clear(options)
Limpa a página de sumário e/ou o formato, conforme especificado com as opções avançadas fornecidas.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; sheet.clear({formatOnly: true, contentsOnly: true});
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
options | Object | Um mapa JavaScript com opções avançadas, listadas abaixo. |
Parâmetros avançados
Nome | Tipo | Descrição |
---|---|---|
contents | Boolean | Define se o conteúdo será limpo. |
format | Boolean | Define se o formato será limpo. |
Retornar
Sheet
: esta página, para encadeamento.
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
clear Conditional Format Rules()
Remove todas as regras de formatação condicional da planilha. Isso equivale a chamar set
com uma matriz vazia como entrada.
const sheet = SpreadsheetApp.getActiveSheet(); sheet.clearConditionalFormatRules();
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
clear Contents()
Limpa a folha de conteúdo, preservando as informações de formatação.
// This example assumes there is a sheet named "first" const ss = SpreadsheetApp.getActiveSpreadsheet(); const first = ss.getSheetByName('first'); first.clearContents();
Retornar
Sheet
: esta página, para encadeamento.
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
clear Formats()
Limpa a formatação da planilha, preservando o conteúdo.
A formatação se refere à forma como os dados são formatados, conforme permitido pelas opções no menu "Formatar" (por exemplo, negrito, itálico, formatação condicional), e não à largura ou altura das células.
// This example assumes there is a sheet named "first" const ss = SpreadsheetApp.getActiveSpreadsheet(); const first = ss.getSheetByName('first'); first.clearFormats();
Retornar
Sheet
: esta página, para encadeamento.
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
clear Notes()
Limpa a folha de todas as anotações.
// This example assumes there is a sheet named "first" const ss = SpreadsheetApp.getActiveSpreadsheet(); const first = ss.getSheetByName('first'); first.clearNotes();
Retornar
Sheet
: esta página, para encadeamento.
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
collapse All Column Groups()
Recolhe todos os grupos de colunas na página.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // All column groups on the sheet are collapsed. sheet.collapseAllColumnGroups();
Retornar
Sheet
: esta página, para encadeamento.
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
collapse All Row Groups()
Recolhe todos os grupos de linhas na página.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // All row groups on the sheet are collapsed. sheet.collapseAllRowGroups();
Retornar
Sheet
: esta página, para encadeamento.
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
copy To(spreadsheet)
Copia a página para uma planilha específica, que pode ser a mesma da origem. A folha copiada é chamada de "Cópia de [nome original]".
const source = SpreadsheetApp.getActiveSpreadsheet(); const sheet = source.getSheets()[0]; const destination = SpreadsheetApp.openById('ID_GOES HERE'); sheet.copyTo(destination);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
spreadsheet | Spreadsheet | A planilha para copiar esta, que pode ser a mesma da origem. |
Retornar
Sheet
: a nova planilha, para encadeamento.
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
create Developer Metadata Finder()
Retorna um Developer
para encontrar metadados do desenvolvedor no escopo desta
folha. Os metadados estão no escopo de uma planilha específica se estiverem associados à
própria planilha ou a uma linha, coluna ou intervalo nela.
// 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 a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Adds developer metadata for testing. sheet.addDeveloperMetadata('CITY', 'PARIS'); // Creates the developer metadata finder. const metadatafinder = sheet.createDeveloperMetadataFinder(); // Finds the metadata with value 'PARIS' and displays its key in the console. console.log(metadatafinder.withValue('PARIS').find()[0].getKey());
Retornar
Developer
: um localizador de metadados do desenvolvedor para pesquisar metadados no escopo desta página.
create Text Finder(findText)
Cria um localizador de texto para a planilha, que pode encontrar e substituir texto nela.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // Creates a text finder. const textFinder = sheet.createTextFinder('dog'); // Returns the first occurrence of 'dog' in the sheet. const firstOccurrence = textFinder.findNext(); // Replaces the last found occurrence of 'dog' with 'cat' and returns the number // of occurrences replaced. const numOccurrencesReplaced = firstOccurrence.replaceWith('cat');
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
find | String | O texto a ser pesquisado. |
Retornar
Text
: o Text
da página.
delete Column(columnPosition)
Exclui a coluna na posição especificada.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Columns start at "1" - this deletes the first column sheet.deleteColumn(1);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
column | Integer | A posição da coluna, começando em 1 para a primeira coluna. |
Retornar
Sheet
: a planilha, útil para encadeamento de métodos
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
delete Columns(columnPosition, howMany)
Exclui um número de colunas a partir da posição especificada.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Columns start at "1" - this deletes the first two columns sheet.deleteColumns(1, 2);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
column | Integer | A posição da primeira coluna a ser excluída. |
how | Integer | O número de colunas a serem excluídas. |
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
delete Row(rowPosition)
Exclui a linha na posição especificada.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Rows start at "1" - this deletes the first row sheet.deleteRow(1);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
row | Integer | A posição da linha, começando em 1 para a primeira linha. |
Retornar
Sheet
: a planilha, útil para encadeamento de métodos
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
delete Rows(rowPosition, howMany)
Exclui um número de linhas a partir da posição especificada.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Rows start at "1" - this deletes the first two rows sheet.deleteRows(1, 2);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
row | Integer | A posição da primeira linha a ser excluída. |
how | Integer | O número de linhas a serem excluídas. |
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
expand All Column Groups()
Abre todos os grupos de colunas na página. Esse método requer pelo menos um grupo de colunas.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // All column groups on the sheet are expanded. sheet.expandAllColumnGroups();
Retornar
Sheet
: esta página, para encadeamento.
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
expand All Row Groups()
Abre todos os grupos de linhas na página. Esse método requer pelo menos um grupo de linhas.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // All row groups on the sheet are expanded. sheet.expandAllRowGroups();
Retornar
Sheet
: esta página, para encadeamento.
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
expand Column Groups Up To Depth(groupDepth)
Expande todos os grupos de colunas até a profundidade especificada e recolhe todos os outros.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // All column groups of depth 2 and lower are expanded, and groups with depth // 3 and higher are collapsed. sheet.expandColumnGroupsUpToDepth(2);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
group | Integer | A profundidade do grupo até a qual os grupos de colunas serão expandidos. |
Retornar
Sheet
: esta página, para encadeamento.
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
expand Row Groups Up To Depth(groupDepth)
Abre todos os grupos de linhas até a profundidade especificada e fecha todos os outros.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // All row groups of depth 2 and lower are expanded, and groups with depth // 3 and higher are collapsed. sheet.expandRowGroupsUpToDepth(2);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
group | Integer | A profundidade do grupo até a qual os grupos de linhas serão expandidos. |
Retornar
Sheet
: esta página, para encadeamento.
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 Cell()
Retorna a célula ativa nesta página.
Observação:é preferível usar get
, que retorna a célula
realçada atual.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Returns the active cell const cell = sheet.getActiveCell();
Retornar
Range
: a célula ativa 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 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.
O termo "intervalo ativo" se refere ao 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.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet(); const activeRange = sheet.getActiveRange();
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
Consulte também
get Active Range List()
Retorna a lista de intervalos ativos na planilha ativa ou null
se não houver intervalos
ativos.
Se um único intervalo for selecionado, ele vai se comportar como uma chamada get
.
const sheet = SpreadsheetApp.getActiveSheet(); // Returns the list of active ranges. const activeRangeList = sheet.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
Consulte também
get Bandings()
Retorna todas as faixas nesta página.
// 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 a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets the banding info for the sheet. const bandings = sheet.getBandings(); // Gets info on the bandings' second row color and logs it to the console. for (const banding of bandings) { console.log(banding.getSecondRowColor()); }
Retornar
Banding[]
: todas as faixas desta página.
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 Charts()
Retorna uma matriz de gráficos nesta página.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const charts = sheet.getCharts(); for (const i in charts) { const chart = charts[i]; // Do something with the chart }
Retornar
Embedded
: uma matriz de gráficos.
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 Column Group(columnIndex, groupDepth)
Retorna o grupo de colunas no índice e na profundidade de grupo especificados.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // Returns the group whose control index is at column 2 and has a depth of 1, or // null if the group doesn’t exist. const columnGroup = sheet.getColumnGroup(2, 1);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
column | Integer | O índice da coluna do controle de grupo ou um índice dentro do grupo. |
group | Integer | A profundidade do grupo. |
Retornar
Group
: o grupo de colunas no índice e na profundidade de controle ou gera uma exceção se o grupo
não existir.
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 Column Group Control Position()
Retorna o Group
para todos os grupos de colunas na planilha.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // GroupControlTogglePosition.AFTER if the column grouping control toggle is // shown after the group. const columnGroupControlPosition = sheet.getColumnGroupControlPosition();
Retornar
Group
: true
se o controle de agrupamento de colunas for mostrado após o grupo nesta
planilha e false
, caso contrário.
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 Column Group Depth(columnIndex)
Retorna a profundidade do grupo da coluna no índice especificado.
A profundidade do grupo indica quantos grupos se sobrepõem à coluna. O intervalo pode variar de zero a oito.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // 1 if there is a group over columns 1 through 3 const groupDepth = sheet.getColumnGroupDepth(1);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
column | Integer | O índice da coluna. |
Retornar
Integer
: a profundidade do grupo da coluna no índice 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.currentonly
-
https://www.googleapis.com/auth/spreadsheets
get Column Width(columnPosition)
Recebe a largura em pixels da coluna especificada.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Columns start at 1 Logger.log(sheet.getColumnWidth(1));
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
column | Integer | A posição da coluna a ser examinada. |
Retornar
Integer
: largura da coluna em pixels
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 Conditional Format Rules()
Receba todas as regras de formatação condicional nesta página.
// Logs the conditional format rules in a sheet. const rules = SpreadsheetApp.getActiveSheet().getConditionalFormatRules(); for (let i = 0; i < rules.length; i++) { const rule = rules[i]; Logger.log(rule); }
Retornar
Conditional
: uma matriz de todas as regras na 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
get Current Cell()
Retorna a célula atual na planilha ativa ou null
se não houver uma célula atual. A
célula atual é a que tem foco na interface das Planilhas Google e é destacada por uma borda
escura. Nunca há mais de uma célula atual. Quando um usuário seleciona um ou mais intervalos de células,
uma das células na seleção é a célula atual.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet(); // Returns the current highlighted cell in the one of the active ranges. const currentCell = sheet.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
get Data Range()
Retorna um Range
correspondente às dimensões em que os dados estão presentes.
Isso é funcionalmente equivalente a criar um intervalo limitado por A1 e (Sheet.getLastColumn(), Sheet.getLastRow()).
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // This represents ALL the data const range = sheet.getDataRange(); const values = range.getValues(); // This logs the spreadsheet in CSV format with a trailing comma for (let i = 0; i < values.length; i++) { let row = ''; for (let j = 0; j < values[i].length; j++) { if (values[i][j]) { row = row + values[i][j]; } row = `${row},`; } Logger.log(row); }
Retornar
Range
: um intervalo que consiste em todos os dados 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
get Data Source Formulas()
Recebe todas as fórmulas da fonte de dados.
// Opens the spreadsheet by its ID. If you created your script from within a // Google Sheets file, use SpreadsheetApp.getActiveSpreadsheet(). // TODO(developer): Replace the ID with your own. const ss = SpreadsheetApp.openById('abc123456'); // Gets Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets an array of the data source formulas on Sheet1. // To get an array of data source formulas for the entire spreadsheet, // replace 'sheet' with 'ss'. const dataSourceFormulas = sheet.getDataSourceFormulas(); // Logs the first data source formula in the array. console.log(dataSourceFormulas[0].getFormula());
Retornar
Data
: uma lista de fórmulas de fontes de dados.
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 Data Source Pivot Tables()
Recebe todas as tabelas dinâmicas da fonte de dados.
// Opens the spreadsheet file by its ID. If you created your script from a // Google Sheets file, use SpreadsheetApp.getActiveSpreadsheet(). // TODO(developer): Replace the ID with your own. const ss = SpreadsheetApp.openById('abc123456'); // Gets Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets an array of the data source pivot tables on Sheet1. // To get an array of data source pivot tables for the entire // spreadsheet, replace 'sheet' with 'ss'. const dataSourcePivotTables = sheet.getDataSourcePivotTables(); // Logs the last time that the first pivot table in the array was refreshed. console.log(dataSourcePivotTables[0].getStatus().getLastRefreshedTime());
Retornar
Data
: uma lista de tabelas dinâmicas da fonte de dados.
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 Data Source Tables()
Recebe todas as tabelas da fonte de dados.
// Opens the spreadsheet file by its ID. If you created your script from a // Google Sheets file, use SpreadsheetApp.getActiveSpreadsheet(). // TODO(developer): Replace the ID with your own. const ss = SpreadsheetApp.openById('abc123456'); // Gets Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets an array of data source tables on Sheet1. // To get an array of data source tables for the entire spreadsheet, // replace 'sheet' with 'ss'. const dataSourceTables = sheet.getDataSourceTables(); // Logs the last completed data execution time on the first data source table. console.log(dataSourceTables[0].getStatus().getLastExecutionTime());
Retornar
Data
: uma lista de tabelas de origem de dados.
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 Developer Metadata()
Receba todos os metadados do desenvolvedor associados a esta página.
// 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 a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Adds developer metadata for testing. sheet.addDeveloperMetadata('CITY', 'PARIS'); // Gets all the developer metadata for the sheet. const developerMetaDataList = sheet.getDeveloperMetadata(); // Logs the developer metadata to the console. for (const developerMetaData of developerMetaDataList) { console.log(developerMetaData.getKey()); }
Retornar
Developer
: os metadados do desenvolvedor associados a esta página.
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 Drawings()
Retorna uma matriz de desenhos na página.
// 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 a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets all the drawings from the sheet. const allDrawings = sheet.getDrawings(); // Logs the number of drawings present on the sheet. console.log(allDrawings.length);
Retornar
Drawing[]
: a lista de desenhos nesta página.
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 Filter()
Retorna o filtro nesta página ou null
se não houver um filtro.
// Gets the filter on the active sheet. const ss = SpreadsheetApp.getActiveSheet(); const filter = ss.getFilter();
Retornar
Filter
: o filtro.
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 Form Url()
Retorna o URL do formulário que envia as respostas para essa página ou null
se ela
não tiver um formulário associado. Gera uma exceção se o usuário não tiver permissão para editar
a planilha.
const sheet = SpreadsheetApp.getActiveSheet(); const url = sheet.getFormUrl();
Retornar
String
: o URL do formulário que coloca as respostas na planilha ou null
se a planilha não tiver um formulário associado.
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 Frozen Columns()
Retorna o número de colunas congeladas.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; Logger.log('Number of frozen columns: %s', sheet.getFrozenColumns());
Retornar
Integer
: o número de colunas congeladas
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 Frozen Rows()
Retorna o número de linhas congeladas.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; Logger.log('Number of frozen rows: %s', sheet.getFrozenRows());
Retornar
Integer
: o número de linhas congeladas
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 Images()
Retorna todas as imagens fora da grade na página.
// Opens the spreadsheet file by its URL. If you created your script from within // a Google Sheets spreadsheet, you can use // SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl( 'https://docs.google.com/spreadsheets/d/abc123456/edit', ); // Gets Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets the over-the-grid images from Sheet1. // To get the over-the-grid images from the entire spreadsheet, use // ss.getImages() instead. const images = sheet.getImages(); // For each image, logs the anchor cell in A1 notation. for (const image of images) { console.log(image.getAnchorCell().getA1Notation()); }
Retornar
Over
: uma matriz de imagens sobre a grade.
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 Index()
Consegue a posição da planilha na planilha pai. Começa em 1.
const ss = SpreadsheetApp.getActiveSpreadsheet(); // Note that the JavaScript index is 0, but this logs 1 const sheet = ss.getSheets()[0]; // ... because spreadsheets are 1-indexed Logger.log(sheet.getIndex());
Retornar
Integer
: a posição da planilha na planilha pai.
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 Last Column()
Retorna a posição da última coluna com conteúdo.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // This logs the value in the very last cell of this sheet const lastRow = sheet.getLastRow(); const lastColumn = sheet.getLastColumn(); const lastCell = sheet.getRange(lastRow, lastColumn); Logger.log(lastCell.getValue());
Retornar
Integer
: a última coluna da planilha que contém conteúdo
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 Last Row()
Retorna a posição da última linha com conteúdo.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // This logs the value in the very last cell of this sheet const lastRow = sheet.getLastRow(); const lastColumn = sheet.getLastColumn(); const lastCell = sheet.getRange(lastRow, lastColumn); Logger.log(lastCell.getValue());
Retornar
Integer
: a última linha da página que contém conteúdo
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 Max Columns()
Retorna o número atual de colunas na planilha, independentemente do conteúdo.
// This example assumes there is a sheet named "first" const ss = SpreadsheetApp.getActiveSpreadsheet(); const first = ss.getSheetByName('first'); Logger.log(first.getMaxColumns());
Retornar
Integer
: a largura máxima da folha.
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 Max Rows()
Retorna o número atual de linhas na planilha, independentemente do conteúdo.
// This example assumes there is a sheet named "first" const ss = SpreadsheetApp.getActiveSpreadsheet(); const first = ss.getSheetByName('first'); Logger.log(first.getMaxRows());
Retornar
Integer
: a altura máxima da folha.
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 Name()
Retorna o nome da planilha.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; Logger.log(sheet.getName());
Retornar
String
: o nome 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
get Named Ranges()
Recebe todos os intervalos nomeados nesta página.
// The code below logs the name of the first named range. const namedRanges = SpreadsheetApp.getActiveSheet().getNamedRanges(); if (namedRanges.length > 1) { Logger.log(namedRanges[0].getName()); }
Retornar
Named
: uma matriz de todos os intervalos nomeados na 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
get Parent()
Retorna o Spreadsheet
que contém essa planilha.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // parent is identical to ss const parent = sheet.getParent();
Retornar
Spreadsheet
: a planilha mãe.
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 Pivot Tables()
Retorna todas as tabelas dinâmicas na página.
// 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 a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets all the pivot table info for the sheet. const pivotTables = sheet.getPivotTables(); // Logs the pivot tables to the console. for (const pivotTable of pivotTables) { console.log(pivotTable.getSourceDataRange().getValues()); }
Retornar
Pivot
: as tabelas dinâmicas nesta página.
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 Protections(type)
Recebe uma matriz de objetos que representam todos os intervalos protegidos na planilha ou uma matriz de um único elemento que representa a proteção na própria planilha.
// Remove all range protections in the spreadsheet that the user has permission // to edit. const sheet = SpreadsheetApp.getActiveSheet(); const protections = sheet.getProtections(SpreadsheetApp.ProtectionType.RANGE); for (let i = 0; i < protections.length; i++) { const protection = protections[i]; if (protection.canEdit()) { protection.remove(); } }
// Remove sheet protection from the active sheet, if the user has permission to // edit it. const sheet = SpreadsheetApp.getActiveSheet(); const protection = sheet.getProtections(SpreadsheetApp.ProtectionType.SHEET)[0]; if (protection?.canEdit()) { protection.remove(); }
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
type | Protection | O tipo de área protegida, Spreadsheet ou
Spreadsheet . |
Retornar
Protection[]
: uma matriz de objetos que representam todos os intervalos protegidos na planilha ou uma matriz de um único elemento que representa a proteção na própria 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
get Range(row, column)
Retorna o intervalo com a célula superior esquerda nas coordenadas especificadas.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Passing only two arguments returns a "range" with a single cell. const range = sheet.getRange(1, 1); const values = range.getValues(); Logger.log(values[0][0]);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
row | Integer | O índice de linha da célula a ser retornada. A indexação de linha começa com 1. |
column | Integer | O índice de coluna da célula a ser retornada. A indexação de colunas começa com 1. |
Retornar
Range
: um intervalo que contém apenas esta célula.
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 Range(row, column, numRows)
Retorna o intervalo com a célula superior esquerda nas coordenadas especificadas e com o número de linhas especificado.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // When the "numRows" argument is used, only a single column of data is // returned. const range = sheet.getRange(1, 1, 3); const values = range.getValues(); // Prints 3 values from the first column, starting from row 1. for (const row in values) { for (const col in values[row]) { Logger.log(values[row][col]); } }
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
row | Integer | O índice de linha inicial do intervalo. A indexação de linhas começa com 1. |
column | Integer | O índice de colunas do intervalo. A indexação de colunas começa com 1. |
num | Integer | O número de linhas que serão retornadas. |
Retornar
Range
: um intervalo que contém uma única coluna de dados com o número de linhas 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.currentonly
-
https://www.googleapis.com/auth/spreadsheets
get Range(row, column, numRows, numColumns)
Retorna o intervalo com a célula superior esquerda nas coordenadas especificadas com o número de linhas e colunas especificado.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange(1, 1, 3, 3); const values = range.getValues(); // Print values from a 3x3 box. for (const row in values) { for (const col in values[row]) { Logger.log(values[row][col]); } }
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
row | Integer | O índice de linha inicial do intervalo. A indexação de linhas começa com 1. |
column | Integer | O índice de coluna inicial do intervalo. A indexação de colunas começa com 1. |
num | Integer | O número de linhas que serão retornadas. |
num | Integer | O número de colunas que serão retornadas. |
Retornar
Range
: um intervalo correspondente à área especificada.
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 Range(a1Notation)
Retorna o intervalo especificado na notação A1 ou R1C1.
// Get a range A1:D4 on sheet titled "Invoices" const ss = SpreadsheetApp.getActiveSpreadsheet(); const range = ss.getRange('Invoices!A1:D4'); // Get cell A1 on the first sheet const sheet = ss.getSheets()[0]; const cell = sheet.getRange('A1');
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
a1Notation | String | O intervalo a ser retornado, conforme especificado na notação A1 ou R1C1. |
Retornar
Range
: o alcance no local designado
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 Range List(a1Notations)
Retorna a coleção Range
que representa os intervalos na mesma planilha especificados
por uma lista não vazia de notações A1 ou R1C1.
// Get a list of ranges A1:D4, F1:H4. const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet(); const rangeList = sheet.getRangeList(['A1:D4', 'F1:H4']);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
a1Notations | String[] | A lista de intervalos a serem retornados, conforme especificado na notação A1 ou R1C1. |
Retornar
Range
: a lista de intervalos no local designado
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 Row Group(rowIndex, groupDepth)
Retorna o grupo de linhas no índice e na profundidade de grupo especificados.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // Returns the group whose control index is at row 2 and has a depth of 1, or // null if the group doesn’t exist. const rowGroup = sheet.getRowGroup(2, 1);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
row | Integer | O índice de linha do controle de grupo ou um índice dentro do grupo. |
group | Integer | A profundidade do grupo. |
Retornar
Group
: o grupo de linhas no índice e na profundidade de controle ou gera uma exceção se o grupo
não existir.
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 Row Group Control Position()
Retorna o Group
para todos os grupos de linhas na planilha.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // GroupControlTogglePosition.AFTER if the row grouping control toggle is shown // after the group. const rowGroupControlPosition = sheet.getRowGroupControlPosition();
Retornar
Group
: true
se o botão de alternância de agrupamento de linhas for mostrado após o grupo nesta página
e false
, caso contrário.
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 Row Group Depth(rowIndex)
Retorna a profundidade do grupo da linha no índice especificado.
A profundidade do grupo indica quantos grupos se sobrepõem à linha. O intervalo pode variar de zero a oito.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // 1 if there is a group over rows 1 through 3 const groupDepth = sheet.getRowGroupDepth(1);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
row | Integer | O índice da linha. |
Retornar
Integer
: a profundidade do grupo da linha no índice 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.currentonly
-
https://www.googleapis.com/auth/spreadsheets
get Row Height(rowPosition)
Recebe a altura em pixels da linha especificada.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Rows start at 1 Logger.log(sheet.getRowHeight(1));
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
row | Integer | A posição da linha a ser examinada. |
Retornar
Integer
: altura da linha em pixels
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.getActiveSpreadsheet().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 Sheet Id()
Retorna o ID da planilha representada por este objeto.
É um ID exclusivo da planilha. O ID é um número inteiro
monotônico crescente atribuído no momento da criação da planilha, independente da posição dela. Isso
é útil em conjunto com métodos como Range.copyFormatToRange(gridId, column, columnEnd, row, rowEnd)
, que usam um parâmetro grid
em vez de uma instância Sheet
.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; Logger.log(sheet.getSheetId());
Retornar
Integer
: um ID exclusivo para 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.currentonly
-
https://www.googleapis.com/auth/spreadsheets
get Sheet Name()
Retorna o nome da planilha.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; Logger.log(sheet.getSheetName());
Retornar
String
: o nome 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
get Sheet Values(startRow, startColumn, numRows, numColumns)
Retorna a grade retangular de valores para esse intervalo, começando nas coordenadas especificadas. Um valor -1 indicado como a posição da linha ou coluna é equivalente a receber a última linha ou coluna que tem dados na planilha.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // The two samples below produce the same output let values = sheet.getSheetValues(1, 1, 3, 3); Logger.log(values); const range = sheet.getRange(1, 1, 3, 3); values = range.getValues(); Logger.log(values);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
start | Integer | A posição da linha inicial. |
start | Integer | A posição da coluna inicial. |
num | Integer | O número de linhas para retornar valores. |
num | Integer | O número de colunas para retornar valores. |
Retornar
Object[][]
: uma matriz bidimensional de valores
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 Slicers()
Retorna uma matriz de seções na planilha.
// 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 a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets all slicers in the spreadsheet. const slicers = sheet.getSlicers(); // Logs the slicer titles to the console. for (const slicer of slicers) { console.log(slicer.getTitle()); }
Retornar
Slicer[]
: a lista de seções dessa 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
get Tab Color Object()
Recebe a cor da guia da página ou null
se ela não tiver cor.
// This example assumes there is a sheet named "Sheet1" const ss = SpreadsheetApp.getActiveSpreadsheet(); const first = ss.getSheetByName('Sheet1'); const color = first.getTabColorObject();
Retornar
Color
: a cor da guia da página ou null
se ela não tiver cor.
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 Type()
Retorna o tipo da planilha.
O tipo padrão de planilha é Sheet
. Uma planilha que contém um único objeto
incorporado, como um Embedded
, é uma planilha Sheet
.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; Logger.log(sheet.getType());
Retornar
Sheet
: o tipo da página.
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
has Hidden Gridlines()
Retorna true
se as linhas de grade da planilha estiverem ocultas. Caso contrário, retorna false
.
As linhas de grade ficam visíveis por padrão.
// 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 a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Checks if the spreadsheet has hidden gridelines and logs the result to the // console. console.log(sheet.hasHiddenGridlines());
Retornar
Boolean
: true
se as linhas de grade estiverem ocultas, false
caso contrário.
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
hide Column(column)
Oculta a coluna ou as colunas no intervalo especificado.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // This hides the first column let range = sheet.getRange('A1'); sheet.hideColumn(range); // This hides the first 3 columns range = sheet.getRange('A:C'); sheet.hideColumn(range);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
column | Range | O intervalo de colunas a ser ocultado. |
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
hide Columns(columnIndex)
Oculta uma única coluna no índice fornecido. Use o índice 1 para esse método.
Para ocultar mais de uma coluna usando um índice, use hide
.
Para ocultar mais de uma coluna usando um intervalo, use hide
.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Hides the first column sheet.hideColumns(1);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
column | Integer | O índice da coluna a ser oculta. |
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
hide Columns(columnIndex, numColumns)
Oculta uma ou mais colunas consecutivas a partir do índice especificado. Use o índice 1 para esse método.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Hides the first three columns sheet.hideColumns(1, 3);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
column | Integer | O índice inicial das colunas a serem ocultadas. |
num | Integer | O número de colunas a serem ocultadas. |
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
hide Row(row)
Oculta as linhas no intervalo especificado.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // This hides the first row const range = sheet.getRange('A1'); sheet.hideRow(range);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
row | Range | O intervalo de linhas a ser ocultado. |
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
hide Rows(rowIndex)
Oculta a linha no índice especificado.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Hides the first row sheet.hideRows(1);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
row | Integer | O índice da linha a ser oculta. |
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
hide Rows(rowIndex, numRows)
Oculta uma ou mais linhas consecutivas a partir do índice especificado.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Hides the first three rows sheet.hideRows(1, 3);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
row | Integer | O índice inicial das linhas a serem ocultadas. |
num | Integer | O número de linhas a serem ocultadas. |
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
hide Sheet()
Oculta esta página. Não tem efeito se a planilha já estiver oculta. Se esse método for chamado na única planilha visível, ele vai gerar uma exceção.
const sheet = SpreadsheetApp.getActiveSheet(); sheet.hideSheet();
Retornar
Sheet
: a página 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
insert Chart(chart)
Adiciona um novo gráfico a esta página.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // This creates a simple bar chart from the first three rows // of the first two columns of the spreadsheet const chart = sheet.newChart() .setChartType(Charts.ChartType.BAR) .addRange(sheet.getRange('A1:B4')) .setPosition(5, 5, 0, 0) .setOption('title', 'Dynamic Chart') .build(); sheet.insertChart(chart);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
chart | Embedded | O gráfico a ser inserido. |
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
insert Column After(afterPosition)
Insere uma coluna após a posição da coluna especificada.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // This inserts a column after the first column position sheet.insertColumnAfter(1);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
after | Integer | A coluna depois da qual a nova coluna será adicionada. |
Retornar
Sheet
: a planilha, útil para encadeamento de métodos
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
insert Column Before(beforePosition)
Insere uma coluna antes da posição da coluna especificada.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // This inserts a column in the first column position sheet.insertColumnBefore(1);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
before | Integer | A coluna antes da qual a nova coluna precisa ser adicionada. |
Retornar
Sheet
: a planilha, útil para encadeamento de métodos
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
insert Columns(columnIndex)
Insere uma coluna em branco em uma página no local especificado.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Shifts all columns by one sheet.insertColumns(1);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
column | Integer | O índice que indica onde inserir uma coluna. |
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
insert Columns(columnIndex, numColumns)
Insere uma ou mais colunas em branco consecutivas em uma planilha, começando no local especificado.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Shifts all columns by three sheet.insertColumns(1, 3);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
column | Integer | O índice que indica onde inserir uma coluna. |
num | Integer | O número de colunas a serem inseridas. |
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
insert Columns After(afterPosition, howMany)
Insere um determinado número de colunas após a posição da coluna especificada.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Inserts two columns after the first column on the first sheet of the // spreadsheet. sheet.insertColumnsAfter(1, 2);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
after | Integer | A coluna depois da qual a nova coluna será adicionada. |
how | Integer | O número de colunas a serem inseridas. |
Retornar
Sheet
: a planilha, útil para encadeamento de métodos
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
insert Columns Before(beforePosition, howMany)
Insere um número de colunas antes da posição da coluna especificada.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // This inserts five columns before the first column sheet.insertColumnsBefore(1, 5);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
before | Integer | A coluna antes da qual a nova coluna precisa ser adicionada. |
how | Integer | O número de colunas a serem inseridas. |
Retornar
Sheet
: a planilha, útil para encadeamento de métodos
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
insert Image(blobSource, column, row)
Insere um Blob
como uma imagem no documento em uma determinada linha e coluna. O tamanho da imagem é extraído do conteúdo do blob. O tamanho máximo de blob aceito é 2 MB.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const binaryData = []; // TODO(developer): Replace with your binary data. const blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName'); sheet.insertImage(blob, 1, 1);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
blob | Blob | O blob que contém o conteúdo da imagem, o tipo MIME e (opcionalmente) o nome. |
column | Integer | A posição da coluna. |
row | Integer | A posição da linha. |
Retornar
Over
: a imagem inserida.
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
insert Image(blobSource, column, row, offsetX, offsetY)
Insere um Blob
como uma imagem no documento em uma determinada linha e coluna, com um
deslocamento de pixel. O tamanho da imagem é extraído do conteúdo do blob. O tamanho máximo de blob
aceito é 2 MB.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const binaryData = []; // TODO(developer): Replace with your binary data. const blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName'); sheet.insertImage(blob, 1, 1, 10, 10);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
blob | Blob | O blob que contém o conteúdo da imagem, o tipo MIME e (opcionalmente) o nome. |
column | Integer | A posição da coluna. |
row | Integer | A posição da linha. |
offsetX | Integer | O deslocamento horizontal do canto da célula em pixels. |
offsetY | Integer | O deslocamento vertical do canto da célula em pixels. |
Retornar
Over
: a imagem inserida.
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
insert Image(url, column, row)
Insere uma imagem no documento em uma determinada linha e coluna.
O URL fornecido precisa ser acessível publicamente.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; sheet.insertImage('https://www.google.com/images/srpr/logo3w.png', 1, 1);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
url | String | É o URL da imagem. |
column | Integer | A posição da coluna da grade. |
row | Integer | A posição da linha da grade. |
Retornar
Over
: a imagem inserida.
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
insert Image(url, column, row, offsetX, offsetY)
Insere uma imagem no documento em uma determinada linha e coluna, com um deslocamento de pixel.
O URL fornecido precisa ser acessível publicamente.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; sheet.insertImage( 'https://www.google.com/images/srpr/logo3w.png', 1, 1, 10, 10, );
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
url | String | O URL da imagem. |
column | Integer | A posição da coluna. |
row | Integer | A posição da linha. |
offsetX | Integer | O deslocamento horizontal do canto da célula em pixels. |
offsetY | Integer | O deslocamento vertical do canto da célula em pixels. |
Retornar
Over
: a imagem inserida.
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
insert Row After(afterPosition)
Insere uma linha após a posição da linha especificada.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // This inserts a row after the first row position sheet.insertRowAfter(1);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
after | Integer | A linha após a qual a nova linha precisa ser adicionada. |
Retornar
Sheet
: a planilha, útil para encadeamento de métodos
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
insert Row Before(beforePosition)
Insere uma linha antes da posição da linha especificada.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // This inserts a row before the first row position sheet.insertRowBefore(1);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
before | Integer | A linha antes da qual a nova linha precisa ser adicionada. |
Retornar
Sheet
: a planilha, útil para encadeamento de métodos
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
insert Rows(rowIndex)
Insere uma linha em branco em uma página no local especificado.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Shifts all rows down by one sheet.insertRows(1);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
row | Integer | O índice que indica onde inserir uma linha. |
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
insert Rows(rowIndex, numRows)
Insere uma ou mais linhas em branco consecutivas em uma planilha, começando no local especificado.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Shifts all rows down by three sheet.insertRows(1, 3);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
row | Integer | O índice que indica onde inserir uma linha. |
num | Integer | O número de linhas a serem inseridas. |
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
insert Rows After(afterPosition, howMany)
Insere um número de linhas após a posição da linha especificada.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // This inserts five rows after the first row sheet.insertRowsAfter(1, 5);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
after | Integer | A linha depois da qual as novas linhas vão ser adicionadas. |
how | Integer | O número de linhas a serem inseridas. |
Retornar
Sheet
: a planilha, útil para encadeamento de métodos
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
insert Rows Before(beforePosition, howMany)
Insere um número de linhas antes da posição de linha especificada.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // This inserts five rows before the first row sheet.insertRowsBefore(1, 5);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
before | Integer | A linha antes da qual as novas linhas precisam ser adicionadas. |
how | Integer | O número de linhas a serem inseridas. |
Retornar
Sheet
: a planilha, útil para encadeamento de métodos
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
insert Slicer(range, anchorRowPos, anchorColPos)
Adiciona um novo seletor a esta página.
// 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 a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets the range of the sheet. const range = sheet.getRange('A1:D10'); // Inserts the slicer with a random range into the sheet. const insertSlicers = sheet.insertSlicer(range.randomize(), 1, 10); // Logs the insert slicer result to the console. console.log(insertSlicers);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
range | Range | O intervalo em que o controle de filtros é criado. |
anchor | Integer | A parte de cima do seletor está ancorada nesta linha. |
anchor | Integer | A parte de cima do seletor está ancorada nesta coluna. |
Retornar
Slicer
: o controle de filtros inserido.
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
insert Slicer(range, anchorRowPos, anchorColPos, offsetX, offsetY)
Adiciona um novo seletor a esta página.
// 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 a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets the range. const range = sheet.getRange('A1:D10'); // Inserts a slicer using the random range function. const insertSlicers = sheet.insertSlicer(range.randomize(), 1, 10, 0, 0); // Logs the insert slicer result to the console. console.log(insertSlicers);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
range | Range | O intervalo em que o controle de filtros é criado. |
anchor | Integer | A parte de cima do seletor está ancorada nesta linha. |
anchor | Integer | A parte de cima do seletor está ancorada nesta coluna. |
offsetX | Integer | O deslocamento horizontal do canto da célula em pixels. |
offsetY | Integer | O deslocamento vertical do canto da célula em pixels. |
Retornar
Slicer
: o controle de filtros inserido.
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
is Column Hidden By User(columnPosition)
Retorna se a coluna especificada está oculta pelo usuário.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Columns start at 1 Logger.log(sheet.isColumnHiddenByUser(1));
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
column | Integer | A posição da coluna a ser examinada. |
Retornar
Boolean
: true
se a coluna estiver oculta, false
, caso contrário.
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
is Right To Left()
Retorna true
se o layout da planilha for da direita para a esquerda. Retorna false
se a planilha
usar o layout padrão da esquerda para a direita.
// 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 a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Checks if a spreadsheet is ordered from right to left and logs the result to // the console. console.log(sheet.isRightToLeft());
Retornar
Boolean
: true
se for da direita para a esquerda. Caso contrário, false
.
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
is Row Hidden By Filter(rowPosition)
Retorna se a linha especificada está oculta por um filtro (não uma visualização de filtro).
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Rows start at 1 Logger.log(sheet.isRowHiddenByFilter(1));
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
row | Integer | A posição da linha a ser examinada. |
Retornar
Boolean
: true
se a linha estiver oculta, false
caso contrário.
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
is Row Hidden By User(rowPosition)
Retorna se a linha especificada está oculta pelo usuário.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Rows start at 1 Logger.log(sheet.isRowHiddenByUser(1));
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
row | Integer | A posição da linha a ser examinada. |
Retornar
Boolean
: true
se a linha estiver oculta, false
caso contrário.
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
is Sheet Hidden()
Retorna true
se a planilha estiver oculta.
const sheet = SpreadsheetApp.getActiveSheet(); if (sheet.isSheetHidden()) { // do something... }
Retornar
Boolean
: true
se a página estiver oculta, false
, caso contrário.
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
move Columns(columnSpec, destinationIndex)
Move as colunas selecionadas pelo intervalo especificado para a posição indicada pelo destination
. O column
não precisa representar exatamente uma coluna
inteira ou um grupo de colunas para ser movido. Ele seleciona todas as colunas que o intervalo abrange.
// The code below moves rows A-B to destination index 5. // This results in those columns becoming columns C-D. const sheet = SpreadsheetApp.getActiveSheet(); // Selects column A and column B to be moved. const columnSpec = sheet.getRange('A1:B1'); sheet.moveColumns(columnSpec, 5);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
column | Range | Um intervalo que abrange as colunas que precisam ser movido. |
destination | Integer | O índice para onde as colunas precisam ser movidas. Esse índice é baseado nas coordenadas antes de as colunas serem movidas. Os dados atuais são deslocados para a direita para abrir espaço para as colunas movidas, enquanto as colunas de origem são removidas da grade. Portanto, os dados podem acabar em um índice diferente do especificado originalmente. |
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
move Rows(rowSpec, destinationIndex)
Move as linhas selecionadas pelo intervalo especificado para a posição indicada pelo destination
. O row
não precisa representar exatamente uma linha inteira
ou um grupo de linhas para ser movido. Ele seleciona todas as linhas que o intervalo abrange.
// The code below moves rows 1-2 to destination index 5. // This results in those rows becoming rows 3-4. const sheet = SpreadsheetApp.getActiveSheet(); // Selects row 1 and row 2 to be moved. const rowSpec = sheet.getRange('A1:A2'); sheet.moveRows(rowSpec, 5);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
row | Range | Um intervalo que abrange as linhas que precisam ser movidas. |
destination | Integer | O índice para onde as linhas precisam ser movidas. Esse índice é baseado nas coordenadas antes de as linhas serem movidas. Os dados atuais são movidos para baixo para abrir espaço para as linhas movidas, enquanto as linhas de origem são removidas da grade. Portanto, os dados podem acabar em um índice diferente do especificado originalmente. |
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
new Chart()
Retorna um builder para criar um novo gráfico para esta página.
Este exemplo mostra como criar um novo gráfico:
const sheet = SpreadsheetApp.getActiveSheet(); const range = sheet.getRange('A1:B8'); const chartBuilder = sheet.newChart(); chartBuilder.addRange(range) .setChartType(Charts.ChartType.LINE) .setPosition(2, 2, 0, 0) .setOption('title', 'My Line Chart!'); sheet.insertChart(chartBuilder.build());
Retornar
Embedded
: um criador para criar um novo gráfico.
protect()
Cria um objeto que pode impedir que a planilha seja editada, exceto por usuários que têm
permissão. Até que o script mude a lista de editores da planilha (chamando
Protection.removeEditor(emailAddress)
, Protection.removeEditor(user)
, Protection.removeEditors(emailAddresses)
, Protection.addEditor(emailAddress)
, Protection.addEditor(user)
, Protection.addEditors(emailAddresses)
ou definindo um novo
valor para Protection.setDomainEdit(editable)
), as permissões vão refletir as da
planilha, o que significa que a planilha permanece desprotegida. Se a planilha já
estiver protegida, esse método vai retornar um objeto que representa as configurações de proteção atuais.
Uma página protegida pode incluir regiões não protegidas.
// Protect the active sheet, then remove all other users from the list of // editors. const sheet = SpreadsheetApp.getActiveSheet(); const protection = sheet.protect().setDescription('Sample protected sheet'); // Ensure the current user is an editor before removing others. Otherwise, if // the user's edit permission comes from a group, the script throws an exception // upon removing the group. const me = Session.getEffectiveUser(); protection.addEditor(me); protection.removeEditors(protection.getEditors()); if (protection.canDomainEdit()) { protection.setDomainEdit(false); }
Retornar
Protection
: um objeto que representa as configurações de proteção.
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
remove Chart(chart)
Remove um gráfico da planilha pai.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // This removes all the embedded charts from the spreadsheet const charts = sheet.getCharts(); for (const i in charts) { sheet.removeChart(charts[i]); }
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
chart | Embedded | O gráfico a ser removido. |
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 Range(range)
Define o intervalo especificado como active range
na página ativa, com
a célula superior esquerda no intervalo como current cell
.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet(); const range = sheet.getRange('A1:D4'); sheet.setActiveRange(range); const selection = sheet.getSelection(); // Current cell: A1 const currentCell = selection.getCurrentCell(); // Active Range: A1:D4 const activeRange = selection.getActiveRange();
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
range | Range | O intervalo a ser definido como ativo. |
Retornar
Range
: o intervalo recém-ativado
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 Range List(rangeList)
Define a lista especificada de intervalos como active ranges
na
folha ativa. O último intervalo na lista é definido como active range
.
const sheet = SpreadsheetApp.getActiveSheet(); const rangeList = sheet.getRangeList(['D4', 'B2:C4']); sheet.setActiveRangeList(rangeList); const selection = sheet.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 Selection(range)
Define a região de seleção ativa para esta página.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('A1:D4'); sheet.setActiveSelection(range);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
range | Range | O intervalo a ser definido como seleção ativa. |
Retornar
Range
: o intervalo recém-ativado
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 Selection(a1Notation)
Define a seleção ativa, conforme especificado na notação A1 ou R1C1.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; sheet.setActiveSelection('A1:D4');
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
a1Notation | String | O intervalo a ser definido como ativo, conforme especificado na notação A1 ou R1C1. |
Retornar
Range
: o intervalo recém-ativado
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 Column Group Control Position(position)
Define a posição do controle de grupo de colunas na planilha.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; sheet.setColumnGroupControlPosition( SpreadsheetApp.GroupControlTogglePosition.AFTER, );
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
position | Group | A posição do controle do grupo de colunas. |
Retornar
Sheet
: esta página, para encadeamento.
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 Column Width(columnPosition, width)
Define a largura da coluna especificada em pixels.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Sets the first column to a width of 200 pixels sheet.setColumnWidth(1, 200);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
column | Integer | A posição da coluna a ser definida. |
width | Integer | A largura em pixels. |
Retornar
Sheet
: a planilha, útil para encadeamento de métodos
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 Column Widths(startColumn, numColumns, width)
Define a largura das colunas especificadas em pixels.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Sets the first three columns to a width of 200 pixels sheet.setColumnWidths(1, 3, 200);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
start | Integer | A posição inicial da coluna a ser alterada. |
num | Integer | O número de colunas a serem alteradas. |
width | Integer | A largura em pixels. |
Retornar
Sheet
: esta página, para encadeamento.
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 Conditional Format Rules(rules)
Substitui todas as regras de formatação condicional na planilha pelas regras de entrada. As regras são avaliadas na ordem de entrada.
// Remove one of the existing conditional format rules. const sheet = SpreadsheetApp.getActiveSheet(); const rules = sheet.getConditionalFormatRules(); rules.splice(1, 1); // Deletes the 2nd format rule. sheet.setConditionalFormatRules(rules);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
rules | Conditional | As novas regras de formatação condicional. |
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 Current Cell(cell)
Define a célula especificada como current cell
.
Se a célula especificada estiver presente 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 especificada vai se tornar a célula atual e o intervalo ativo.
Observação:o Range
especificado precisa consistir em uma célula. Caso contrário, uma
exceção será gerada.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet(); const cell = sheet.getRange('B5'); sheet.setCurrentCell(cell); const selection = sheet.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
set Frozen Columns(columns)
Congelar o número especificado de colunas. Se for zero, nenhuma coluna será congelada.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Freezes the first column sheet.setFrozenColumns(1);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
columns | Integer | O número de colunas a serem congeladas. |
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 Frozen Rows(rows)
Congelar o número especificado de linhas. Se for zero, nenhuma linha será congelada.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Freezes the first row sheet.setFrozenRows(1);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
rows | Integer | O número de linhas a serem congeladas. |
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 Hidden Gridlines(hideGridlines)
Oculta ou mostra as linhas de grade da página.
// Opens the spreadsheet file by its URL. If you created your script from within // a Google Sheets file, you can us eSpreadsheetApp.getActiveSpreadsheet() // instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl( 'https://docs.google.com/spreadsheets/d/abc123456/edit', ); // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Hides the gridlines in the sheet. sheet.setHiddenGridlines(true);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
hide | Boolean | Se true , oculta as linhas de grade nesta página. Caso contrário, mostra as
linhas de grade. |
Retornar
Sheet
: esta página, para encadeamento.
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 Name(name)
Define o nome da planilha.
// This example assumes there is a sheet named "first" const ss = SpreadsheetApp.getActiveSpreadsheet(); const first = ss.getSheetByName('first'); first.setName('not first anymore');
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
name | String | O novo nome da planilha. |
Retornar
Sheet
: esta página, para encadeamento.
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 Right To Left(rightToLeft)
Define ou desativa o layout da página da direita para a esquerda.
// 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 a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Sets the sheet layout, so that the sheet is ordered from right to left. sheet.setRightToLeft(true);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
right | Boolean | Se true , o layout da página é definido como da direita para a esquerda, com a célula A1 no
canto superior direito. Se false , o layout da página é definido como o padrão
da esquerda para a direita, com a célula A1 no canto superior esquerdo. |
Retornar
Sheet
: esta página, para encadeamento.
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 Row Group Control Position(position)
Define a posição do controle de grupo de linhas na planilha.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; sheet.setRowGroupControlPosition( SpreadsheetApp.GroupControlTogglePosition.AFTER, );
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
position | Group | A posição do botão de controle do grupo de linhas. |
Retornar
Sheet
: esta página, para encadeamento.
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 Row Height(rowPosition, height)
Define a altura da linha em pixels. Por padrão, as linhas crescem para ajustar o conteúdo da célula. Se
você quiser forçar as linhas a uma altura especificada, use set
.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Sets the first row to a height of 200 pixels sheet.setRowHeight(1, 200);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
row | Integer | A posição da linha a ser alterada. |
height | Integer | A altura em pixels. |
Retornar
Sheet
: a planilha, útil para encadeamento de métodos.
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 Row Heights(startRow, numRows, height)
Define a altura das linhas especificadas em pixels. Por padrão, as linhas crescem para ajustar o conteúdo da célula. Se você
quiser forçar as linhas a uma altura especificada, use set
.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Sets the first three rows to a height of 20 pixels sheet.setRowHeights(1, 3, 20);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
start | Integer | A posição da linha inicial a ser alterada. |
num | Integer | O número de linhas a serem alteradas. |
height | Integer | A altura em pixels. |
Retornar
Sheet
: esta página, para encadeamento.
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 Row Heights Forced(startRow, numRows, height)
Define a altura das linhas especificadas em pixels. Por padrão, as linhas crescem para ajustar o conteúdo da célula. Quando
você usa set
, as linhas são forçadas para a altura especificada, mesmo que o
conteúdo da célula seja maior que a altura da linha.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Sets the first three rows to a height of 5 pixels. sheet.setRowHeightsForced(1, 3, 5);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
start | Integer | A posição da linha inicial a ser alterada. |
num | Integer | O número de linhas a serem alteradas. |
height | Integer | A altura em pixels. |
Retornar
Sheet
: esta página, para encadeamento.
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 Tab Color(color)
Define a cor da guia da planilha.
// This example assumes there is a sheet named "first" const ss = SpreadsheetApp.getActiveSpreadsheet(); const first = ss.getSheetByName('first'); first.setTabColor('ff0000'); // Set the color to red. first.setTabColor(null); // Unset the color.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
color | String | Um código de cor na notação CSS (como '#ffffff' ou 'white' ) ou
null para redefinir a cor da guia. |
Retornar
Sheet
: esta página, para encadeamento.
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 Tab Color Object(color)
Define a cor da guia da planilha.
// This example assumes there is a sheet named "Sheet1" const ss = SpreadsheetApp.getActiveSpreadsheet(); const first = ss.getSheetByName('Sheet1'); const color = SpreadsheetApp.newColor() .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT1) .build(); first.setTabColorObject(color); // Set the color to theme accent 1. first.setTabColorObject(null); // Unset the color.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
color | Color | A cor da guia da página a ser definida. |
Retornar
Sheet
: esta página, para encadeamento.
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
show Columns(columnIndex)
Mostra a coluna no índice fornecido.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Unhides the first column sheet.showColumns(1);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
column | Integer | O índice da coluna que será exibida. |
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
show Columns(columnIndex, numColumns)
Mostra uma ou mais colunas consecutivas a partir do índice especificado.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Unhides the first three columns sheet.showColumns(1, 3);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
column | Integer | O índice inicial das colunas a serem exibidas. |
num | Integer | O número de colunas a serem exibidas. |
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
show Rows(rowIndex)
Mostra a linha no índice especificado.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Unhides the first row sheet.showRows(1);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
row | Integer | O índice da linha a ser exibida. |
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
show Rows(rowIndex, numRows)
Mostra uma ou mais linhas consecutivas a partir do índice especificado.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Unhides the first three rows sheet.showRows(1, 3);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
row | Integer | O índice inicial das linhas a serem exibidas. |
num | Integer | O número de linhas a serem exibidas. |
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
show Sheet()
Torna a página visível. Não tem efeito se a planilha já estiver visível.
const sheet = SpreadsheetApp.getActiveSheet(); sheet.showSheet();
Retornar
Sheet
: a página 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
sort(columnPosition)
Classifica uma página por coluna, em ordem crescente.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Sorts the sheet by the first column, ascending sheet.sort(1);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
column | Integer | A coluna a ser classificada. |
Retornar
Sheet
: a planilha, útil para encadeamento de métodos
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
sort(columnPosition, ascending)
Ordena uma página por coluna. Recebe um parâmetro para especificar crescente ou decrescente.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // Sorts the sheet by the first column, descending sheet.sort(1, false);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
column | Integer | A coluna a ser classificada. |
ascending | Boolean | true para ordenações crescentes e false para decrescentes. |
Retornar
Sheet
: a planilha, útil para encadeamento de métodos
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
unhide Column(column)
Mostra a coluna no intervalo especificado.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // This unhides the first column if it was previously hidden const range = sheet.getRange('A1'); sheet.unhideColumn(range);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
column | Range | O intervalo a ser mostrado, se estiver oculto. |
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
unhide Row(row)
Mostra a linha no intervalo especificado.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // This unhides the first row if it was previously hidden const range = sheet.getRange('A1'); sheet.unhideRow(range);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
row | Range | O intervalo a ser mostrado, se estiver oculto. |
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
update Chart(chart)
Atualiza o gráfico nesta página.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // This code is going to loop through all the charts and change them to // column charts const charts = sheet.getCharts(); for (const i in charts) { const chart = charts[i]; const newChart = chart.modify().setChartType(Charts.ChartType.COLUMN).build(); sheet.updateChart(newChart); }
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
chart | Embedded | O gráfico a ser atualizado. |
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