Esta página foi traduzida pela API Cloud Translation.

Class Range

Acesse e modifique intervalos da planilha. Um intervalo pode ser uma única célula em uma página ou um grupo de células adjacentes em uma página.

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 especificada e visibilidade no 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 de faixa de colunas padrão ao intervalo.
`applyColumnBanding(bandingTheme)`	`Banding`	Aplica um tema de faixa de colunas especificado ao intervalo.
`applyColumnBanding(bandingTheme, showHeader, showFooter)`	`Banding`	Aplica um tema de banda de coluna especificado ao intervalo com configurações específicas de cabeçalho e rodapé.
`applyRowBanding()`	`Banding`	Aplica um tema de faixa de linha padrão ao intervalo.
`applyRowBanding(bandingTheme)`	`Banding`	Aplica um tema de faixa de linha especificado ao intervalo.
`applyRowBanding(bandingTheme, showHeader, showFooter)`	`Banding`	Aplica um tema de faixa de linha especificado ao intervalo com configurações específicas de cabeçalho e rodapé.
`autoFill(destination, series)`	`void`	Preenche o `destinationRange` com dados baseados nos dados deste intervalo.
`autoFillToNeighbor(series)`	`void`	Calcula um intervalo a ser preenchido com novos dados com base em células vizinhas e preenche automaticamente esse intervalo com novos valores com base nos dados contidos nesse intervalo.
`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 do intervalo.
`check()`	`Range`	Altera o estado das caixas de seleção no intervalo para "marcado".
`clear()`	`Range`	Limpa a variedade de conteúdos e formatos.
`clear(options)`	`Range`	Limpa o intervalo de conteúdo, formato, regras de validação de dados e/ou comentários, conforme especificado nas 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 para o intervalo.
`clearFormat()`	`Range`	Limpa a formatação deste intervalo.
`clearNote()`	`Range`	Limpa a nota nas células especificadas.
`collapseGroups()`	`Range`	Recolhe todos os grupos totalmente contidos no intervalo.
`copyFormatToRange(gridId, column, columnEnd, row, rowEnd)`	`void`	Copie a formatação do intervalo para o local especificado.
`copyFormatToRange(sheet, column, columnEnd, row, rowEnd)`	`void`	Copie a formatação do intervalo para o local especificado.
`copyTo(destination)`	`void`	Copia os dados de um intervalo de células para outro intervalo de células.
`copyTo(destination, copyPasteType, transposed)`	`void`	Copia os dados de um intervalo de células para outro intervalo de células.
`copyTo(destination, options)`	`void`	Copia os dados de um intervalo de células para outro intervalo de células.
`copyValuesToRange(gridId, column, columnEnd, row, rowEnd)`	`void`	Copie o conteúdo do intervalo para o local fornecido.
`copyValuesToRange(sheet, column, columnEnd, row, rowEnd)`	`void`	Copie o conteúdo do intervalo para o local fornecido.
`createDataSourcePivotTable(dataSource)`	`DataSourcePivotTable`	Cria uma tabela dinâmica de fonte de dados vazia a partir da fonte de dados, ancorada na primeira célula nesse intervalo.
`createDataSourceTable(dataSource)`	`DataSourceTable`	Cria uma tabela vazia de fonte de dados, ancorada na primeira célula nesse intervalo.
`createDeveloperMetadataFinder()`	`DeveloperMetadataFinder`	Retorna uma DeveloperMetadataFinderApi para encontrar metadados do desenvolvedor dentro do escopo desse intervalo.
`createFilter()`	`Filter`	Cria um filtro e o aplica ao intervalo especificado na página.
`createPivotTable(sourceData)`	`PivotTable`	Cria uma tabela dinâmica vazia do `sourceData` especificado ancorado na primeira célula nesse intervalo.
`createTextFinder(findText)`	`TextFinder`	Cria um localizador de texto para o intervalo, que pode localizar e substituir texto nesse intervalo.
`deleteCells(shiftDimension)`	`void`	Exclui este intervalo de células.
`expandGroups()`	`Range`	Expande os grupos recolhidos cujo intervalo ou controle alterna com esse 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 célula especificada dentro de um intervalo.
`getColumn()`	`Integer`	Retorna a posição inicial da coluna para este 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 `DataSourceFormula` para a primeira célula do 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[]`	Obtém todas as tabelas dinâmicas da fonte de dados que se cruzam com o intervalo.
`getDataSourceTables()`	`DataSourceTable[]`	Obtém todas as tabelas de fonte de dados que se cruzam com o intervalo.
`getDataSourceUrl()`	`String`	Retorna um URL para os dados deste 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`	Retorne os dados dentro desse intervalo como uma tabela de dados.
`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 do intervalo.
`getDeveloperMetadata()`	`DeveloperMetadata[]`	Obtém os metadados do desenvolvedor associados a esse intervalo.
`getDisplayValue()`	`String`	Retorna o valor exibido da célula superior esquerda no intervalo.
`getDisplayValues()`	`String[][]`	Retorna a grade retangular de valores para este intervalo.
`getFilter()`	`Filter`	Retorna o filtro na página a que esse intervalo pertence ou `null` se não houver filtro na página.
`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 os grupos de fontes das células do intervalo.
`getFontFamily()`	`String`	Retorna a família de fontes da célula no canto superior esquerdo do intervalo.
`getFontLine()`	`String`	Obtém o estilo de linha da célula no canto superior esquerdo do intervalo (`'underline'`, `'line-through'` ou `'none'`).
`getFontLines()`	`String[][]`	Obtém o estilo de linha das células no intervalo (`'underline'`, `'line-through'` ou `'none'`).
`getFontSize()`	`Integer`	Retorna o tamanho da fonte no tamanho do ponto da célula no canto superior esquerdo do intervalo.
`getFontSizes()`	`Integer[][]`	Retorna os tamanhos de fonte das células do 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 o peso da fonte (normal/negrito) da célula no canto superior esquerdo do intervalo.
`getFontWeights()`	`String[][]`	Retorna os pesos 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 células.
`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 página pai do intervalo.
`getHeight()`	`Integer`	Retorna a altura do intervalo.
`getHorizontalAlignment()`	`String`	Retorna o alinhamento horizontal do texto (esquerda/centro/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 que estão totalmente dentro do intervalo atual ou que contêm pelo menos uma célula no intervalo atual.
`getNextDataCell(direction)`	`Range`	Começa na célula da primeira coluna e linha do intervalo. Retorna a próxima célula na direção indicada, que é a borda de um intervalo contíguo de células com dados nelas ou a célula na borda da planilha nessa direção.
`getNote()`	`String`	Retorna a nota associada ao intervalo fornecido.
`getNotes()`	`String[][]`	Retorna as notas associadas às células do intervalo.
`getNumColumns()`	`Integer`	Retorna o número de colunas neste intervalo.
`getNumRows()`	`Integer`	Retorna o número de linhas neste intervalo.
`getNumberFormat()`	`String`	Obtém a formatação de número ou data da célula superior esquerda do intervalo fornecido.
`getNumberFormats()`	`String[][]`	Retorna os formatos de número ou data das células no intervalo.
`getRichTextValue()`	`RichTextValue`	Retorna o valor de rich text para a célula superior esquerda do intervalo, ou `null` se o valor da célula não for texto.
`getRichTextValues()`	`RichTextValue[][]`	Retorna os valores de rich text para as células no intervalo.
`getRow()`	`Integer`	Retorna a posição da linha do intervalo.
`getRowIndex()`	`Integer`	Retorna a posição da linha do intervalo.
`getSheet()`	`Sheet`	Retorna a página à qual o intervalo pertence.
`getTextDirection()`	`TextDirection`	Retorna a direção do texto da célula superior esquerda do intervalo.
`getTextDirections()`	`TextDirection[][]`	Retorna as rotas em texto das células do 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 das 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 este intervalo.
`getVerticalAlignment()`	`String`	Retorna o alinhamento vertical (superior/médio/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 é ajustado.
`getWrapStrategies()`	`WrapStrategy[][]`	Retorna as estratégias de ajuste de texto para as células do intervalo.
`getWrapStrategy()`	`WrapStrategy`	Retorna a estratégia de ajuste de texto para a célula do canto superior esquerdo do intervalo.
`getWraps()`	`Boolean[][]`	Retorna se o texto nas células é ajustado.
`insertCells(shiftDimension)`	`Range`	Insere células vazias nesse intervalo.
`insertCheckboxes()`	`Range`	Insere caixas de seleção em cada célula no intervalo, configuradas com `true` para marcar e `false` para desmarcada.
`insertCheckboxes(checkedValue)`	`Range`	Insere caixas de seleção em cada célula no intervalo, configuradas com um valor personalizado para marcado e a string vazia para desmarcada.
`insertCheckboxes(checkedValue, uncheckedValue)`	`Range`	Insere caixas de seleção em cada célula no 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 de caixa de seleção como "marcada".
`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` caso as células no intervalo atual se sobreponham a qualquer célula mesclada.
`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`	Mescle as células do intervalo nas colunas do intervalo.
`mergeVertically()`	`Range`	Mescla as células no intervalo.
`moveTo(target)`	`void`	Recortar e colar (formato e valores) deste intervalo para o intervalo de destino.
`offset(rowOffset, columnOffset)`	`Range`	Retorna um novo intervalo com intervalo desse número pelo número de linhas e colunas fornecido (que pode ser negativo).
`offset(rowOffset, columnOffset, numRows)`	`Range`	Retorna um novo intervalo relativo ao intervalo atual, cujo ponto superior esquerdo é deslocado do intervalo atual pelas linhas e colunas especificadas e com a altura especificada nas 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 especificadas e com a altura e largura especificadas nas células.
`protect()`	`Protection`	Cria um objeto que pode impedir que o intervalo seja editado, exceto por usuários que tenham permissão.
`randomize()`	`Range`	Ordem aleatória das linhas das linhas no intervalo fornecido.
`removeCheckboxes()`	`Range`	Remove todas as caixas de seleção do intervalo.
`removeDuplicates()`	`Range`	Remove as linhas dentro desse intervalo que contêm valores que são duplicatas 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 cópias de valores de qualquer linha anterior.
`setBackground(color)`	`Range`	Define a cor do plano de fundo de todas as células no intervalo na notação CSS (como `'#ffffff'` ou `'white'`).
`setBackgroundObject(color)`	`Range`	Define a cor do plano de fundo de todas as células do intervalo.
`setBackgroundObjects(color)`	`Range`	Define uma grade retangular de cores de fundo (deve corresponder às dimensões deste intervalo).
`setBackgroundRGB(red, green, blue)`	`Range`	Define o plano de fundo para a cor determinada usando valores RGB (números inteiros entre 0 e 255, inclusive).
`setBackgrounds(color)`	`Range`	Define uma grade retangular de cores de fundo (deve corresponder às dimensões deste intervalo).
`setBorder(top, left, bottom, right, vertical, horizontal)`	`Range`	Define a propriedade da 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 fornecido.
`setFontColorObjects(colors)`	`Range`	Define uma grade retangular de cores de fontes (precisa corresponder às dimensões deste intervalo).
`setFontColors(colors)`	`Range`	Define uma grade retangular de cores de fontes (precisa corresponder às dimensões deste intervalo).
`setFontFamilies(fontFamilies)`	`Range`	Define uma grade retangular de famílias de fonte (precisa corresponder às dimensões deste intervalo).
`setFontFamily(fontFamily)`	`Range`	Define a família de fontes, como "Arial" ou "Helvetica".
`setFontLine(fontLine)`	`Range`	Define o estilo da linha de fonte do intervalo fornecido (`'underline'`, `'line-through'` ou `'none'`).
`setFontLines(fontLines)`	`Range`	Define uma grade retangular de estilos de linha (deve corresponder às dimensões deste intervalo).
`setFontSize(size)`	`Range`	Define o tamanho da fonte, sendo que o tamanho é o tamanho de ponto a ser usado.
`setFontSizes(sizes)`	`Range`	Define uma grade retangular de tamanhos de fonte (precisa corresponder às dimensões deste intervalo).
`setFontStyle(fontStyle)`	`Range`	Define o estilo da fonte para o intervalo fornecido (`'italic'` ou `'normal'`).
`setFontStyles(fontStyles)`	`Range`	Define uma grade retangular de estilos de fonte (precisa corresponder às dimensões deste intervalo).
`setFontWeight(fontWeight)`	`Range`	Define a espessura da fonte para o intervalo fornecido (normal/negrito).
`setFontWeights(fontWeights)`	`Range`	Define uma grade retangular de pesos de fonte (deve corresponder às dimensões deste 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 deste intervalo).
`setFormulasR1C1(formulas)`	`Range`	Define uma grade retangular de fórmulas (precisa corresponder às dimensões deste intervalo).
`setHorizontalAlignment(alignment)`	`Range`	Define o alinhamento horizontal (esquerda para 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 fornecido.
`setNotes(notes)`	`Range`	Define uma grade retangular de notas (precisa corresponder às dimensões deste intervalo).
`setNumberFormat(numberFormat)`	`Range`	Define o formato do número ou a data para a string de formatação fornecida.
`setNumberFormats(numberFormats)`	`Range`	Define uma grade retangular de formatos de número ou data (deve 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 rich text.
`setShowHyperlink(showHyperlink)`	`Range`	Define se o intervalo deve exibir hiperlinks.
`setTextDirection(direction)`	`Range`	Define a direção do texto das células no intervalo.
`setTextDirections(directions)`	`Range`	Define uma grade retangular de rotas de texto.
`setTextRotation(degrees)`	`Range`	Define as configurações de rotação de texto para as células no intervalo.
`setTextRotation(rotation)`	`Range`	Define as configurações de rotação de 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 de texto das 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 deste intervalo).
`setVerticalAlignment(alignment)`	`Range`	Define o alinhamento vertical (de cima para baixo) do intervalo especificado (superior/meio/inferior).
`setVerticalAlignments(alignments)`	`Range`	Define uma grade retangular de alinhamentos verticais (precisa corresponder às dimensões desse intervalo).
`setVerticalText(isVertical)`	`Range`	Define se será necessário empilhar o texto das células no intervalo.
`setWrap(isWrapEnabled)`	`Range`	Define o ajuste de célula do intervalo fornecido.
`setWrapStrategies(strategies)`	`Range`	Define uma grade retangular de estratégias de ajuste.
`setWrapStrategy(strategy)`	`Range`	Define a estratégia de ajuste de texto para as células do intervalo.
`setWraps(isWrapEnabled)`	`Range`	Define uma grade retangular de políticas de quebra de palavras (precisa corresponder às dimensões desse intervalo).
`shiftColumnGroupDepth(delta)`	`Range`	Altera a profundidade do agrupamento de colunas do intervalo de acordo com o valor especificado.
`shiftRowGroupDepth(delta)`	`Range`	Altera a profundidade do agrupamento de linhas do intervalo pelo valor especificado.
`sort(sortSpecObj)`	`Range`	Classifica as células no intervalo especificado, por coluna e ordem especificadas.
`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`	Corta espaços em branco (como espaços, tabulações ou novas linhas) em todas as células deste intervalo.
`uncheck()`	`Range`	Altera 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, em 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.

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

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

Retornar

Range: este intervalo, para encadeamento.

`activateAsCurrentCell()`

Define a célula especificada como current cell.

Se a célula especificada estiver presente em um intervalo existente, 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 existente, a seleção existente 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, ele lançará uma exceção.

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

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

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

Retornar

Range: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método requerem 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 para os novos metadados do desenvolvedor.

Retornar

Range: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método requerem 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 especificada e visibilidade no 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 para os novos metadados do desenvolvedor.
`visibility`	`DeveloperMetadataVisibility`	A visibilidade dos novos metadados do desenvolvedor.

Retornar

Range: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método requerem 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 para os novos metadados do desenvolvedor.
`value`	`String`	O valor dos novos metadados do desenvolvedor.

Retornar

Range: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método requerem 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 para os novos metadados do desenvolvedor.
`value`	`String`	O valor dos novos metadados do desenvolvedor.
`visibility`	`DeveloperMetadataVisibility`	A visibilidade dos novos metadados do desenvolvedor.

Retornar

Range: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método requerem 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 de faixa de colunas padrão ao intervalo. Por padrão, a faixa tem o cabeçalho e nenhuma cor do 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 requerem 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 faixa de colunas especificado ao intervalo. Por padrão, o banding tem cabeçalho e nenhuma 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 cor para aplicar às colunas no intervalo.

Retornar

Banding: a nova faixa.

Autorização

Os scripts que usam esse método requerem 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 banda de coluna especificado ao intervalo com configurações específicas de cabeçalho e 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 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 cor para aplicar às colunas no intervalo.
`showHeader`	`Boolean`	Se `true`, a cor do cabeçalho do tema da faixa será aplicada à primeira coluna.
`showFooter`	`Boolean`	Se `true`, a cor do rodapé do tema da faixa será aplicada à última coluna.

Retornar

Banding: a nova faixa.

Autorização

Os scripts que usam esse método requerem 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 de faixa de linha padrão ao intervalo. Por padrão, a faixa tem o cabeçalho e nenhuma cor do rodapé.

Retornar

Banding: a nova faixa.

Autorização

Os scripts que usam esse método requerem 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 faixa de linha especificado ao intervalo. Por padrão, a faixa tem o cabeçalho e nenhuma cor do rodapé.

Parâmetros

Nome	Tipo	Descrição
`bandingTheme`	`BandingTheme`	Um tema de cor para aplicar às linhas no intervalo.

Retornar

Banding: a nova faixa.

Autorização

Os scripts que usam esse método requerem 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 configurações específicas de cabeçalho e rodapé.

Parâmetros

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

Retornar

Banding: a nova faixa.

Autorização

Os scripts que usam esse método requerem 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 baseados nos dados deste 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 comando a seguir preenche A1:A20 com uma série de números crescentes com base nos valores atuais em A1:A4:

var sheet = SpreadsheetApp.getActiveSheet();

// Has values [1, 2, 3, 4].
var sourceRange = sheet.getRange("A1:A4");
// The range to fill with values.
var 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 deve 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 AutoFill que deve ser usado para calcular novos valores. O efeito dessa série varia com base no tipo e na quantidade de dados de origem.

Autorização

Os scripts que usam esse método requerem 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 a ser preenchido com novos dados com base em células vizinhas e preenche automaticamente esse intervalo com novos valores com base nos dados contidos nesse intervalo. 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 precisam ser inseridos: se houver dados à esquerda ou à direita de uma coluna que está sendo preenchida automaticamente, os novos valores se estenderão apenas até os 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, os novos valores serão inseridos apenas no B5:B20. Dessa forma, esses novos valores "seguem" as células que contêm valores na coluna A.

var sheet = SpreadsheetApp.getActiveSheet();

// A1:A20 has values [1, 2, 3, ... 20].
// B1:B4 has values [1/1/2017, 1/2/2017, ...]
var 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 AutoFill que deve ser usado para calcular novos valores. O efeito dessa série varia com base no tipo e na quantidade de dados de origem.

Autorização

Os scripts que usam esse método requerem 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" -> "Desfazer mesclagem".

Retornar

Range: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método requerem 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 do intervalo. O proprietário da planilha sempre pode editar páginas e intervalos protegidos.

Retornar

Boolean: true se o usuário tiver permissão para editar todas as células do intervalo. Caso contrário, false.

Autorização

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

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

`check()`

Altera o estado das caixas de seleção no intervalo para "marcado". Ignora as células no intervalo que atualmente 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'.
var range = SpreadsheetApp.getActive().getRange('A1:B10');
range.check();

Retornar

Range: este intervalo, para encadeamento.

Autorização

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

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

`clear()`

Limpa a variedade de conteúdos e formatos.

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

var range = sheet.getRange("A1:D10");
range.clear();

Retornar

Range: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método requerem 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 nas opções avançadas fornecidas. Por padrão, todos os dados são apagados.

// The code below clears range C2:G8 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 os parâmetros avançados, conforme listado abaixo.

Parâmetros avançados

Nome	Tipo	Descrição
`commentsOnly`	`Boolean`	Define se apenas os comentários serão apagados.
`contentsOnly`	`Boolean`	Define se apenas o conteúdo será limpo.
`formatOnly`	`Boolean`	Define se apenas o formato será limpo. Observe que a limpeza do formato também limpa as regras de validação de dados.
`validationsOnly`	`Boolean`	Define se apenas as regras de validação de dados serão apagadas.
`skipFilteredRows`	`Boolean`	Se deve evitar a limpeza das linhas filtradas.

Retornar

Range: este intervalo, para encadeamento.

Autorização

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

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

var range = sheet.getRange("A1:D10");
range.clearContent();

Retornar

Range: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método requerem 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 para o intervalo.

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

Retornar

Range: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método requerem 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 deste intervalo.

Isso limpa a formatação do texto das células no intervalo, mas não redefine as regras de formatação de números.

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

var range = sheet.getRange("A1:D10");
range.clearFormat();

Retornar

Range: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método requerem 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 nota nas células especificadas.

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

var range = sheet.getRange("A1:D10");
range.clearNote();

Retornar

Range: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método requerem 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 expandido mais profundo que está parcialmente dentro do intervalo será recolhido.

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

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

Retornar

Range: este intervalo, para encadeamento.

Autorização

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

Copie 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. Observe que esse método copia apenas a formatação.

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

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

var 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 código exclusivo da página da planilha, independentemente da posição.
`column`	`Integer`	A primeira coluna do intervalo de destino.
`columnEnd`	`Integer`	A coluna final do intervalo desejado.
`row`	`Integer`	A linha inicial do intervalo desejado.
`rowEnd`	`Integer`	A linha final do intervalo desejado.

Autorização

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

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

Veja também

getGridId()

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

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

var 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 página de destino.
`column`	`Integer`	A primeira coluna do intervalo de destino.
`columnEnd`	`Integer`	A coluna final do intervalo desejado.
`row`	`Integer`	A linha inicial do intervalo desejado.
`rowEnd`	`Integer`	A linha final do intervalo desejado.

Autorização

Os scripts que usam esse método requerem 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 intervalo de células. Os valores e a formatação são copiados.

// The code below copies the first 5 columns over to the 6th column.
var sheet = SpreadsheetApp.getActiveSheet();
var 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 requerem 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 intervalo de células.

// The code below copies only the values of the first 5 columns over to the 6th column.
var 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 deve ser colado na orientação transposta.

Autorização

Os scripts que usam esse método requerem 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 intervalo de células. 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.
var 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 os parâmetros avançados, conforme listado abaixo.

Parâmetros avançados

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

Autorização

Os scripts que usam esse método requerem 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 fornecido. 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().

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

var 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 código exclusivo da página da planilha, independentemente da posição.
`column`	`Integer`	A primeira coluna do intervalo de destino.
`columnEnd`	`Integer`	A coluna final do intervalo desejado.
`row`	`Integer`	A linha inicial do intervalo desejado.
`rowEnd`	`Integer`	A linha final do intervalo desejado.

Autorização

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

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

Veja também

getGridId()

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

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

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

var 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 página de destino.
`column`	`Integer`	A primeira coluna do intervalo de destino.
`columnEnd`	`Integer`	A coluna final do intervalo desejado.
`row`	`Integer`	A linha inicial do intervalo desejado.
`rowEnd`	`Integer`	A linha final do intervalo desejado.

Autorização

Os scripts que usam esse método requerem 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 a partir da fonte de dados, ancorada na primeira célula nesse intervalo.

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

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

var 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 da qual criar a tabela dinâmica.

Retornar

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

Autorização

Os scripts que usam esse método requerem 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 vazia de fonte de dados, ancorada na primeira célula nesse intervalo.

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

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

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

Parâmetros

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

Retornar

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

Autorização

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

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

`createDeveloperMetadataFinder()`

Retorna uma DeveloperMetadataFinderApi para encontrar metadados do desenvolvedor dentro do escopo desse intervalo. Os metadados estão dentro do escopo do intervalo somente se ele estiver totalmente contido nesse intervalo. Por exemplo, os metadados associados à linha "3:3" não estão no escopo de um intervalo "A1:D5", mas estão dentro do 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 página. 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().

let ss = SpreadsheetApp.getActiveSheet();
let 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() {
  let filter = range.getFilter();
  let criteria = SpreadsheetApp.newFilterCriteria()
    .whenCellNotEmpty()
    .build();
  filter.setColumnFilterCriteria(2, criteria);
}

Use esse método para criar filtros para Grid páginas, o tipo de página padrão. Páginas de grade são páginas que não estão conectadas a um banco de dados. Para criar outros tipos de filtro, consulte o seguinte:

Criar um filtro de tabela dinâmica com PivotTable.addFilter(sourceDataColumn, filterCriteria)
Criar um filtro para uma página 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 requerem 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 do sourceData especificado ancorado na primeira 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');

// 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 usados para criar a tabela dinâmica.

Retornar

PivotTable: o PivotTable recém-criado.

Autorização

Os scripts que usam esse método requerem 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 localizar e substituir texto nesse intervalo.

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

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

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

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

Parâmetros

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

Retornar

TextFinder: o TextFinder do intervalo

`deleteCells(shiftDimension)`

Exclui este intervalo de células. Os dados existentes na página ao longo da dimensão fornecida são transferidos para o intervalo excluído.

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

var range = sheet.getRange("A1:D10");
range.deleteCells(SpreadsheetApp.Dimension.COLUMNS);

Parâmetros

Nome	Tipo	Descrição
`shiftDimension`	`Dimension`	A dimensão pela qual os dados existentes são transferidos.

Autorização

Os scripts que usam esse método requerem 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 controle alterna com esse intervalo. O local do alternador de controle é o índice em que o controle é exibido, diretamente antes ou depois do grupo, dependendo das configurações. Se houver mais de um grupo no mesmo local, o grupo mais baixo será expandido.

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

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

Retornar

Range: este intervalo, para encadeamento.

Autorização

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var 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 requerem 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').

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

var 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 requerem 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.

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

var cell = sheet.getRange("B5");
Logger.log(cell.getBackgroundObject().asRgbColor().asHexString());

Retornar

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

Autorização

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

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

var range = sheet.getRange("B5:C6");
var bgColors = range.getBackgroundObjects();
for (var i in bgColors) {
  for (var 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 requerem 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').

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

var range = sheet.getRange("B5:C6");
var bgColors = range.getBackgrounds();
for (var i in bgColors) {
  for (var 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 requerem 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 (let 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 requerem 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 célula especificada dentro de um intervalo.

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

var 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
var 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 requerem 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 inicial da coluna para este intervalo.

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

var 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 requerem 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 for cercado por células vazias que não as incluam ao longo das diagonais, ele será retornado. Isso é semelhante a selecionar o intervalo e digitar Ctrl+A no editor.

// Assume the active spreadsheet is blank.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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 requerem 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 ao lado do intervalo organizado 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 for 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.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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 pela qual o intervalo será expandido.

Retornar

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

Autorização

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

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

`getDataSourceFormula()`

Retorna DataSourceFormula para a primeira célula do intervalo ou null se a célula não contiver uma fórmula de fonte de dados.

Retornar

DataSourceFormula: o DataSourceFormula da célula.

Autorização

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

Retornar

DataSourceFormula[]: uma matriz de DataSourceFormulas.

Autorização

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

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

`getDataSourcePivotTables()`

Obtém todas as tabelas dinâmicas da fonte de dados que se cruzam com o intervalo.

Retornar

DataSourcePivotTable[]: uma lista de tabelas dinâmicas da fonte de dados.

Autorização

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

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

`getDataSourceTables()`

Obtém todas as tabelas de fonte de dados que se cruzam com o intervalo.

Retornar

DataSourceTable[]: uma lista de tabelas de fonte de dados.

Autorização

Os scripts que usam esse método requerem 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 deste intervalo, que pode ser usado para criar gráficos e consultas.

Code.gs

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

  var 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 requerem 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.

Retornar

DataTable: os dados como uma tabela de dados.

`getDataTable(firstRowIsHeader)`

Retorne os dados dentro desse intervalo como uma tabela de dados.

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

// Calling this method with "true" sets the first line to be the title of the axes
var 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.
var 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 requerem 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 retornará null.

// Log information about the data validation rule for cell A1.
var cell = SpreadsheetApp.getActive().getRange('A1');
var rule = cell.getDataValidation();
if (rule != null) {
  var criteria = rule.getCriteriaType();
  var 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 para a célula do canto superior esquerdo do intervalo.

Autorização

Os scripts que usam esse método requerem 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 do intervalo. Se a validação de dados não tiver sido definida em uma determinada célula, esse método retornará null para a posição dessa célula na matriz.

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

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

    if (rule != null) {
      var criteria = rule.getCriteriaType();
      var 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 requerem autorização com um ou mais dos seguintes escopos:

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

`getDeveloperMetadata()`

Obtém os metadados do desenvolvedor associados a esse intervalo.

Retornar

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

Autorização

Os scripts que usam esse método requerem 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 exibido da célula superior esquerda no intervalo. O valor é um String. O valor exibido leva em conta a formatação da data, hora e moeda, incluindo formatos aplicados automaticamente pela configuração de localidade da planilha. As 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 exibido nesta célula.

Autorização

Os scripts que usam esse método requerem 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 este intervalo.

Retorna uma matriz bidimensional de valores exibidos, indexados por linha e depois por coluna. Os valores são objetos String. O valor exibido leva em conta a formatação de data, hora e moeda, incluindo formatos aplicados automaticamente pela configuração de localidade da planilha. As células vazias são representadas por uma string vazia na matriz. Lembre-se de que, enquanto um índice de intervalo começa 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.
var values = SpreadsheetApp.getActiveSheet().getRange(2, 3, 6, 4).getDisplayValues();
Logger.log(values[0][0]);

Retornar

String[][]: uma matriz de valores bidimensional.

Autorização

Os scripts que usam esse método requerem 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 página a que esse intervalo pertence ou null se não houver filtro na página.

let ss = SpreadsheetApp.getActiveSheet();
let range = ss.getRange("A1:C20");
// Gets the existing filter on the sheet that the given range belongs to.
let filter = range.getFilter();

Retornar

Filter: o filtro.

Autorização

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var 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 requerem 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.

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

var results = range.getFontColorObjects();

for (var i in results) {
  for (var 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 requerem autorização com um ou mais dos seguintes escopos:

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

`getFontFamilies()`

Retorna os grupos de fontes das células do intervalo.

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

var results = range.getFontFamilies();

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

Retornar

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

Autorização

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var 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 requerem autorização com um ou mais dos seguintes escopos:

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

`getFontLine()`

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

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

Logger.log(range.getFontLine());

Retornar

String: a linha da fonte.

Autorização

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

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

`getFontLines()`

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

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

var results = range.getFontLines();

for (var i in results) {
  for (var 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 requerem 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 no tamanho do ponto da célula no canto superior esquerdo do intervalo.

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

Logger.log(range.getFontSize());

Retornar

Integer: o tamanho da fonte no tamanho do ponto.

Autorização

Os scripts que usam esse método requerem 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 do intervalo.

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

var results = range.getFontSizes();

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

Retornar

Integer[][]: uma matriz bidimensional de tamanhos de fonte de texto associados a células no intervalo.

Autorização

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var 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 requerem 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.

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

var results = range.getFontStyles();

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

Retornar

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

Autorização

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

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

`getFontWeight()`

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

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

Logger.log(range.getFontWeight());

Retornar

String — a espessura da fonte do texto na célula.

Autorização

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

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

`getFontWeights()`

Retorna os pesos da fonte das células no intervalo.

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

var results = range.getFontWeights();

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

Retornar

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

Autorização

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

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

// This assumes you have a function in B5 that sums up
// B2:B4
var 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 requerem 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 células.

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

var range = sheet.getRange("B5");
var formula = range.getFormulaR1C1();
Logger.log(formula);

Retornar

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

Autorização

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

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

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

Retornar

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

Autorização

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

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

var range = sheet.getRange("B5:C6");
var formulas = range.getFormulasR1C1();
for (var i in formulas) {
  for (var 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 requerem 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 página pai do intervalo. IDs são valores int não negativos aleatórios.

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

Logger.log(range.getGridId());

Retornar

Integer: o ID da grade da página mãe.

Autorização

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

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

var 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 requerem 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/centro/direita) da célula no canto superior esquerdo do intervalo.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var 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 requerem 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.

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

var results = range.getHorizontalAlignments();

for (var i in results) {
  for (var 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 requerem 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.

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

var 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 requerem 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.

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

var 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 requerem 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 que estão totalmente dentro do intervalo atual ou que contêm pelo menos uma célula no intervalo atual.

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

var range = sheet.getRange("A1:B3");

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

Retornar

Range[]: uma matriz de objetos Range, representando células mescladas sobrepondo o intervalo.

`getNextDataCell(direction)`

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

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

var 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 na qual 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 requerem 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 nota associada ao intervalo fornecido.

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

Logger.log(range.getNote());

Retornar

String: a nota associada à célula especificada.

Autorização

Os scripts que usam esse método requerem 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 do intervalo.

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

var results = range.getNotes();

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

Retornar

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

Autorização

Os scripts que usam esse método requerem 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 neste intervalo.

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

var range = sheet.getRange("B2:D5");
Logger.log(range.getNumColumns());

Retornar

Integer: o número de colunas no intervalo.

Autorização

Os scripts que usam esse método requerem 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 neste intervalo.

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

var range = sheet.getRange("B2:D5");
Logger.log(range.getNumRows());

Retornar

Integer: o número de linhas nesse intervalo.

Autorização

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

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

`getNumberFormat()`

Obtém a formatação de número ou data da célula superior esquerda do intervalo fornecido. Os padrões de formato retornados são descritos na documentação da API Sheets.

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

var cell = sheet.getRange("C4");
Logger.log(cell.getNumberFormat());

Retornar

String: o formato numérico da célula superior esquerda do intervalo.

Autorização

Os scripts que usam esse método requerem 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 Sheets.

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

var range = sheet.getRange("B5:C6");
var formats = range.getNumberFormats();
for (var i in formats) {
  for (var 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 requerem 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 rich text para a 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.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("D4:F6");
var richText = range.getRichTextValue();
console.log(richText.getText());

Retornar

RichTextValue: o valor de Rich Text 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 requerem 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 rich text para as células no intervalo.

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

for (var i = 0; i < values.length; i++) {
  for (var 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 requerem 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 do intervalo. Idêntico a getRowIndex().

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

var 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 requerem 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 do intervalo. Idêntico a getRow().

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

var 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 requerem autorização com um ou mais dos seguintes escopos:

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

Veja também

getRow()

`getSheet()`

Retorna a página à qual o 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 página à qual esse intervalo pertence.

Autorização

Os scripts que usam esse método requerem 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. Retornará null se a direção do texto da célula for determinada com detecção automática.

// Get the text direction of cell B1.
var sheet = SpreadsheetApp.getActiveSheet();
var 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 requerem 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 rotas em texto das células do 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
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B5:C6");
var directions = range.getTextDirections();

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

Retornar

TextDirection[][]: uma matriz bidimensional de rotas de texto.

Autorização

Os scripts que usam esse método requerem 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.
var sheet = SpreadsheetApp.getActiveSheet();

var cell = sheet.getRange("A1");
Logger.log(cell.getTextRotation());

Retornar

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

Autorização

Os scripts que usam esse método requerem 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 das células no intervalo.

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B2:D4");

var results = range.getTextRotations();

for (var i in results) {
  for (var j in results[i]) {
    var 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 requerem 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.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("D4:F6");
var style = range.getTextStyle();
Logger.log(style);

Retornar

TextStyle — o estilo de texto da célula superior esquerda no intervalo.

Autorização

Os scripts que usam esse método requerem 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
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B5:C6");
var styles = range.getTextStyles();

for (var i = 0; i < styles.length; i++) {
  for (var 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 requerem 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. As 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 requerem 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 este intervalo.

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

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

Em apps da Web, o valor Date não é um parâmetro legal. getValues() falhará ao retornar dados para um app da Web se o intervalo contiver uma célula com um valor Date. Em vez disso, transforme todos os valores recuperados da página para um primitivo JavaScript compatível, como Number, Boolean ou String.

Retornar

Object[][]: uma matriz de valores bidimensional.

Autorização

Os scripts que usam esse método requerem 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/médio/inferior) da célula no canto superior esquerdo do intervalo.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var 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 requerem 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.

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

var results = range.getVerticalAlignments();

for (var i in results) {
  for (var 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 requerem 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 requerem 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 é ajustado. Para ver uma estratégia de quebra mais granular, use getWrapStrategy().

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

Logger.log(range.getWrap());

Retornar

Boolean: se o texto desta célula é ajustado ou não.

Autorização

Os scripts que usam esse método requerem 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 ajuste de texto para as células do intervalo.

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

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

Retornar

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

Autorização

Os scripts que usam esse método requerem 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 ajuste de texto para a célula do canto superior esquerdo do intervalo.

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

Retornar

WrapStrategy — a estratégia de ajuste de texto da célula superior esquerda no intervalo.

Autorização

Os scripts que usam esse método requerem 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 é ajustado. Para ver uma estratégia de quebra mais granular, use getWrapStrategies().

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

var results = range.getVerticalAlignments();

for (var i in results) {
  for (var j in results[i]) {
    var 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 requerem 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 qualquer formatação presente nas células que anteriormente ocupavam esse intervalo. Os dados existentes na página ao longo da dimensão fornecida são deslocados para fora do intervalo inserido.

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

var range = sheet.getRange("A1:D10");
range.insertCells(SpreadsheetApp.Dimension.COLUMNS);

Parâmetros

Nome	Tipo	Descrição
`shiftDimension`	`Dimension`	A dimensão pela qual os dados existentes são transferidos.

Retornar

Range: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método requerem 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 no intervalo, configuradas com true para marcar e false para desmarcada. Define o valor de todas as células no intervalo como false.

var 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: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método requerem 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 no intervalo, configuradas com um valor personalizado para marcado e a string vazia para desmarcada. Define o valor de cada célula no intervalo para a string vazia.

var 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 verificado para a validação dos dados da caixa de seleção.

Retornar

Range: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método requerem 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 no intervalo, configuradas com valores personalizados para os estados marcados e desmarcados. Define o valor de cada célula no intervalo para o valor personalizado desmarcado.

var 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 verificado para a validação dos dados da caixa de seleção.
`uncheckedValue`	`Object`	O valor desmarcado da validação de dados da caixa de seleção.

Retornar

Range: este intervalo, para encadeamento.

Autorização

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

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

Logger.log(range.isBlank());

Retornar

Boolean: true se o intervalo estiver em branco. Caso contrário, será false.

Autorização

Os scripts que usam esse método requerem 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 de caixa de seleção como "marcada". Retornará null se algumas células estiverem marcadas e o restante estiver desmarcado ou se algumas células não tiverem validação de dados da caixa de seleção.

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

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

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

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

var range3 = SpreadsheetApp.getActive().getRange('A3');
range3.setValue('random');
// Sets the value of isRange3Checked as null, as it contains an invalid checkbox value.
var 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 da caixa de seleção.

Autorização

Os scripts que usam esse método requerem 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. Caso contrário, será false.

Autorização

Os scripts que usam esse método requerem 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, este 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. Caso contrário, será false.

Autorização

Os scripts que usam esse método requerem 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 caso as células no intervalo atual se sobreponham a qualquer célula mesclada.

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

var range = sheet.getRange("A1:B3");

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

Retornar

Boolean: true se o intervalo se sobrepõe a qualquer célula mesclada. 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, será false.

Autorização

Os scripts que usam esse método requerem 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, este método retorna true. Para o intervalo B:B, que está vinculado apenas a uma determinada coluna no início do intervalo, este 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. Caso contrário, será false.

Autorização

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

var sheet = SpreadsheetApp.getActiveSheet();

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

Retornar

Range: este intervalo, para encadeamento.

Autorização

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

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

`mergeAcross()`

Mescle as células do intervalo nas colunas do intervalo.

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

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

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

Retornar

Range: este intervalo, para encadeamento.

Autorização

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

var 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: este intervalo, para encadeamento.

Autorização

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

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

`moveTo(target)`

Recortar e colar (formato e valores) deste intervalo para o intervalo de destino.

// The code below moves the first 5 columns over to the 6th column
var 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 esse intervalo. Apenas a posição da célula superior esquerda é relevante.

Autorização

Os scripts que usam esse método requerem 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 com intervalo desse número pelo número de linhas e colunas fornecido (que pode ser negativo). O novo intervalo é do mesmo tamanho que o intervalo original.

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

var cell = sheet.getRange("A1");

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

Parâmetros

Nome	Tipo	Descrição
`rowOffset`	`Integer`	Número de linhas abaixo da célula superior esquerda do intervalo. Valores negativos representam linhas da célula superior esquerda do intervalo.
`columnOffset`	`Integer`	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: este intervalo, para encadeamento.

`offset(rowOffset, columnOffset, numRows)`

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

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

var cell = sheet.getRange("A1");

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

Parâmetros

Nome	Tipo	Descrição
`rowOffset`	`Integer`	Número de linhas abaixo da célula superior esquerda do intervalo. Valores negativos representam linhas da célula superior esquerda do intervalo.
`columnOffset`	`Integer`	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: este 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 especificadas e com a altura e largura especificadas nas células.

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

var cell = sheet.getRange("A1");

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

Parâmetros

Nome	Tipo	Descrição
`rowOffset`	`Integer`	Número de linhas abaixo da célula superior esquerda do intervalo. Valores negativos representam linhas da célula superior esquerda do intervalo.
`columnOffset`	`Integer`	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: este intervalo, para encadeamento.

`protect()`

Cria um objeto que pode impedir que o intervalo seja editado, exceto por usuários que tenham 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 espelham aquelas da própria planilha, o que significa efetivamente que o intervalo permanece desprotegido. Se o intervalo já estiver protegido, esse método 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 a edite, esse usuário não poderá editá-la.

// Protect range A1:B10, then remove all other users from the list of editors.
var ss = SpreadsheetApp.getActive();
var range = ss.getRange('A1:B10');
var 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.
var 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 requerem autorização com um ou mais dos seguintes escopos:

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

`randomize()`

Ordem aleatória das linhas das linhas no intervalo fornecido.

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

// Randomizes the range
range.randomize();

Retornar

Range: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método requerem 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 correspondente, caso a célula contenha o valor marcado ou desmarcado.

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

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

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

var 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: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método requerem 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 que são duplicatas de valores em qualquer linha anterior. Linhas com valores idênticos, mas com uso diferente de maiúsculas e minúsculas, formatação ou fórmulas, são consideradas duplicatas. Esse método também remove linhas duplicadas ocultas (por exemplo, devido a um filtro). O conteúdo fora desse intervalo não é removido.

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

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

Retornar

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

Autorização

Os scripts que usam esse método requerem 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 cópias de valores de qualquer linha anterior. Linhas com valores idênticos, mas com uso diferente de maiúsculas e minúsculas, formatação ou fórmulas, são consideradas duplicatas. Esse método também remove linhas duplicadas ocultas (por exemplo, devido a um filtro). O conteúdo fora desse intervalo não é removido.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var 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 quanto a valores duplicados. Se nenhuma coluna for fornecida, todas as colunas serão analisadas em busca de cópias.

Retornar

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

Autorização

Os scripts que usam esse método requerem 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 do plano de fundo de todas as células no intervalo na notação CSS (como '#ffffff' ou 'white').

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

var 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: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método requerem 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 do plano de fundo de todas as células do intervalo.

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

var range = sheet.getRange("B2:D5");
range.setBackgroundObject(bgColor);

Parâmetros

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

Retornar

Range: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método requerem 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 fundo (deve corresponder às dimensões deste intervalo).

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

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

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

var cell = sheet.getRange("B5:C6");
cell.setBackgroundObjects(colors);

Parâmetros

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

Retornar

Range: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método requerem 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 para a cor determinada usando valores RGB (números inteiros entre 0 e 255, inclusive).

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

var 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: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método requerem 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 fundo (deve corresponder às dimensões deste intervalo). As cores estão em notação CSS (como '#ffffff' ou 'white').

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

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

var 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: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método requerem 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 da borda. Os valores válidos são true (ativado), false (desativado) e null (sem alterações).

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

var 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 nenhuma, `null` para nenhuma alteração.
`left`	`Boolean`	`true` para borda, `false` para nenhuma, `null` para nenhuma alteração.
`bottom`	`Boolean`	`true` para borda, `false` para nenhuma, `null` para nenhuma alteração.
`right`	`Boolean`	`true` para borda, `false` para nenhuma, `null` para nenhuma alteração.
`vertical`	`Boolean`	`true` para bordas verticais internas, `false` para nenhuma, `null` para nenhuma alteração.
`horizontal`	`Boolean`	`true` para bordas horizontais, `false` para nenhuma e `null` para nenhuma alteração.

Retornar

Range: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método requerem 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ções). Para cor, use a cor na notação CSS (como '#ffffff' ou 'white').

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

var 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 nenhuma, `null` para nenhuma alteração.
`left`	`Boolean`	`true` para borda, `false` para nenhuma, `null` para nenhuma alteração.
`bottom`	`Boolean`	`true` para borda, `false` para nenhuma, `null` para nenhuma alteração.
`right`	`Boolean`	`true` para borda, `false` para nenhuma, `null` para nenhuma alteração.
`vertical`	`Boolean`	`true` para bordas verticais internas, `false` para nenhuma, `null` para nenhuma alteração.
`horizontal`	`Boolean`	`true` para bordas horizontais, `false` para nenhuma e `null` para nenhuma alteração.
`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: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método requerem 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.
var cell = SpreadsheetApp.getActive().getRange('A1');
var range = SpreadsheetApp.getActive().getRange('B1:B10');
var 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: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método requerem 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 depois por 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.
var destinationRange = SpreadsheetApp.getActive().getSheetByName('Sheet1').getRange('A1:B5');
var sourceRange = SpreadsheetApp.getActive().getSheetByName('Sheet2').getRange('A1:A10');
var rule = SpreadsheetApp.newDataValidation().requireValueInRange(sourceRange).build();
var rules = destinationRange.getDataValidations();
for (var i = 0; i < rules.length; i++) {
  for (var 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 ser definida. Os valores `null` removem a validação de dados.

Retornar

Range: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método requerem 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').

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

var 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: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método requerem 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 fornecido.

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

var 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: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método requerem 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 fontes (precisa corresponder às dimensões deste intervalo).

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

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

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

var 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: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método requerem 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 fontes (precisa corresponder às dimensões deste intervalo). As cores estão em notação CSS (como '#ffffff' ou 'white').

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

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

var 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: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método requerem 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 fonte (precisa corresponder às dimensões deste intervalo). Exemplos de famílias de fontes são "Arial" ou "Helvetica".

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

var fonts = [
  ["Arial", "Helvetica", "Verdana"],
  ["Courier New", "Arial", "Helvetica]
];

var 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: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método requerem 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".

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

var 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: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método requerem 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 de fonte do intervalo fornecido ('underline', 'line-through' ou 'none').

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

var 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: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método requerem 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 (deve corresponder às dimensões deste intervalo).

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

// The size of the two-dimensional array must match the size of the range.
var fontLines = [
  ["underline", "line-through", "none"]
];

var 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 de fonte.

Retornar

Range: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método requerem 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, sendo que o tamanho é o tamanho de ponto a ser usado.

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

var cell = sheet.getRange("B2");
cell.setFontSize(20);

Parâmetros

Nome	Tipo	Descrição
`size`	`Integer`	Um tamanho de fonte no tamanho do ponto.

Retornar

Range: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método requerem 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 fonte (precisa corresponder às dimensões deste intervalo). Os tamanhos estão em pontos.

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

// The size of the two-dimensional array must match the size of the range.
var fontSizes = [
  [16, 20, 24]
];

var range = sheet.getRange("B2:D2");
range.setFontSizes(fontSizes);

Parâmetros

Nome	Tipo	Descrição
`sizes`	`Object[][]`	Uma matriz bidimensional de tamanhos.

Retornar

Range: este intervalo, para encadeamento.

Autorização

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

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

`setFontStyle(fontStyle)`

Define o estilo da fonte para o intervalo fornecido ('italic' ou 'normal').

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

var 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: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método requerem 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 deste intervalo).

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

// The size of the two-dimensional array must match the size of the range.
var fontStyles = [
  ["italic", "normal"]
];

var 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: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método requerem 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 a espessura da fonte para o intervalo fornecido (normal/negrito).

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

var cell = sheet.getRange("B2");
cell.setFontWeight("bold");

Parâmetros

Nome	Tipo	Descrição
`fontWeight`	`String`	O peso da fonte, `'bold'` ou `'normal'`. Um valor `null` redefine o peso da fonte.

Retornar

Range: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método requerem 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 fonte (deve corresponder às dimensões deste intervalo). Um exemplo de peso da fonte é "negrito".

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

// The size of the two-dimensional array must match the size of the range.
var fontStyles = [
  [ "bold", "bold", "normal" ]
];

var range = sheet.getRange("B2:D2");
range.setFontWeights(fontStyles);

Parâmetros

Nome	Tipo	Descrição
`fontWeights`	`Object[][]`	Uma matriz bidimensional de pesos de fonte, `'bold'` ou `'normal'`. Os valores `null` redefinem o peso da fonte.

Retornar

Range: este intervalo, para encadeamento.

Autorização

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

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

var 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: este intervalo, para encadeamento.

Autorização

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

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

var 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: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método requerem 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 deste intervalo). As fórmulas precisam estar na notação A1. Esse método usa uma matriz bidimensional de fórmulas, indexadas por linha e depois por coluna. As dimensões da matriz devem corresponder às dimensões do intervalo.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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.
var formulas = [
  ["=SUM(B2:B4)", "=SUM(C2:C4)", "=SUM(D2:D4)"],
  ["=AVERAGE(B2:B4)", "=AVERAGE(C2:C4)", "=AVERAGE(D2:D4)"]
];

var 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: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método requerem 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 deste intervalo). As fórmulas especificadas precisam estar na notação R1C1.

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

// This creates formulas for a row of sums, followed by a row of averages.
var sumOfRowsAbove = "=SUM(R[-3]C[0]:R[-1]C[0])";
var averageOfRowsAbove = "=AVERAGE(R[-4]C[0]:R[-2]C[0])";

// The size of the two-dimensional array must match the size of the range.
var formulas = [
  [sumOfRowsAbove, sumOfRowsAbove, sumOfRowsAbove],
  [averageOfRowsAbove, averageOfRowsAbove, averageOfRowsAbove]
];

var 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: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método requerem 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 (esquerda para direita) para o intervalo especificado (esquerda/centro/direita).

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

var 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: este intervalo, para encadeamento.

Autorização

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

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

// The size of the two-dimensional array must match the size of the range.
var horizontalAlignments = [
  [ "left", "right", "center" ]
];

var 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: este intervalo, para encadeamento.

Autorização

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

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

Veja também

setHorizontalAlignment(alignment)

`setNote(note)`

Define a nota como o valor fornecido.

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

var cell = sheet.getRange("B2");
cell.setNote("This is a note");

Parâmetros

Nome	Tipo	Descrição
`note`	`String`	O valor a ser definido no intervalo. Um valor `null` remove a nota.

Retornar

Range: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método requerem 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 deste intervalo).

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

// The size of the two-dimensional array must match the size of the range.
var notes = [
  ["it goes", "like this", "the fourth, the fifth"],
  ["the minor fall", "and the", "major lift"]
];

var cell = sheet.getRange("B2:D3");
cell.setNotes(notes)

Parâmetros

Nome	Tipo	Descrição
`notes`	`Object[][]`	Uma matriz bidimensional de notas. Os valores `null` removem a nota.

Retornar

Range: este intervalo, para encadeamento.

Autorização

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

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

Veja também

setNote(note)

`setNumberFormat(numberFormat)`

Define o formato do número ou a data para a string de formatação fornecida. Os padrões de formato aceitos são descritos na documentação da API Sheets.

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

var 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: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método requerem 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 (deve corresponder às dimensões desse intervalo). Os valores são strings de padrão de formato, conforme descrito na documentação da API Sheets.

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

// The size of the two-dimensional array must match the size of the range.
var formats = [
  [ "0.000", "0,000,000", "$0.00" ]
];

var 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: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método requerem 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.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B2:D4");
var bold = SpreadsheetApp.newTextStyle()
    .setBold(true)
    .build();
var richText = SpreadsheetApp.newRichTextValue()
    .setText("Hello world")
    .setTextStyle(0, 5, bold)
    .build();
range.setRichTextValue(richText);

Parâmetros

Nome	Tipo	Descrição
`value`	`RichTextValue`	O valor desejado para Rich Text.

Retornar

Range: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método requerem 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 rich text.

// Sets the cells in range A1:A2 to have Rich Text values.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:A2");
var bold = SpreadsheetApp.newTextStyle()
    .setBold(true)
    .build();
var italic = SpreadsheetApp.newTextStyle()
    .setItalic(true)
    .build();
var richTextA1 = SpreadsheetApp.newRichTextValue()
    .setText("This cell is bold")
    .setTextStyle(bold)
    .build();
var 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 desejados de Rich Text.

Retornar

Range: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método requerem 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 exibir 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`	Se o hiperlink será ou não exibido.

Retornar

Range: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método requerem 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 das células no intervalo. Se uma direção especificada for null, a direção será inferida e, em seguida, definida.

// Sets right-to-left text direction for the range.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B5:C6");
range.setTextDirection(SpreadsheetApp.TextDirection.RIGHT_TO_LEFT);

Parâmetros

Nome	Tipo	Descrição
`direction`	`TextDirection`	A direção do texto desejada. Se `null`, a direção será inferida antes da configuração.

Retornar

Range: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método requerem 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 rotas de texto. Se a 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.
var sheet = SpreadsheetApp.getActiveSheet();
var range1 = sheet.getRange("A1:B2");
var range2 = sheet.getRange("C5:D6");

range2.setTextRotations(range1.getTextDirections());

Parâmetros

Nome	Tipo	Descrição
`directions`	`TextDirection[][]`	As rotas de texto desejadas. Se uma direção especificada for `null`, será inferida antes da configuração.

Retornar

Range: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método requerem 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 de texto para as células no intervalo. A entrada corresponde ao ângulo entre a orientação de texto padrão e a orientação desejada. Uma entrada igual a zero indica que o texto está definido com a orientação padrão.

Na direção de texto da esquerda para a direita, os ângulos positivos estão no sentido anti-horário, enquanto os da direita para a esquerda estão no sentido horário.

// Sets all cell's in range B2:D4 to have text rotated up 45 degrees.
var sheet = SpreadsheetApp.getActiveSheet();
var 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, os ângulos positivos estão no sentido anti-horário.

Retornar

Range: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método requerem 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 de 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.
var sheet = SpreadsheetApp.getActiveSheet();

var rotation = sheet.getRange("A1").getTextRotation();

sheet.getRange("B2:D4").setTextRotation(rotation);

Parâmetros

Nome	Tipo	Descrição
`rotation`	`TextRotation`	As configurações desejadas de rotação de texto.

Retornar

Range: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método requerem 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.
var sheet = SpreadsheetApp.getActiveSheet();
var range1 = sheet.getRange("A1:B2");
var range2 = sheet.getRange("C5:D6");

range2.setTextRotations(range1.getTextRotations());

Parâmetros

Nome	Tipo	Descrição
`rotations`	`TextRotation[][]`	As configurações desejadas de rotação de texto.

Retornar

Range: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método requerem 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 de texto das células no intervalo.

// Sets the cells in range C5:D6 to have underlined size 15 font.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("C5:D6");
var 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: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método requerem 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
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B2");
var bold = SpreadsheetApp.newTextStyle()
    .setBold(true)
    .build();
var 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: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método requerem 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, de string, booleano ou de data. Se começar com '=', ele será interpretado como uma fórmula.

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

var cell = sheet.getRange("B2");
cell.setValue(100);

Parâmetros

Nome	Tipo	Descrição
`value`	`Object`	O valor do intervalo.

Retornar

Range: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método requerem 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 deste intervalo).

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

// The size of the two-dimensional array must match the size of the range.
var values = [
  [ "2.000", "1,000,000", "$2.99" ]
];

var range = sheet.getRange("B2:D2");
range.setValues(values);

Parâmetros

Nome	Tipo	Descrição
`values`	`Object[][]`	Uma matriz de valores bidimensional.

Retornar

Range: este intervalo, para encadeamento.

Autorização

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

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

`setVerticalAlignment(alignment)`

Define o alinhamento vertical (de cima para baixo) do intervalo especificado (superior/meio/inferior).

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

var 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: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método requerem 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).

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

// The size of the two-dimensional array must match the size of the range.
var alignments = [
  [ "top", "middle", "bottom" ]
];

var 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: este intervalo, para encadeamento.

Autorização

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

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

Veja também

setVerticalAlignment(alignment)

`setVerticalText(isVertical)`

Define se será necessário empilhar o texto das células no intervalo. Se o texto estiver empilhado verticalmente, a configuração de rotação de texto do grau será ignorada.

// Sets all cell's in range B2:D4 to have vertically stacked text.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B2:D4");

range.setVerticalText(true);

Parâmetros

Nome	Tipo	Descrição
`isVertical`	`Boolean`	Se o texto deve ou não ser empilhado.

Retornar

Range: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método requerem 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 célula do intervalo fornecido.

As células com quebra ativada (padrão) são redimensionadas para exibir todo o conteúdo. As células com quebra de tela exibem o máximo possível na célula sem redimensionar ou executar em várias linhas.

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

var cell = sheet.getRange("B2");
cell.setWrap(true);

Parâmetros

Nome	Tipo	Descrição
`isWrapEnabled`	`Boolean`	Se o texto deve ou não ser ajustado.

Retornar

Range: este intervalo, para encadeamento.

Autorização

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

// Copies all of the wrap strategies from range A1:B2 over to range C5:D6.
var sheet = SpreadsheetApp.getActiveSheet();
var range1 = sheet.getRange("A1:B2");
var range2 = sheet.getRange("C5:D6");

range2.setWrapStrategies(range1.getWrapStrategies());

Parâmetros

Nome	Tipo	Descrição
`strategies`	`WrapStrategy[][]`	As estratégias de ajuste desejadas.

Retornar

Range: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método requerem 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 ajuste de texto para as células do intervalo.

// Sets all cells in range B2:D4 to use the clip wrap strategy.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B2:D4");

range.setWrapStrategy(SpreadsheetApp.WrapStrategy.CLIP);

Parâmetros

Nome	Tipo	Descrição
`strategy`	`WrapStrategy`	A estratégia de ajuste desejada.

Retornar

Range: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método requerem 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 palavras (precisa corresponder às dimensões desse intervalo). As células com quebra ativada (padrão) são redimensionadas para exibir todo o conteúdo. As células com quebra de tela exibidas o máximo possível na célula sem redimensionar ou executar em várias linhas.

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

// The size of the two-dimensional array must match the size of the range.
var wraps = [
  [ true, true, false ]
];

var range = sheet.getRange("B2:D2");
range.setWraps(wraps);

Parâmetros

Nome	Tipo	Descrição
`isWrapEnabled`	`Object[][]`	Uma matriz bidimensional de variáveis de quebra que determinam se o texto deve ser ajustado em uma célula ou não.

Retornar

Range: este intervalo, para encadeamento.

Autorização

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

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

Veja também

setWrap(isWrapEnabled)

`shiftColumnGroupDepth(delta)`

Altera a profundidade do agrupamento de colunas do intervalo de acordo com o valor especificado.

Isso tem o efeito de criar, modificar ou excluir grupos que 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 reduzir a profundidade do grupo para menos de zero ou acima de oito.

Se column group control position for BEFORE, isso gerará um erro ao tentar mudar a profundidade da primeira linha.

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var 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 a profundidade do grupo de colunas do intervalo deve ser alterada.

Retornar

Range: este intervalo, para encadeamento.

Gera

Error: ao tentar mudar a profundidade da primeira coluna quando a posição de controle é GroupControlTogglePosition.BEFORE

Autorização

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

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

`shiftRowGroupDepth(delta)`

Altera a profundidade do agrupamento de linhas do intervalo pelo valor especificado.

Isso não tem efeito ao reduzir a profundidade do grupo para menos de zero ou acima de oito.

Se row group control position for BEFORE, isso gerará um erro ao tentar mudar a profundidade da primeira linha.

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var 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 a profundidade do grupo de linhas deste intervalo deve ser alterada.

Retornar

Range: este intervalo, para encadeamento.

Gera

Error: ao tentar mudar a profundidade da primeira linha quando a posição de controle é GroupControlTogglePosition.BEFORE

Autorização

Os scripts que usam esse método requerem 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 especificadas.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var 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 pelas quais classificar.

Retornar

Range: este intervalo, para encadeamento.

Autorização

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

var range = SpreadsheetApp.getActiveSheet().getRange("A1:A3");
range.splitTextToColumns();

// Result after spliting 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 requerem 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|                 |                 |

var range = SpreadsheetApp.getActiveSheet().getRange("A1:A3");
range.splitTextToColumns('#');

// Result after spliting 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 requerem 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|                 |                 |

var range = SpreadsheetApp.getActiveSheet().getRange("A1:A3");
range.splitTextToColumns(SpreadsheetApp.TextToColumnsDelimiter.SEMICOLON);

// Result after spliting 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 a ser dividido.

Autorização

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

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

`trimWhitespace()`

Corta espaços em branco (como espaços, tabulações ou novas linhas) em todas as células deste 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 em um único espaço.

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var range = sheet.getRange('A1:A4');
range.activate();
range.setValues(
    [' preceding space', 'following space ', 'two  middle  spaces', '   =SUM(1,2)'])

range.trimWhitespace();

var values = range.getValues();
// Values are ['preceding space', 'following space', 'two middle spaces', '=SUM(1,2)']

Retornar

Range: este intervalo, para encadeamento.

Autorização

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

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

`uncheck()`

Altera o estado das caixas de seleção no intervalo para "desmarcado". Ignora as células no intervalo que atualmente 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'.
var range = SpreadsheetApp.getActive().getRange('A1:B10');
range.uncheck();

Retornar

Range: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método requerem 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, em notação CSS (como '#ffffff' ou 'white').

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var 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 requerem 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').

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

var results = range.getFontColors();

for (var i in results) {
  for (var 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 requerem autorização com um ou mais dos seguintes escopos:

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