Esta página foi traduzida pela API Cloud Translation.

Class Sheet

Acessar e modificar páginas de 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 a página.
`addDeveloperMetadata(key)`	`Sheet`	Adiciona metadados do desenvolvedor com a chave especificada à planilha.
`addDeveloperMetadata(key, visibility)`	`Sheet`	Adiciona metadados do desenvolvedor com a chave e a visibilidade especificadas à planilha.
`addDeveloperMetadata(key, value)`	`Sheet`	Adiciona metadados do desenvolvedor com a chave e o valor especificados à planilha.
`addDeveloperMetadata(key, value, visibility)`	`Sheet`	Adiciona metadados do desenvolvedor com a chave, o valor e a visibilidade especificados à planilha.
`appendRow(rowContents)`	`Sheet`	Acrescenta uma linha à parte de baixo da região de dados atual na planilha.
`asDataSourceSheet()`	`DataSourceSheet`	Retorna a planilha como um `DataSourceSheet` se ela for do tipo `SheetType.DATASOURCE`. Caso contrário, retorna `null`.
`autoResizeColumn(columnPosition)`	`Sheet`	Define a largura da coluna especificada para ajustar o conteúdo.
`autoResizeColumns(startColumn, numColumns)`	`Sheet`	Define a largura de todas as colunas a partir da posição especificada para ajustar o conteúdo delas.
`autoResizeRows(startRow, numRows)`	`Sheet`	Define a altura de todas as linhas a partir da posição especificada para ajustar o conteúdo.
`clear()`	`Sheet`	Limpa o conteúdo e as informações de formatação da planilha.
`clear(options)`	`Sheet`	Limpa o conteúdo e/ou o formato da planilha, conforme especificado nas opções avançadas.
`clearConditionalFormatRules()`	`void`	Remove todas as regras de formatação condicional da planilha.
`clearContents()`	`Sheet`	Limpa o conteúdo da planilha, preservando as informações de formatação.
`clearFormats()`	`Sheet`	Limpa a formatação da planilha, preservando o conteúdo.
`clearNotes()`	`Sheet`	Limpa todas as anotações da planilha.
`collapseAllColumnGroups()`	`Sheet`	Recolhe todos os grupos de colunas na página.
`collapseAllRowGroups()`	`Sheet`	Recolhe todos os grupos de linhas na página.
`copyTo(spreadsheet)`	`Sheet`	Copia a página para uma determinada planilha, que pode ser a mesma da origem.
`createDeveloperMetadataFinder()`	`DeveloperMetadataFinder`	Retorna um `DeveloperMetadataFinder` para encontrar metadados do desenvolvedor no escopo desta planilha.
`createTextFinder(findText)`	`TextFinder`	Cria um localizador de texto para a planilha, que pode encontrar e substituir texto nela.
`deleteColumn(columnPosition)`	`Sheet`	Exclui a coluna na posição especificada.
`deleteColumns(columnPosition, howMany)`	`void`	Exclui um número de colunas a partir da posição de coluna especificada.
`deleteRow(rowPosition)`	`Sheet`	Exclui a linha na posição especificada.
`deleteRows(rowPosition, howMany)`	`void`	Exclui um número de linhas a partir da posição de linha especificada.
`expandAllColumnGroups()`	`Sheet`	Expande todos os grupos de colunas na página.
`expandAllRowGroups()`	`Sheet`	Expande todos os grupos de linhas na página.
`expandColumnGroupsUpToDepth(groupDepth)`	`Sheet`	Expande todos os grupos de colunas até a profundidade especificada e recolhe todos os outros.
`expandRowGroupsUpToDepth(groupDepth)`	`Sheet`	Expande todos os grupos de linhas até a profundidade especificada e recolhe todos os outros.
`getActiveCell()`	`Range`	Retorna a célula ativa na planilha.
`getActiveRange()`	`Range`	Retorna o intervalo selecionado na planilha ativa ou `null` se não houver um intervalo ativo.
`getActiveRangeList()`	`RangeList`	Retorna a lista de intervalos ativos na planilha ativa ou `null` se não houver intervalos ativos.
`getBandings()`	`Banding[]`	Retorna todas as bandas nesta planilha.
`getCharts()`	`EmbeddedChart[]`	Retorna uma matriz de gráficos nesta página.
`getColumnGroup(columnIndex, groupDepth)`	`Group`	Retorna o grupo de colunas no índice e na profundidade de grupo especificados.
`getColumnGroupControlPosition()`	`GroupControlTogglePosition`	Retorna o `GroupControlTogglePosition` de todos os grupos de colunas na planilha.
`getColumnGroupDepth(columnIndex)`	`Integer`	Retorna a profundidade do grupo da coluna no índice especificado.
`getColumnWidth(columnPosition)`	`Integer`	Recebe a largura em pixels da coluna especificada.
`getConditionalFormatRules()`	`ConditionalFormatRule[]`	Recebe todas as regras de formatação condicional nesta planilha.
`getCurrentCell()`	`Range`	Retorna a célula atual na planilha ativa ou `null` se não houver uma célula atual.
`getDataRange()`	`Range`	Retorna um `Range` correspondente às dimensões em que os dados estão presentes.
`getDataSourceFormulas()`	`DataSourceFormula[]`	Recebe todas as fórmulas de fonte de dados.
`getDataSourcePivotTables()`	`DataSourcePivotTable[]`	Recebe todas as tabelas dinâmicas de fonte de dados.
`getDataSourceTables()`	`DataSourceTable[]`	Recebe todas as tabelas de fonte de dados.
`getDeveloperMetadata()`	`DeveloperMetadata[]`	Recebe todos os metadados do desenvolvedor associados a esta planilha.
`getDrawings()`	`Drawing[]`	Retorna uma matriz de desenhos na planilha.
`getFilter()`	`Filter`	Retorna o filtro nesta planilha ou `null` se não houver um.
`getFormUrl()`	`String`	Retorna o URL do formulário que envia as respostas para esta planilha ou `null` se a planilha não tiver um formulário associado.
`getFrozenColumns()`	`Integer`	Retorna o número de colunas fixas.
`getFrozenRows()`	`Integer`	Retorna o número de linhas fixadas.
`getImages()`	`OverGridImage[]`	Retorna todas as imagens sobrepostas na planilha.
`getIndex()`	`Integer`	Recebe a posição da página na planilha mãe.
`getLastColumn()`	`Integer`	Retorna a posição da última coluna com conteúdo.
`getLastRow()`	`Integer`	Retorna a posição da última linha com conteúdo.
`getMaxColumns()`	`Integer`	Retorna o número atual de colunas na planilha, independente do conteúdo.
`getMaxRows()`	`Integer`	Retorna o número atual de linhas na planilha, independente do conteúdo.
`getName()`	`String`	Retorna o nome da página.
`getNamedRanges()`	`NamedRange[]`	Recebe todos os intervalos nomeados nesta planilha.
`getParent()`	`Spreadsheet`	Retorna o `Spreadsheet` que contém essa planilha.
`getPivotTables()`	`PivotTable[]`	Retorna todas as tabelas dinâmicas na planilha.
`getProtections(type)`	`Protection[]`	Recebe uma matriz de objetos que representam todos os intervalos protegidos na planilha ou uma matriz de elemento único que representa a proteção na própria planilha.
`getRange(row, column)`	`Range`	Retorna o intervalo com a célula superior esquerda nas coordenadas especificadas.
`getRange(row, column, numRows)`	`Range`	Retorna o intervalo com a célula superior esquerda nas coordenadas fornecidas e com o número de linhas especificado.
`getRange(row, column, numRows, numColumns)`	`Range`	Retorna o intervalo com a célula superior esquerda nas coordenadas fornecidas e com o número de linhas e colunas especificado.
`getRange(a1Notation)`	`Range`	Retorna o intervalo conforme especificado na notação A1 ou R1C1.
`getRangeList(a1Notations)`	`RangeList`	Retorna a coleção `RangeList` que representa os intervalos na mesma planilha especificados por uma lista não vazia de notações A1 ou R1C1.
`getRowGroup(rowIndex, groupDepth)`	`Group`	Retorna o grupo de linhas no índice e na profundidade de grupo especificados.
`getRowGroupControlPosition()`	`GroupControlTogglePosition`	Retorna o `GroupControlTogglePosition` de todos os grupos de linhas na planilha.
`getRowGroupDepth(rowIndex)`	`Integer`	Retorna a profundidade do grupo da linha no índice especificado.
`getRowHeight(rowPosition)`	`Integer`	Recebe a altura em pixels da linha especificada.
`getSelection()`	`Selection`	Retorna o `Selection` atual na planilha.
`getSheetId()`	`Integer`	Retorna o ID da planilha representada por este objeto.
`getSheetName()`	`String`	Retorna o nome da página.
`getSheetValues(startRow, startColumn, numRows, numColumns)`	`Object[][]`	Retorna a grade retangular de valores para esse intervalo, começando nas coordenadas especificadas.
`getSlicers()`	`Slicer[]`	Retorna uma matriz de segmentações na planilha.
`getTabColorObject()`	`Color`	Recebe a cor da guia da planilha ou `null` se ela não tiver uma cor.
`getType()`	`SheetType`	Retorna o tipo da planilha.
`hasHiddenGridlines()`	`Boolean`	Retorna `true` se as linhas de grade da planilha estiverem ocultas. Caso contrário, retorna `false`.
`hideColumn(column)`	`void`	Oculta a coluna ou as colunas no intervalo especificado.
`hideColumns(columnIndex)`	`void`	Oculta uma única coluna no índice especificado.
`hideColumns(columnIndex, numColumns)`	`void`	Oculta uma ou mais colunas consecutivas a partir do índice especificado.
`hideRow(row)`	`void`	Oculta as linhas no intervalo especificado.
`hideRows(rowIndex)`	`void`	Oculta a linha no índice especificado.
`hideRows(rowIndex, numRows)`	`void`	Oculta uma ou mais linhas consecutivas a partir do índice especificado.
`hideSheet()`	`Sheet`	Oculta esta página.
`insertChart(chart)`	`void`	Adiciona um novo gráfico à página.
`insertColumnAfter(afterPosition)`	`Sheet`	Insere uma coluna após a posição da coluna especificada.
`insertColumnBefore(beforePosition)`	`Sheet`	Insere uma coluna antes da posição especificada.
`insertColumns(columnIndex)`	`void`	Insere uma coluna em branco em uma planilha no local especificado.
`insertColumns(columnIndex, numColumns)`	`void`	Insere uma ou mais colunas em branco consecutivas em uma planilha a partir do local especificado.
`insertColumnsAfter(afterPosition, howMany)`	`Sheet`	Insere um determinado número de colunas após a posição de coluna especificada.
`insertColumnsBefore(beforePosition, howMany)`	`Sheet`	Insere um número de colunas antes da posição de coluna especificada.
`insertImage(blobSource, column, row)`	`OverGridImage`	Insere um `BlobSource` como uma imagem no documento em uma determinada linha e coluna.
`insertImage(blobSource, column, row, offsetX, offsetY)`	`OverGridImage`	Insere um `BlobSource` como uma imagem no documento em uma determinada linha e coluna, com um deslocamento de pixel.
`insertImage(url, column, row)`	`OverGridImage`	Insere uma imagem no documento em uma determinada linha e coluna.
`insertImage(url, column, row, offsetX, offsetY)`	`OverGridImage`	Insere uma imagem no documento em uma determinada linha e coluna, com um deslocamento de pixel.
`insertRowAfter(afterPosition)`	`Sheet`	Insere uma linha após a posição especificada.
`insertRowBefore(beforePosition)`	`Sheet`	Insere uma linha antes da posição especificada.
`insertRows(rowIndex)`	`void`	Insere uma linha em branco em uma planilha no local especificado.
`insertRows(rowIndex, numRows)`	`void`	Insere uma ou mais linhas em branco consecutivas em uma planilha a partir do local especificado.
`insertRowsAfter(afterPosition, howMany)`	`Sheet`	Insere um número de linhas após a posição de linha especificada.
`insertRowsBefore(beforePosition, howMany)`	`Sheet`	Insere um número de linhas antes da posição de linha especificada.
`insertSlicer(range, anchorRowPos, anchorColPos)`	`Slicer`	Adiciona um novo segmentador a esta página.
`insertSlicer(range, anchorRowPos, anchorColPos, offsetX, offsetY)`	`Slicer`	Adiciona um novo segmentador a esta página.
`isColumnHiddenByUser(columnPosition)`	`Boolean`	Retorna se a coluna especificada está oculta para o usuário.
`isRightToLeft()`	`Boolean`	Retorna `true` se o layout da planilha for da direita para a esquerda.
`isRowHiddenByFilter(rowPosition)`	`Boolean`	Retorna se a linha especificada está oculta por um filtro (não uma visualização de filtro).
`isRowHiddenByUser(rowPosition)`	`Boolean`	Retorna se a linha especificada está oculta para o usuário.
`isSheetHidden()`	`Boolean`	Retorna `true` se a planilha estiver oculta.
`moveColumns(columnSpec, destinationIndex)`	`void`	Move as colunas selecionadas pelo intervalo especificado para a posição indicada pelo `destinationIndex`.
`moveRows(rowSpec, destinationIndex)`	`void`	Move as linhas selecionadas pelo intervalo especificado para a posição indicada pelo `destinationIndex`.
`newChart()`	`EmbeddedChartBuilder`	Retorna um builder para criar um novo gráfico para esta planilha.
`protect()`	`Protection`	Cria um objeto que pode proteger a planilha contra edições, exceto por usuários que têm permissão.
`removeChart(chart)`	`void`	Remove um gráfico da planilha principal.
`setActiveRange(range)`	`Range`	Define o intervalo especificado como o `active range` na planilha ativa, com a célula superior esquerda no intervalo como o `current cell`.
`setActiveRangeList(rangeList)`	`RangeList`	Define a lista especificada de intervalos como o `active ranges` na página ativa.
`setActiveSelection(range)`	`Range`	Define a região de seleção ativa para esta planilha.
`setActiveSelection(a1Notation)`	`Range`	Define a seleção ativa, conforme especificado na notação A1 ou R1C1.
`setColumnGroupControlPosition(position)`	`Sheet`	Define a posição da alternância de controle do grupo de colunas na planilha.
`setColumnWidth(columnPosition, width)`	`Sheet`	Define a largura da coluna especificada em pixels.
`setColumnWidths(startColumn, numColumns, width)`	`Sheet`	Define a largura das colunas especificadas em pixels.
`setConditionalFormatRules(rules)`	`void`	Substitui todas as regras de formatação condicional atuais na planilha pelas regras de entrada.
`setCurrentCell(cell)`	`Range`	Define a célula especificada como `current cell`.
`setFrozenColumns(columns)`	`void`	Congela o número de colunas especificado.
`setFrozenRows(rows)`	`void`	Congela o número de linhas especificado.
`setHiddenGridlines(hideGridlines)`	`Sheet`	Oculta ou mostra as linhas de grade da página.
`setName(name)`	`Sheet`	Define o nome da página.
`setRightToLeft(rightToLeft)`	`Sheet`	Define ou remove o layout da página da direita para a esquerda.
`setRowGroupControlPosition(position)`	`Sheet`	Define a posição da opção de ativar/desativar o controle do grupo de linhas na planilha.
`setRowHeight(rowPosition, height)`	`Sheet`	Define a altura da linha especificada em pixels.
`setRowHeights(startRow, numRows, height)`	`Sheet`	Define a altura das linhas especificadas em pixels.
`setRowHeightsForced(startRow, numRows, height)`	`Sheet`	Define a altura das linhas especificadas em pixels.
`setTabColor(color)`	`Sheet`	Define a cor da guia da planilha.
`setTabColorObject(color)`	`Sheet`	Define a cor da guia da planilha.
`showColumns(columnIndex)`	`void`	Mostra a coluna no índice especificado.
`showColumns(columnIndex, numColumns)`	`void`	Mostra uma ou mais colunas consecutivas a partir do índice especificado.
`showRows(rowIndex)`	`void`	Mostra a linha no índice especificado.
`showRows(rowIndex, numRows)`	`void`	Mostra uma ou mais linhas consecutivas a partir do índice especificado.
`showSheet()`	`Sheet`	Torna a planilha visível.
`sort(columnPosition)`	`Sheet`	Classifica uma página por coluna, em ordem crescente.
`sort(columnPosition, ascending)`	`Sheet`	Classifica uma página por coluna.
`unhideColumn(column)`	`void`	Mostra a coluna no intervalo especificado.
`unhideRow(row)`	`void`	Mostra a linha no intervalo especificado.
`updateChart(chart)`	`void`	Atualiza o gráfico nesta planilha.

Métodos obsoletos

Método	Tipo de retorno	Breve descrição
`getSheetProtection()`	`PageProtection`	Retorna uma instância `PageProtection` que descreve as permissões da planilha atual.
`getTabColor()`	`String`	Recebe a cor da guia da planilha ou `null` se ela não tiver uma cor.
`setSheetProtection(permissions)`	`void`	Define as permissões da planilha atual.

Documentação detalhada

`activate()`

Ativa a página. Não altera a planilha em si, apenas a noção da planilha ativa do elemento pai.

// This example assumes there is a sheet named "first"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('first');
first.activate();

Retornar

Sheet: a planilha recém-ativada.

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

`addDeveloperMetadata(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`	`DeveloperMetadataVisibility`	A visibilidade dos novos metadados do desenvolvedor.

Retornar

Sheet: esta 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

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

`addDeveloperMetadata(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`	`DeveloperMetadataVisibility`	A visibilidade dos novos metadados do desenvolvedor.

Retornar

Sheet: esta 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

`appendRow(rowContents)`

Acrescenta 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
`rowContents`	`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

`asDataSourceSheet()`

Retorna a planilha como um DataSourceSheet se ela for do tipo SheetType.DATASOURCE. Caso contrário, retorna 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

DataSourceSheet: 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

`autoResizeColumn(columnPosition)`

Define a largura da coluna especificada 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
`columnPosition`	`Integer`	A posição da coluna especificada 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

`autoResizeColumns(startColumn, numColumns)`

Define a largura de todas as colunas a partir da posição especificada para ajustar o conteúdo delas.

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
`startColumn`	`Integer`	A coluna inicial a ser redimensionada automaticamente.
`numColumns`	`Integer`	O número de colunas a serem redimensionadas automaticamente.

Retornar

Sheet: esta 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

`autoResizeRows(startRow, numRows)`

Define a altura de todas as linhas a partir da posição 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
`startRow`	`Integer`	A linha inicial a ser redimensionada automaticamente.
`numRows`	`Integer`	O número de linhas a serem redimensionadas automaticamente.

Retornar

Sheet: esta 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

`clear()`

Limpa o conteúdo e as informações de formatação da planilha.

// 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 o conteúdo e/ou o formato da planilha, conforme especificado nas opções avançadas.

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
`contentsOnly`	`Boolean`	Se o conteúdo será removido.
`formatOnly`	`Boolean`	Se o formato deve ser limpo.

Retornar

Sheet: esta 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

`clearConditionalFormatRules()`

Remove todas as regras de formatação condicional da planilha. Equivalente a chamar setConditionalFormatRules(rules) 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

`clearContents()`

Limpa o conteúdo da planilha, 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 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

`clearFormats()`

Limpa a formatação da planilha, preservando o conteúdo.

A formatação se refere a 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 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

`clearNotes()`

Limpa todas as anotações da planilha.

// This example assumes there is a sheet named "first"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('first');
first.clearNotes();

Retornar

Sheet: esta 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

`collapseAllColumnGroups()`

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

`collapseAllRowGroups()`

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

`copyTo(spreadsheet)`

Copia a página para uma determinada planilha, que pode ser a mesma da origem. A planilha 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 em que a cópia será feita, 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

`createDeveloperMetadataFinder()`

Retorna um DeveloperMetadataFinder para encontrar metadados do desenvolvedor no escopo desta planilha. Os metadados estão no escopo de uma planilha específica se estiverem associados a ela ou a uma linha, coluna ou intervalo nessa 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 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

DeveloperMetadataFinder: um localizador de metadados do desenvolvedor para pesquisar metadados no escopo desta planilha.

`createTextFinder(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
`findText`	`String`	O texto a ser pesquisado.

Retornar

TextFinder: o TextFinder da planilha.

`deleteColumn(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
`columnPosition`	`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

`deleteColumns(columnPosition, howMany)`

Exclui um número de colunas a partir da posição de coluna 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
`columnPosition`	`Integer`	A posição da primeira coluna a ser excluída.
`howMany`	`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

`deleteRow(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
`rowPosition`	`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

`deleteRows(rowPosition, howMany)`

Exclui um número de linhas a partir da posição de linha 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
`rowPosition`	`Integer`	A posição da primeira linha a ser excluída.
`howMany`	`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

`expandAllColumnGroups()`

Expande todos os grupos de colunas na página. Esse método exige 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 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

`expandAllRowGroups()`

Expande todos os grupos de linhas na página. Esse método exige 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 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

`expandColumnGroupsUpToDepth(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
`groupDepth`	`Integer`	A profundidade do grupo até a qual os grupos de colunas serão expandidos.

Retornar

Sheet: esta 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

`expandRowGroupsUpToDepth(groupDepth)`

Expande todos os grupos de linhas até a profundidade especificada e recolhe 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
`groupDepth`	`Integer`	A profundidade do grupo até a qual os grupos de linhas serão expandidos.

Retornar

Sheet: esta 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

`getActiveCell()`

Retorna a célula ativa na planilha.

Observação:é preferível usar getCurrentCell(), que retorna a célula destacada 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

`getActiveRange()`

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

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.

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

setActiveRange(range)

`getActiveRangeList()`

Retorna a lista de intervalos ativos na planilha ativa ou null se não houver intervalos ativos.

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

const sheet = SpreadsheetApp.getActiveSheet();
// Returns the list of active ranges.
const activeRangeList = sheet.getActiveRangeList();

Retornar

RangeList: a lista de intervalos ativos.

Autorização

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

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

Consulte também

setActiveRangeList(rangeList)

`getBandings()`

Retorna todas as bandas nesta 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 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 nesta 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

`getCharts()`

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

EmbeddedChart[]: 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

`getColumnGroup(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
`columnIndex`	`Integer`	O índice da coluna da alternância de controle do grupo ou um índice dentro do grupo.
`groupDepth`	`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

`getColumnGroupControlPosition()`

Retorna o GroupControlTogglePosition de 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

GroupControlTogglePosition: true se a alternância de controle de agrupamento de colunas for mostrada 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

`getColumnGroupDepth(columnIndex)`

Retorna a profundidade do grupo da coluna no índice especificado.

A profundidade do grupo indica quantos grupos se sobrepõem à coluna. Esse valor pode variar entre zero e 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
`columnIndex`	`Integer`	O índice da coluna.

Retornar

Integer: a profundidade do grupo da coluna no índice determinado.

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

`getColumnWidth(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
`columnPosition`	`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

`getConditionalFormatRules()`

Recebe todas as regras de formatação condicional nesta planilha.

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

ConditionalFormatRule[]: 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

`getCurrentCell()`

Retorna a célula atual na planilha ativa ou null se não houver uma célula atual. A célula atual é aquela que está em 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

`getDataRange()`

Retorna um Range correspondente às dimensões em que os dados estão presentes.

Isso é funcionalmente equivalente a criar um intervalo delimitado 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

`getDataSourceFormulas()`

Recebe todas as fórmulas de 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

DataSourceFormula[]: uma lista de fórmulas de 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

`getDataSourcePivotTables()`

Recebe todas as tabelas dinâmicas de 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

DataSourcePivotTable[]: uma lista de tabelas dinâmicas 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

`getDataSourceTables()`

Recebe todas as tabelas de 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

DataSourceTable[]: uma lista de tabelas 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

`getDeveloperMetadata()`

Recebe todos os metadados do desenvolvedor associados a esta 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 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

DeveloperMetadata[]: os metadados do desenvolvedor associados a esta 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

`getDrawings()`

Retorna uma matriz de desenhos 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 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

`getFilter()`

Retorna o filtro nesta planilha ou null se não houver um.

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

`getFormUrl()`

Retorna o URL do formulário que envia as respostas para esta planilha ou null se a planilha 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 nesta planilha ou null se esta 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

`getFrozenColumns()`

Retorna o número de colunas fixas.

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

`getFrozenRows()`

Retorna o número de linhas fixadas.

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 fixas.

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

`getImages()`

Retorna todas as imagens sobrepostas na planilha.

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

OverGridImage[]: 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

`getIndex()`

Recebe a posição da página na planilha mãe. 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 página na 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

`getLastColumn()`

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

`getLastRow()`

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

`getMaxColumns()`

Retorna o número atual de colunas na planilha, independente 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 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

`getMaxRows()`

Retorna o número atual de linhas na planilha, independente 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 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

`getName()`

Retorna o nome da página.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
Logger.log(sheet.getName());

Retornar

String: o nome 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

`getNamedRanges()`

Recebe todos os intervalos nomeados nesta planilha.

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

NamedRange[]: 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

`getParent()`

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 principal.

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

`getPivotTables()`

Retorna todas as tabelas dinâmicas 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 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

PivotTable[]: 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

`getProtections(type)`

Recebe uma matriz de objetos que representam todos os intervalos protegidos na planilha ou uma matriz de elemento único 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`	`ProtectionType`	O tipo de área protegida, `SpreadsheetApp.ProtectionType.RANGE` ou `SpreadsheetApp.ProtectionType.SHEET`.

Retornar

Protection[]: uma matriz de objetos que representa todos os intervalos protegidos na planilha ou uma matriz de elemento único 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

`getRange(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 da linha da célula a ser retornada. A indexação de linhas começa com 1.
`column`	`Integer`	O índice da coluna da célula a ser retornada. A indexação de colunas começa com 1.

Retornar

Range: um intervalo que contém apenas essa 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

`getRange(row, column, numRows)`

Retorna o intervalo com a célula superior esquerda nas coordenadas fornecidas 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 da linha inicial do intervalo. A indexação de linhas começa com 1.
`column`	`Integer`	O índice da coluna do intervalo. A indexação de colunas começa com 1.
`numRows`	`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

`getRange(row, column, numRows, numColumns)`

Retorna o intervalo com a célula superior esquerda nas coordenadas fornecidas e 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 da linha inicial do intervalo. A indexação de linhas começa com 1.
`column`	`Integer`	O índice da coluna inicial do intervalo. A indexação de colunas começa com 1.
`numRows`	`Integer`	O número de linhas que serão retornadas.
`numColumns`	`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

`getRange(a1Notation)`

Retorna o intervalo conforme 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 intervalo 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

`getRangeList(a1Notations)`

Retorna a coleção RangeList 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

RangeList: 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

`getRowGroup(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
`rowIndex`	`Integer`	O índice da linha da alternância de controle do grupo ou um índice dentro do grupo.
`groupDepth`	`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

`getRowGroupControlPosition()`

Retorna o GroupControlTogglePosition de 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

GroupControlTogglePosition: true se o botão de alternância de controle de agrupamento de linhas 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

`getRowGroupDepth(rowIndex)`

Retorna a profundidade do grupo da linha no índice especificado.

A profundidade do grupo indica quantos grupos se sobrepõem à linha. Esse valor pode variar entre zero e 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
`rowIndex`	`Integer`	O índice da linha.

Retornar

Integer: a profundidade do grupo da linha no índice determinado.

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

`getRowHeight(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
`rowPosition`	`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

`getSelection()`

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

`getSheetId()`

Retorna o ID da planilha representada por este objeto.

É um ID da página exclusivo da planilha. O ID é um número inteiro monotonicamente crescente atribuído no momento da criação da planilha e 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 gridId 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 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

`getSheetName()`

Retorna o nome da página.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

Logger.log(sheet.getSheetName());

Retornar

String: o nome 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

`getSheetValues(startRow, startColumn, numRows, numColumns)`

Retorna a grade retangular de valores para esse intervalo, começando nas coordenadas especificadas. Um valor -1 fornecido 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
`startRow`	`Integer`	A posição da linha inicial.
`startColumn`	`Integer`	A posição da coluna inicial.
`numRows`	`Integer`	O número de linhas para retornar valores.
`numColumns`	`Integer`	O número de colunas para as quais os valores serão retornados.

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

`getSlicers()`

Retorna uma matriz de segmentaçõ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 segmentações nesta 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

`getTabColorObject()`

Recebe a cor da guia da planilha ou null se ela não tiver uma 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 a guia 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

`getType()`

Retorna o tipo da planilha.

O tipo de página padrão é SheetType.GRID. Uma página que contém um único objeto incorporado, como um EmbeddedChart, é uma página SheetType.OBJECT.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
Logger.log(sheet.getType());

Retornar

SheetType: o tipo 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

`hasHiddenGridlines()`

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

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

`hideColumns(columnIndex)`

Oculta uma única coluna no índice especificado. Use o índice 1 para esse método.

Para ocultar mais de uma coluna usando um índice, use hideColumns(columnIndex, numColumns).

Para ocultar mais de uma coluna usando um intervalo, use hideColumn().

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Hides the first column
sheet.hideColumns(1);

Parâmetros

Nome	Tipo	Descrição
`columnIndex`	`Integer`	O índice da coluna a ser ocultada.

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

`hideColumns(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
`columnIndex`	`Integer`	O índice inicial das colunas a serem ocultadas.
`numColumns`	`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

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

`hideRows(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
`rowIndex`	`Integer`	O índice da linha a ser ocultada.

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

`hideRows(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
`rowIndex`	`Integer`	O índice inicial das linhas a serem ocultadas.
`numRows`	`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

`hideSheet()`

Oculta esta página. Não terá 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

`insertChart(chart)`

Adiciona um novo gráfico à 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`	`EmbeddedChart`	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

`insertColumnAfter(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
`afterPosition`	`Integer`	A coluna após a qual a nova coluna deve 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

`insertColumnBefore(beforePosition)`

Insere uma coluna antes da posição 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
`beforePosition`	`Integer`	A coluna antes da qual a nova coluna deve 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

`insertColumns(columnIndex)`

Insere uma coluna em branco em uma planilha 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
`columnIndex`	`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

`insertColumns(columnIndex, numColumns)`

Insere uma ou mais colunas em branco consecutivas em uma planilha a partir do 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
`columnIndex`	`Integer`	O índice que indica onde inserir uma coluna.
`numColumns`	`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

`insertColumnsAfter(afterPosition, howMany)`

Insere um determinado número de colunas após a posição de 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
`afterPosition`	`Integer`	A coluna após a qual a nova coluna deve ser adicionada.
`howMany`	`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

`insertColumnsBefore(beforePosition, howMany)`

Insere um número de colunas antes da posição de 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
`beforePosition`	`Integer`	A coluna antes da qual a nova coluna deve ser adicionada.
`howMany`	`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

`insertImage(blobSource, column, row)`

Insere um BlobSource 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 permitido é 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
`blobSource`	`BlobSource`	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

OverGridImage: 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

`insertImage(blobSource, column, row, offsetX, offsetY)`

Insere um BlobSource como uma imagem no documento em uma determinada linha e coluna, com um deslocamento de pixel. O tamanho da imagem é recuperado 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
`blobSource`	`BlobSource`	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

OverGridImage: 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

`insertImage(url, column, row)`

Insere uma imagem no documento em uma determinada linha e coluna.

O URL fornecido precisa estar acessível ao público.

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

OverGridImage: 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

`insertImage(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 estar acessível ao público.

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

OverGridImage: 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

`insertRowAfter(afterPosition)`

Insere uma linha após a posição 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
`afterPosition`	`Integer`	A linha após a qual a nova linha deve 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

`insertRowBefore(beforePosition)`

Insere uma linha antes da posição 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
`beforePosition`	`Integer`	A linha antes da qual a nova linha deve 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

`insertRows(rowIndex)`

Insere uma linha em branco em uma planilha 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
`rowIndex`	`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

`insertRows(rowIndex, numRows)`

Insere uma ou mais linhas em branco consecutivas em uma planilha a partir do 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
`rowIndex`	`Integer`	O índice que indica onde inserir uma linha.
`numRows`	`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

`insertRowsAfter(afterPosition, howMany)`

Insere um número de linhas após a posição de 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
`afterPosition`	`Integer`	A linha após a qual as novas linhas devem ser adicionadas.
`howMany`	`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

`insertRowsBefore(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
`beforePosition`	`Integer`	A linha antes da qual as novas linhas devem ser adicionadas.
`howMany`	`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

`insertSlicer(range, anchorRowPos, anchorColPos)`

Adiciona um novo segmentador 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.
`anchorRowPos`	`Integer`	A parte superior do segmentador fica ancorada nessa linha.
`anchorColPos`	`Integer`	A parte de cima do segmentador está ancorada nessa coluna.

Retornar

Slicer: o controle de filtros recém-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

`insertSlicer(range, anchorRowPos, anchorColPos, offsetX, offsetY)`

Adiciona um novo segmentador 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.
`anchorRowPos`	`Integer`	A parte superior do segmentador fica ancorada nessa linha.
`anchorColPos`	`Integer`	A parte de cima do segmentador está ancorada nessa 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 recém-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

`isColumnHiddenByUser(columnPosition)`

Retorna se a coluna especificada está oculta para o 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
`columnPosition`	`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

`isRightToLeft()`

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 da direita para a esquerda; 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

`isRowHiddenByFilter(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
`rowPosition`	`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

`isRowHiddenByUser(rowPosition)`

Retorna se a linha especificada está oculta para o 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
`rowPosition`	`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

`isSheetHidden()`

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

`moveColumns(columnSpec, destinationIndex)`

Move as colunas selecionadas pelo intervalo especificado para a posição indicada pelo destinationIndex. O columnSpec não precisa representar exatamente uma coluna ou um grupo de colunas inteiro para ser movido. Ele seleciona todas as colunas abrangidas pelo intervalo.

// 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
`columnSpec`	`Range`	Um intervalo que abrange as colunas a serem movidas.
`destinationIndex`	`Integer`	O índice para onde as colunas devem ser movidas. Esse índice é baseado nas coordenadas antes da movimentação das colunas. Os dados atuais são movidos 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

`moveRows(rowSpec, destinationIndex)`

Move as linhas selecionadas pelo intervalo especificado para a posição indicada pelo destinationIndex. O rowSpec não precisa representar exatamente uma linha inteira ou um grupo de linhas para ser movido. Ele seleciona todas as linhas abrangidas pelo intervalo.

// 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
`rowSpec`	`Range`	Um intervalo que abrange as linhas a serem movidas.
`destinationIndex`	`Integer`	O índice para onde as linhas devem ser movidas. Esse índice é baseado nas coordenadas antes da movimentação das linhas. 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

`newChart()`

Retorna um builder para criar um novo gráfico para esta planilha.

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

EmbeddedChartBuilder: um criador para criar um novo gráfico.

`protect()`

Cria um objeto que pode proteger a planilha contra edições, 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 refletem as da própria planilha, o que significa que ela 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

`removeChart(chart)`

Remove um gráfico da planilha principal.

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`	`EmbeddedChart`	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

`setActiveRange(range)`

Define o intervalo especificado como o active range na planilha ativa, com a célula superior esquerda no intervalo como o 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 o intervalo 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

`setActiveRangeList(rangeList)`

Define a lista especificada de intervalos como o active ranges na página ativa. O último intervalo na lista é definido como o 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
`rangeList`	`RangeList`	A lista de intervalos a serem selecionados.

Retornar

RangeList: a lista de intervalos recém-selecionada.

Autorização

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

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

`setActiveSelection(range)`

Define a região de seleção ativa para esta planilha.

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

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

`setColumnGroupControlPosition(position)`

Define a posição da alternância de controle do grupo de colunas na planilha.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
sheet.setColumnGroupControlPosition(
    SpreadsheetApp.GroupControlTogglePosition.AFTER,
);

Parâmetros

Nome	Tipo	Descrição
`position`	`GroupControlTogglePosition`	A posição do botão de alternância do controle do grupo de colunas.

Retornar

Sheet: esta 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

`setColumnWidth(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
`columnPosition`	`Integer`	A posição da coluna especificada a ser definida.
`width`	`Integer`	A largura em pixels a ser definida.

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

`setColumnWidths(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
`startColumn`	`Integer`	A posição da coluna inicial a ser alterada.
`numColumns`	`Integer`	O número de colunas a serem alteradas.
`width`	`Integer`	A largura em pixels a ser definida.

Retornar

Sheet: esta 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

`setConditionalFormatRules(rules)`

Substitui todas as regras de formatação condicional atuais na planilha pelas regras de entrada. As regras são avaliadas na ordem em que são inseridas.

// 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`	`ConditionalFormatRule[]`	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

`setCurrentCell(cell)`

Define a célula especificada como current cell.

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

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

Observação:o Range especificado precisa consistir em uma célula. Caso contrário, 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

`setFrozenColumns(columns)`

Congela o número de colunas especificado. 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

`setFrozenRows(rows)`

Congela o número de linhas especificado. 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

`setHiddenGridlines(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
`hideGridlines`	`Boolean`	Se `true`, oculte as linhas de grade nesta página. Caso contrário, mostre as linhas de grade.

Retornar

Sheet: esta 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

`setName(name)`

Define o nome da página.

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

`setRightToLeft(rightToLeft)`

Define ou remove 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
`rightToLeft`	`Boolean`	Se `true`, o layout da página será definido como da direita para a esquerda, com a célula A1 no canto superior direito. Se `false`, o layout da planilha será definido como o padrão da esquerda para a direita, com a célula A1 no canto superior esquerdo.

Retornar

Sheet: esta 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

`setRowGroupControlPosition(position)`

Define a posição da opção de ativar/desativar o controle do grupo de linhas na planilha.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
sheet.setRowGroupControlPosition(
    SpreadsheetApp.GroupControlTogglePosition.AFTER,
);

Parâmetros

Nome	Tipo	Descrição
`position`	`GroupControlTogglePosition`	A posição da alternância de controle do grupo de linhas.

Retornar

Sheet: esta 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

`setRowHeight(rowPosition, height)`

Define a altura da linha especificada em pixels. Por padrão, as linhas aumentam para ajustar o conteúdo das células. Se você quiser forçar as linhas a uma altura especificada, use setRowHeightsForced(startRow, numRows, height).

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
`rowPosition`	`Integer`	A posição da linha a ser mudada.
`height`	`Integer`	A altura em pixels a ser definida.

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

`setRowHeights(startRow, numRows, height)`

Define a altura das linhas especificadas em pixels. Por padrão, as linhas aumentam para ajustar o conteúdo das células. Se você quiser forçar as linhas a uma altura especificada, use setRowHeightsForced(startRow, numRows, height).

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
`startRow`	`Integer`	A posição da linha inicial a ser mudada.
`numRows`	`Integer`	O número de linhas a serem alteradas.
`height`	`Integer`	A altura em pixels a ser definida.

Retornar

Sheet: esta 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

`setRowHeightsForced(startRow, numRows, height)`

Define a altura das linhas especificadas em pixels. Por padrão, as linhas aumentam para ajustar o conteúdo das células. Quando você usa setRowHeightsForced, as linhas são forçadas à 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
`startRow`	`Integer`	A posição da linha inicial a ser mudada.
`numRows`	`Integer`	O número de linhas a serem alteradas.
`height`	`Integer`	A altura em pixels a ser definida.

Retornar

Sheet: esta 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

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

`setTabColorObject(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 planilha a ser definida.

Retornar

Sheet: esta 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

`showColumns(columnIndex)`

Mostra a coluna no índice especificado.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Unhides the first column
sheet.showColumns(1);

Parâmetros

Nome	Tipo	Descrição
`columnIndex`	`Integer`	O índice da coluna a ser mostrada.

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

`showColumns(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
`columnIndex`	`Integer`	O índice inicial das colunas a serem mostradas.
`numColumns`	`Integer`	O número de colunas a serem mostradas.

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

`showRows(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
`rowIndex`	`Integer`	O índice da linha a ser mostrada.

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

`showRows(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
`rowIndex`	`Integer`	O índice inicial das linhas a serem mostradas.
`numRows`	`Integer`	O número de linhas a serem mostradas.

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

`showSheet()`

Torna a planilha visível. Não tem efeito se a página 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
`columnPosition`	`Integer`	A coluna a ser usada para classificação.

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

Classifica uma página por coluna. Usa 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
`columnPosition`	`Integer`	A coluna a ser usada para classificação.
`ascending`	`Boolean`	`true` para classificaçõ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

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

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

`updateChart(chart)`

Atualiza o gráfico nesta planilha.

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`	`EmbeddedChart`	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

Métodos obsoletos

`getSheetProtection()`

Obsoleto. Para planilhas criadas na versão mais recente das Planilhas Google, use getProtections(type), que retorna a classe Protection mais eficiente. Embora esse método esteja descontinuado, ele continua disponível para compatibilidade com a versão mais antiga do app Planilhas.

Retorna uma instância PageProtection que descreve as permissões da planilha atual.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

const permissions = sheet.getSheetProtection();

permissions.setProtected(true);
permissions.addUser('user@example.com');

// Logs the users that have access to edit this sheet. Note that this
// is different from access to the entire spreadsheet - getUsers()
// only returns users if permissions.isProtected() is set to true.
const users = permissions.getUsers();
Logger.log(users);

Retornar

PageProtection: um objeto que descreve as permissões de acesso à 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

`getTabColor()`

Obsoleto. Substituído por getTabColorObject()

Recebe a cor da guia da planilha ou null se ela não tiver uma cor.

// This example assumes there is a sheet named "first"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('first');
const color = first.getTabColor();

Retornar

String: código de cor na notação CSS (como '#ffffff').

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

`setSheetProtection(permissions)`

Obsoleto. Para planilhas criadas na versão mais recente das Planilhas Google, use protect(), que retorna a classe Protection mais eficiente. Embora esse método esteja descontinuado, ele ainda está disponível para compatibilidade com a versão mais antiga do Planilhas.

Define as permissões da planilha atual.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

const permissions = sheet.getSheetProtection();

// This copies the permissions on the first sheet to the second sheet
const sheetToClonePermissionsTo = ss.getSheets()[1];
sheetToClonePermissionsTo.setSheetProtection(permissions);

Parâmetros

Nome	Tipo	Descrição
`permissions`	`PageProtection`	O objeto de permissões de acesso a ser definido nesta 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

Class Sheet Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

Métodos

Métodos obsoletos

Documentação detalhada

activate()

Retornar

addDeveloperMetadata(key)

Parâmetros

Retornar

Autorização

addDeveloperMetadata(key, visibility)

Parâmetros

Retornar

Autorização

addDeveloperMetadata(key, value)

Parâmetros

Retornar

Autorização

addDeveloperMetadata(key, value, visibility)

Parâmetros

Retornar

Autorização

appendRow(rowContents)

Parâmetros

Retornar

Autorização

asDataSourceSheet()

Retornar

Autorização

autoResizeColumn(columnPosition)

Parâmetros

Retornar

Autorização

autoResizeColumns(startColumn, numColumns)

Parâmetros

Retornar

Autorização

autoResizeRows(startRow, numRows)

Parâmetros

Retornar

Autorização

clear()

Retornar

Autorização

clear(options)

Parâmetros

Parâmetros avançados

Retornar

Autorização

clearConditionalFormatRules()

Autorização

clearContents()

Retornar

Autorização

clearFormats()

Retornar

Autorização

clearNotes()

Retornar

Autorização

collapseAllColumnGroups()

Retornar

Autorização

collapseAllRowGroups()

Retornar

Autorização

copyTo(spreadsheet)

Parâmetros

Retornar

Autorização

createDeveloperMetadataFinder()

Retornar

createTextFinder(findText)

Parâmetros

Retornar

deleteColumn(columnPosition)

Parâmetros

Retornar

Autorização

deleteColumns(columnPosition, howMany)

Class Sheet

`activate()`

`addDeveloperMetadata(key)`

`addDeveloperMetadata(key, visibility)`

`addDeveloperMetadata(key, value)`

`addDeveloperMetadata(key, value, visibility)`

`appendRow(rowContents)`

`asDataSourceSheet()`

`autoResizeColumn(columnPosition)`

`autoResizeColumns(startColumn, numColumns)`

`autoResizeRows(startRow, numRows)`

`clear()`

`clear(options)`

`clearConditionalFormatRules()`

`clearContents()`

`clearFormats()`

`clearNotes()`

`collapseAllColumnGroups()`

`collapseAllRowGroups()`

`copyTo(spreadsheet)`

`createDeveloperMetadataFinder()`

`createTextFinder(findText)`

`deleteColumn(columnPosition)`

`deleteColumns(columnPosition, howMany)`

`deleteRow(rowPosition)`

`deleteRows(rowPosition, howMany)`

`expandAllColumnGroups()`

`expandAllRowGroups()`

`expandColumnGroupsUpToDepth(groupDepth)`

`expandRowGroupsUpToDepth(groupDepth)`

`getActiveCell()`

`getActiveRange()`

`getActiveRangeList()`

`getBandings()`

`getCharts()`

`getColumnGroup(columnIndex, groupDepth)`

`getColumnGroupControlPosition()`

`getColumnGroupDepth(columnIndex)`

`getColumnWidth(columnPosition)`

`getConditionalFormatRules()`

`getCurrentCell()`

`getDataRange()`

`getDataSourceFormulas()`

`getDataSourcePivotTables()`