Class Spreadsheet

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

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

Retornar

TextFinder: o TextFinder da planilha.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

• setActiveRange(range)

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

• setActiveRangeList(rangeList)

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.

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

Retornar

Blob: os dados como um blob.

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

Retorne os dados dentro desse objeto como um blob.

Retornar

Blob: os dados como um blob.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

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

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

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

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

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

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

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

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.

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

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

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

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

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

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

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

Retornar

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

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

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

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());