Acessar e modificar arquivos do Planilhas Google. As operações comuns são adicionar novas páginas colaboradores.
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
addDeveloperMetadata(key) | Spreadsheet | Adiciona metadados do desenvolvedor com a chave especificada à planilha de nível superior. |
addDeveloperMetadata(key, visibility) | Spreadsheet | Adiciona metadados do desenvolvedor com a chave e visibilidade especificadas à planilha. |
addDeveloperMetadata(key, value) | Spreadsheet | Adiciona metadados do desenvolvedor com a chave e o valor especificados à planilha. |
addDeveloperMetadata(key, value, visibility) | Spreadsheet | Adiciona metadados do desenvolvedor com a chave, o valor e a visibilidade especificados à planilha. |
addEditor(emailAddress) | Spreadsheet | Adiciona o usuário especificado à lista de editores do Spreadsheet . |
addEditor(user) | Spreadsheet | Adiciona o usuário especificado à lista de editores do Spreadsheet . |
addEditors(emailAddresses) | Spreadsheet | Adiciona a matriz de usuários especificada à lista de editores do Spreadsheet . |
addMenu(name, subMenus) | void | Cria um novo menu na interface da planilha. |
addViewer(emailAddress) | Spreadsheet | Adiciona o usuário especificado à lista de leitores do Spreadsheet . |
addViewer(user) | Spreadsheet | Adiciona o usuário especificado à lista de leitores do Spreadsheet . |
addViewers(emailAddresses) | Spreadsheet | Adiciona a matriz de usuários especificada à lista de leitores para Spreadsheet . |
appendRow(rowContents) | Sheet | Anexa uma linha à parte inferior da região de dados atual na planilha. |
autoResizeColumn(columnPosition) | Sheet | Define a largura da coluna para ajustar o conteúdo dela. |
copy(name) | Spreadsheet | Copia a planilha e retorna a nova. |
createDeveloperMetadataFinder() | DeveloperMetadataFinder | Retorna um DeveloperMetadataFinder para encontrar metadados do desenvolvedor no escopo de
nesta planilha. |
createTextFinder(findText) | TextFinder | Cria um localizador de textos para a planilha, que pode ser usado para localizar e substituir texto na planilha. |
deleteActiveSheet() | Sheet | Exclui a página ativa no momento. |
deleteColumn(columnPosition) | Sheet | Exclui a coluna na posição de coluna especificada. |
deleteColumns(columnPosition, howMany) | void | Exclui várias colunas a partir da posição da coluna especificada. |
deleteRow(rowPosition) | Sheet | Exclui a linha na posição de linha especificada. |
deleteRows(rowPosition, howMany) | void | Exclui várias linhas a partir da posição da linha especificada. |
deleteSheet(sheet) | void | Exclui a página especificada. |
duplicateActiveSheet() | Sheet | Duplica a planilha ativa e a torna ativa. |
getActiveCell() | Range | Retorna a célula ativa na página. |
getActiveRange() | Range | Retorna o intervalo selecionado na página ativa ou null quando não há um intervalo ativo. |
getActiveRangeList() | RangeList | Retorna a lista de intervalos ativos na página ativa ou null se não houver intervalos ativos
intervalos. |
getActiveSheet() | Sheet | Acessa a página ativa de uma planilha. |
getAs(contentType) | Blob | Retorna os dados dentro desse objeto como um blob convertido no tipo de conteúdo especificado. |
getBandings() | Banding[] | Retorna todas as faixas da planilha. |
getBlob() | Blob | Retorne os dados dentro desse objeto como um blob. |
getColumnWidth(columnPosition) | Integer | Recebe a largura em pixels da coluna especificada. |
getCurrentCell() | Range | Retorna a célula atual na página ativa ou null se não houver uma célula atual. |
getDataRange() | Range | Retorna 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() | String | 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. |
getFrozenColumns() | Integer | Retorna o número de colunas congeladas. |
getFrozenRows() | Integer | Retorna o número de linhas congeladas. |
getId() | String | Recebe um identificador exclusivo desta planilha. |
getImages() | OverGridImage[] | Retorna todas as imagens sobre a grade na página. |
getIterativeCalculationConvergenceThreshold() | Number | Retorna o valor do limite usado durante o cálculo iterativo. |
getLastColumn() | Integer | Retorna a posição da última coluna que tem conteúdo. |
getLastRow() | Integer | Retorna a posição da última linha que tem conteúdo. |
getMaxIterativeCalculationCycles() | Integer | Retorna o número máximo de iterações a serem usadas durante o cálculo iterativo. |
getName() | String | Recebe o nome do documento. |
getNamedRanges() | NamedRange[] | Recebe todos os intervalos nomeados na planilha. |
getNumSheets() | Integer | Retorna o número de páginas nesta planilha. |
getOwner() | User | Retorna 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) | Range | Retorna o intervalo conforme especificado na notação A1 ou R1C1. |
getRangeByName(name) | Range | Retorna um intervalo nomeado ou null se nenhum intervalo com o nome fornecido for encontrado. |
getRangeList(a1Notations) | RangeList | 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. |
getRecalculationInterval() | RecalculationInterval | Retorna o intervalo de cálculo da planilha. |
getRowHeight(rowPosition) | Integer | Recebe a altura em pixels da linha especificada. |
getSelection() | Selection | Retorna o Selection atual na planilha. |
getSheetByName(name) | Sheet | Retorna uma página com o nome informado. |
getSheetId() | Integer | Retorna o ID da planilha representada por este objeto. |
getSheetName() | String | Retorna 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() | String | Recebe a localidade da planilha. |
getSpreadsheetTheme() | SpreadsheetTheme | Retorna o tema atual da planilha ou null se nenhum tema for aplicado. |
getSpreadsheetTimeZone() | String | Acessa o fuso horário da planilha. |
getUrl() | String | Retorna o URL da planilha especificada. |
getViewers() | User[] | Recebe a lista de leitores e comentadores deste Spreadsheet . |
hideColumn(column) | void | Oculta a coluna ou colunas no intervalo especificado. |
hideRow(row) | void | Oculta as linhas do intervalo especificado. |
insertColumnAfter(afterPosition) | Sheet | Insere uma coluna depois da posição da coluna especificada. |
insertColumnBefore(beforePosition) | Sheet | Insere uma coluna antes da posição da coluna especificada. |
insertColumnsAfter(afterPosition, howMany) | Sheet | Insere um determinado número de colunas após a posição de coluna especificada. |
insertColumnsBefore(beforePosition, howMany) | Sheet | Insere algumas colunas antes da posição da coluna especificada. |
insertDataSourceSheet(spec) | DataSourceSheet | Insere um novo DataSourceSheet na planilha e inicia a execução dos dados. |
insertImage(blobSource, column, row) | OverGridImage | Insere uma Spreadsheet como uma imagem no documento em uma determinada linha e coluna. |
insertImage(blobSource, column, row, offsetX, offsetY) | OverGridImage | Insere um Spreadsheet como uma imagem no documento em uma determinada linha e coluna, com um
deslocamento de pixels. |
insertImage(url, column, row) | OverGridImage | Insere uma imagem no documento em uma determinada linha e coluna. |
insertImage(url, column, row, offsetX, offsetY) | OverGridImage | Insere uma imagem no documento em uma determinada linha e coluna, com um deslocamento de pixel. |
insertRowAfter(afterPosition) | Sheet | Insere uma linha após a posição da linha especificada. |
insertRowBefore(beforePosition) | Sheet | Insere uma linha antes da posição da linha especificada. |
insertRowsAfter(afterPosition, howMany) | Sheet | Insere um número de linhas após a posição da linha especificada. |
insertRowsBefore(beforePosition, howMany) | Sheet | Insere um número de linhas antes da posição da linha especificada. |
insertSheet() | Sheet | Insere uma nova página na planilha usando um nome de página padrão. |
insertSheet(sheetIndex) | Sheet | Insere uma nova página na planilha com o índice especificado. |
insertSheet(sheetIndex, options) | Sheet | Insere uma nova página na planilha com o índice especificado e usa recursos avançados opcionais . |
insertSheet(options) | Sheet | Insere uma nova página na planilha, usando um nome de página padrão e opções de recursos avançados . |
insertSheet(sheetName) | Sheet | Insere uma nova página na planilha com o nome fornecido. |
insertSheet(sheetName, sheetIndex) | Sheet | Insere uma nova página na planilha com o nome no índice especificado. |
insertSheet(sheetName, sheetIndex, options) | Sheet | Insere uma nova página na planilha com o nome determinado no índice especificado e usa argumentos avançados opcionais. |
insertSheet(sheetName, options) | Sheet | Insere uma nova página na planilha com o nome fornecido e usa opções avançadas . |
insertSheetWithDataSourceTable(spec) | Sheet | 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. |
isColumnHiddenByUser(columnPosition) | Boolean | Retorna se a coluna especificada está oculta para o usuário. |
isIterativeCalculationEnabled() | Boolean | Informa se o cálculo iterativo está ativado na planilha. |
isRowHiddenByFilter(rowPosition) | Boolean | Retorna indicando se a linha especificada está oculta por um filtro (não por uma visualização de filtro). |
isRowHiddenByUser(rowPosition) | Boolean | Retorna se a linha especificada está oculta para o usuário. |
moveActiveSheet(pos) | void | Move a página ativa para a posição especificada na lista de páginas. |
moveChartToObjectSheet(chart) | Sheet | Cria uma nova planilha SheetType.OBJECT e move o gráfico fornecido para ela. |
refreshAllDataSources() | void | Atualiza todas as fontes de dados compatíveis e os objetos das fontes de dados vinculadas, ignorando as objetos da fonte de dados. |
removeEditor(emailAddress) | Spreadsheet | Remove o usuário especificado da lista de editores do Spreadsheet . |
removeEditor(user) | Spreadsheet | Remove o usuário especificado da lista de editores do Spreadsheet . |
removeMenu(name) | void | Remove um menu adicionado por addMenu(name, subMenus) . |
removeNamedRange(name) | void | Exclui um intervalo nomeado com o nome informado. |
removeViewer(emailAddress) | Spreadsheet | Remove o usuário especificado da lista de leitores e comentadores do Spreadsheet . |
removeViewer(user) | Spreadsheet | Remove o usuário especificado da lista de leitores e comentadores do Spreadsheet . |
rename(newName) | void | Renomeia o documento. |
renameActiveSheet(newName) | void | Renomeia a página ativa atual com o novo nome fornecido. |
resetSpreadsheetTheme() | SpreadsheetTheme | Remove o tema aplicado e define o tema padrão na planilha. |
setActiveRange(range) | Range | Define o intervalo especificado como active range na página ativa, com
a célula superior esquerda no intervalo como current cell . |
setActiveRangeList(rangeList) | RangeList | Define a lista de intervalos especificada como o active ranges no
página ativa. |
setActiveSelection(range) | Range | Define a região de seleção ativa para esta página. |
setActiveSelection(a1Notation) | Range | Define a seleção ativa, conforme especificado na notação A1 ou R1C1. |
setActiveSheet(sheet) | Sheet | Define a página especificada como a página ativa na planilha. |
setActiveSheet(sheet, restoreSelection) | Sheet | Define a página especificada como ativa na planilha, com uma opção para restaurar a seleção mais recente naquela planilha. |
setColumnWidth(columnPosition, width) | Sheet | Define a largura da coluna em pixels. |
setCurrentCell(cell) | Range | Define a célula especificada como a current cell . |
setFrozenColumns(columns) | void | Congela o número fornecido de colunas. |
setFrozenRows(rows) | void | Congela o número fornecido de linhas. |
setIterativeCalculationConvergenceThreshold(minThreshold) | Spreadsheet | Define o valor limite mínimo para cálculos iterativos. |
setIterativeCalculationEnabled(isEnabled) | Spreadsheet | Define se o cálculo iterativo será ativado nesta planilha. |
setMaxIterativeCalculationCycles(maxIterations) | Spreadsheet | Define o número máximo de iterações de cálculo que precisam ser realizadas durante as iterações cálculo. |
setNamedRange(name, range) | void | Nomeie um intervalo. |
setRecalculationInterval(recalculationInterval) | Spreadsheet | Define com que frequência esta planilha deve ser recalculada. |
setRowHeight(rowPosition, height) | Sheet | Define a altura da linha especificada em pixels. |
setSpreadsheetLocale(locale) | void | Define a localidade da planilha. |
setSpreadsheetTheme(theme) | SpreadsheetTheme | Define um tema na planilha. |
setSpreadsheetTimeZone(timezone) | void | Define o fuso horário da planilha. |
show(userInterface) | void | Mostra 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) | Sheet | Classifica uma planilha por coluna, em ordem crescente. |
sort(columnPosition, ascending) | Sheet | Classifica uma planilha por coluna. |
toast(msg) | void | Mostra uma janela pop-up no canto inferior direito da planilha com a mensagem especificada. |
toast(msg, title) | void | Mostra uma janela pop-up no canto inferior direito da planilha com a mensagem especificada e título. |
toast(msg, title, timeoutSeconds) | void | Mostra 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) | void | Reexibe a coluna no intervalo especificado. |
unhideRow(row) | void | Reexibe a linha no intervalo especificado. |
updateMenu(name, subMenus) | void | Atualiza um menu adicionado por addMenu(name, subMenus) . |
waitForAllDataExecutionsCompletion(timeoutInSeconds) | void | Aguarda 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
Nome | Tipo | Descrição |
---|---|---|
key | String | A 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
Nome | Tipo | Descrição |
---|---|---|
key | String | A chave para os novos metadados do desenvolvedor. |
visibility | DeveloperMetadataVisibility | A 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
Nome | Tipo | Descrição |
---|---|---|
key | String | A chave para os novos metadados do desenvolvedor. |
value | String | O 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
Nome | Tipo | Descrição |
---|---|---|
key | String | A chave para os novos metadados do desenvolvedor. |
value | String | O valor dos novos metadados do desenvolvedor. |
visibility | DeveloperMetadataVisibility | A visibilidade dos novos metadados do desenvolvedor. |
Retornar
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
Nome | Tipo | Descrição |
---|---|---|
emailAddress | String | Endereç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
Nome | Tipo | Descrição |
---|---|---|
user | User | Uma 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
Nome | Tipo | Descrição |
---|---|---|
emailAddresses | String[] | 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
Nome | Tipo | Descrição |
---|---|---|
name | String | Nome do menu a ser criado. |
subMenus | Object[] | 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
Nome | Tipo | Descrição |
---|---|---|
emailAddress | String | Endereç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
Nome | Tipo | Descrição |
---|---|---|
user | User | Uma 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
Nome | Tipo | Descrição |
---|---|---|
emailAddresses | String[] | 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
Nome | Tipo | Descrição |
---|---|---|
rowContents | Object[] | 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
Nome | Tipo | Descrição |
---|---|---|
columnPosition | Integer | A 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
Nome | Tipo | Descrição |
---|---|---|
name | String | O 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
Nome | Tipo | Descrição |
---|---|---|
findText | String | O 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
Nome | Tipo | Descrição |
---|---|---|
columnPosition | Integer | A 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
Nome | Tipo | Descrição |
---|---|---|
columnPosition | Integer | A posição da primeira coluna a ser excluída. |
howMany | Integer | O 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
Nome | Tipo | Descrição |
---|---|---|
rowPosition | Integer | A 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
Nome | Tipo | Descrição |
---|---|---|
rowPosition | Integer | A posição da primeira linha a ser excluída. |
howMany | Integer | O 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
Nome | Tipo | Descrição |
---|---|---|
sheet | Sheet | A 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
Nome | Tipo | Descrição |
---|---|---|
contentType | String | O 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()
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
Nome | Tipo | Descrição |
---|---|---|
columnPosition | Integer | A 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
Nome | Tipo | Descrição |
---|---|---|
type | ProtectionType | O 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
Nome | Tipo | Descrição |
---|---|---|
a1Notation | String | O 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
Nome | Tipo | Descrição |
---|---|---|
name | String | O 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
Nome | Tipo | Descrição |
---|---|---|
a1Notations | String[] | 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
Nome | Tipo | Descrição |
---|---|---|
rowPosition | Integer | A 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
Nome | Tipo | Descrição |
---|---|---|
name | String | O 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
Nome | Tipo | Descrição |
---|---|---|
startRow | Integer | A posição da linha inicial. |
startColumn | Integer | A posição da coluna inicial. |
numRows | Integer | O número de linhas para retornar valores. |
numColumns | Integer | O 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
Nome | Tipo | Descrição |
---|---|---|
column | Range | O 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
Nome | Tipo | Descrição |
---|---|---|
row | Range | O 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
Nome | Tipo | Descrição |
---|---|---|
afterPosition | Integer | A 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
Nome | Tipo | Descrição |
---|---|---|
beforePosition | Integer | A 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
Nome | Tipo | Descrição |
---|---|---|
afterPosition | Integer | A coluna depois da qual a nova coluna deve ser adicionada. |
howMany | Integer | O 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
Nome | Tipo | Descrição |
---|---|---|
beforePosition | Integer | A coluna antes da qual a nova coluna deve ser adicionada. |
howMany | Integer | O 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
Nome | Tipo | Descrição |
---|---|---|
spec | DataSourceSpec | A 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
Nome | Tipo | Descrição |
---|---|---|
blobSource | BlobSource | O blob que contém o conteúdo da imagem, o tipo MIME e, opcionalmente, o nome. |
column | Integer | A posição da coluna. |
row | Integer | A 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
Nome | Tipo | Descrição |
---|---|---|
blobSource | BlobSource | O blob que contém o conteúdo da imagem, o tipo MIME e, opcionalmente, o nome. |
column | Integer | A posição da coluna. |
row | Integer | A posição da linha. |
offsetX | Integer | O deslocamento horizontal do canto da célula em pixels. |
offsetY | Integer | O 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
Nome | Tipo | Descrição |
---|---|---|
url | String | É o URL da imagem. |
column | Integer | A posição da coluna da grade. |
row | Integer | A 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
Nome | Tipo | Descrição |
---|---|---|
url | String | O URL da imagem. |
column | Integer | A posição da coluna. |
row | Integer | A posição da linha. |
offsetX | Integer | O deslocamento horizontal do canto da célula em pixels. |
offsetY | Integer | O 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
Nome | Tipo | Descrição |
---|---|---|
afterPosition | Integer | A 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
Nome | Tipo | Descrição |
---|---|---|
beforePosition | Integer | A 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
Nome | Tipo | Descrição |
---|---|---|
afterPosition | Integer | A linha depois da qual as novas linhas devem ser adicionadas. |
howMany | Integer | O 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
Nome | Tipo | Descrição |
---|---|---|
beforePosition | Integer | A linha antes da qual as novas linhas devem ser adicionadas. |
howMany | Integer | O 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
Nome | Tipo | Descrição |
---|---|---|
sheetIndex | Integer | O í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
Nome | Tipo | Descrição |
---|---|---|
sheetIndex | Integer | O índice da planilha recém-criada. Para inserir uma planilha como a primeira em planilha, defina-o como 0. |
options | Object | Argumentos avançados de JavaScript opcionais. |
Parâmetros avançados
Nome | Tipo | Descrição |
---|---|---|
template | Sheet | Todos 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
Nome | Tipo | Descrição |
---|---|---|
options | Object | Os argumentos avançados de JavaScript opcionais, listados abaixo. |
Parâmetros avançados
Nome | Tipo | Descrição |
---|---|---|
template | Sheet | Todos 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
Nome | Tipo | Descrição |
---|---|---|
sheetName | String | O 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
Nome | Tipo | Descrição |
---|---|---|
sheetName | String | O nome da nova planilha. |
sheetIndex | Integer | O í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
Nome | Tipo | Descrição |
---|---|---|
sheetName | String | O nome da nova planilha. |
sheetIndex | Integer | O índice da página recém-inserida. Para inserir uma planilha como a primeira em em uma planilha, defina-o como 0. |
options | Object | Argumentos avançados de JavaScript opcionais. |
Parâmetros avançados
Nome | Tipo | Descrição |
---|---|---|
template | Sheet | Todos 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
Nome | Tipo | Descrição |
---|---|---|
sheetName | String | O nome da nova planilha. |
options | Object | Argumentos avançados de JavaScript opcionais. |
Parâmetros avançados
Nome | Tipo | Descrição |
---|---|---|
template | Sheet | Todos 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
Nome | Tipo | Descrição |
---|---|---|
spec | DataSourceSpec | A 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
Nome | Tipo | Descrição |
---|---|---|
columnPosition | Integer | A posição da coluna a ser examinada. |
Retornar
Boolean
— true
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
Nome | Tipo | Descrição |
---|---|---|
rowPosition | Integer | A 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
Nome | Tipo | Descrição |
---|---|---|
rowPosition | Integer | A 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
Nome | Tipo | Descrição |
---|---|---|
pos | Integer | A 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
Nome | Tipo | Descrição |
---|---|---|
chart | EmbeddedChart | O 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