Class Spreadsheet

Planilha

Acessar e modificar arquivos do Planilhas Google. As operações comuns são adicionar novas páginas colaboradores.

Métodos

MétodoTipo de retornoBreve descrição
addDeveloperMetadata(key)SpreadsheetAdiciona metadados do desenvolvedor com a chave especificada à planilha de nível superior.
addDeveloperMetadata(key, visibility)SpreadsheetAdiciona metadados do desenvolvedor com a chave e visibilidade especificadas à planilha.
addDeveloperMetadata(key, value)SpreadsheetAdiciona 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 interface da planilha.
addViewer(emailAddress)SpreadsheetAdiciona o usuário especificado à lista de leitores do Spreadsheet.
addViewer(user)SpreadsheetAdiciona o usuário especificado à lista de leitores do Spreadsheet.
addViewers(emailAddresses)SpreadsheetAdiciona a matriz de usuários especificada à lista de leitores para Spreadsheet.
appendRow(rowContents)SheetAnexa uma linha à parte inferior da região de dados atual na planilha.
autoResizeColumn(columnPosition)SheetDefine a largura da coluna para ajustar o conteúdo dela.
copy(name)SpreadsheetCopia a planilha e retorna a nova.
createDeveloperMetadataFinder()DeveloperMetadataFinderRetorna um DeveloperMetadataFinder para encontrar metadados do desenvolvedor no escopo de nesta planilha.
createTextFinder(findText)TextFinderCria um localizador de textos para a planilha, que pode ser usado para localizar e substituir texto na planilha.
deleteActiveSheet()SheetExclui a página ativa no momento.
deleteColumn(columnPosition)SheetExclui a coluna na posição de coluna especificada.
deleteColumns(columnPosition, howMany)voidExclui várias colunas a partir da posição da coluna especificada.
deleteRow(rowPosition)SheetExclui a linha na posição de linha especificada.
deleteRows(rowPosition, howMany)voidExclui várias linhas a partir da posição da linha especificada.
deleteSheet(sheet)voidExclui a página especificada.
duplicateActiveSheet()SheetDuplica a planilha ativa e a torna ativa.
getActiveCell()RangeRetorna a célula ativa na página.
getActiveRange()RangeRetorna o intervalo selecionado na página ativa ou null quando não há um intervalo ativo.
getActiveRangeList()RangeListRetorna a lista de intervalos ativos na página ativa ou null se não houver intervalos ativos intervalos.
getActiveSheet()SheetAcessa a página ativa de uma planilha.
getAs(contentType)BlobRetorna os dados dentro desse objeto como um blob convertido no tipo de conteúdo especificado.
getBandings()Banding[]Retorna todas as faixas da 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 na página ativa ou null se não houver uma 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 fonte de dados da planilha.
getDataSourceTables()DataSourceTable[]Recebe todas as tabelas da fonte de dados.
getDataSources()DataSource[]Retorna todas as fontes de dados na planilha.
getDeveloperMetadata()DeveloperMetadata[]Recebe os metadados do desenvolvedor associados à planilha de nível superior.
getEditors()User[]Recebe a lista de editores desse Spreadsheet.
getFormUrl()StringRetorna o URL do formulário que envia as respostas para essa planilha, ou null se esta planilha não tem nenhum formulário associado.
getFrozenColumns()IntegerRetorna o número de colunas congeladas.
getFrozenRows()IntegerRetorna o número de linhas congeladas.
getId()StringRecebe um identificador exclusivo desta planilha.
getImages()OverGridImage[]Retorna todas as imagens sobre a grade na página.
getIterativeCalculationConvergenceThreshold()NumberRetorna o valor do 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 tem 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 na planilha.
getNumSheets()IntegerRetorna o número de páginas nesta planilha.
getOwner()UserRetorna o proprietário do documento ou null de 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 fornecido 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 notaçõ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 planilha representada por este objeto.
getSheetName()StringRetorna o nome da página.
getSheetValues(startRow, startColumn, numRows, numColumns)Object[][]Retorna a grade retangular de valores para este intervalo, começando nas coordenadas fornecidas.
getSheets()Sheet[]Extrai todas as páginas desta planilha.
getSpreadsheetLocale()StringRecebe a localidade da planilha.
getSpreadsheetTheme()SpreadsheetThemeRetorna o tema atual da planilha ou null se nenhum tema for aplicado.
getSpreadsheetTimeZone()StringAcessa o fuso horário da planilha.
getUrl()StringRetorna o URL da planilha especificada.
getViewers()User[]Recebe a lista de leitores e comentadores deste Spreadsheet.
hideColumn(column)voidOculta a coluna ou colunas no intervalo especificado.
hideRow(row)voidOculta as linhas do intervalo especificado.
insertColumnAfter(afterPosition)SheetInsere uma coluna depois da posição da coluna especificada.
insertColumnBefore(beforePosition)SheetInsere uma coluna antes da posição da coluna especificada.
insertColumnsAfter(afterPosition, howMany)SheetInsere um determinado número de colunas após a posição de coluna especificada.
insertColumnsBefore(beforePosition, howMany)SheetInsere algumas 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 uma 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 pixels.
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 pixel.
insertRowAfter(afterPosition)SheetInsere uma linha após a posição da linha especificada.
insertRowBefore(beforePosition)SheetInsere uma linha antes da posição da linha especificada.
insertRowsAfter(afterPosition, howMany)SheetInsere um número de linhas após a posição da linha especificada.
insertRowsBefore(beforePosition, howMany)SheetInsere um número de linhas antes da posição da linha especificada.
insertSheet()SheetInsere uma nova página na planilha usando um nome de página padrão.
insertSheet(sheetIndex)SheetInsere uma nova página na planilha com o índice especificado.
insertSheet(sheetIndex, options)SheetInsere uma nova página na planilha com o índice especificado e usa recursos avançados opcionais .
insertSheet(options)SheetInsere uma nova página na planilha, usando um nome de página padrão e opções de recursos avançados .
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 no índice especificado.
insertSheet(sheetName, sheetIndex, options)SheetInsere uma nova página na planilha com o nome determinado 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 opções avançadas .
insertSheetWithDataSourceTable(spec)SheetInsere uma nova página na planilha, cria uma DataSourceTable abrangendo a planilha inteira com a especificação de fonte de dados especificada e inicia a execução dos dados.
isColumnHiddenByUser(columnPosition)BooleanRetorna se a coluna especificada está oculta para o usuário.
isIterativeCalculationEnabled()BooleanInforma se o cálculo iterativo está ativado na planilha.
isRowHiddenByFilter(rowPosition)BooleanRetorna indicando se a linha especificada está oculta por um filtro (não por uma visualização de filtro).
isRowHiddenByUser(rowPosition)BooleanRetorna se a linha especificada está oculta para o usuário.
moveActiveSheet(pos)voidMove a página ativa para a posição especificada na lista de páginas.
moveChartToObjectSheet(chart)SheetCria uma nova planilha SheetType.OBJECT e move o gráfico fornecido para ela.
refreshAllDataSources()voidAtualiza todas as fontes de dados compatíveis e os objetos das fontes de dados vinculadas, ignorando as objetos da fonte de dados.
removeEditor(emailAddress)SpreadsheetRemove o usuário especificado da lista de editores do Spreadsheet.
removeEditor(user)SpreadsheetRemove o usuário especificado 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 informado.
removeViewer(emailAddress)SpreadsheetRemove o usuário especificado da lista de leitores e comentadores do Spreadsheet.
removeViewer(user)SpreadsheetRemove o usuário especificado da lista de leitores e comentadores do Spreadsheet.
rename(newName)voidRenomeia o documento.
renameActiveSheet(newName)voidRenomeia a página ativa atual com o novo nome fornecido.
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 de intervalos especificada como o active ranges no 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 especificada como a página ativa na planilha.
setActiveSheet(sheet, restoreSelection)SheetDefine a página especificada como ativa na planilha, com uma opção para restaurar a seleção mais recente naquela planilha.
setColumnWidth(columnPosition, width)SheetDefine a largura da coluna em pixels.
setCurrentCell(cell)RangeDefine a célula especificada como a 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 limite mínimo para cálculos iterativos.
setIterativeCalculationEnabled(isEnabled)SpreadsheetDefine se o cálculo iterativo será ativado nesta planilha.
setMaxIterativeCalculationCycles(maxIterations)SpreadsheetDefine o número máximo de iterações de cálculo que precisam ser realizadas durante as iterações cálculo.
setNamedRange(name, range)voidNomeie um intervalo.
setRecalculationInterval(recalculationInterval)SpreadsheetDefine com que frequência esta planilha deve ser recalculada.
setRowHeight(rowPosition, height)SheetDefine a altura da linha especificada 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)voidMostra um componente personalizado da interface do usuário em uma caixa de diálogo centralizada no navegador do usuário janela de visualização.
sort(columnPosition)SheetClassifica uma planilha por coluna, em ordem crescente.
sort(columnPosition, ascending)SheetClassifica uma planilha 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 especificada e título.
toast(msg, title, timeoutSeconds)voidMostra uma janela pop-up no canto inferior direito da planilha com o título fornecido e 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, expirando após o em segundos fornecido.

Documentação detalhada

addDeveloperMetadata(key)

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

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

// Adds the key 'NAME' in the developer metadata for the spreadsheet.
ss.addDeveloperMetadata('NAME')

// Gets the first developer metadata object and logs its key.
const developerMetaData = ss.getDeveloperMetadata()[0]
console.log(developerMetaData.getKey())

Parâmetros

NomeTipoDescrição
keyStringA chave para os novos metadados do desenvolvedor.

Retornar

Spreadsheet: esta planilha, para encadeamento.

Autorização

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

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

addDeveloperMetadata(key, visibility)

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

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

// Adds the key 'NAME' in the developer metadata for the spreadsheet and sets the visibility
// to the developer project that created the metadata.
ss.addDeveloperMetadata('NAME', SpreadsheetApp.DeveloperMetadataVisibility.PROJECT);

// Gets the first developer metadata object and logs its key and visibility setting.
const developerMetaData = ss.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(`Key: ${developerMetaData.getKey()},
.             Visibility: ${developerMetaData.getVisibility()}`);

Parâmetros

NomeTipoDescrição
keyStringA chave para os 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 precisam de autorização com um ou mais dos seguintes escopos:

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

addDeveloperMetadata(key, value)

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

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

// Adds the key 'NAME' and sets the value to 'GOOGLE' in the developer metadata for the
// spreadsheet.
ss.addDeveloperMetadata('NAME', 'GOOGLE');

// Gets the first developer metadata object and logs its key and value.
const developerMetaData = ss.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(`Key: ${developerMetaData.getKey()}, Value: ${developerMetaData.getValue()}`);

Parâmetros

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

Retornar

Spreadsheet: esta planilha, para encadeamento.

Autorização

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

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

addDeveloperMetadata(key, value, visibility)

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

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

// Adds the key 'NAME', sets the value to 'GOOGLE', and sets the visibility
// to any developer project with document access.
ss.addDeveloperMetadata('NAME', 'GOOGLE', SpreadsheetApp.DeveloperMetadataVisibility.DOCUMENT);

// Gets the first developer metadata object and logs its key, value, and visibility setting.
const developerMetaData = ss.getDeveloperMetadata()[0];
console.log(`Key: ${developerMetaData.getKey()},
             Value: ${developerMetaData.getValue()},
             Visibility: ${developerMetaData.getVisibility()}`);

Parâmetros

NomeTipoDescrição
keyStringA chave para os novos metadados do 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 precisam de 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á estava na lista de visualizadores, esse método promove o usuário para fora da lista de leitores.

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 precisam de 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á estava na lista de visualizadores, esse método promove o usuário para fora da lista de leitores.

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 precisam de 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á estavam na lista de visualizadores, este método os promove para fora da lista de os espectadores.

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 precisam de 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 interface da planilha.

Cada entrada de menu executa uma função definida pelo usuário. Normalmente, é melhor chamá-la pela 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
nameStringNome do menu a ser criado.
subMenusObject[]Uma matriz de mapas JavaScript com os parâmetros name e functionName . É possível usar funções de bibliotecas incluídas, como Library.libFunction1.

Autorização

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

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

addViewer(emailAddress)

Adiciona o usuário especificado à lista de leitores do Spreadsheet. Se o usuário já estava na lista de editores, esse método não terá efeito.

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 precisam de 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 leitores do Spreadsheet. Se o usuário já estava na lista de editores, esse método não terá efeito.

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 precisam de 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 leitores para Spreadsheet. Se algum dos usuários já estavam na lista de editores, este método não 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 precisam de 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 na planilha. Se o conteúdo de uma célula começar com =, isso será interpretado como uma fórmula.

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 da página.

Retornar

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

Autorização

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

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

autoResizeColumn(columnPosition)

Define a largura da coluna para ajustar o conteúdo dela.

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 o encadeamento de métodos.

Autorização

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

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

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
nameStringO nome da cópia.

Retornar

Spreadsheet: esta planilha, para encadeamento.

Autorização

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

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

createDeveloperMetadataFinder()

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

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

// Adds developer metadata to the spreadsheet.
ss.addDeveloperMetadata('NAME', 'CHARLIE');
ss.addDeveloperMetadata('COMPANY', 'EXAMPLE ORGANIZATION');
ss.addDeveloperMetadata('TECHNOLOGY', 'JAVASCRIPT');

// Creates a developer metadata finder.
const developerMetadataFinder = ss.createDeveloperMetadataFinder();

// Finds the developer metadata objects with 'COMPANY' as the key.
const googleMetadataFromSpreadsheet = developerMetadataFinder.withKey('COMPANY').find();

// Gets the first result of developer metadata that has the key 'COMPANY' and logs its value.
console.log(googleMetadataFromSpreadsheet[0].getValue());

Retornar

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


createTextFinder(findText)

Cria um localizador de textos para a planilha, que pode ser usado para localizar e substituir texto na planilha. 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 precisam de 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 de 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 o encadeamento de métodos.

Autorização

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

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

deleteColumns(columnPosition, howMany)

Exclui várias colunas a partir da posição da 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 precisam de 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 de 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 para a primeira linha.

Retornar

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

Autorização

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

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

deleteRows(rowPosition, howMany)

Exclui várias linhas a partir da posição da 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 precisam de 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 precisam de autorização com um ou mais dos seguintes escopos:

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

duplicateActiveSheet()

Duplica a planilha ativa e a torna 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 precisam de 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 na página.

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

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 precisam de 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 quando não há um intervalo ativo. Se vários intervalos são selecionados este método retorna apenas o último intervalo selecionado.

O termo "intervalo ativo" refere-se ao intervalo que um usuário selecionou na página ativa, mas em uma função personalizada se refere à célula que está 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 precisam de autorização com um ou mais dos seguintes escopos:

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

Consulte também


getActiveRangeList()

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

Se um único intervalo for selecionado, a chamada getActiveRange() vai se comportar como um todo.

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

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

Consulte também


getActiveSheet()

Acessa a página ativa de uma planilha.

A página ativa em uma planilha é a página que está sendo exibida na planilha de ML pela IU.

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 no tipo de conteúdo especificado. Isso adiciona a extensão adequada ao nome do arquivo, por exemplo, "myfile.pdf". No entanto, pressupõe que a parte do nome do arquivo que segue o ponto final (se houver) é uma que deve ser substituída. Consequentemente, "ShoppingList.12.25.2014" se torna "ListaShopping.12.25.pdf".

Para acessar as cotas diárias para conversões, consulte Cotas do Google Serviços. Os domínios do Google Workspace recém-criados podem estar temporariamente sujeitos a medidas cotas.

Parâmetros

NomeTipoDescrição
contentTypeStringO tipo MIME em que a conversão será feita. 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 valores 'image/bmp', 'image/gif', 'image/jpeg' ou 'image/png' também precisa ser válidos. Para um documento do Documentos Google, 'text/markdown' também é válido.

Retornar

Blob: os dados como um blob.


getBandings()

Retorna todas as faixas da planilha.

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

// Gets an array of the bandings in the spreadsheet.
const bandings = ss.getBandings();

// Logs the range of the first banding in the spreadsheet to the console.
console.log(bandings[0].getRange().getA1Notation());

Retornar

Banding[]: as faixas da planilha.

Autorização

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

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

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 precisam de 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 na página ativa ou null se não houver uma célula atual. A a célula atual é a célula em foco na interface do Planilhas Google, destacada por um ícone borda. Nunca há mais de uma célula atual. Quando um usuário seleciona um ou mais intervalos de células, uma das células na seleção é a célula 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 precisam de 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 é funcionalmente equivalente a criar um Range 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 da planilha.

Autorização

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

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

getDataSourceFormulas()

Recebe todas as fórmulas da fonte de dados.

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

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

// Gets an array of the data source formulas on Sheet1.
// To get an array of data source formulas for the entire spreadsheet,
// replace 'sheet' with 'ss'.
const dataSourceFormulas = sheet.getDataSourceFormulas();

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

Retornar

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

Autorização

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

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

getDataSourcePivotTables()

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

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

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

// Gets an array of the data source pivot tables on Sheet1.
// To get an array of data source pivot tables for the entire
// spreadsheet, replace 'sheet' with 'ss'.
const dataSourcePivotTables = sheet.getDataSourcePivotTables();

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

Retornar

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

Autorização

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

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

getDataSourceRefreshSchedules()

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

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

// Activates BigQuery operations for the connected spreadsheet.
SpreadsheetApp.enableBigQueryExecution();

// Gets the frequency type of the first referesh schedule in the array.
const frequencyType = ss.getDataSourceRefreshSchedules()[0]
                        .getFrequency()
                        .getFrequencyType()
                        .toString();

// Logs the frequency type to the console.
console.log(frequencyType);

Retornar

DataSourceRefreshSchedule[]: as programações de atualização desta planilha.

Autorização

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

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

getDataSourceSheets()

Retorna todas as páginas de fonte de dados da planilha.

// Turns data execution on for BigQuery data sources.
SpreadsheetApp.enableBigQueryExecution();

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

// Gets the first data source sheet in the spreadsheet.
const dataSource = ss.getDataSourceSheets()[0];

// Gets the name of the data source sheet.
console.log(dataSource.asSheet().getName());

Retornar

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

Autorização

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

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

getDataSourceTables()

Recebe todas as tabelas da fonte de dados.

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

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

// Gets an array of data source tables on Sheet1.
// To get an array of data source tables for the entire spreadsheet,
// replace 'sheet' with 'ss'.
const dataSourceTables = sheet.getDataSourceTables();

// Logs the last completed data execution time on the first data source table.
console.log(dataSourceTables[0].getStatus().getLastExecutionTime());

Retornar

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

Autorização

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

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

getDataSources()

Retorna todas as fontes de dados na planilha.

// Turns data execution on for BigQuery data sources.
SpreadsheetApp.enableBigQueryExecution();

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

// Gets the data sources on the spreadsheet.
const dataSources = ss.getDataSources();

// Logs the name of the first column on the first data source.
console.log(dataSources[0].getColumns()[0].getName());

Retornar

DataSource[]: uma matriz de todas as fontes de dados.

Autorização

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

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

getDeveloperMetadata()

Recebe os metadados do desenvolvedor associados à planilha de nível superior.

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

// Adds 'Google' as a key to the spreadsheet metadata.
ss.addDeveloperMetadata('Google');

// Gets the spreadsheet's metadata.
const ssMetadata = ss.getDeveloperMetadata();

// Gets the first set of the spreadsheet's metadata and logs the key to the console.
console.log(ssMetadata[0].getKey());

Retornar

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

Autorização

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

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

getEditors()

Recebe a lista de editores desse Spreadsheet.

Retornar

User[]: uma matriz de usuários com permissão para edição.

Autorização

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

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

getFormUrl()

Retorna o URL do formulário que envia as respostas para essa planilha, ou null se esta planilha não tem nenhum formulário associado. Se vários formulários enviarem respostas para esta planilha, o URL do formulário retornado for indeterminado. Como alternativa, as associações de URL de formulário por planilha podem recuperados pelo método Sheet.getFormUrl().

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

// Gets the form URL from the spreadsheet.
const formUrl = ss.getFormUrl();

// Logs the form URL to the console.
console.log(formUrl);

Retornar

String: o URL do formulário que coloca as respostas nessa planilha, ou null se esta planilha não tem um formulário associado.

Autorização

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

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

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 precisam de 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 precisam de 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 desta planilha. Um ID de planilha pode ser extraído do URL. Por exemplo, o código 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 sobre a grade na página.

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

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

// Gets the over-the-grid images from Sheet1.
// To get the over-the-grid images from the entire spreadsheet, use ss.getImages() instead.
const images = sheet.getImages();

// For each image, logs the anchor cell in A1 notation.
for (const image of images) {
 console.log(image.getAnchorCell().getA1Notation());
}

Retornar

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

Autorização

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

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

getIterativeCalculationConvergenceThreshold()

Retorna o valor do limite usado durante o cálculo iterativo. Quando os resultados de sucessivas diferente por menos que esse valor, o cálculo iterativo é interrompido.

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

// Sets the iterative calculation convergence threshold for the spreadsheet.
ss.setIterativeCalculationConvergenceThreshold(2);

// Logs the threshold to the console.
console.log(ss.getIterativeCalculationConvergenceThreshold());

Retornar

Number: o limite de convergência.

Autorização

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

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

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 o conteúdo

Autorização

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

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

getLastRow()

Retorna a posição da última linha 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 linha da página que contém o conteúdo.

Autorização

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

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

getMaxIterativeCalculationCycles()

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

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

// Sets the max iterative calculation cycles for the spreadsheet.
ss.setMaxIterativeCalculationCycles(10);

// Logs the max iterative calculation cycles to the console.
console.log(ss.getMaxIterativeCalculationCycles());

Retornar

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

Autorização

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

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

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 precisam de 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 na 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 precisam de 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 da planilha.


getOwner()

Retorna o proprietário do documento ou null de 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 precisam de 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 precisam de 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 que representam todas as páginas ou intervalos protegidos na planilha.

Autorização

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

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

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 precisam de 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 fornecido for encontrado. Se várias páginas da planilha usem o mesmo nome de intervalo, especifique o nome da página sem detalhes aspas, 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 obtido.

Retornar

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


getRangeList(a1Notations)

Retorna a coleção RangeList que representa os intervalos na mesma página especificada. por uma lista não vazia de notaçõ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 precisam de 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.

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

// Logs the calculation interval for the spreadsheet to the console.
console.log(ss.getRecalculationInterval().toString());

Retornar

RecalculationInterval: o intervalo de cálculo da planilha.

Autorização

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

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

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 precisam de 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 precisam de 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. Retorna null se não há nenhuma 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 planilha a ser acessada.

Retornar

Sheet: a página com o nome informado.


getSheetId()

Retorna o ID da planilha representada por este objeto.

Este é um ID para a página, que é exclusivo da planilha. O ID é uma sequência monotonicamente número inteiro crescente atribuído no momento de criação da página, que é independente da posição dela. 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 de Sheet.

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

Logger.log(sheet.getSheetId());

Retornar

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

Autorização

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

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

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 precisam de 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 para este intervalo, começando nas coordenadas fornecidas. A -1 dado como a posição da linha ou coluna é equivalente a obter a última linha ou coluna que contém dados na planilha.

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
startRowIntegerA posição da linha inicial.
startColumnIntegerA posição da coluna inicial.
numRowsIntegerO número de linhas para retornar valores.
numColumnsIntegerO número de colunas para as quais retornar valores.

Retornar

Object[][]: uma matriz bidimensional de valores

Autorização

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

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

getSheets()

Extrai 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.

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

// Gets the spreadsheet locale.
const ssLocale = ss.getSpreadsheetLocale();

// Logs the locale to the console.
console.log(ssLocale);

Retornar

String: a localidade da planilha.

Autorização

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

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

getSpreadsheetTheme()

Retorna o tema atual da planilha ou null se nenhum tema for 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 precisam de autorização com um ou mais dos seguintes escopos:

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

getSpreadsheetTimeZone()

Acessa o fuso horário da planilha.

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

// Sets the time zone of the spreadsheet.
ss.setSpreadsheetTimeZone('America/New_York');

// Gets the time zone of the spreadsheet.
const ssTimeZone = ss.getSpreadsheetTimeZone();

// Logs the time zone to the console.
console.log(ssTimeZone);

Retornar

String: o fuso horário, especificado em "longo" formato (por exemplo, "America/New_York", conforme listado por Joda.org).

Autorização

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

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

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 precisam de 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 comentadores deste Spreadsheet.

Retornar

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

Autorização

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

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

hideColumn(column)

Oculta a coluna ou 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 precisam de 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 do 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 precisam de 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 depois da 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
afterPositionIntegerA coluna depois da qual a nova coluna deve ser adicionada.

Retornar

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

Autorização

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

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

insertColumnBefore(beforePosition)

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

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 o encadeamento de métodos.

Autorização

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

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

insertColumnsAfter(afterPosition, howMany)

Insere um determinado número de colunas após a posição de coluna especificada.

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

// Inserts two columns after the first column on the first sheet of the spreadsheet.
sheet.insertColumnsAfter(1,2);

Parâmetros

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

Retornar

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

Autorização

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

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

insertColumnsBefore(beforePosition, howMany)

Insere algumas 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 o encadeamento de métodos.

Autorização

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

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

insertDataSourceSheet(spec)

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

Lança uma exceção se o tipo de fonte de dados não estiver ativado. Usar métodos SpreadsheetApp#enable...Execution() para ativar a execução de dados em uma fonte de dados específica não é válido.

// Activates BigQuery operations.
SpreadsheetApp.enableBigQueryExecution();

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

// Builds a data source specification.
// TODO (developer): Update the project ID to your own Google Cloud project ID.
const dataSourceSpec = SpreadsheetApp.newDataSourceSpec()
 .asBigQuery()
 .setProjectId('project-id-1')
 .setTableProjectId('bigquery-public-data')
 .setDatasetId('ncaa_basketball')
 .setTableId('mbb_historical_teams_games')
 .build();

// Adds the data source and its data to the spreadsheet.
ss.insertDataSourceSheet(dataSourceSpec);

Parâmetros

NomeTipoDescrição
specDataSourceSpecA especificação da fonte de dados com a qual inserir.

Retornar

DataSourceSheet: a nova página de fonte de dados.

Autorização

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

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

insertImage(blobSource, column, row)

Insere uma Spreadsheet como uma imagem no documento em uma determinada linha e coluna. A imagem tamanho é recuperado do conteúdo do blob. O tamanho máximo de blob aceito é de 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, opcionalmente, o nome.
columnIntegerA posição da coluna.
rowIntegerA posição da linha.

Retornar

OverGridImage: a imagem inserida.

Autorização

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

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

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

Insere um Spreadsheet como uma imagem no documento em uma determinada linha e coluna, com um deslocamento de pixels. O tamanho da imagem é recuperado do conteúdo do blob. O blob máximo com suporte tem 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, opcionalmente, o nome.
columnIntegerA posição da coluna.
rowIntegerA posiçã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 precisam de autorização com um ou mais dos seguintes escopos:

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

insertImage(url, column, row)

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

O URL informado precisa ser acessível publicamente.

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

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

Parâmetros

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

Retornar

OverGridImage: a imagem inserida.

Autorização

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

O URL informado precisa ser acessível publicamente.

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

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

Parâmetros

NomeTipoDescrição
urlStringO URL da imagem.
columnIntegerA posição da coluna.
rowIntegerA posiçã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 precisam de 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 depois da qual a nova linha deve ser adicionada.

Retornar

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

Autorização

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

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

insertRowBefore(beforePosition)

Insere uma linha antes da posição da 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 o encadeamento de métodos.

Autorização

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

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

insertRowsAfter(afterPosition, howMany)

Insere um número de 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 depois da qual as novas linhas devem ser adicionadas.
howManyIntegerO número de linhas a serem inseridas.

Retornar

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

Autorização

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

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

insertRowsBefore(beforePosition, howMany)

Insere um número de linhas antes da posição da 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 o encadeamento de métodos.

Autorização

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

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

insertSheet()

Insere uma nova página na planilha usando um nome de página padrão. A nova planilha se torna o página ativa.

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

Retornar

Sheet: a nova página.

Autorização

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

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

insertSheet(sheetIndex)

Insere uma nova página na planilha com o índice especificado. A nova planilha se torna ativa folha

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

Parâmetros

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

Retornar

Sheet: a nova página.

Autorização

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

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

insertSheet(sheetIndex, options)

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

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

Parâmetros

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

Parâmetros avançados

NomeTipoDescrição
templateSheetTodos os dados do objeto da folha de modelo são copiados para o nova planilha. O modelo precisa ser uma das folhas do objeto "Planilha".

Retornar

Sheet: a nova página.

Autorização

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

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

insertSheet(options)

Insere uma nova página na planilha, usando um nome de página padrão e opções de recursos avançados . A nova planilha se torna a página ativa.

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

Parâmetros

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

Parâmetros avançados

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

Retornar

Sheet: a nova página.

Autorização

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

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

insertSheet(sheetName)

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

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

Parâmetros

NomeTipoDescrição
sheetNameStringO nome da nova planilha.

Retornar

Sheet: a nova página.

Autorização

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

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

insertSheet(sheetName, sheetIndex)

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

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

Parâmetros

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

Retornar

Sheet: a nova página.

Autorização

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

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

insertSheet(sheetName, sheetIndex, options)

Insere uma nova página na planilha com o nome determinado no índice especificado e usa argumentos avançados opcionais. A nova planilha se torna a página 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 planilha.
sheetIndexIntegerO índice da página recém-inserida. Para inserir uma planilha como a primeira em em uma planilha, defina-o como 0.
optionsObjectArgumentos avançados de JavaScript opcionais.

Parâmetros avançados

NomeTipoDescrição
templateSheetTodos os dados do objeto da folha de modelo são copiados para o nova planilha. O modelo precisa ser uma das folhas do objeto "Planilha".

Retornar

Sheet: a nova página.

Autorização

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

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

insertSheet(sheetName, options)

Insere uma nova página na planilha com o nome fornecido e usa opções avançadas . A nova planilha se torna a página 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 planilha.
optionsObjectArgumentos avançados de JavaScript opcionais.

Parâmetros avançados

NomeTipoDescrição
templateSheetTodos os dados do objeto da folha de modelo são copiados para o nova planilha. O modelo precisa ser uma das folhas do objeto "Planilha".

Retornar

Sheet: a nova página.

Autorização

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

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

insertSheetWithDataSourceTable(spec)

Insere uma nova página na planilha, cria uma DataSourceTable abrangendo a planilha inteira com a especificação de fonte de dados especificada e inicia a execução dos dados. Como um lado torna a nova página a página ativa.

Lança uma exceção se o tipo de fonte de dados não estiver ativado. Usar métodos SpreadsheetApp#enable...Execution() para ativar a execução de dados em uma fonte de dados específica não é válido.

// Activates BigQuery operations.
SpreadsheetApp.enableBigQueryExecution();

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

// Adds a sheet and sets cell A1 as the parameter cell.
const parameterCell = ss.insertSheet('parameterSheet').getRange('A1');

// Sets the value of the parameter cell to 'Duke'.
parameterCell.setValue('Duke');

const query = 'select * from `bigquery-public-data`.`ncaa_basketball`.' +
  '`mbb_historical_tournament_games` WHERE win_school_ncaa = @SCHOOL';

// Adds a data source with a query parameter.
// TODO(developer): Update the project ID to your own Google Cloud project ID.
const dataSourceSpec = SpreadsheetApp.newDataSourceSpec()
 .asBigQuery()
 .setProjectId('project-id-1')
 .setRawQuery(query)
 .setParameterFromCell('SCHOOL', 'parameterSheet!A1')
 .build();

// Adds sheets for the data source and data source table to the spreadsheet.
ss.insertSheetWithDataSourceTable(dataSourceSpec);

Parâmetros

NomeTipoDescrição
specDataSourceSpecA especificação da fonte de dados com a qual inserir.

Retornar

Sheet: a nova página.

Autorização

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

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

isColumnHiddenByUser(columnPosition)

Retorna se a coluna especificada está oculta para o 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

Booleantrue se a coluna estiver oculta. Caso contrário, false.

Autorização

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

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

isIterativeCalculationEnabled()

Informa se o cálculo iterativo está ativado na planilha.

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

// Activates iterative calculation on the spreadsheet.
ss.setIterativeCalculationEnabled(true);

// Logs whether iterative calculation is activated for the spreadsheet.
console.log(ss.isIterativeCalculationEnabled());

Retornar

Boolean: true se o cálculo iterativo estiver ativado. Caso contrário, false.

Autorização

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

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

isRowHiddenByFilter(rowPosition)

Retorna indicando se a linha especificada está oculta por um filtro (não por uma visualização de 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, false.

Autorização

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

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

isRowHiddenByUser(rowPosition)

Retorna se a linha especificada está oculta para o 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, false.

Autorização

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

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

moveActiveSheet(pos)

Move a página ativa para a posição especificada na lista de páginas. Gera uma exceção se o position é negativo ou maior que o número de folhas.

// 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 precisam de 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 planilha SheetType.OBJECT e move o gráfico fornecido para ela. Se o gráfico já estiver na própria planilha, essa planilha será retornada sem criar 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 precisam de 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 objetos das fontes de dados vinculadas, ignorando as objetos da fonte de dados.

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

// Activates BigQuery operations.
SpreadsheetApp.enableBigQueryExecution();

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with