Class Sheet

Ativa esta página. Não altera a própria página, apenas a noção do pai de folha

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

Retornar

Sheet: a página recém-ativada.

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

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

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

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

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

Parâmetros

Retornar

Sheet: esta página, 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 a visibilidade especificadas à página.

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

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

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

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

Parâmetros

Retornar

Sheet: esta página, 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 à página.

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

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

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

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

Parâmetros

Retornar

Sheet: esta página, 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 à página.

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

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

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

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

Parâmetros

Retornar

Sheet: esta página, 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

Retorna a página como DataSourceSheet se ela for do tipo SheetType.DATASOURCE. Caso contrário, retorna null.

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

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

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

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

Retornar

DataSourceSheet: uma página de fonte de dados.

Autorização

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

Define a largura de todas as colunas a partir da posição de coluna especificada para ajustar o conteúdo delas.

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

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

Parâmetros

Retornar

Sheet: esta página, 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

Define a altura de todas as linhas a partir da posição da linha especificada para ajustar o conteúdo.

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

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

Parâmetros

Retornar

Sheet: esta página, 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

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

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

Retornar

Sheet: a página apagada.

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

Limpa a folha de conteúdo e/ou o formato, conforme especificado com as opções avançadas fornecidas.

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

Parâmetros

Parâmetros avançados

Retornar

Sheet: esta página, 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

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

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

Autorização

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

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

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

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

Retornar

Sheet: esta página, para encadeamento.

Autorização

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

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

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

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

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

Retornar

Sheet: esta página, para encadeamento.

Autorização

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

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

Limpa a folha com todas as notas.

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

Retornar

Sheet: esta página, para encadeamento.

Autorização

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

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

Recolhe todos os grupos de colunas da página.

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

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

Retornar

Sheet: esta página, para encadeamento.

Autorização

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

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

Recolhe todos os grupos de linhas da página.

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

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

Retornar

Sheet: esta página, para encadeamento.

Autorização

Os scripts que usam esse método 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 página para uma determinada planilha, que pode ser a mesma planilha da fonte. A página copiada se chama "Cópia de [nome original]".

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

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

Parâmetros

Retornar

Sheet: a nova página, 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. Os metadados estarão no escopo de uma página específica se estiverem associados ao página em si, ou associado a uma linha, coluna ou intervalo nessa página.

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

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

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

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

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

Retornar

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

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

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

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

// Returns the first occurrence of 'dog' in the sheet.
var firstOccurrence = textFinder.findNext();

// Replaces the last found occurrence of 'dog' with 'cat' and returns the number
// of occurrences replaced.
var numOccurrencesReplaced = findOccurrence.replaceWith('cat');

Parâmetros

Retornar

TextFinder: o TextFinder da página.

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

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

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

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

Retornar

Sheet: esta página, para encadeamento.

Autorização

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

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

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

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

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

Retornar

Sheet: esta página, para encadeamento.

Autorização

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

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

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

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

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

Parâmetros

Retornar

Sheet: esta página, 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

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

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

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

Parâmetros

Retornar

Sheet: esta página, 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 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)

Retorna todas as faixas nesta página.

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

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

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

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

Retornar

Banding[]: todas as faixas 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

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

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

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

Retornar

EmbeddedChart[]: uma matriz de gráficos.

Autorização

Os scripts que usam esse método 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 grupo de colunas com o índice e a profundidade do grupo especificados.

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

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

Parâmetros

Retornar

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

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 GroupControlTogglePosition para todos os grupos de colunas na página.

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

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

Retornar

GroupControlTogglePosition: true se o botão de alternância de controle do agrupamento de colunas for exibido após o grupo neste planilha e false caso contrá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

Retorna a profundidade do grupo da coluna no índice fornecido.

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

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

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

Parâmetros

Retornar

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

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

Receba todas as regras de formatação condicional desta planilha.

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

Retornar

ConditionalFormatRule[]: uma matriz de todas as regras 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

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

Recebe todos os metadados do desenvolvedor associados a esta planilha.

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

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

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

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

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

Retornar

DeveloperMetadata[]: os metadados do desenvolvedor associados à 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 uma matriz de desenhos na página.

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

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

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

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

Retornar

Drawing[]: a lista de desenhos na 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 o filtro nesta página ou null se não houver um filtro.

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

Retornar

Filter: o filtro.

Autorização

Os scripts que usam esse método 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 página, ou null se esse página não tem nenhum formulário associado.

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

Retornar

String: o URL do formulário que coloca as respostas nesta página, ou null se este 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

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

Define a posição da página na planilha principal. Começa em 1.

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

Retornar

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

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 atual de colunas na página, independentemente do conteúdo.

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

Retornar

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

Autorização

Os scripts que usam esse método 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 atual de linhas na página, independentemente do conteúdo.

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

Retornar

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

Autorização

Os scripts que usam esse método 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 nome da página.

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

Retornar

String: o nome da página.

Autorização

Os scripts que usam esse método 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 página.

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

Retornar

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

Autorização

Os scripts que usam esse método 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 Spreadsheet que contém a página.

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

Retornar

Spreadsheet: é a planilha principal.

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 tabelas dinâmicas nesta página.

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

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

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

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