Class Spreadsheet

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

Acesse e modifique arquivos do Planilhas Google. As operações mais comuns são a adição de novas planilhas e a colaboração.

Métodos

MétodoTipo de retornoBreve descrição
addDeveloperMetadata(key)SpreadsheetAdiciona metadados de desenvolvedor com a chave especificada à planilha de nível superior.
addDeveloperMetadata(key, visibility)SpreadsheetAdiciona metadados do desenvolvedor com a chave e a visibilidade especificadas à planilha.
addDeveloperMetadata(key, value)SpreadsheetAdiciona os metadados do desenvolvedor com a chave e o valor especificados à planilha.
addDeveloperMetadata(key, value, visibility)SpreadsheetAdiciona metadados do desenvolvedor com a chave, o valor e a visibilidade especificados à planilha.
addEditor(emailAddress)SpreadsheetAdiciona o usuário especificado à lista de editores do Spreadsheet.
addEditor(user)SpreadsheetAdiciona o usuário especificado à lista de editores do Spreadsheet.
addEditors(emailAddresses)SpreadsheetAdiciona a matriz de usuários especificada à lista de editores do Spreadsheet.
addMenu(name, subMenus)voidCria um novo menu na IU do Planilhas.
addViewer(emailAddress)SpreadsheetAdiciona o usuário especificado à lista de visualizadores para o Spreadsheet.
addViewer(user)SpreadsheetAdiciona o usuário especificado à lista de visualizadores para o Spreadsheet.
addViewers(emailAddresses)SpreadsheetAdiciona a matriz de usuários especificada à lista de visualizadores para o Spreadsheet.
appendRow(rowContents)SheetAnexa uma linha à parte inferior da região de dados atual da página.
autoResizeColumn(columnPosition)SheetDefine a largura da coluna específica para que se ajuste ao conteúdo.
copy(name)SpreadsheetCopia a planilha e retorna a nova.
createDeveloperMetadataFinder()DeveloperMetadataFinderRetorna um DeveloperMetadataFinder para encontrar metadados do desenvolvedor no escopo desta planilha.
createTextFinder(findText)TextFinderCria um localizador para a planilha, que pode ser usada para encontrar e substituir texto nela.
deleteActiveSheet()SheetExclui a página ativa no momento.
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.
deleteSheet(sheet)voidExclui a página especificada.
duplicateActiveSheet()SheetDuplicar a página ativa e torná-la ativa.
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.
getActiveSheet()SheetRecebe a planilha ativa em uma planilha.
getAs(contentType)BlobRetorna os dados dentro desse objeto como um blob convertido para o tipo de conteúdo especificado.
getBandings()Banding[]Retorna todas as faixas nesta planilha.
getBlob()BlobRetorne os dados dentro desse objeto como um blob.
getColumnWidth(columnPosition)IntegerRecebe a largura em pixels da coluna especificada.
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.
getDataSourceRefreshSchedules()DataSourceRefreshSchedule[]Recebe as programações de atualização desta planilha.
getDataSourceSheets()DataSourceSheet[]Retorna todas as páginas de origem de dados na planilha.
getDataSourceTables()DataSourceTable[]Recebe todas as tabelas de fontes de dados.
getDataSources()DataSource[]Retorna todas as fontes de dados na planilha.
getDeveloperMetadata()DeveloperMetadata[]Acesse os metadados do desenvolvedor associados à planilha de nível superior.
getEditors()User[]Recebe a lista de editores para esse Spreadsheet.
getFormUrl()StringRetorna o URL do formulário que envia as respostas a esta planilha ou null caso a planilha não tenha um formulário associado.
getFrozenColumns()IntegerRetorna o número de colunas congeladas.
getFrozenRows()IntegerRetorna o número de linhas congeladas.
getId()StringRecebe um identificador exclusivo para essa planilha.
getImages()OverGridImage[]Retorna todas as imagens na grade da página.
getIterativeCalculationConvergenceThreshold()NumberRetorna o valor limite usado durante o cálculo iterativo.
getLastColumn()IntegerRetorna a posição da última coluna que tem conteúdo.
getLastRow()IntegerRetorna a posição da última linha que tenha conteúdo.
getMaxIterativeCalculationCycles()IntegerRetorna o número máximo de iterações a serem usadas durante o cálculo iterativo.
getName()StringRecebe o nome do documento.
getNamedRanges()NamedRange[]Recebe todos os intervalos nomeados nesta planilha.
getNumSheets()IntegerRetorna o número de páginas nesta planilha.
getOwner()UserRetorna o proprietário do documento ou null para um documento em um drive compartilhado.
getPredefinedSpreadsheetThemes()SpreadsheetTheme[]Retorna a lista de temas predefinidos.
getProtections(type)Protection[]Recebe uma matriz de objetos que representam todos os intervalos ou páginas protegidos na planilha.
getRange(a1Notation)RangeRetorna o intervalo conforme especificado na notação A1 ou R1C1.
getRangeByName(name)RangeRetorna um intervalo nomeado ou null se nenhum intervalo com o nome especificado for encontrado.
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.
getRecalculationInterval()RecalculationIntervalRetorna o intervalo de cálculo da planilha.
getRowHeight(rowPosition)IntegerRecebe a altura em pixels da linha especificada.
getSelection()SelectionRetorna o Selection atual na planilha.
getSheetByName(name)SheetRetorna uma página com o nome informado.
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.
getSheets()Sheet[]Recebe todas as páginas desta planilha.
getSpreadsheetLocale()StringRecebe a localidade da planilha.
getSpreadsheetTheme()SpreadsheetThemeRetorna o tema atual da planilha ou null caso nenhum tema seja aplicado.
getSpreadsheetTimeZone()StringRecebe o fuso horário da planilha.
getUrl()StringRetorna o URL da planilha especificada.
getViewers()User[]Recebe a lista de leitores e comentaristas desta Spreadsheet.
hideColumn(column)voidOculta a coluna ou as colunas no intervalo especificado.
hideRow(row)voidOculta as linhas no intervalo especificado.
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.
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.
insertDataSourceSheet(spec)DataSourceSheetInsere um novo DataSourceSheet na planilha e inicia a execução dos dados.
insertImage(blobSource, column, row)OverGridImageInsere uma Spreadsheet como imagem no documento em uma determinada linha e coluna.
insertImage(blobSource, column, row, offsetX, offsetY)OverGridImageInsere um Spreadsheet 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.
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.
insertSheet()SheetInsere uma nova página na planilha usando o nome padrão da página.
insertSheet(sheetIndex)SheetInsere uma nova página na planilha no índice especificado.
insertSheet(sheetIndex, options)SheetInsere uma nova página na planilha no índice fornecido e usa argumentos avançados opcionais.
insertSheet(options)SheetInsere uma nova página na planilha usando um nome de página padrão e argumentos avançados opcionais.
insertSheet(sheetName)SheetInsere uma nova página na planilha com o nome fornecido.
insertSheet(sheetName, sheetIndex)SheetInsere uma nova página na planilha com o nome fornecido no índice especificado.
insertSheet(sheetName, sheetIndex, options)SheetInsere uma nova página na planilha com o nome especificado no índice especificado e usa argumentos avançados opcionais.
insertSheet(sheetName, options)SheetInsere uma nova página na planilha com o nome fornecido e usa argumentos avançados opcionais.
insertSheetWithDataSourceTable(spec)SheetInsere uma nova página na planilha, cria um DataSourceTable que abrange toda a página com a especificação de fonte de dados especificada e inicia a execução dos dados.
isColumnHiddenByUser(columnPosition)BooleanRetorna se a coluna especificada é oculta pelo usuário.
isIterativeCalculationEnabled()BooleanRetorna indicando se o cálculo iterativo está ativado ou não na planilha.
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.
moveActiveSheet(pos)voidMove a página ativa para a posição especificada na lista de páginas.
moveChartToObjectSheet(chart)SheetCria uma nova página SheetType.OBJECT e move o gráfico fornecido para ela.
refreshAllDataSources()voidAtualiza todas as fontes de dados compatíveis e os respectivos objetos vinculados, ignorando objetos inválidos.
removeEditor(emailAddress)SpreadsheetRemove o usuário em questão da lista de editores do Spreadsheet.
removeEditor(user)SpreadsheetRemove o usuário em questão da lista de editores do Spreadsheet.
removeMenu(name)voidRemove um menu adicionado por addMenu(name, subMenus).
removeNamedRange(name)voidExclui um intervalo nomeado com o nome fornecido.
removeViewer(emailAddress)SpreadsheetRemove o usuário da lista de leitores e comentaristas da Spreadsheet.
removeViewer(user)SpreadsheetRemove o usuário da lista de leitores e comentaristas da Spreadsheet.
rename(newName)voidRenomeia o documento.
renameActiveSheet(newName)voidRenomeia a página ativa atual com o novo nome.
resetSpreadsheetTheme()SpreadsheetThemeRemove o tema aplicado e define o tema padrão na planilha.
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.
setActiveSheet(sheet)SheetDefine a página como a página ativa na planilha.
setActiveSheet(sheet, restoreSelection)SheetDefine a página especificada como a ativa na planilha, com a opção de restaurar a seleção mais recente dentro dessa página.
setColumnWidth(columnPosition, width)SheetDefine a largura da coluna especificada em pixels.
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.
setIterativeCalculationConvergenceThreshold(minThreshold)SpreadsheetDefine o valor do limite mínimo para o cálculo iterativo.
setIterativeCalculationEnabled(isEnabled)SpreadsheetDefine se o cálculo iterativo está ativado nesta planilha.
setMaxIterativeCalculationCycles(maxIterations)SpreadsheetDefine o número máximo de iterações de cálculo que precisam ser realizadas durante o cálculo iterativo.
setNamedRange(name, range)voidNomeia um intervalo.
setRecalculationInterval(recalculationInterval)SpreadsheetDefine a frequência com que esta planilha deve ser recalculada.
setRowHeight(rowPosition, height)SheetDefine a altura da linha em pixels.
setSpreadsheetLocale(locale)voidDefine a localidade da planilha.
setSpreadsheetTheme(theme)SpreadsheetThemeDefine um tema na planilha.
setSpreadsheetTimeZone(timezone)voidDefine o fuso horário da planilha.
show(userInterface)voidExibe um componente personalizado da interface do usuário em uma caixa de diálogo centralizada na janela de visualização do navegador do usuário.
sort(columnPosition)SheetClassifica uma página por coluna, em ordem crescente.
sort(columnPosition, ascending)SheetClassifica uma página por coluna.
toast(msg)voidMostra uma janela pop-up no canto inferior direito da planilha com a mensagem especificada.
toast(msg, title)voidMostra uma janela pop-up no canto inferior direito da planilha com a mensagem e o título fornecidos.
toast(msg, title, timeoutSeconds)voidMostra uma janela pop-up no canto inferior direito da planilha com o título e a mensagem fornecidos, que permanece visível por um determinado período.
unhideColumn(column)voidReexibe a coluna no intervalo especificado.
unhideRow(row)voidReexibe a linha no intervalo especificado.
updateMenu(name, subMenus)voidAtualiza um menu adicionado por addMenu(name, subMenus).
waitForAllDataExecutionsCompletion(timeoutInSeconds)voidAguarda até que todas as execuções atuais na planilha sejam concluídas. Esse tempo limite é atingido após o número de segundos informado.

Documentação detalhada

addDeveloperMetadata(key)

Adiciona metadados de desenvolvedor com a chave especificada à planilha de nível superior.

Parâmetros

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

Retornar

Spreadsheet: esta planilha, para encadeamento.

Autorização

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

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

addDeveloperMetadata(key, visibility)

Adiciona metadados do desenvolvedor com a chave e a visibilidade especificadas à planilha.

Parâmetros

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

Retornar

Spreadsheet: esta planilha, para encadeamento.

Autorização

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

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

addDeveloperMetadata(key, value)

Adiciona os metadados do desenvolvedor com a chave e o valor especificados à planilha.

Parâmetros

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

Retornar

Spreadsheet: esta planilha, para encadeamento.

Autorização

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

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

addDeveloperMetadata(key, value, visibility)

Adiciona metadados do desenvolvedor com a chave, o valor e a visibilidade especificados à planilha.

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

Spreadsheet: esta planilha, para encadeamento.

Autorização

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

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

addEditor(emailAddress)

Adiciona o usuário especificado à lista de editores do Spreadsheet. Se o usuário já estiver na lista de espectadores, esse método o promoverá fora da lista.

Parâmetros

NomeTipoDescrição
emailAddressStringEndereço de e-mail do usuário a ser adicionado.

Retornar

Spreadsheet: este Spreadsheet, 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

addEditor(user)

Adiciona o usuário especificado à lista de editores do Spreadsheet. Se o usuário já estiver na lista de espectadores, esse método o promoverá fora da lista.

Parâmetros

NomeTipoDescrição
userUserUma representação do usuário a ser adicionado.

Retornar

Spreadsheet: este Spreadsheet, 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

addEditors(emailAddresses)

Adiciona a matriz de usuários especificada à lista de editores do Spreadsheet. Se algum dos usuários já estiver na lista de visualizadores, esse método os promoverá fora da lista de visualizadores.

Parâmetros

NomeTipoDescrição
emailAddressesString[]Uma matriz de endereços de e-mail dos usuários a serem adicionados.

Retornar

Spreadsheet: este Spreadsheet, 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

addMenu(name, subMenus)

Cria um novo menu na IU do Planilhas.

Cada entrada do menu executa uma função definida pelo usuário. Normalmente, você quer chamá-lo na função onOpen() para que o menu seja criado automaticamente quando a planilha for carregada.

// The onOpen function is executed automatically every time a Spreadsheet is loaded
function onOpen() {
  var ss = SpreadsheetApp.getActiveSpreadsheet();
  var menuEntries = [];
  // When the user clicks on "addMenuExample" then "Menu Entry 1", the function function1 is
  // executed.
  menuEntries.push({name: "Menu Entry 1", functionName: "function1"});
  menuEntries.push(null); // line separator
  menuEntries.push({name: "Menu Entry 2", functionName: "function2"});

  ss.addMenu("addMenuExample", menuEntries);
}

Parâmetros

NomeTipoDescrição
nameStringO nome do menu a ser criado.
subMenusObject[]Uma matriz de mapas JavaScript com parâmetros name e functionName . Você pode usar funções de bibliotecas incluídas, como Library.libFunction1.

Autorização

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

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

addViewer(emailAddress)

Adiciona o usuário especificado à lista de visualizadores para o Spreadsheet. Esse método não terá efeito se o usuário já estiver na lista de editores.

Parâmetros

NomeTipoDescrição
emailAddressStringEndereço de e-mail do usuário a ser adicionado.

Retornar

Spreadsheet: este Spreadsheet, 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

addViewer(user)

Adiciona o usuário especificado à lista de visualizadores para o Spreadsheet. Esse método não terá efeito se o usuário já estiver na lista de editores.

Parâmetros

NomeTipoDescrição
userUserUma representação do usuário a ser adicionado.

Retornar

Spreadsheet: este Spreadsheet, 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

addViewers(emailAddresses)

Adiciona a matriz de usuários especificada à lista de visualizadores para o Spreadsheet. Se algum dos usuários já estiver na lista de editores, esse método não vai ter efeito para eles.

Parâmetros

NomeTipoDescrição
emailAddressesString[]Uma matriz de endereços de e-mail dos usuários a serem adicionados.

Retornar

Spreadsheet: este Spreadsheet, 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

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

copy(name)

Copia a planilha e retorna a nova.

// This code makes a copy of the current spreadsheet and names it appropriately
var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.copy("Copy of " + ss.getName());

Parâmetros

NomeTipoDescrição
nameStringÉ o nome da cópia.

Retornar

Spreadsheet: esta planilha, para encadeamento.

Autorização

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

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

createDeveloperMetadataFinder()

Retorna um DeveloperMetadataFinder para encontrar metadados do desenvolvedor no escopo desta planilha. Por padrão, isso considera todos os metadados associados à planilha, às páginas, às linhas e às colunas.

Retornar

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


createTextFinder(findText)

Cria um localizador para a planilha, que pode ser usada para encontrar e substituir texto nela. A pesquisa começa na primeira página da planilha.

var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();

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

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


deleteActiveSheet()

Exclui a página ativa no momento.

// The code below deletes the currently active sheet and stores the new active sheet in a
// variable
var newSheet = SpreadsheetApp.getActiveSpreadsheet().deleteActiveSheet();

Retornar

Sheet: a nova página ativa.

Autorização

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

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

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

deleteSheet(sheet)

Exclui a página especificada.

// The code below deletes the specified sheet.
var ss = SpreadsheetApp.getActive();
var sheet = ss.getSheetByName('My Sheet');
ss.deleteSheet(sheet);

Parâmetros

NomeTipoDescrição
sheetSheetA página a ser excluída.

Autorização

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

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

duplicateActiveSheet()

Duplicar a página ativa e torná-la ativa.

// The code below makes a duplicate of the active sheet
SpreadsheetApp.getActiveSpreadsheet().duplicateActiveSheet();

Retornar

Sheet: a nova 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

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


getActiveSheet()

Recebe a planilha ativa em uma planilha.

A página ativa em uma planilha é aquela que está sendo exibida na IU da planilha.

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

Retornar

Sheet: a página ativa na planilha.


getAs(contentType)

Retorna os dados dentro desse objeto como um blob convertido para o tipo de conteúdo especificado. Esse método adiciona a extensão apropriada ao nome do arquivo, por exemplo, "meuarquivo.pdf". No entanto, supõe que a parte do nome do arquivo que segue o último ponto (se houver) é uma extensão existente que precisa ser substituída. Consequentemente, "ShoppingList.12.25.2014" se tornará "ShoppingList.12.25.pdf".

Para ver as cotas diárias de conversões, consulte Cotas para serviços do Google. Os domínios do Google Workspace recém-criados podem estar temporariamente sujeitos a cotas mais rígidas.

Parâmetros

NomeTipoDescrição
contentTypeStringO tipo MIME para conversão. Para a maioria dos blobs, 'application/pdf' é a única opção válida. Para imagens no formato BMP, GIF, JPEG ou PNG, qualquer um dos 'image/bmp', 'image/gif', 'image/jpeg' ou 'image/png' também é válido.

Retornar

Blob: os dados como um blob.


getBandings()

Retorna todas as faixas nesta planilha.

Retornar

Banding[]: as faixas nesta planilha.

Autorização

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

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

getBlob()

Retorne os dados dentro desse objeto como um blob.

Retornar

Blob: os dados como um blob.


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

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

getDataSourceRefreshSchedules()

Recebe as programações de atualização desta planilha.

Retornar

DataSourceRefreshSchedule[]: as programações de atualização desta 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

getDataSourceSheets()

Retorna todas as páginas de origem de dados na planilha.

Retornar

DataSourceSheet[]: uma matriz de todas as páginas de origem de dados.

Autorização

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

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

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

getDataSources()

Retorna todas as fontes de dados na planilha.

Retornar

DataSource[]: uma matriz de todas as 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 os metadados do desenvolvedor associados à planilha de nível superior.

Retornar

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

Autorização

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

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

getEditors()

Recebe a lista de editores para esse Spreadsheet.

Retornar

User[]: uma matriz de usuários com permissão para ediçã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

getFormUrl()

Retorna o URL do formulário que envia as respostas a esta planilha ou null caso a planilha não tenha um formulário associado. Se vários formulários enviarem respostas a essa planilha, o URL do formulário retornado será indeterminado. Como alternativa, as associações de URL por formulário da planilha podem ser recuperadas pelo método Sheet.getFormUrl().

Retornar

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

Autorização

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

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

getFrozenColumns()

Retorna o número de colunas 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

getId()

Recebe um identificador exclusivo para essa planilha. Um ID de planilha pode ser extraído do URL. Por exemplo, o ID da planilha no URL https://docs.google.com/spreadsheets/d/abc1234567/edit#gid=0 é "abc1234567".

// The code below logs the ID for the active spreadsheet.
Logger.log(SpreadsheetApp.getActiveSpreadsheet().getId());

Retornar

String: o ID (ou chave) exclusivo da planilha.


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

getIterativeCalculationConvergenceThreshold()

Retorna o valor limite usado durante o cálculo iterativo. Quando os resultados do cálculo sucessivo são diferentes por esse valor, o cálculo iterativo é interrompido.

Retornar

Number: o limite de convergência.

Autorização

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

getMaxIterativeCalculationCycles()

Retorna o número máximo de iterações a serem usadas durante o cálculo iterativo.

Retornar

Integer: o número máximo de iterações de cálculo.

Autorização

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

Recebe o nome do documento.

var ss = SpreadsheetApp.getActiveSpreadsheet();
Logger.log(ss.getName());

Retornar

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

getNamedRanges()

Recebe todos os intervalos nomeados nesta planilha.

// The code below logs the name of the first named range.
var namedRanges = SpreadsheetApp.getActiveSpreadsheet().getNamedRanges();
for (var i = 0; i < namedRanges.length; i++) {
  Logger.log(namedRanges[i].getName());
}

Retornar

NamedRange[]: uma matriz de todos os intervalos nomeados na planilha.

Autorização

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

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

getNumSheets()

Retorna o número de páginas nesta planilha.

// The code below logs the number of sheets in the active spreadsheet.
Logger.log(SpreadsheetApp.getActiveSpreadsheet().getNumSheets());

Retornar

Integer: o número de páginas na planilha.


getOwner()

Retorna o proprietário do documento ou null para um documento em um drive compartilhado.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var owner = ss.getOwner();
Logger.log(owner.getEmail());

Retornar

User: o proprietário do documento ou null se o documento estiver em um drive compartilhado.

Autorização

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

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

getPredefinedSpreadsheetThemes()

Retorna a lista de temas predefinidos.

// The code below returns the list of predefined themes.
var predefinedThemesList = SpreadsheetApp.getActiveSpreadsheet()
                               .getPredefinedSpreadsheetThemes();

Retornar

SpreadsheetTheme[]: lista de temas predefinidos.

Autorização

Os scripts que usam esse mé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 ou páginas protegidos na planilha.

// Remove all range protections in the spreadsheet that the user has permission to edit.
var ss = SpreadsheetApp.getActive();
var protections = ss.getProtections(SpreadsheetApp.ProtectionType.RANGE);
for (var i = 0; i < protections.length; i++) {
  var protection = protections[i];
  if (protection.canEdit()) {
    protection.remove();
  }
}
// Remove all sheet protections in the spreadsheet that the user has permission to edit.
var ss = SpreadsheetApp.getActive();
var protections = ss.getProtections(SpreadsheetApp.ProtectionType.SHEET);
for (var i = 0; i < protections.length; i++) {
  var protection = protections[i];
  if (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 representando todos os intervalos ou páginas protegidos 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

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

getRangeByName(name)

Retorna um intervalo nomeado ou null se nenhum intervalo com o nome especificado for encontrado. Se várias páginas da planilha usarem o mesmo nome de intervalo, especifique o nome da planilha sem aspas extras (por exemplo, getRangeByName('TaxRates') ou getRangeByName('Sheet Name!TaxRates'), mas não getRangeByName('"Sheet Name"!TaxRates')).

// Log the number of columns for the range named 'TaxRates' in the active spreadsheet.
var range = SpreadsheetApp.getActiveSpreadsheet().getRangeByName('TaxRates');
if (range != null) {
  Logger.log(range.getNumColumns());
}

Parâmetros

NomeTipoDescrição
nameStringO nome do intervalo a ser recebido.

Retornar

Range: o intervalo de células com o nome especificado.


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

getRecalculationInterval()

Retorna o intervalo de cálculo da planilha.

Retornar

RecalculationInterval: o intervalo de cálculo desta 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

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

getSheetByName(name)

Retorna uma página com o nome informado.

Se várias páginas tiverem o mesmo nome, a mais à esquerda será retornada. Retornará null se não houver uma página com o nome fornecido.

// The code below logs the index of a sheet named "Expenses"
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheetByName("Expenses");
if (sheet != null) {
  Logger.log(sheet.getIndex());
}

Parâmetros

NomeTipoDescrição
nameStringO nome da página a ser recebida.

Retornar

Sheet: a página com o nome fornecido.


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

getSheets()

Recebe todas as páginas desta planilha.

// The code below logs the name of the second sheet
var sheets = SpreadsheetApp.getActiveSpreadsheet().getSheets();
if (sheets.length > 1) {
  Logger.log(sheets[1].getName());
}

Retornar

Sheet[]: uma matriz de todas as páginas da planilha.


getSpreadsheetLocale()

Recebe a localidade da planilha.

Retornar

String: a localidade 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

getSpreadsheetTheme()

Retorna o tema atual da planilha ou null caso nenhum tema seja aplicado.

// The code below returns the current theme of the spreadsheet.
var currentTheme = SpreadsheetApp.getActiveSpreadsheet().getSpreadsheetTheme();

Retornar

SpreadsheetTheme: o tema aplicado no momento.

Autorização

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

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

getSpreadsheetTimeZone()

Recebe o fuso horário da planilha.

Retornar

String: o fuso horário, especificado no formato "longo" (por exemplo, "EUA/Nova_York", conforme listado por Joda.org).

Autorização

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

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

getUrl()

Retorna o URL da planilha especificada.

var ss = SpreadsheetApp.getActiveSpreadsheet();
Logger.log(ss.getUrl());

Retornar

String: o URL da planilha 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

getViewers()

Recebe a lista de leitores e comentaristas desta Spreadsheet.

Retornar

User[]: uma matriz de usuários com permissão para visualização ou comentário.

Autorização

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

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

hideColumn(column)

Oculta a coluna ou as colunas no intervalo especificado.

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

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

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

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

insertDataSourceSheet(spec)

Insere um novo DataSourceSheet na planilha e inicia a execução dos dados. Como efeito colateral, isso também torna a nova página a ativa.

Uma exceção vai ser gerada se o tipo de fonte de dados não estiver ativado. Use métodos SpreadsheetApp#enable...Execution() para ativar a execução de dados para um tipo específico de fonte de dados.

Parâmetros

NomeTipoDescrição
specDataSourceSpecA especificação da fonte de dados a ser inserida.

Retornar

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

insertImage(blobSource, column, row)

Insere uma Spreadsheet 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 Spreadsheet 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.

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.

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

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

insertSheet()

Insere uma nova página na planilha usando o nome padrão da página. A nova página será a ativa.

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.insertSheet();

Retornar

Sheet: a nova 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

insertSheet(sheetIndex)

Insere uma nova página na planilha no índice especificado. A nova página se torna a ativa.

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.insertSheet(1);

Parâmetros

NomeTipoDescrição
sheetIndexIntegerO índice da página recém-criada. Para inserir uma página como a primeira na planilha, defina-a como 0.

Retornar

Sheet: a nova 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

insertSheet(sheetIndex, options)

Insere uma nova página na planilha no índice fornecido e usa argumentos avançados opcionais. A nova página se tornará a ativa.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var templateSheet = ss.getSheetByName('Sales');
ss.insertSheet(1, {template: templateSheet});

Parâmetros

NomeTipoDescrição
sheetIndexIntegerO índice da página recém-criada. Para inserir uma página como a primeira na planilha, defina-a como 0.
optionsObjectArgumentos avançados de JavaScript opcionais.

Parâmetros avançados

NomeTipoDescrição
templateSheetTodos os dados do objeto de página de modelo são copiados para a nova página. O modelo de página precisa ser uma das páginas do objeto Planilha.

Retornar

Sheet: a nova 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

insertSheet(options)

Insere uma nova página na planilha usando um nome de página padrão e argumentos avançados opcionais. A nova página se tornará a ativa.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var templateSheet = ss.getSheetByName('Sales');
ss.insertSheet({template: templateSheet});

Parâmetros

NomeTipoDescrição
optionsObjectArgumentos avançados de JavaScript opcionais, listados abaixo.

Parâmetros avançados

NomeTipoDescrição
templateSheetTodos os dados do objeto de página de modelo são copiados para a nova página. O modelo de planilha precisa ser uma das planilhas desse objeto de planilha.

Retornar

Sheet: a nova 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

insertSheet(sheetName)

Insere uma nova página na planilha com o nome fornecido. A nova página se torna a ativa.

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.insertSheet('My New Sheet');

Parâmetros

NomeTipoDescrição
sheetNameStringO nome da nova página.

Retornar

Sheet: a nova 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

insertSheet(sheetName, sheetIndex)

Insere uma nova página na planilha com o nome fornecido no índice especificado. A nova página se tornará a ativa.

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.insertSheet('My New Sheet', 1);

Parâmetros

NomeTipoDescrição
sheetNameStringO nome da nova página.
sheetIndexIntegerO índice da página recém-criada. Para inserir uma página como a primeira na planilha, defina-a como 0.

Retornar

Sheet: a nova 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

insertSheet(sheetName, sheetIndex, options)

Insere uma nova página na planilha com o nome especificado no índice especificado e usa argumentos avançados opcionais. A nova página se tornará a ativa.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var templateSheet = ss.getSheetByName('Sales');
ss.insertSheet('My New Sheet', 1, {template: templateSheet});

Parâmetros

NomeTipoDescrição
sheetNameStringO nome da nova página.
sheetIndexIntegerO índice da página recém-inserida. Para inserir uma página como a primeira em uma planilha, defina-a como 0.
optionsObjectArgumentos avançados de JavaScript opcionais.

Parâmetros avançados

NomeTipoDescrição
templateSheetTodos os dados do objeto de página de modelo são copiados para a nova página. O modelo de página precisa ser uma das páginas do objeto Planilha.

Retornar

Sheet: a nova 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

insertSheet(sheetName, options)

Insere uma nova página na planilha com o nome fornecido e usa argumentos avançados opcionais. A nova página se tornará a ativa.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var templateSheet = ss.getSheetByName('Sales');
ss.insertSheet('My New Sheet', {template: templateSheet});

Parâmetros

NomeTipoDescrição
sheetNameStringO nome da nova página.
optionsObjectArgumentos avançados de JavaScript opcionais.

Parâmetros avançados

NomeTipoDescrição
templateSheetTodos os dados do objeto de página de modelo são copiados para a nova página. O modelo de página precisa ser uma das páginas do objeto Planilha.

Retornar

Sheet: a nova 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

insertSheetWithDataSourceTable(spec)

Insere uma nova página na planilha, cria um DataSourceTable que abrange toda a página com a especificação de fonte de dados especificada e inicia a execução dos dados. Como efeito colateral, torna a nova página a ativa.

Uma exceção vai ser gerada se o tipo de fonte de dados não estiver ativado. Use métodos SpreadsheetApp#enable...Execution() para ativar a execução de dados para um tipo específico de fonte de dados.

Parâmetros

NomeTipoDescrição
specDataSourceSpecA especificação da fonte de dados a ser inserida.

Retornar

Sheet: a nova 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

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

isIterativeCalculationEnabled()

Retorna indicando se o cálculo iterativo está ativado ou não na planilha.

Retornar

Boolean: true se o cálculo iterativo estiver ativado. 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

moveActiveSheet(pos)

Move a página ativa para a posição especificada na lista de páginas. Uma exceção será gerada se a posição for negativa ou maior que o número de páginas.

// This example assumes that there are 2 sheets in the current
// active spreadsheet: one named "first" in position 1 and another named "second"
// in position 2.
var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
// Gets the "first" sheet and activates it.
var sheet = spreadsheet.getSheetByName("first").activate();

// Logs 'Current index of sheet: 1'
console.log("Current index of sheet: %s", sheet.getIndex());

spreadsheet.moveActiveSheet(2);

// Logs 'New index of sheet: 2'
console.log("New index of sheet: %s", sheet.getIndex());

Parâmetros

NomeTipoDescrição
posIntegerA posição de um índice para mover a página ativa na lista de páginas.

Autorização

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

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

moveChartToObjectSheet(chart)

Cria uma nova página SheetType.OBJECT e move o gráfico fornecido para ela. Se o gráfico já estiver na própria planilha, ela será retornada sem a criação de uma nova.

var sheet = SpreadsheetApp.getActiveSheet();
var chart = sheet.newChart().setPosition(1, 1, 0, 0).build();
sheet.insertChart(chart);
var objectSheet = SpreadsheetApp.getActive().moveChartToObjectSheet(chart);

Parâmetros

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

Retornar

Sheet: a página em que o gráfico está.

Autorização

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

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

refreshAllDataSources()

Atualiza todas as fontes de dados compatíveis e os respectivos objetos vinculados, ignorando objetos inválidos.

Use métodos SpreadsheetApp#enable...Execution() para ativar a execução de dados para um tipo de fonte de dados específico.

Autorização

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

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

removeEditor(emailAddress)

Remove o usuário em questão da lista de editores do Spreadsheet. Esse método não impede que os usuários acessem o Spreadsheet se pertencerem a uma classe de usuários com acesso geral, por exemplo, se o Spreadsheet for compartilhado com todo o domínio do usuário ou se Spreadsheet estiver em um drive compartilhado que o usuário possa acessar.

No caso de arquivos do Drive, isso também remove o usuário da lista de leitores.

Parâmetros

NomeTipoDescrição
emailAddressStringEndereço de e-mail do usuário a ser removido.

Retornar

Spreadsheet: este Spreadsheet, 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

removeEditor(user)

Remove o usuário em questão da lista de editores do Spreadsheet. Esse método não impede que os usuários acessem o Spreadsheet se pertencerem a uma classe de usuários com acesso geral, por exemplo, se o Spreadsheet for compartilhado com todo o domínio do usuário ou se Spreadsheet estiver em um drive compartilhado que o usuário possa acessar.

No caso de arquivos do Drive, isso também remove o usuário da lista de leitores.

Parâmetros

NomeTipoDescrição
userUserUma representação do usuário a ser removido.

Retornar

Spreadsheet: este Spreadsheet, 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

removeMenu(name)

Remove um menu adicionado por addMenu(name, subMenus). O argumento name precisa ter o mesmo valor que a chamada correspondente para addMenu(name, subMenus).

// The onOpen function is executed automatically every time a Spreadsheet is loaded
function onOpen() {
  var ss = SpreadsheetApp.getActiveSpreadsheet();
  ss.addMenu("badMenu", [{name: "remove bad menu", functionName: "removeBadMenu"},
                                       {name: "foo", functionName: "foo"}]);
}
function removeBadMenu() {
  var ss = SpreadsheetApp.getActiveSpreadsheet();
  ss.removeMenu("badMenu");  // name must match the name used when added the menu
}
function foo(){
// Do nothing
}

Parâmetros

NomeTipoDescrição
nameStringNome do menu 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

removeNamedRange(name)

Exclui um intervalo nomeado com o nome fornecido. Uma exceção será gerada se nenhum intervalo com o nome fornecido for encontrado na planilha.

// The code below creates a new named range "foo", and then remove it.
var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.setNamedRange("foo", ss.getActiveRange());
ss.removeNamedRange("foo");

Parâmetros

NomeTipoDescrição
nameStringNome do intervalo.

Autorização

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

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

removeViewer(emailAddress)

Remove o usuário da lista de leitores e comentaristas da Spreadsheet. Esse método não terá efeito se o usuário for um editor, não um leitor ou comentarista. Esse método também não impede que os usuários acessem o Spreadsheet se pertencerem a uma classe de usuários que tenham acesso geral, por exemplo, se o Spreadsheet for compartilhado com todo o domínio do usuário ou se Spreadsheet estiver em um drive compartilhado que o usuário possa acessar.

Nos arquivos do Drive, essa ação também remove o usuário da lista de editores.

Parâmetros

NomeTipoDescrição
emailAddressStringEndereço de e-mail do usuário a ser removido.

Retornar

Spreadsheet: este Spreadsheet para encadeamentos.

Autorização

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

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

removeViewer(user)

Remove o usuário da lista de leitores e comentaristas da Spreadsheet. Esse método não terá efeito se o usuário for um editor, não um leitor. Esse método também não impede que os usuários acessem o Spreadsheet se pertencerem a uma classe de usuários com acesso geral. Por exemplo, se o Spreadsheet for compartilhado com todo o domínio do usuário ou se o Spreadsheet estiver em um drive compartilhado que o usuário pode acessar.

Nos arquivos do Drive, essa ação também remove o usuário da lista de editores.

Parâmetros

NomeTipoDescrição
userUserUma representação do usuário a ser removido.

Retornar

Spreadsheet: este Spreadsheet para encadeamentos.

Autorização

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

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

rename(newName)

Renomeia o documento.

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.rename("This is the new name");

Parâmetros

NomeTipoDescrição
newNameStringO novo nome do documento.

Autorização

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

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

renameActiveSheet(newName)

Renomeia a página ativa atual com o novo nome.

// The code below renames the active sheet to "Hello world"
SpreadsheetApp.getActiveSpreadsheet().renameActiveSheet("Hello world");

Parâmetros

NomeTipoDescrição
newNameStringO novo nome da página 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

resetSpreadsheetTheme()

Remove o tema aplicado e define o tema padrão na planilha.

// The code below applies default theme on the spreadsheet.
SpreadsheetApp.getActiveSpreadsheet().resetSpreadsheetTheme();

Retornar

SpreadsheetTheme: o tema padrã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

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

setActiveSheet(sheet)

Define a página como a página ativa na planilha. A IU do Planilhas Google exibe a planilha escolhida, a menos que ela pertença a outra planilha.

// The code below makes the first sheet active in the active spreadsheet.
var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
spreadsheet.setActiveSheet(spreadsheet.getSheets()[0]);

Parâmetros

NomeTipoDescrição
sheetSheetA página a ser definida como ativa.

Retornar

Sheet: a página ativa.

Autorização

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

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

setActiveSheet(sheet, restoreSelection)

Define a página especificada como a ativa na planilha, com a opção de restaurar a seleção mais recente dentro dessa página. A IU do Planilhas Google exibe a página escolhida, a menos que ela pertença a outra planilha.

var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
var firstSheet = spreadsheet.getSheets()[0];
var secondSheet = spreadsheet.getSheets()[1];
// Set the first sheet as the active sheet and select the range D4:F4.
spreadsheet.setActiveSheet(firstSheet).getRange('D4:F4').activate();

// Switch to the second sheet to do some work.
spreadsheet.setActiveSheet(secondSheet);
// Switch back to first sheet, and restore its selection.
spreadsheet.setActiveSheet(firstSheet, true);

// The selection of first sheet is restored, and it logs D4:F4
var range = spreadsheet.getActiveSheet().getSelection().getActiveRange();
Logger.log(range.getA1Notation());

Parâmetros

NomeTipoDescrição
sheetSheetA nova página ativa.
restoreSelectionBooleanTf true, a seleção mais recente da nova página ativa será selecionada novamente à medida que a nova página ficar ativa. Se false, a nova página ficará ativa sem mudar a seleção atual.

Retornar

Sheet: a nova página ativa.

Autorização

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

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

setIterativeCalculationConvergenceThreshold(minThreshold)

Define o valor do limite mínimo para o cálculo iterativo. Quando os resultados do cálculo sucessivo são diferentes por esse valor, o cálculo iterativo é interrompido. Esse valor não pode ser negativo e o padrão é 0, 05.

Parâmetros

NomeTipoDescrição
minThresholdNumberO limite mínimo de convergência (não pode ser negativo).

Retornar

Spreadsheet: esta planilha, para encadeamento.

Autorização

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

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

setIterativeCalculationEnabled(isEnabled)

Define se o cálculo iterativo está ativado nesta planilha. Se o número máximo de ciclos de cálculo e o limite de convergência não tiverem sido definidos anteriormente quando o cálculo estiver ativado, o padrão será 50 e 0,05, respectivamente. Se algum deles tiver sido definido anteriormente, ele manterá os valores anteriores.

Parâmetros

NomeTipoDescrição
isEnabledBooleantrue se o cálculo iterativo precisar ser ativado. Caso contrário, false.

Retornar

Spreadsheet: esta planilha, para encadeamento.

Autorização

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

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

setMaxIterativeCalculationCycles(maxIterations)

Define o número máximo de iterações de cálculo que precisam ser realizadas durante o cálculo iterativo. Esse valor precisa estar entre 1 e 10.000 (inclusive) e o padrão é 50.

Parâmetros

NomeTipoDescrição
maxIterationsIntegerO número máximo de iterações de cálculo (entre 1 e 10.000).

Retornar

Spreadsheet: esta planilha, para encadeamento.

Autorização

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

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

setNamedRange(name, range)

Nomeia um intervalo.

// The code below creates a new named range "TaxRates" in the active spreadsheet
var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.setNamedRange("TaxRates", SpreadsheetApp.getActiveRange());

Parâmetros

NomeTipoDescrição
nameStringNome do intervalo.
rangeRangeA especificação do intervalo.

Autorização

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

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

setRecalculationInterval(recalculationInterval)

Define a frequência com que esta planilha deve ser recalculada.

Parâmetros

NomeTipoDescrição
recalculationIntervalRecalculationIntervalO novo intervalo de recálculo.

Retornar

Spreadsheet: esta planilha, para encadeamento.

Autorização

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

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

setRowHeight(rowPosition, height)

Define a altura da linha 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 Sheet.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

setSpreadsheetLocale(locale)

Define a localidade da planilha.

Parâmetros

NomeTipoDescrição
localeStringO código da localidade a ser usado (por exemplo, "en", "fr" ou "en_US").

Autorização

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

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

setSpreadsheetTheme(theme)

Define um tema na planilha.

var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
// The code below sets the second predefined theme as the current theme of the spreadsheet.
var predefinedThemesList = spreadsheet.getPredefinedSpreadsheetThemes();
spreadsheet.setSpreadsheetTheme(predefinedThemesList[1]);

Parâmetros

NomeTipoDescrição
themeSpreadsheetThemeO tema a ser aplicado.

Retornar

SpreadsheetTheme: o novo tema 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

setSpreadsheetTimeZone(timezone)

Define o fuso horário da planilha.

Parâmetros

NomeTipoDescrição
timezoneStringO fuso horário, especificado no formato "longo" (por exemplo, "EUA/New_York", conforme listado por Joda.org).

Autorização

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

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

show(userInterface)

Exibe um componente personalizado da interface do usuário em uma caixa de diálogo centralizada na janela de visualização do navegador do usuário. A execução do script do lado do servidor não está suspensa. Para se comunicar com o lado do servidor, o componente da interface do usuário precisa fazer callbacks assíncronos para o script do lado do servidor.

Se o script do lado do servidor exibia uma caixa de diálogo que ainda não foi dispensada, a caixa de diálogo existente será substituída pela interface do usuário da nova caixa de diálogo.

O snippet de código a seguir exibe um aplicativo HtmlService simples em uma caixa de diálogo com o título, altura e largura especificados:

var htmlApp = HtmlService
    .createHtmlOutput('<p>A change of speed, a change of style...</p>')
    .setTitle('My HtmlService Application')
    .setWidth(250)
    .setHeight(300);

SpreadsheetApp.getActiveSpreadsheet().show(htmlApp);

// The script resumes execution immediately after showing the dialog.

Parâmetros

NomeTipoDescrição
userInterfaceObjectUma HtmlOutput.

Autorização

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

  • https://www.googleapis.com/auth/script.container.ui

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

toast(msg)

Mostra uma janela pop-up no canto inferior direito da planilha com a mensagem especificada.

// Show a popup with the message "Task started".
SpreadsheetApp.getActiveSpreadsheet().toast('Task started');

Parâmetros

NomeTipoDescrição
msgStringA mensagem a ser exibida no aviso.

Autorização

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

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

toast(msg, title)

Mostra uma janela pop-up no canto inferior direito da planilha com a mensagem e o título fornecidos.

// Show a popup with the title "Status" and the message "Task started".
SpreadsheetApp.getActiveSpreadsheet().toast('Task started', 'Status');

Parâmetros

NomeTipoDescrição
msgStringA mensagem a ser exibida no aviso.
titleStringO título opcional do aviso.

Autorização

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

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

toast(msg, title, timeoutSeconds)

Mostra uma janela pop-up no canto inferior direito da planilha com o título e a mensagem fornecidos, que permanece visível por um determinado período.

// Show a 3-second popup with the title "Status" and the message "Task started".
SpreadsheetApp.getActiveSpreadsheet().toast('Task started', 'Status', 3);

Parâmetros

NomeTipoDescrição
msgStringA mensagem a ser exibida no aviso.
titleStringO título opcional do aviso.
timeoutSecondsNumberTempo limite em segundos. Se null, o aviso será definido por padrão como cinco segundos. Se negativo, o aviso será mantido até que seja dispensado.

Autorização

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

updateMenu(name, subMenus)

Atualiza um menu adicionado por addMenu(name, subMenus). Funciona exatamente como addMenu(name, subMenus).

var ss = SpreadsheetApp.getActiveSpreadsheet();
var menuEntries = [];
menuEntries.push({name: "Lone Menu Entry", functionName: "function1"});
ss.updateMenu("addMenuExample", menuEntries);

Parâmetros

NomeTipoDescrição
nameStringO nome do menu a ser atualizado.
subMenusObject[]Uma matriz de mapas JavaScript com parâmetros name e functionName . Você pode usar funções de bibliotecas incluídas, como Library.libFunction1.

Autorização

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

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

waitForAllDataExecutionsCompletion(timeoutInSeconds)

Aguarda até que todas as execuções atuais na planilha sejam concluídas. Esse tempo limite é atingido após o número de segundos informado. Emite uma exceção se as execuções não forem concluídas ao expirar, mas não cancela as execuções de dados.

Parâmetros

NomeTipoDescrição
timeoutInSecondsIntegerTempo de espera para execução de dados, em segundos. O máximo é de 300 segundos.

Autorização

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