Se usó la API de Cloud Translation para traducir esta página.

Class SpreadsheetApp
Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.

Accede a archivos de Hojas de cálculo de Google y créalos. Esta clase es la clase superior del servicio de Hojas de cálculo.

Propiedades

Propiedad	Tipo	Descripción
`AutoFillSeries`	`AutoFillSeries`	Es una enumeración de los tipos de series que se usan para calcular los valores autocompletados.
`BandingTheme`	`BandingTheme`	Es una enumeración de los posibles temas de bandas.
`BooleanCriteria`	`BooleanCriteria`	Es una enumeración de criterios booleanos de formato condicional.
`BorderStyle`	`BorderStyle`	Es una enumeración de los estilos válidos para establecer bordes en un `Range`.
`ColorType`	`ColorType`	Es una enumeración de los tipos de colores posibles.
`CopyPasteType`	`CopyPasteType`	Es una enumeración de los posibles tipos de pegado.
`DataExecutionErrorCode`	`DataExecutionErrorCode`	Una enumeración de los posibles códigos de error de ejecución de datos.
`DataExecutionState`	`DataExecutionState`	Es una enumeración de los posibles estados de ejecución de datos.
`DataSourceParameterType`	`DataSourceParameterType`	Es una enumeración de los posibles tipos de parámetros de fuente de datos.
`DataSourceRefreshScope`	`DataSourceRefreshScope`	Es una enumeración de los posibles alcances de actualización de la fuente de datos.
`DataSourceType`	`DataSourceType`	Es una enumeración de los posibles tipos de fuentes de datos.
`DataValidationCriteria`	`DataValidationCriteria`	Es una enumeración que representa los criterios de validación de datos que se pueden establecer en un rango.
`DateTimeGroupingRuleType`	`DateTimeGroupingRuleType`	Es una enumeración de la regla de agrupación de fecha y hora.
`DeveloperMetadataLocationType`	`DeveloperMetadataLocationType`	Es una enumeración de los posibles tipos de ubicación de los metadatos del desarrollador.
`DeveloperMetadataVisibility`	`DeveloperMetadataVisibility`	Es una enumeración de las posibles visibilidades de los metadatos del desarrollador.
`Dimension`	`Dimension`	Es una enumeración de las dimensiones posibles de una hoja de cálculo.
`Direction`	`Direction`	Es una enumeración de las direcciones posibles en las que se puede desplazar dentro de una hoja de cálculo con las teclas de flecha.
`FrequencyType`	`FrequencyType`	Es una enumeración de los posibles tipos de frecuencia.
`GroupControlTogglePosition`	`GroupControlTogglePosition`	Es una enumeración de las posiciones en las que puede estar el botón de activación del control de grupo.
`InterpolationType`	`InterpolationType`	Es una enumeración de los tipos de interpolación de gradientes de formato condicional.
`PivotTableSummarizeFunction`	`PivotTableSummarizeFunction`	Es una enumeración de las funciones que se pueden usar para resumir valores en una tabla dinámica.
`PivotValueDisplayType`	`PivotValueDisplayType`	Es una enumeración de las formas en que se puede mostrar un valor de eje.
`ProtectionType`	`ProtectionType`	Es una enumeración que representa las partes de una hoja de cálculo que se pueden proteger de las ediciones.
`RecalculationInterval`	`RecalculationInterval`	Es una enumeración de los intervalos posibles que se pueden usar en el recálculo de hojas de cálculo.
`RelativeDate`	`RelativeDate`	Es una enumeración de opciones de fecha relativa para calcular un valor que se usará en `BooleanCriteria` basado en fechas.
`SheetType`	`SheetType`	Es una enumeración de los diferentes tipos de hojas que pueden existir en una hoja de cálculo.
`SortOrder`	`SortOrder`	Es una enumeración del orden de clasificación.
`TextDirection`	`TextDirection`	Es una enumeración de instrucciones de texto válidas.
`TextToColumnsDelimiter`	`TextToColumnsDelimiter`	Es una enumeración de los delimitadores predeterminados para dividir el texto en columnas.
`ThemeColorType`	`ThemeColorType`	Es una enumeración de los posibles tipos de colores de tema.
`ValueType`	`ValueType`	Es una enumeración de los tipos de valores que muestran `Range.getValue()` y `Range.getValues()` desde la clase Range del servicio de Hojas de cálculo. Los valores de enumeración que se enumeran a continuación se suman a `Number`, `Boolean`, `Date` o `String`.
`WrapStrategy`	`WrapStrategy`	Es una enumeración de las estrategias que se usan para unir celdas.

Métodos

Método	Tipo de datos que se muestra	Descripción breve
`create(name)`	`Spreadsheet`	Crea una hoja de cálculo nueva con el nombre determinado.
`create(name, rows, columns)`	`Spreadsheet`	Crea una hoja de cálculo nueva con el nombre que se indique y la cantidad de filas y columnas especificadas.
`enableAllDataSourcesExecution()`	`void`	Activa la ejecución de datos para todos los tipos de fuentes de datos.
`enableBigQueryExecution()`	`void`	Activa la ejecución de datos para las fuentes de datos de BigQuery.
`enableLookerExecution()`	`void`	Activa la ejecución de datos para las fuentes de datos de Looker.
`flush()`	`void`	Aplica todos los cambios pendientes de la hoja de cálculo.
`getActive()`	`Spreadsheet`	Muestra la hoja de cálculo activa actualmente o `null` si no hay ninguna.
`getActiveRange()`	`Range`	Muestra el rango seleccionado en la hoja activa o `null` si no hay un rango activo.
`getActiveRangeList()`	`RangeList`	Muestra la lista de rangos activos en la hoja activa o `null` si no hay rangos seleccionados.
`getActiveSheet()`	`Sheet`	Obtiene la hoja activa en una hoja de cálculo.
`getActiveSpreadsheet()`	`Spreadsheet`	Muestra la hoja de cálculo activa actualmente o `null` si no hay ninguna.
`getCurrentCell()`	`Range`	Muestra la celda actual (destacada) que se seleccionó en uno de los rangos activos de la hoja activa o `null` si no hay una celda actual.
`getSelection()`	`Selection`	Muestra el `Selection` actual en la hoja de cálculo.
`getUi()`	`Ui`	Muestra una instancia del entorno de la 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()`	`CellImageBuilder`	Crea un compilador para un `CellImage`.
`newColor()`	`ColorBuilder`	Crea un compilador para un `Color`.
`newConditionalFormatRule()`	`ConditionalFormatRuleBuilder`	Crea un compilador para una regla de formato condicional.
`newDataSourceSpec()`	`DataSourceSpecBuilder`	Crea un compilador para un `DataSourceSpec`.
`newDataValidation()`	`DataValidationBuilder`	Crea un compilador para una regla de validación de datos.
`newFilterCriteria()`	`FilterCriteriaBuilder`	Crea un compilador para un `FilterCriteria`.
`newRichTextValue()`	`RichTextValueBuilder`	Crea un compilador para un valor de texto enriquecido.
`newTextStyle()`	`TextStyleBuilder`	Crea un compilador para un estilo de texto.
`open(file)`	`Spreadsheet`	Abre la hoja de cálculo que corresponde al objeto File determinado.
`openById(id)`	`Spreadsheet`	Abre la hoja de cálculo con el ID determinado.
`openByUrl(url)`	`Spreadsheet`	Abre la hoja de cálculo con la URL proporcionada.
`setActiveRange(range)`	`Range`	Establece el rango especificado como `active range`, con la celda superior izquierda del rango como `current cell`.
`setActiveRangeList(rangeList)`	`RangeList`	Establece la lista de rangos especificada como `active ranges`.
`setActiveSheet(sheet)`	`Sheet`	Establece la hoja activa en una hoja de cálculo.
`setActiveSheet(sheet, restoreSelection)`	`Sheet`	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.
`setActiveSpreadsheet(newActiveSpreadsheet)`	`void`	Establece la hoja de cálculo activa.
`setCurrentCell(cell)`	`Range`	Establece la celda especificada como `current cell`.

Documentación detallada

`create(name)`

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

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

Parámetros

Nombre	Tipo	Descripción
`name`	`String`	Es el nombre de la hoja de cálculo.

Volver

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 ámbitos:

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

`create(name, rows, columns)`

Crea una hoja de cálculo nueva con el nombre que se indique y la cantidad de filas y columnas especificadas.

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

Parámetros

Nombre	Tipo	Descripción
`name`	`String`	Es el nombre de la hoja de cálculo.
`rows`	`Integer`	Es la cantidad de filas de la hoja de cálculo.
`columns`	`Integer`	Es la cantidad de columnas de la hoja de cálculo.

Volver

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 ámbitos:

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 para 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 ámbitos:

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 para 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 ámbitos:

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

`enableLookerExecution()`

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

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

// Turns data execution on for Looker data sources.
SpreadsheetApp.enableLookerExecution();

// 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
// associated Looker data.
ss.getDataSourceSheets()[0].refreshData();

`flush()`

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

A veces, las operaciones de hoja de cálculo se agrupan para mejorar el rendimiento, como cuando se realizan varias llamadas a Range.getValue(). Sin embargo, a veces es posible que desees asegurarte de que todos los cambios pendientes se realicen de inmediato, por ejemplo, para mostrar los datos de los usuarios mientras se ejecuta 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() {
  const sheet = SpreadsheetApp.getActiveSheet();
  for (let 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 actualmente 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 hoja de cálculo correspondiente llamando a esta función.

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

Volver

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

Autorización

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

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 intervalos, este método solo muestra el último intervalo seleccionado.

Por lo general, se refiere 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.
const colorObject = SpreadsheetApp.getActiveRange().getBackgroundObject();
// Assume the color has ColorType.RGB.
Logger.log(colorObject.asRgbColor().asHexString());

Volver

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 ámbitos:

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 coloca al final de la lista.

Si se selecciona un solo rango, se comporta como una llamada a getActiveRange().

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

Volver

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 ámbitos:

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

Volver

Sheet: 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 ámbitos:

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

`getActiveSpreadsheet()`

Muestra la hoja de cálculo activa actualmente 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 Spreadsheet correspondiente llamando a esta función.

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

Volver

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

Autorización

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

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

`getCurrentCell()`

Muestra la celda actual (destacada) que se seleccionó en uno de los rangos activos de la hoja activa o null si no hay una celda actual.

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

Volver

Range: 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 ámbitos:

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

`getSelection()`

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

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

Volver

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 ámbitos:

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

`getUi()`

Muestra una instancia del entorno de la 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 está vinculada a ella. Para obtener más información, consulta las guías de menús y 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();
}

Volver

Ui: Es una instancia del entorno de la 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);

Volver

CellImageBuilder: Es el nuevo compilador.

`newColor()`

Crea un compilador para un Color.

const rgbColor = SpreadsheetApp.newColor().setRgbColor('#FF0000').build();

Volver

ColorBuilder: Es el nuevo compilador.

`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.
const sheet = SpreadsheetApp.getActive().getActiveSheet();
const range = sheet.getRange('A1:B3');
const rule = SpreadsheetApp.newConditionalFormatRule()
                 .whenNumberBetween(1, 10)
                 .setBackground('#FF0000')
                 .setRanges([range])
                 .build();
const rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Volver

ConditionalFormatRuleBuilder: Es el nuevo compilador.

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

Volver

DataSourceSpecBuilder: Es el nuevo compilador.

`newDataValidation()`

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

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

Volver

DataValidationBuilder: Es el nuevo compilador.

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

Volver

FilterCriteriaBuilder: El nuevo compilador

`newRichTextValue()`

Crea un compilador para un valor de texto enriquecido.

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

Volver

RichTextValueBuilder: Es el nuevo compilador.

`newTextStyle()`

Crea un compilador para un estilo de texto.

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

Volver

TextStyleBuilder: Es el nuevo compilador.

`open(file)`

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

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

Parámetros

Nombre	Tipo	Descripción
`file`	`File`	El archivo que se abrirá.

Volver

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 ámbitos:

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

`openById(id)`

Abre la hoja de cálculo con el ID determinado. Se puede extraer un ID de hoja de cálculo 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).
const ss = SpreadsheetApp.openById('abc1234567');
Logger.log(ss.getName());

Parámetros

Nombre	Tipo	Descripción
`id`	`String`	Es el identificador único de la hoja de cálculo.

Volver

Spreadsheet: Es el objeto Hoja de cálculo con el ID determinado.

Autorización

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

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

`openByUrl(url)`

Abre la hoja de cálculo con la URL proporcionada. Genera una excepción de secuencias 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).
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc1234567/edit',
);
console.log(ss.getName());

Parámetros

Nombre	Tipo	Descripción
`url`	`String`	Es la URL de la hoja de cálculo.

Volver

Spreadsheet: Es el objeto de 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 ámbitos:

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

`setActiveRange(range)`

Establece el rango especificado como active range, con la celda superior izquierda del 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 él.

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

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

Parámetros

Nombre	Tipo	Descripción
`range`	`Range`	Es el rango que se convertirá en el rango activo.

Volver

Range: El nuevo período activo

`setActiveRangeList(rangeList)`

Establece la lista de rangos especificada 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.
const rangeList = SpreadsheetApp.getActiveSheet().getRanges(['D4', 'B2:C4']);
SpreadsheetApp.setActiveRangeList(rangeList);

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

Parámetros

Nombre	Tipo	Descripción
`rangeList`	`RangeList`	Es la lista de rangos que se deben seleccionar.

Volver

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 ámbitos:

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 una hoja de cálculo diferente.

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

Parámetros

Nombre	Tipo	Descripción
`sheet`	`Sheet`	La nueva hoja activa.

Volver

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 una hoja de cálculo diferente.

const spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
const firstSheet = spreadsheet.getSheets()[0];
const 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
const range = spreadsheet.getActiveSheet().getSelection().getActiveRange();
Logger.log(range.getA1Notation());

Parámetros

Nombre	Tipo	Descripción
`sheet`	`Sheet`	La nueva hoja activa.
`restoreSelection`	`Boolean`	Si es `true`, la selección más reciente de la hoja activa nueva se vuelve a seleccionar cuando la hoja nueva se activa. Si es `false`, la hoja nueva se activa sin cambiar la selección actual.

Volver

Sheet: 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 ámbitos:

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
const ss = SpreadsheetApp.openById('1234567890');
SpreadsheetApp.setActiveSpreadsheet(ss);

Parámetros

Nombre	Tipo	Descripción
`newActiveSpreadsheet`	`Spreadsheet`	La 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 activo, y la celda se convierte en la celda actual.

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

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

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

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

Parámetros

Nombre	Tipo	Descripción
`cell`	`Range`	Es la celda que se establecerá como la celda actual.

Volver

Range: Es la celda actual recién establecida.

Autorización

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

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

Class SpreadsheetApp Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.

Propiedades

Métodos

Documentación detallada

create(name)

Parámetros

Volver

Autorización

create(name, rows, columns)

Parámetros

Volver

Autorización

enableAllDataSourcesExecution()

Autorización

enableBigQueryExecution()

Autorización

enableLookerExecution()

flush()

getActive()

Volver

Autorización

getActiveRange()

Volver

Autorización

getActiveRangeList()

Volver

Autorización

getActiveSheet()

Volver

Autorización

getActiveSpreadsheet()

Volver

Autorización

getCurrentCell()

Volver

Autorización

getSelection()

Volver

Autorización

getUi()

Volver

newCellImage()

Volver

newColor()

Volver

newConditionalFormatRule()

Volver

newDataSourceSpec()

Volver

newDataValidation()

Volver

newFilterCriteria()

Volver

newRichTextValue()

Volver

newTextStyle()

Volver

open(file)

Parámetros

Volver

Autorización

openById(id)

Parámetros

Volver

Autorización

openByUrl(url)

Parámetros

Volver

Autorización

setActiveRange(range)

Parámetros

Volver

setActiveRangeList(rangeList)

Parámetros

Volver

Autorización

setActiveSheet(sheet)

Parámetros

Volver

setActiveSheet(sheet, restoreSelection)

Class SpreadsheetApp
Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.

`create(name)`

`create(name, rows, columns)`

`enableAllDataSourcesExecution()`

`enableBigQueryExecution()`

`enableLookerExecution()`

`flush()`

`getActive()`

`getActiveRange()`

`getActiveRangeList()`

`getActiveSheet()`

`getActiveSpreadsheet()`

`getCurrentCell()`

`getSelection()`

`getUi()`

`newCellImage()`

`newColor()`

`newConditionalFormatRule()`

`newDataSourceSpec()`

`newDataValidation()`

`newFilterCriteria()`

`newRichTextValue()`

`newTextStyle()`

`open(file)`

`openById(id)`

`openByUrl(url)`

`setActiveRange(range)`

`setActiveRangeList(rangeList)`

`setActiveSheet(sheet)`

`setActiveSheet(sheet, restoreSelection)`

`setActiveSpreadsheet(newActiveSpreadsheet)`

`setCurrentCell(cell)`