Esta página foi traduzida pela API Cloud Translation.

Class Range

Acessar e modificar intervalos de planilhas. Um intervalo pode ser uma única célula ou um grupo de células adjacentes em uma planilha.

Métodos

Método	Tipo de retorno	Breve descrição
`activate()`	`Range`	Define o intervalo especificado como `active range`, com a célula superior esquerda no intervalo como `current cell`.
`activateAsCurrentCell()`	`Range`	Define a célula especificada como `current cell`.
`addDeveloperMetadata(key)`	`Range`	Adiciona metadados do desenvolvedor com a chave especificada ao intervalo.
`addDeveloperMetadata(key, visibility)`	`Range`	Adiciona metadados do desenvolvedor com a chave e a visibilidade especificadas ao intervalo.
`addDeveloperMetadata(key, value)`	`Range`	Adiciona metadados do desenvolvedor com a chave e o valor especificados ao intervalo.
`addDeveloperMetadata(key, value, visibility)`	`Range`	Adiciona metadados do desenvolvedor com a chave, o valor e a visibilidade especificados ao intervalo.
`applyColumnBanding()`	`Banding`	Aplica um tema padrão de faixa de coluna ao intervalo.
`applyColumnBanding(bandingTheme)`	`Banding`	Aplica um tema de bandas de coluna especificado ao intervalo.
`applyColumnBanding(bandingTheme, showHeader, showFooter)`	`Banding`	Aplica um tema de bandas de coluna especificado ao intervalo com configurações de cabeçalho e rodapé especificadas.
`applyRowBanding()`	`Banding`	Aplica um tema padrão de faixa de linha ao intervalo.
`applyRowBanding(bandingTheme)`	`Banding`	Aplica um tema de bandas de linha especificado ao intervalo.
`applyRowBanding(bandingTheme, showHeader, showFooter)`	`Banding`	Aplica um tema de faixa de linha especificado ao intervalo com as configurações de cabeçalho e rodapé especificadas.
`autoFill(destination, series)`	`void`	Preenche o `destinationRange` com dados com base nas informações desse intervalo.
`autoFillToNeighbor(series)`	`void`	Calcula um intervalo para preencher com novos dados com base nas células vizinhas e preenche automaticamente esse intervalo com novos valores com base nos dados contidos nele.
`breakApart()`	`Range`	Divida novamente as células de várias colunas no intervalo em células individuais.
`canEdit()`	`Boolean`	Determina se o usuário tem permissão para editar todas as células no intervalo.
`check()`	`Range`	Muda o estado das caixas de seleção no intervalo para "marcado".
`clear()`	`Range`	Limpa o intervalo de conteúdo e formatos.
`clear(options)`	`Range`	Limpa o intervalo de conteúdo, formato, regras de validação de dados e/ou comentários, conforme especificado com as opções avançadas fornecidas.
`clearContent()`	`Range`	Limpa o conteúdo do intervalo, deixando a formatação intacta.
`clearDataValidations()`	`Range`	Limpa as regras de validação de dados do intervalo.
`clearFormat()`	`Range`	Limpa a formatação desse intervalo.
`clearNote()`	`Range`	Limpa a observação na célula ou nas células especificadas.
`collapseGroups()`	`Range`	Recolhe todos os grupos totalmente contidos no intervalo.
`copyFormatToRange(gridId, column, columnEnd, row, rowEnd)`	`void`	Copia a formatação do intervalo para o local especificado.
`copyFormatToRange(sheet, column, columnEnd, row, rowEnd)`	`void`	Copia a formatação do intervalo para o local especificado.
`copyTo(destination)`	`void`	Copia os dados de um intervalo de células para outro.
`copyTo(destination, copyPasteType, transposed)`	`void`	Copia os dados de um intervalo de células para outro.
`copyTo(destination, options)`	`void`	Copia os dados de um intervalo de células para outro.
`copyValuesToRange(gridId, column, columnEnd, row, rowEnd)`	`void`	Copie o conteúdo do intervalo para o local especificado.
`copyValuesToRange(sheet, column, columnEnd, row, rowEnd)`	`void`	Copie o conteúdo do intervalo para o local especificado.
`createDataSourcePivotTable(dataSource)`	`DataSourcePivotTable`	Cria uma tabela dinâmica de fonte de dados vazia com base na fonte de dados, ancorada na primeira célula desse intervalo.
`createDataSourceTable(dataSource)`	`DataSourceTable`	Cria uma tabela de fonte de dados vazia com base na fonte de dados, ancorada na primeira célula desse intervalo.
`createDeveloperMetadataFinder()`	`DeveloperMetadataFinder`	Retorna um DeveloperMetadataFinderApi para encontrar metadados do desenvolvedor no escopo desse intervalo.
`createFilter()`	`Filter`	Cria um filtro e o aplica ao intervalo especificado na planilha.
`createPivotTable(sourceData)`	`PivotTable`	Cria uma tabela dinâmica vazia com base no `sourceData` especificado, ancorada na primeira célula do intervalo.
`createTextFinder(findText)`	`TextFinder`	Cria um localizador de texto para o intervalo, que pode encontrar e substituir texto nele.
`deleteCells(shiftDimension)`	`void`	Exclui esse intervalo de células.
`expandGroups()`	`Range`	Expande os grupos recolhidos cujo intervalo ou alternância de controle se cruzam com este intervalo.
`getA1Notation()`	`String`	Retorna uma descrição de string do intervalo na notação A1.
`getBackground()`	`String`	Retorna a cor de fundo da célula superior esquerda no intervalo (por exemplo, `'#ffffff'`).
`getBackgroundObject()`	`Color`	Retorna a cor de fundo da célula superior esquerda no intervalo.
`getBackgroundObjects()`	`Color[][]`	Retorna as cores de plano de fundo das células no intervalo.
`getBackgrounds()`	`String[][]`	Retorna as cores de plano de fundo das células no intervalo (por exemplo, `'#ffffff'`).
`getBandings()`	`Banding[]`	Retorna todas as faixas aplicadas a qualquer célula nesse intervalo.
`getCell(row, column)`	`Range`	Retorna uma determinada célula em um intervalo.
`getColumn()`	`Integer`	Retorna a posição da coluna inicial para esse intervalo.
`getDataRegion()`	`Range`	Retorna uma cópia do intervalo expandido nos quatro `Direction`s cardinais para cobrir todas as células adjacentes com dados.
`getDataRegion(dimension)`	`Range`	Retorna uma cópia do intervalo expandido `Direction.UP` e `Direction.DOWN` se a dimensão especificada for `Dimension.ROWS`, ou `Direction.NEXT` e `Direction.PREVIOUS` se a dimensão for `Dimension.COLUMNS`.
`getDataSourceFormula()`	`DataSourceFormula`	Retorna o `DataSourceFormula` da primeira célula no intervalo ou `null` se a célula não contiver uma fórmula de fonte de dados.
`getDataSourceFormulas()`	`DataSourceFormula[]`	Retorna os `DataSourceFormula`s das células no intervalo.
`getDataSourcePivotTables()`	`DataSourcePivotTable[]`	Recebe todas as tabelas dinâmicas de fonte de dados que se cruzam com o intervalo.
`getDataSourceTables()`	`DataSourceTable[]`	Recebe todas as tabelas de fonte de dados que se cruzam com o intervalo.
`getDataSourceUrl()`	`String`	Retorna um URL para os dados nesse intervalo, que pode ser usado para criar gráficos e consultas.
`getDataTable()`	`DataTable`	Retorna os dados dentro desse objeto como uma DataTable.
`getDataTable(firstRowIsHeader)`	`DataTable`	Retorna os dados dentro desse intervalo como uma DataTable.
`getDataValidation()`	`DataValidation`	Retorna a regra de validação de dados da célula superior esquerda no intervalo.
`getDataValidations()`	`DataValidation[][]`	Retorna as regras de validação de dados para todas as células no intervalo.
`getDeveloperMetadata()`	`DeveloperMetadata[]`	Recebe os metadados do desenvolvedor associados a esse intervalo.
`getDisplayValue()`	`String`	Retorna o valor mostrado da célula superior esquerda no intervalo.
`getDisplayValues()`	`String[][]`	Retorna a grade retangular de valores para esse intervalo.
`getFilter()`	`Filter`	Retorna o filtro na planilha a que esse intervalo pertence ou `null` se não houver filtro na planilha.
`getFontColorObject()`	`Color`	Retorna a cor da fonte da célula no canto superior esquerdo do intervalo.
`getFontColorObjects()`	`Color[][]`	Retorna as cores da fonte das células no intervalo.
`getFontFamilies()`	`String[][]`	Retorna as famílias de fontes das células no intervalo.
`getFontFamily()`	`String`	Retorna a família de fontes da célula no canto superior esquerdo do intervalo.
`getFontLine()`	`String`	Recebe o estilo da linha da célula no canto superior esquerdo do intervalo (`'underline'`, `'line-through'` ou `'none'`).
`getFontLines()`	`String[][]`	Recebe o estilo de linha das células no intervalo (`'underline'`, `'line-through'` ou `'none'`).
`getFontSize()`	`Integer`	Retorna o tamanho da fonte em pontos da célula no canto superior esquerdo do intervalo.
`getFontSizes()`	`Integer[][]`	Retorna os tamanhos de fonte das células no intervalo.
`getFontStyle()`	`String`	Retorna o estilo da fonte (`'italic'` ou `'normal'`) da célula no canto superior esquerdo do intervalo.
`getFontStyles()`	`String[][]`	Retorna os estilos de fonte das células no intervalo.
`getFontWeight()`	`String`	Retorna a espessura da fonte (normal/negrito) da célula no canto superior esquerdo do intervalo.
`getFontWeights()`	`String[][]`	Retorna as espessuras da fonte das células no intervalo.
`getFormula()`	`String`	Retorna a fórmula (notação A1) da célula superior esquerda do intervalo ou uma string vazia se a célula estiver vazia ou não contiver uma fórmula.
`getFormulaR1C1()`	`String`	Retorna a fórmula (notação R1C1) de uma determinada célula ou `null` se não houver nenhuma.
`getFormulas()`	`String[][]`	Retorna as fórmulas (notação A1) das células no intervalo.
`getFormulasR1C1()`	`String[][]`	Retorna as fórmulas (notação R1C1) das células no intervalo.
`getGridId()`	`Integer`	Retorna o ID da grade da planilha mãe do intervalo.
`getHeight()`	`Integer`	Retorna a altura do intervalo.
`getHorizontalAlignment()`	`String`	Retorna o alinhamento horizontal do texto (esquerda/centralizado/direita) da célula no canto superior esquerdo do intervalo.
`getHorizontalAlignments()`	`String[][]`	Retorna os alinhamentos horizontais das células no intervalo.
`getLastColumn()`	`Integer`	Retorna a posição da coluna final.
`getLastRow()`	`Integer`	Retorna a posição da linha final.
`getMergedRanges()`	`Range[]`	Retorna uma matriz de objetos `Range` que representam células mescladas totalmente dentro do intervalo atual ou que contêm pelo menos uma célula no intervalo atual.
`getNextDataCell(direction)`	`Range`	Começando pela célula na primeira coluna e linha do intervalo, retorna a próxima célula na direção especificada que é a borda de um intervalo contíguo de células com dados ou a célula na borda da planilha nessa direção.
`getNote()`	`String`	Retorna a observação associada ao intervalo especificado.
`getNotes()`	`String[][]`	Retorna as notas associadas às células no intervalo.
`getNumColumns()`	`Integer`	Retorna o número de colunas nesse intervalo.
`getNumRows()`	`Integer`	Retorna o número de linhas nesse intervalo.
`getNumberFormat()`	`String`	Recebe a formatação de número ou data da célula no canto superior esquerdo do intervalo especificado.
`getNumberFormats()`	`String[][]`	Retorna os formatos de número ou data das células no intervalo.
`getRichTextValue()`	`RichTextValue`	Retorna o valor de texto avançado da célula superior esquerda do intervalo ou `null` se o valor da célula não for texto.
`getRichTextValues()`	`RichTextValue[][]`	Retorna os valores de texto formatado das células no intervalo.
`getRow()`	`Integer`	Retorna a posição da linha para esse intervalo.
`getRowIndex()`	`Integer`	Retorna a posição da linha para esse intervalo.
`getSheet()`	`Sheet`	Retorna a planilha a que esse intervalo pertence.
`getTextDirection()`	`TextDirection`	Retorna a direção do texto da célula superior esquerda do intervalo.
`getTextDirections()`	`TextDirection[][]`	Retorna as direções de texto das células no intervalo.
`getTextRotation()`	`TextRotation`	Retorna as configurações de rotação de texto da célula superior esquerda do intervalo.
`getTextRotations()`	`TextRotation[][]`	Retorna as configurações de rotação de texto para as células no intervalo.
`getTextStyle()`	`TextStyle`	Retorna o estilo de texto da célula superior esquerda do intervalo.
`getTextStyles()`	`TextStyle[][]`	Retorna os estilos de texto das células no intervalo.
`getValue()`	`Object`	Retorna o valor da célula superior esquerda no intervalo.
`getValues()`	`Object[][]`	Retorna a grade retangular de valores para esse intervalo.
`getVerticalAlignment()`	`String`	Retorna o alinhamento vertical (superior/central/inferior) da célula no canto superior esquerdo do intervalo.
`getVerticalAlignments()`	`String[][]`	Retorna os alinhamentos verticais das células no intervalo.
`getWidth()`	`Integer`	Retorna a largura do intervalo em colunas.
`getWrap()`	`Boolean`	Retorna se o texto na célula é quebrado.
`getWrapStrategies()`	`WrapStrategy[][]`	Retorna as estratégias de quebra de texto para as células no intervalo.
`getWrapStrategy()`	`WrapStrategy`	Retorna a estratégia de quebra de texto da célula superior esquerda do intervalo.
`getWraps()`	`Boolean[][]`	Retorna se o texto nas células é quebrado.
`insertCells(shiftDimension)`	`Range`	Insere células vazias nesse intervalo.
`insertCheckboxes()`	`Range`	Insere caixas de seleção em cada célula do intervalo, configuradas com `true` para marcadas e `false` para desmarcadas.
`insertCheckboxes(checkedValue)`	`Range`	Insere caixas de seleção em cada célula do intervalo, configuradas com um valor personalizado para marcado e a string vazia para desmarcado.
`insertCheckboxes(checkedValue, uncheckedValue)`	`Range`	Insere caixas de seleção em cada célula do intervalo, configuradas com valores personalizados para os estados marcados e desmarcados.
`isBlank()`	`Boolean`	Retorna `true` se o intervalo estiver totalmente em branco.
`isChecked()`	`Boolean`	Retorna se todas as células no intervalo têm o estado da caixa de seleção como "marcado".
`isEndColumnBounded()`	`Boolean`	Determina se o fim do intervalo está vinculado a uma coluna específica.
`isEndRowBounded()`	`Boolean`	Determina se o fim do intervalo está vinculado a uma linha específica.
`isPartOfMerge()`	`Boolean`	Retorna `true` se as células no intervalo atual se sobrepuserem a células mescladas.
`isStartColumnBounded()`	`Boolean`	Determina se o início do intervalo está vinculado a uma coluna específica.
`isStartRowBounded()`	`Boolean`	Determina se o início do intervalo está vinculado a uma linha específica.
`merge()`	`Range`	Mescla as células no intervalo em um único bloco.
`mergeAcross()`	`Range`	Mescla as células no intervalo em todas as colunas.
`mergeVertically()`	`Range`	Mescla as células no intervalo.
`moveTo(target)`	`void`	Corte e cole (formato e valores) desse intervalo no intervalo de destino.
`offset(rowOffset, columnOffset)`	`Range`	Retorna um novo intervalo que é deslocado deste intervalo pelo número de linhas e colunas especificado (que pode ser negativo).
`offset(rowOffset, columnOffset, numRows)`	`Range`	Retorna um novo intervalo relativo ao atual, cujo ponto superior esquerdo é deslocado do intervalo atual pelas linhas e colunas fornecidas e com a altura especificada em células.
`offset(rowOffset, columnOffset, numRows, numColumns)`	`Range`	Retorna um novo intervalo relativo ao intervalo atual, cujo ponto superior esquerdo é deslocado do intervalo atual pelas linhas e colunas fornecidas, e com a altura e largura fornecidas em células.
`protect()`	`Protection`	Cria um objeto que pode proteger o intervalo contra edições, exceto por usuários que têm permissão.
`randomize()`	`Range`	Aleatoriza a ordem das linhas no intervalo especificado.
`removeCheckboxes()`	`Range`	Remove todas as caixas de seleção do intervalo.
`removeDuplicates()`	`Range`	Remove as linhas dentro desse intervalo que contêm valores duplicados de valores em qualquer linha anterior.
`removeDuplicates(columnsToCompare)`	`Range`	Remove as linhas dentro desse intervalo que contêm valores nas colunas especificadas que são duplicados de valores em qualquer linha anterior.
`setBackground(color)`	`Range`	Define a cor de plano de fundo de todas as células no intervalo na notação CSS (como `'#ffffff'` ou `'white'`).
`setBackgroundObject(color)`	`Range`	Define a cor de fundo de todas as células no intervalo.
`setBackgroundObjects(color)`	`Range`	Define uma grade retangular de cores de plano de fundo (precisa corresponder às dimensões desse intervalo).
`setBackgroundRGB(red, green, blue)`	`Range`	Define o plano de fundo com a cor especificada usando valores RGB (números inteiros entre 0 e 255, inclusive).
`setBackgrounds(color)`	`Range`	Define uma grade retangular de cores de plano de fundo (precisa corresponder às dimensões desse intervalo).
`setBorder(top, left, bottom, right, vertical, horizontal)`	`Range`	Define a propriedade de borda.
`setBorder(top, left, bottom, right, vertical, horizontal, color, style)`	`Range`	Define a propriedade de borda com cor e/ou estilo.
`setDataValidation(rule)`	`Range`	Define uma regra de validação de dados para todas as células no intervalo.
`setDataValidations(rules)`	`Range`	Define as regras de validação de dados para todas as células no intervalo.
`setFontColor(color)`	`Range`	Define a cor da fonte na notação CSS (como `'#ffffff'` ou `'white'`).
`setFontColorObject(color)`	`Range`	Define a cor da fonte do intervalo especificado.
`setFontColorObjects(colors)`	`Range`	Define uma grade retangular de cores de fonte (precisa corresponder às dimensões desse intervalo).
`setFontColors(colors)`	`Range`	Define uma grade retangular de cores de fonte (precisa corresponder às dimensões desse intervalo).
`setFontFamilies(fontFamilies)`	`Range`	Define uma grade retangular de famílias de fontes (precisa corresponder às dimensões desse intervalo).
`setFontFamily(fontFamily)`	`Range`	Define a família de fontes, como "Arial" ou "Helvetica".
`setFontLine(fontLine)`	`Range`	Define o estilo da linha da fonte do intervalo especificado (`'underline'`, `'line-through'` ou `'none'`).
`setFontLines(fontLines)`	`Range`	Define uma grade retangular de estilos de linha (precisa corresponder às dimensões desse intervalo).
`setFontSize(size)`	`Range`	Define o tamanho da fonte, que é o tamanho do ponto a ser usado.
`setFontSizes(sizes)`	`Range`	Define uma grade retangular de tamanhos de fontes (precisa corresponder às dimensões desse intervalo).
`setFontStyle(fontStyle)`	`Range`	Defina o estilo da fonte para o intervalo especificado (`'italic'` ou `'normal'`).
`setFontStyles(fontStyles)`	`Range`	Define uma grade retangular de estilos de fonte (precisa corresponder às dimensões desse intervalo).
`setFontWeight(fontWeight)`	`Range`	Define o peso da fonte para o intervalo especificado (normal/negrito).
`setFontWeights(fontWeights)`	`Range`	Define uma grade retangular de pesos de fontes (precisa corresponder às dimensões desse intervalo).
`setFormula(formula)`	`Range`	Atualiza a fórmula desse intervalo.
`setFormulaR1C1(formula)`	`Range`	Atualiza a fórmula desse intervalo.
`setFormulas(formulas)`	`Range`	Define uma grade retangular de fórmulas (precisa corresponder às dimensões desse intervalo).
`setFormulasR1C1(formulas)`	`Range`	Define uma grade retangular de fórmulas (precisa corresponder às dimensões desse intervalo).
`setHorizontalAlignment(alignment)`	`Range`	Define o alinhamento horizontal (da esquerda para a direita) para o intervalo especificado (esquerda/centro/direita).
`setHorizontalAlignments(alignments)`	`Range`	Define uma grade retangular de alinhamentos horizontais.
`setNote(note)`	`Range`	Define a nota como o valor especificado.
`setNotes(notes)`	`Range`	Define uma grade retangular de notas (precisa corresponder às dimensões desse intervalo).
`setNumberFormat(numberFormat)`	`Range`	Define o formato de número ou data para a string de formatação especificada.
`setNumberFormats(numberFormats)`	`Range`	Define uma grade retangular de formatos de número ou data (precisa corresponder às dimensões desse intervalo).
`setRichTextValue(value)`	`Range`	Define o valor de rich text para as células no intervalo.
`setRichTextValues(values)`	`Range`	Define uma grade retangular de valores de rich text.
`setShowHyperlink(showHyperlink)`	`Range`	Define se o intervalo deve mostrar hiperlinks.
`setTextDirection(direction)`	`Range`	Define a direção do texto para as células no intervalo.
`setTextDirections(directions)`	`Range`	Define uma grade retangular de direções de texto.
`setTextRotation(degrees)`	`Range`	Define as configurações de rotação do texto para as células no intervalo.
`setTextRotation(rotation)`	`Range`	Define as configurações de rotação do texto para as células no intervalo.
`setTextRotations(rotations)`	`Range`	Define uma grade retangular de rotações de texto.
`setTextStyle(style)`	`Range`	Define o estilo do texto para as células no intervalo.
`setTextStyles(styles)`	`Range`	Define uma grade retangular de estilos de texto.
`setValue(value)`	`Range`	Define o valor do intervalo.
`setValues(values)`	`Range`	Define uma grade retangular de valores (precisa corresponder às dimensões desse intervalo).
`setVerticalAlignment(alignment)`	`Range`	Defina o alinhamento vertical (de cima para baixo) para o intervalo especificado (parte de cima/meio/parte de baixo).
`setVerticalAlignments(alignments)`	`Range`	Define uma grade retangular de alinhamentos verticais (precisa corresponder às dimensões desse intervalo).
`setVerticalText(isVertical)`	`Range`	Define se o texto das células no intervalo será empilhado ou não.
`setWrap(isWrapEnabled)`	`Range`	Define o ajuste de texto da célula do intervalo especificado.
`setWrapStrategies(strategies)`	`Range`	Define uma grade retangular de estratégias de ajuste de texto.
`setWrapStrategy(strategy)`	`Range`	Define a estratégia de quebra de texto para as células no intervalo.
`setWraps(isWrapEnabled)`	`Range`	Define uma grade retangular de políticas de quebra de texto (precisa corresponder às dimensões desse intervalo).
`shiftColumnGroupDepth(delta)`	`Range`	Muda a profundidade do agrupamento de colunas do intervalo pela quantidade especificada.
`shiftRowGroupDepth(delta)`	`Range`	Muda a profundidade do agrupamento de linhas do intervalo na quantidade especificada.
`sort(sortSpecObj)`	`Range`	Classifica as células no intervalo especificado por coluna e ordem.
`splitTextToColumns()`	`void`	Divide uma coluna de texto em várias colunas com base em um delimitador detectado automaticamente.
`splitTextToColumns(delimiter)`	`void`	Divide uma coluna de texto em várias colunas usando a string especificada como um delimitador personalizado.
`splitTextToColumns(delimiter)`	`void`	Divide uma coluna de texto em várias colunas com base no delimitador especificado.
`trimWhitespace()`	`Range`	Remove os espaços em branco (como espaços, tabulações ou novas linhas) em todas as células desse intervalo.
`uncheck()`	`Range`	Muda o estado das caixas de seleção no intervalo para "desmarcado".

Métodos obsoletos

Método	Tipo de retorno	Breve descrição
`getFontColor()`	`String`	Retorna a cor da fonte da célula no canto superior esquerdo do intervalo, na notação CSS (como `'#ffffff'` ou `'white'`).
`getFontColors()`	`String[][]`	Retorna as cores da fonte das células no intervalo na notação CSS (como `'#ffffff'` ou `'white'`).

Documentação detalhada

`activate()`

Define o intervalo especificado como active range, com a célula superior esquerda no intervalo como current cell.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
const range = sheet.getRange('A1:D10');
range.activate();

const selection = sheet.getSelection();
// Current cell: A1
const currentCell = selection.getCurrentCell();
// Active Range: A1:D10
const activeRange = selection.getActiveRange();

Retornar

Range: esse intervalo, para encadeamento.

`activateAsCurrentCell()`

Define a célula especificada como current cell.

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

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

Observação:o Range especificado precisa consistir em uma célula. Caso contrário, uma exceção será gerada.

// Gets the first sheet of the spreadsheet.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// Gets the cell B5 and sets it as the active cell.
const range = sheet.getRange('B5');
const currentCell = range.activateAsCurrentCell();

// Logs the activated cell.
console.log(currentCell.getA1Notation());

Retornar

Range: esse intervalo, 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)`

Adiciona metadados do desenvolvedor com a chave especificada ao intervalo.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets row 2 on the sheet.
const range = sheet.getRange('2:2');

// Adds the key 'NAME' to the developer metadata for row 2.
range.addDeveloperMetadata('NAME');

// Gets the metadata and logs it to the console.
const developerMetaData = range.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());

Parâmetros

Nome	Tipo	Descrição
`key`	`String`	A chave dos novos metadados do desenvolvedor.

Retornar

Range: esse intervalo, 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 ao intervalo.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets row 2 on Sheet1.
const range = sheet.getRange('2:2');

// Adds the key 'NAME' and sets the developer metadata visibility to 'DOCUMENT'
// for row 2 on Sheet1.
range.addDeveloperMetadata(
    'NAME',
    SpreadsheetApp.DeveloperMetadataVisibility.DOCUMENT,
);

// Gets the updated metadata info and logs it to the console.
const developerMetaData = range.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

Range: esse intervalo, 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 ao intervalo.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets row 2 of Sheet1.
const range = sheet.getRange('2:2');

// Adds the key 'NAME' and sets the value to 'GOOGLE' for the metadata of row 2.
range.addDeveloperMetadata('NAME', 'GOOGLE');

// Gets the metadata and logs it to the console.
const developerMetaData = range.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

Range: esse intervalo, 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 ao intervalo.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets row 2 on the sheet.
const range = sheet.getRange('2:2');

// Adds the key 'NAME', sets the value to 'GOOGLE', and sets the visibility
// to PROJECT for row 2 on the sheet.
range.addDeveloperMetadata(
    'NAME',
    'GOOGLE',
    SpreadsheetApp.DeveloperMetadataVisibility.PROJECT,
);

// Gets the updated metadata info and logs it to the console.
const developerMetaData = range.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

Range: esse intervalo, 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

`applyColumnBanding()`

Aplica um tema padrão de faixa de coluna ao intervalo. Por padrão, o efeito de faixa tem um cabeçalho e não tem uma cor de rodapé.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets row 2 on the sheet.
const range = sheet.getRange('2:2');

// Applies column banding to row 2.
const colBanding = range.applyColumnBanding();

// Gets the first banding on the sheet and logs the color of the header column.
console.log(
    sheet.getBandings()[0]
        .getHeaderColumnColorObject()
        .asRgbColor()
        .asHexString(),
);

// Gets the first banding on the sheet and logs the color of the second column.
console.log(
    sheet.getBandings()[0]
        .getSecondColumnColorObject()
        .asRgbColor()
        .asHexString(),
);

Retornar

Banding: a nova faixa.

Autorização

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

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

`applyColumnBanding(bandingTheme)`

Aplica um tema de bandas de coluna especificado ao intervalo. Por padrão, o efeito de faixa tem cabeçalho e não tem cor de rodapé.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets row 2 on the sheet.
const range = sheet.getRange('2:2');

// Applies the INDIGO color banding theme to the columns in row 2.
const colBanding = range.applyColumnBanding(SpreadsheetApp.BandingTheme.INDIGO);

// Gets the first banding on the sheet and logs the color of the second column.
console.log(
    sheet.getBandings()[0]
        .getSecondColumnColorObject()
        .asRgbColor()
        .asHexString(),
);

Parâmetros

Nome	Tipo	Descrição
`bandingTheme`	`BandingTheme`	Um tema de cores a ser aplicado às colunas no intervalo.

Retornar

Banding: a nova faixa.

Autorização

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

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

`applyColumnBanding(bandingTheme, showHeader, showFooter)`

Aplica um tema de bandas de coluna especificado ao intervalo com configurações de cabeçalho e rodapé especificadas.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets rows 12-22 on the sheet.
const range = sheet.getRange('12:22');

// Applies the BLUE color banding theme to rows 12-22.
// Sets the header visibility to false and the footer visibility to true.
const colBanding = range.applyColumnBanding(
    SpreadsheetApp.BandingTheme.BLUE,
    false,
    true,
);

// Gets the banding color and logs it to the console.
console.log(
    sheet.getBandings()[0]
        .getSecondColumnColorObject()
        .asRgbColor()
        .asHexString(),
);

// Gets the header color object and logs it to the console. Returns null because
// the header visibility is set to false.
console.log(sheet.getBandings()[0].getHeaderColumnColorObject());

// Gets the footer color and logs it to the console.
console.log(
    sheet.getBandings()[0]
        .getFooterColumnColorObject()
        .asRgbColor()
        .asHexString(),
);

Parâmetros

Nome	Tipo	Descrição
`bandingTheme`	`BandingTheme`	Um tema de cores a ser aplicado às colunas no intervalo.
`showHeader`	`Boolean`	Se `true`, a cor do cabeçalho do tema de faixa será aplicada à primeira coluna.
`showFooter`	`Boolean`	Se `true`, a cor do rodapé do tema de bandas será aplicada à última coluna.

Retornar

Banding: a nova faixa.

Autorização

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

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

`applyRowBanding()`

Aplica um tema padrão de faixa de linha ao intervalo. Por padrão, o efeito de faixa tem um cabeçalho e não tem uma cor de rodapé.

// Opens the spreadsheet 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 rows 1-30 on Sheet1.
const range = sheet.getRange('1:30');

// Applies row banding to rows 1-30.
range.applyRowBanding();

// Gets the hex color of the second banded row.
const secondRowColor =
    range.getBandings()[0].getSecondRowColorObject().asRgbColor().asHexString();

// Logs the hex color to console.
console.log(secondRowColor);

Retornar

Banding: o banding.

Autorização

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

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

`applyRowBanding(bandingTheme)`

Aplica um tema de bandas de linha especificado ao intervalo. Por padrão, o efeito de faixa tem um cabeçalho e não tem uma cor de rodapé.

// Opens the spreadsheet 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 rows 1-30 on Sheet1.
const range = sheet.getRange('1:30');

// Applies the INDIGO row banding theme to rows 1-30.
range.applyRowBanding(SpreadsheetApp.BandingTheme.INDIGO);

// Gets the hex color of the second banded row.
const secondRowColor =
    range.getBandings()[0].getSecondRowColorObject().asRgbColor().asHexString();

// Logs the hex color to console.
console.log(secondRowColor);

Parâmetros

Nome	Tipo	Descrição
`bandingTheme`	`BandingTheme`	Um tema de cores a ser aplicado às linhas no intervalo.

Retornar

Banding: a nova faixa.

Autorização

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

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

`applyRowBanding(bandingTheme, showHeader, showFooter)`

Aplica um tema de faixa de linha especificado ao intervalo com as configurações de cabeçalho e rodapé especificadas.

// Opens the spreadsheet 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 rows 1-30 on Sheet1.
const range = sheet.getRange('1:30');

// Applies the INDIGO row banding to rows 1-30 and
// specifies to hide the header and show the footer.
range.applyRowBanding(SpreadsheetApp.BandingTheme.INDIGO, false, true);

Parâmetros

Nome	Tipo	Descrição
`bandingTheme`	`BandingTheme`	Um tema de cores a ser aplicado às linhas no intervalo.
`showHeader`	`Boolean`	Se `true`, a cor do cabeçalho do tema de faixa será aplicada à primeira linha.
`showFooter`	`Boolean`	Se `true`, a cor do rodapé do tema de bandas será aplicada à última linha.

Retornar

Banding: a nova faixa.

Autorização

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

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

`autoFill(destination, series)`

Preenche o destinationRange com dados com base nas informações desse intervalo. Os novos valores também são determinados pelo tipo series especificado. O intervalo de destino precisa conter esse intervalo e estendê-lo em apenas uma direção. Por exemplo, o código a seguir preenche A1:A20 com uma série de números crescentes com base nos valores atuais em A1:A4:

const sheet = SpreadsheetApp.getActiveSheet();

// Has values [1, 2, 3, 4].
const sourceRange = sheet.getRange('A1:A4');
// The range to fill with values.
const destination = sheet.getRange('A1:A20');

// Inserts new values in A5:A20, continuing the pattern expressed in A1:A4
sourceRange.autoFill(destination, SpreadsheetApp.AutoFillSeries.DEFAULT_SERIES);

Parâmetros

Nome	Tipo	Descrição
`destination`	`Range`	O intervalo a ser preenchido automaticamente com valores. O intervalo de destino precisa conter esse intervalo e estendê-lo em apenas uma direção (para cima, para baixo, para a esquerda ou para a direita).
`series`	`AutoFillSeries`	O tipo de série de preenchimento automático que deve ser usado para calcular novos valores. O efeito dessa série varia de acordo com o tipo e a quantidade de dados de origem.

Autorização

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

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

`autoFillToNeighbor(series)`

Calcula um intervalo para preencher com novos dados com base nas células vizinhas e preenche automaticamente esse intervalo com novos valores com base nos dados contidos nele. Esses novos valores também são determinados pelo tipo series especificado.

O intervalo de destino calculado considera os dados ao redor para determinar onde os novos valores devem ser inseridos: se houver dados imediatamente à esquerda ou à direita de uma coluna que está sendo preenchida automaticamente, os novos valores só se estenderão até esses dados adjacentes.

Por exemplo, se A1:A20 for preenchido com uma série de números crescentes e esse método for chamado no intervalo B1:B4, que contém uma série de datas, novos valores serão inseridos apenas em B5:B20. Assim, esses novos valores "aderem" às células que contêm valores na coluna A.

const sheet = SpreadsheetApp.getActiveSheet();

// A1:A20 has values [1, 2, 3, ... 20].
// B1:B4 has values [1/1/2017, 1/2/2017, ...]
const sourceRange = sheet.getRange('B1:B4');

// Results in B5:B20 having values [1/5/2017, ... 1/20/2017]
sourceRange.autoFillToNeighbor(SpreadsheetApp.AutoFillSeries.DEFAULT_SERIES);

Parâmetros

Nome	Tipo	Descrição
`series`	`AutoFillSeries`	O tipo de série de preenchimento automático que deve ser usado para calcular novos valores. O efeito dessa série varia de acordo com o tipo e a quantidade de dados de origem.

Autorização

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

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

`breakApart()`

Divida novamente as células de várias colunas no intervalo em células individuais.

Chamar essa função em um intervalo é equivalente a selecionar um intervalo e clicar em Formatar > Mesclar células > Desfazer mesclagem.

// Opens the spreadsheet 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 range A1:C6 on Sheet1.
const range = sheet.getRange('A1:C6');

// Unmerges the range A1:C6 into individual cells.
range.breakApart();

Retornar

Range: esse intervalo, 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

`canEdit()`

Determina se o usuário tem permissão para editar todas as células no intervalo. O proprietário da planilha sempre pode editar intervalos e páginas protegidos.

// Opens the spreadsheet 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 range A1:C6 on Sheet1.
const range = sheet.getRange('A1:C6');

// Logs whether the user has permission to edit every cell in the range.
console.log(range.canEdit());

Retornar

Boolean: true se o usuário tiver permissão para editar todas as células no intervalo; 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

`check()`

Muda o estado das caixas de seleção no intervalo para "marcado". Ignora as células no intervalo que não contêm o valor marcado ou desmarcado configurado.

// Changes the state of cells which currently contain either the checked or
// unchecked value configured in the range A1:B10 to 'checked'.
const range = SpreadsheetApp.getActive().getRange('A1:B10');
range.check();

Retornar

Range: esse intervalo, 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 intervalo de conteúdo e formatos.

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

const range = sheet.getRange('A1:D10');
range.clear();

Retornar

Range: esse intervalo, 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(options)`

Limpa o intervalo de conteúdo, formato, regras de validação de dados e/ou comentários, conforme especificado com as opções avançadas fornecidas. Por padrão, todos os dados são limpos.

// The code below clears range C2:G7 in the active sheet, but preserves the
// format, data validation rules, and comments.
SpreadsheetApp.getActiveSheet().getRange(2, 3, 6, 5).clear({
  contentsOnly: true
});

Parâmetros

Nome	Tipo	Descrição
`options`	`Object`	Um objeto JavaScript que especifica parâmetros avançados, conforme listado abaixo.

Parâmetros avançados

Nome	Tipo	Descrição
`commentsOnly`	`Boolean`	Se é para limpar apenas os comentários.
`contentsOnly`	`Boolean`	Se é para limpar apenas o conteúdo.
`formatOnly`	`Boolean`	Se deve limpar apenas o formato. Observe que limpar o formato também limpa as regras de validação de dados.
`validationsOnly`	`Boolean`	Se é para limpar apenas as regras de validação de dados.
`skipFilteredRows`	`Boolean`	Se as linhas filtradas não devem ser limpas.

Retornar

Range: esse intervalo, 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

`clearContent()`

Limpa o conteúdo do intervalo, deixando a formatação intacta.

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

const range = sheet.getRange('A1:D10');
range.clearContent();

Retornar

Range: esse intervalo, 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

`clearDataValidations()`

Limpa as regras de validação de dados do intervalo.

// Clear the data validation rules for cells A1:B5.
const range = SpreadsheetApp.getActive().getRange('A1:B5');
range.clearDataValidations();

Retornar

Range: esse intervalo, 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

`clearFormat()`

Limpa a formatação desse intervalo.

Isso limpa a formatação de texto da célula ou das células no intervalo, mas não redefine nenhuma regra de formatação de número.

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

const range = sheet.getRange('A1:D10');
range.clearFormat();

Retornar

Range: esse intervalo, 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

`clearNote()`

Limpa a observação na célula ou nas células especificadas.

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

const range = sheet.getRange('A1:D10');
range.clearNote();

Retornar

Range: esse intervalo, 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

`collapseGroups()`

Recolhe todos os grupos totalmente contidos no intervalo. Se nenhum grupo estiver totalmente dentro do intervalo, o grupo aberto mais profundo que estiver parcialmente dentro do intervalo será fechado.

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

// All row and column groups within the range are collapsed.
range.collapseGroups();

Retornar

Range: esse intervalo, 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

`copyFormatToRange(gridId, column, columnEnd, row, rowEnd)`

Copia a formatação do intervalo para o local especificado. Se o destino for maior ou menor que o intervalo de origem, a origem será repetida ou truncada de acordo. Esse método copia apenas a formatação.

Para uma descrição detalhada do parâmetro "gridId", consulte getGridId().

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

const range = source.getRange('B2:D4');

// This copies the formatting in B2:D4 in the source sheet to
// D4:F6 in the sheet with gridId 1555299895. Note that you can get the gridId
// of a sheet by calling sheet.getSheetId() or range.getGridId().
range.copyFormatToRange(1555299895, 4, 6, 4, 6);

Parâmetros

Nome	Tipo	Descrição
`gridId`	`Integer`	O ID exclusivo da página na planilha, independente da posição.
`column`	`Integer`	A primeira coluna do intervalo de destino.
`columnEnd`	`Integer`	A coluna final do intervalo de destino.
`row`	`Integer`	A linha inicial do intervalo de destino.
`rowEnd`	`Integer`	A linha final do intervalo de destino.

Autorização

Os scripts que usam esse mé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

getGridId()

`copyFormatToRange(sheet, column, columnEnd, row, rowEnd)`

const ss = SpreadsheetApp.getActiveSpreadsheet();
const source = ss.getSheets()[0];
const destination = ss.getSheets()[1];

const range = source.getRange('B2:D4');

// This copies the formatting in B2:D4 in the source sheet to
// D4:F6 in the second sheet
range.copyFormatToRange(destination, 4, 6, 4, 6);

Parâmetros

Nome	Tipo	Descrição
`sheet`	`Sheet`	A planilha de destino.
`column`	`Integer`	A primeira coluna do intervalo de destino.
`columnEnd`	`Integer`	A coluna final do intervalo de destino.
`row`	`Integer`	A linha inicial do intervalo de destino.
`rowEnd`	`Integer`	A linha final do intervalo de destino.

Autorização

Os scripts que usam esse mé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(destination)`

Copia os dados de um intervalo de células para outro. Tanto os valores quanto a formatação são copiados.

// The code below copies the first 5 columns over to the 6th column.
const sheet = SpreadsheetApp.getActiveSheet();
const rangeToCopy = sheet.getRange(1, 1, sheet.getMaxRows(), 5);
rangeToCopy.copyTo(sheet.getRange(1, 6));

Parâmetros

Nome	Tipo	Descrição
`destination`	`Range`	Um intervalo de destino para copiar. Apenas a posição da célula superior esquerda é relevante.

Autorização

Os scripts que usam esse mé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(destination, copyPasteType, transposed)`

Copia os dados de um intervalo de células para outro.

// The code below copies only the values of the first 5 columns over to the 6th
// column.
const sheet = SpreadsheetApp.getActiveSheet();
sheet.getRange('A:E').copyTo(
    sheet.getRange('F1'),
    SpreadsheetApp.CopyPasteType.PASTE_VALUES,
    false,
);

Parâmetros

Nome	Tipo	Descrição
`destination`	`Range`	Um intervalo de destino para copiar. Apenas a posição da célula superior esquerda é relevante.
`copyPasteType`	`CopyPasteType`	Um tipo que especifica como o conteúdo do intervalo é colado no destino.
`transposed`	`Boolean`	Indica se o intervalo precisa ser colado na orientação transposta.

Autorização

Os scripts que usam esse mé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(destination, options)`

Copia os dados de um intervalo de células para outro. Por padrão, os valores e a formatação são copiados, mas isso pode ser substituído usando argumentos avançados.

// The code below copies only the values of the first 5 columns over to the 6th
// column.
const sheet = SpreadsheetApp.getActiveSheet();
sheet.getRange('A:E').copyTo(sheet.getRange('F1'), {contentsOnly: true});

Parâmetros

Nome	Tipo	Descrição
`destination`	`Range`	Um intervalo de destino para copiar. Apenas a posição da célula superior esquerda é relevante.
`options`	`Object`	Um objeto JavaScript que especifica parâmetros avançados, conforme listado abaixo.

Parâmetros avançados

Nome	Tipo	Descrição
`formatOnly`	`Boolean`	indica que apenas o formato deve ser copiado
`contentsOnly`	`Boolean`	designa que apenas o conteúdo deve ser copiado

Autorização

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

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

`copyValuesToRange(gridId, column, columnEnd, row, rowEnd)`

Copie o conteúdo do intervalo para o local especificado. Se o destino for maior ou menor que o intervalo de origem, a origem será repetida ou truncada de acordo.

Para uma descrição detalhada do parâmetro "gridId", consulte getGridId().

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

const range = source.getRange('B2:D4');

// This copies the data in B2:D4 in the source sheet to
// D4:F6 in the sheet with gridId 0
range.copyValuesToRange(0, 4, 6, 4, 6);

Parâmetros

Nome	Tipo	Descrição
`gridId`	`Integer`	O ID exclusivo da página na planilha, independente da posição.
`column`	`Integer`	A primeira coluna do intervalo de destino.
`columnEnd`	`Integer`	A coluna final do intervalo de destino.
`row`	`Integer`	A linha inicial do intervalo de destino.
`rowEnd`	`Integer`	A linha final do intervalo de destino.

Autorização

Os scripts que usam esse mé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

getGridId()

`copyValuesToRange(sheet, column, columnEnd, row, rowEnd)`

Copie o conteúdo do intervalo para o local especificado. Se o destino for maior ou menor que o intervalo de origem, a origem será repetida ou truncada de acordo.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const source = ss.getSheets()[0];
const destination = ss.getSheets()[1];

const range = source.getRange('B2:D4');

// This copies the data in B2:D4 in the source sheet to
// D4:F6 in the second sheet
range.copyValuesToRange(destination, 4, 6, 4, 6);

Parâmetros

Nome	Tipo	Descrição
`sheet`	`Sheet`	A planilha de destino.
`column`	`Integer`	A primeira coluna do intervalo de destino.
`columnEnd`	`Integer`	A coluna final do intervalo de destino.
`row`	`Integer`	A linha inicial do intervalo de destino.
`rowEnd`	`Integer`	A linha final do intervalo de destino.

Autorização

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

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

`createDataSourcePivotTable(dataSource)`

Cria uma tabela dinâmica de fonte de dados vazia com base na fonte de dados, ancorada na primeira célula desse intervalo.

Este exemplo mostra como criar e configurar uma nova tabela dinâmica de fonte de dados.

const spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
const anchorCell = spreadsheet.getSheets()[0].getRange('A1');
const dataSource = spreadsheet.getDataSources()[0];

const pivotTable = anchorCell.createDataSourcePivotTable(dataSource);
pivotTable.addRowGroup('dataColumnA');
pivotTable.addColumnGroup('dataColumnB');
pivotTable.addPivotValue(
    'dataColumnC',
    SpreadsheetApp.PivotTableSummarizeFunction.SUM,
);
pivotTable.addFilter(
    'dataColumnA',
    SpreadsheetApp.newFilterCriteria().whenTextStartsWith('A').build(),
);

Parâmetros

Nome	Tipo	Descrição
`dataSource`	`DataSource`	A fonte de dados para criar a tabela dinâmica.

Retornar

DataSourcePivotTable: a tabela dinâmica da fonte de dados recém-criada.

Autorização

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

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

`createDataSourceTable(dataSource)`

Cria uma tabela de fonte de dados vazia com base na fonte de dados, ancorada na primeira célula desse intervalo.

Este exemplo mostra como criar e configurar uma nova tabela de fonte de dados.

const spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
const anchorCell = spreadsheet.getSheets()[0].getRange('A1');
const dataSource = spreadsheet.getDataSources()[0];

const dataSourceTable =
    anchorCell.createDataSourceTable(dataSource)
        .addColumns('dataColumnA', 'dataColumnB', 'dataColumnC')
        .addSortSpec('dataColumnA', true)    // ascending=true
        .addSortSpec('dataColumnB', false);  // ascending=false

Parâmetros

Nome	Tipo	Descrição
`dataSource`	`DataSource`	A fonte de dados para criar a tabela dinâmica.

Retornar

DataSourceTable: a tabela da fonte de dados recém-criada.

Autorização

Os scripts que usam esse mé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 DeveloperMetadataFinderApi para encontrar metadados do desenvolvedor no escopo desse intervalo. Os metadados estão no escopo do intervalo somente se estiverem totalmente contidos nele. Por exemplo, os metadados associados à linha "3:3" não estão no escopo de um intervalo "A1:D5", mas estão no escopo de um intervalo "1:5".

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the range A1:C6.
const range = sheet.getRange('A1:C6');

// Creates a developer metadata finder to search for metadata in the scope of
// this range.
const developerMetaDataFinder = range.createDeveloperMetadataFinder();

// Logs information about the developer metadata finder to the console.
const developerMetaData = developerMetaDataFinder.find()[0];
console.log(developerMetaData.getKey());
console.log(developerMetaData.getValue());
console.log(developerMetaData.getVisibility().toString());

Retornar

DeveloperMetadataFinder: um localizador de metadados do desenvolvedor para pesquisar metadados no escopo desse intervalo.

`createFilter()`

Cria um filtro e o aplica ao intervalo especificado na planilha. Não é possível criar mais de um filtro em uma página. Para acessar e modificar seu filtro depois de criá-lo, use getFilter() ou Sheet.getFilter().

const ss = SpreadsheetApp.getActiveSheet();
const range = ss.getRange('A1:C20');

// Creates a new filter and applies it to the range A1:C20 on the active sheet.
function createFilter() {
  range.createFilter();
}
// Gets the filter and applies criteria that only shows cells that aren't empty.
function getFilterAddCriteria() {
  const filter = range.getFilter();
  const criteria =
      SpreadsheetApp.newFilterCriteria().whenCellNotEmpty().build();
  filter.setColumnFilterCriteria(2, criteria);
}

Use esse método para criar filtros para planilhas Grid, o tipo padrão de planilha. As planilhas de grade não estão conectadas a um banco de dados. Para criar outros tipos de filtros, consulte o seguinte:

Criar um filtro de tabela dinâmica com PivotTable.addFilter(sourceDataColumn, filterCriteria)
Criar um filtro para uma planilha conectada a um banco de dados com DataSourceSheet.addFilter(columnName, filterCriteria)
Crie um filtro para uma tabela dinâmica conectada a um banco de dados com DataSourcePivotTable.addFilter(columnName, filterCriteria)

Retornar

Filter: o novo 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

`createPivotTable(sourceData)`

Cria uma tabela dinâmica vazia com base no sourceData especificado, ancorada na primeira célula do intervalo.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets cell A1 as a range in order to place the pivot table.
const range = sheet.getRange('A1');

// Gets the range of the source data for the pivot table.
const dataRange = sheet.getRange('E12:G20');

// Creates an empty pivot table from the specified source data.
const pivotTable = range.createPivotTable(dataRange);

// Logs the values from the pivot table's source data to the console.
console.log(pivotTable.getSourceDataRange().getValues());

Parâmetros

Nome	Tipo	Descrição
`sourceData`	`Range`	Os dados para criar a tabela dinâmica.

Retornar

PivotTable: o PivotTable recém-criado.

Autorização

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

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

`createTextFinder(findText)`

Cria um localizador de texto para o intervalo, que pode encontrar e substituir texto nele.

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

// Creates  a text finder for the range.
const textFinder = range.createTextFinder('dog');

// Returns the first occurrence of 'dog'.
const firstOccurrence = textFinder.findNext();

// Replaces the last found occurrence of 'dog' with 'cat' and returns the number
// of occurrences replaced.
const numOccurrencesReplaced = textFinder.replaceWith('cat');

Parâmetros

Nome	Tipo	Descrição
`findText`	`String`	O texto a ser pesquisado.

Retornar

TextFinder: o TextFinder do intervalo

`deleteCells(shiftDimension)`

Exclui esse intervalo de células. Os dados atuais na planilha ao longo da dimensão fornecida são movidos para o intervalo excluído.

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

const range = sheet.getRange('A1:D10');
range.deleteCells(SpreadsheetApp.Dimension.COLUMNS);

Parâmetros

Nome	Tipo	Descrição
`shiftDimension`	`Dimension`	A dimensão ao longo da qual os dados atuais serão movidos.

Autorização

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

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

`expandGroups()`

Expande os grupos recolhidos cujo intervalo ou alternância de controle se cruzam com este intervalo. O local de alternância do controle é o índice em que a alternância do controle é mostrada, diretamente antes ou depois do grupo, dependendo das configurações. Se houver mais de um grupo no mesmo local, o mais raso será expandido.

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

// All row and column groups within the range are expanded.
range.expandGroups();

Retornar

Range: esse intervalo, 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

`getA1Notation()`

Retorna uma descrição de string do intervalo na notação A1.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange(1, 1, 2, 5);

// Logs "A1:E2"
Logger.log(range.getA1Notation());

Retornar

String: a descrição da string do intervalo na notação A1.

Autorização

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

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

`getBackground()`

Retorna a cor de fundo da célula superior esquerda no intervalo (por exemplo, '#ffffff').

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

const cell = sheet.getRange('B5');
Logger.log(cell.getBackground());

Retornar

String: o código de cor do plano de fundo.

Autorização

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

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

`getBackgroundObject()`

Retorna a cor de fundo da célula superior esquerda no intervalo.

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

const cell = sheet.getRange('B5');
Logger.log(cell.getBackgroundObject().asRgbColor().asHexString());

Retornar

Color: a cor de segundo plano da célula superior esquerda no intervalo.

Autorização

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

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

`getBackgroundObjects()`

Retorna as cores de plano de fundo das células no intervalo.

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

const range = sheet.getRange('B5:C6');
const bgColors = range.getBackgroundObjects();
for (const i in bgColors) {
  for (const j in bgColors[i]) {
    Logger.log(bgColors[i][j].asRgbColor().asHexString());
  }
}

Retornar

Color[][]: uma matriz bidimensional de cores de plano de fundo.

Autorização

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

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

`getBackgrounds()`

Retorna as cores de plano de fundo das células no intervalo (por exemplo, '#ffffff').

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

const range = sheet.getRange('B5:C6');
const bgColors = range.getBackgrounds();
for (const i in bgColors) {
  for (const j in bgColors[i]) {
    Logger.log(bgColors[i][j]);
  }
}

Retornar

String[][]: uma matriz bidimensional de códigos de cores dos planos de fundo.

Autorização

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

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

`getBandings()`

Retorna todas as faixas aplicadas a qualquer célula nesse intervalo.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Sets a range.
const range = sheet.getRange('A1:K50');

// Gets the banding info for the range.
const bandings = range.getBandings();

// Logs the second row color for each banding to the console.
for (const banding of bandings) {
  console.log(banding.getSecondRowColor());
}

Retornar

Banding[]: todas as faixas aplicadas a qualquer célula nesse intervalo.

Autorização

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

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

`getCell(row, column)`

Retorna uma determinada célula em um intervalo.

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

const range = sheet.getRange('B2:D4');

// The row and column here are relative to the range
// getCell(1,1) in this code returns the cell at B2
const cell = range.getCell(1, 1);
Logger.log(cell.getValue());

Parâmetros

Nome	Tipo	Descrição
`row`	`Integer`	A linha da célula em relação ao intervalo.
`column`	`Integer`	A coluna da célula em relação ao intervalo.

Retornar

Range: um intervalo que contém uma única célula nas coordenadas especificadas.

Autorização

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

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

`getColumn()`

Retorna a posição da coluna inicial para esse intervalo.

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

const range = sheet.getRange('B2:D4');
// Logs "2.0"
Logger.log(range.getColumn());

Retornar

Integer: a posição da coluna inicial do intervalo 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

`getDataRegion()`

Retorna uma cópia do intervalo expandido nos quatro Directions cardinais para cobrir todas as células adjacentes com dados. Se o intervalo estiver cercado por células vazias que não incluem as diagonais, o próprio intervalo será retornado. Isso é semelhante a selecionar o intervalo e digitar Ctrl+A no editor.

// Assume the active spreadsheet is blank.
const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
sheet.getRange('C2').setValue(100);
sheet.getRange('B3').setValue(100);
sheet.getRange('D3').setValue(100);
sheet.getRange('C4').setValue(100);
// Logs "B2:D4"
Logger.log(sheet.getRange('C3').getDataRegion().getA1Notation());

Retornar

Range: a região de dados do intervalo ou um intervalo para toda a planilha.

Autorização

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

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

`getDataRegion(dimension)`

Retorna uma cópia do intervalo expandido Direction.UP e Direction.DOWN se a dimensão especificada for Dimension.ROWS, ou Direction.NEXT e Direction.PREVIOUS se a dimensão for Dimension.COLUMNS. A expansão do intervalo é baseada na detecção de dados próximos ao intervalo que estão organizados como uma tabela. O intervalo expandido abrange todas as células adjacentes com dados ao longo da dimensão especificada, incluindo os limites da tabela. Se o intervalo original estiver cercado por células vazias ao longo da dimensão especificada, o próprio intervalo será retornado. Esse método é semelhante a selecionar o intervalo e digitar Ctrl+Space para colunas ou Shift+Space para linhas no editor.

// Assume the active spreadsheet is blank.
const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
sheet.getRange('C2').setValue(100);
sheet.getRange('B3').setValue(100);
sheet.getRange('D3').setValue(100);
sheet.getRange('C4').setValue(100);
// Logs "C2:C4"
Logger.log(
    sheet.getRange('C3')
        .getDataRegion(SpreadsheetApp.Dimension.ROWS)
        .getA1Notation(),
);
// Logs "B3:D3"
Logger.log(
    sheet.getRange('C3')
        .getDataRegion(SpreadsheetApp.Dimension.COLUMNS)
        .getA1Notation(),
);

Parâmetros

Nome	Tipo	Descrição
`dimension`	`Dimension`	A dimensão ao longo da qual o intervalo será expandido.

Retornar

Range: a região de dados do intervalo ou um intervalo que abrange cada coluna ou cada linha abrangida pelo intervalo original.

Autorização

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

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

`getDataSourceFormula()`

Retorna o DataSourceFormula da primeira célula no intervalo ou null se a célula não contiver uma fórmula 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 the range A1 on Sheet1.
const range = sheet.getRange('A1');

// Gets the data source formula from cell A1.
const dataSourceFormula = range.getDataSourceFormula();

// Gets the formula.
const formula = dataSourceFormula.getFormula();

// Logs the formula.
console.log(formula);

Retornar

DataSourceFormula: o DataSourceFormula da 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

`getDataSourceFormulas()`

Retorna os DataSourceFormulas das células no intervalo.

// 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 the range A1:B5 on Sheet1.
const range = sheet.getRange('A1:B5');

// Gets an array of the data source formulas in the range A1:B5.
const dataSourceFormulas = range.getDataSourceFormulas();

// Logs the first formula in the array.
console.log(dataSourceFormulas[0].getFormula());

Retornar

DataSourceFormula[]: uma matriz de DataSourceFormulas.

Autorização

Os scripts que usam esse mé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 que se cruzam com o intervalo.

// 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 the range A1:G50 on Sheet1.
const range = sheet.getRange('A1:G50');

// Gets an array of the data source pivot tables in the range A1:G50.
const dataSourcePivotTables = range.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 que se cruzam com o intervalo.

// 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 the range A1:G50 on Sheet1.
const range = sheet.getRange('A1:G50');

// Gets the first data source table in the range A1:G50.
const dataSourceTable = range.getDataSourceTables()[0];

// Logs the time of the last completed data execution on the data source table.
console.log(dataSourceTable.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

`getDataSourceUrl()`

Retorna um URL para os dados nesse intervalo, que pode ser usado para criar gráficos e consultas.

Code.gs

function doGet() {
  const ss = SpreadsheetApp.openById(
      '1khO6hBWTNNyvyyxvob7aoZTI9ZvlqqASNeq0e29Tw2c',
  );
  const sheet = ss.getSheetByName('ContinentData');
  const range = sheet.getRange('A1:B8');

  const template = HtmlService.createTemplateFromFile('piechart');
  template.dataSourceUrl = range.getDataSourceUrl();
  return template.evaluate();
}

piechart.html

<!DOCTYPE html>
<html>
  <head>
    <!--Load the AJAX API-->
    <script type="text/javascript" src="https://www.gstatic.com/charts/loader.js"></script>
    <script type="text/javascript">
      // Load the Visualization API and the corechart package.
      google.charts.load('current', {'packages': ['corechart']});

      // Set a callback to run when the Google Visualization API is loaded.
      google.charts.setOnLoadCallback(queryData);

      function queryData() {
        var query = new google.visualization.Query('<?= dataSourceUrl ?>');
        query.send(drawChart);
      }

      // Callback that creates and populates a data table,
      // instantiates the pie chart, passes in the data and
      // draws it.
      function drawChart(response) {
        if (response.isError()) {
          alert('Error: ' + response.getMessage() + ' ' + response.getDetailedMessage());
          return;
        }
        var data = response.getDataTable();

        // Set chart options.
        var options = {
          title: 'Population by Continent',
          width: 400,
          height: 300
        };

        // Instantiate and draw the chart, passing in some options.
        var chart = new google.visualization.PieChart(document.getElementById('chart_div'));
        chart.draw(data, options);
      }
    </script>
  </head>
  <body>
    <!-- Div that holds the pie chart. -->
    <div id="chart_div"></div>
  </body>
</html>

Retornar

String: um URL para esse intervalo como uma fonte de dados que pode ser transmitida para outras APIs, como 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

`getDataTable()`

Retorna os dados dentro desse objeto como uma DataTable.

// 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 the range A1:B7 on Sheet1.
const range = sheet.getRange('A1:B7');

// Gets the range A1:B7 as a data table. The values in each column must be of
// the same type.
const datatable = range.getDataTable();

// Uses the Charts service to build a bar chart from the data table.
// This doesn't build an embedded chart. To do that, use
// sheet.newChart().addRange() instead.
const chart = Charts.newBarChart()
                  .setDataTable(datatable)
                  .setOption('title', 'Your Chart Title Here')
                  .build();

Retornar

DataTable: os dados como uma tabela de dados.

`getDataTable(firstRowIsHeader)`

Retorna os dados dentro desse intervalo como uma DataTable.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('A1:B7');

// Calling this method with "true" sets the first line to be the title of the
// axes
const datatable = range.getDataTable(true);

// Note that this doesn't build an EmbeddedChart, so you can't just use
// Sheet#insertChart(). To do that, use sheet.newChart().addRange() instead.
const chart = Charts.newBarChart()
                  .setDataTable(datatable)
                  .setOption('title', 'Your Title Here')
                  .build();

Parâmetros

Nome	Tipo	Descrição
`firstRowIsHeader`	`Boolean`	Se a primeira linha deve ser tratada como um cabeçalho.

Retornar

DataTable: os dados como uma tabela 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

`getDataValidation()`

Retorna a regra de validação de dados da célula superior esquerda no intervalo. Se a validação de dados não tiver sido definida na célula, esse método vai retornar null.

// Log information about the data validation rule for cell A1.
const cell = SpreadsheetApp.getActive().getRange('A1');
const rule = cell.getDataValidation();
if (rule != null) {
  const criteria = rule.getCriteriaType();
  const args = rule.getCriteriaValues();
  Logger.log('The data validation rule is %s %s', criteria, args);
} else {
  Logger.log('The cell does not have a data validation rule.');
}

Retornar

DataValidation: a regra de validação de dados da célula superior esquerda no intervalo.

Autorização

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

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

`getDataValidations()`

Retorna as regras de validação de dados para todas as células no intervalo. Se a validação de dados não tiver sido definida em uma determinada célula, esse método vai retornar null para a posição da célula na matriz.

// Change existing data validation rules that require a date in 2013 to require
// a date in 2014.
const oldDates = [new Date('1/1/2013'), new Date('12/31/2013')];
const newDates = [new Date('1/1/2014'), new Date('12/31/2014')];
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange(1, 1, sheet.getMaxRows(), sheet.getMaxColumns());
const rules = range.getDataValidations();

for (let i = 0; i < rules.length; i++) {
  for (let j = 0; j < rules[i].length; j++) {
    const rule = rules[i][j];

    if (rule != null) {
      const criteria = rule.getCriteriaType();
      const args = rule.getCriteriaValues();

      if (criteria === SpreadsheetApp.DataValidationCriteria.DATE_BETWEEN &&
          args[0].getTime() === oldDates[0].getTime() &&
          args[1].getTime() === oldDates[1].getTime()) {
        // Create a builder from the existing rule, then change the dates.
        rules[i][j] = rule.copy().withCriteria(criteria, newDates).build();
      }
    }
  }
}
range.setDataValidations(rules);

Retornar

DataValidation[][]: uma matriz bidimensional de regras de validação de dados associadas às células no intervalo.

Autorização

Os scripts que usam esse mé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 os metadados do desenvolvedor associados a esse intervalo.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets row 2 on Sheet1.
const range = sheet.getRange('2:2');

// Adds metadata to row 2.
range.addDeveloperMetadata('NAME', 'GOOGLE');

// Logs the metadata to console.
for (const metadata of range.getDeveloperMetadata()) {
  console.log(`${metadata.getKey()}: ${metadata.getValue()}`);
}

Retornar

DeveloperMetadata[]: os metadados do desenvolvedor associados a esse intervalo.

Autorização

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

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

`getDisplayValue()`

Retorna o valor mostrado da célula superior esquerda no intervalo. O valor é um String. O valor mostrado considera a formatação de data, hora e moeda, incluindo formatos aplicados automaticamente pela configuração de localidade da planilha. Células vazias retornam uma string vazia.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets cell A30 and sets its value to 'Test code.'
const cell = sheet.getRange('A30');
cell.setValue('Test code');

// Gets the value and logs it to the console.
console.log(cell.getDisplayValue());

Retornar

String: o valor mostrado nessa 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

`getDisplayValues()`

Retorna a grade retangular de valores para esse intervalo.

Retorna uma matriz bidimensional de valores mostrados, indexada por linha e depois por coluna. Os valores são objetos String. O valor mostrado considera a data, a hora e a formatação de moeda, incluindo os formatos aplicados automaticamente pela configuração regional da planilha. Células vazias são representadas por uma string vazia na matriz. Lembre-se de que, embora um índice de intervalo comece em 1, 1, a matriz JavaScript é indexada de [0][0].

// The code below gets the displayed values for the range C2:G8
// in the active spreadsheet.  Note that this is a JavaScript array.
const values =
    SpreadsheetApp.getActiveSheet().getRange(2, 3, 6, 4).getDisplayValues();
Logger.log(values[0][0]);

Retornar

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

`getFilter()`

Retorna o filtro na planilha a que esse intervalo pertence ou null se não houver filtro na planilha.

const ss = SpreadsheetApp.getActiveSheet();
const range = ss.getRange('A1:C20');
// Gets the existing filter on the sheet that the given range belongs to.
const filter = range.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

`getFontColorObject()`

Retorna a cor da fonte da célula no canto superior esquerdo do intervalo.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('B2:D4');

Logger.log(range.getFontColorObject().asRgbColor().asHexString());

Retornar

Color: a cor da fonte da célula superior esquerda no intervalo.

Autorização

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

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

`getFontColorObjects()`

Retorna as cores da fonte das células no intervalo.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('B2:D4');

const results = range.getFontColorObjects();

for (const i in results) {
  for (const j in results[i]) {
    Logger.log(results[i][j].asRgbColor().asHexString());
  }
}

Retornar

Color[][]: uma matriz bidimensional de cores de fonte associadas a células no intervalo.

Autorização

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

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

`getFontFamilies()`

Retorna as famílias de fontes das células no intervalo.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('B2:D4');

const results = range.getFontFamilies();

for (const i in results) {
  for (const j in results[i]) {
    Logger.log(results[i][j]);
  }
}

Retornar

String[][]: uma matriz bidimensional de famílias de fontes associadas a células no intervalo.

Autorização

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

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

`getFontFamily()`

Retorna a família de fontes da célula no canto superior esquerdo do intervalo.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('B2:D4');

Logger.log(range.getFontFamily());

Retornar

String: a família de fontes da 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

`getFontLine()`

Recebe o estilo da linha da célula no canto superior esquerdo do intervalo ('underline', 'line-through' ou 'none').

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('B2:D4');

Logger.log(range.getFontLine());

Retornar

String: a linha da fonte.

Autorização

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

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

`getFontLines()`

Recebe o estilo de linha das células no intervalo ('underline', 'line-through' ou 'none').

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('B2:D4');

const results = range.getFontLines();

for (const i in results) {
  for (const j in results[i]) {
    Logger.log(results[i][j]);
  }
}

Retornar

String[][]: uma matriz bidimensional de linhas de fonte associadas a células no intervalo.

Autorização

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

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

`getFontSize()`

Retorna o tamanho da fonte em pontos da célula no canto superior esquerdo do intervalo.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('B2:D4');

Logger.log(range.getFontSize());

Retornar

Integer: o tamanho da fonte em pontos.

Autorização

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

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

`getFontSizes()`

Retorna os tamanhos de fonte das células no intervalo.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('B2:D4');

const results = range.getFontSizes();

for (const i in results) {
  for (const j in results[i]) {
    Logger.log(results[i][j]);
  }
}

Retornar

Integer[][]: uma matriz bidimensional de tamanhos de fonte do texto associado às células no intervalo.

Autorização

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

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

`getFontStyle()`

Retorna o estilo da fonte ('italic' ou 'normal') da célula no canto superior esquerdo do intervalo.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('B2:D4');

Logger.log(range.getFontStyle());

Retornar

String: o estilo da fonte do texto na 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

`getFontStyles()`

Retorna os estilos de fonte das células no intervalo.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('B2:D4');

const results = range.getFontStyles();

for (const i in results) {
  for (const j in results[i]) {
    Logger.log(results[i][j]);
  }
}

Retornar

String[][]: uma matriz bidimensional de estilos de fonte do texto associado às células no intervalo.

Autorização

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

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

`getFontWeight()`

Retorna a espessura da fonte (normal/negrito) da célula no canto superior esquerdo do intervalo.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('B2:D4');

Logger.log(range.getFontWeight());

Retornar

String: o peso da fonte do texto na 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

`getFontWeights()`

Retorna as espessuras da fonte das células no intervalo.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('B2:D4');

const results = range.getFontWeights();

for (const i in results) {
  for (const j in results[i]) {
    Logger.log(results[i][j]);
  }
}

Retornar

String[][]: uma matriz bidimensional de pesos de fonte do texto associado às células no intervalo.

Autorização

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

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

`getFormula()`

Retorna a fórmula (notação A1) da célula superior esquerda do intervalo ou uma string vazia se a célula estiver vazia ou não contiver uma fórmula.

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

// This assumes you have a function in B5 that sums up
// B2:B4
const range = sheet.getRange('B5');

// Logs the calculated value and the formula
Logger.log(
    'Calculated value: %s Formula: %s',
    range.getValue(),
    range.getFormula(),
);

Retornar

String: a fórmula da 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

`getFormulaR1C1()`

Retorna a fórmula (notação R1C1) de uma determinada célula ou null se não houver nenhuma.

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

const range = sheet.getRange('B5');
const formula = range.getFormulaR1C1();
Logger.log(formula);

Retornar

String: a fórmula na notação R1C1.

Autorização

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

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

`getFormulas()`

Retorna as fórmulas (notação A1) das células no intervalo. As entradas na matriz 2D são strings vazias para células sem fórmula.

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

const range = sheet.getRange('B5:C6');
const formulas = range.getFormulas();
for (const i in formulas) {
  for (const j in formulas[i]) {
    Logger.log(formulas[i][j]);
  }
}

Retornar

String[][]: uma matriz bidimensional de fórmulas no formato de string.

Autorização

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

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

`getFormulasR1C1()`

Retorna as fórmulas (notação R1C1) das células no intervalo. As entradas na matriz 2D são null para células sem fórmula.

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

const range = sheet.getRange('B5:C6');
const formulas = range.getFormulasR1C1();
for (const i in formulas) {
  for (const j in formulas[i]) {
    Logger.log(formulas[i][j]);
  }
}

Retornar

String[][]: uma matriz bidimensional de fórmulas na notação R1C1.

Autorização

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

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

`getGridId()`

Retorna o ID da grade da planilha mãe do intervalo. Os IDs são valores int aleatórios não negativos.

// Log the grid ID of the first sheet (by tab position) in the spreadsheet.
const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('B2:D4');

Logger.log(range.getGridId());

Retornar

Integer: o ID da grade da 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

`getHeight()`

Retorna a altura do intervalo.

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

const range = sheet.getRange('B2:D4');
// logs 3.0
Logger.log(range.getHeight());

Retornar

Integer: a altura do intervalo.

Autorização

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

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

`getHorizontalAlignment()`

Retorna o alinhamento horizontal do texto (esquerda/centralizado/direita) da célula no canto superior esquerdo do intervalo.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('B2:D4');

Logger.log(range.getHorizontalAlignment());

Retornar

String: o alinhamento horizontal do texto na 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

`getHorizontalAlignments()`

Retorna os alinhamentos horizontais das células no intervalo.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('B2:D4');

const results = range.getHorizontalAlignments();

for (const i in results) {
  for (const j in results[i]) {
    Logger.log(results[i][j]);
  }
}

Retornar

String[][]: uma matriz bidimensional de alinhamentos horizontais de texto associados a células no intervalo.

Autorização

Os scripts que usam esse mé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 coluna final.

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

const range = sheet.getRange('B2:D4');
// Logs "4.0"
Logger.log(range.getLastColumn());

Retornar

Integer: a posição da coluna final do intervalo 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

`getLastRow()`

Retorna a posição da linha final.

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

const range = sheet.getRange('B2:D4');
// Logs "4.0"
Logger.log(range.getLastRow());

Retornar

Integer: a posição da linha final do intervalo 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

`getMergedRanges()`

Retorna uma matriz de objetos Range que representam células mescladas totalmente dentro do intervalo atual ou que contêm pelo menos uma célula no intervalo atual.

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

const range = sheet.getRange('A1:B3');

const mergedRanges = range.getMergedRanges();
for (let i = 0; i < mergedRanges.length; i++) {
  Logger.log(mergedRanges[i].getA1Notation());
  Logger.log(mergedRanges[i].getDisplayValue());
}

Retornar

Range[]: uma matriz de objetos Range que representam células mescladas sobrepostas ao intervalo.

`getNextDataCell(direction)`

Começando pela célula na primeira coluna e linha do intervalo, retorna a próxima célula na direção especificada que é a borda de um intervalo contíguo de células com dados ou a célula na borda da planilha nessa direção. Isso é equivalente a digitar Ctrl+[arrow key] no editor.

// Assume the active spreadsheet is blank.
const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

const range = sheet.getRange('C3:E5');
// Logs "C1"
Logger.log(range.getNextDataCell(SpreadsheetApp.Direction.UP).getA1Notation());

Parâmetros

Nome	Tipo	Descrição
`direction`	`Direction`	A direção em que encontrar a próxima célula de borda da região de dados.

Retornar

Range: a célula de borda da região de dados ou a célula na borda 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

`getNote()`

Retorna a observação associada ao intervalo especificado.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('B2:D4');

Logger.log(range.getNote());

Retornar

String: a observação associada à célula 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

`getNotes()`

Retorna as notas associadas às células no intervalo.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('B2:D4');

const results = range.getNotes();

for (const i in results) {
  for (const j in results[i]) {
    Logger.log(results[i][j]);
  }
}

Retornar

String[][]: uma matriz bidimensional de observações associadas a células no intervalo.

Autorização

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

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

`getNumColumns()`

Retorna o número de colunas nesse intervalo.

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

const range = sheet.getRange('B2:D5');
Logger.log(range.getNumColumns());

Retornar

Integer: o número de colunas neste intervalo.

Autorização

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

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

`getNumRows()`

Retorna o número de linhas nesse intervalo.

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

const range = sheet.getRange('B2:D5');
Logger.log(range.getNumRows());

Retornar

Integer: o número de linhas no intervalo.

Autorização

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

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

`getNumberFormat()`

Recebe a formatação de número ou data da célula no canto superior esquerdo do intervalo especificado. Os padrões de formato retornados são descritos na documentação da API Google Sheets.

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

const cell = sheet.getRange('C4');
Logger.log(cell.getNumberFormat());

Retornar

String: o formato de número da célula superior esquerda do intervalo.

Autorização

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

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

`getNumberFormats()`

Retorna os formatos de número ou data das células no intervalo. Os padrões de formato retornados são descritos na documentação da API Google Sheets.

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

const range = sheet.getRange('B5:C6');
const formats = range.getNumberFormats();
for (const i in formats) {
  for (const j in formats[i]) {
    Logger.log(formats[i][j]);
  }
}

Retornar

String[][]: uma matriz bidimensional de formatos de número.

Autorização

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

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

`getRichTextValue()`

Retorna o valor de texto avançado da célula superior esquerda do intervalo ou null se o valor da célula não for texto.

// Gets the Rich Text value of cell D4.
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('D4:F6');
const richText = range.getRichTextValue();
console.log(richText.getText());

Retornar

RichTextValue: o valor de texto avançado da célula superior esquerda no intervalo ou null se o valor da célula não for texto.

Autorização

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

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

`getRichTextValues()`

Retorna os valores de texto formatado das células no intervalo.

// Gets the Rich Text values for all cells in range B5:C6
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('B5:C6');
const values = range.getRichTextValues();

for (let i = 0; i < values.length; i++) {
  for (let j = 0; j < values[i].length; j++) {
    console.log(values[i][j].getText());
  }
}

Retornar

RichTextValue[][]: uma matriz bidimensional de valores de rich text.

Autorização

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

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

`getRow()`

Retorna a posição da linha para esse intervalo. Idêntico a getRowIndex().

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

const range = sheet.getRange('B2');
Logger.log(range.getRow());

Retornar

Integer: a posição da linha do intervalo.

Autorização

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

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

`getRowIndex()`

Retorna a posição da linha para esse intervalo. Idêntico a getRow().

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

const range = sheet.getRange('B2');
Logger.log(range.getRowIndex());

Retornar

Integer: a posição da linha do intervalo.

Autorização

Os scripts que usam esse mé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

getRow()

`getSheet()`

Retorna a planilha a que esse intervalo pertence.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the range A1:D10 on Sheet1.
const range = sheet.getRange('A1:D10');

// Gets the sheet that the range belongs to.
const rangeSheet = range.getSheet();

// Gets the sheet name and logs it to the console.
console.log(rangeSheet.getName());

Retornar

Sheet: a planilha a que esse intervalo pertence.

Autorização

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

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

`getTextDirection()`

Retorna a direção do texto da célula superior esquerda do intervalo. Retorna null se a direção do texto da célula for determinada com detecção automática.

// Get the text direction of cell B1.
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('B1:D4');
Logger.log(range.getTextDirection());

Retornar

TextDirection: a direção do texto da célula superior esquerda no intervalo.

Autorização

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

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

`getTextDirections()`

Retorna as direções de texto das células no intervalo. As entradas na matriz 2D são null para células que usam a detecção automática.

// Get the text directions for all cells in range B5:C6
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('B5:C6');
const directions = range.getTextDirections();

for (let i = 0; i < directions.length; i++) {
  for (let j = 0; j < directions[i].length; j++) {
    Logger.log(directions[i][j]);
  }
}

Retornar

TextDirection[][]: uma matriz bidimensional de direções de texto.

Autorização

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

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

`getTextRotation()`

Retorna as configurações de rotação de texto da célula superior esquerda do intervalo.

// Log the text rotation settings for a cell.
const sheet = SpreadsheetApp.getActiveSheet();

const cell = sheet.getRange('A1');
Logger.log(cell.getTextRotation());

Retornar

TextRotation: as configurações de rotação de texto.

Autorização

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

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

`getTextRotations()`

Retorna as configurações de rotação de texto para as células no intervalo.

const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('B2:D4');

const results = range.getTextRotations();

for (const i in results) {
  for (const j in results[i]) {
    const rotation = results[i][j];
    Logger.log('Cell [%s, %s] has text rotation: %v', i, j, rotation);
  }
}

Retornar

TextRotation[][]: uma matriz bidimensional de rotações de texto associadas a células no intervalo.

Autorização

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

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

`getTextStyle()`

Retorna o estilo de texto da célula superior esquerda do intervalo.

// Get the text style of cell D4.
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('D4:F6');
const style = range.getTextStyle();
Logger.log(style);

Retornar

TextStyle: o estilo do texto da célula superior esquerda no intervalo.

Autorização

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

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

`getTextStyles()`

Retorna os estilos de texto das células no intervalo.

// Get the text styles for all cells in range B5:C6
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('B5:C6');
const styles = range.getTextStyles();

for (let i = 0; i < styles.length; i++) {
  for (let j = 0; j < styles[i].length; j++) {
    Logger.log(styles[i][j]);
  }
}

Retornar

TextStyle[][]: uma matriz bidimensional de estilos de texto.

Autorização

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

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

`getValue()`

Retorna o valor da célula superior esquerda no intervalo. O valor pode ser do tipo Number, Boolean, Date ou String, dependendo do valor da célula. Células vazias retornam uma string vazia.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the range A1:D10 on Sheet1.
const range = sheet.getRange('A1:D10');

// Gets the value of the top-left cell in the range and logs it to the console.
console.log(range.getValue());

Retornar

Object: o valor nesta 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

`getValues()`

Retorna a grade retangular de valores para esse intervalo.

Retorna uma matriz bidimensional de valores, indexada por linha e depois por coluna. Os valores podem ser do tipo Number, Boolean, Date ou String, dependendo do valor da célula. Células vazias são representadas por uma string vazia na matriz. Lembre-se de que, embora um índice de intervalo comece em 1, 1, a matriz JavaScript é indexada de [0][0].

// The code below gets the values for the range C2:G8
// in the active spreadsheet.  Note that this is a JavaScript array.
const values = SpreadsheetApp.getActiveSheet().getRange(2, 3, 6, 4).getValues();
Logger.log(values[0][0]);

Em apps da Web, um valor Date não é um parâmetro válido. getValues() não retorna dados para um web app se o intervalo contiver uma célula com um valor Date. Em vez disso, transforme todos os valores recuperados da planilha em uma primitiva JavaScript compatível, como Number, Boolean ou String.

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

`getVerticalAlignment()`

Retorna o alinhamento vertical (superior/central/inferior) da célula no canto superior esquerdo do intervalo.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('B2:D4');

Logger.log(range.getVerticalAlignment());

Retornar

String: o alinhamento vertical do texto na 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

`getVerticalAlignments()`

Retorna os alinhamentos verticais das células no intervalo.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('B2:D4');

const results = range.getVerticalAlignments();

for (const i in results) {
  for (const j in results[i]) {
    Logger.log(results[i][j]);
  }
}

Retornar

String[][]: uma matriz bidimensional de alinhamentos verticais de texto associados a células no intervalo.

Autorização

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

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

`getWidth()`

Retorna a largura do intervalo em colunas.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the range A1:D10 on Sheet1.
const range = sheet.getRange('A1:D10');

// Gets the width of the range in number of columns and logs it to the console.
console.log(range.getWidth());

Retornar

Integer: o número de colunas no intervalo.

Autorização

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

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

`getWrap()`

Retorna se o texto na célula é quebrado. Para uma estratégia de ajuste de texto mais granular, use getWrapStrategy().

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('B2:D4');

Logger.log(range.getWrap());

Retornar

Boolean: indica se o texto nesta célula é ajustado ou nã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

`getWrapStrategies()`

Retorna as estratégias de quebra de texto para as células no intervalo.

// Get the text wrapping strategies for all cells in range B5:C6
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('B5:C6');
const strategies = range.getWrapStrategies();

for (let i = 0; i < strategies.length; i++) {
  for (let j = 0; j < strategies[i].length; j++) {
    Logger.log(strategies[i][j]);
  }
}

Retornar

WrapStrategy[][]: uma matriz bidimensional de estratégias de ajuste de texto.

Autorização

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

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

`getWrapStrategy()`

Retorna a estratégia de quebra de texto da célula superior esquerda do intervalo.

// Get the text wrapping strategy of cell B1.
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('B1:D4');
Logger.log(range.getWrapStrategy());

Retornar

WrapStrategy: a estratégia de quebra de texto da célula superior esquerda no intervalo.

Autorização

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

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

`getWraps()`

Retorna se o texto nas células é quebrado. Para uma estratégia de ajuste de texto mais granular, use getWrapStrategies().

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('B2:D4');

const results = range.getVerticalAlignments();

for (const i in results) {
  for (const j in results[i]) {
    const isWrapped = results[i][j];
    if (isWrapped) {
      Logger.log('Cell [%s, %s] has wrapped text', i, j);
    }
  }
}

Retornar

Boolean[][]: uma matriz bidimensional de alinhamentos verticais de texto associados a células no intervalo.

Autorização

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

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

`insertCells(shiftDimension)`

Insere células vazias nesse intervalo. As novas células mantêm a formatação das células que ocupavam esse intervalo. Os dados atuais na planilha ao longo da dimensão fornecida são movidos para longe do intervalo inserido.

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

const range = sheet.getRange('A1:D10');
range.insertCells(SpreadsheetApp.Dimension.COLUMNS);

Parâmetros

Nome	Tipo	Descrição
`shiftDimension`	`Dimension`	A dimensão ao longo da qual os dados atuais serão movidos.

Retornar

Range: esse intervalo, 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

`insertCheckboxes()`

Insere caixas de seleção em cada célula do intervalo, configuradas com true para marcadas e false para desmarcadas. Define o valor de todas as células no intervalo como false.

const range = SpreadsheetApp.getActive().getRange('A1:B10');

// Inserts checkboxes into each cell in the range A1:B10 configured with 'true'
// for checked and 'false' for unchecked. Also, sets the value of each cell in
// the range A1:B10 to 'false'.
range.insertCheckboxes();

Retornar

Range: esse intervalo, 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

`insertCheckboxes(checkedValue)`

Insere caixas de seleção em cada célula do intervalo, configuradas com um valor personalizado para marcado e a string vazia para desmarcado. Define o valor de cada célula no intervalo como a string vazia.

const range = SpreadsheetApp.getActive().getRange('A1:B10');

// Inserts checkboxes into each cell in the range A1:B10 configured with 'yes'
// for checked and the empty string for unchecked. Also, sets the value of each
// cell in the range A1:B10 to
//  the empty string.
range.insertCheckboxes('yes');

Parâmetros

Nome	Tipo	Descrição
`checkedValue`	`Object`	O valor marcado para a validação de dados da caixa de seleção.

Retornar

Range: esse intervalo, 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

`insertCheckboxes(checkedValue, uncheckedValue)`

Insere caixas de seleção em cada célula do intervalo, configuradas com valores personalizados para os estados marcados e desmarcados. Define o valor de cada célula no intervalo como o valor personalizado não marcado.

const range = SpreadsheetApp.getActive().getRange('A1:B10');

// Inserts checkboxes into each cell in the range A1:B10 configured with 'yes'
// for checked and 'no' for unchecked. Also, sets the value of each cell in the
// range A1:B10 to 'no'.
range.insertCheckboxes('yes', 'no');

Parâmetros

Nome	Tipo	Descrição
`checkedValue`	`Object`	O valor marcado para a validação de dados da caixa de seleção.
`uncheckedValue`	`Object`	O valor desmarcado para a validação de dados da caixa de seleção.

Retornar

Range: esse intervalo, 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

`isBlank()`

Retorna true se o intervalo estiver totalmente em branco.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('B2:D4');

Logger.log(range.isBlank());

Retornar

Boolean: true se o intervalo estiver em branco; 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

`isChecked()`

Retorna se todas as células no intervalo têm o estado da caixa de seleção como "marcado". Retorna null se algumas células estiverem marcadas e o restante desmarcado ou se algumas células não tiverem validação de dados de caixa de seleção.

const range = SpreadsheetApp.getActive().getRange('A1:A3');

// Inserts checkboxes and sets each cell value to 'no' in the range A1:A3.
range.insertCheckboxes('yes', 'no');

const range1 = SpreadsheetApp.getActive().getRange('A1');
range1.setValue('yes');
// Sets the value of isRange1Checked as true as it contains the checked value.
const isRange1Checked = range1.isChecked();

const range2 = SpreadsheetApp.getActive().getRange('A2');
range2.setValue('no');
// Sets the value of isRange2Checked as false as it contains the unchecked
// value.
const isRange2Checked = range2.isChecked();

const range3 = SpreadsheetApp.getActive().getRange('A3');
range3.setValue('random');
// Sets the value of isRange3Checked as null, as it contains an invalid checkbox
// value.
const isRange3Checked = range3.isChecked();

Retornar

Boolean: true se todas as células no intervalo estiverem marcadas, false se todas as células no intervalo estiverem desmarcadas ou null se alguma das células estiver desmarcada ou não tiver validação de dados de caixa de seleçã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

`isEndColumnBounded()`

Determina se o fim do intervalo está vinculado a uma coluna específica. Por exemplo, para os intervalos A1:B10 ou B:B, que estão vinculados a colunas no final do intervalo, esse método retorna true. Para os intervalos 3:7 ou A1:5, que estão vinculados apenas a linhas específicas no final do intervalo, esse método retorna false.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the range A1:D10 on Sheet1.
const range = sheet.getRange('A1:D10');

// Determines if the end of the range is bound to a particular column and logs
// it to the console.
console.log(range.isEndColumnBounded());

Retornar

Boolean: true se o fim do intervalo estiver vinculado a uma coluna específica; 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

`isEndRowBounded()`

Determina se o fim do intervalo está vinculado a uma linha específica. Por exemplo, para os intervalos A1:B10 ou 3:7, que estão vinculados a linhas no final do intervalo, esse método retorna true. Para os intervalos B:B ou A1:C, que estão vinculados apenas a colunas específicas no final do intervalo, esse método retorna false.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the range A1:D10 on Sheet1.
const range = sheet.getRange('A1:D10');

// Determines if the end of the range is bound to a particular row and logs it
// to the console.
console.log(range.isEndRowBounded());

Retornar

Boolean: true se o fim do intervalo estiver vinculado a uma linha específica; 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

`isPartOfMerge()`

Retorna true se as células no intervalo atual se sobrepuserem a células mescladas.

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

const range = sheet.getRange('A1:B3');

// True if any of the cells in A1:B3 is included in a merge.
const isPartOfMerge = range.isPartOfMerge();

Retornar

Boolean: true se o intervalo se sobrepõe a células mescladas. Caso contrário, retorna false.

`isStartColumnBounded()`

Determina se o início do intervalo está vinculado a uma coluna específica. Por exemplo, para os intervalos A1:B10 ou B:B, que estão vinculados a colunas no início do intervalo, esse método retorna true. Para o intervalo 3:7, que está vinculado apenas a uma linha no início do intervalo, esse método retorna false.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the range A1:D10 on Sheet1.
const range = sheet.getRange('A1:D10');

// Determines if the start of the range is bound to a particular column and logs
// it to the console.
console.log(range.isStartColumnBounded());

Retornar

Boolean: true se o início do intervalo estiver vinculado a uma coluna específica. Caso contrário, false.

Autorização

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

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

`isStartRowBounded()`

Determina se o início do intervalo está vinculado a uma linha específica. Por exemplo, para os intervalos A1:B10 ou 3:7, que estão vinculados a linhas no início do intervalo, esse método retorna true. Para o intervalo B:B, que está vinculado apenas a uma coluna específica no início do intervalo, esse método retorna false.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the range A1:D10 on Sheet1.
const range = sheet.getRange('A1:D10');

// Determines if the start of the range is bound to a particular row and logs it
// to the console.
console.log(range.isStartRowBounded());

Retornar

Boolean: true se o início do intervalo estiver vinculado a uma linha específica; 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

`merge()`

Mescla as células no intervalo em um único bloco.

const sheet = SpreadsheetApp.getActiveSheet();

// The code below 2-dimensionally merges the cells in A1 to B3
sheet.getRange('A1:B3').merge();

Retornar

Range: esse intervalo, 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

`mergeAcross()`

Mescla as células no intervalo em todas as colunas.

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

// The code below merges cells C5:E5 into one cell
const range1 = sheet.getRange('C5:E5');
range1.mergeAcross();

// The code below creates 2 horizontal cells, F5:H5 and F6:H6
const range2 = sheet.getRange('F5:H6');
range2.mergeAcross();

Retornar

Range: esse intervalo, 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

`mergeVertically()`

Mescla as células no intervalo.

const sheet = SpreadsheetApp.getActiveSheet();

// The code below vertically merges the cells in A1 to A10
sheet.getRange('A1:A10').mergeVertically();

// The code below creates 3 merged columns: B1 to B10, C1 to C10, and D1 to D10
sheet.getRange('B1:D10').mergeVertically();

Retornar

Range: esse intervalo, 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

`moveTo(target)`

Corte e cole (formato e valores) desse intervalo no intervalo de destino.

// The code below moves the first 5 columns over to the 6th column
const sheet = SpreadsheetApp.getActiveSheet();
sheet.getRange('A1:E').moveTo(sheet.getRange('F1'));

Parâmetros

Nome	Tipo	Descrição
`target`	`Range`	Um intervalo de destino para copiar este intervalo. Apenas a posição da célula no canto superior esquerdo é relevante.

Autorização

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

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

`offset(rowOffset, columnOffset)`

Retorna um novo intervalo que é deslocado deste intervalo pelo número de linhas e colunas especificado (que pode ser negativo). O novo intervalo tem o mesmo tamanho do original.

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

const cell = sheet.getRange('A1');

// newCell references B2
const newCell = cell.offset(1, 1);

Parâmetros

Nome	Tipo	Descrição
`rowOffset`	`Integer`	O número de linhas abaixo da célula superior esquerda do intervalo. Valores negativos representam linhas acima da célula superior esquerda do intervalo.
`columnOffset`	`Integer`	O número de colunas à direita da célula superior esquerda do intervalo. Valores negativos representam colunas à esquerda da célula superior esquerda do intervalo.

Retornar

Range: esse intervalo, para encadeamento.

`offset(rowOffset, columnOffset, numRows)`

Retorna um novo intervalo relativo ao atual, cujo ponto superior esquerdo é deslocado do intervalo atual pelas linhas e colunas fornecidas e com a altura especificada em células.

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

const cell = sheet.getRange('A1');

// newCell references B2:B3
const newRange = cell.offset(1, 1, 2);

Parâmetros

Nome	Tipo	Descrição
`rowOffset`	`Integer`	O número de linhas abaixo da célula superior esquerda do intervalo. Valores negativos representam linhas acima da célula superior esquerda do intervalo.
`columnOffset`	`Integer`	O número de colunas à direita da célula superior esquerda do intervalo. Valores negativos representam colunas à esquerda da célula superior esquerda do intervalo.
`numRows`	`Integer`	A altura em linhas do novo intervalo.

Retornar

Range: esse intervalo, para encadeamento.

`offset(rowOffset, columnOffset, numRows, numColumns)`

Retorna um novo intervalo relativo ao intervalo atual, cujo ponto superior esquerdo é deslocado do intervalo atual pelas linhas e colunas fornecidas, e com a altura e largura fornecidas em células.

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

const cell = sheet.getRange('A1');

// newCell references B2:C3
const newRange = cell.offset(1, 1, 2, 2);

Parâmetros

Nome	Tipo	Descrição
`rowOffset`	`Integer`	O número de linhas abaixo da célula superior esquerda do intervalo. Valores negativos representam linhas acima da célula superior esquerda do intervalo.
`columnOffset`	`Integer`	O número de colunas à direita da célula superior esquerda do intervalo. Valores negativos representam colunas à esquerda da célula superior esquerda do intervalo.
`numRows`	`Integer`	A altura em linhas do novo intervalo.
`numColumns`	`Integer`	A largura em colunas do novo intervalo.

Retornar

Range: esse intervalo, para encadeamento.

`protect()`

Cria um objeto que pode proteger o intervalo contra edições, exceto por usuários que têm permissão. Até que o script mude a lista de editores do intervalo (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 o intervalo permanece desprotegido. Se o intervalo já estiver protegido, esse método vai criar um novo intervalo protegido que se sobrepõe ao existente. Se uma célula estiver protegida por vários intervalos protegidos e qualquer um deles impedir que um usuário específico edite a célula, esse usuário não poderá fazer edições.

// Protect range A1:B10, then remove all other users from the list of editors.
const ss = SpreadsheetApp.getActive();
const range = ss.getRange('A1:B10');
const protection = range.protect().setDescription('Sample protected range');

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

`randomize()`

Aleatoriza a ordem das linhas no intervalo especificado.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('A1:C7');

// Randomizes the range
range.randomize();

Retornar

Range: esse intervalo, 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

`removeCheckboxes()`

Remove todas as caixas de seleção do intervalo. Limpa a validação de dados de cada célula e também o valor dela se ela contiver o valor marcado ou desmarcado.

const range = SpreadsheetApp.getActive().getRange('A1:B10');

// Inserts checkboxes and sets each cell value to 'no' in the range A1:B10.
range.insertCheckboxes('yes', 'no');

const range1 = SpreadsheetApp.getActive().getRange('A1');
range1.setValue('yes');
// Removes the checkbox data validation in cell A1 and clears its value.
range1.removeCheckboxes();

const range2 = SpreadsheetApp.getActive().getRange('A2');
range2.setValue('random');
// Removes the checkbox data validation in cell A2 but does not clear its value.
range2.removeCheckboxes();

Retornar

Range: esse intervalo, 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

`removeDuplicates()`

Remove as linhas dentro desse intervalo que contêm valores duplicados de valores em qualquer linha anterior. As linhas com valores idênticos, mas letras maiúsculas/minúsculas, formatação ou fórmulas diferentes, são consideradas cópias. Esse método também remove linhas duplicadas ocultas da visualização (por exemplo, devido a um filtro). O conteúdo fora desse intervalo não é removido.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('B1:D7');

// Remove duplicate rows in the range.
range.removeDuplicates();

Retornar

Range: o intervalo resultante após a remoção de duplicados. O tamanho do intervalo é reduzido em uma linha para cada linha removida.

Autorização

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

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

`removeDuplicates(columnsToCompare)`

Remove as linhas dentro desse intervalo que contêm valores nas colunas especificadas que são duplicados de valores em qualquer linha anterior. As linhas com valores idênticos, mas letras maiúsculas/minúsculas, formatação ou fórmulas diferentes, são consideradas cópias. Esse método também remove linhas duplicadas ocultas da visualização (por exemplo, devido a um filtro). O conteúdo fora desse intervalo não é removido.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('B1:D7');

// Remove rows which have duplicate values in column B.
range.removeDuplicates([2]);

// Remove rows which have duplicate values in both columns B and D.
range.removeDuplicates([2, 4]);

Parâmetros

Nome	Tipo	Descrição
`columnsToCompare`	`Integer[]`	As colunas a serem analisadas para valores duplicados. Se nenhuma coluna for fornecida, todas serão analisadas em busca de duplicatas.

Retornar

Range: o intervalo resultante após a remoção de duplicados. O tamanho do intervalo é reduzido em uma linha para cada linha removida.

Autorização

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

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

`setBackground(color)`

Define a cor de plano de fundo de todas as células no intervalo na notação CSS (como '#ffffff' ou 'white').

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

const range = sheet.getRange('B2:D5');
range.setBackground('red');

Parâmetros

Nome	Tipo	Descrição
`color`	`String`	Um código de cor na notação CSS (como `'#ffffff'` ou `'white'`). Um valor `null` redefine a cor.

Retornar

Range: esse intervalo, 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

`setBackgroundObject(color)`

Define a cor de fundo de todas as células no intervalo.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const bgColor = SpreadsheetApp.newColor()
                    .setThemeColor(SpreadsheetApp.ThemeColorType.BACKGROUND)
                    .build();

const range = sheet.getRange('B2:D5');
range.setBackgroundObject(bgColor);

Parâmetros

Nome	Tipo	Descrição
`color`	`Color`	A cor de plano de fundo a ser definida. O valor `null` redefine a cor de plano de fundo.

Retornar

Range: esse intervalo, 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

`setBackgroundObjects(color)`

Define uma grade retangular de cores de plano de fundo (precisa corresponder às dimensões desse intervalo).

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

const colorAccent1 = SpreadsheetApp.newColor()
                         .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT1)
                         .build();
const colorAccent2 = SpreadsheetApp.newColor()
                         .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT2)
                         .build();
const colorAccent3 = SpreadsheetApp.newColor()
                         .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT3)
                         .build();
const colorAccent4 = SpreadsheetApp.newColor()
                         .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT4)
                         .build();

const colors = [
  [colorAccent1, colorAccent2],
  [colorAccent3, colorAccent4],
];

const cell = sheet.getRange('B5:C6');
cell.setBackgroundObjects(colors);

Parâmetros

Nome	Tipo	Descrição
`color`	`Color[][]`	Uma matriz bidimensional de cores. Os valores `null` redefinem a cor.

Retornar

Range: esse intervalo, 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

`setBackgroundRGB(red, green, blue)`

Define o plano de fundo com a cor especificada usando valores RGB (números inteiros entre 0 e 255, inclusive).

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

const cell = sheet.getRange('B2');

// Sets the background to white
cell.setBackgroundRGB(255, 255, 255);

// Sets the background to red
cell.setBackgroundRGB(255, 0, 0);

Parâmetros

Nome	Tipo	Descrição
`red`	`Integer`	O valor vermelho na notação RGB.
`green`	`Integer`	O valor verde na notação RGB.
`blue`	`Integer`	O valor azul na notação RGB.

Retornar

Range: esse intervalo, 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

`setBackgrounds(color)`

Define uma grade retangular de cores de plano de fundo (precisa corresponder às dimensões desse intervalo). As cores estão na notação CSS (como '#ffffff' ou 'white').

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

const colors = [
  ['red', 'white', 'blue'],
  ['#FF0000', '#FFFFFF', '#0000FF'],  // These are the hex equivalents
];

const cell = sheet.getRange('B5:D6');
cell.setBackgrounds(colors);

Parâmetros

Nome	Tipo	Descrição
`color`	`String[][]`	Uma matriz bidimensional de cores na notação CSS (como `'#ffffff'` ou `'white'`). Os valores `null` redefinem a cor.

Retornar

Range: esse intervalo, 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

`setBorder(top, left, bottom, right, vertical, horizontal)`

Define a propriedade de borda. Os valores válidos são true (ativado), false (desativado) e null (sem alteração).

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

const cell = sheet.getRange('B2');
// Sets borders on the top and bottom, but leaves the left and right unchanged
cell.setBorder(true, null, true, null, false, false);

Parâmetros

Nome	Tipo	Descrição
`top`	`Boolean`	`true` para borda, `false` para nenhum e `null` para nenhuma mudança.
`left`	`Boolean`	`true` para borda, `false` para nenhum e `null` para nenhuma mudança.
`bottom`	`Boolean`	`true` para borda, `false` para nenhum e `null` para nenhuma mudança.
`right`	`Boolean`	`true` para borda, `false` para nenhum e `null` para nenhuma mudança.
`vertical`	`Boolean`	`true` para bordas verticais internas, `false` para nenhuma e `null` para nenhuma mudança.
`horizontal`	`Boolean`	`true` para bordas horizontais internas, `false` para nenhuma e `null` para nenhuma mudança.

Retornar

Range: esse intervalo, 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

`setBorder(top, left, bottom, right, vertical, horizontal, color, style)`

Define a propriedade de borda com cor e/ou estilo. Os valores válidos são true (ativado), false (desativado) e null (sem alteração). Para cor, use a notação de cor em CSS (como '#ffffff' ou 'white').

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

const cell = sheet.getRange('B2');
// Sets borders on the top and bottom, but leaves the left and right unchanged
// Also sets the color to "red", and the border to "DASHED".
cell.setBorder(
    true,
    null,
    true,
    null,
    false,
    false,
    'red',
    SpreadsheetApp.BorderStyle.DASHED,
);

Parâmetros

Nome	Tipo	Descrição
`top`	`Boolean`	`true` para borda, `false` para nenhum e `null` para nenhuma mudança.
`left`	`Boolean`	`true` para borda, `false` para nenhum e `null` para nenhuma mudança.
`bottom`	`Boolean`	`true` para borda, `false` para nenhum e `null` para nenhuma mudança.
`right`	`Boolean`	`true` para borda, `false` para nenhum e `null` para nenhuma mudança.
`vertical`	`Boolean`	`true` para bordas verticais internas, `false` para nenhuma e `null` para nenhuma mudança.
`horizontal`	`Boolean`	`true` para bordas horizontais internas, `false` para nenhuma e `null` para nenhuma mudança.
`color`	`String`	Uma cor na notação CSS (como `'#ffffff'` ou `'white'`), `null` para a cor padrão (preto).
`style`	`BorderStyle`	Um estilo para as bordas, `null` para o estilo padrão (sólido).

Retornar

Range: esse intervalo, 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

`setDataValidation(rule)`

Define uma regra de validação de dados para todas as células no intervalo.

// Set the data validation rule for cell A1 to require a value from B1:B10.
const cell = SpreadsheetApp.getActive().getRange('A1');
const range = SpreadsheetApp.getActive().getRange('B1:B10');
const rule =
    SpreadsheetApp.newDataValidation().requireValueInRange(range).build();
cell.setDataValidation(rule);

Parâmetros

Nome	Tipo	Descrição
`rule`	`DataValidation`	A regra de validação de dados a ser definida ou `null` para remover a validação de dados.

Retornar

Range: esse intervalo, 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

`setDataValidations(rules)`

Define as regras de validação de dados para todas as células no intervalo. Esse método usa uma matriz bidimensional de validações de dados, indexada por linha e coluna. As dimensões da matriz precisam corresponder às dimensões do intervalo.

// Set the data validation rules for Sheet1!A1:B5 to require a value from
// Sheet2!A1:A10.
const destinationRange =
    SpreadsheetApp.getActive().getSheetByName('Sheet1').getRange('A1:B5');
const sourceRange =
    SpreadsheetApp.getActive().getSheetByName('Sheet2').getRange('A1:A10');
const rule =
    SpreadsheetApp.newDataValidation().requireValueInRange(sourceRange).build();
const rules = destinationRange.getDataValidations();
for (let i = 0; i < rules.length; i++) {
  for (let j = 0; j < rules[i].length; j++) {
    rules[i][j] = rule;
  }
}
destinationRange.setDataValidations(rules);

Parâmetros

Nome	Tipo	Descrição
`rules`	`DataValidation[][]`	Uma matriz bidimensional de regras de validação de dados a serem definidas. Os valores `null` removem a validação de dados.

Retornar

Range: esse intervalo, 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

`setFontColor(color)`

Define a cor da fonte na notação CSS (como '#ffffff' ou 'white').

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

const cell = sheet.getRange('B2');
cell.setFontColor('red');

Parâmetros

Nome	Tipo	Descrição
`color`	`String`	A cor da fonte na notação CSS (como `'#ffffff'` ou `'white'`). Um valor `null` redefine a cor.

Retornar

Range: esse intervalo, 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

`setFontColorObject(color)`

Define a cor da fonte do intervalo especificado.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const color = SpreadsheetApp.newColor()
                  .setThemeColor(SpreadsheetApp.ThemeColorType.TEXT)
                  .build();

const cell = sheet.getRange('B2');
cell.setFontColor(color);

Parâmetros

Nome	Tipo	Descrição
`color`	`Color`	A cor da fonte a ser definida. Um valor `null` redefine a cor.

Retornar

Range: esse intervalo, 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

`setFontColorObjects(colors)`

Define uma grade retangular de cores de fonte (precisa corresponder às dimensões desse intervalo).

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

const colorAccent1 = SpreadsheetApp.newColor()
                         .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT1)
                         .build();
const colorAccent2 = SpreadsheetApp.newColor()
                         .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT2)
                         .build();
const colorAccent3 = SpreadsheetApp.newColor()
                         .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT3)
                         .build();
const colorAccent4 = SpreadsheetApp.newColor()
                         .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT4)
                         .build();

const colors = [
  [colorAccent1, colorAccent2],
  [colorAccent3, colorAccent4],
];

const cell = sheet.getRange('B5:C6');
cell.setFontColorObjects(colors);

Parâmetros

Nome	Tipo	Descrição
`colors`	`Color[][]`	Uma matriz bidimensional de cores. Os valores `null` redefinem a cor da fonte.

Retornar

Range: esse intervalo, 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

`setFontColors(colors)`

Define uma grade retangular de cores de fonte (precisa corresponder às dimensões desse intervalo). As cores estão na notação CSS (como '#ffffff' ou 'white').

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

const colors = [
  ['red', 'white', 'blue'],
  ['#FF0000', '#FFFFFF', '#0000FF'],  // These are the hex equivalents
];

const cell = sheet.getRange('B5:D6');
cell.setFontColors(colors);

Parâmetros

Nome	Tipo	Descrição
`colors`	`Object[][]`	Uma matriz bidimensional de cores na notação CSS (como `'#ffffff'` ou `'white'`). Os valores `null` redefinem a cor.

Retornar

Range: esse intervalo, 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

`setFontFamilies(fontFamilies)`

Define uma grade retangular de famílias de fontes (precisa corresponder às dimensões desse intervalo). Exemplos de famílias tipográficas são "Arial" ou "Helvetica".

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

const fonts = [
  ['Arial', 'Helvetica', 'Verdana'],
  ['Courier New', 'Arial', 'Helvetica'],
];

const cell = sheet.getRange('B2:D3');
cell.setFontFamilies(fonts);

Parâmetros

Nome	Tipo	Descrição
`fontFamilies`	`Object[][]`	Uma matriz bidimensional de famílias de fontes. Os valores `null` redefinem a família de fontes.

Retornar

Range: esse intervalo, 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

`setFontFamily(fontFamily)`

Define a família de fontes, como "Arial" ou "Helvetica".

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

const cell = sheet.getRange('B2');
cell.setFontFamily('Helvetica');

Parâmetros

Nome	Tipo	Descrição
`fontFamily`	`String`	A família de fontes a ser definida. Um valor `null` redefine a família de fontes.

Retornar

Range: esse intervalo, 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

`setFontLine(fontLine)`

Define o estilo da linha da fonte do intervalo especificado ('underline', 'line-through' ou 'none').

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

const cell = sheet.getRange('B2');
cell.setFontLine('line-through');

Parâmetros

Nome	Tipo	Descrição
`fontLine`	`String`	O estilo da linha da fonte, `'underline'`, `'line-through'` ou `'none'`. Um valor `null` redefine o estilo da linha da fonte.

Retornar

Range: esse intervalo, 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

`setFontLines(fontLines)`

Define uma grade retangular de estilos de linha (precisa corresponder às dimensões desse intervalo).

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

// The size of the two-dimensional array must match the size of the range.
const fontLines = [['underline', 'line-through', 'none']];

const range = sheet.getRange('B2:D2');
range.setFontLines(fontLines);

Parâmetros

Nome	Tipo	Descrição
`fontLines`	`Object[][]`	Uma matriz bidimensional de estilos de linha de fonte (`'underline'`, `'line-through'` ou `'none'`). Os valores `null` redefinem o estilo de linha da fonte.

Retornar

Range: esse intervalo, 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

`setFontSize(size)`

Define o tamanho da fonte, que é o tamanho do ponto a ser usado.

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

const cell = sheet.getRange('B2');
cell.setFontSize(20);

Parâmetros

Nome	Tipo	Descrição
`size`	`Integer`	Um tamanho de fonte em pontos.

Retornar

Range: esse intervalo, 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

`setFontSizes(sizes)`

Define uma grade retangular de tamanhos de fontes (precisa corresponder às dimensões desse intervalo). Os tamanhos estão em pontos.

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

// The size of the two-dimensional array must match the size of the range.
const fontSizes = [[16, 20, 24]];

const range = sheet.getRange('B2:D2');
range.setFontSizes(fontSizes);

Parâmetros

Nome	Tipo	Descrição
`sizes`	`Object[][]`	Uma matriz bidimensional de tamanhos.

Retornar

Range: esse intervalo, 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

`setFontStyle(fontStyle)`

Defina o estilo da fonte para o intervalo especificado ('italic' ou 'normal').

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

const cell = sheet.getRange('B2');
cell.setFontStyle('italic');

Parâmetros

Nome	Tipo	Descrição
`fontStyle`	`String`	O estilo da fonte, `'italic'` ou `'normal'`. Um valor `null` redefine o estilo da fonte.

Retornar

Range: esse intervalo, 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

`setFontStyles(fontStyles)`

Define uma grade retangular de estilos de fonte (precisa corresponder às dimensões desse intervalo).

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

// The size of the two-dimensional array must match the size of the range.
const fontStyles = [['italic', 'normal']];

const range = sheet.getRange('B2:C2');
range.setFontStyles(fontStyles);

Parâmetros

Nome	Tipo	Descrição
`fontStyles`	`Object[][]`	Uma matriz bidimensional de estilos de fonte, `'italic'` ou `'normal'`. Os valores `null` redefinem o estilo da fonte.

Retornar

Range: esse intervalo, 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

`setFontWeight(fontWeight)`

Define o peso da fonte para o intervalo especificado (normal/negrito).

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

const cell = sheet.getRange('B2');
cell.setFontWeight('bold');

Parâmetros

Nome	Tipo	Descrição
`fontWeight`	`String`	A espessura da fonte, `'bold'` ou `'normal'`. Um valor `null` redefine a espessura da fonte.

Retornar

Range: esse intervalo, 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

`setFontWeights(fontWeights)`

Define uma grade retangular de pesos de fontes (precisa corresponder às dimensões desse intervalo). Um exemplo de espessura da fonte é "negrito".

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

// The size of the two-dimensional array must match the size of the range.
const fontStyles = [['bold', 'bold', 'normal']];

const range = sheet.getRange('B2:D2');
range.setFontWeights(fontStyles);

Parâmetros

Nome	Tipo	Descrição
`fontWeights`	`Object[][]`	Uma matriz bidimensional de espessuras de fonte, `'bold'` ou `'normal'`. Os valores `null` redefinem a espessura da fonte.

Retornar

Range: esse intervalo, 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

`setFormula(formula)`

Atualiza a fórmula desse intervalo. A fórmula precisa estar na notação A1.

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

const cell = sheet.getRange('B5');
cell.setFormula('=SUM(B3:B4)');

Parâmetros

Nome	Tipo	Descrição
`formula`	`String`	Uma string que representa a fórmula a ser definida para a célula.

Retornar

Range: esse intervalo, 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

`setFormulaR1C1(formula)`

Atualiza a fórmula desse intervalo. A fórmula precisa estar na notação R1C1.

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

const cell = sheet.getRange('B5');
// This sets the formula to be the sum of the 3 rows above B5
cell.setFormulaR1C1('=SUM(R[-3]C[0]:R[-1]C[0])');

Parâmetros

Nome	Tipo	Descrição
`formula`	`String`	Uma fórmula de string.

Retornar

Range: esse intervalo, 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

`setFormulas(formulas)`

Define uma grade retangular de fórmulas (precisa corresponder às dimensões desse intervalo). As fórmulas fornecidas precisam estar na notação A1. Esse método usa uma matriz bidimensional de fórmulas, indexada por linha e depois por coluna. As dimensões da matriz precisam corresponder às dimensões do intervalo.

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

// This sets the formulas to be a row of sums, followed by a row of averages
// right below. The size of the two-dimensional array must match the size of the
// range.
const formulas = [
  ['=SUM(B2:B4)', '=SUM(C2:C4)', '=SUM(D2:D4)'],
  ['=AVERAGE(B2:B4)', '=AVERAGE(C2:C4)', '=AVERAGE(D2:D4)'],
];

const cell = sheet.getRange('B5:D6');
cell.setFormulas(formulas);

Parâmetros

Nome	Tipo	Descrição
`formulas`	`String[][]`	Uma matriz de strings bidimensional de fórmulas.

Retornar

Range: esse intervalo, 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

`setFormulasR1C1(formulas)`

Define uma grade retangular de fórmulas (precisa corresponder às dimensões desse intervalo). As fórmulas fornecidas precisam estar na notação R1C1.

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

// This creates formulas for a row of sums, followed by a row of averages.
const sumOfRowsAbove = '=SUM(R[-3]C[0]:R[-1]C[0])';
const averageOfRowsAbove = '=AVERAGE(R[-4]C[0]:R[-2]C[0])';

// The size of the two-dimensional array must match the size of the range.
const formulas = [
  [sumOfRowsAbove, sumOfRowsAbove, sumOfRowsAbove],
  [averageOfRowsAbove, averageOfRowsAbove, averageOfRowsAbove],
];

const cell = sheet.getRange('B5:D6');
// This sets the formula to be the sum of the 3 rows above B5.
cell.setFormulasR1C1(formulas);

Parâmetros

Nome	Tipo	Descrição
`formulas`	`String[][]`	Uma matriz bidimensional de fórmulas no formato R1C1.

Retornar

Range: esse intervalo, 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

`setHorizontalAlignment(alignment)`

Define o alinhamento horizontal (da esquerda para a direita) para o intervalo especificado (esquerda/centro/direita).

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

const cell = sheet.getRange('B2');
cell.setHorizontalAlignment('center');

Parâmetros

Nome	Tipo	Descrição
`alignment`	`String`	O alinhamento, `'left'`, `'center'` ou `'normal'`. Um valor `null` redefine o alinhamento.

Retornar

Range: esse intervalo, 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

`setHorizontalAlignments(alignments)`

Define uma grade retangular de alinhamentos horizontais. Consulte setHorizontalAlignment(alignment)

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

// The size of the two-dimensional array must match the size of the range.
const horizontalAlignments = [['left', 'right', 'center']];

const range = sheet.getRange('B2:D2');
range.setHorizontalAlignments(horizontalAlignments);

Parâmetros

Nome	Tipo	Descrição
`alignments`	`Object[][]`	Uma matriz bidimensional de alinhamentos, `'left'`, `'center'` ou `'normal'`. Um valor `null` redefine o alinhamento.

Retornar

Range: esse intervalo, 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

Consulte também

setHorizontalAlignment(alignment)

`setNote(note)`

Define a nota como o valor especificado.

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

const cell = sheet.getRange('B2');
cell.setNote('This is a note');

Parâmetros

Nome	Tipo	Descrição
`note`	`String`	O valor da nota a ser definido para o intervalo. Um valor `null` remove a nota.

Retornar

Range: esse intervalo, 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

`setNotes(notes)`

Define uma grade retangular de notas (precisa corresponder às dimensões desse intervalo).

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

// The size of the two-dimensional array must match the size of the range.
const notes = [
  ['it goes', 'like this', 'the fourth, the fifth'],
  ['the minor fall', 'and the', 'major lift'],
];

const cell = sheet.getRange('B2:D3');
cell.setNotes(notes);

Parâmetros

Nome	Tipo	Descrição
`notes`	`Object[][]`	Uma matriz bidimensional de observações. Os valores `null` removem a observação.

Retornar

Range: esse intervalo, 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

Consulte também

setNote(note)

`setNumberFormat(numberFormat)`

Define o formato de número ou data para a string de formatação especificada. Os padrões de formato aceitos são descritos na documentação da API Google Sheets.

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

const cell = sheet.getRange('B2');
// Always show 3 decimal points
cell.setNumberFormat('0.000');

Parâmetros

Nome	Tipo	Descrição
`numberFormat`	`String`	Uma string de formato de número.

Retornar

Range: esse intervalo, 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

`setNumberFormats(numberFormats)`

Define uma grade retangular de formatos de número ou data (precisa corresponder às dimensões desse intervalo). Os valores são strings de padrão de formato, conforme descrito na documentação da API Google Sheets.

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

// The size of the two-dimensional array must match the size of the range.
const formats = [['0.000', '0,000,000', '$0.00']];

const range = sheet.getRange('B2:D2');
range.setNumberFormats(formats);

Parâmetros

Nome	Tipo	Descrição
`numberFormats`	`Object[][]`	Uma matriz bidimensional de formatos de número.

Retornar

Range: esse intervalo, 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

`setRichTextValue(value)`

Define o valor de rich text para as células no intervalo.

// Sets all cells in range B2:D4 to have the text "Hello world", with "Hello"
// bolded.
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('B2:D4');
const bold = SpreadsheetApp.newTextStyle().setBold(true).build();
const richText = SpreadsheetApp.newRichTextValue()
                     .setText('Hello world')
                     .setTextStyle(0, 5, bold)
                     .build();
range.setRichTextValue(richText);

Parâmetros

Nome	Tipo	Descrição
`value`	`RichTextValue`	O valor de rich text desejado.

Retornar

Range: esse intervalo, 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

`setRichTextValues(values)`

Define uma grade retangular de valores de rich text.

// Sets the cells in range A1:A2 to have Rich Text values.
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:A2');
const bold = SpreadsheetApp.newTextStyle().setBold(true).build();
const italic = SpreadsheetApp.newTextStyle().setItalic(true).build();
const richTextA1 = SpreadsheetApp.newRichTextValue()
                       .setText('This cell is bold')
                       .setTextStyle(bold)
                       .build();
const richTextA2 = SpreadsheetApp.newRichTextValue()
                       .setText('bold words, italic words')
                       .setTextStyle(0, 11, bold)
                       .setTextStyle(12, 24, italic)
                       .build();
range.setRichTextValues([[richTextA1], [richTextA2]]);

Parâmetros

Nome	Tipo	Descrição
`values`	`RichTextValue[][]`	Os valores de rich text desejados.

Retornar

Range: esse intervalo, 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

`setShowHyperlink(showHyperlink)`

Define se o intervalo deve mostrar hiperlinks.

// 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets cell A30 and sets its hyperlink value.
const range = sheet.getRange('A30');
range.setValue('https://www.example.com');

// Sets cell A30 to show hyperlinks.
range.setShowHyperlink(true);

Parâmetros

Nome	Tipo	Descrição
`showHyperlink`	`Boolean`	Indica se o hiperlink será mostrado ou não.

Retornar

Range: esse intervalo, 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

`setTextDirection(direction)`

Define a direção do texto para as células no intervalo. Se uma direção especificada for null, ela será inferida e definida.

// Sets right-to-left text direction for the range.
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('B5:C6');
range.setTextDirection(SpreadsheetApp.TextDirection.RIGHT_TO_LEFT);

Parâmetros

Nome	Tipo	Descrição
`direction`	`TextDirection`	A direção de texto desejada. Se `null`, a direção será inferida antes da definição.

Retornar

Range: esse intervalo, 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

`setTextDirections(directions)`

Define uma grade retangular de direções de texto. Se uma direção especificada for null, a direção será inferida e definida.

// Copies all of the text directions from range A1:B2 over to range C5:D6.
const sheet = SpreadsheetApp.getActiveSheet();
const range1 = sheet.getRange('A1:B2');
const range2 = sheet.getRange('C5:D6');

range2.setTextRotations(range1.getTextDirections());

Parâmetros

Nome	Tipo	Descrição
`directions`	`TextDirection[][]`	As direções de texto desejadas. Se uma direção especificada for `null`, ela será inferida antes da definição.

Retornar

Range: esse intervalo, 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

`setTextRotation(degrees)`

Define as configurações de rotação do texto para as células no intervalo. A entrada corresponde ao ângulo entre a orientação de texto padrão e a desejada. Uma entrada de zero indica que o texto está definido na orientação padrão.

Para a direção do texto da esquerda para a direita, os ângulos positivos estão no sentido anti-horário, enquanto para a direita para a esquerda, eles estão no sentido horário.

// Sets all cell's in range B2:D4 to have text rotated up 45 degrees.
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('B2:D4');

range.setTextRotation(45);

Parâmetros

Nome	Tipo	Descrição
`degrees`	`Integer`	O ângulo desejado entre a orientação padrão e a orientação desejada. Para texto da esquerda para a direita, ângulos positivos estão no sentido anti-horário.

Retornar

Range: esse intervalo, 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

`setTextRotation(rotation)`

Define as configurações de rotação do texto para as células no intervalo.

// Sets all cell's in range B2:D4 to have the same text rotation settings as
// cell A1.
const sheet = SpreadsheetApp.getActiveSheet();

const rotation = sheet.getRange('A1').getTextRotation();

sheet.getRange('B2:D4').setTextRotation(rotation);

Parâmetros

Nome	Tipo	Descrição
`rotation`	`TextRotation`	As configurações de rotação de texto desejadas.

Retornar

Range: esse intervalo, 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

`setTextRotations(rotations)`

Define uma grade retangular de rotações de texto.

// Copies all of the text rotations from range A1:B2 over to range C5:D6.
const sheet = SpreadsheetApp.getActiveSheet();
const range1 = sheet.getRange('A1:B2');
const range2 = sheet.getRange('C5:D6');

range2.setTextRotations(range1.getTextRotations());

Parâmetros

Nome	Tipo	Descrição
`rotations`	`TextRotation[][]`	As configurações de rotação de texto desejadas.

Retornar

Range: esse intervalo, 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

`setTextStyle(style)`

Define o estilo do texto para as células no intervalo.

// Sets the cells in range C5:D6 to have underlined size 15 font.
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('C5:D6');
const style =
    SpreadsheetApp.newTextStyle().setFontSize(15).setUnderline(true).build();
range.setTextStyle(style);

Parâmetros

Nome	Tipo	Descrição
`style`	`TextStyle`	O estilo de texto desejado.

Retornar

Range: esse intervalo, 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

`setTextStyles(styles)`

Define uma grade retangular de estilos de texto.

// Sets text styles for cells in range A1:B2
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:B2');
const bold = SpreadsheetApp.newTextStyle().setBold(true).build();
const otherStyle = SpreadsheetApp.newTextStyle()
                       .setBold(true)
                       .setUnderline(true)
                       .setItalic(true)
                       .setForegroundColor('#335522')
                       .setFontSize(44)
                       .build();
range.setTextStyles([
  [bold, otherStyle],
  [otherStyle, bold],
]);

Parâmetros

Nome	Tipo	Descrição
`styles`	`TextStyle[][]`	Os estilos de texto desejados.

Retornar

Range: esse intervalo, 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

`setValue(value)`

Define o valor do intervalo. O valor pode ser numérico, string, booleano ou data. Se começar com '=', será interpretado como uma fórmula.

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

const cell = sheet.getRange('B2');
cell.setValue(100);

Parâmetros

Nome	Tipo	Descrição
`value`	`Object`	O valor do intervalo.

Retornar

Range: esse intervalo, 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

`setValues(values)`

Define uma grade retangular de valores (precisa corresponder às dimensões desse intervalo). Se um valor começar com =, ele será interpretado como uma fórmula.

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

// The size of the two-dimensional array must match the size of the range.
const values = [['2.000', '1,000,000', '$2.99']];

const range = sheet.getRange('B2:D2');
range.setValues(values);

Parâmetros

Nome	Tipo	Descrição
`values`	`Object[][]`	Uma matriz bidimensional de valores.

Retornar

Range: esse intervalo, 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

`setVerticalAlignment(alignment)`

Defina o alinhamento vertical (de cima para baixo) para o intervalo especificado (parte de cima/meio/parte de baixo).

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

const cell = sheet.getRange('B2');
cell.setVerticalAlignment('middle');

Parâmetros

Nome	Tipo	Descrição
`alignment`	`String`	O alinhamento, `'top'`, `'middle'` ou `'bottom'`. Um valor `null` redefine o alinhamento.

Retornar

Range: esse intervalo, 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

`setVerticalAlignments(alignments)`

Define uma grade retangular de alinhamentos verticais (precisa corresponder às dimensões desse intervalo).

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

// The size of the two-dimensional array must match the size of the range.
const alignments = [['top', 'middle', 'bottom']];

const range = sheet.getRange('B2:D2');
range.setVerticalAlignments(alignments);

Parâmetros

Nome	Tipo	Descrição
`alignments`	`Object[][]`	Uma matriz bidimensional de alinhamentos, `'top'`, `'middle'` ou `'bottom'`. Um valor `null` redefine o alinhamento.

Retornar

Range: esse intervalo, 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

Consulte também

setVerticalAlignment(alignment)

`setVerticalText(isVertical)`

Define se o texto das células no intervalo será empilhado ou não. Se o texto estiver empilhado verticalmente, a configuração de rotação do texto em graus será ignorada.

// Sets all cell's in range B2:D4 to have vertically stacked text.
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('B2:D4');

range.setVerticalText(true);

Parâmetros

Nome	Tipo	Descrição
`isVertical`	`Boolean`	Se o texto será empilhado ou não.

Retornar

Range: esse intervalo, 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

`setWrap(isWrapEnabled)`

Define o ajuste de texto da célula do intervalo especificado.

As células com o ajuste ativado (o padrão) são redimensionadas para mostrar todo o conteúdo. As células com quebra desativada mostram o máximo possível na célula sem redimensionar ou ocupar várias linhas.

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

const cell = sheet.getRange('B2');
cell.setWrap(true);

Parâmetros

Nome	Tipo	Descrição
`isWrapEnabled`	`Boolean`	Se o texto deve ser ajustado ou não.

Retornar

Range: esse intervalo, 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

`setWrapStrategies(strategies)`

Define uma grade retangular de estratégias de ajuste de texto.

// Copies all of the wrap strategies from range A1:B2 over to range C5:D6.
const sheet = SpreadsheetApp.getActiveSheet();
const range1 = sheet.getRange('A1:B2');
const range2 = sheet.getRange('C5:D6');

range2.setWrapStrategies(range1.getWrapStrategies());

Parâmetros

Nome	Tipo	Descrição
`strategies`	`WrapStrategy[][]`	As estratégias de quebra de linha desejadas.

Retornar

Range: esse intervalo, 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

`setWrapStrategy(strategy)`

Define a estratégia de quebra de texto para as células no intervalo.

// Sets all cells in range B2:D4 to use the clip wrap strategy.
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('B2:D4');

range.setWrapStrategy(SpreadsheetApp.WrapStrategy.CLIP);

Parâmetros

Nome	Tipo	Descrição
`strategy`	`WrapStrategy`	A estratégia de quebra de linha desejada.

Retornar

Range: esse intervalo, 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

`setWraps(isWrapEnabled)`

Define uma grade retangular de políticas de quebra de texto (precisa corresponder às dimensões desse intervalo). As células com o ajuste ativado (o padrão) são redimensionadas para mostrar todo o conteúdo. As células com o ajuste de texto desativado mostram o máximo possível na célula sem redimensionar ou ocupar várias linhas.

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

// The size of the two-dimensional array must match the size of the range.
const wraps = [[true, true, false]];

const range = sheet.getRange('B2:D2');
range.setWraps(wraps);

Parâmetros

Nome	Tipo	Descrição
`isWrapEnabled`	`Object[][]`	Uma matriz bidimensional de variáveis de ajuste que determinam se o texto em uma célula deve ser ajustado ou não.

Retornar

Range: esse intervalo, 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

Consulte também

setWrap(isWrapEnabled)

`shiftColumnGroupDepth(delta)`

Muda a profundidade do agrupamento de colunas do intervalo pela quantidade especificada.

Isso cria, modifica ou exclui grupos que se cruzam com o intervalo. Para deltas positivos, os grupos são criados e/ou modificados. Para deltas negativos, os grupos são destruídos e/ou modificados.

Isso não tem efeito ao diminuir a profundidade do grupo abaixo de zero ou acima de oito.

Se o column group control position for BEFORE, isso vai gerar um erro ao tentar mudar a profundidade da primeira linha.

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

// The column grouping depth is increased by 1.
range.shiftColumnGroupDepth(1);

// The column grouping depth is decreased by 1.
range.shiftColumnGroupDepth(-1);

Parâmetros

Nome	Tipo	Descrição
`delta`	`Integer`	O valor pelo qual mudar a profundidade do grupo de colunas desse intervalo.

Retornar

Range: esse intervalo, para encadeamento.

Gera

Error: ao tentar mudar a profundidade da primeira coluna quando a posição do controle é GroupControlTogglePosition.BEFORE

Autorização

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

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

`shiftRowGroupDepth(delta)`

Muda a profundidade do agrupamento de linhas do intervalo na quantidade especificada.

Isso cria, modifica ou exclui grupos que se cruzam com o intervalo. Para deltas positivos, os grupos são criados e/ou modificados. Para deltas negativos, os grupos são destruídos e/ou modificados.

Isso não tem efeito ao diminuir a profundidade do grupo abaixo de zero ou acima de oito.

Se row group control position for BEFORE, isso vai gerar um erro ao tentar mudar a profundidade da primeira linha.

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

// The row grouping depth is increased by 1.
range.shiftRowGroupDepth(1);

// The row grouping depth is decreased by 1.
range.shiftRowGroupDepth(-1);

Parâmetros

Nome	Tipo	Descrição
`delta`	`Integer`	O valor pelo qual mudar a profundidade do grupo de linhas desse intervalo.

Retornar

Range: esse intervalo, para encadeamento.

Gera

Error: ao tentar mudar a profundidade da primeira linha quando a posição do controle é GroupControlTogglePosition.BEFORE.

Autorização

Os scripts que usam esse mé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(sortSpecObj)`

Classifica as células no intervalo especificado por coluna e ordem.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('A1:C7');

// Sorts by the values in the first column (A)
range.sort(1);

// Sorts by the values in the second column (B)
range.sort(2);

// Sorts descending by column B
range.sort({column: 2, ascending: false});

// Sorts descending by column B, then ascending by column A
// Note the use of an array
range.sort([
  {column: 2, ascending: false},
  {column: 1, ascending: true},
]);

// For rows that are sorted in ascending order, the "ascending" parameter is
// optional, and just an integer with the column can be used instead. Note that
// in general, keeping the sort specification consistent results in more
// readable code. You can express the earlier sort as:
range.sort([{column: 2, ascending: false}, 1]);

// Alternatively, if you want all columns to be in ascending order, you can use
// the following (this makes column 2 ascending)
range.sort([2, 1]);
// ... which is equivalent to
range.sort([
  {column: 2, ascending: true},
  {column: 1, ascending: true},
]);

Parâmetros

Nome	Tipo	Descrição
`sortSpecObj`	`Object`	As colunas a serem usadas para classificação.

Retornar

Range: esse intervalo, 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

`splitTextToColumns()`

Divide uma coluna de texto em várias colunas com base em um delimitador detectado automaticamente.

// A1:A3 has the following values:
//           A                  B                 C
// 1 |one,one,one      |                 |                 |
// 2 |two,two,two      |                 |                 |
// 3 |three,three,three|                 |                 |

const range = SpreadsheetApp.getActiveSheet().getRange('A1:A3');
range.splitTextToColumns();

// Result after splitting the text to columns:
//           A                  B                 C
// 1 |one              |one              |one              |
// 2 |two              |two              |two              |
// 3 |three            |three            |three            |

Autorização

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

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

`splitTextToColumns(delimiter)`

Divide uma coluna de texto em várias colunas usando a string especificada como um delimitador personalizado.

// A1:A3 has the following values:
//           A                  B                 C
// 1 |one#one#one      |                 |                 |
// 2 |two#two#two      |                 |                 |
// 3 |three#three#three|                 |                 |

const range = SpreadsheetApp.getActiveSheet().getRange('A1:A3');
range.splitTextToColumns('#');

// Result after splitting the text to columns:
//           A                  B                 C
// 1 |one              |one              |one              |
// 2 |two              |two              |two              |
// 3 |three            |three            |three            |

Parâmetros

Nome	Tipo	Descrição
`delimiter`	`String`	O delimitador personalizado para dividir.

Autorização

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

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

`splitTextToColumns(delimiter)`

Divide uma coluna de texto em várias colunas com base no delimitador especificado.

// A1:A3 has the following values:
//           A                  B                 C
// 1 |one;one;one      |                 |                 |
// 2 |two;two;two      |                 |                 |
// 3 |three;three;three|                 |                 |

const range = SpreadsheetApp.getActiveSheet().getRange('A1:A3');
range.splitTextToColumns(SpreadsheetApp.TextToColumnsDelimiter.SEMICOLON);

// Result after splitting the text to columns:
//           A                  B                 C
// 1 |one              |one              |one              |
// 2 |two              |two              |two              |
// 3 |three            |three            |three            |

Parâmetros

Nome	Tipo	Descrição
`delimiter`	`TextToColumnsDelimiter`	O delimitador predefinido para dividir.

Autorização

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

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

`trimWhitespace()`

Remove os espaços em branco (como espaços, tabulações ou novas linhas) em todas as células desse intervalo. Remove todos os espaços em branco do início e do fim do texto de cada célula e reduz qualquer subsequência de caracteres de espaço em branco restantes a um único espaço.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
const range = sheet.getRange('A1:A4');
range.activate();
range.setValues([
  ' preceding space',
  'following space ',
  'two  middle  spaces',
  '   =SUM(1,2)',
]);

range.trimWhitespace();

const values = range.getValues();
// Values are ['preceding space', 'following space', 'two middle spaces',
// '=SUM(1,2)']

Retornar

Range: esse intervalo, 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

`uncheck()`

Muda o estado das caixas de seleção no intervalo para "desmarcado". Ignora as células no intervalo que não contêm o valor marcado ou desmarcado configurado.

// Changes the state of cells which currently contain either the checked or
// unchecked value configured in the range A1:B10 to 'unchecked'.
const range = SpreadsheetApp.getActive().getRange('A1:B10');
range.uncheck();

Retornar

Range: esse intervalo, 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

Métodos obsoletos

`getFontColor()`

Obsoleto. Substituído por getFontColorObject()

Retorna a cor da fonte da célula no canto superior esquerdo do intervalo, na notação CSS (como '#ffffff' ou 'white').

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('B2:D4');

Logger.log(range.getFontColor());

Retornar

String: a cor da fonte na notação CSS (como '#ffffff' ou 'white').

Autorização

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

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

`getFontColors()`

Obsoleto. Substituído por getFontColorObjects()

Retorna as cores da fonte das células no intervalo na notação CSS (como '#ffffff' ou 'white').

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('B2:D4');

const results = range.getFontColors();

for (const i in results) {
  for (const j in results[i]) {
    Logger.log(results[i][j]);
  }
}

Retornar

String[][]: uma matriz bidimensional de cores de fonte associadas a células no intervalo.

Autorização

Os scripts que usam esse mé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 Range 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

activateAsCurrentCell()

Retornar

Autorização

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

applyColumnBanding()

Retornar

Autorização

applyColumnBanding(bandingTheme)

Parâmetros

Retornar

Autorização

applyColumnBanding(bandingTheme, showHeader, showFooter)

Parâmetros

Retornar

Autorização

applyRowBanding()

Retornar

Autorização

applyRowBanding(bandingTheme)

Parâmetros

Retornar

Autorização

applyRowBanding(bandingTheme, showHeader, showFooter)

Parâmetros

Retornar

Autorização

autoFill(destination, series)

Parâmetros

Autorização

autoFillToNeighbor(series)

Parâmetros

Autorização

breakApart()

Retornar

Autorização

canEdit()

Retornar

Autorização

check()

Retornar

Autorização

clear()

Retornar

Autorização

clear(options)

Parâmetros

Parâmetros avançados

Retornar

Autorização

clearContent()

Retornar

Autorização

clearDataValidations()

Retornar

Autorização

clearFormat()

Retornar

Autorização

clearNote()

Class Range

`activate()`

`activateAsCurrentCell()`

`addDeveloperMetadata(key)`

`addDeveloperMetadata(key, visibility)`

`addDeveloperMetadata(key, value)`

`addDeveloperMetadata(key, value, visibility)`

`applyColumnBanding()`

`applyColumnBanding(bandingTheme)`

`applyColumnBanding(bandingTheme, showHeader, showFooter)`

`applyRowBanding()`

`applyRowBanding(bandingTheme)`

`applyRowBanding(bandingTheme, showHeader, showFooter)`

`autoFill(destination, series)`

`autoFillToNeighbor(series)`

`breakApart()`

`canEdit()`

`check()`

`clear()`

`clear(options)`

`clearContent()`

`clearDataValidations()`

`clearFormat()`

`clearNote()`

`collapseGroups()`

`copyFormatToRange(gridId, column, columnEnd, row, rowEnd)`

`copyFormatToRange(sheet, column, columnEnd, row, rowEnd)`

`copyTo(destination)`

`copyTo(destination, copyPasteType, transposed)`

`copyTo(destination, options)`

`copyValuesToRange(gridId, column, columnEnd, row, rowEnd)`

`copyValuesToRange(sheet, column, columnEnd, row, rowEnd)`

`createDataSourcePivotTable(dataSource)`

`createDataSourceTable(dataSource)`

`createDeveloperMetadataFinder()`

`createFilter()`

`createPivotTable(sourceData)`

`createTextFinder(findText)`

`deleteCells(shiftDimension)`

`expandGroups()`

`getA1Notation()`

`getBackground()`

`getBackgroundObject()`

`getBackgroundObjects()`

`getBackgrounds()`