Esta página foi traduzida pela API Cloud Translation.

Class Range

Acessar e modificar intervalos de planilhas. Um intervalo pode ser uma única célula 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 o topo célula esquerda no intervalo como `current cell`.
`activateAsCurrentCell()`	`Range`	Define a célula especificada como a `current cell`.
`addDeveloperMetadata(key)`	`Range`	Adiciona metadados do desenvolvedor com a chave especificada ao intervalo.
`addDeveloperMetadata(key, visibility)`	`Range`	Adiciona metadados do desenvolvedor com a chave e a visibilidade especificadas ao intervalo.
`addDeveloperMetadata(key, value)`	`Range`	Adiciona metadados do desenvolvedor com a chave e o valor especificados ao intervalo.
`addDeveloperMetadata(key, value, visibility)`	`Range`	Adiciona metadados do desenvolvedor com a chave, o valor e a visibilidade especificados ao intervalo.
`applyColumnBanding()`	`Banding`	Aplica um tema padrão de faixas de coluna ao intervalo.
`applyColumnBanding(bandingTheme)`	`Banding`	Aplica um tema de faixa de coluna especificado ao intervalo.
`applyColumnBanding(bandingTheme, showHeader, showFooter)`	`Banding`	Aplica um tema de faixa de coluna especificado ao intervalo com cabeçalho e rodapé especificados configurações.
`applyRowBanding()`	`Banding`	Aplica um tema padrão de faixas de linha 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 de cabeçalho e rodapé especificadas.
`autoFill(destination, series)`	`void`	Preenche o `destinationRange` com dados com base nos dados desse intervalo.
`autoFillToNeighbor(series)`	`void`	Calcula um intervalo a ser preenchido com novos dados com base nas células vizinhas e preenche automaticamente esse intervalo com novos valores com base nos dados contidos nesse intervalo.
`breakApart()`	`Range`	Quebre novamente as células de várias colunas do 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 "marcada".
`clear()`	`Range`	Limpa o intervalo 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 com as opções avançadas fornecidas.
`clearContent()`	`Range`	Limpa o conteúdo do intervalo, deixando a formatação intacta.
`clearDataValidations()`	`Range`	Limpa as regras de validação de dados do intervalo.
`clearFormat()`	`Range`	Limpa a formatação do intervalo.
`clearNote()`	`Range`	Limpa a nota na célula ou células especificadas.
`collapseGroups()`	`Range`	Recolhe todos os grupos que estejam totalmente contidos no intervalo.
`copyFormatToRange(gridId, column, columnEnd, row, rowEnd)`	`void`	Copie a formatação do intervalo para o local fornecido.
`copyFormatToRange(sheet, column, columnEnd, row, rowEnd)`	`void`	Copie a formatação do intervalo para o local fornecido.
`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 especificado.
`copyValuesToRange(sheet, column, columnEnd, row, rowEnd)`	`void`	Copie o conteúdo do intervalo para o local especificado.
`createDataSourcePivotTable(dataSource)`	`DataSourcePivotTable`	Cria uma tabela dinâmica de fonte de dados vazia a partir da fonte de dados, ancorada na primeira célula em esse intervalo.
`createDataSourceTable(dataSource)`	`DataSourceTable`	Cria uma tabela de fonte de dados vazia a partir da fonte de dados, ancorada na primeira célula neste do intervalo 10.240.0.0/16.
`createDeveloperMetadataFinder()`	`DeveloperMetadataFinder`	Retorna um DeveloperMetadataFinderApi para encontrar os metadados do desenvolvedor no escopo deste do intervalo 10.240.0.0/16.
`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, ancorada na primeira célula nessa faixa.
`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 botão de alternância de controle cruza com este intervalo.
`getA1Notation()`	`String`	Retorna uma descrição em string do intervalo, em notação A1.
`getBackground()`	`String`	Retorna a cor de fundo da célula no canto superior esquerdo do intervalo (por exemplo, `'#ffffff'`).
`getBackgroundObject()`	`Color`	Retorna a cor de fundo da célula superior esquerda do intervalo.
`getBackgroundObjects()`	`Color[][]`	Retorna as cores de fundo das células no intervalo.
`getBackgrounds()`	`String[][]`	Retorna as cores de fundo das células no intervalo (por exemplo, `'#ffffff'`).
`getBandings()`	`Banding[]`	Retorna todas as faixas aplicadas a qualquer célula neste intervalo.
`getCell(row, column)`	`Range`	Retorna determinada célula dentro de um intervalo.
`getColumn()`	`Integer`	Retorna a posição inicial da coluna desse intervalo.
`getDataRegion()`	`Range`	Retorna uma cópia do intervalo expandido nos quatro cardeais `Direction`s para abranger todos células adjacentes com dados.
`getDataRegion(dimension)`	`Range`	Retorna uma cópia dos `Direction.UP` e `Direction.DOWN` expandidos do intervalo se o a dimensão especificada for `Dimension.ROWS` ou `Direction.NEXT` e `Direction.PREVIOUS` se a dimensão for `Dimension.COLUMNS`.
`getDataSourceFormula()`	`DataSourceFormula`	Retorna o `DataSourceFormula` para a primeira célula no intervalo, ou `null` se a célula não contém uma fórmula de fonte de dados.
`getDataSourceFormulas()`	`DataSourceFormula[]`	Retorna os `DataSourceFormula`s das células no intervalo.
`getDataSourcePivotTables()`	`DataSourcePivotTable[]`	Recebe todas as tabelas dinâmicas da fonte de dados que cruzam com o intervalo.
`getDataSourceTables()`	`DataSourceTable[]`	Recebe todas as tabelas da fonte de dados em interseção com o intervalo.
`getDataSourceUrl()`	`String`	Retorna um URL para os dados nesse intervalo, que pode ser usado para criar gráficos e consultas.
`getDataTable()`	`DataTable`	Retorne 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 para a célula superior esquerda do intervalo.
`getDataValidations()`	`DataValidation[][]`	Retorna as regras de validação de dados para todas as células no intervalo.
`getDeveloperMetadata()`	`DeveloperMetadata[]`	Recebe os metadados do desenvolvedor associados a esse intervalo.
`getDisplayValue()`	`String`	Retorna o valor exibido da célula superior esquerda do intervalo.
`getDisplayValues()`	`String[][]`	Retorna a grade retangular de valores para este intervalo.
`getFilter()`	`Filter`	Retorna o filtro na página a que este intervalo pertence ou `null` se não houver filtro em na planilha.
`getFontColorObject()`	`Color`	Retorna a cor da fonte da célula no canto superior esquerdo do intervalo.
`getFontColorObjects()`	`Color[][]`	Retorna as cores da fonte das células no intervalo.
`getFontFamilies()`	`String[][]`	Retorna as famílias de fontes das células no intervalo.
`getFontFamily()`	`String`	Retorna a família de fontes da célula no canto superior esquerdo do intervalo.
`getFontLine()`	`String`	Extrai o estilo da linha da célula no canto superior esquerdo do intervalo (`'underline'`, `'line-through'` ou `'none'`).
`getFontLines()`	`String[][]`	Extrai o estilo da linha das células no intervalo (`'underline'`, `'line-through'` ou `'none'`).
`getFontSize()`	`Integer`	Retorna o tamanho da fonte em tamanho de ponto da célula no canto superior esquerdo do intervalo.
`getFontSizes()`	`Integer[][]`	Retorna os tamanhos de fonte das células no intervalo.
`getFontStyle()`	`String`	Retorna o estilo da fonte (`'italic'` ou `'normal'`) da célula no canto superior esquerdo. o canto do intervalo.
`getFontStyles()`	`String[][]`	Retorna os estilos de fonte das células no intervalo.
`getFontWeight()`	`String`	Retorna a espessura da fonte (normal/negrito) da célula no canto superior esquerdo do intervalo.
`getFontWeights()`	`String[][]`	Retorna a espessura da fonte das células no intervalo.
`getFormula()`	`String`	Retorna a fórmula (notação A1) para a célula superior esquerda do intervalo, ou uma string vazia se o célula está vazia ou não contém uma fórmula.
`getFormulaR1C1()`	`String`	Retorna a fórmula (notação R1C1) para uma determinada célula ou `null` se não houver nenhuma.
`getFormulas()`	`String[][]`	Retorna as fórmulas (notação A1) para as células do intervalo.
`getFormulasR1C1()`	`String[][]`	Retorna as fórmulas (notação R1C1) para as células do 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 o canto 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 são totalmente no intervalo atual ou conter pelo menos uma célula no intervalo atual.
`getNextDataCell(direction)`	`Range`	Começando na célula da primeira coluna e linha do intervalo, retorna a célula seguinte na direção determinada, que é a borda de um intervalo contíguo de células com dados nelas ou na célula na borda da planilha nessa direção.
`getNote()`	`String`	Retorna a nota associada ao intervalo especificado.
`getNotes()`	`String[][]`	Retorna as notas associadas às células no intervalo.
`getNumColumns()`	`Integer`	Retorna o número de colunas neste intervalo.
`getNumRows()`	`Integer`	Retorna o número de linhas neste intervalo.
`getNumberFormat()`	`String`	Acessa 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 para as células no intervalo.
`getRichTextValue()`	`RichTextValue`	Retorna o valor de rich text para a célula superior esquerda do intervalo, ou `null` se a célula o valor não é texto.
`getRichTextValues()`	`RichTextValue[][]`	Retorna os valores em rich text para as células do intervalo.
`getRow()`	`Integer`	Retorna a posição da linha desse intervalo.
`getRowIndex()`	`Integer`	Retorna a posição da linha desse intervalo.
`getSheet()`	`Sheet`	Retorna a página a que este intervalo pertence.
`getTextDirection()`	`TextDirection`	Retorna a direção do texto para a célula superior esquerda do intervalo.
`getTextDirections()`	`TextDirection[][]`	Retorna as direções de texto para as células no intervalo.
`getTextRotation()`	`TextRotation`	Retorna as configurações de rotação de texto para a célula superior esquerda do intervalo.
`getTextRotations()`	`TextRotation[][]`	Retorna as configurações de rotação de texto para as células no intervalo.
`getTextStyle()`	`TextStyle`	Retorna o estilo de texto da célula superior esquerda do intervalo.
`getTextStyles()`	`TextStyle[][]`	Retorna os estilos de texto para as células do intervalo.
`getValue()`	`Object`	Retorna o valor da célula superior esquerda do 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 do intervalo 10.240.0.0/16.
`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 no intervalo.
`getWrapStrategy()`	`WrapStrategy`	Retorna a estratégia de ajuste de texto para a célula superior esquerda do intervalo.
`getWraps()`	`Boolean[][]`	Retorna se o texto nas células é ajustado.
`insertCells(shiftDimension)`	`Range`	Insere células vazias no intervalo.
`insertCheckboxes()`	`Range`	Insere caixas de seleção em cada célula do intervalo, configuradas com `true` para selecionadas e `false` para desmarcado.
`insertCheckboxes(checkedValue)`	`Range`	Insere caixas de seleção em cada célula do intervalo, configuradas com um valor personalizado para as a string vazia para desmarcar.
`insertCheckboxes(checkedValue, uncheckedValue)`	`Range`	Insere caixas de seleção em cada célula do intervalo, configuradas com valores personalizados para o campo e não marcados.
`isBlank()`	`Boolean`	Retorna `true` se o intervalo estiver totalmente em branco.
`isChecked()`	`Boolean`	Retorna indicando se todas as células no intervalo estão com a caixa de seleção marcada como 'marcada'.
`isEndColumnBounded()`	`Boolean`	Determina se o final do intervalo está vinculado a uma coluna específica.
`isEndRowBounded()`	`Boolean`	Determina se o final do intervalo está vinculado a uma linha específica.
`isPartOfMerge()`	`Boolean`	Retorna `true` se as células no intervalo atual se sobrepuserem 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 do intervalo em um só bloco.
`mergeAcross()`	`Range`	Mesclar as células do intervalo nas colunas do intervalo.
`mergeVertically()`	`Range`	Mescla as células no intervalo.
`moveTo(target)`	`void`	Recorte e cole (formato e valores) deste intervalo para o intervalo de destino.
`offset(rowOffset, columnOffset)`	`Range`	Retorna um novo intervalo que é deslocado deste intervalo pelo número de linhas e colunas fornecido. (o que pode ser negativo).
`offset(rowOffset, columnOffset, numRows)`	`Range`	Retorna um novo intervalo relativo ao atual, cujo ponto superior esquerdo é o deslocamento do intervalo atual pelas linhas e colunas especificadas e pela altura especificada nas células.
`offset(rowOffset, columnOffset, numRows, numColumns)`	`Range`	Retorna um novo intervalo relativo ao atual, cujo ponto superior esquerdo é o deslocamento do intervalo atual pelas linhas e colunas especificadas e com a altura e a largura informadas em células.
`protect()`	`Protection`	Cria um objeto que pode proteger o intervalo de ser editado, exceto por usuários que permissão.
`randomize()`	`Range`	Faz com que a ordem das linhas de um intervalo seja aleatória.
`removeCheckboxes()`	`Range`	Remove todas as caixas de seleção do intervalo.
`removeDuplicates()`	`Range`	Remove linhas dentro deste intervalo que contêm valores que são cópias de valores em qualquer linha anterior.
`removeDuplicates(columnsToCompare)`	`Range`	Remove linhas dentro do intervalo que contêm valores duplicados nas colunas especificadas. de valores em 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 no intervalo.
`setBackgroundObjects(color)`	`Range`	Define uma grade retangular de cores de plano de fundo (deve corresponder às dimensões deste intervalo).
`setBackgroundRGB(red, green, blue)`	`Range`	Define a cor do plano de fundo usando valores RGB (números inteiros entre 0 e 255).
`setBackgrounds(color)`	`Range`	Define uma grade retangular de cores de plano 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 da borda com cor e/ou estilo.
`setDataValidation(rule)`	`Range`	Define uma regra de validação de dados para todas as células no intervalo.
`setDataValidations(rules)`	`Range`	Define as regras de validação de dados para todas as células no intervalo.
`setFontColor(color)`	`Range`	Define a cor da fonte na notação CSS (como `'#ffffff'` ou `'white'`).
`setFontColorObject(color)`	`Range`	Define a cor da fonte do intervalo especificado.
`setFontColorObjects(colors)`	`Range`	Define uma grade retangular de cores de fonte (precisa corresponder às dimensões deste intervalo).
`setFontColors(colors)`	`Range`	Define uma grade retangular de cores de fonte (precisa corresponder às dimensões deste intervalo).
`setFontFamilies(fontFamilies)`	`Range`	Define uma grade retangular de famílias de fontes (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 da fonte do intervalo especificado (`'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 o tamanho o tamanho do 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`	Defina o estilo da fonte do intervalo especificado (`'italic'` ou `'normal'`).
`setFontStyles(fontStyles)`	`Range`	Define uma grade retangular de estilos de fonte (deve corresponder às dimensões deste intervalo).
`setFontWeight(fontWeight)`	`Range`	Define o peso da fonte para o intervalo especificado (normal/negrito).
`setFontWeights(fontWeights)`	`Range`	Define uma grade retangular de espessuras de fonte (precisa corresponder às dimensões deste intervalo).
`setFormula(formula)`	`Range`	Atualiza a fórmula para este intervalo.
`setFormulaR1C1(formula)`	`Range`	Atualiza a fórmula para este 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 (da esquerda para a direita) do intervalo especificado (esquerda/centro/direita).
`setHorizontalAlignments(alignments)`	`Range`	Define uma grade retangular de alinhamentos horizontais.
`setNote(note)`	`Range`	Define a nota para o valor informado.
`setNotes(notes)`	`Range`	Define uma grade retangular de notas (precisa corresponder às dimensões deste intervalo).
`setNumberFormat(numberFormat)`	`Range`	Define o formato de número ou data para a string de formatação especificada.
`setNumberFormats(numberFormats)`	`Range`	Define uma grade retangular de formatos numéricos ou de data (deve corresponder às dimensões deste intervalo).
`setRichTextValue(value)`	`Range`	Define o valor de rich text para as células do intervalo.
`setRichTextValues(values)`	`Range`	Define uma grade retangular de valores em rich text.
`setShowHyperlink(showHyperlink)`	`Range`	Define se o intervalo deve ou não mostrar hiperlinks.
`setTextDirection(direction)`	`Range`	Define a direção do texto para as células do intervalo.
`setTextDirections(directions)`	`Range`	Define uma grade retangular de rotas de texto.
`setTextRotation(degrees)`	`Range`	Define as configurações de rotação do texto para as células do intervalo.
`setTextRotation(rotation)`	`Range`	Define as configurações de rotação do texto para as células do intervalo.
`setTextRotations(rotations)`	`Range`	Define uma grade retangular de rotações de texto.
`setTextStyle(style)`	`Range`	Define o estilo do texto para as células do 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 específico (superior/médio/inferior).
`setVerticalAlignments(alignments)`	`Range`	Define uma grade retangular de alinhamentos verticais (deve corresponder às dimensões deste intervalo).
`setVerticalText(isVertical)`	`Range`	Define se o texto deve ou não empilhar para as células do intervalo.
`setWrap(isWrapEnabled)`	`Range`	Define a quebra de célula do intervalo especificado.
`setWrapStrategies(strategies)`	`Range`	Define uma grade retangular de estratégias de união.
`setWrapStrategy(strategy)`	`Range`	Define a estratégia de ajuste de texto para as células no intervalo.
`setWraps(isWrapEnabled)`	`Range`	Define uma grade retangular de políticas de ajuste de palavra (deve corresponder às dimensões deste intervalo).
`shiftColumnGroupDepth(delta)`	`Range`	Altera a profundidade do agrupamento de colunas do intervalo pelo 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 fornecido, 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 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 o espaço em branco (como espaços, tabulações ou novas linhas) em todas as células nesse intervalo.
`uncheck()`	`Range`	Altera o estado das caixas de seleção no intervalo para "desmarcada".

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 como `'#ffffff'` ou `'white'`).
`getFontColors()`	`String[][]`	Retorna as cores da fonte das células no intervalo em notação CSS (como `'#ffffff'` ou `'white'`).

Documentação detalhada

`activate()`

Define o intervalo especificado como active range, com o topo célula 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 a current cell.

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

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

Observação:o Range especificado precisa consistir de uma célula. Caso contrário, 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 precisam de 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 precisam de autorização com um ou mais dos seguintes escopos:

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

`addDeveloperMetadata(key, visibility)`

Adiciona metadados do desenvolvedor com a chave e a visibilidade especificadas ao intervalo.

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

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

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

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

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

Parâmetros

Nome	Tipo	Descrição
`key`	`String`	A chave 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 precisam de 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 precisam de 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 precisam de autorização com um ou mais dos seguintes escopos:

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

`applyColumnBanding()`

Aplica um tema padrão de faixas de coluna ao intervalo. Por padrão, as faixas têm 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 precisam de 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 coluna especificado ao intervalo. Por padrão, as faixas têm cabeçalho e sem 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 do intervalo.

Retornar

Banding — A nova faixa.

Autorização

Os scripts que usam esse método precisam de 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 faixa de coluna especificado ao intervalo com cabeçalho e rodapé especificados configurações.

// 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 do intervalo.
`showHeader`	`Boolean`	Se for `true`, a cor do cabeçalho do tema de faixas será aplicada ao primeiro .
`showFooter`	`Boolean`	Se for `true`, a cor do rodapé do tema de faixas será aplicada à última .

Retornar

Banding — A nova faixa.

Autorização

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

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

`applyRowBanding()`

Aplica um tema padrão de faixas de linha ao intervalo. Por padrão, as faixas têm cabeçalho e nenhuma cor do rodapé.

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

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

// Gets rows 1-30 on Sheet1.
const range = sheet.getRange('1:30');

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

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

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

Retornar

Banding — As faixas.

Autorização

Os scripts que usam esse método precisam de 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, as faixas têm cabeçalho e nenhuma cor do rodapé.

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

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

// Gets rows 1-30 on Sheet1.
const range = sheet.getRange('1:30');

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

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

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

Parâmetros

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

Retornar

Banding — A nova faixa.

Autorização

Os scripts que usam esse método precisam de 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 de cabeçalho e rodapé especificadas.

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

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

// Gets rows 1-30 on Sheet1.
const range = sheet.getRange('1:30');

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

Parâmetros

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

Retornar

Banding — A nova faixa.

Autorização

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

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

`autoFill(destination, series)`

Preenche o destinationRange com dados com base nos dados desse intervalo. Os novos valores também são determinados pelo tipo series especificado. O intervalo de destino deve conter esse intervalo e o estende em apenas uma direção. Por exemplo, o código abaixo 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 contêm esse intervalo e o estendem em apenas uma direção (para cima, para baixo, para a esquerda ou direita).
`series`	`AutoFillSeries`	O tipo de série de preenchimento automático que deve ser usada para calcular novos valores. A O efeito dessa série difere com base no tipo e na quantidade de dados de origem.

Autorização

Os scripts que usam esse método precisam de 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 nas 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 determinado pelo tipo de series especificado.

O intervalo de destino calculado considera os dados ao redor para determinar onde o novo valores devem ser inseridos: se houver dados imediatamente à esquerda ou à direita de uma coluna sendo preenchidos automaticamente, os novos valores se estendem somente 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 inserido em B5:B20. Dessa forma, esses novos valores "mantêm" às células que contêm 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 de preenchimento automático que deve ser usada para calcular novos valores. A O efeito dessa série difere com base no tipo e na quantidade de dados de origem.

Autorização

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

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

`breakApart()`

Quebre novamente as células de várias colunas do intervalo em células individuais.

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

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

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

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

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

Retornar

Range: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método precisam de 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. A planilha proprietário sempre pode editar páginas e intervalos protegidos.

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

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

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

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

Retornar

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

Autorização

Os scripts que usam esse método precisam de 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 "marcada". Ignora as células no intervalo. que não contêm o valor marcado ou desmarcado configurado.

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

Retornar

Range: este intervalo, para encadeamento.

Autorização

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

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

`clear()`

Limpa o intervalo de conteú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 precisam de autorização com um ou mais dos seguintes escopos:

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

`clear(options)`

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

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

Parâmetros

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

Parâmetros avançados

Nome	Tipo	Descrição
`commentsOnly`	`Boolean`	Define se apenas os comentários serão apagados.
`contentsOnly`	`Boolean`	Define se apenas o conteúdo será apagado.
`formatOnly`	`Boolean`	Define se apenas o formato será apagado. observe que limpar 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`	Define se as linhas filtradas devem ser limpas.

Retornar

Range: este intervalo, para encadeamento.

Autorização

Os scripts que usam esse método precisam de 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 precisam de autorização com um ou mais dos seguintes escopos:

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

`clearDataValidations()`

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

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

Retornar

Range: este intervalo, para encadeamento.

Autorização

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

Isso limpa a formatação do texto da célula ou das células no intervalo, mas não redefine nenhuma 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 precisam de 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 na célula ou 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 precisam de 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 que estejam totalmente contidos no intervalo. Se nenhum grupo estiver totalmente dentro o intervalo, o grupo expandido mais profundo que estiver 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 precisam de 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 fornecido. Se o destino for maior ou menor que o intervalo de origem, a origem será repetida ou truncada. Observe que este 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 ID exclusivo da página na planilha, independentemente da posição.
`column`	`Integer`	A primeira coluna do intervalo desejado.
`columnEnd`	`Integer`	A coluna final do intervalo de destino.
`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 precisam de autorização com um ou mais dos seguintes escopos:

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

Consulte também

getGridId()

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

Copie a formatação do intervalo para o local fornecido. Se o destino for maior ou menor que o intervalo de origem, a origem será repetida ou truncada. Observe que este copia apenas a formatação.

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 desejado.
`columnEnd`	`Integer`	A coluna final do intervalo de destino.
`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 precisam de 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 onde copiar. somente a posição da célula superior esquerda é relevante.

Autorização

Os scripts que usam esse método precisam de 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 onde copiar. somente 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 precisam de 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 formatação são copiadas, 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 onde copiar. somente a posição da célula superior esquerda é relevante.
`options`	`Object`	Um objeto JavaScript que especifica parâmetros avançados, conforme listado abaixo.

Parâmetros avançados

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

Autorização

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

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

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

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

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 ID exclusivo da página na planilha, independentemente da posição.
`column`	`Integer`	A primeira coluna do intervalo desejado.
`columnEnd`	`Integer`	A coluna final do intervalo de destino.
`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 precisam de autorização com um ou mais dos seguintes escopos:

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

Consulte também

getGridId()

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

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

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 desejado.
`columnEnd`	`Integer`	A coluna final do intervalo de destino.
`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 precisam de 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 em desse intervalo.

Neste exemplo, mostramos 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 a partir da qual a tabela dinâmica será criada.

Retornar

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

Autorização

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

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

`createDataSourceTable(dataSource)`

Cria uma tabela de fonte de dados vazia a partir da fonte de dados, ancorada na primeira célula neste do intervalo 10.240.0.0/16.

Neste exemplo, mostramos 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 a partir da qual a tabela dinâmica será criada.

Retornar

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

Autorização

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

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

`createDeveloperMetadataFinder()`

Retorna um DeveloperMetadataFinderApi para encontrar os metadados do desenvolvedor no escopo deste do intervalo 10.240.0.0/16. Os metadados estarão no escopo do intervalo somente se estiverem totalmente contidos nesse intervalo. do intervalo 10.240.0.0/16. Por exemplo, os metadados associados à linha "3:3" não estão no escopo de um intervalo. "A1:D5", mas está no escopo de um intervalo de "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 planilha. 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 este método para criar filtros para páginas Grid, o tipo padrão de página. As páginas de grade são aquelas que não estão conectadas a um banco de dados. Para criar outros tipos de filtros, consulte o seguinte:

Criar um filtro de tabela dinâmica com PivotTable.addFilter(sourceDataColumn, filterCriteria)
Criar um filtro para uma página conectada a um banco de dados com DataSourceSheet.addFilter(columnName, filterCriteria)
Criar 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 precisam de 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, ancorada na primeira célula nessa faixa.

// 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 a partir dos quais a tabela dinâmica será criada.

Retornar

PivotTable: o PivotTable recém-criado.

Autorização

Os scripts que usam esse método precisam de 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 = textFinder.replaceWith('cat');

Parâmetros

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

Retornar

TextFinder: o TextFinder do intervalo

`deleteCells(shiftDimension)`

Exclui este intervalo de células. Os dados existentes na página ao longo da dimensão fornecida são deslocados em direção ao 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 com a qual os dados existentes serão transferidos.

Autorização

Os scripts que usam esse método precisam de 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 botão de alternância de controle cruza com este intervalo. A o local de alternância dos controles é o índice em que o controle é mostrado, diretamente antes ou depois do grupo, dependendo das configurações. Se houver mais de um grupo no mesmo local, o grupo mais baixo é 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 precisam de 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 em string do intervalo, em 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 precisam de 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 no canto superior esquerdo do 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 precisam de 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 do 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 do intervalo.

Autorização

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

Autorização

Os scripts que usam esse método precisam de 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 determinada célula 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 relativa ao intervalo.
`column`	`Integer`	A coluna da célula relativa 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 precisam de 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 desse 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 inicial da coluna do intervalo na planilha.

Autorização

Os scripts que usam esse método precisam de 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 cardeais Directions para abranger todos células adjacentes com dados. Se o intervalo estiver entre células vazias, sem incluir essas nas diagonais, o próprio intervalo é retornado. Isso é semelhante a selecionar o intervalo digitando 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 de toda a planilha.

Autorização

Os scripts que usam esse método precisam de 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 dos Direction.UP e Direction.DOWN expandidos do intervalo se o 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 baseia-se na detecção de dados ao lado do intervalo organizado como uma tabela. Intervalo expandido abrange todas as células adjacentes com dados ao longo da dimensão especificada, incluindo a tabela limites. Se o intervalo original estiver entre células vazias na dimensão especificada, o próprio intervalo é 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 na qual expandir o intervalo.

Retornar

Range: a região de dados do intervalo ou um intervalo que cobre cada coluna ou linha abrangida pela ao intervalo original.

Autorização

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

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

`getDataSourceFormula()`

Retorna o DataSourceFormula para a primeira célula no intervalo, ou null se a célula não contém uma fórmula de fonte de dados.

// Opens the spreadsheet file by its ID. If you created your script from a Google Sheets file,
// use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

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

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

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

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

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

Retornar

DataSourceFormula: o DataSourceFormula da célula.

Autorização

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

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

`getDataSourceFormulas()`

Retorna os DataSourceFormulas das células no intervalo.

// Opens the spreadsheet file by its ID. If you created your script from a Google Sheets file,
// use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

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

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

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

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

Retornar

DataSourceFormula[]: uma matriz de DataSourceFormulas.

Autorização

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

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

`getDataSourcePivotTables()`

Recebe todas as tabelas dinâmicas da fonte de dados que cruzam com o intervalo.

// Opens the spreadsheet file by its ID. If you created your script from a Google Sheets file,
// use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

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

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

// Gets an array of the data source pivot tables in the range A1:G50.
const dataSourcePivotTables = range.getDataSourcePivotTables();

// Logs the last time that the first pivot table in the array was refreshed.
console.log(dataSourcePivotTables[0].getStatus().getLastRefreshedTime());

Retornar

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

Autorização

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

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

`getDataSourceTables()`

Recebe todas as tabelas da fonte de dados em interseção com o intervalo.

// Opens the spreadsheet file by its ID. If you created your script from a Google Sheets file,
// use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

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

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

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

// Logs the time of the last completed data execution on the data source table.
console.log(dataSourceTable.getStatus().getLastExecutionTime());

Retornar

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

Autorização

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

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

`getDataSourceUrl()`

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

Code.gs

function doGet() {
  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 desse 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 precisam de autorização com um ou mais dos seguintes escopos:

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

`getDataTable()`

Retorne os dados dentro desse objeto como uma DataTable.

// Opens the spreadsheet file by its ID. If you created your script from a Google Sheets file,
// use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

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

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

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

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

Retornar

DataTable: os dados como uma tabela de dados.

`getDataTable(firstRowIsHeader)`

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`	Define 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 precisam de 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 para a célula superior esquerda do intervalo. Se a validação de dados não foi definido na célula, esse método retorna 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 superior esquerda do intervalo.

Autorização

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

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

`getDataValidations()`

Retorna as regras de validação de dados para todas as células no intervalo. Se a validação de dados não foi definido em uma determinada célula, esse método retorna 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 da do intervalo 10.240.0.0/16.

Autorização

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

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

`getDeveloperMetadata()`

Recebe os metadados do desenvolvedor associados a esse intervalo.

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

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

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

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

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

Retornar

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

Autorização

Os scripts que usam esse método precisam de 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 do intervalo. O valor é um String. O valor exibido considera a formatação de data, hora e moeda, incluindo: são aplicados automaticamente pela configuração de localidade da planilha. As células vazias retornam uma imagem fio.

// 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 precisam de 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. A valores são objetos String. O valor exibido considera data, hora e formatação de moeda, inclusive formatos aplicados automaticamente pela localidade da planilha do ambiente. As células vazias são representadas por uma string vazia na matriz. Lembre-se de que, embora índice de intervalo começa em 1, 1, a matriz JavaScript é indexada a partir 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 bidimensional de valores.

Autorização

Os scripts que usam esse método precisam de 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 este intervalo pertence ou null se não houver filtro em na planilha.

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 precisam de 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 do intervalo.

Autorização

Os scripts que usam esse método precisam de 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 fontes associadas às células no intervalo.

Autorização

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

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

`getFontFamilies()`

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

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 fontes associadas às células no intervalo.

Autorização

Os scripts que usam esse método precisam de 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 precisam de autorização com um ou mais dos seguintes escopos:

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

`getFontLine()`

Extrai o estilo da 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 precisam de autorização com um ou mais dos seguintes escopos:

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

`getFontLines()`

Extrai o estilo da 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