Class SpreadsheetApp

SpreadsheetApp

Crear archivos de Hojas de cálculo de Google y acceder a ellos Esta clase es la clase superior del servicio Hojas de cálculo.

Propiedades

PropiedadTipoDescripción
AutoFillSeriesAutoFillSeriesEs una enumeración de los tipos de series utilizados para calcular los valores completados automáticamente.
BandingThemeBandingThemeUna enumeración de los posibles temas de las bandas.
BooleanCriteriaBooleanCriteriaUna enumeración de criterios booleanos de formato condicional.
BorderStyleBorderStyleEs una enumeración de los estilos válidos para configurar bordes en un objeto Range.
ColorTypeColorTypeUna enumeración de los tipos de color posibles.
CopyPasteTypeCopyPasteTypeUna enumeración de los tipos de pegado posibles.
DataExecutionErrorCodeDataExecutionErrorCodeUna enumeración de los posibles códigos de error de ejecución de datos.
DataExecutionStateDataExecutionStateUna enumeración de los posibles estados de ejecución de datos.
DataSourceParameterTypeDataSourceParameterTypeUna enumeración de los tipos de parámetros de fuente de datos posibles.
DataSourceRefreshScopeDataSourceRefreshScopeUna enumeración de los posibles alcances de actualización de las fuentes de datos.
DataSourceTypeDataSourceTypeUna enumeración de los tipos de fuentes de datos posibles.
DataValidationCriteriaDataValidationCriteriaUna enumeración que representa los criterios de validación de datos que se pueden configurar en un rango.
DateTimeGroupingRuleTypeDateTimeGroupingRuleTypeUna enumeración de la regla de agrupación de fecha y hora.
DeveloperMetadataLocationTypeDeveloperMetadataLocationTypeUna enumeración de los posibles tipos de ubicación de los metadatos del desarrollador.
DeveloperMetadataVisibilityDeveloperMetadataVisibilityUna enumeración de las posibles visibilidades de metadatos del desarrollador.
DimensionDimensionEs una enumeración de las posibles dimensiones de una hoja de cálculo.
DirectionDirectionUna enumeración de las posibles direcciones que se pueden mover dentro de una hoja de cálculo usando las teclas de flecha.
FrequencyTypeFrequencyTypeUna enumeración de los tipos de frecuencia posibles.
GroupControlTogglePositionGroupControlTogglePositionUna enumeración de las posiciones en las que puede estar el control de grupo.
InterpolationTypeInterpolationTypeEs una enumeración de los tipos de interpolación de gradiente de formato condicional.
PivotTableSummarizeFunctionPivotTableSummarizeFunctionUna enumeración de las funciones que se pueden usar para resumir los valores de una tabla dinámica.
PivotValueDisplayTypePivotValueDisplayTypeEs una enumeración de las formas en que se puede mostrar un valor dinámico.
ProtectionTypeProtectionTypeUna enumeración que representa las partes de una hoja de cálculo que se pueden proteger de las modificaciones.
RecalculationIntervalRecalculationIntervalUna enumeración de los intervalos posibles que se pueden usar en un recálculo de una hoja de cálculo.
RelativeDateRelativeDateUna enumeración de las opciones de fecha relativas para calcular un valor que se usará en BooleanCriteria basado en fechas.
SheetTypeSheetTypeEs una enumeración de los diferentes tipos de hojas que puede existir en una hoja de cálculo.
SortOrderSortOrderUna enumeración de orden de clasificación.
TextDirectionTextDirectionEs una enumeración de direcciones de texto válidas.
TextToColumnsDelimiterTextToColumnsDelimiterUna enumeración de los delimitadores predeterminados para la división de texto en columnas.
ThemeColorTypeThemeColorTypeUna enumeración de los posibles tipos de colores de tema.
ValueTypeValueTypeUna enumeración de los tipos de valor que muestran Range.getValue() y Range.getValues() desde la clase Range del servicio de hoja de cálculo. Los valores de enumeración que se muestran a continuación, además de Number, Boolean, Date o String.
WrapStrategyWrapStrategyEs una enumeración de las estrategias usadas para unir celdas.

Métodos

MétodoTipo de datos que se muestraDescripción breve
create(name)SpreadsheetCrea una hoja de cálculo nueva con el nombre dado.
create(name, rows, columns)SpreadsheetCrea una hoja de cálculo nueva con el nombre dado y el número especificado de filas y columnas.
enableAllDataSourcesExecution()voidActiva la ejecución de datos para todos los tipos de fuentes de datos.
enableBigQueryExecution()voidActiva la ejecución de datos para las fuentes de datos de BigQuery.
flush()voidAplica todos los cambios pendientes de la hoja de cálculo.
getActive()SpreadsheetMuestra la hoja de cálculo activa en este momento o null si no hay ninguna.
getActiveRange()RangeMuestra el rango seleccionado en la hoja activa o null si no hay un rango activo.
getActiveRangeList()RangeListMuestra la lista de rangos activos en la hoja activa o null si no hay rangos seleccionados.
getActiveSheet()SheetObtiene la hoja activa en una hoja de cálculo.
getActiveSpreadsheet()SpreadsheetMuestra la hoja de cálculo activa en este momento o null si no hay ninguna.
getCurrentCell()RangeMuestra la celda actual (resaltada) que está seleccionada en uno de los rangos activos en la hoja activa o null si no hay una celda actual.
getSelection()SelectionMuestra el Selection actual en la hoja de cálculo.
getUi()UiMuestra una instancia del entorno de interfaz de usuario de la hoja de cálculo que permite que la secuencia de comandos agregue funciones como menús, diálogos y barras laterales.
newCellImage()CellImageBuilderCrea un compilador para un CellImage.
newColor()ColorBuilderCrea un compilador para un Color.
newConditionalFormatRule()ConditionalFormatRuleBuilderCrea un compilador para una regla de formato condicional.
newDataSourceSpec()DataSourceSpecBuilderCrea un compilador para un DataSourceSpec.
newDataValidation()DataValidationBuilderCrea un compilador para una regla de validación de datos.
newFilterCriteria()FilterCriteriaBuilderCrea un compilador para un FilterCriteria.
newRichTextValue()RichTextValueBuilderCrea un compilador para un valor de texto enriquecido.
newTextStyle()TextStyleBuilderCrea un compilador para un estilo de texto.
open(file)SpreadsheetAbre la hoja de cálculo que corresponde al objeto de archivo determinado.
openById(id)SpreadsheetAbre la hoja de cálculo con el ID especificado.
openByUrl(url)SpreadsheetAbre la hoja de cálculo con la URL especificada.
setActiveRange(range)RangeEstablece el rango especificado como active range, con la celda superior izquierda en el rango como current cell.
setActiveRangeList(rangeList)RangeListEstablece la lista especificada de rangos como active ranges.
setActiveSheet(sheet)SheetEstablece la hoja activa en una hoja de cálculo.
setActiveSheet(sheet, restoreSelection)SheetEstablece la hoja activa en una hoja de cálculo con la opción de restablecer la selección más reciente dentro de esa hoja.
setActiveSpreadsheet(newActiveSpreadsheet)voidEstablece la hoja de cálculo activa.
setCurrentCell(cell)RangeEstablece la celda especificada como current cell.

Documentación detallada

create(name)

Crea una hoja de cálculo nueva con el nombre dado.

// The code below creates a new spreadsheet "Finances" and logs the URL for it
var ssNew = SpreadsheetApp.create("Finances");
Logger.log(ssNew.getUrl());

Parámetros

NombreTipoDescripción
nameStringEs el nombre de la hoja de cálculo.

Devolvedor

Spreadsheet: Una hoja de cálculo nueva

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

create(name, rows, columns)

Crea una hoja de cálculo nueva con el nombre dado y el número especificado de filas y columnas.

// The code below creates a new spreadsheet "Finances" with 50 rows and 5 columns and logs the
// URL for it
var ssNew = SpreadsheetApp.create("Finances", 50, 5);
Logger.log(ssNew.getUrl());

Parámetros

NombreTipoDescripción
nameStringEs el nombre de la hoja de cálculo.
rowsIntegerEs la cantidad de filas de la hoja de cálculo.
columnsIntegerEs la cantidad de columnas de la hoja de cálculo.

Devolvedor

Spreadsheet: Una hoja de cálculo nueva

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

enableAllDataSourcesExecution()

Activa la ejecución de datos para todos los tipos de fuentes de datos.

La ejecución de datos arroja una excepción si el tipo de fuente de datos no está activado. Usa este método a fin de activar la ejecución de datos para todos los tipos de fuentes de datos.

// Turns data execution on for all types of data sources.
SpreadsheetApp.enableAllDataSourcesExecution();

// 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 the first data source sheet in the spreadsheet and refreshes the data.
ss.getDataSourceSheets()[0].refreshData();

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/bigquery.readonly

enableBigQueryExecution()

Activa la ejecución de datos para las fuentes de datos de BigQuery.

La ejecución de datos de la fuente de datos de BigQuery arroja una excepción si no está activada.

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

// 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 the first data source sheet in the spreadsheet and refreshes the BigQuery data.
ss.getDataSourceSheets()[0].refreshData();

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/bigquery.readonly

flush()

Aplica todos los cambios pendientes de la hoja de cálculo.

A veces, las operaciones de la hoja de cálculo se agrupan para mejorar el rendimiento, como cuando haces varias llamadas a Range.getValue(). Sin embargo, es posible que, a veces, quieras asegurarte de que todos los cambios pendientes se realicen de inmediato; por ejemplo, para mostrar datos del usuario como se está ejecutando una secuencia de comandos.

// The code below changes the background color of cells A1 and B1 twenty times. You should be
// able to see the updates live in the spreadsheet. If flush() is not called, the updates may
// be applied live or may all be applied at once when the script completes.
function colors() {
  var sheet = SpreadsheetApp.getActiveSheet();
  for (var i = 0; i < 20; i++) {
    if ((i % 2) == 0) {
      sheet.getRange('A1').setBackground('green');
      sheet.getRange('B1').setBackground('red');
    } else {
      sheet.getRange('A1').setBackground('red');
      sheet.getRange('B1').setBackground('green');
    }
    SpreadsheetApp.flush();
  }
}

getActive()

Muestra la hoja de cálculo activa en este momento o null si no hay ninguna.

Las funciones que se ejecutan en el contexto de una hoja de cálculo pueden obtener una referencia al objeto de la hoja de cálculo correspondiente si se llama a esta función.

// The code below logs the URL for the active spreadsheet.
Logger.log(SpreadsheetApp.getActive().getUrl());

Devolvedor

Spreadsheet: Es el objeto activo de la hoja de cálculo.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getActiveRange()

Muestra el rango seleccionado en la hoja activa o null si no hay un rango activo. Si se seleccionan varios rangos, este método solo muestra el último rango seleccionado.

Por lo general, esto hace referencia al rango que un usuario seleccionó en la hoja activa, pero en una función personalizada se refiere a la celda que se vuelve a calcular de forma activa.

// The code below logs the background color for the active range.
var colorObject = SpreadsheetApp.getActiveRange().getBackgroundObject();
// Assume the color has ColorType.RGB.
Logger.log(colorObject.asRgbColor().asHexString());

Devolvedor

Range: Es el rango activo.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getActiveRangeList()

Muestra la lista de rangos activos en la hoja activa o null si no hay rangos seleccionados. El rango activo que contiene la celda destacada actual se colocará en último lugar de la lista.

Si hay un solo rango seleccionado, se comportará como una llamada getActiveRange().

// Returns the list of active ranges.
var rangeList = SpreadsheetApp.getActiveRangeList();

Devolvedor

RangeList: Es la lista de rangos activos.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getActiveSheet()

Obtiene la hoja activa en una hoja de cálculo.

La hoja activa en una hoja de cálculo es la hoja que se muestra en la IU de la hoja de cálculo.

// The code below logs the name of the active sheet.
Logger.log(SpreadsheetApp.getActiveSheet().getName());

Devolvedor

Sheet: Es el objeto de hoja activo.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getActiveSpreadsheet()

Muestra la hoja de cálculo activa en este momento o null si no hay ninguna.

Las funciones que se ejecutan en el contexto de una hoja de cálculo pueden llamar a esta función para obtener una referencia al objeto Spreadsheet correspondiente.

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

Devolvedor

Spreadsheet: Es el objeto activo de la hoja de cálculo.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getCurrentCell()

Muestra la celda actual (resaltada) que está seleccionada en uno de los rangos activos en la hoja activa o null si no hay una celda actual.

// Returns the current highlighted cell in the one of the active ranges.
var currentCell = SpreadsheetApp.getCurrentCell();

Devolvedor

Range: Es la celda actual.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getSelection()

Muestra el Selection actual en la hoja de cálculo.

var selection = SpreadsheetApp.getSelection();
var currentCell = selection.getCurrentCell();

Devolvedor

Selection: Es la selección actual.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getUi()

Muestra una instancia del entorno de interfaz de usuario de la hoja de cálculo que permite que la secuencia de comandos agregue funciones como menús, diálogos y barras laterales. Una secuencia de comandos solo puede interactuar con la IU de la instancia actual de una hoja de cálculo abierta y solo si la secuencia de comandos está vinculada a la hoja de cálculo. Para obtener más información, consulta las guías de menús, y de diálogos y barras laterales.

// Add a custom menu to the active spreadsheet, including a separator and a sub-menu.
function onOpen(e) {
  SpreadsheetApp.getUi()
      .createMenu('My Menu')
      .addItem('My menu item', 'myFunction')
      .addSeparator()
      .addSubMenu(SpreadsheetApp.getUi().createMenu('My sub-menu')
          .addItem('One sub-menu item', 'mySecondFunction')
          .addItem('Another sub-menu item', 'myThirdFunction'))
      .addToUi();
}

Devolvedor

Ui: Es una instancia del entorno de interfaz de usuario de esta hoja de cálculo.


newCellImage()

Crea un compilador para un CellImage.

// 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets cell A1 on Sheet1.
const range = sheet.getRange('A1');

// Builds an image using a source URL.
const cellImage = SpreadsheetApp.newCellImage()
  .setSourceUrl('https://www.gstatic.com/images/branding/productlogos/apps_script/v10/web-64dp/logo_apps_script_color_1x_web_64dp.png')
  .build();

// Sets the image in cell A1.
range.setValue(cellImage);

Devolvedor

CellImageBuilder: Es el compilador nuevo.


newColor()

Crea un compilador para un Color.

var rgbColor = SpreadsheetApp.newColor().setRgbColor("#FF0000").build();

Devolvedor

ColorBuilder: Es el compilador nuevo.


newConditionalFormatRule()

Crea un compilador para una regla de formato condicional.

// Adds a conditional format rule to a sheet that causes all cells in range A1:B3 to turn red
// if they contain a number between 1 and 10.
var sheet = SpreadsheetApp.getActive().getActiveSheet();
var range = sheet.getRange('A1:B3');
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenNumberBetween(1, 10)
    .setBackground("#FF0000")
    .setRanges([range])
    .build()
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Devolvedor

ConditionalFormatRuleBuilder: Es el compilador nuevo.


newDataSourceSpec()

Crea un compilador para un DataSourceSpec.

// 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');

// Enables BigQuery.
SpreadsheetApp.enableBigQueryExecution();

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

Devolvedor

DataSourceSpecBuilder: Es el compilador nuevo.


newDataValidation()

Crea un compilador para una regla de validación de datos.

var cell = SpreadsheetApp.getActive().getRange('A1');
var rule = SpreadsheetApp.newDataValidation()
    .requireNumberBetween(1, 100)
    .setAllowInvalid(false)
    .setHelpText('Number must be between 1 and 100.')
    .build();
cell.setDataValidation(rule);

Devolvedor

DataValidationBuilder: Es el compilador nuevo.


newFilterCriteria()

Crea un compilador para un FilterCriteria.

// 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Sets the range to A1:D20.
const range = sheet.getRange('A1:D20');

// Creates a filter and applies it to the specified range.
range.createFilter();

// Gets the current filter for the range and creates filter criteria that only shows cells
// that aren't empty.
const filter = range.getFilter();
const criteria = SpreadsheetApp.newFilterCriteria().whenCellNotEmpty().build();

// Sets the criteria to  column C.
filter.setColumnFilterCriteria(3, criteria);

Devolvedor

FilterCriteriaBuilder: Es el compilador nuevo.


newRichTextValue()

Crea un compilador para un valor de texto enriquecido.

// Sets cell A1 to have the text "Hello world", with "Hello" bolded.
var cell = SpreadsheetApp.getActive().getRange('A1');
var bold = SpreadsheetApp.newTextStyle().setBold(true).build();
var value = SpreadsheetApp.newRichTextValue()
    .setText("Hello world")
    .setTextStyle(0, 5, bold)
    .build();
cell.setRichTextValue(value);

Devolvedor

RichTextValueBuilder: Es el compilador nuevo.


newTextStyle()

Crea un compilador para un estilo de texto.

// Sets range A1:B3 to have red, size 22, bolded, underlined text.
var range = SpreadsheetApp.getActive().getRange('A1:B3');
var style = SpreadsheetApp.newTextStyle()
    .setForegroundColor("red")
    .setFontSize(22)
    .setBold(true)
    .setUnderline(true)
    .build();
range.setTextStyle(style);

Devolvedor

TextStyleBuilder: Es el compilador nuevo.


open(file)

Abre la hoja de cálculo que corresponde al objeto de archivo determinado.

// Get any starred spreadsheets from Google Drive, then open the spreadsheets and log the name
// of the first sheet within each spreadsheet.
var files = DriveApp.searchFiles(
    'starred = true and mimeType = "' + MimeType.GOOGLE_SHEETS + '"');
while (files.hasNext()) {
  var spreadsheet = SpreadsheetApp.open(files.next());
  var sheet = spreadsheet.getSheets()[0];
  Logger.log(sheet.getName());
}

Parámetros

NombreTipoDescripción
fileFileEl archivo que se abrirá.

Devolvedor

Spreadsheet: Es la hoja de cálculo.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

openById(id)

Abre la hoja de cálculo con el ID especificado. El ID de una hoja de cálculo se puede extraer de su URL. Por ejemplo, el ID de la hoja de cálculo en la URL https://docs.google.com/spreadsheets/d/abc1234567/edit#gid=0 es "abc1234567".

// The code below opens a spreadsheet using its ID and logs the name for it.
// Note that the spreadsheet is NOT physically opened on the client side.
// It is opened on the server only (for modification by the script).
var ss = SpreadsheetApp.openById("abc1234567");
Logger.log(ss.getName());

Parámetros

NombreTipoDescripción
idStringEs el identificador único de la hoja de cálculo.

Devolvedor

Spreadsheet: Es el objeto de la hoja de cálculo con el ID especificado.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

openByUrl(url)

Abre la hoja de cálculo con la URL especificada. Muestra una excepción de secuencia de comandos si la URL no existe o si el usuario no tiene permiso para acceder a ella.

// Opens a spreadsheet by its URL and logs its name.
// Note that the spreadsheet doesn't physically open on the client side.
// It opens on the server only (for modification by the script).
var ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc1234567/edit');
console.log(ss.getName());

Parámetros

NombreTipoDescripción
urlStringEs la URL de la hoja de cálculo.

Devolvedor

Spreadsheet: Es el objeto de la hoja de cálculo con la URL determinada.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

setActiveRange(range)

Establece el rango especificado como active range, con la celda superior izquierda en el rango como current cell.

La IU de la hoja de cálculo muestra la hoja que contiene el rango elegido y selecciona las celdas definidas en el rango elegido.

// The code below sets range C1:D4 in the first sheet as the active range.
var range = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0].getRange('C1:D4');
SpreadsheetApp.setActiveRange(range);

var selection = SpreadsheetApp.getSelection();
// Current cell: C1
var currentCell = selection.getCurrentCell();
// Active Range: C1:D4
var activeRange = selection.getActiveRange();

Parámetros

NombreTipoDescripción
rangeRangeRango en el que se convertirá el rango activo

Devolvedor

Range: Es el nuevo rango activo.


setActiveRangeList(rangeList)

Establece la lista especificada de rangos como active ranges. El último rango de la lista se establece como active range.

// The code below sets ranges [D4, B2:C4] in the active sheet as the active ranges.
var rangeList = SpreadsheetApp.getActiveSheet().getRanges(['D4', 'B2:C4']);
SpreadsheetApp.setActiveRangeList(rangeList);

var selection = SpreadsheetApp.getSelection();
// Current cell: B2
var currentCell = selection.getCurrentCell();
// Active range: B2:C4
var activeRange = selection.getActiveRange();
// Active range list: [D4, B2:C4]
var activeRangeList = selection.getActiveRangeList();

Parámetros

NombreTipoDescripción
rangeListRangeListEs la lista de rangos para seleccionar.

Devolvedor

RangeList: Es la lista de rangos recién seleccionada.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

setActiveSheet(sheet)

Establece la hoja activa en una hoja de cálculo. La IU de Hojas de cálculo de Google muestra la hoja elegida, a menos que pertenezca a otra hoja de cálculo.

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

Parámetros

NombreTipoDescripción
sheetSheetLa nueva hoja activa.

Devolvedor

Sheet: Es la hoja que se convirtió en la nueva hoja activa.


setActiveSheet(sheet, restoreSelection)

Establece la hoja activa en una hoja de cálculo con la opción de restablecer la selección más reciente dentro de esa hoja. La IU de Hojas de cálculo de Google muestra la hoja elegida, a menos que pertenezca a otra hoja de cálculo.

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

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

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

Parámetros

NombreTipoDescripción
sheetSheetLa nueva hoja activa.
restoreSelectionBooleanSi es true, se vuelve a seleccionar la selección más reciente de la nueva hoja activa cuando se activa la hoja nueva. Si es false, se activa la hoja nueva sin cambiar la selección actual.

Devolvedor

Sheet: Es la nueva hoja activa.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

setActiveSpreadsheet(newActiveSpreadsheet)

Establece la hoja de cálculo activa.

// The code below makes the spreadsheet with key "1234567890" the active spreadsheet
var ss = SpreadsheetApp.openById("1234567890");
SpreadsheetApp.setActiveSpreadsheet(ss);

Parámetros

NombreTipoDescripción
newActiveSpreadsheetSpreadsheetLa hoja de cálculo que se convertirá en la hoja de cálculo activa.

setCurrentCell(cell)

Establece la celda especificada como current cell.

Si la celda especificada está presente en un rango ya seleccionado, ese rango se convierte en el rango activo con la celda como la celda actual.

Si la celda especificada no está presente en ningún rango seleccionado, la selección existente se quita y la celda se convierte en la celda actual y en el rango activo.

Nota: El Range especificado debe constar de una celda; de lo contrario, este método arrojará una excepción.

// The code below sets the cell B5 in the first sheet as the current cell.
var cell = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0].getRange('B5');
SpreadsheetApp.setCurrentCell(cell);

var selection = SpreadsheetApp.getSelection();
// Current cell: B5
var currentCell = selection.getCurrentCell();

Parámetros

NombreTipoDescripción
cellRangeCelda que se establecerá como la celda actual.

Devolvedor

Range: Es la celda actual que se acaba de establecer.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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