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

Class Spreadsheet

Acceder a archivos de Hojas de cálculo de Google y modificarlos. Las operaciones comunes son agregar hojas nuevas y colaboradores.

Métodos

Método	Tipo de datos que se muestra	Descripción breve
`addDeveloperMetadata(key)`	`Spreadsheet`	Agrega metadatos del desarrollador con la clave especificada a la hoja de cálculo de nivel superior.
`addDeveloperMetadata(key, visibility)`	`Spreadsheet`	Agrega metadatos del desarrollador con la clave y el nivel de visibilidad especificados a la hoja de cálculo.
`addDeveloperMetadata(key, value)`	`Spreadsheet`	Agrega metadatos del desarrollador con la clave y el valor especificados a la hoja de cálculo.
`addDeveloperMetadata(key, value, visibility)`	`Spreadsheet`	Agrega metadatos del desarrollador con la clave, el valor y la visibilidad especificados en la hoja de cálculo.
`addEditor(emailAddress)`	`Spreadsheet`	Agrega el usuario determinado a la lista de editores de `Spreadsheet`.
`addEditor(user)`	`Spreadsheet`	Agrega el usuario determinado a la lista de editores de `Spreadsheet`.
`addEditors(emailAddresses)`	`Spreadsheet`	Agrega el array de usuarios determinado a la lista de editores de `Spreadsheet`.
`addMenu(name, subMenus)`	`void`	Crea un menú nuevo en la IU de la hoja de cálculo.
`addViewer(emailAddress)`	`Spreadsheet`	Agrega el usuario determinado a la lista de lectores de `Spreadsheet`.
`addViewer(user)`	`Spreadsheet`	Agrega el usuario determinado a la lista de lectores de `Spreadsheet`.
`addViewers(emailAddresses)`	`Spreadsheet`	Agrega el array de usuarios determinado a la lista de lectores de `Spreadsheet`.
`appendRow(rowContents)`	`Sheet`	Agrega una fila a la parte inferior de la región de datos actual en la hoja.
`autoResizeColumn(columnPosition)`	`Sheet`	Establece el ancho de la columna determinada para que se ajuste a su contenido.
`copy(name)`	`Spreadsheet`	Copia la hoja de cálculo y muestra la nueva.
`createDeveloperMetadataFinder()`	`DeveloperMetadataFinder`	Muestra un `DeveloperMetadataFinder` para encontrar metadatos del desarrollador dentro del alcance de esta hoja de cálculo.
`createTextFinder(findText)`	`TextFinder`	Crea un buscador de texto para la hoja de cálculo, que se puede usar a fin de buscar y reemplazar texto dentro de la hoja de cálculo.
`deleteActiveSheet()`	`Sheet`	Borra la hoja actualmente activa.
`deleteColumn(columnPosition)`	`Sheet`	Borra la columna en la posición determinada.
`deleteColumns(columnPosition, howMany)`	`void`	Elimina un número de columnas a partir de la posición determinada.
`deleteRow(rowPosition)`	`Sheet`	Borra la fila en la posición de fila dada.
`deleteRows(rowPosition, howMany)`	`void`	Elimina un número de filas que comienzan en la posición de fila dada.
`deleteSheet(sheet)`	`void`	Borra la hoja especificada.
`duplicateActiveSheet()`	`Sheet`	Duplica la hoja activa y la convierte en la hoja activa.
`getActiveCell()`	`Range`	Muestra la celda activa en esta hoja.
`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 activos.
`getActiveSheet()`	`Sheet`	Obtiene la hoja activa en una hoja de cálculo.
`getAs(contentType)`	`Blob`	Muestra los datos de este objeto como un BLOB convertido al tipo de contenido especificado.
`getBandings()`	`Banding[]`	Muestra todas las bandas en esta hoja de cálculo.
`getBlob()`	`Blob`	Muestra los datos dentro de este objeto como un BLOB.
`getColumnWidth(columnPosition)`	`Integer`	Obtiene el ancho en píxeles de la columna determinada.
`getCurrentCell()`	`Range`	Muestra la celda actual en la hoja activa o `null` si no hay una.
`getDataRange()`	`Range`	Muestra un `Range` que corresponde a las dimensiones en las que están presentes los datos.
`getDataSourceFormulas()`	`DataSourceFormula[]`	Obtiene todas las fórmulas de la fuente de datos.
`getDataSourcePivotTables()`	`DataSourcePivotTable[]`	Obtiene todas las tablas dinámicas de la fuente de datos.
`getDataSourceRefreshSchedules()`	`DataSourceRefreshSchedule[]`	Obtiene las programaciones de actualización de esta hoja de cálculo.
`getDataSourceSheets()`	`DataSourceSheet[]`	Muestra todas las hojas de origen de datos en la hoja de cálculo.
`getDataSourceTables()`	`DataSourceTable[]`	Obtiene todas las tablas de fuentes de datos.
`getDataSources()`	`DataSource[]`	Muestra todas las fuentes de datos en la hoja de cálculo.
`getDeveloperMetadata()`	`DeveloperMetadata[]`	Obtén los metadatos del desarrollador asociados con la hoja de cálculo de nivel superior.
`getEditors()`	`User[]`	Obtiene la lista de editores de este `Spreadsheet`.
`getFormUrl()`	`String`	Muestra la URL del formulario que envía sus respuestas a esta hoja de cálculo o `null` si esta hoja de cálculo no tiene un formulario asociado.
`getFrozenColumns()`	`Integer`	Muestra el número de columnas inmovilizadas.
`getFrozenRows()`	`Integer`	Muestra el número de filas inmovilizadas.
`getId()`	`String`	Obtiene un identificador único para esta hoja de cálculo.
`getImages()`	`OverGridImage[]`	Muestra todas las imágenes sobre la cuadrícula en la hoja.
`getIterativeCalculationConvergenceThreshold()`	`Number`	Muestra el valor límite utilizado durante el cálculo iterativo.
`getLastColumn()`	`Integer`	Muestra la posición de la última columna que tiene contenido.
`getLastRow()`	`Integer`	Muestra la posición de la última fila que tiene contenido.
`getMaxIterativeCalculationCycles()`	`Integer`	Muestra la cantidad máxima de iteraciones que se usarán durante el cálculo iterativo.
`getName()`	`String`	Obtiene el nombre del documento.
`getNamedRanges()`	`NamedRange[]`	Obtiene todos los rangos con nombre en esta hoja de cálculo.
`getNumSheets()`	`Integer`	Muestra la cantidad de hojas de esta hoja de cálculo.
`getOwner()`	`User`	Muestra el propietario del documento o `null` para un documento en una unidad compartida.
`getPredefinedSpreadsheetThemes()`	`SpreadsheetTheme[]`	Muestra la lista de temas predefinidos.
`getProtections(type)`	`Protection[]`	Obtiene un arreglo de objetos que representan todos los rangos o las hojas protegidas en la hoja de cálculo.
`getRange(a1Notation)`	`Range`	Muestra el rango como se especifica en la notación A1 o R1C1.
`getRangeByName(name)`	`Range`	Muestra un rango con nombre o `null` si no se encuentra ningún rango con el nombre especificado.
`getRangeList(a1Notations)`	`RangeList`	Muestra la colección `RangeList` que representa los rangos en la misma hoja especificada por una lista no vacía de notación A1 o R1C1.
`getRecalculationInterval()`	`RecalculationInterval`	Muestra el intervalo de cálculo para esta hoja de cálculo.
`getRowHeight(rowPosition)`	`Integer`	Obtiene la altura en píxeles de una fila determinada.
`getSelection()`	`Selection`	Muestra el `Selection` actual en la hoja de cálculo.
`getSheetByName(name)`	`Sheet`	Muestra una hoja con el nombre dado.
`getSheetId()`	`Integer`	Muestra el ID de la hoja representada por este objeto.
`getSheetName()`	`String`	Muestra el nombre de la hoja.
`getSheetValues(startRow, startColumn, numRows, numColumns)`	`Object[][]`	Muestra la cuadrícula rectangular de los valores de este rango a partir de las coordenadas dadas.
`getSheets()`	`Sheet[]`	Obtiene todas las hojas de esta hoja de cálculo.
`getSpreadsheetLocale()`	`String`	Obtiene la configuración regional de la hoja de cálculo.
`getSpreadsheetTheme()`	`SpreadsheetTheme`	Muestra el tema actual de la hoja de cálculo o `null` si no se aplica ningún tema.
`getSpreadsheetTimeZone()`	`String`	Obtiene la zona horaria de la hoja de cálculo.
`getUrl()`	`String`	Muestra la URL de la hoja de cálculo determinada.
`getViewers()`	`User[]`	Obtiene la lista de lectores y comentaristas de este `Spreadsheet`.
`hideColumn(column)`	`void`	Oculta la columna o las columnas en el rango dado.
`hideRow(row)`	`void`	Oculta las filas del rango especificado.
`insertColumnAfter(afterPosition)`	`Sheet`	Inserta una columna después de la posición de columna especificada.
`insertColumnBefore(beforePosition)`	`Sheet`	Inserta una columna antes de la posición de columna especificada.
`insertColumnsAfter(afterPosition, howMany)`	`Sheet`	Inserta varias columnas después de la posición determinada de la columna.
`insertColumnsBefore(beforePosition, howMany)`	`Sheet`	Inserta ciertas columnas antes de la posición indicada.
`insertDataSourceSheet(spec)`	`DataSourceSheet`	Inserta un `DataSourceSheet` nuevo en la hoja de cálculo y comienza la ejecución de datos.
`insertImage(blobSource, column, row)`	`OverGridImage`	Inserta un `Spreadsheet` como una imagen en el documento en una fila y columna determinadas.
`insertImage(blobSource, column, row, offsetX, offsetY)`	`OverGridImage`	Inserta un `Spreadsheet` como una imagen en el documento en una fila y columna determinadas, con desplazamiento de píxeles.
`insertImage(url, column, row)`	`OverGridImage`	Inserta una imagen en el documento en una fila y columna determinadas.
`insertImage(url, column, row, offsetX, offsetY)`	`OverGridImage`	Inserta una imagen en el documento en una fila y columna determinadas, con un desplazamiento de píxeles.
`insertRowAfter(afterPosition)`	`Sheet`	Inserta una fila después de la posición de fila especificada.
`insertRowBefore(beforePosition)`	`Sheet`	Inserta una fila antes de la posición de fila especificada.
`insertRowsAfter(afterPosition, howMany)`	`Sheet`	Inserta una cantidad de filas después de la posición de fila especificada.
`insertRowsBefore(beforePosition, howMany)`	`Sheet`	Inserta ciertas filas antes de la posición indicada.
`insertSheet()`	`Sheet`	Inserta una hoja nueva en la hoja de cálculo y usa un nombre de hoja predeterminado.
`insertSheet(sheetIndex)`	`Sheet`	Inserta una hoja nueva en la hoja de cálculo en el índice dado.
`insertSheet(sheetIndex, options)`	`Sheet`	Inserta una hoja nueva en la hoja de cálculo en el índice dado y usa argumentos avanzados opcionales.
`insertSheet(options)`	`Sheet`	Inserta una hoja nueva en la hoja de cálculo con un nombre de hoja predeterminado y argumentos avanzados opcionales.
`insertSheet(sheetName)`	`Sheet`	Inserta una hoja nueva en la hoja de cálculo con el nombre determinado.
`insertSheet(sheetName, sheetIndex)`	`Sheet`	Inserta una hoja nueva en la hoja de cálculo con el nombre dado en el índice indicado.
`insertSheet(sheetName, sheetIndex, options)`	`Sheet`	Inserta una hoja nueva en la hoja de cálculo con el nombre dado en el índice dado y usa argumentos avanzados opcionales.
`insertSheet(sheetName, options)`	`Sheet`	Inserta una hoja nueva en la hoja de cálculo con el nombre determinado y usa argumentos avanzados opcionales.
`insertSheetWithDataSourceTable(spec)`	`Sheet`	Inserta una hoja nueva en la hoja de cálculo, crea un `DataSourceTable` que abarca toda la hoja con la especificación de la fuente de datos determinada y comienza la ejecución de datos.
`isColumnHiddenByUser(columnPosition)`	`Boolean`	Muestra si el usuario ocultó la columna determinada.
`isIterativeCalculationEnabled()`	`Boolean`	Muestra si está habilitado el cálculo iterativo en esta hoja de cálculo.
`isRowHiddenByFilter(rowPosition)`	`Boolean`	Muestra si un filtro oculta la fila dada (no una vista de filtro).
`isRowHiddenByUser(rowPosition)`	`Boolean`	Muestra si el usuario oculta la fila especificada.
`moveActiveSheet(pos)`	`void`	Mueve la hoja activa a la posición indicada en la lista de hojas.
`moveChartToObjectSheet(chart)`	`Sheet`	Crea una hoja de cálculo `SheetType.OBJECT` y mueve la tabla proporcionada a ella.
`refreshAllDataSources()`	`void`	Actualiza todas las fuentes de datos admitidas y sus objetos de fuente de datos vinculados, y se omiten los objetos de fuente de datos no válidos.
`removeEditor(emailAddress)`	`Spreadsheet`	Quita el usuario determinado de la lista de editores de `Spreadsheet`.
`removeEditor(user)`	`Spreadsheet`	Quita el usuario determinado de la lista de editores de `Spreadsheet`.
`removeMenu(name)`	`void`	Quita un menú que agregó `addMenu(name, subMenus)`.
`removeNamedRange(name)`	`void`	Borra un rango con nombre con el nombre determinado.
`removeViewer(emailAddress)`	`Spreadsheet`	Quita el usuario determinado de la lista de lectores y comentaristas del `Spreadsheet`.
`removeViewer(user)`	`Spreadsheet`	Quita el usuario determinado de la lista de lectores y comentaristas del `Spreadsheet`.
`rename(newName)`	`void`	Cambia el nombre del documento.
`renameActiveSheet(newName)`	`void`	Cambia el nombre de la hoja activa actual a un nombre nuevo determinado.
`resetSpreadsheetTheme()`	`SpreadsheetTheme`	Quita el tema aplicado y establece el tema predeterminado en la hoja de cálculo.
`setActiveRange(range)`	`Range`	Configura el rango especificado como `active range` en la hoja activa, con la celda superior izquierda en el rango como `current cell`.
`setActiveRangeList(rangeList)`	`RangeList`	Establece la lista de rangos especificada como `active ranges` en la hoja activa.
`setActiveSelection(range)`	`Range`	Establece la región de selección activa para esta hoja.
`setActiveSelection(a1Notation)`	`Range`	Configura la selección activa, como se especifica en la notación A1 o en la notación R1C1.
`setActiveSheet(sheet)`	`Sheet`	Configura la hoja determinada como la hoja activa en la hoja de cálculo.
`setActiveSheet(sheet, restoreSelection)`	`Sheet`	Configura la hoja determinada como la hoja activa en la hoja de cálculo, con la opción de restablecer la selección más reciente dentro de esa hoja.
`setColumnWidth(columnPosition, width)`	`Sheet`	Establece el ancho de la columna determinada en píxeles.
`setCurrentCell(cell)`	`Range`	Configura la celda especificada como `current cell`.
`setFrozenColumns(columns)`	`void`	Inmoviliza la cantidad determinada de columnas.
`setFrozenRows(rows)`	`void`	Inmoviliza la cantidad determinada de filas.
`setIterativeCalculationConvergenceThreshold(minThreshold)`	`Spreadsheet`	Establece el valor de umbral mínimo para el cálculo iterativo.
`setIterativeCalculationEnabled(isEnabled)`	`Spreadsheet`	Establece si está habilitado el cálculo iterativo en esta hoja de cálculo.
`setMaxIterativeCalculationCycles(maxIterations)`	`Spreadsheet`	Establece la cantidad máxima de iteraciones de cálculos que deben realizarse durante los cálculos iterativos.
`setNamedRange(name, range)`	`void`	Asigna un nombre a un rango.
`setRecalculationInterval(recalculationInterval)`	`Spreadsheet`	Establece la frecuencia con la que se debe volver a calcular esta hoja de cálculo.
`setRowHeight(rowPosition, height)`	`Sheet`	Establece la altura de las filas en píxeles.
`setSpreadsheetLocale(locale)`	`void`	Establece la configuración regional de la hoja de cálculo.
`setSpreadsheetTheme(theme)`	`SpreadsheetTheme`	Establece un tema en la hoja de cálculo.
`setSpreadsheetTimeZone(timezone)`	`void`	Establece la zona horaria de la hoja de cálculo.
`show(userInterface)`	`void`	Muestra un componente de interfaz de usuario personalizada en un cuadro de diálogo centrado en la ventana de visualización del navegador del usuario.
`sort(columnPosition)`	`Sheet`	Ordena una hoja por columna de forma ascendente.
`sort(columnPosition, ascending)`	`Sheet`	Ordena una hoja por columna.
`toast(msg)`	`void`	Muestra una ventana emergente en la esquina inferior derecha de la hoja de cálculo con el mensaje dado.
`toast(msg, title)`	`void`	Muestra una ventana emergente en la esquina inferior derecha de la hoja de cálculo con el mensaje y el título dados.
`toast(msg, title, timeoutSeconds)`	`void`	Muestra una ventana emergente en la esquina inferior derecha de la hoja de cálculo con el título y el mensaje determinados que permanecen visibles durante un período determinado.
`unhideColumn(column)`	`void`	Muestra la columna en el rango dado.
`unhideRow(row)`	`void`	Muestra la fila del rango especificado.
`updateMenu(name, subMenus)`	`void`	Actualiza un menú que agregó `addMenu(name, subMenus)`.
`waitForAllDataExecutionsCompletion(timeoutInSeconds)`	`void`	Espera hasta que se completan todas las ejecuciones actuales en la hoja de cálculo y se agota el tiempo de espera después de la cantidad de segundos proporcionada.

Métodos obsoletos

Método	Tipo de datos que se muestra	Descripción breve
`getSheetProtection()`	`PageProtection`	Muestra una instancia `PageProtection` que describe los permisos de la hoja actual.
`isAnonymousView()`	`Boolean`	Indica si el documento permite la visualización anónima.
`isAnonymousWrite()`	`Boolean`	Indica si el documento permite ediciones de usuarios anónimos.
`setAnonymousAccess(anonymousReadAllowed, anonymousWriteAllowed)`	`void`	Establece la política del documento sobre lectura y escritura anónimas.
`setSheetProtection(permissions)`	`void`	Establece los permisos para la hoja actual.

Documentación detallada

`addDeveloperMetadata(key)`

Agrega metadatos del desarrollador con la clave especificada a la hoja de cálculo de nivel superior.

Parámetros

Nombre	Tipo	Descripción
`key`	`String`	La clave para los nuevos metadatos del desarrollador.

Volver

Spreadsheet: Esta hoja de cálculo para el encadenamiento.

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

`addDeveloperMetadata(key, visibility)`

Agrega metadatos del desarrollador con la clave y el nivel de visibilidad especificados a la hoja de cálculo.

Parámetros

Nombre	Tipo	Descripción
`key`	`String`	La clave para los nuevos metadatos del desarrollador.
`visibility`	`DeveloperMetadataVisibility`	La visibilidad de los nuevos metadatos del programador.

Volver

Spreadsheet: Esta hoja de cálculo para el encadenamiento.

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

`addDeveloperMetadata(key, value)`

Agrega metadatos del desarrollador con la clave y el valor especificados a la hoja de cálculo.

Parámetros

Nombre	Tipo	Descripción
`key`	`String`	La clave para los nuevos metadatos del desarrollador.
`value`	`String`	Es el valor de los nuevos metadatos del desarrollador.

Volver

Spreadsheet: Esta hoja de cálculo para el encadenamiento.

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

`addDeveloperMetadata(key, value, visibility)`

Agrega metadatos del desarrollador con la clave, el valor y la visibilidad especificados en la hoja de cálculo.

Parámetros

Nombre	Tipo	Descripción
`key`	`String`	La clave para los nuevos metadatos del desarrollador.
`value`	`String`	Es el valor de los nuevos metadatos del desarrollador.
`visibility`	`DeveloperMetadataVisibility`	La visibilidad de los nuevos metadatos del programador.

Volver

Spreadsheet: Esta hoja de cálculo para el encadenamiento.

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

`addEditor(emailAddress)`

Agrega el usuario determinado a la lista de editores de Spreadsheet. Si el usuario ya estaba en la lista de usuarios, este método lo promociona fuera de la lista de usuarios.

Parámetros

Nombre	Tipo	Descripción
`emailAddress`	`String`	La dirección de correo electrónico del usuario que se agregará.

Volver

Spreadsheet: Este Spreadsheet, para el encadenamiento

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

`addEditor(user)`

Agrega el usuario determinado a la lista de editores de Spreadsheet. Si el usuario ya estaba en la lista de usuarios, este método lo promociona fuera de la lista de usuarios.

Parámetros

Nombre	Tipo	Descripción
`user`	`User`	Una representación del usuario que se agregará.

Volver

Spreadsheet: Este Spreadsheet, para el encadenamiento

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

`addEditors(emailAddresses)`

Agrega el array de usuarios determinado a la lista de editores de Spreadsheet. Si alguno de los usuarios ya estaba en la lista de usuarios, este método los promociona fuera de la lista de usuarios.

Parámetros

Nombre	Tipo	Descripción
`emailAddresses`	`String[]`	Un arreglo de direcciones de correo electrónico de los usuarios para agregar.

Volver

Spreadsheet: Este Spreadsheet, para el encadenamiento

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

`addMenu(name, subMenus)`

Crea un menú nuevo en la IU de la hoja de cálculo.

Cada entrada del menú ejecuta una función definida por el usuario. Por lo general, debes llamarlo desde la función onOpen() para que el menú se cree automáticamente cuando se cargue la hoja de cálculo.

// The onOpen function is executed automatically every time a Spreadsheet is loaded
function onOpen() {
  var ss = SpreadsheetApp.getActiveSpreadsheet();
  var menuEntries = [];
  // When the user clicks on "addMenuExample" then "Menu Entry 1", the function function1 is
  // executed.
  menuEntries.push({name: "Menu Entry 1", functionName: "function1"});
  menuEntries.push(null); // line separator
  menuEntries.push({name: "Menu Entry 2", functionName: "function2"});

  ss.addMenu("addMenuExample", menuEntries);
}

Parámetros

Nombre	Tipo	Descripción
`name`	`String`	El nombre del menú que se creará.
`subMenus`	`Object[]`	Un arreglo de mapas de JavaScript con parámetros `name` y `functionName`. Puedes usar funciones de las bibliotecas incluidas, como `Library.libFunction1`.

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

`addViewer(emailAddress)`

Agrega el usuario determinado a la lista de lectores de Spreadsheet. Si el usuario ya estaba en la lista de editores, este método no tiene efecto.

Parámetros

Nombre	Tipo	Descripción
`emailAddress`	`String`	La dirección de correo electrónico del usuario que se agregará.

Volver

Spreadsheet: Este Spreadsheet, para el encadenamiento

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

`addViewer(user)`

Agrega el usuario determinado a la lista de lectores de Spreadsheet. Si el usuario ya estaba en la lista de editores, este método no tiene efecto.

Parámetros

Nombre	Tipo	Descripción
`user`	`User`	Una representación del usuario que se agregará.

Volver

Spreadsheet: Este Spreadsheet, para el encadenamiento

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

`addViewers(emailAddresses)`

Agrega el array de usuarios determinado a la lista de lectores de Spreadsheet. Si alguno de los usuarios ya estaba en la lista de editores, este método no tiene efecto en ellos.

Parámetros

Nombre	Tipo	Descripción
`emailAddresses`	`String[]`	Un arreglo de direcciones de correo electrónico de los usuarios para agregar.

Volver

Spreadsheet: Este Spreadsheet, para el encadenamiento

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

`appendRow(rowContents)`

Agrega una fila a la parte inferior de la región de datos actual en la hoja.

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

Nombre	Tipo	Descripción
`rowContents`	`Object[]`	Un arreglo de valores para insertar después de la última fila de la hoja.

Volver

Sheet: Es la hoja, útil para el encadenamiento de métodos.

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

`autoResizeColumn(columnPosition)`

Establece el ancho de la columna determinada para que se ajuste a su contenido.

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

Nombre	Tipo	Descripción
`columnPosition`	`Integer`	La posición de la columna dada a la que se le debe cambiar el tamaño.

Volver

Sheet: Es la hoja, útil para el encadenamiento de métodos.

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

`copy(name)`

Copia la hoja de cálculo y muestra la nueva.

// This code makes a copy of the current spreadsheet and names it appropriately
var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.copy("Copy of " + ss.getName());

Parámetros

Nombre	Tipo	Descripción
`name`	`String`	El nombre de la copia.

Volver

Spreadsheet: Esta hoja de cálculo para el encadenamiento.

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

`createDeveloperMetadataFinder()`

Muestra un DeveloperMetadataFinder para encontrar metadatos del desarrollador dentro del alcance de esta hoja de cálculo. De forma predeterminada, se consideran todos los metadatos asociados con la hoja de cálculo, las hojas, las filas y las columnas.

Volver

DeveloperMetadataFinder: Es un buscador de metadatos del desarrollador que permite buscar metadatos en el alcance de esta hoja de cálculo.

`createTextFinder(findText)`

Crea un buscador de texto para la hoja de cálculo, que se puede usar a fin de buscar y reemplazar texto dentro de la hoja de cálculo. La búsqueda comienza desde la primera hoja de la hoja de cálculo.

var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();

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

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

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

Parámetros

Nombre	Tipo	Descripción
`findText`	`String`	El texto que se desea buscar.

Volver

TextFinder: el TextFinder de la hoja de cálculo.

`deleteActiveSheet()`

Borra la hoja actualmente activa.

// The code below deletes the currently active sheet and stores the new active sheet in a
// variable
var newSheet = SpreadsheetApp.getActiveSpreadsheet().deleteActiveSheet();

Volver

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

`deleteColumn(columnPosition)`

Borra la columna en la posición determinada.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Columns start at "1" - this deletes the first column
sheet.deleteColumn(1);

Parámetros

Nombre	Tipo	Descripción
`columnPosition`	`Integer`	Posición de la columna, comenzando en 1 para la primera columna.

Volver

Sheet: Es la hoja, útil para el encadenamiento de métodos.

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

`deleteColumns(columnPosition, howMany)`

Elimina un número de columnas a partir de la posición determinada.

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

Nombre	Tipo	Descripción
`columnPosition`	`Integer`	La posición de la primera columna que se borrará.
`howMany`	`Integer`	Número de columnas que se eliminarán.

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

`deleteRow(rowPosition)`

Borra la fila en la posición de fila dada.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Rows start at "1" - this deletes the first row
sheet.deleteRow(1);

Parámetros

Nombre	Tipo	Descripción
`rowPosition`	`Integer`	Posición de la fila, comenzando en 1 para la primera fila.

Volver

Sheet: Es la hoja, útil para el encadenamiento de métodos.

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

`deleteRows(rowPosition, howMany)`

Elimina un número de filas que comienzan en la posición de fila dada.

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

Nombre	Tipo	Descripción
`rowPosition`	`Integer`	La posición de la primera fila que se borrará.
`howMany`	`Integer`	Número de filas que se borrarán.

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

`deleteSheet(sheet)`

Borra la hoja especificada.

// The code below deletes the specified sheet.
var ss = SpreadsheetApp.getActive();
var sheet = ss.getSheetByName('My Sheet');
ss.deleteSheet(sheet);

Parámetros

Nombre	Tipo	Descripción
`sheet`	`Sheet`	La hoja que deseas borrar.

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

`duplicateActiveSheet()`

Duplica la hoja activa y la convierte en la hoja activa.

// The code below makes a duplicate of the active sheet
SpreadsheetApp.getActiveSpreadsheet().duplicateActiveSheet();

Volver

Sheet: La hoja 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.currentonly
https://www.googleapis.com/auth/spreadsheets

`getActiveCell()`

Muestra la celda activa en esta hoja.

Nota: Es preferible utilizar getCurrentCell(), que muestra la celda destacada actual.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Returns the active cell
var cell = sheet.getActiveCell();

Volver

Range: Celda activa 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

`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 muestra solo el último rango seleccionado.

El término “rango activo” 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 manera activa.

var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
var activeRange = sheet.getActiveRange();

Volver

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

Consulta también

setActiveRange(range)

`getActiveRangeList()`

Muestra la lista de rangos activos en la hoja activa o null si no hay rangos activos.

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

var sheet = SpreadsheetApp.getActiveSheet();
// Returns the list of active ranges.
var activeRangeList = sheet.getActiveRangeList();

Volver

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

Consulta también

setActiveRangeList(rangeList)

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

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

Volver

Sheet: Es la hoja activa en la hoja de cálculo.

`getAs(contentType)`

Muestra los datos de este objeto como un BLOB convertido al tipo de contenido especificado. Este método agrega la extensión adecuada al nombre del archivo, por ejemplo, "myfile.pdf". Sin embargo, se supone que la parte del nombre de archivo que sigue al último punto (si existe) es una extensión existente que debe reemplazarse. En consecuencia, “ShoppingList.12.25.2014” se convierte en “ShoppingList.12.25.pdf”.

Si deseas ver las cuotas diarias de conversiones, consulta Cuotas para servicios de Google. Los dominios de Google Workspace creados recientemente pueden estar sujetos a cuotas más estrictas de forma temporal.

Parámetros

Nombre	Tipo	Descripción
`contentType`	`String`	El tipo de MIME al que deseas convertir. Para la mayoría de los BLOB, `'application/pdf'` es la única opción válida. Para las imágenes en formato BMP, GIF, JPEG o PNG, también son válidas cualquiera de las siguientes opciones: `'image/bmp'`, `'image/gif'`, `'image/jpeg'` o `'image/png'`.

Volver

Blob: los datos como un BLOB

`getBandings()`

Muestra todas las bandas en esta hoja de cálculo.

Volver

Banding[]: las bandas de esta 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

`getBlob()`

Muestra los datos dentro de este objeto como un BLOB.

Volver

Blob: los datos como un BLOB

`getColumnWidth(columnPosition)`

Obtiene el ancho en píxeles de la columna determinada.

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

// Columns start at 1
Logger.log(sheet.getColumnWidth(1));

Parámetros

Nombre	Tipo	Descripción
`columnPosition`	`Integer`	La posición de la columna que se desea examinar.

Volver

Integer: Ancho de columna en píxeles

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 en la hoja activa o null si no hay una. La celda actual es aquella que tiene el foco en la IU de Hojas de cálculo de Google y que se destaca con un borde oscuro. Nunca hay más de una celda actual. Cuando un usuario selecciona uno o más rangos de celdas, una de las celdas de la selección es la celda actual.

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

Volver

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

`getDataRange()`

Muestra un Range que corresponde a las dimensiones en las que están presentes los datos.

Esto es funcionalmente equivalente a crear un rango delimitado por A1 y (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);
}

Volver

Range: Un rango que contiene todos los datos 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

`getDataSourceFormulas()`

Obtiene todas las fórmulas de la fuente de datos.

Volver

DataSourceFormula[]: Es una lista de fórmulas de fuente de datos.

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

`getDataSourcePivotTables()`

Obtiene todas las tablas dinámicas de la fuente de datos.

Volver

DataSourcePivotTable[]: Es una lista de tablas dinámicas de fuente de datos.

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

`getDataSourceRefreshSchedules()`

Obtiene las programaciones de actualización de esta hoja de cálculo.

Volver

DataSourceRefreshSchedule[]: Son los programas de actualización de esta 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

`getDataSourceSheets()`

Muestra todas las hojas de origen de datos en la hoja de cálculo.

Volver

DataSourceSheet[]: Es un arreglo de todas las hojas de fuentes de datos.

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

`getDataSourceTables()`

Obtiene todas las tablas de fuentes de datos.

Volver

DataSourceTable[]: Es una lista de tablas de fuentes de datos.

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

`getDataSources()`

Muestra todas las fuentes de datos en la hoja de cálculo.

Volver

DataSource[]: Es un arreglo de todas las fuentes de datos.

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

`getDeveloperMetadata()`

Obtén los metadatos del desarrollador asociados con la hoja de cálculo de nivel superior.

Volver

DeveloperMetadata[]: Son los metadatos del desarrollador asociados con este rango.

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

`getEditors()`

Obtiene la lista de editores de este Spreadsheet.

Volver

User[]: Es un array de usuarios con permiso de edición.

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

`getFormUrl()`

Muestra la URL del formulario que envía sus respuestas a esta hoja de cálculo o null si esta hoja de cálculo no tiene un formulario asociado. Si varios formularios envían respuestas a esta hoja de cálculo, la URL del formulario que se muestra es indeterminada. Como alternativa, las asociaciones de URL por formulario de hoja se pueden recuperar a través del método Sheet.getFormUrl().

Volver

String: Es la URL del formulario que coloca sus respuestas en esta hoja de cálculo o null si esta hoja de cálculo no tiene un formulario asociado.

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

`getFrozenColumns()`

Muestra el número de columnas inmovilizadas.

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

Logger.log("Number of frozen columns: %s", sheet.getFrozenColumns());

Volver

Integer: la cantidad de columnas inmovilizadas

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

`getFrozenRows()`

Muestra el número de filas inmovilizadas.

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

Logger.log("Number of frozen rows: %s", sheet.getFrozenRows());

Volver

Integer: la cantidad de filas inmovilizadas

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

`getId()`

Obtiene un identificador único para esta hoja de cálculo. El ID de la hoja de cálculo se puede extraer de la 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 logs the ID for the active spreadsheet.
Logger.log(SpreadsheetApp.getActiveSpreadsheet().getId());

Volver

String: El ID único (o la clave) de la hoja de cálculo.

`getImages()`

Muestra todas las imágenes sobre la cuadrícula en la hoja.

Volver

OverGridImage[]: Es un array de imágenes sobre la cuadrícula.

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

`getIterativeCalculationConvergenceThreshold()`

Muestra el valor límite utilizado durante el cálculo iterativo. Cuando los resultados de los cálculos sucesivos difieren en menos que este valor, el cálculo iterativo se detiene.

Volver

Number: Es el umbral de convergencia.

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

`getLastColumn()`

Muestra la posición de la última columna que tiene contenido.

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

Volver

Integer: La última columna de la hoja en la que se incluye contenido

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

`getLastRow()`

Muestra la posición de la última fila que tiene contenido.

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

Volver

Integer: Es la última fila de la hoja que tiene contenido.

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

`getMaxIterativeCalculationCycles()`

Muestra la cantidad máxima de iteraciones que se usarán durante el cálculo iterativo.

Volver

Integer: es la cantidad máxima de iteraciones 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

`getName()`

Obtiene el nombre del documento.

var ss = SpreadsheetApp.getActiveSpreadsheet();
Logger.log(ss.getName());

Volver

String: Es el nombre 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

`getNamedRanges()`

Obtiene todos los rangos con nombre en esta hoja de cálculo.

// The code below logs the name of the first named range.
var namedRanges = SpreadsheetApp.getActiveSpreadsheet().getNamedRanges();
for (var i = 0; i < namedRanges.length; i++) {
  Logger.log(namedRanges[i].getName());
}

Volver

NamedRange[]: Es un array de todos los rangos con nombre 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

`getNumSheets()`

Muestra la cantidad de hojas de esta hoja de cálculo.

// The code below logs the number of sheets in the active spreadsheet.
Logger.log(SpreadsheetApp.getActiveSpreadsheet().getNumSheets());

Volver

Integer: la cantidad de hojas de la hoja de cálculo.

`getOwner()`

Muestra el propietario del documento o null para un documento en una unidad compartida.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var owner = ss.getOwner();
Logger.log(owner.getEmail());

Volver

User: El propietario del documento o null si el documento está en una unidad compartida

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

`getPredefinedSpreadsheetThemes()`

Muestra la lista de temas predefinidos.

// The code below returns the list of predefined themes.
var predefinedThemesList = SpreadsheetApp.getActiveSpreadsheet()
                               .getPredefinedSpreadsheetThemes();

Volver

SpreadsheetTheme[]: Es una lista de temas predefinidos.

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

`getProtections(type)`

Obtiene un arreglo de objetos que representan todos los rangos o las hojas protegidas en la hoja de cálculo.

// Remove all range protections in the spreadsheet that the user has permission to edit.
var ss = SpreadsheetApp.getActive();
var protections = ss.getProtections(SpreadsheetApp.ProtectionType.RANGE);
for (var i = 0; i < protections.length; i++) {
  var protection = protections[i];
  if (protection.canEdit()) {
    protection.remove();
  }
}

// Remove all sheet protections in the spreadsheet that the user has permission to edit.
var ss = SpreadsheetApp.getActive();
var protections = ss.getProtections(SpreadsheetApp.ProtectionType.SHEET);
for (var i = 0; i < protections.length; i++) {
  var protection = protections[i];
  if (protection.canEdit()) {
    protection.remove();
  }
}

Parámetros

Nombre	Tipo	Descripción
`type`	`ProtectionType`	El tipo de área protegida, ya sea `SpreadsheetApp.ProtectionType.RANGE` o `SpreadsheetApp.ProtectionType.SHEET`

Volver

Protection[]: Es un array de objetos que representan todos los rangos o las hojas protegidas 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

`getRange(a1Notation)`

Muestra el rango como se especifica en la notación A1 o R1C1.

// Get a range A1:D4 on sheet titled "Invoices"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var range = ss.getRange("Invoices!A1:D4");

// Get cell A1 on the first sheet
var sheet = ss.getSheets()[0];
var cell = sheet.getRange("A1");

Parámetros

Nombre	Tipo	Descripción
`a1Notation`	`String`	Rango que se va a mostrar, como se especifica en la notación A1 o en la notación R1C1.

Volver

Range: Es el rango en la ubicación designada.

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

`getRangeByName(name)`

Muestra un rango con nombre o null si no se encuentra ningún rango con el nombre especificado. Si varias hojas de la hoja de cálculo usan el mismo nombre de rango, especifica el nombre de la hoja sin comillas adicionales, por ejemplo, getRangeByName('TaxRates') o getRangeByName('Sheet Name!TaxRates'), pero no getRangeByName('"Sheet Name"!TaxRates').

// Log the number of columns for the range named 'TaxRates' in the active spreadsheet.
var range = SpreadsheetApp.getActiveSpreadsheet().getRangeByName('TaxRates');
if (range != null) {
  Logger.log(range.getNumColumns());
}

Parámetros

Nombre	Tipo	Descripción
`name`	`String`	El nombre del rango que se obtendrá.

Volver

Range: el rango de celdas con el nombre determinado.

`getRangeList(a1Notations)`

Muestra la colección RangeList que representa los rangos en la misma hoja especificada por una lista no vacía de notación A1 o R1C1.

// Get a list of ranges A1:D4, F1:H4.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
var rangeList  = sheet.getRangeList(['A1:D4', 'F1:H4']);

Parámetros

Nombre	Tipo	Descripción
`a1Notations`	`String[]`	La lista de rangos que se muestra, como se especifica en la notación A1 o R1C1.

Volver

RangeList: Es la lista de rango en la ubicación designada.

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

`getRecalculationInterval()`

Muestra el intervalo de cálculo para esta hoja de cálculo.

Volver

RecalculationInterval: Es el intervalo de cálculo de esta 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

`getRowHeight(rowPosition)`

Obtiene la altura en píxeles de una fila determinada.

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

// Rows start at 1
Logger.log(sheet.getRowHeight(1));

Parámetros

Nombre	Tipo	Descripción
`rowPosition`	`Integer`	Posición de la fila que se examinará.

Volver

Integer: Altura de fila en píxeles

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.getActiveSpreadsheet().getSelection();
var 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 alcances:

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

`getSheetByName(name)`

Muestra una hoja con el nombre dado.

Si varias hojas tienen el mismo nombre, se muestra la que se encuentra más a la izquierda. Muestra null si no hay una hoja con el nombre determinado.

// The code below logs the index of a sheet named "Expenses"
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheetByName("Expenses");
if (sheet != null) {
  Logger.log(sheet.getIndex());
}

Parámetros

Nombre	Tipo	Descripción
`name`	`String`	El nombre de la hoja que se obtendrá.

Volver

Sheet: Es la hoja con el nombre determinado.

`getSheetId()`

Muestra el ID de la hoja representada por este objeto.

Este es un ID para la hoja que es exclusivo de la hoja de cálculo. El ID es un número entero monótonamente creciente que se asigna en el momento de creación de la hoja y es independiente de su posición. Esto es útil junto con métodos como Range.copyFormatToRange(gridId, column, columnEnd, row, rowEnd), que toman un parámetro gridId en lugar de una instancia Sheet.

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

Logger.log(sheet.getSheetId());

Volver

Integer: Es un ID de la hoja única 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

`getSheetName()`

Muestra el nombre de la hoja.

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

Logger.log(sheet.getSheetName());

Volver

String: Es el nombre de la hoja.

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

`getSheetValues(startRow, startColumn, numRows, numColumns)`

Muestra la cuadrícula rectangular de los valores de este rango a partir de las coordenadas dadas. Un valor -1 dado como posición de fila o columna es equivalente a obtener la última fila o columna que tiene datos en la hoja.

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

// The two samples below produce the same output
var values = sheet.getSheetValues(1, 1, 3, 3);
Logger.log(values);

var range = sheet.getRange(1, 1, 3, 3);
values = range.getValues();
Logger.log(values);

Parámetros

Nombre	Tipo	Descripción
`startRow`	`Integer`	La posición de la fila inicial.
`startColumn`	`Integer`	La posición de la columna inicial
`numRows`	`Integer`	Cantidad de filas para las que se mostrarán los valores.
`numColumns`	`Integer`	Número de columnas para las que se mostrarán los valores.

Volver

Object[][]: Es un array de valores bidimensionales.

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

`getSheets()`

Obtiene todas las hojas de esta hoja de cálculo.

// The code below logs the name of the second sheet
var sheets = SpreadsheetApp.getActiveSpreadsheet().getSheets();
if (sheets.length > 1) {
  Logger.log(sheets[1].getName());
}

Volver

Sheet[]: Es un array de todas las hojas de la hoja de cálculo.

`getSpreadsheetLocale()`

Obtiene la configuración regional de la hoja de cálculo.

Volver

String: Es la configuración regional 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

`getSpreadsheetTheme()`

Muestra el tema actual de la hoja de cálculo o null si no se aplica ningún tema.

// The code below returns the current theme of the spreadsheet.
var currentTheme = SpreadsheetApp.getActiveSpreadsheet().getSpreadsheetTheme();

Volver

SpreadsheetTheme: Es el tema aplicado 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

`getSpreadsheetTimeZone()`

Obtiene la zona horaria de la hoja de cálculo.

Volver

String: Es la zona horaria, especificada en el formato “largo” (por ejemplo, “America/New_York”, según lo enumera Joda.org).

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

`getUrl()`

Muestra la URL de la hoja de cálculo determinada.

var ss = SpreadsheetApp.getActiveSpreadsheet();
Logger.log(ss.getUrl());

Volver

String: Es la URL de la hoja de cálculo 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.currentonly
https://www.googleapis.com/auth/spreadsheets

`getViewers()`

Obtiene la lista de lectores y comentaristas de este Spreadsheet.

Volver

User[]: Es un array de usuarios con permiso para ver o comentar.

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

`hideColumn(column)`

Oculta la columna o las columnas en el rango dado.

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

// This hides the first column
let range = sheet.getRange("A1");
sheet.hideColumn(range);

// This hides the first 3 columns
let range = sheet.getRange("A:C");
sheet.hideColumn(range);

Parámetros

Nombre	Tipo	Descripción
`column`	`Range`	El rango de columnas que se ocultará.

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

`hideRow(row)`

Oculta las filas del rango especificado.

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

// This hides the first row
var range = sheet.getRange("A1");
sheet.hideRow(range);

Parámetros

Nombre	Tipo	Descripción
`row`	`Range`	El rango de filas que se ocultará.

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

`insertColumnAfter(afterPosition)`

Inserta una columna después de la posición de columna especificada.

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

// This inserts a column after the first column position
sheet.insertColumnAfter(1);

Parámetros

Nombre	Tipo	Descripción
`afterPosition`	`Integer`	La columna después de la cual se debe agregar la columna nueva.

Volver

Sheet: Es la hoja, útil para el encadenamiento de métodos.

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

`insertColumnBefore(beforePosition)`

Inserta una columna antes de la posición de columna especificada.

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

// This inserts a column in the first column position
sheet.insertColumnBefore(1);

Parámetros

Nombre	Tipo	Descripción
`beforePosition`	`Integer`	La columna antes de la cual se debe agregar la columna nueva.

Volver

Sheet: Es la hoja, útil para el encadenamiento de métodos.

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

`insertColumnsAfter(afterPosition, howMany)`

Inserta varias columnas después de la posición determinada de la columna.

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

// This inserts a column in the second column position
sheet.insertColumnsAfter(1);

Parámetros

Nombre	Tipo	Descripción
`afterPosition`	`Integer`	La columna después de la cual se debe agregar la columna nueva.
`howMany`	`Integer`	Número de columnas que se van a insertar

Volver

Sheet: Es la hoja, útil para el encadenamiento de métodos.

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

`insertColumnsBefore(beforePosition, howMany)`

Inserta ciertas columnas antes de la posición indicada.

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

// This inserts five columns before the first column
sheet.insertColumnsBefore(1, 5);

Parámetros

Nombre	Tipo	Descripción
`beforePosition`	`Integer`	La columna antes de la cual se debe agregar la columna nueva.
`howMany`	`Integer`	Número de columnas que se van a insertar

Volver

Sheet: Es la hoja, útil para el encadenamiento de métodos.

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

`insertDataSourceSheet(spec)`

Inserta un DataSourceSheet nuevo en la hoja de cálculo y comienza la ejecución de datos. Como efecto secundario, esto también hace que la hoja nueva se active.

Muestra una excepción si el tipo de fuente de datos no está habilitado. Usa los métodos SpreadsheetApp#enable...Execution() a fin de habilitar la ejecución de datos para un tipo de fuente de datos específico.

Parámetros

Nombre	Tipo	Descripción
`spec`	`DataSourceSpec`	La especificación de la fuente de datos para insertar.

Volver

DataSourceSheet: la hoja de fuente de datos 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.currentonly
https://www.googleapis.com/auth/spreadsheets

`insertImage(blobSource, column, row)`

Inserta un Spreadsheet como una imagen en el documento en una fila y columna determinadas. El tamaño de la imagen se recupera del contenido de BLOB. El tamaño máximo permitido para un BLOB es 2 MB.

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

var blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1);

Parámetros

Nombre	Tipo	Descripción
`blobSource`	`BlobSource`	El BLOB que contiene el contenido de la imagen, el tipo de MIME y el nombre (opcional).
`column`	`Integer`	La posición de la columna.
`row`	`Integer`	La posición de la fila.

Volver

OverGridImage: Es la imagen insertada.

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

`insertImage(blobSource, column, row, offsetX, offsetY)`

Inserta un Spreadsheet como una imagen en el documento en una fila y columna determinadas, con desplazamiento de píxeles. El tamaño de la imagen se recupera del contenido de BLOB. El tamaño máximo permitido para un BLOB es 2 MB.

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

var blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1, 10, 10);

Parámetros

Nombre	Tipo	Descripción
`blobSource`	`BlobSource`	El BLOB que contiene el contenido de la imagen, el tipo de MIME y el nombre (opcional).
`column`	`Integer`	La posición de la columna.
`row`	`Integer`	La posición de la fila.
`offsetX`	`Integer`	Desplazamiento horizontal de la esquina de la celda en píxeles
`offsetY`	`Integer`	Desplazamiento vertical de la esquina de la celda en píxeles

Volver

OverGridImage: Es la imagen insertada.

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

`insertImage(url, column, row)`

Inserta una imagen en el documento en una fila y columna determinadas.

La URL proporcionada debe ser de acceso público.

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

sheet.insertImage("https://www.google.com/images/srpr/logo3w.png", 1, 1);

Parámetros

Nombre	Tipo	Descripción
`url`	`String`	Es la URL de la imagen.
`column`	`Integer`	Posición de la columna de la cuadrícula
`row`	`Integer`	Posición de la fila de cuadrícula

Volver

OverGridImage: Es la imagen insertada.

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

`insertImage(url, column, row, offsetX, offsetY)`

Inserta una imagen en el documento en una fila y columna determinadas, con un desplazamiento de píxeles.

La URL proporcionada debe ser de acceso público.

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

sheet.insertImage("https://www.google.com/images/srpr/logo3w.png", 1, 1, 10, 10);

Parámetros

Nombre	Tipo	Descripción
`url`	`String`	La URL de la imagen.
`column`	`Integer`	La posición de la columna.
`row`	`Integer`	La posición de la fila.
`offsetX`	`Integer`	Desplazamiento horizontal de la esquina de la celda en píxeles
`offsetY`	`Integer`	Desplazamiento vertical de la esquina de la celda en píxeles

Volver

OverGridImage: la imagen insertada.

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

`insertRowAfter(afterPosition)`

Inserta una fila después de la posición de fila especificada.

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

// This inserts a row after the first row position
sheet.insertRowAfter(1);

Parámetros

Nombre	Tipo	Descripción
`afterPosition`	`Integer`	La fila después de la cual se debe agregar la fila nueva.

Volver

Sheet: Es la hoja, útil para el encadenamiento de métodos.

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

`insertRowBefore(beforePosition)`

Inserta una fila antes de la posición de fila especificada.

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

// This inserts a row before the first row position
sheet.insertRowBefore(1);

Parámetros

Nombre	Tipo	Descripción
`beforePosition`	`Integer`	La fila antes de la cual se debe agregar la fila nueva.

Volver

Sheet: Es la hoja, útil para el encadenamiento de métodos.

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

`insertRowsAfter(afterPosition, howMany)`

Inserta una cantidad de filas después de la posición de fila especificada.

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

// This inserts five rows after the first row
sheet.insertRowsAfter(1, 5);

Parámetros

Nombre	Tipo	Descripción
`afterPosition`	`Integer`	La fila después de la cual deben agregarse las filas nuevas.
`howMany`	`Integer`	Número de filas que se insertarán.

Volver

Sheet: Es la hoja, útil para el encadenamiento de métodos.

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

`insertRowsBefore(beforePosition, howMany)`

Inserta ciertas filas antes de la posición indicada.

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

// This inserts five rows before the first row
sheet.insertRowsBefore(1, 5);

Parámetros

Nombre	Tipo	Descripción
`beforePosition`	`Integer`	La fila antes de la cual se deben agregar las filas nuevas.
`howMany`	`Integer`	Número de filas que se insertarán.

Volver

Sheet: Es la hoja, útil para el encadenamiento de métodos.

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

`insertSheet()`

Inserta una hoja nueva en la hoja de cálculo y usa un nombre de hoja predeterminado. La hoja nueva se convierte en la hoja activa.

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.insertSheet();

Volver

Sheet: La hoja 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.currentonly
https://www.googleapis.com/auth/spreadsheets

`insertSheet(sheetIndex)`

Inserta una hoja nueva en la hoja de cálculo en el índice dado. La hoja nueva se convertirá en la hoja activa.

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.insertSheet(1);

Parámetros

Nombre	Tipo	Descripción
`sheetIndex`	`Integer`	El índice de la hoja recién creada. Para insertar una hoja como la primera de la hoja de cálculo, configúrala en 0.

Volver

Sheet: La hoja 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.currentonly
https://www.googleapis.com/auth/spreadsheets

`insertSheet(sheetIndex, options)`

Inserta una hoja nueva en la hoja de cálculo en el índice dado y usa argumentos avanzados opcionales. La hoja nueva se convertirá en la hoja activa.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var templateSheet = ss.getSheetByName('Sales');
ss.insertSheet(1, {template: templateSheet});

Parámetros

Nombre	Tipo	Descripción
`sheetIndex`	`Integer`	El índice de la hoja recién creada. Para insertar una hoja como la primera de la hoja de cálculo, configúrala en 0.
`options`	`Object`	Argumentos avanzados de JavaScript opcionales.

Parámetros avanzados

Nombre	Tipo	Descripción
`template`	`Sheet`	Todos los datos del objeto de la hoja de plantillas se copian en la hoja nueva. La plantilla de la hoja de cálculo debe ser una de las hojas del objeto de la hoja de cálculo.

Volver

Sheet: La hoja 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.currentonly
https://www.googleapis.com/auth/spreadsheets

`insertSheet(options)`

Inserta una hoja nueva en la hoja de cálculo con un nombre de hoja predeterminado y argumentos avanzados opcionales. La hoja nueva se convertirá en la hoja activa.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var templateSheet = ss.getSheetByName('Sales');
ss.insertSheet({template: templateSheet});

Parámetros

Nombre	Tipo	Descripción
`options`	`Object`	A continuación, se detallan los argumentos avanzados de JavaScript opcionales.

Parámetros avanzados

Nombre	Tipo	Descripción
`template`	`Sheet`	Todos los datos del objeto de la hoja de plantillas se copian en la hoja nueva. La plantilla de la hoja de cálculo debe ser una de las hojas del objeto Spreadsheet.

Volver

Sheet: La hoja 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.currentonly
https://www.googleapis.com/auth/spreadsheets

`insertSheet(sheetName)`

Inserta una hoja nueva en la hoja de cálculo con el nombre determinado. La hoja nueva se convertirá en la hoja activa.

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.insertSheet('My New Sheet');

Parámetros

Nombre	Tipo	Descripción
`sheetName`	`String`	El nombre de la hoja nueva.

Volver

Sheet: La hoja 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.currentonly
https://www.googleapis.com/auth/spreadsheets

`insertSheet(sheetName, sheetIndex)`

Inserta una hoja nueva en la hoja de cálculo con el nombre dado en el índice indicado. La hoja nueva se convertirá en la hoja activa.

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.insertSheet('My New Sheet', 1);

Parámetros

Nombre	Tipo	Descripción
`sheetName`	`String`	El nombre de la hoja nueva.
`sheetIndex`	`Integer`	El índice de la hoja recién creada. Para insertar una hoja como la primera de la hoja de cálculo, configúrala en 0.

Volver

Sheet: La hoja 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.currentonly
https://www.googleapis.com/auth/spreadsheets

`insertSheet(sheetName, sheetIndex, options)`

Inserta una hoja nueva en la hoja de cálculo con el nombre dado en el índice dado y usa argumentos avanzados opcionales. La hoja nueva se convertirá en la hoja activa.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var templateSheet = ss.getSheetByName('Sales');
ss.insertSheet('My New Sheet', 1, {template: templateSheet});

Parámetros

Nombre	Tipo	Descripción
`sheetName`	`String`	El nombre de la hoja nueva.
`sheetIndex`	`Integer`	El índice de la hoja que acabas de insertar. Para insertar una hoja como la primera en una hoja de cálculo, configúrala en 0.
`options`	`Object`	Argumentos avanzados de JavaScript opcionales.

Parámetros avanzados

Nombre	Tipo	Descripción
`template`	`Sheet`	Todos los datos del objeto de la hoja de plantillas se copian en la hoja nueva. La plantilla de la hoja de cálculo debe ser una de las hojas del objeto de la hoja de cálculo.

Volver

Sheet: La hoja 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.currentonly
https://www.googleapis.com/auth/spreadsheets

`insertSheet(sheetName, options)`

Inserta una hoja nueva en la hoja de cálculo con el nombre determinado y usa argumentos avanzados opcionales. La hoja nueva se convertirá en la hoja activa.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var templateSheet = ss.getSheetByName('Sales');
ss.insertSheet('My New Sheet', {template: templateSheet});

Parámetros

Nombre	Tipo	Descripción
`sheetName`	`String`	El nombre de la hoja nueva.
`options`	`Object`	Argumentos avanzados de JavaScript opcionales.

Parámetros avanzados

Nombre	Tipo	Descripción
`template`	`Sheet`	Todos los datos del objeto de la hoja de plantillas se copian en la hoja nueva. La plantilla de la hoja de cálculo debe ser una de las hojas del objeto de la hoja de cálculo.

Volver

Sheet: La hoja 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.currentonly
https://www.googleapis.com/auth/spreadsheets

`insertSheetWithDataSourceTable(spec)`

Inserta una hoja nueva en la hoja de cálculo, crea un DataSourceTable que abarca toda la hoja con la especificación de la fuente de datos determinada y comienza la ejecución de datos. Como efecto secundario, hace que la hoja nueva esté activa.

Parámetros

Nombre	Tipo	Descripción
`spec`	`DataSourceSpec`	La especificación de la fuente de datos para insertar.

Volver

Sheet: La hoja 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.currentonly
https://www.googleapis.com/auth/spreadsheets

`isColumnHiddenByUser(columnPosition)`

Muestra si el usuario ocultó la columna determinada.

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

// Columns start at 1
Logger.log(sheet.isColumnHiddenByUser(1));

Parámetros

Nombre	Tipo	Descripción
`columnPosition`	`Integer`	La posición de la columna que se desea examinar.

Volver

Boolean: Es true si la columna está oculta; de lo contrario, false.

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

`isIterativeCalculationEnabled()`

Muestra si está habilitado el cálculo iterativo en esta hoja de cálculo.

Volver

Boolean: Es true si el cálculo iterativo está habilitado; de lo contrario, false.

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

`isRowHiddenByFilter(rowPosition)`

Muestra si un filtro oculta la fila dada (no una vista de filtro).

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

// Rows start at 1
Logger.log(sheet.isRowHiddenByFilter(1));

Parámetros

Nombre	Tipo	Descripción
`rowPosition`	`Integer`	Posición de la fila que se examinará.

Volver

Boolean: Es true si la fila está oculta; de lo contrario, false.

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

`isRowHiddenByUser(rowPosition)`

Muestra si el usuario oculta la fila especificada.

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

// Rows start at 1
Logger.log(sheet.isRowHiddenByUser(1));

Parámetros

Nombre	Tipo	Descripción
`rowPosition`	`Integer`	Posición de la fila que se examinará.

Volver

Boolean: Es true si la fila está oculta; de lo contrario, false.

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

`moveActiveSheet(pos)`

Mueve la hoja activa a la posición indicada en la lista de hojas. Muestra una excepción si la posición es negativa o mayor que el número de hojas.

// This example assumes that there are 2 sheets in the current
// active spreadsheet: one named "first" in position 1 and another named "second"
// in position 2.
var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
// Gets the "first" sheet and activates it.
var sheet = spreadsheet.getSheetByName("first").activate();

// Logs 'Current index of sheet: 1'
console.log("Current index of sheet: %s", sheet.getIndex());

spreadsheet.moveActiveSheet(2);

// Logs 'New index of sheet: 2'
console.log("New index of sheet: %s", sheet.getIndex());

Parámetros

Nombre	Tipo	Descripción
`pos`	`Integer`	La posición en el índice 1 a la que se debe mover la hoja activa en la lista de hojas.

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

`moveChartToObjectSheet(chart)`

Crea una hoja de cálculo SheetType.OBJECT y mueve la tabla proporcionada a ella. Si el gráfico ya está en su propia hoja, esa hoja se muestra sin crear una nueva.

var sheet = SpreadsheetApp.getActiveSheet();
var chart = sheet.newChart().setPosition(1, 1, 0, 0).build();
sheet.insertChart(chart);
var objectSheet = SpreadsheetApp.getActive().moveChartToObjectSheet(chart);

Parámetros

Nombre	Tipo	Descripción
`chart`	`EmbeddedChart`	El gráfico que se debe mover.

Volver

Sheet: la hoja en la que se encuentra el gráfico.

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

`refreshAllDataSources()`

Actualiza todas las fuentes de datos admitidas y sus objetos de fuente de datos vinculados, y se omiten los objetos de fuente de datos no válidos.

Usa los métodos SpreadsheetApp#enable...Execution() a fin de habilitar la ejecución de datos para un tipo de fuente de datos específico.

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

`removeEditor(emailAddress)`

Quita el usuario determinado de la lista de editores de Spreadsheet. Este método no impide que los usuarios accedan a Spreadsheet si pertenecen a una clase de usuarios que tiene acceso general, por ejemplo, si Spreadsheet se comparte con todo el dominio del usuario o si Spreadsheet está en una unidad compartida a la que el usuario puede acceder.

En el caso de los archivos de Drive, también se quita al usuario de la lista de lectores.

Parámetros

Nombre	Tipo	Descripción
`emailAddress`	`String`	La dirección de correo electrónico del usuario que se quitará.

Volver

Spreadsheet: Este Spreadsheet, para el encadenamiento

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

`removeEditor(user)`

En el caso de los archivos de Drive, también se quita al usuario de la lista de lectores.

Parámetros

Nombre	Tipo	Descripción
`user`	`User`	Una representación del usuario que se desea quitar.

Volver

Spreadsheet: Este Spreadsheet, para el encadenamiento

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

`removeMenu(name)`

Quita un menú que agregó addMenu(name, subMenus). El argumento name debe tener el mismo valor que la llamada a addMenu(name, subMenus) correspondiente.

// The onOpen function is executed automatically every time a Spreadsheet is loaded
function onOpen() {
  var ss = SpreadsheetApp.getActiveSpreadsheet();
  ss.addMenu("badMenu", [{name: "remove bad menu", functionName: "removeBadMenu"},
                                       {name: "foo", functionName: "foo"}]);
}
function removeBadMenu() {
  var ss = SpreadsheetApp.getActiveSpreadsheet();
  ss.removeMenu("badMenu");  // name must match the name used when added the menu
}
function foo(){
// Do nothing
}

Parámetros

Nombre	Tipo	Descripción
`name`	`String`	El nombre del menú que se quitará.

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

`removeNamedRange(name)`

Borra un rango con nombre con el nombre determinado. Muestra una excepción si no se encuentra ningún rango con el nombre determinado en la hoja de cálculo.

// The code below creates a new named range "foo", and then remove it.
var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.setNamedRange("foo", ss.getActiveRange());
ss.removeNamedRange("foo");

Parámetros

Nombre	Tipo	Descripción
`name`	`String`	El nombre del rango.

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

`removeViewer(emailAddress)`

Quita el usuario determinado de la lista de lectores y comentaristas del Spreadsheet. Este método no tiene efecto si el usuario es editor, no lector ni comentarista. Este método tampoco impide que los usuarios accedan a Spreadsheet si pertenecen a una clase de usuarios que tienen acceso general, por ejemplo, si Spreadsheet se comparte con todo el dominio del usuario o si el Spreadsheet está en una unidad compartida a la que el usuario puede acceder.

En el caso de los archivos de Drive, también se quita al usuario de la lista de editores.

Parámetros

Nombre	Tipo	Descripción
`emailAddress`	`String`	La dirección de correo electrónico del usuario que se quitará.

Volver

Spreadsheet: Es el Spreadsheet para el encadenamiento.

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

`removeViewer(user)`

Quita el usuario determinado de la lista de lectores y comentaristas del Spreadsheet. Este método no tiene efecto si el usuario es editor, no lector. Este método tampoco impide que los usuarios accedan a Spreadsheet si pertenecen a una clase de usuarios que tienen acceso general, por ejemplo, si Spreadsheet se comparte con todo el dominio del usuario o si Spreadsheet está en una unidad compartida a la que el usuario puede acceder.

En el caso de los archivos de Drive, también se quita al usuario de la lista de editores.

Parámetros

Nombre	Tipo	Descripción
`user`	`User`	Una representación del usuario que se desea quitar.

Volver

Spreadsheet: Es el Spreadsheet para el encadenamiento.

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

`rename(newName)`

Cambia el nombre del documento.

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.rename("This is the new name");

Parámetros

Nombre	Tipo	Descripción
`newName`	`String`	El nuevo nombre del documento.

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

`renameActiveSheet(newName)`

Cambia el nombre de la hoja activa actual a un nombre nuevo determinado.

// The code below renames the active sheet to "Hello world"
SpreadsheetApp.getActiveSpreadsheet().renameActiveSheet("Hello world");

Parámetros

Nombre	Tipo	Descripción
`newName`	`String`	El nuevo nombre de la hoja activa 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

`resetSpreadsheetTheme()`

Quita el tema aplicado y establece el tema predeterminado en la hoja de cálculo.

// The code below applies default theme on the spreadsheet.
SpreadsheetApp.getActiveSpreadsheet().resetSpreadsheetTheme();

Volver

SpreadsheetTheme: Es el tema predeterminado.

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

`setActiveRange(range)`

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

var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
var range = sheet.getRange('A1:D4');
sheet.setActiveRange(range);

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

Parámetros

Nombre	Tipo	Descripción
`range`	`Range`	Rango que se establecerá como rango activo

Volver

Range: El rango recién 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

`setActiveRangeList(rangeList)`

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

var sheet = SpreadsheetApp.getActiveSheet();
var rangeList = sheet.getRangeList(['D4', 'B2:C4']);
sheet.setActiveRangeList(rangeList);

var selection = sheet.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

Nombre	Tipo	Descripción
`rangeList`	`RangeList`	La lista de rangos que se seleccionarán.

Volver

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

`setActiveSelection(range)`

Establece la región de selección activa para esta hoja.

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

var range = sheet.getRange("A1:D4");
sheet.setActiveSelection(range);

Parámetros

Nombre	Tipo	Descripción
`range`	`Range`	Rango en el que se establecerá la selección activa

Volver

Range: El rango recién 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

`setActiveSelection(a1Notation)`

Configura la selección activa, como se especifica en la notación A1 o en la notación R1C1.

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

sheet.setActiveSelection("A1:D4");

Parámetros

Nombre	Tipo	Descripción
`a1Notation`	`String`	Rango que se configurará como activo, según se especifica en la notación A1 o R1C1.

Volver

Range: El rango recién 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

`setActiveSheet(sheet)`

Configura la hoja determinada como la hoja activa en la hoja de cálculo. La IU de Hojas de cálculo de Google muestra la hoja elegida, a menos que la hoja pertenezca a una hoja de cálculo diferente.

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

Parámetros

Nombre	Tipo	Descripción
`sheet`	`Sheet`	La hoja que se configurará como activa.

Volver

Sheet: La 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

`setActiveSheet(sheet, restoreSelection)`

Configura la hoja determinada como la hoja activa en la 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 la hoja pertenezca a una hoja de cálculo diferente.

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

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

Volver

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

`setColumnWidth(columnPosition, width)`

Establece el ancho de la columna determinada en píxeles.

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

// Sets the first column to a width of 200 pixels
sheet.setColumnWidth(1, 200);

Parámetros

Nombre	Tipo	Descripción
`columnPosition`	`Integer`	La posición de la columna determinada que se establecerá.
`width`	`Integer`	Ancho en píxeles para establecerlo

Volver

Sheet: Es la hoja, útil para el encadenamiento de métodos.

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

`setCurrentCell(cell)`

Configura 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 actual.

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

Nota: El Range especificado debe consistir en una celda; de lo contrario, se arroja una excepción.

var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
var cell = sheet.getRange('B5');
sheet.setCurrentCell(cell);

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

Parámetros

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

Volver

Range: Es la celda actual recién configurada.

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

`setFrozenColumns(columns)`

Inmoviliza la cantidad determinada de columnas. Si es cero, ninguna columna está inmovilizada.

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

// Freezes the first column
sheet.setFrozenColumns(1);

Parámetros

Nombre	Tipo	Descripción
`columns`	`Integer`	Número de columnas que se deben inmovilizar

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

`setFrozenRows(rows)`

Inmoviliza la cantidad determinada de filas. Si es cero, no hay filas inmovilizadas.

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

// Freezes the first row
sheet.setFrozenRows(1);

Parámetros

Nombre	Tipo	Descripción
`rows`	`Integer`	Número de filas que se deben inmovilizar.

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

`setIterativeCalculationConvergenceThreshold(minThreshold)`

Establece el valor de umbral mínimo para el cálculo iterativo. Cuando los resultados de los cálculos sucesivos difieren en menos que este valor, el cálculo iterativo se detiene. Este valor no debe ser negativo y su valor predeterminado es 0.05.

Parámetros

Nombre	Tipo	Descripción
`minThreshold`	`Number`	El umbral de convergencia mínimo (debe ser no negativo).

Volver

Spreadsheet: Esta hoja de cálculo para el encadenamiento.

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

`setIterativeCalculationEnabled(isEnabled)`

Establece si está habilitado el cálculo iterativo en esta hoja de cálculo. Si la cantidad máxima de ciclos de cálculo y el umbral de convergencia no se establecieron antes cuando el cálculo está habilitado, su valor predeterminado es 50 y 0.05, respectivamente. Si alguno se configuró anteriormente, conservarán sus valores anteriores.

Parámetros

Nombre	Tipo	Descripción
`isEnabled`	`Boolean`	`true` si se debe habilitar el cálculo iterativo; de lo contrario, `false`.

Volver

Spreadsheet: Esta hoja de cálculo para el encadenamiento.

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

`setMaxIterativeCalculationCycles(maxIterations)`

Establece la cantidad máxima de iteraciones de cálculos que deben realizarse durante los cálculos iterativos. Este valor debe estar entre 1 y 10,000 (inclusive) y el valor predeterminado es 50.

Parámetros

Nombre	Tipo	Descripción
`maxIterations`	`Integer`	La cantidad máxima de iteraciones de cálculo (entre 1 y 10,000).

Volver

Spreadsheet: Esta hoja de cálculo para el encadenamiento.

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

`setNamedRange(name, range)`

Asigna un nombre a un rango.

// The code below creates a new named range "TaxRates" in the active spreadsheet
var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.setNamedRange("TaxRates", SpreadsheetApp.getActiveRange());

Parámetros

Nombre	Tipo	Descripción
`name`	`String`	El nombre que se le dará al rango.
`range`	`Range`	La especificación del rango.

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

`setRecalculationInterval(recalculationInterval)`

Establece la frecuencia con la que se debe volver a calcular esta hoja de cálculo.

Parámetros

Nombre	Tipo	Descripción
`recalculationInterval`	`RecalculationInterval`	El nuevo intervalo de recálculo.

Volver

Spreadsheet: Esta hoja de cálculo para el encadenamiento.

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

`setRowHeight(rowPosition, height)`

Establece la altura de las filas en píxeles. De forma predeterminada, las filas aumentan para adaptarse al contenido de las celdas. Si deseas forzar las filas a una altura específica, usa Sheet.setRowHeightsForced(startRow, numRows, height).

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

// Sets the first row to a height of 200 pixels
sheet.setRowHeight(1, 200);

Parámetros

Nombre	Tipo	Descripción
`rowPosition`	`Integer`	La posición de la fila que se modificará.
`height`	`Integer`	Es la altura en píxeles en la que se debe establecer.

Volver

Sheet: Es la hoja, útil para el encadenamiento de métodos.

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

`setSpreadsheetLocale(locale)`

Establece la configuración regional de la hoja de cálculo.

Parámetros

Nombre	Tipo	Descripción
`locale`	`String`	El código de configuración regional que se utilizará (por ejemplo, 'en', 'fr' o 'en_US').

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

`setSpreadsheetTheme(theme)`

Establece un tema en la hoja de cálculo.

var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
// The code below sets the second predefined theme as the current theme of the spreadsheet.
var predefinedThemesList = spreadsheet.getPredefinedSpreadsheetThemes();
spreadsheet.setSpreadsheetTheme(predefinedThemesList[1]);

Parámetros

Nombre	Tipo	Descripción
`theme`	`SpreadsheetTheme`	Tema por aplicar

Volver

SpreadsheetTheme: Es el nuevo tema 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

`setSpreadsheetTimeZone(timezone)`

Establece la zona horaria de la hoja de cálculo.

Parámetros

Nombre	Tipo	Descripción
`timezone`	`String`	La zona horaria, especificada en el formato “largo” (por ejemplo, “America/New_York”, como se indica en Joda.org).

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

`show(userInterface)`

Muestra un componente de interfaz de usuario personalizada en un cuadro de diálogo centrado en la ventana de visualización del navegador del usuario. La ejecución de la secuencia de comandos del servidor no está suspendida. Para comunicarse con el servidor, el componente de la interfaz de usuario debe realizar devoluciones de llamada asíncronas en la secuencia de comandos del lado del servidor.

Si la secuencia de comandos del lado del servidor mostró anteriormente un diálogo que aún no se descartó, el diálogo existente se reemplaza por la interfaz de usuario del diálogo solicitado recientemente.

En el siguiente fragmento de código, se muestra una aplicación HtmlService simple en un diálogo con el título, la altura y el ancho especificados:

var htmlApp = HtmlService
    .createHtmlOutput('<p>A change of speed, a change of style...</p>')
    .setTitle('My HtmlService Application')
    .setWidth(250)
    .setHeight(300);

SpreadsheetApp.getActiveSpreadsheet().show(htmlApp);

// The script resumes execution immediately after showing the dialog.

Parámetros

Nombre	Tipo	Descripción
`userInterface`	`Object`	Un objeto `HtmlOutput`.

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/script.container.ui

`sort(columnPosition)`

Ordena una hoja por columna de forma ascendente.

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

// Sorts the sheet by the first column, ascending
sheet.sort(1);

Parámetros

Nombre	Tipo	Descripción
`columnPosition`	`Integer`	La columna que se debe ordenar.

Volver

Sheet: Es la hoja, útil para el encadenamiento de métodos.

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

`sort(columnPosition, ascending)`

Ordena una hoja por columna. Toma un parámetro para especificar el orden ascendente o descendente.

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

// Sorts the sheet by the first column, descending
sheet.sort(1, false);

Parámetros

Nombre	Tipo	Descripción
`columnPosition`	`Integer`	La columna que se debe ordenar.
`ascending`	`Boolean`	`true` para los tipos ascendentes, `false` para los descendentes.

Volver

Sheet: Es la hoja, útil para el encadenamiento de métodos.

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

`toast(msg)`

Muestra una ventana emergente en la esquina inferior derecha de la hoja de cálculo con el mensaje dado.

// Show a popup with the message "Task started".
SpreadsheetApp.getActiveSpreadsheet().toast('Task started');

Parámetros

Nombre	Tipo	Descripción
`msg`	`String`	Mensaje que se mostrará en el aviso

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

`toast(msg, title)`

Muestra una ventana emergente en la esquina inferior derecha de la hoja de cálculo con el mensaje y el título dados.

// Show a popup with the title "Status" and the message "Task started".
SpreadsheetApp.getActiveSpreadsheet().toast('Task started', 'Status');

Parámetros

Nombre	Tipo	Descripción
`msg`	`String`	Mensaje que se mostrará en el aviso
`title`	`String`	Es el título opcional del aviso.

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

`toast(msg, title, timeoutSeconds)`

Muestra una ventana emergente en la esquina inferior derecha de la hoja de cálculo con el título y el mensaje determinados que permanecen visibles durante un período determinado.

// Show a 3-second popup with the title "Status" and the message "Task started".
SpreadsheetApp.getActiveSpreadsheet().toast('Task started', 'Status', 3);

Parámetros

Nombre	Tipo	Descripción
`msg`	`String`	Mensaje que se mostrará en el aviso
`title`	`String`	Es el título opcional del aviso.
`timeoutSeconds`	`Number`	Tiempo de espera en segundos: si es `null`, el aviso se establecerá en 5 segundos de forma predeterminada; si es negativo, el aviso permanecerá hasta que se descarte.

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

`unhideColumn(column)`

Muestra la columna en el rango dado.

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

// This unhides the first column if it was previously hidden
var range = sheet.getRange("A1");
sheet.unhideColumn(range);

Parámetros

Nombre	Tipo	Descripción
`column`	`Range`	El rango que se mostrará, si está oculto.

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

`unhideRow(row)`

Muestra la fila del rango especificado.

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

// This unhides the first row if it was previously hidden
var range = sheet.getRange("A1");
sheet.unhideRow(range);

Parámetros

Nombre	Tipo	Descripción
`row`	`Range`	El rango que se mostrará, si está oculto.

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

`updateMenu(name, subMenus)`

Actualiza un menú que agregó addMenu(name, subMenus). Funciona igual que addMenu(name, subMenus).

var ss = SpreadsheetApp.getActiveSpreadsheet();
var menuEntries = [];
menuEntries.push({name: "Lone Menu Entry", functionName: "function1"});
ss.updateMenu("addMenuExample", menuEntries);

Parámetros

Nombre	Tipo	Descripción
`name`	`String`	El nombre del menú que se actualizará.
`subMenus`	`Object[]`	Un arreglo de mapas de JavaScript con parámetros `name` y `functionName`. Puedes usar funciones de las bibliotecas incluidas, como `Library.libFunction1`.

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

`waitForAllDataExecutionsCompletion(timeoutInSeconds)`

Espera hasta que se completan todas las ejecuciones actuales en la hoja de cálculo y se agota el tiempo de espera después de la cantidad de segundos proporcionada. Muestra una excepción si las ejecuciones no se completan cuando se agota el tiempo de espera, pero no se cancelan las ejecuciones de datos.

Parámetros

Nombre	Tipo	Descripción
`timeoutInSeconds`	`Integer`	El tiempo que se debe esperar para que se ejecuten las ejecuciones de datos, en segundos. El máximo es 300 segundos.

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

Métodos obsoletos

`getSheetProtection()`

Obsoleto. Para las hojas de cálculo creadas en la versión más reciente de Hojas de cálculo de Google, usa Sheet.getProtections(type), que muestra la clase Protection más potente. Si bien este método es obsoleto, la versión de Hojas de cálculo anterior es compatible con esta versión

Muestra una instancia PageProtection que describe los permisos de la hoja actual.

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

var permissions = sheet.getSheetProtection();

permissions.setProtected(true);
permissions.addUser("user@example.com");

// Logs the users that have access to edit this sheet. Note that this
// is different from access to the entire spreadsheet - getUsers()
// only returns users if permissions.isProtected() is set to true.
var users = permissions.getUsers();
Logger.log(users);

Volver

PageProtection: un objeto que describe los permisos de acceso a las hojas

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

`isAnonymousView()`

Obsoleto. A partir de enero de 2014, esta función dejó de estar disponible y no está disponible en la nueva versión de Hojas de cálculo de Google.

Indica si el documento permite la visualización anónima. Como ya no se admite en la versión nueva de Hojas de cálculo de Google, usa File.getSharingAccess() y File.getSharingPermission() en su lugar.

// Determine if the document allows anonymous viewing via the Drive API.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var file = DriveApp.getFileById(ss.getId());
var access = file.getSharingAccess();
var permission = file.getSharingPermission();
var isAnonymousAccess =
    access == DriveApp.Access.ANYONE || access == DriveApp.Access.ANYONE_WITH_LINK;
var isAnonymousEdit = isAnonymousAccess && permission != DriveApp.Permission.NONE;

Volver

Boolean: Es true si el documento permite la visualización anónima, en caso contrario, false.

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

Consulta también

Servicio de Drive

`isAnonymousWrite()`

Obsoleto. A partir de enero de 2014, esta función dejó de estar disponible y no está disponible en la nueva versión de Hojas de cálculo de Google.

Indica si el documento permite ediciones de usuarios anónimos. Como ya no se admite en la versión nueva de Hojas de cálculo de Google, usa File.getSharingAccess() y File.getSharingPermission() en su lugar.

// Determine if the document allow anonymous edits via the Drive API.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var file = DriveApp.getFileById(ss.getId());
var access = file.getSharingAccess();
var permission = file.getSharingPermission();
var isAnonymousAccess =
    access == DriveApp.Access.ANYONE || access == DriveApp.Access.ANYONE_WITH_LINK;
var isAnonymousEdit = isAnonymousAccess && permission == DriveApp.Permission.EDIT;

Volver

Boolean: Es true si el documento permite la edición anónima. De lo contrario, false.

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

Consulta también

Servicio de Drive

`setAnonymousAccess(anonymousReadAllowed, anonymousWriteAllowed)`

Obsoleto. A partir de enero de 2014, esta función dejó de estar disponible y no está disponible en la nueva versión de Hojas de cálculo de Google.

Establece la política del documento sobre lectura y escritura anónimas. Como ya no se admite en la versión nueva de Hojas de cálculo de Google, usa File.setSharing(accessType, permissionType) como alternativa.

// Set the document's policy on anonymous reading and writing via the Drive API.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var file = DriveApp.getFileById(ss.getId());

// Set anonymous read.
file.setSharing(DriveApi.Access.ANYONE, DriveApi.Permission.VIEW);

// Set anonymous write.
file.setSharing(DriveApi.Access.ANYONE, DriveApi.Permission.EDIT);

// Disable anonymous access.
file.setSharing(DriveApi.Access.PRIVATE, file.getSharingPermission());

Parámetros

Nombre	Tipo	Descripción
`anonymousReadAllowed`	`Boolean`	`true` para permitir lecturas anónimas; de lo contrario, `false`.
`anonymousWriteAllowed`	`Boolean`	`true` para permitir lecturas anónimas; de lo contrario, `false`.

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

Consulta también

isAnonymousView()
isAnonymousWrite()
Servicio de Drive

`setSheetProtection(permissions)`

Obsoleto. Para las hojas de cálculo creadas en la versión más reciente de Hojas de cálculo de Google, usa Sheet.protect(), que muestra la clase Protection más potente. Aunque este método es obsoleto, la versión de Hojas de cálculo anterior es compatible con esta versión

Establece los permisos para la hoja actual.

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

var permissions = sheet.getSheetProtection();

// This copies the permissions on the first sheet to the second sheet
var sheetToClonePermissionsTo = ss.getSheets()[1];
sheetToClonePermissionsTo.setSheetProtection(permissions);

Parámetros

Nombre	Tipo	Descripción
`permissions`	`PageProtection`	El objeto de los permisos de acceso que se debe establecer en esta hoja.

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