Class Sheet

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

Acesse e modifique as planilhas. As operações comuns são renomear uma página e acessar objetos de intervalo dela.

Métodos

MétodoTipo de retornoBreve descrição
activate()SheetAtiva esta página.
addDeveloperMetadata(key)SheetAdiciona metadados de desenvolvedor com a chave especificada à página.
addDeveloperMetadata(key, visibility)SheetAdiciona metadados do desenvolvedor com a chave especificada e a visibilidade da página.
addDeveloperMetadata(key, value)SheetAdiciona metadados do desenvolvedor à chave e ao valor especificados à planilha.
addDeveloperMetadata(key, value, visibility)SheetAdiciona metadados do desenvolvedor com a chave, o valor e a visibilidade especificados à página.
appendRow(rowContents)SheetAnexa uma linha à parte inferior da região de dados atual da página.
asDataSourceSheet()DataSourceSheetRetornará a página como uma DataSourceSheet se a página for do tipo SheetType.DATASOURCE. Caso contrário, retornará null.
autoResizeColumn(columnPosition)SheetDefine a largura da coluna específica para que se ajuste ao conteúdo.
autoResizeColumns(startColumn, numColumns)SheetDefine a largura de todas as colunas começando na posição da coluna específica para ajustar o conteúdo.
autoResizeRows(startRow, numRows)SheetDefine a altura de todas as linhas que começam na posição de linha especificada de acordo com o conteúdo.
clear()SheetLimpa a página de conteúdo e informações de formatação.
clear(options)SheetLimpa o sumário e/ou o formato, conforme especificado com as opções avançadas fornecidas.
clearConditionalFormatRules()voidRemove todas as regras de formatação condicional da página.
clearContents()SheetLimpa o índice e preserva as informações de formatação.
clearFormats()SheetLimpa a página de formatação, preservando o conteúdo.
clearNotes()SheetLimpa a página de todas as notas.
collapseAllColumnGroups()SheetRecolhe todos os grupos de colunas na página.
collapseAllRowGroups()SheetRecolhe todos os grupos de linhas na página.
copyTo(spreadsheet)SheetCopia a página para uma planilha específica, que pode ser a mesma da fonte.
createDeveloperMetadataFinder()DeveloperMetadataFinderRetorna um DeveloperMetadataFinder para encontrar metadados de desenvolvedor no escopo desta página.
createTextFinder(findText)TextFinderCria um localizador para a página, que pode encontrar e substituir texto.
deleteColumn(columnPosition)SheetExclui a coluna na posição da coluna especificada.
deleteColumns(columnPosition, howMany)voidExclui várias colunas da posição de coluna especificada.
deleteRow(rowPosition)SheetExclui a linha na posição da linha especificada.
deleteRows(rowPosition, howMany)voidExclui um número de linhas que começam na posição de linha especificada.
expandAllColumnGroups()SheetExpande todos os grupos de colunas na página.
expandAllRowGroups()SheetExpande todos os grupos de linhas na página.
expandColumnGroupsUpToDepth(groupDepth)SheetExpande todos os grupos de colunas até a profundidade especificada e recolhe todos os outros.
expandRowGroupsUpToDepth(groupDepth)SheetExpande todos os grupos de linhas até a profundidade especificada e recolhe todos os outros.
getActiveCell()RangeRetorna a célula ativa desta página.
getActiveRange()RangeRetorna o intervalo selecionado na página ativa ou null se não houver um intervalo ativo.
getActiveRangeList()RangeListRetorna a lista de intervalos ativos na página ativa ou null se não houver intervalos ativos.
getBandings()Banding[]Retorna todas as faixas nesta página.
getCharts()EmbeddedChart[]Retorna uma matriz de gráficos nesta página.
getColumnGroup(columnIndex, groupDepth)GroupRetorna o grupo de colunas na indexação e na profundidade do grupo fornecidos.
getColumnGroupControlPosition()GroupControlTogglePositionRetorna GroupControlTogglePosition para todos os grupos de colunas da página.
getColumnGroupDepth(columnIndex)IntegerRetorna a profundidade de grupo da coluna no índice especificado.
getColumnWidth(columnPosition)IntegerRecebe a largura em pixels da coluna especificada.
getConditionalFormatRules()ConditionalFormatRule[]Veja todas as regras de formatação condicional nesta página.
getCurrentCell()RangeRetorna a célula atual da página ativa ou null se não houver nenhuma célula atual.
getDataRange()RangeRetorna um Range correspondente às dimensões em que os dados estão presentes.
getDataSourceFormulas()DataSourceFormula[]Recebe todas as fórmulas da fonte de dados.
getDataSourcePivotTables()DataSourcePivotTable[]Recebe todas as tabelas dinâmicas da fonte de dados.
getDataSourceTables()DataSourceTable[]Recebe todas as tabelas de fontes de dados.
getDeveloperMetadata()DeveloperMetadata[]Acesse todos os metadados do desenvolvedor associados a esta planilha.
getDrawings()Drawing[]Retorna uma matriz de desenhos na página.
getFilter()FilterRetorna o filtro nesta página ou null se não houver filtro.
getFormUrl()StringRetorna o URL do formulário que envia as respostas a esta página ou null caso a página não tenha um formulário associado.
getFrozenColumns()IntegerRetorna o número de colunas congeladas.
getFrozenRows()IntegerRetorna o número de linhas congeladas.
getImages()OverGridImage[]Retorna todas as imagens na grade da página.
getIndex()IntegerAcessa a posição da página na planilha mãe.
getLastColumn()IntegerRetorna a posição da última coluna que tem conteúdo.
getLastRow()IntegerRetorna a posição da última linha que tenha conteúdo.
getMaxColumns()IntegerRetorna o número atual de colunas na página, independentemente do conteúdo.
getMaxRows()IntegerRetorna o número atual de linhas na página, independentemente do conteúdo.
getName()StringRetorna o nome da página.
getNamedRanges()NamedRange[]Recebe todos os intervalos nomeados nesta planilha.
getParent()SpreadsheetRetorna o Spreadsheet que contém a página.
getPivotTables()PivotTable[]Retorna todas as tabelas dinâmicas nesta página.
getProtections(type)Protection[]Recebe uma matriz de objetos que representam todos os intervalos protegidos na página ou uma matriz de elemento único que representa a proteção na própria página.
getRange(row, column)RangeRetorna o intervalo com a célula superior esquerda nas coordenadas fornecidas.
getRange(row, column, numRows)RangeRetorna o intervalo com a célula superior esquerda nas coordenadas especificadas e com o número de linhas especificado.
getRange(row, column, numRows, numColumns)RangeRetorna o intervalo com a célula superior esquerda nas coordenadas especificadas com o número de linhas e colunas especificado.
getRange(a1Notation)RangeRetorna o intervalo conforme especificado na notação A1 ou R1C1.
getRangeList(a1Notations)RangeListRetorna a coleção RangeList que representa os intervalos na mesma página especificada por uma lista não vazia de anotações A1 ou R1C1.
getRowGroup(rowIndex, groupDepth)GroupRetorna o grupo de linhas no índice e profundidade de grupo fornecidos.
getRowGroupControlPosition()GroupControlTogglePositionRetorna o GroupControlTogglePosition para todos os grupos de linhas na página.
getRowGroupDepth(rowIndex)IntegerRetorna a profundidade do grupo da linha em um índice específico.
getRowHeight(rowPosition)IntegerRecebe a altura em pixels da linha especificada.
getSelection()SelectionRetorna o Selection atual na planilha.
getSheetId()IntegerRetorna o ID da página representada por esse objeto.
getSheetName()StringRetorna o nome da página.
getSheetValues(startRow, startColumn, numRows, numColumns)Object[][]Retorna a grade retangular de valores desse intervalo, começando com as coordenadas fornecidas.
getSlicers()Slicer[]Retorna uma matriz de controles de filtros na página.
getTabColorObject()ColorRecebe a cor da guia da página ou null se a guia da página não tiver cor.
getType()SheetTypeRetorna o tipo da página.
hasHiddenGridlines()BooleanRetornará true se as linhas de grade da página estiverem ocultas. Caso contrário, retornará false.
hideColumn(column)voidOculta a coluna ou as colunas no intervalo especificado.
hideColumns(columnIndex)voidOculta uma única coluna no índice especificado.
hideColumns(columnIndex, numColumns)voidOculta uma ou mais colunas consecutivas que começam no índice especificado.
hideRow(row)voidOculta as linhas no intervalo especificado.
hideRows(rowIndex)voidOculta a linha no índice especificado.
hideRows(rowIndex, numRows)voidOculta uma ou mais linhas consecutivas que começam no índice especificado.
hideSheet()SheetOculta esta página.
insertChart(chart)voidAdiciona um novo gráfico à página.
insertColumnAfter(afterPosition)SheetInsere uma coluna após a posição da coluna especificada.
insertColumnBefore(beforePosition)SheetInsere uma coluna antes da posição especificada na coluna.
insertColumns(columnIndex)voidInsere uma coluna em branco em uma página no local especificado.
insertColumns(columnIndex, numColumns)voidInsere uma ou mais colunas em branco consecutivas em uma página a partir do local especificado.
insertColumnsAfter(afterPosition, howMany)SheetInsere várias colunas após a posição da coluna especificada.
insertColumnsBefore(beforePosition, howMany)SheetInsere um número de colunas antes da posição da coluna especificada.
insertImage(blobSource, column, row)OverGridImageInsere uma BlobSource como imagem no documento em uma determinada linha e coluna.
insertImage(blobSource, column, row, offsetX, offsetY)OverGridImageInsere um BlobSource como uma imagem no documento em uma determinada linha e coluna, com um deslocamento de pixel.
insertImage(url, column, row)OverGridImageInsere uma imagem no documento em uma determinada linha e coluna.
insertImage(url, column, row, offsetX, offsetY)OverGridImageInsere uma imagem no documento em uma determinada linha e coluna, com um deslocamento de pixels.
insertRowAfter(afterPosition)SheetInsere uma linha após a posição da linha especificada.
insertRowBefore(beforePosition)SheetInsere uma linha antes da posição de linha especificada.
insertRows(rowIndex)voidInsere uma linha em branco em uma página no local especificado.
insertRows(rowIndex, numRows)voidInsere uma ou mais linhas em branco consecutivas em uma página a partir do local especificado.
insertRowsAfter(afterPosition, howMany)SheetInsere várias linhas após a posição da linha especificada.
insertRowsBefore(beforePosition, howMany)SheetInsere várias linhas antes da posição de linha especificada.
insertSlicer(range, anchorRowPos, anchorColPos)SlicerAdiciona um novo controle de filtros a esta página.
insertSlicer(range, anchorRowPos, anchorColPos, offsetX, offsetY)SlicerAdiciona um novo controle de filtros a esta página.
isColumnHiddenByUser(columnPosition)BooleanRetorna se a coluna especificada é oculta pelo usuário.
isRightToLeft()BooleanRetorna true se o layout da página for da direita para a esquerda.
isRowHiddenByFilter(rowPosition)BooleanRetorna se a linha especificada está oculta por um filtro (não uma visualização com filtro).
isRowHiddenByUser(rowPosition)BooleanRetorna se a linha especificada é oculta pelo usuário.
isSheetHidden()BooleanRetornará true se a página estiver oculta.
moveColumns(columnSpec, destinationIndex)voidMove as colunas selecionadas pelo intervalo especificado para a posição indicada pelo destinationIndex.
moveRows(rowSpec, destinationIndex)voidMove as linhas selecionadas pelo intervalo especificado para a posição indicada pelo destinationIndex.
newChart()EmbeddedChartBuilderRetorna um builder para criar um novo gráfico na página.
protect()ProtectionCria um objeto que pode proteger a página de ser editada por usuários que tenham permissão.
removeChart(chart)voidRemove um gráfico da página mãe.
setActiveRange(range)RangeDefine o intervalo especificado como active range na página ativa, com a célula superior esquerda no intervalo como current cell.
setActiveRangeList(rangeList)RangeListDefine a lista especificada de intervalos como o active ranges na página ativa.
setActiveSelection(range)RangeDefine a região de seleção ativa para esta página.
setActiveSelection(a1Notation)RangeDefine a seleção ativa, conforme especificado na notação A1 ou R1C1.
setColumnGroupControlPosition(position)SheetDefine a posição do botão de controle do grupo de colunas na página.
setColumnWidth(columnPosition, width)SheetDefine a largura da coluna especificada em pixels.
setColumnWidths(startColumn, numColumns, width)SheetDefine a largura das colunas fornecidas em pixels.
setConditionalFormatRules(rules)voidSubstitui todas as regras de formatação condicional existentes na planilha pelas regras de entrada.
setCurrentCell(cell)RangeDefine a célula especificada como current cell.
setFrozenColumns(columns)voidCongela o número fornecido de colunas.
setFrozenRows(rows)voidCongela o número fornecido de linhas.
setHiddenGridlines(hideGridlines)SheetOculta ou revela as linhas da grade da página.
setName(name)SheetDefine o nome da página.
setRightToLeft(rightToLeft)SheetDefine ou desativa o layout da página da direita para a esquerda.
setRowGroupControlPosition(position)SheetDefine a posição do botão de controle do grupo de linhas na página.
setRowHeight(rowPosition, height)SheetDefine a altura da linha em pixels.
setRowHeights(startRow, numRows, height)SheetDefine a altura das linhas fornecidas em pixels.
setRowHeightsForced(startRow, numRows, height)SheetDefine a altura das linhas fornecidas em pixels.
setTabColor(color)SheetDefine a cor da guia da página.
setTabColorObject(color)SheetDefine a cor da guia da página.
showColumns(columnIndex)voidReexibe a coluna no índice especificado.
showColumns(columnIndex, numColumns)voidReexibe uma ou mais colunas consecutivas a partir do índice especificado.
showRows(rowIndex)voidReexibe a linha em um índice específico.
showRows(rowIndex, numRows)voidReexibe uma ou mais linhas consecutivas a partir do índice especificado.
showSheet()SheetTorna a página visível.
sort(columnPosition)SheetClassifica uma página por coluna, em ordem crescente.
sort(columnPosition, ascending)SheetClassifica uma página por coluna.
unhideColumn(column)voidReexibe a coluna no intervalo especificado.
unhideRow(row)voidReexibe a linha no intervalo especificado.
updateChart(chart)voidAtualiza o gráfico nesta página.

Documentação detalhada

activate()

Ativa esta página. Não muda a página em si, apenas a noção do pai da página ativa.

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

Retornar

Sheet: a página ativa recentemente.


addDeveloperMetadata(key)

Adiciona metadados de desenvolvedor com a chave especificada à página.

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

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

// Adds the key 'NAME' to the developer metadata for the sheet.
sheet.addDeveloperMetadata('NAME');

// Gets the updated metadata info and logs it to the console.
console.log(sheet.getDeveloperMetadata()[0].getKey());

Parâmetros

NomeTipoDescrição
keyStringA chave dos metadados do novo desenvolvedor.

Retornar

Sheet: esta página, para encadeamento.

Autorização

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

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

addDeveloperMetadata(key, visibility)

Adiciona metadados do desenvolvedor com a chave especificada e a visibilidade da página.

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

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

// Adds the key 'NAME' and sets the developer metadata visibility to PROJECT
// for the sheet.
sheet.addDeveloperMetadata('NAME', SpreadsheetApp.DeveloperMetadataVisibility.PROJECT);

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

Parâmetros

NomeTipoDescrição
keyStringA chave dos metadados do novo desenvolvedor.
visibilityDeveloperMetadataVisibilityA visibilidade dos novos metadados do desenvolvedor.

Retornar

Sheet: esta página, para encadeamento.

Autorização

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

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

addDeveloperMetadata(key, value)

Adiciona metadados do desenvolvedor à chave e ao valor especificados à planilha.

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

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

// Adds the key 'COMPANY' with the value 'TECH' to the developer metadata for the sheet.
sheet.addDeveloperMetadata('COMPANY', 'TECH');

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

Parâmetros

NomeTipoDescrição
keyStringA chave dos metadados do novo desenvolvedor.
valueStringO valor dos novos metadados do desenvolvedor.

Retornar

Sheet: esta página, para encadeamento.

Autorização

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

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

addDeveloperMetadata(key, value, visibility)

Adiciona metadados do desenvolvedor com a chave, o valor e a visibilidade especificados à página.

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

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

// Adds the key 'COMPANY' with the value 'TECH' to the developer metadata and sets the
// visibility to DOCUMENT for the sheet.
sheet.addDeveloperMetadata(
  'COMPANY',
  'TECH',
  SpreadsheetApp.DeveloperMetadataVisibility.DOCUMENT);

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

Parâmetros

NomeTipoDescrição
keyStringA chave dos metadados do novo desenvolvedor.
valueStringO valor dos novos metadados do desenvolvedor.
visibilityDeveloperMetadataVisibilityA visibilidade dos novos metadados do desenvolvedor.

Retornar

Sheet: esta página, para encadeamento.

Autorização

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

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

appendRow(rowContents)

Anexa uma linha à parte inferior da região de dados atual da página.

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

// Appends a new row with 3 columns to the bottom of the current
// data region in the sheet containing the values in the array.
sheet.appendRow(["a man", "a plan", "panama"]);

Parâmetros

NomeTipoDescrição
rowContentsObject[]Uma matriz de valores a serem inseridos após a última linha na página.

Retornar

Sheet: a página, útil para encadeamento de métodos.

Autorização

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

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

asDataSourceSheet()

Retornará a página como uma DataSourceSheet se a página for do tipo SheetType.DATASOURCE. Caso contrário, retornará null.

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

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

// Gets the data source sheet value if the sheet is of type
// SpreadsheetApp.SheetType.DATASOURCE, otherwise this returns a null value.
const dataSourceSheet = sheet.asDataSourceSheet();

// Gets the data source sheet value and logs it to the console.
console.log(dataSourceSheet);
console.log(sheet.getType().toString());

Retornar

DataSourceSheet: uma página de fonte de dados.

Autorização

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

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

autoResizeColumn(columnPosition)

Define a largura da coluna específica para que se ajuste ao conteúdo.

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

sheet.getRange('a1').setValue('Whenever it is a damp, drizzly November in my soul...');

// Sets the first column to a width which fits the text
sheet.autoResizeColumn(1);

Parâmetros

NomeTipoDescrição
columnPositionIntegerA posição da coluna especificada para redimensionar.

Retornar

Sheet: a página, útil para encadeamento de métodos

Autorização

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

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

autoResizeColumns(startColumn, numColumns)

Define a largura de todas as colunas começando na posição da coluna específica para ajustar o conteúdo.

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

// Sets the first 15 columns to a width that fits their text.
sheet.autoResizeColumns(1, 15);

Parâmetros

NomeTipoDescrição
startColumnIntegerA coluna inicial que será redimensionada automaticamente.
numColumnsIntegerO número de colunas para redimensionamento automático.

Retornar

Sheet: esta página, para encadeamento.

Autorização

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

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

autoResizeRows(startRow, numRows)

Define a altura de todas as linhas que começam na posição de linha especificada de acordo com o conteúdo.

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

// Sets the first 15 rows to a height that fits their text.
sheet.autoResizeRows(1, 15);

Parâmetros

NomeTipoDescrição
startRowIntegerA linha inicial deve ser redimensionada automaticamente.
numRowsIntegerO número de linhas a serem redimensionadas automaticamente.

Retornar

Sheet: esta página, para encadeamento.

Autorização

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

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

clear()

Limpa a página de conteúdo e informações de formatação.

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

Retornar

Sheet: a página removida.

Autorização

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

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

clear(options)

Limpa o sumário e/ou o formato, conforme especificado com as opções avançadas fornecidas.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
sheet.clear({ formatOnly: true, contentsOnly: true });

Parâmetros

NomeTipoDescrição
optionsObjectUm mapa JavaScript com opções avançadas listadas abaixo.

Parâmetros avançados

NomeTipoDescrição
contentsOnlyBooleanDefine se o conteúdo será apagado.
formatOnlyBooleanDefine se o formato será limpo.

Retornar

Sheet: esta página, para encadeamento.

Autorização

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

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

clearConditionalFormatRules()

Remove todas as regras de formatação condicional da página. É equivalente a chamar setConditionalFormatRules(rules) com uma matriz vazia como entrada.

var sheet = SpreadsheetApp.getActiveSheet();
sheet.clearConditionalFormatRules();

Autorização

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

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

clearContents()

Limpa o índice e preserva as informações de formatação.

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

Retornar

Sheet: esta página, para encadeamento.

Autorização

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

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

clearFormats()

Limpa a página de formatação, preservando o conteúdo.

A formatação se refere à maneira como os dados são formatados conforme permitido pelas opções no menu "Formato" (por exemplo, negrito, itálico, formatação condicional), e não pela largura ou altura das células.

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

Retornar

Sheet: esta página, para encadeamento.

Autorização

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

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

clearNotes()

Limpa a página de todas as notas.

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

Retornar

Sheet: esta página, para encadeamento.

Autorização

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

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

collapseAllColumnGroups()

Recolhe todos os grupos de colunas na página.

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

// All column groups on the sheet are collapsed.
sheet.collapseAllColumnGroups();

Retornar

Sheet: esta página, para encadeamento.

Autorização

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

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

collapseAllRowGroups()

Recolhe todos os grupos de linhas na página.

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

// All row groups on the sheet are collapsed.
sheet.collapseAllRowGroups();

Retornar

Sheet: esta página, para encadeamento.

Autorização

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

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

copyTo(spreadsheet)

Copia a página para uma planilha específica, que pode ser a mesma da fonte. A cópia foi chamada de "Cópia de [nome original]".

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

var destination = SpreadsheetApp.openById('ID_GOES HERE');
sheet.copyTo(destination);

Parâmetros

NomeTipoDescrição
spreadsheetSpreadsheetA planilha para onde copiar esta página, que pode ser a mesma da fonte.

Retornar

Sheet: a nova página de encadeamento.

Autorização

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

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

createDeveloperMetadataFinder()

Retorna um DeveloperMetadataFinder para encontrar metadados de desenvolvedor no escopo desta página. Os metadados estão no escopo de uma página específica se estiverem associados à própria página ou a uma linha, coluna ou intervalo nessa página.

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

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

// Adds developer metadata for testing.
sheet.addDeveloperMetadata('CITY', 'PARIS');

// Creates the developer metadata finder.
const metadatafinder = sheet.createDeveloperMetadataFinder();

// Finds the metadata with value 'PARIS' and displays its key in the console.
console.log(metadatafinder.withValue('PARIS').find()[0].getKey());

Retornar

DeveloperMetadataFinder: um localizador de metadados do desenvolvedor para pesquisar metadados no escopo desta página.


createTextFinder(findText)

Cria um localizador para a página, que pode encontrar e substituir texto.

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

// Creates  a text finder.
var textFinder = sheet.createTextFinder('dog');

// Returns the first occurrence of 'dog' in the sheet.
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

NomeTipoDescrição
findTextStringO texto a ser pesquisado.

Retornar

TextFinder: o TextFinder da página.


deleteColumn(columnPosition)

Exclui a coluna na posição da coluna especificada.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Columns start at "1" - this deletes the first column
sheet.deleteColumn(1);

Parâmetros

NomeTipoDescrição
columnPositionIntegerA posição da coluna, começando em 1 para a primeira coluna.

Retornar

Sheet: a página, útil para encadeamento de métodos

Autorização

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

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

deleteColumns(columnPosition, howMany)

Exclui várias colunas da posição de coluna especificada.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Columns start at "1" - this deletes the first two columns
sheet.deleteColumns(1, 2);

Parâmetros

NomeTipoDescrição
columnPositionIntegerA posição da primeira coluna a ser excluída.
howManyIntegerO número de colunas a serem excluídas.

Autorização

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

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

deleteRow(rowPosition)

Exclui a linha na posição da linha especificada.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Rows start at "1" - this deletes the first row
sheet.deleteRow(1);

Parâmetros

NomeTipoDescrição
rowPositionIntegerA posição da linha, começando em 1 pela primeira linha.

Retornar

Sheet: a página, útil para encadeamento de métodos

Autorização

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

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

deleteRows(rowPosition, howMany)

Exclui um número de linhas que começam na posição de linha especificada.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Rows start at "1" - this deletes the first two rows
sheet.deleteRows(1, 2);

Parâmetros

NomeTipoDescrição
rowPositionIntegerA posição da primeira linha a ser excluída.
howManyIntegerO número de linhas a serem excluídas.

Autorização

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

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

expandAllColumnGroups()

Expande todos os grupos de colunas na página. Esse método requer pelo menos um grupo de colunas.

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

// All column groups on the sheet are expanded.
sheet.expandAllColumnGroups();

Retornar

Sheet: esta página, para encadeamento.

Autorização

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

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

expandAllRowGroups()

Expande todos os grupos de linhas na página. Esse método requer pelo menos um grupo de linhas.

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

// All row groups on the sheet are expanded.
sheet.expandAllRowGroups();

Retornar

Sheet: esta página, para encadeamento.

Autorização

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

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

expandColumnGroupsUpToDepth(groupDepth)

Expande todos os grupos de colunas até a profundidade especificada e recolhe todos os outros.

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

// All column groups of depth 2 and lower are expanded, and groups with depth
// 3 and higher are collapsed.
sheet.expandColumnGroupsUpToDepth(2);

Parâmetros

NomeTipoDescrição
groupDepthIntegerA profundidade do grupo no qual expandir os grupos de colunas.

Retornar

Sheet: esta página, para encadeamento.

Autorização

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

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

expandRowGroupsUpToDepth(groupDepth)

Expande todos os grupos de linhas até a profundidade especificada e recolhe todos os outros.

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

// All row groups of depth 2 and lower are expanded, and groups with depth
// 3 and higher are collapsed.
sheet.expandRowGroupsUpToDepth(2);

Parâmetros

NomeTipoDescrição
groupDepthIntegerA profundidade do grupo no qual expandir os grupos de linhas.

Retornar

Sheet: esta página, para encadeamento.

Autorização

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

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

getActiveCell()

Retorna a célula ativa desta página.

Observação:é preferível usar getCurrentCell(), que retorna a célula destacada atual.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Returns the active cell
var cell = sheet.getActiveCell();

Retornar

Range: a célula ativa atual.

Autorização

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

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

getActiveRange()

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

O termo "intervalo ativo" refere-se ao intervalo que um usuário selecionou na página ativa, mas em uma função personalizada ele se refere à célula sendo recalculada ativamente.

var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
var activeRange = sheet.getActiveRange();

Retornar

Range: o intervalo ativo.

Autorização

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

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

Veja também


getActiveRangeList()

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

Se houver apenas um intervalo selecionado, ele se comportará como uma chamada getActiveRange().

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

Retornar

RangeList: a lista de intervalos ativos.

Autorização

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

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

Veja também


getBandings()

Retorna todas as faixas nesta página.

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

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

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

// Gets info on the bandings' second row color and logs it to the console.
for (const banding of bandings) {
  console.log(banding.getSecondRowColor());
}

Retornar

Banding[]: todas as faixas nesta página.

Autorização

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

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

getCharts()

Retorna uma matriz de gráficos nesta página.

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

for (var i in charts) {
  var chart = charts[i];
  // Do something with the chart
}

Retornar

EmbeddedChart[]: uma matriz de gráficos.

Autorização

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

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

getColumnGroup(columnIndex, groupDepth)

Retorna o grupo de colunas na indexação e na profundidade do grupo fornecidos.

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

// Returns the group whose control index is at column 2 and has a depth of 1, or
// null if the group doesn’t exist.
var columnGroup = sheet.getColumnGroup(2, 1);

Parâmetros

NomeTipoDescrição
columnIndexIntegerO índice de colunas da alternância do controle de grupo ou um índice dentro do grupo.
groupDepthIntegerMostra a profundidade do grupo.

Retornar

Group: o grupo de colunas no índice e a profundidade do controle ou gera uma exceção se o grupo não existir.

Autorização

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

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

getColumnGroupControlPosition()

Retorna GroupControlTogglePosition para todos os grupos de colunas da página.

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

// GroupControlTogglePosition.AFTER if the column grouping control toggle is shown after the
// group.
var columnGroupControlPosition = sheet.getColumnGroupControlPosition();

Retornar

GroupControlTogglePosition: true se o botão de controle do agrupamento de colunas for mostrado depois do grupo nesta página e false se não estiver.

Autorização

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

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

getColumnGroupDepth(columnIndex)

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

A profundidade do grupo indica quantos grupos se sobrepõem à coluna. Pode variar entre zero e oito.

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

// 1 if there is a group over columns 1 through 3
var groupDepth = sheet.getColumnGroupDepth(1);

Parâmetros

NomeTipoDescrição
columnIndexIntegerO índice da coluna.

Retornar

Integer: a profundidade de grupo da coluna no índice especificado.

Autorização

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

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

getColumnWidth(columnPosition)

Recebe a largura em pixels da coluna especificada.

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

// Columns start at 1
Logger.log(sheet.getColumnWidth(1));

Parâmetros

NomeTipoDescrição
columnPositionIntegerA posição da coluna a ser examinada.

Retornar

Integer: largura da coluna em pixels.

Autorização

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

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

getConditionalFormatRules()

Veja todas as regras de formatação condicional nesta página.

// Logs the conditional format rules in a sheet.
var rules = SpreadsheetApp.getActiveSheet().getConditionalFormatRules();
for (var i = 0; i < rules.length; i++) {
  var rule = rules[i];
  Logger.log(rule);
}

Retornar

ConditionalFormatRule[]: uma matriz de todas as regras na página.

Autorização

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

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

getCurrentCell()

Retorna a célula atual da página ativa ou null se não houver nenhuma célula atual. A célula atual é aquela que tem o foco na IU do Planilhas Google e é destacada por uma borda escura. Nunca há mais de uma célula. Quando um usuário seleciona um ou mais intervalos de células, uma das células da seleção é a atual.

var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
// Returns the current highlighted cell in the one of the active ranges.
var currentCell = sheet.getCurrentCell();

Retornar

Range: a célula atual.

Autorização

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

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

getDataRange()

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

Isso equivale a criar um intervalo delimitado por A1 e (Sheet.getLastColumn(), Sheet.getLastRow()).

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

// This represents ALL the data
var range = sheet.getDataRange();
var values = range.getValues();

// This logs the spreadsheet in CSV format with a trailing comma
for (var i = 0; i < values.length; i++) {
  var row = "";
  for (var j = 0; j < values[i].length; j++) {
    if (values[i][j]) {
      row = row + values[i][j];
    }
    row = row + ",";
  }
  Logger.log(row);
}

Retornar

Range: um intervalo que consiste em todos os dados na planilha.

Autorização

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

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

getDataSourceFormulas()

Recebe todas as fórmulas da fonte de dados.

Retornar

DataSourceFormula[]: uma lista de fórmulas da fonte de dados.

Autorização

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

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

getDataSourcePivotTables()

Recebe todas as tabelas dinâmicas da fonte de dados.

Retornar

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

Autorização

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

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

getDataSourceTables()

Recebe todas as tabelas de fontes de dados.

Retornar

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

Autorização

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

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

getDeveloperMetadata()

Acesse todos os metadados do desenvolvedor associados a esta planilha.

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

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

// Adds developer metadata for testing.
sheet.addDeveloperMetadata('CITY', 'PARIS');

// Gets all the developer metadata for the sheet.
const developerMetaDataList = sheet.getDeveloperMetadata();

// Logs the developer metadata to the console.
for (const developerMetaData of developerMetaDataList) {
  console.log(developerMetaData.getKey());
}

Retornar

DeveloperMetadata[]: os metadados do desenvolvedor associados a esta página.

Autorização

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

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

getDrawings()

Retorna uma matriz de desenhos na página.

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

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

// Gets all the drawings from the sheet.
const allDrawings = sheet.getDrawings();

 // Logs the number of drawings present on the sheet.
console.log(allDrawings.length);

Retornar

Drawing[]: a lista de desenhos nesta página.

Autorização

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

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

getFilter()

Retorna o filtro nesta página ou null se não houver filtro.

// Gets the filter on the active sheet.
let ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();

Retornar

Filter: o filtro.

Autorização

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

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

getFormUrl()

Retorna o URL do formulário que envia as respostas a esta página ou null caso a página não tenha um formulário associado.

var sheet = SpreadsheetApp.getActiveSheet();
var url = sheet.getFormUrl();

Retornar

String: o URL do formulário que coloca as respostas nesta página ou null se a página não tiver um formulário associado.

Autorização

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

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

getFrozenColumns()

Retorna o número de colunas congeladas.

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

Logger.log("Number of frozen columns: %s", sheet.getFrozenColumns());

Retornar

Integer: o número de colunas congeladas

Autorização

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

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

getFrozenRows()

Retorna o número de linhas congeladas.

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

Logger.log("Number of frozen rows: %s", sheet.getFrozenRows());

Retornar

Integer: o número de linhas congeladas

Autorização

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

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

getImages()

Retorna todas as imagens na grade da página.

Retornar

OverGridImage[]: uma matriz de imagens sobre a grade.

Autorização

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

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

getIndex()

Acessa a posição da página na planilha mãe. Começa em 1.

var ss = SpreadsheetApp.getActiveSpreadsheet();
// Note that the JavaScript index is 0, but this logs 1
var sheet = ss.getSheets()[0];
// ... because spreadsheets are 1-indexed
Logger.log(sheet.getIndex());

Retornar

Integer: a posição da página na planilha mãe.

Autorização

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

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

getLastColumn()

Retorna a posição da última coluna que tem conteúdo.

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

// This logs the value in the very last cell of this sheet
var lastRow = sheet.getLastRow();
var lastColumn = sheet.getLastColumn();
var lastCell = sheet.getRange(lastRow, lastColumn);
Logger.log(lastCell.getValue());

Retornar

Integer: a última coluna da página que contém conteúdo

Autorização

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

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

getLastRow()

Retorna a posição da última linha que tenha conteúdo.

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

// This logs the value in the very last cell of this sheet
var lastRow = sheet.getLastRow();
var lastColumn = sheet.getLastColumn();
var lastCell = sheet.getRange(lastRow, lastColumn);
Logger.log(lastCell.getValue());

Retornar

Integer: a última linha da página com conteúdo

Autorização

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

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

getMaxColumns()

Retorna o número atual de colunas na página, independentemente do conteúdo.

// This example assumes there is a sheet named "first"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("first");
Logger.log(first.getMaxColumns());

Retornar

Integer: a largura máxima da página.

Autorização

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

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

getMaxRows()

Retorna o número atual de linhas na página, independentemente do conteúdo.

// This example assumes there is a sheet named "first"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("first");
Logger.log(first.getMaxRows());

Retornar

Integer: a altura máxima da página.

Autorização

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

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

getName()

Retorna o nome da página.

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

Retornar

String: o nome da página.

Autorização

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

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

getNamedRanges()

Recebe todos os intervalos nomeados nesta planilha.

// The code below logs the name of the first named range.
var namedRanges = SpreadsheetApp.getActiveSheet().getNamedRanges();
if (namedRanges.length > 1) {
  Logger.log(namedRanges[0].getName());
}

Retornar

NamedRange[]: uma matriz de todos os intervalos nomeados na página.

Autorização

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

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

getParent()

Retorna o Spreadsheet que contém a página.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// parent is identical to ss
var parent = sheet.getParent();

Retornar

Spreadsheet: a planilha mãe.

Autorização

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

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

getPivotTables()

Retorna todas as tabelas dinâmicas nesta página.

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

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

// Gets all the pivot table info for the sheet.
const pivotTables = sheet.getPivotTables();

// Logs the pivot tables to the console.
for (const pivotTable of pivotTables) {
  console.log(pivotTable.getSourceDataRange().getValues());
}

Retornar

PivotTable[]: as tabelas dinâmicas nesta página.

Autorização

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

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

getProtections(type)

Recebe uma matriz de objetos que representam todos os intervalos protegidos na página ou uma matriz de elemento único que representa a proteção na própria página.

// Remove all range protections in the spreadsheet that the user has permission to edit.
var sheet = SpreadsheetApp.getActiveSheet();
var protections = sheet.getProtections(SpreadsheetApp.ProtectionType.RANGE);
for (var i = 0; i < protections.length; i++) {
  var protection = protections[i];
  if (protection.canEdit()) {
    protection.remove();
  }
}
// Remove sheet protection from the active sheet, if the user has permission to edit it.
var sheet = SpreadsheetApp.getActiveSheet();
var protection = sheet.getProtections(SpreadsheetApp.ProtectionType.SHEET)[0];
if (protection && protection.canEdit()) {
  protection.remove();
}

Parâmetros

NomeTipoDescrição
typeProtectionTypeO tipo de área protegida, SpreadsheetApp.ProtectionType.RANGE ou SpreadsheetApp.ProtectionType.SHEET.

Retornar

Protection[]: uma matriz de objetos que representam todos os intervalos protegidos na página ou uma matriz de um único elemento que representa a proteção na própria página.

Autorização

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

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

getRange(row, column)

Retorna o intervalo com a célula superior esquerda nas coordenadas fornecidas.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Passing only two arguments returns a "range" with a single cell.
var range = sheet.getRange(1, 1);
var values = range.getValues();
Logger.log(values[0][0]);

Parâmetros

NomeTipoDescrição
rowIntegerO índice de linhas da célula a ser retornada. A indexação de linhas começa com 1.
columnIntegerO índice de colunas da célula a ser retornada. A indexação de colunas começa com 1.

Retornar

Range: um intervalo que contém apenas esta célula.

Autorização

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

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

getRange(row, column, numRows)

Retorna o intervalo com a célula superior esquerda nas coordenadas especificadas e com o número de linhas especificado.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// When the "numRows" argument is used, only a single column of data is returned.
var range = sheet.getRange(1, 1, 3);
var values = range.getValues();

// Prints 3 values from the first column, starting from row 1.
for (var row in values) {
  for (var col in values[row]) {
    Logger.log(values[row][col]);
  }
}

Parâmetros

NomeTipoDescrição
rowIntegerO índice de linha inicial do intervalo. A indexação de linhas começa com 1.
columnIntegerO índice de colunas do intervalo. A indexação de colunas começa com 1.
numRowsIntegerO número de linhas a serem retornadas.

Retornar

Range: um intervalo que contém uma única coluna de dados com o número de linhas especificado.

Autorização

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

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

getRange(row, column, numRows, numColumns)

Retorna o intervalo com a célula superior esquerda nas coordenadas especificadas com o número de linhas e colunas especificado.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange(1, 1, 3, 3);
var values = range.getValues();

// Print values from a 3x3 box.
for (var row in values) {
  for (var col in values[row]) {
    Logger.log(values[row][col]);
  }
}

Parâmetros

NomeTipoDescrição
rowIntegerO índice de linha inicial do intervalo. A indexação de linhas começa com 1.
columnIntegerO índice da coluna inicial do intervalo. A indexação da coluna começa com 1.
numRowsIntegerO número de linhas a serem retornadas.
numColumnsIntegerO número de colunas a serem retornadas.

Retornar

Range: um intervalo correspondente à área especificada.

Autorização

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

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

getRange(a1Notation)

Retorna o intervalo conforme especificado na notação A1 ou R1C1.

// Get a range A1:D4 on sheet titled "Invoices"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var range = ss.getRange("Invoices!A1:D4");

// Get cell A1 on the first sheet
var sheet = ss.getSheets()[0];
var cell = sheet.getRange("A1");

Parâmetros

NomeTipoDescrição
a1NotationStringO intervalo a ser retornado, conforme especificado na notação A1 ou R1C1.

Retornar

Range: o intervalo no local designado.

Autorização

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

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

getRangeList(a1Notations)

Retorna a coleção RangeList que representa os intervalos na mesma página especificada por uma lista não vazia de anotações A1 ou R1C1.

// Get a list of ranges A1:D4, F1:H4.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
var rangeList  = sheet.getRangeList(['A1:D4', 'F1:H4']);

Parâmetros

NomeTipoDescrição
a1NotationsString[]A lista de intervalos a serem retornados, conforme especificado na notação A1 ou R1C1.

Retornar

RangeList: a lista de intervalos no local designado

Autorização

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

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

getRowGroup(rowIndex, groupDepth)

Retorna o grupo de linhas no índice e profundidade de grupo fornecidos.

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

// Returns the group whose control index is at row 2 and has a depth of 1, or
// null if the group doesn’t exist.
var rowGroup = sheet.getRowGroup(2, 1);

Parâmetros

NomeTipoDescrição
rowIndexIntegerO índice da linha do botão de controle do grupo ou um índice dentro do grupo.
groupDepthIntegerMostra a profundidade do grupo.

Retornar

Group: o grupo de linhas no índice de controle e profundidade, ou gera uma exceção se o grupo não existir.

Autorização

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

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

getRowGroupControlPosition()

Retorna o GroupControlTogglePosition para todos os grupos de linhas na página.

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

// GroupControlTogglePosition.AFTER if the row grouping control toggle is shown after the
// group.
var rowGroupControlPosition = sheet.getRowGroupControlPosition();

Retornar

GroupControlTogglePosition: true se o controle de agrupamento de linhas for exibido depois do grupo nesta página e false se não estiver.

Autorização

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

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

getRowGroupDepth(rowIndex)

Retorna a profundidade do grupo da linha em um índice específico.

A profundidade do grupo indica quantos grupos se sobrepõem à linha. Pode variar entre zero e oito.

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

// 1 if there is a group over rows 1 through 3
var groupDepth = sheet.getRowGroupDepth(1);

Parâmetros

NomeTipoDescrição
rowIndexIntegerO índice da linha.

Retornar

Integer: a profundidade de grupo da linha em um índice especificado.

Autorização

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

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

getRowHeight(rowPosition)

Recebe a altura em pixels da linha especificada.

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

// Rows start at 1
Logger.log(sheet.getRowHeight(1));

Parâmetros

NomeTipoDescrição
rowPositionIntegerA posição da linha a ser examinada.

Retornar

Integer: altura da linha em pixels

Autorização

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

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

getSelection()

Retorna o Selection atual na planilha.

var selection = SpreadsheetApp.getActiveSpreadsheet().getSelection();
var currentCell = selection.getCurrentCell();

Retornar

Selection: a seleção atual

Autorização

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

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

getSheetId()

Retorna o ID da página representada por esse objeto.

Esse é um ID da planilha exclusivo da planilha. O ID é um número inteiro que aumenta monotonicamente atribuído no momento da criação da página e é independente da posição da página. Isso é útil em conjunto com métodos como Range.copyFormatToRange(gridId, column, columnEnd, row, rowEnd), que usam um parâmetro gridId em vez de uma instância Sheet.

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

Logger.log(sheet.getSheetId());

Retornar

Integer: um ID para a página exclusivo da planilha.

Autorização

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

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

getSheetName()

Retorna o nome da página.

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

Logger.log(sheet.getSheetName());

Retornar

String: o nome da página

Autorização

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

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

getSheetValues(startRow, startColumn, numRows, numColumns)

Retorna a grade retangular de valores desse intervalo, começando com as coordenadas fornecidas. Um valor -1 fornecido como a posição da linha ou coluna equivale ao acesso à última linha ou coluna que tem dados na página.

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

// The two samples below produce the same output
var values = sheet.getSheetValues(1, 1, 3, 3);
Logger.log(values);

var range = sheet.getRange(1, 1, 3, 3);
values = range.getValues();
Logger.log(values);

Parâmetros

NomeTipoDescrição
startRowIntegerPosição da linha inicial.
startColumnIntegerA posição da coluna inicial.
numRowsIntegerO número de linhas para as quais os valores serão retornados.
numColumnsIntegerO número de colunas para as quais os valores serão retornados.

Retornar

Object[][]: uma matriz de valores bidimensional

Autorização

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

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

getSlicers()

Retorna uma matriz de controles de filtros na página.

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

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

// Gets all slicers in the spreadsheet.
const slicers = sheet.getSlicers();

// Logs the slicer titles to the console.
for (const slicer of slicers) {
  console.log(slicer.getTitle());
}

Retornar

Slicer[]: a lista de controles de filtros nesta página.

Autorização

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

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

getTabColorObject()

Recebe a cor da guia da página ou null se a guia da página não tiver cor.

// This example assumes there is a sheet named "Sheet1"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("Sheet1");
var color = first.getTabColorObject();

Retornar

Color: a cor da guia da página, ou null se a guia da página não tiver cor.

Autorização

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

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

getType()

Retorna o tipo da página.

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

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

Retornar

SheetType: o tipo de página.

Autorização

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

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

hasHiddenGridlines()

Retornará true se as linhas de grade da página estiverem ocultas. Caso contrário, retornará false. As linhas de grade ficam visíveis por padrão.

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

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

// Checks if the spreadsheet has hidden gridelines and logs the result to the console.
console.log(sheet.hasHiddenGridlines());

Retornar

Boolean: true se as linhas de grade estiverem ocultas. Caso contrário, será false.

Autorização

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

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

hideColumn(column)

Oculta a coluna ou as colunas no intervalo especificado.

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

// This hides the first column
let range = sheet.getRange("A1");
sheet.hideColumn(range);

// This hides the first 3 columns
let range = sheet.getRange("A:C");
sheet.hideColumn(range);

Parâmetros

NomeTipoDescrição
columnRangeO intervalo de colunas a ser ocultado.

Autorização

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

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

hideColumns(columnIndex)

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

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

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

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

Parâmetros

NomeTipoDescrição
columnIndexIntegerO índice da coluna a ser ocultada.

Autorização

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

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

hideColumns(columnIndex, numColumns)

Oculta uma ou mais colunas consecutivas que começam no índice especificado. Use 1 índice para esse método.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Hides the first three columns
sheet.hideColumns(1, 3);

Parâmetros

NomeTipoDescrição
columnIndexIntegerO índice inicial das colunas a serem ocultas.
numColumnsIntegerO número de colunas a serem ocultas.

Autorização

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

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

hideRow(row)

Oculta as linhas no intervalo especificado.

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

// This hides the first row
var range = sheet.getRange("A1");
sheet.hideRow(range);

Parâmetros

NomeTipoDescrição
rowRangeO intervalo de linhas a ser ocultado.

Autorização

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

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

hideRows(rowIndex)

Oculta a linha no índice especificado.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Hides the first row
sheet.hideRows(1);

Parâmetros

NomeTipoDescrição
rowIndexIntegerO índice da linha a ser ocultada.

Autorização

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

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

hideRows(rowIndex, numRows)

Oculta uma ou mais linhas consecutivas que começam no índice especificado.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Hides the first three rows
sheet.hideRows(1, 3);

Parâmetros

NomeTipoDescrição
rowIndexIntegerO índice inicial das linhas a serem ocultas.
numRowsIntegerO número de linhas a serem ocultas.

Autorização

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

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

hideSheet()

Oculta esta página. Não terá efeito se a página já estiver oculta. Se esse método for chamado na única página visível, uma exceção será gerada.

var sheet = SpreadsheetApp.getActiveSheet();
sheet.hideSheet();

Retornar

Sheet: a página atual.

Autorização

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

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

insertChart(chart)

Adiciona um novo gráfico à página.

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

// This creates a simple bar chart from the first three rows
// of the first two columns of the spreadsheet
var chart = sheet.newChart()
    .setChartType(Charts.ChartType.BAR)
    .addRange(sheet.getRange("A1:B4"))
    .setPosition(5, 5, 0, 0)
    .setOption("title", "Dynamic Chart")
    .build();
sheet.insertChart(chart);

Parâmetros

NomeTipoDescrição
chartEmbeddedChartO gráfico a ser inserido.

Autorização

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

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

insertColumnAfter(afterPosition)

Insere uma coluna após a posição da coluna especificada.

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

// This inserts a column after the first column position
sheet.insertColumnAfter(1);

Parâmetros

NomeTipoDescrição
afterPositionIntegerColuna que será adicionada à nova coluna.

Retornar

Sheet: a página, útil para encadeamento de métodos

Autorização

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

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

insertColumnBefore(beforePosition)

Insere uma coluna antes da posição especificada na coluna.

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

// This inserts a column in the first column position
sheet.insertColumnBefore(1);

Parâmetros

NomeTipoDescrição
beforePositionIntegerA coluna antes da qual a nova coluna deve ser adicionada.

Retornar

Sheet: a página, útil para encadeamento de métodos

Autorização

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

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

insertColumns(columnIndex)

Insere uma coluna em branco em uma página no local especificado.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Shifts all columns by one
sheet.insertColumns(1);

Parâmetros

NomeTipoDescrição
columnIndexIntegerO índice que indica onde inserir uma coluna.

Autorização

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

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

insertColumns(columnIndex, numColumns)

Insere uma ou mais colunas em branco consecutivas em uma página a partir do local especificado.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Shifts all columns by three
sheet.insertColumns(1, 3);

Parâmetros

NomeTipoDescrição
columnIndexIntegerO índice que indica onde inserir uma coluna.
numColumnsIntegerO número de colunas a serem inseridas.

Autorização

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

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

insertColumnsAfter(afterPosition, howMany)

Insere várias colunas após a posição da coluna especificada.

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

// This inserts a column in the second column position
sheet.insertColumnsAfter(1);

Parâmetros

NomeTipoDescrição
afterPositionIntegerColuna que será adicionada à nova coluna.
howManyIntegerO número de colunas a serem inseridas.

Retornar

Sheet: a página, útil para encadeamento de métodos

Autorização

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

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

insertColumnsBefore(beforePosition, howMany)

Insere um número de colunas antes da posição da coluna especificada.

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

// This inserts five columns before the first column
sheet.insertColumnsBefore(1, 5);

Parâmetros

NomeTipoDescrição
beforePositionIntegerA coluna antes da qual a nova coluna deve ser adicionada.
howManyIntegerO número de colunas a serem inseridas.

Retornar

Sheet: a página, útil para encadeamento de métodos

Autorização

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

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

insertImage(blobSource, column, row)

Insere uma BlobSource como imagem no documento em uma determinada linha e coluna. O tamanho da imagem é recuperado do conteúdo do blob. O tamanho máximo permitido do blob é 2 MB.

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

var blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1);

Parâmetros

NomeTipoDescrição
blobSourceBlobSourceO blob que contém o conteúdo da imagem, o tipo MIME e, como opção, o nome.
columnIntegerA posição da coluna.
rowIntegerPosição da linha.

Retornar

OverGridImage: a imagem inserida.

Autorização

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

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

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

Insere um BlobSource como uma imagem no documento em uma determinada linha e coluna, com um deslocamento de pixel. O tamanho da imagem é recuperado do conteúdo do blob. O tamanho máximo permitido do blob é 2 MB.

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

var blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1, 10, 10);

Parâmetros

NomeTipoDescrição
blobSourceBlobSourceO blob que contém o conteúdo da imagem, o tipo MIME e, como opção, o nome.
columnIntegerA posição da coluna.
rowIntegerPosição da linha.
offsetXIntegerO deslocamento horizontal do canto da célula em pixels.
offsetYIntegerO deslocamento vertical do canto da célula em pixels.

Retornar

OverGridImage: a imagem inserida.

Autorização

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

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

insertImage(url, column, row)

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

O URL fornecido precisa ser acessível publicamente.

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

sheet.insertImage("https://www.google.com/images/srpr/logo3w.png", 1, 1);

Parâmetros

NomeTipoDescrição
urlStringÉ o URL da imagem.
columnIntegerA posição da coluna da grade.
rowIntegerA posição da linha da grade.

Retornar

OverGridImage: a imagem inserida.

Autorização

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

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

insertImage(url, column, row, offsetX, offsetY)

Insere uma imagem no documento em uma determinada linha e coluna, com um deslocamento de pixels.

O URL fornecido precisa ser acessível publicamente.

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

sheet.insertImage("https://www.google.com/images/srpr/logo3w.png", 1, 1, 10, 10);

Parâmetros

NomeTipoDescrição
urlStringO URL da imagem.
columnIntegerA posição da coluna.
rowIntegerPosição da linha.
offsetXIntegerO deslocamento horizontal do canto da célula em pixels.
offsetYIntegerO deslocamento vertical do canto da célula em pixels.

Retornar

OverGridImage: a imagem inserida.

Autorização

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

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

insertRowAfter(afterPosition)

Insere uma linha após a posição da linha especificada.

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

// This inserts a row after the first row position
sheet.insertRowAfter(1);

Parâmetros

NomeTipoDescrição
afterPositionIntegerA linha após a qual a nova linha deve ser adicionada.

Retornar

Sheet: a página, útil para encadeamento de métodos

Autorização

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

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

insertRowBefore(beforePosition)

Insere uma linha antes da posição de linha especificada.

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

// This inserts a row before the first row position
sheet.insertRowBefore(1);

Parâmetros

NomeTipoDescrição
beforePositionIntegerA linha antes da qual a nova linha deve ser adicionada.

Retornar

Sheet: a página, útil para encadeamento de métodos

Autorização

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

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

insertRows(rowIndex)

Insere uma linha em branco em uma página no local especificado.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Shifts all rows down by one
sheet.insertRows(1);

Parâmetros

NomeTipoDescrição
rowIndexIntegerO índice que indica onde inserir uma linha.

Autorização

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

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

insertRows(rowIndex, numRows)

Insere uma ou mais linhas em branco consecutivas em uma página a partir do local especificado.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Shifts all rows down by three
sheet.insertRows(1, 3);

Parâmetros

NomeTipoDescrição
rowIndexIntegerO índice que indica onde inserir uma linha.
numRowsIntegerO número de linhas a serem inseridas.

Autorização

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

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

insertRowsAfter(afterPosition, howMany)

Insere várias linhas após a posição da linha especificada.

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

// This inserts five rows after the first row
sheet.insertRowsAfter(1, 5);

Parâmetros

NomeTipoDescrição
afterPositionIntegerA linha após a qual as novas linhas devem ser adicionadas.
howManyIntegerO número de linhas a serem inseridas.

Retornar

Sheet: a página, útil para encadeamento de métodos

Autorização

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

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

insertRowsBefore(beforePosition, howMany)

Insere várias linhas antes da posição de linha especificada.

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

// This inserts five rows before the first row
sheet.insertRowsBefore(1, 5);

Parâmetros

NomeTipoDescrição
beforePositionIntegerA linha antes da qual as novas linhas devem ser adicionadas.
howManyIntegerO número de linhas a serem inseridas.

Retornar

Sheet: a página, útil para encadeamento de métodos

Autorização

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

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

insertSlicer(range, anchorRowPos, anchorColPos)

Adiciona um novo controle de filtros a esta página.

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

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

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

// Inserts the slicer with a random range into the sheet.
const insertSlicers = sheet.insertSlicer(range.randomize(), 1, 10);

// Logs the insert slicer result to the console.
console.log(insertSlicers);

Parâmetros

NomeTipoDescrição
rangeRangeO intervalo em que o controle de filtros é criado.
anchorRowPosIntegerA lateral superior do controle deslizante está ancorada nessa linha.
anchorColPosIntegerA lateral superior do controle de cor é fixada nesta coluna.

Retornar

Slicer: o controle de filtros recém-inserido.

Autorização

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

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

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

Adiciona um novo controle de filtros a esta página.

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

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

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

// Inserts a slicer using the random range function.
const insertSlicers = sheet.insertSlicer(range.randomize(), 1, 10, 0, 0);

// Logs the insert slicer result to the console.
console.log(insertSlicers);

Parâmetros

NomeTipoDescrição
rangeRangeO intervalo em que o controle de filtros é criado.
anchorRowPosIntegerA lateral superior do controle deslizante está ancorada nessa linha.
anchorColPosIntegerA lateral superior do controle de cor é fixada nesta coluna.
offsetXIntegerO deslocamento horizontal do canto da célula em pixels.
offsetYIntegerO deslocamento vertical do canto da célula em pixels.

Retornar

Slicer: o controle de filtros recém-inserido.

Autorização

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

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

isColumnHiddenByUser(columnPosition)

Retorna se a coluna especificada é oculta pelo usuário.

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

// Columns start at 1
Logger.log(sheet.isColumnHiddenByUser(1));

Parâmetros

NomeTipoDescrição
columnPositionIntegerA posição da coluna a ser examinada.

Retornar

Boolean: true se a coluna estiver oculta. Caso contrário, será false.

Autorização

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

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

isRightToLeft()

Retorna true se o layout da página for da direita para a esquerda. Retornará false se a página usar o layout padrão da esquerda para a direita.

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

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

// Checks if a spreadsheet is ordered from right to left and logs the result to the console.
console.log(sheet.isRightToLeft());

Retornar

Boolean: true se for da direita para a esquerda. Caso contrário, false.

Autorização

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

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

isRowHiddenByFilter(rowPosition)

Retorna se a linha especificada está oculta por um filtro (não uma visualização com filtro).

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

// Rows start at 1
Logger.log(sheet.isRowHiddenByFilter(1));

Parâmetros

NomeTipoDescrição
rowPositionIntegerA posição da linha a ser examinada.

Retornar

Boolean: true se a linha estiver oculta. Caso contrário, será false.

Autorização

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

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

isRowHiddenByUser(rowPosition)

Retorna se a linha especificada é oculta pelo usuário.

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

// Rows start at 1
Logger.log(sheet.isRowHiddenByUser(1));

Parâmetros

NomeTipoDescrição
rowPositionIntegerA posição da linha a ser examinada.

Retornar

Boolean: true se a linha estiver oculta. Caso contrário, será false.

Autorização

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

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

isSheetHidden()

Retornará true se a página estiver oculta.

var sheet = SpreadsheetApp.getActiveSheet();
if (sheet.isSheetHidden()) {
  // do something...
}

Retornar

Boolean: true se a página estiver oculta. Caso contrário, será false.

Autorização

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

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

moveColumns(columnSpec, destinationIndex)

Move as colunas selecionadas pelo intervalo especificado para a posição indicada pelo destinationIndex. O columnSpec não precisa representar exatamente uma coluna inteira ou um grupo de colunas para mover. Ele seleciona todas as colunas que o intervalo abrange.

// The code below moves rows A-B to destination index 5.
// This results in those columns becoming columns C-D.
var sheet = SpreadsheetApp.getActiveSheet();
// Selects column A and column B to be moved.
var columnSpec = sheet.getRange("A1:B1");
sheet.moveColumns(columnSpec, 5);

Parâmetros

NomeTipoDescrição
columnSpecRangeUm intervalo que abrange as colunas que precisam ser movidas.
destinationIndexIntegerO índice para o qual as colunas devem ser movidas. Esse índice é baseado nas coordenadas antes da migração das colunas. Os dados existentes são deslocados para a direita a fim de liberar espaço para as colunas movidas, enquanto as colunas de origem são removidas da grade. Portanto, os dados podem acabar em um índice diferente do especificado originalmente.

Autorização

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

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

moveRows(rowSpec, destinationIndex)

Move as linhas selecionadas pelo intervalo especificado para a posição indicada pelo destinationIndex. O rowSpec não precisa representar exatamente uma linha ou um grupo inteiro de linhas a serem movidas, ele seleciona todas as linhas que o intervalo abrange.

// The code below moves rows 1-2 to destination index 5.
// This results in those rows becoming rows 3-4.
var sheet = SpreadsheetApp.getActiveSheet();
// Selects row 1 and row 2 to be moved.
var rowSpec = sheet.getRange("A1:A2");
sheet.moveRows(rowSpec, 5);

Parâmetros

NomeTipoDescrição
rowSpecRangeUm intervalo que abrange as linhas que serão movidas.
destinationIndexIntegerO índice para o qual as linhas devem ser movidas. Esse índice é baseado nas coordenadas antes da migração das linhas. Os dados atuais são deslocados para baixo para abrir espaço para as linhas movidas, enquanto as linhas de origem são removidas da grade. Portanto, os dados podem acabar em um índice diferente do especificado originalmente.

Autorização

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

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

newChart()

Retorna um builder para criar um novo gráfico na página.

Este exemplo mostra como criar um novo gráfico:

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B8");
var chartBuilder = sheet.newChart();
chartBuilder.addRange(range)
    .setChartType(Charts.ChartType.LINE)
    .setPosition(2, 2, 0, 0)
    .setOption('title', 'My Line Chart!');
sheet.insertChart(chartBuilder.build());

Retornar

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


protect()

Cria um objeto que pode proteger a página de ser editada por usuários que tenham permissão. Até que o script realmente mude a lista de editores para a página (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 planilha, o que significa que a página permanece desprotegida. Se a página já estiver protegida, esse método retornará um objeto que representa as configurações de proteção existentes. Uma página protegida pode incluir regiões desprotegidas.

// Protect the active sheet, then remove all other users from the list of editors.
var sheet = SpreadsheetApp.getActiveSheet();
var protection = sheet.protect().setDescription('Sample protected sheet');

// Ensure the current user is an editor before removing others. Otherwise, if the user's edit
// permission comes from a group, the script throws an exception upon removing the group.
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 exigem autorização com um ou mais dos seguintes escopos:

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

removeChart(chart)

Remove um gráfico da página mãe.

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

// This removes all the embedded charts from the spreadsheet
var charts = sheet.getCharts();
for (var i in charts) {
  sheet.removeChart(charts[i]);
}

Parâmetros

NomeTipoDescrição
chartEmbeddedChartO gráfico a ser removido.

Autorização

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

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

setActiveRange(range)

Define o intervalo especificado como active range na página ativa, com a célula superior esquerda no intervalo como current cell.

var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
var range = sheet.getRange('A1:D4');
sheet.setActiveRange(range);

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

Parâmetros

NomeTipoDescrição
rangeRangeO intervalo a ser definido como ativo.

Retornar

Range: o intervalo recém-ativo.

Autorização

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

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

setActiveRangeList(rangeList)

Define a lista especificada de intervalos como o active ranges na página ativa. O último intervalo na lista é definido como active range.

var sheet = SpreadsheetApp.getActiveSheet();
var rangeList = sheet.getRangeList(['D4', 'B2:C4']);
sheet.setActiveRangeList(rangeList);

var selection = sheet.getSelection();
// Current cell: B2
var currentCell = selection.getCurrentCell();
// Active range: B2:C4
var activeRange = selection.getActiveRange();
// Active range list: [D4, B2:C4]
var activeRangeList = selection.getActiveRangeList();

Parâmetros

NomeTipoDescrição
rangeListRangeListLista de intervalos a serem selecionados.

Retornar

RangeList: a lista de intervalos recém-selecionada

Autorização

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

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

setActiveSelection(range)

Define a região de seleção ativa para esta página.

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

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

Parâmetros

NomeTipoDescrição
rangeRangeO intervalo a ser definido como a seleção ativa.

Retornar

Range: o intervalo recém-ativo.

Autorização

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

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

setActiveSelection(a1Notation)

Define a seleção ativa, conforme especificado na notação A1 ou R1C1.

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

sheet.setActiveSelection("A1:D4");

Parâmetros

NomeTipoDescrição
a1NotationStringO intervalo a ser definido como ativo, conforme especificado na notação A1 ou R1C1.

Retornar

Range: o intervalo recém-ativo.

Autorização

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

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

setColumnGroupControlPosition(position)

Define a posição do botão de controle do grupo de colunas na página.

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

Parâmetros

NomeTipoDescrição
positionGroupControlTogglePositionA posição da opção de controle do grupo de colunas.

Retornar

Sheet: esta página, para encadeamento.

Autorização

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

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

setColumnWidth(columnPosition, width)

Define a largura da coluna especificada em pixels.

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

// Sets the first column to a width of 200 pixels
sheet.setColumnWidth(1, 200);

Parâmetros

NomeTipoDescrição
columnPositionIntegerA posição da coluna especificada a ser definida.
widthIntegerA largura em pixels para o definir.

Retornar

Sheet: a página, útil para encadeamento de métodos

Autorização

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

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

setColumnWidths(startColumn, numColumns, width)

Define a largura das colunas fornecidas em pixels.

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

// Sets the first three columns to a width of 200 pixels
sheet.setColumnWidths(1, 3, 200);

Parâmetros

NomeTipoDescrição
startColumnIntegerA posição inicial da coluna a ser alterada.
numColumnsIntegerO número de colunas a serem alteradas.
widthIntegerA largura em pixels para o definir.

Retornar

Sheet: esta página, para encadeamento.

Autorização

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

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

setConditionalFormatRules(rules)

Substitui todas as regras de formatação condicional existentes na planilha pelas regras de entrada. As regras são avaliadas na ordem de entrada.

// Remove one of the existing conditional format rules.
var sheet = SpreadsheetApp.getActiveSheet();
var rules = sheet.getConditionalFormatRules();
rules.splice(1, 1); // Deletes the 2nd format rule.
sheet.setConditionalFormatRules(rules);

Parâmetros

NomeTipoDescrição
rulesConditionalFormatRule[]As novas regras de formato condicional.

Autorização

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

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

setCurrentCell(cell)

Define a célula especificada como current cell.

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

Se a célula especificada não estiver presente em nenhum intervalo selecionado, qualquer 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 gerará uma exceção.

var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
var cell = sheet.getRange('B5');
sheet.setCurrentCell(cell);

var selection = sheet.getSelection();
// Current cell: B5
var currentCell = selection.getCurrentCell();

Parâmetros

NomeTipoDescrição
cellRangeA célula a ser definida como célula atual.

Retornar

Range: a célula atual recém-definida.

Autorização

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

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

setFrozenColumns(columns)

Congela o número fornecido de colunas. Se zero, nenhuma coluna é congelada.

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

// Freezes the first column
sheet.setFrozenColumns(1);

Parâmetros

NomeTipoDescrição
columnsIntegerO número de colunas a serem congeladas.

Autorização

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

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

setFrozenRows(rows)

Congela o número fornecido de linhas. Se for zero, nenhuma linha será congelada.

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

// Freezes the first row
sheet.setFrozenRows(1);

Parâmetros

NomeTipoDescrição
rowsIntegerO número de linhas a serem congeladas.

Autorização

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

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

setHiddenGridlines(hideGridlines)

Oculta ou revela as linhas da grade da página.

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

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

// Hides the gridlines in the sheet.
sheet.setHiddenGridlines(true);

Parâmetros

NomeTipoDescrição
hideGridlinesBooleanSe for true, oculte as linhas de grade nesta página. Caso contrário, mostre as linhas de grade.

Retornar

Sheet: esta página, para encadeamento.

Autorização

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

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

setName(name)

Define o nome da página.

// This example assumes there is a sheet named "first"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("first");
first.setName("not first anymore");

Parâmetros

NomeTipoDescrição
nameStringO novo nome da página.

Retornar

Sheet: esta página, para encadeamento.

Autorização

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

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

setRightToLeft(rightToLeft)

Define ou desativa o layout da página da direita para a esquerda.

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

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

// Sets the sheet layout, so that the sheet is ordered from right to left.
sheet.setRightToLeft(true);

Parâmetros

NomeTipoDescrição
rightToLeftBooleanSe definido como true, o layout da página será definido da direita para a esquerda, com a célula A1 no canto superior direito. Se definido como false, o layout da página será definido como o padrão da esquerda para a direita, com a célula A1 no canto superior esquerdo.

Retornar

Sheet: esta página, para encadeamento.

Autorização

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

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

setRowGroupControlPosition(position)

Define a posição do botão de controle do grupo de linhas na página.

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

Parâmetros

NomeTipoDescrição
positionGroupControlTogglePositionA posição da opção de controle do grupo de linhas.

Retornar

Sheet: esta página, para encadeamento.

Autorização

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

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

setRowHeight(rowPosition, height)

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

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

// Sets the first row to a height of 200 pixels
sheet.setRowHeight(1, 200);

Parâmetros

NomeTipoDescrição
rowPositionIntegerA posição da linha a ser alterada.
heightIntegerA altura em pixels para o qual será definida.

Retornar

Sheet: a página, útil para encadeamento de métodos.

Autorização

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

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

setRowHeights(startRow, numRows, height)

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

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

// Sets the first three rows to a height of 20 pixels
sheet.setRowHeights(1, 3, 20);

Parâmetros

NomeTipoDescrição
startRowIntegerA posição inicial da linha a ser alterada.
numRowsIntegerO número de linhas a serem alteradas.
heightIntegerA altura em pixels para o qual será definida.

Retornar

Sheet: esta página, para encadeamento.

Autorização

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

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

setRowHeightsForced(startRow, numRows, height)

Define a altura das linhas fornecidas em pixels. Por padrão, as linhas crescem para caber no conteúdo da célula. Quando você usa setRowHeightsForced, as linhas são forçadas até a altura especificada, mesmo que o conteúdo da célula seja mais alto que a altura da linha.

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

// Sets the first three rows to a height of 5 pixels.
sheet.setRowHeightsForced(1, 3, 5);

Parâmetros

NomeTipoDescrição
startRowIntegerA posição inicial da linha a ser alterada.
numRowsIntegerO número de linhas a serem alteradas.
heightIntegerA altura em pixels para o qual será definida.

Retornar

Sheet: esta página, para encadeamento.

Autorização

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

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

setTabColor(color)

Define a cor da guia da página.

// This example assumes there is a sheet named "first"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("first");
first.setTabColor("ff0000"); // Set the color to red.
first.setTabColor(null); // Unset the color.

Parâmetros

NomeTipoDescrição
colorStringUm código de cor na notação CSS (como '#ffffff' ou 'white') ou null para redefinir a cor da guia.

Retornar

Sheet: esta página, para encadeamento.

Autorização

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

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

setTabColorObject(color)

Define a cor da guia da página.

// This example assumes there is a sheet named "Sheet1"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("Sheet1");
var color = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT1)
    .build();
first.setTabColorObject(color); // Set the color to theme accent 1.
first.setTabColorObject(null); // Unset the color.

Parâmetros

NomeTipoDescrição
colorColorA cor da guia da página a ser definida.

Retornar

Sheet: esta página, para encadeamento.

Autorização

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

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

showColumns(columnIndex)

Reexibe a coluna no índice especificado.

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

Parâmetros

NomeTipoDescrição
columnIndexIntegerO índice da coluna que será exibido.

Autorização

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

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

showColumns(columnIndex, numColumns)

Reexibe uma ou mais colunas consecutivas a partir do índice especificado.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Unhides the first three columns
sheet.showColumns(1, 3);

Parâmetros

NomeTipoDescrição
columnIndexIntegerO índice inicial das colunas a serem exibidas.
numColumnsIntegerO número de colunas a serem exibidas.

Autorização

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

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

showRows(rowIndex)

Reexibe a linha em um índice específico.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Unhides the first row
sheet.showRows(1);

Parâmetros

NomeTipoDescrição
rowIndexIntegerO índice da linha a ser reexibido.

Autorização

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

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

showRows(rowIndex, numRows)

Reexibe uma ou mais linhas consecutivas a partir do índice especificado.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Unhides the first three rows
sheet.showRows(1, 3);

Parâmetros

NomeTipoDescrição
rowIndexIntegerO índice inicial das linhas a serem exibidas.
numRowsIntegerO número de linhas a serem exibidas.

Autorização

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

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

showSheet()

Torna a página visível. Não terá efeito se a página já estiver visível.

var sheet = SpreadsheetApp.getActiveSheet();
sheet.showSheet();

Retornar

Sheet: a página atual.

Autorização

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

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

sort(columnPosition)

Classifica uma página por coluna, em ordem crescente.

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

// Sorts the sheet by the first column, ascending
sheet.sort(1);

Parâmetros

NomeTipoDescrição
columnPositionIntegerA coluna pela qual classificar.

Retornar

Sheet: a página, útil para encadeamento de métodos

Autorização

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

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

sort(columnPosition, ascending)

Classifica uma página por coluna. Usa um parâmetro para especificar crescente ou decrescente.

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

// Sorts the sheet by the first column, descending
sheet.sort(1, false);

Parâmetros

NomeTipoDescrição
columnPositionIntegerA coluna pela qual classificar.
ascendingBooleantrue para classificações crescentes, false para decrescente.

Retornar

Sheet: a página, útil para encadeamento de métodos

Autorização

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

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

unhideColumn(column)

Reexibe a coluna no intervalo especificado.

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

// This unhides the first column if it was previously hidden
var range = sheet.getRange("A1");
sheet.unhideColumn(range);

Parâmetros

NomeTipoDescrição
columnRangeO intervalo a ser exibido, se oculto.

Autorização

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

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

unhideRow(row)

Reexibe a linha no intervalo especificado.

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

// This unhides the first row if it was previously hidden
var range = sheet.getRange("A1");
sheet.unhideRow(range);

Parâmetros

NomeTipoDescrição
rowRangeO intervalo a ser exibido, se oculto.

Autorização

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

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

updateChart(chart)

Atualiza o gráfico nesta página.

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

// This code is going to loop through all the charts and change them to
// column charts
var charts = sheet.getCharts();
for (var i in charts) {
  var chart = charts[i];
  var newChart = chart
      .modify()
      .setChartType(Charts.ChartType.COLUMN)
      .build();
  sheet.updateChart(newChart);
}

Parâmetros

NomeTipoDescrição
chartEmbeddedChartO gráfico a ser atualizado.

Autorização

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

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

Métodos obsoletos