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 la visibilidad especificadas 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 a la hoja de cálculo.
`addEditor(emailAddress)`	`Spreadsheet`	Agrega el usuario especificado a la lista de editores de `Spreadsheet`.
`addEditor(user)`	`Spreadsheet`	Agrega el usuario especificado 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 nuevo menú en la IU de la hoja de cálculo.
`addViewer(emailAddress)`	`Spreadsheet`	Agrega al usuario determinado a la lista de usuarios de `Spreadsheet`.
`addViewer(user)`	`Spreadsheet`	Agrega al usuario determinado a la lista de usuarios de `Spreadsheet`.
`addViewers(emailAddresses)`	`Spreadsheet`	Agrega el array de usuarios determinado a la lista de usuarios 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 para buscar y reemplazar texto dentro de la hoja de cálculo.
`deleteActiveSheet()`	`Sheet`	Borra la hoja activa actualmente.
`deleteColumn(columnPosition)`	`Sheet`	Borra la columna en la posición determinada.
`deleteColumns(columnPosition, howMany)`	`void`	Borra una cantidad de columnas a partir de la posición de columna especificada.
`deleteRow(rowPosition)`	`Sheet`	Borra la fila en la posición determinada.
`deleteRows(rowPosition, howMany)`	`void`	Borra una cantidad de filas a partir de la posición de fila determinada.
`deleteSheet(sheet)`	`void`	Borra la hoja especificada.
`duplicateActiveSheet()`	`Sheet`	Duplica la hoja activa y la convierte en la hoja activa.
`getActiveCell()`	`Range`	Devuelve 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 dentro de este objeto como un blob convertido al tipo de contenido especificado.
`getBandings()`	`Banding[]`	Muestra todas las bandas de esta hoja de cálculo.
`getBlob()`	`Blob`	Devuelve los datos dentro de este objeto como un blob.
`getColumnWidth(columnPosition)`	`Integer`	Obtiene el ancho en píxeles de la columna especificada.
`getCurrentCell()`	`Range`	Muestra la celda actual en la hoja activa o `null` si no hay una celda actual.
`getDataRange()`	`Range`	Devuelve 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 los programas de actualización de esta hoja de cálculo.
`getDataSourceSheets()`	`DataSourceSheet[]`	Muestra todas las hojas de la fuente de datos en la hoja de cálculo.
`getDataSourceTables()`	`DataSourceTable[]`	Obtiene todas las tablas de la fuente de datos.
`getDataSources()`	`DataSource[]`	Muestra todas las fuentes de datos de la hoja de cálculo.
`getDeveloperMetadata()`	`DeveloperMetadata[]`	Obtiene 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 la cantidad de columnas inmovilizadas.
`getFrozenRows()`	`Integer`	Muestra la cantidad 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 de la hoja.
`getIterativeCalculationConvergenceThreshold()`	`Number`	Devuelve el valor del umbral que se usa durante el cálculo iterativo.
`getLastColumn()`	`Integer`	Devuelve la posición de la última columna que tiene contenido.
`getLastRow()`	`Integer`	Devuelve 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 de 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 array de objetos que representan todos los rangos o hojas protegidos de 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 determinado.
`getRangeList(a1Notations)`	`RangeList`	Muestra la colección `RangeList` que representa los rangos en la misma hoja especificada por una lista no vacía de notaciones A1 o R1C1.
`getRecalculationInterval()`	`RecalculationInterval`	Devuelve el intervalo de cálculo de esta hoja de cálculo.
`getRowHeight(rowPosition)`	`Integer`	Obtiene la altura en píxeles de la fila determinada.
`getSelection()`	`Selection`	Muestra el `Selection` actual en la hoja de cálculo.
`getSheetByName(name)`	`Sheet`	Muestra una hoja con el nombre determinado.
`getSheetId()`	`Integer`	Devuelve el ID de la hoja que representa este objeto.
`getSheetName()`	`String`	Muestra el nombre de la hoja.
`getSheetValues(startRow, startColumn, numRows, numColumns)`	`Object[][]`	Devuelve la cuadrícula rectangular de valores para este rango a partir de las coordenadas determinadas.
`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 usuarios y comentaristas de este `Spreadsheet`.
`hideColumn(column)`	`void`	Oculta la columna o las columnas del rango determinado.
`hideRow(row)`	`void`	Oculta las filas del rango especificado.
`insertColumnAfter(afterPosition)`	`Sheet`	Inserta una columna después de la posición de columna determinada.
`insertColumnBefore(beforePosition)`	`Sheet`	Inserta una columna antes de la posición de la columna determinada.
`insertColumnsAfter(afterPosition, howMany)`	`Sheet`	Inserta una cantidad determinada de columnas después de la posición de columna especificada.
`insertColumnsBefore(beforePosition, howMany)`	`Sheet`	Inserta una cantidad de columnas antes de la posición de columna determinada.
`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 un 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 determinada.
`insertRowBefore(beforePosition)`	`Sheet`	Inserta una fila antes de la posición de fila determinada.
`insertRowsAfter(afterPosition, howMany)`	`Sheet`	Inserta una cantidad de filas después de la posición de fila determinada.
`insertRowsBefore(beforePosition, howMany)`	`Sheet`	Inserta una cantidad de filas antes de la posición de fila determinada.
`insertSheet()`	`Sheet`	Inserta una hoja nueva en la hoja de cálculo con un nombre predeterminado.
`insertSheet(sheetIndex)`	`Sheet`	Inserta una hoja nueva en la hoja de cálculo en el índice determinado.
`insertSheet(sheetIndex, options)`	`Sheet`	Inserta una hoja nueva en la hoja de cálculo en el índice determinado 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 indicado.
`insertSheet(sheetName, sheetIndex)`	`Sheet`	Inserta una hoja nueva en la hoja de cálculo con el nombre indicado en el índice indicado.
`insertSheet(sheetName, sheetIndex, options)`	`Sheet`	Inserta una hoja nueva en la hoja de cálculo con el nombre determinado en el índice determinado 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 abarque 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 el cálculo iterativo está activado en esta hoja de cálculo.
`isRowHiddenByFilter(rowPosition)`	`Boolean`	Muestra si un filtro (no una vista de filtro) oculta la fila determinada.
`isRowHiddenByUser(rowPosition)`	`Boolean`	Muestra si el usuario ocultó la fila determinada.
`moveActiveSheet(pos)`	`void`	Mueve la hoja activa a la posición determinada en la lista de hojas.
`moveChartToObjectSheet(chart)`	`Sheet`	Crea una hoja `SheetType.OBJECT` nueva y mueve el gráfico proporcionado a ella.
`refreshAllDataSources()`	`void`	Actualiza todas las fuentes de datos admitidas y sus objetos de fuente de datos vinculados, y omite los objetos de fuente de datos no válidos.
`removeEditor(emailAddress)`	`Spreadsheet`	Quita al usuario determinado de la lista de editores de `Spreadsheet`.
`removeEditor(user)`	`Spreadsheet`	Quita al 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 al usuario determinado de la lista de usuarios y comentaristas de `Spreadsheet`.
`removeViewer(user)`	`Spreadsheet`	Quita al usuario determinado de la lista de usuarios y comentaristas de `Spreadsheet`.
`rename(newName)`	`void`	Cambia el nombre del documento.
`renameActiveSheet(newName)`	`void`	Cambia el nombre de la hoja activa actual al nombre nuevo que se proporciona.
`resetSpreadsheetTheme()`	`SpreadsheetTheme`	Quita el tema aplicado y establece el tema predeterminado en la hoja de cálculo.
`setActiveRange(range)`	`Range`	Establece el rango especificado como `active range` en la hoja activa, con la celda superior izquierda del 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`	Establece la selección activa, como se especifica en la notación A1 o R1C1.
`setActiveSheet(sheet)`	`Sheet`	Establece la hoja determinada como la hoja activa en la hoja de cálculo.
`setActiveSheet(sheet, restoreSelection)`	`Sheet`	Establece la hoja determinada como la hoja activa en la hoja de cálculo, con una opción para 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`	Establece 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 mínimo del umbral para el cálculo iterativo.
`setIterativeCalculationEnabled(isEnabled)`	`Spreadsheet`	Establece si el cálculo iterativo está activado en esta hoja de cálculo.
`setMaxIterativeCalculationCycles(maxIterations)`	`Spreadsheet`	Establece la cantidad máxima de iteraciones de cálculo que se deben realizar durante el cálculo iterativo.
`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 la fila determinada 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 personalizado en un diálogo centrado en el viewport 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 determinado.
`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 determinados.
`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 determinado.
`unhideRow(row)`	`void`	Muestra la fila en el rango determinado.
`updateMenu(name, subMenus)`	`void`	Actualiza un menú que agregó `addMenu(name, subMenus)`.
`waitForAllDataExecutionsCompletion(timeoutInSeconds)`	`void`	Espera hasta que se completen todas las ejecuciones actuales de la hoja de cálculo y se agote 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 de `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 la lectura y escritura anónimas.
`setSheetProtection(permissions)`	`void`	Establece los permisos de 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.

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

// Adds the key 'NAME' in the developer metadata for the spreadsheet.
ss.addDeveloperMetadata('NAME')

// Gets the first developer metadata object and logs its key.
const developerMetaData = ss.getDeveloperMetadata()[0]
console.log(developerMetaData.getKey())

Parámetros

Nombre	Tipo	Descripción
`key`	`String`	Es la clave de los nuevos metadatos del desarrollador.

Volver

Spreadsheet: Esta hoja de cálculo, para encadenar.

Autorización

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

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

`addDeveloperMetadata(key, visibility)`

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

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

// Adds the key 'NAME' in the developer metadata for the spreadsheet and sets the visibility
// to the developer project that created the metadata.
ss.addDeveloperMetadata('NAME', SpreadsheetApp.DeveloperMetadataVisibility.PROJECT);

// Gets the first developer metadata object and logs its key and visibility setting.
const developerMetaData = ss.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(`Key: ${developerMetaData.getKey()},
.             Visibility: ${developerMetaData.getVisibility()}`);

Parámetros

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

Volver

Spreadsheet: Esta hoja de cálculo, para encadenar.

Autorización

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

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

`addDeveloperMetadata(key, value)`

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

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

// Adds the key 'NAME' and sets the value to 'GOOGLE' in the developer metadata for the
// spreadsheet.
ss.addDeveloperMetadata('NAME', 'GOOGLE');

// Gets the first developer metadata object and logs its key and value.
const developerMetaData = ss.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(`Key: ${developerMetaData.getKey()}, Value: ${developerMetaData.getValue()}`);

Parámetros

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

Volver

Spreadsheet: Esta hoja de cálculo, para encadenar.

Autorización

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

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

`addDeveloperMetadata(key, value, visibility)`

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

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

// Adds the key 'NAME', sets the value to 'GOOGLE', and sets the visibility
// to any developer project with document access.
ss.addDeveloperMetadata('NAME', 'GOOGLE', SpreadsheetApp.DeveloperMetadataVisibility.DOCUMENT);

// Gets the first developer metadata object and logs its key, value, and visibility setting.
const developerMetaData = ss.getDeveloperMetadata()[0];
console.log(`Key: ${developerMetaData.getKey()},
             Value: ${developerMetaData.getValue()},
             Visibility: ${developerMetaData.getVisibility()}`);

Parámetros

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

Volver

Spreadsheet: Esta hoja de cálculo, para encadenar.

Autorización

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

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

`addEditor(emailAddress)`

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

Parámetros

Nombre	Tipo	Descripción
`emailAddress`	`String`	Es la dirección de correo electrónico del usuario que quieres agregar.

Volver

Spreadsheet: Este Spreadsheet, para encadenar.

Autorización

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

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

`addEditor(user)`

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

Parámetros

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

Volver

Spreadsheet: Este Spreadsheet, para encadenar.

Autorización

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

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

`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 lo quita de la lista.

Parámetros

Nombre	Tipo	Descripción
`emailAddresses`	`String[]`	Es un array de direcciones de correo electrónico de los usuarios que se agregarán.

Volver

Spreadsheet: Este Spreadsheet, para encadenar.

Autorización

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

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

`addMenu(name, subMenus)`

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

Cada entrada de menú ejecuta una función definida por el usuario. Por lo general, es conveniente 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`	Es el nombre del menú que se creará.
`subMenus`	`Object[]`	Un array 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 ámbitos:

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

`addViewer(emailAddress)`

Agrega al usuario determinado a la lista de usuarios 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`	Es la dirección de correo electrónico del usuario que quieres agregar.

Volver

Spreadsheet: Este Spreadsheet, para encadenar.

Autorización

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

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

`addViewer(user)`

Agrega al usuario determinado a la lista de usuarios 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`	Es una representación del usuario que se agregará.

Volver

Spreadsheet: Este Spreadsheet, para encadenar.

Autorización

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

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

`addViewers(emailAddresses)`

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

Parámetros

Nombre	Tipo	Descripción
`emailAddresses`	`String[]`	Es un array de direcciones de correo electrónico de los usuarios que se agregarán.

Volver

Spreadsheet: Este Spreadsheet, para encadenar.

Autorización

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

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

`appendRow(rowContents)`

Agrega una fila a la parte inferior de la región de datos actual en la hoja. Si el contenido de una celda comienza con =, se interpreta como una fórmula.

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

// Appends a new row with 3 columns to the bottom of the current
// data region in the sheet containing the values in the array.
sheet.appendRow(["a man", "a plan", "panama"]);

Parámetros

Nombre	Tipo	Descripción
`rowContents`	`Object[]`	Es un array de valores que se insertarán después de la última fila de la hoja.

Volver

Sheet: Es la hoja, útil para encadenar métodos.

Autorización

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

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

`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`	Es la posición de la columna determinada a la que se le cambiará el tamaño.

Volver

Sheet: Es la hoja, útil para encadenar métodos.

Autorización

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

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

`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`	Es el nombre de la copia.

Volver

Spreadsheet: Esta hoja de cálculo, para encadenar.

Autorización

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

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

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

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

// Adds developer metadata to the spreadsheet.
ss.addDeveloperMetadata('NAME', 'CHARLIE');
ss.addDeveloperMetadata('COMPANY', 'EXAMPLE ORGANIZATION');
ss.addDeveloperMetadata('TECHNOLOGY', 'JAVASCRIPT');

// Creates a developer metadata finder.
const developerMetadataFinder = ss.createDeveloperMetadataFinder();

// Finds the developer metadata objects with 'COMPANY' as the key.
const googleMetadataFromSpreadsheet = developerMetadataFinder.withKey('COMPANY').find();

// Gets the first result of developer metadata that has the key 'COMPANY' and logs its value.
console.log(googleMetadataFromSpreadsheet[0].getValue());

Volver

DeveloperMetadataFinder: Es un buscador de metadatos del desarrollador para 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 para 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`	Es el texto que se busca.

Volver

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

`deleteActiveSheet()`

Borra la hoja activa actualmente.

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

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`	Es la posición de la columna, que comienza en 1 para la primera columna.

Volver

Sheet: Es la hoja, útil para encadenar métodos.

Autorización

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

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

`deleteColumns(columnPosition, howMany)`

Borra una cantidad de columnas a partir de la posición de columna especificada.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Columns start at "1" - this deletes the first two columns
sheet.deleteColumns(1, 2);

Parámetros

Nombre	Tipo	Descripción
`columnPosition`	`Integer`	Es la posición de la primera columna que se borrará.
`howMany`	`Integer`	Es la cantidad de columnas 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 ámbitos:

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

`deleteRow(rowPosition)`

Borra la fila en la posición determinada.

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`	Es la posición de la fila, que comienza en 1 para la primera fila.

Volver

Sheet: Es la hoja, útil para encadenar métodos.

Autorización

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

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

`deleteRows(rowPosition, howMany)`

Borra una cantidad de filas a partir de la posición de fila determinada.

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`	Es la posición de la primera fila que se borrará.
`howMany`	`Integer`	Es la cantidad 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 ámbitos:

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 se borrará.

Autorización

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

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

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

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

`getActiveCell()`

Devuelve la celda activa en esta hoja.

Nota: Es preferible usar 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: La 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 ámbitos:

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

`getActiveRange()`

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

El término "rango activo" hace referencia al rango que un usuario seleccionó en la hoja activa, pero en una función personalizada se refiere a la celda que se vuelve a calcular de forma activa.

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

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 se selecciona un solo rango, se comporta como una llamada a getActiveRange().

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

Volver

RangeList: Es la lista de rangos activos.

Autorización

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

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

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 que se muestra en la IU de la hoja de cálculo.

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

Volver

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

`getAs(contentType)`

Muestra los datos dentro 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, "miarchivo.pdf". Sin embargo, se da por sentado que la parte del nombre de archivo que sigue al último punto (si corresponde) es una extensión existente que se debe reemplazar. Por lo tanto, "ShoppingList.12.25.2014" se convierte en "ShoppingList.12.25.pdf".

Para ver las cuotas diarias de conversiones, consulta Cuotas de los servicios de Google. Es posible que los dominios de Google Workspace recién creados estén sujetos temporalmente a cuotas más estrictas.

Parámetros

Nombre	Tipo	Descripción
`contentType`	`String`	Es el tipo de MIME al que se debe realizar la conversión. Para la mayoría de los blobs, `'application/pdf'` es la única opción válida. Para las imágenes en formato BMP, GIF, JPEG o PNG, también son válidos `'image/bmp'`, `'image/gif'`, `'image/jpeg'` o `'image/png'`. Para un documento de Documentos de Google, `'text/markdown'` también es válido.

Volver

Blob: Los datos como un BLOB.

`getBandings()`

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

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

// Gets an array of the bandings in the spreadsheet.
const bandings = ss.getBandings();

// Logs the range of the first banding in the spreadsheet to the console.
console.log(bandings[0].getRange().getA1Notation());

Volver

Banding[]: Son 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 ámbitos:

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

`getBlob()`

Devuelve 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 especificada.

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`	Es la posición de la columna que se examinará.

Volver

Integer: Es el ancho de la 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 ámbitos:

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 celda actual. La celda actual es la que está enfocada en la IU de Hojas de cálculo de Google y 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: La celda actual

Autorización

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

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

`getDataRange()`

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

Esto es funcionalmente equivalente a crear un rango limitado 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: Es un rango que consta de 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 ámbitos:

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

`getDataSourceFormulas()`

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

// Opens the spreadsheet by its ID. If you created your script from within a Google Sheets
// file, use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

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

// Gets an array of the data source formulas on Sheet1.
// To get an array of data source formulas for the entire spreadsheet,
// replace 'sheet' with 'ss'.
const dataSourceFormulas = sheet.getDataSourceFormulas();

// Logs the first data source formula in the array.
console.log(dataSourceFormulas[0].getFormula());

Volver

DataSourceFormula[]: Es una lista de fórmulas 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 ámbitos:

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.

// Opens the spreadsheet file by its ID. If you created your script from a Google Sheets file,
// use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

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

// Gets an array of the data source pivot tables on Sheet1.
// To get an array of data source pivot tables for the entire
// spreadsheet, replace 'sheet' with 'ss'.
const dataSourcePivotTables = sheet.getDataSourcePivotTables();

// Logs the last time that the first pivot table in the array was refreshed.
console.log(dataSourcePivotTables[0].getStatus().getLastRefreshedTime());

Volver

DataSourcePivotTable[]: Es una lista de tablas dinámicas 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 ámbitos:

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

`getDataSourceRefreshSchedules()`

Obtiene los programas de actualización de esta hoja de cálculo.

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

// Activates BigQuery operations for the connected spreadsheet.
SpreadsheetApp.enableBigQueryExecution();

// Gets the frequency type of the first referesh schedule in the array.
const frequencyType = ss.getDataSourceRefreshSchedules()[0]
                        .getFrequency()
                        .getFrequencyType()
                        .toString();

// Logs the frequency type to the console.
console.log(frequencyType);

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

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

`getDataSourceSheets()`

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

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

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

// Gets the first data source sheet in the spreadsheet.
const dataSource = ss.getDataSourceSheets()[0];

// Gets the name of the data source sheet.
console.log(dataSource.asSheet().getName());

Volver

DataSourceSheet[]: Es un array de todas las hojas de la 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 ámbitos:

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

`getDataSourceTables()`

Obtiene todas las tablas de la fuente de datos.

// Opens the spreadsheet file by its ID. If you created your script from a Google Sheets file,
// use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

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

// Gets an array of data source tables on Sheet1.
// To get an array of data source tables for the entire spreadsheet,
// replace 'sheet' with 'ss'.
const dataSourceTables = sheet.getDataSourceTables();

// Logs the last completed data execution time on the first data source table.
console.log(dataSourceTables[0].getStatus().getLastExecutionTime());

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

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

`getDataSources()`

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

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

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

// Gets the data sources on the spreadsheet.
const dataSources = ss.getDataSources();

// Logs the name of the first column on the first data source.
console.log(dataSources[0].getColumns()[0].getName());

Volver

DataSource[]: Es un array 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 ámbitos:

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

`getDeveloperMetadata()`

Obtiene los metadatos del desarrollador asociados con la hoja de cálculo de nivel superior.

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

// Adds 'Google' as a key to the spreadsheet metadata.
ss.addDeveloperMetadata('Google');

// Gets the spreadsheet's metadata.
const ssMetadata = ss.getDeveloperMetadata();

// Gets the first set of the spreadsheet's metadata and logs the key to the console.
console.log(ssMetadata[0].getKey());

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

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

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 de formulario por hoja se pueden recuperar a través del método Sheet.getFormUrl().

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

// Gets the form URL from the spreadsheet.
const formUrl = ss.getFormUrl();

// Logs the form URL to the console.
console.log(formUrl);

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

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

`getFrozenColumns()`

Muestra la cantidad de columnas inmovilizadas.

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

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

Volver

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

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

`getFrozenRows()`

Muestra la cantidad de filas inmovilizadas.

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

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

Volver

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

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

`getId()`

Obtiene un identificador único para esta hoja de cálculo. Se puede extraer un ID de hoja de cálculo de su URL. Por ejemplo, el ID de la hoja de cálculo en la URL https://docs.google.com/spreadsheets/d/abc1234567/edit#gid=0 es "abc1234567".

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

Volver

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

`getImages()`

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

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

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

// Gets the over-the-grid images from Sheet1.
// To get the over-the-grid images from the entire spreadsheet, use ss.getImages() instead.
const images = sheet.getImages();

// For each image, logs the anchor cell in A1 notation.
for (const image of images) {
 console.log(image.getAnchorCell().getA1Notation());
}

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

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

`getIterativeCalculationConvergenceThreshold()`

Devuelve el valor del umbral que se usa durante el cálculo iterativo. Cuando los resultados de cálculos sucesivos difieren en menos de este valor, se detiene el cálculo iterativo.

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

// Sets the iterative calculation convergence threshold for the spreadsheet.
ss.setIterativeCalculationConvergenceThreshold(2);

// Logs the threshold to the console.
console.log(ss.getIterativeCalculationConvergenceThreshold());

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

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

`getLastColumn()`

Devuelve 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: Es la última columna de la hoja que contiene contenido.

Autorización

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

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

`getLastRow()`

Devuelve 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 contiene contenido.

Autorización

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

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

`getMaxIterativeCalculationCycles()`

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

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

// Sets the max iterative calculation cycles for the spreadsheet.
ss.setMaxIterativeCalculationCycles(10);

// Logs the max iterative calculation cycles to the console.
console.log(ss.getMaxIterativeCalculationCycles());

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

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

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

`getNamedRanges()`

Obtiene todos los rangos con nombre de 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 ámbitos:

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

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

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

`getProtections(type)`

Obtiene un array de objetos que representan todos los rangos o hojas protegidos de 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`	Es 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 hojas protegidos en la hoja de cálculo.

Autorización

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

https://www.googleapis.com/auth/spreadsheets.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`	Es el rango que se mostrará, como se especifica en la notación A1 o 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 ámbitos:

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 determinado. 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`	Es el nombre del rango que se debe obtener.

Volver

Range: Es 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 notaciones 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[]`	Es la lista de rangos que se mostrarán, como se especifica en la notación A1 o R1C1.

Volver

RangeList: Es la lista de rangos 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 ámbitos:

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

`getRecalculationInterval()`

Devuelve el intervalo de cálculo de esta hoja de cálculo.

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

// Logs the calculation interval for the spreadsheet to the console.
console.log(ss.getRecalculationInterval().toString());

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

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

`getRowHeight(rowPosition)`

Obtiene la altura en píxeles de la 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`	Es la posición de la fila que se examinará.

Volver

Integer: Es la altura de la 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 ámbitos:

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

`getSelection()`

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

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

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

`getSheetByName(name)`

Muestra una hoja con el nombre determinado.

Si varias hojas tienen el mismo nombre, se muestra la 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`	Es el nombre de la hoja que se debe obtener.

Volver

Sheet: Es la hoja con el nombre determinado.

`getSheetId()`

Devuelve el ID de la hoja que representa este objeto.

Es un ID único para la hoja de cálculo. El ID es un número entero que aumenta de forma monótona asignado en el momento de la creación de la hoja y que es independiente de su posición. Esto es útil en conjunto 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 único para la hoja de cálculo.

Autorización

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

https://www.googleapis.com/auth/spreadsheets.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 ámbitos:

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

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

Devuelve la cuadrícula rectangular de valores para este rango a partir de las coordenadas determinadas. Un valor de -1 que se proporciona como la posición de la fila o columna equivale 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`	Es la posición de la fila inicial.
`startColumn`	`Integer`	Es la posición de la columna inicial.
`numRows`	`Integer`	Es la cantidad de filas para las que se mostrarán valores.
`numColumns`	`Integer`	Es la cantidad de columnas para las que se mostrarán valores.

Volver

Object[][]: Es un array de valores de dos dimensiones.

Autorización

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

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

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

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

// Gets the spreadsheet locale.
const ssLocale = ss.getSpreadsheetLocale();

// Logs the locale to the console.
console.log(ssLocale);

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

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

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

`getSpreadsheetTimeZone()`

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

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

// Sets the time zone of the spreadsheet.
ss.setSpreadsheetTimeZone('America/New_York');

// Gets the time zone of the spreadsheet.
const ssTimeZone = ss.getSpreadsheetTimeZone();

// Logs the time zone to the console.
console.log(ssTimeZone);

Volver

String: Es la zona horaria, especificada en formato "long" (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 ámbitos:

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

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

`getViewers()`

Obtiene la lista de usuarios y comentaristas de este Spreadsheet.

Volver

User[]: Es un array de usuarios con permiso de vista o comentario.

Autorización

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

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

`hideColumn(column)`

Oculta la columna o las columnas del rango determinado.

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

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

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

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`	Es la columna después de la que se debe agregar la nueva.

Volver

Sheet: Es la hoja, útil para encadenar métodos.

Autorización

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

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

`insertColumnBefore(beforePosition)`

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

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`	Es la columna antes de la que se debe agregar la nueva.

Volver

Sheet: Es la hoja, útil para encadenar métodos.

Autorización

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

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

`insertColumnsAfter(afterPosition, howMany)`

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

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

// Inserts two columns after the first column on the first sheet of the spreadsheet.
sheet.insertColumnsAfter(1,2);

Parámetros

Nombre	Tipo	Descripción
`afterPosition`	`Integer`	Es la columna después de la que se debe agregar la nueva.
`howMany`	`Integer`	Es la cantidad de columnas que se insertarán.

Volver

Sheet: Es la hoja, útil para encadenar métodos.

Autorización

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

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

`insertColumnsBefore(beforePosition, howMany)`

Inserta una cantidad de columnas antes de la posición de columna determinada.

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`	Es la columna antes de la que se debe agregar la nueva.
`howMany`	`Integer`	Es la cantidad de columnas que se insertarán.

Volver

Sheet: Es la hoja, útil para encadenar métodos.

Autorización

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

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

`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 sea la hoja activa.

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

// Activates BigQuery operations.
SpreadsheetApp.enableBigQueryExecution();

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

// Builds a data source specification.
// TODO (developer): Update the project ID to your own Google Cloud project ID.
const dataSourceSpec = SpreadsheetApp.newDataSourceSpec()
 .asBigQuery()
 .setProjectId('project-id-1')
 .setTableProjectId('bigquery-public-data')
 .setDatasetId('ncaa_basketball')
 .setTableId('mbb_historical_teams_games')
 .build();

// Adds the data source and its data to the spreadsheet.
ss.insertDataSourceSheet(dataSourceSpec);

Parámetros

Nombre	Tipo	Descripción
`spec`	`DataSourceSpec`	Es la especificación de la fuente de datos con la que se insertará.

Volver

DataSourceSheet: Es la hoja de la nueva 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 ámbitos:

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 del blob. El tamaño máximo permitido para un BLOB es de 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`	Es el objeto BLOB que contiene el contenido de la imagen, el tipo MIME y, de forma opcional, el nombre.
`column`	`Integer`	La posición de la columna.
`row`	`Integer`	Es 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 ámbitos:

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 un desplazamiento de píxeles. El tamaño de la imagen se recupera del contenido del blob. El tamaño máximo permitido para un BLOB es de 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`	Es el objeto BLOB que contiene el contenido de la imagen, el tipo MIME y, de forma opcional, el nombre.
`column`	`Integer`	La posición de la columna.
`row`	`Integer`	Es la posición de la fila.
`offsetX`	`Integer`	Es el desplazamiento horizontal desde la esquina de la celda en píxeles.
`offsetY`	`Integer`	Es el desplazamiento vertical desde 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 ámbitos:

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`	Es la posición de la columna de la cuadrícula.
`row`	`Integer`	Es la posición de la fila de la 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 ámbitos:

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`	Es la URL de la imagen.
`column`	`Integer`	La posición de la columna.
`row`	`Integer`	Es la posición de la fila.
`offsetX`	`Integer`	Es el desplazamiento horizontal desde la esquina de la celda en píxeles.
`offsetY`	`Integer`	Es el desplazamiento vertical desde 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 ámbitos:

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

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`	Es la fila después de la cual se debe agregar la fila nueva.

Volver

Sheet: Es la hoja, útil para encadenar métodos.

Autorización

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

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

`insertRowBefore(beforePosition)`

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

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`	Es la fila antes de la que se debe agregar la fila nueva.

Volver

Sheet: Es la hoja, útil para encadenar métodos.

Autorización

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

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

`insertRowsAfter(afterPosition, howMany)`

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

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`	Es la fila después de la cual se deben agregar las filas nuevas.
`howMany`	`Integer`	Es la cantidad de filas que se insertarán.

Volver

Sheet: Es la hoja, útil para encadenar métodos.

Autorización

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

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

`insertRowsBefore(beforePosition, howMany)`

Inserta una cantidad de filas antes de la posición de fila determinada.

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`	Es la fila antes de la que se deben agregar las filas nuevas.
`howMany`	`Integer`	Es la cantidad de filas que se insertarán.

Volver

Sheet: Es la hoja, útil para encadenar métodos.

Autorización

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

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

`insertSheet()`

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

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

Volver

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

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 determinado. La hoja nueva se convierte en la hoja activa.

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

Parámetros

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

Volver

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

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 determinado y usa argumentos avanzados opcionales. La hoja nueva se convierte 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`	Es el índice de la hoja recién creada. Para insertar una hoja como la primera en la hoja de cálculo, configúrala en 0.
`options`	`Object`	Argumentos avanzados opcionales de JavaScript.

Parámetros avanzados

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

Volver

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

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 convierte 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 enumeran los argumentos avanzados opcionales de JavaScript.

Parámetros avanzados

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

Volver

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

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 indicado. La hoja nueva se convierte en la hoja activa.

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

Parámetros

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

Volver

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

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 indicado en el índice indicado. La hoja nueva se convierte en la hoja activa.

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

Parámetros

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

Volver

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

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 determinado en el índice determinado y usa argumentos avanzados opcionales. La hoja nueva se convierte 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`	Es el nombre de la hoja nueva.
`sheetIndex`	`Integer`	Es el índice de la hoja que se insertó recientemente. Para insertar una hoja como la primera en una hoja de cálculo, configúrala en 0.
`options`	`Object`	Argumentos avanzados opcionales de JavaScript.

Parámetros avanzados

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

Volver

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

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 convierte 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`	Es el nombre de la hoja nueva.
`options`	`Object`	Argumentos avanzados opcionales de JavaScript.

Parámetros avanzados

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

Volver

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

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 abarque 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 sea la hoja activa.

// Activates BigQuery operations.
SpreadsheetApp.enableBigQueryExecution();

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

// Adds a sheet and sets cell A1 as the parameter cell.
const parameterCell = ss.insertSheet('parameterSheet').getRange('A1');

// Sets the value of the parameter cell to 'Duke'.
parameterCell.setValue('Duke');

const query = 'select * from `bigquery-public-data`.`ncaa_basketball`.' +
  '`mbb_historical_tournament_games` WHERE win_school_ncaa = @SCHOOL';

// Adds a data source with a query parameter.
// TODO(developer): Update the project ID to your own Google Cloud project ID.
const dataSourceSpec = SpreadsheetApp.newDataSourceSpec()
 .asBigQuery()
 .setProjectId('project-id-1')
 .setRawQuery(query)
 .setParameterFromCell('SCHOOL', 'parameterSheet!A1')
 .build();

// Adds sheets for the data source and data source table to the spreadsheet.
ss.insertSheetWithDataSourceTable(dataSourceSpec);

Parámetros

Nombre	Tipo	Descripción
`spec`	`DataSourceSpec`	Es la especificación de la fuente de datos con la que se insertará.

Volver

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

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`	Es la posición de la columna que se examinará.

Volver

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

Autorización

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

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

`isIterativeCalculationEnabled()`

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

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

// Activates iterative calculation on the spreadsheet.
ss.setIterativeCalculationEnabled(true);

// Logs whether iterative calculation is activated for the spreadsheet.
console.log(ss.isIterativeCalculationEnabled());

Volver

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

Autorización

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

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

`isRowHiddenByFilter(rowPosition)`

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

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`	Es la posición de la fila que se examinará.

Volver

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

Autorización

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

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

`isRowHiddenByUser(rowPosition)`

Muestra si el usuario ocultó la fila determinada.

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`	Es la posición de la fila que se examinará.

Volver

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

Autorización

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

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

`moveActiveSheet(pos)`

Mueve la hoja activa a la posición determinada en la lista de hojas. Genera una excepción si la posición es negativa o mayor que la cantidad 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`	Es la posición de índice 1 a la que se 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 ámbitos:

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

`moveChartToObjectSheet(chart)`

Crea una hoja SheetType.OBJECT nueva y mueve el gráfico proporcionado a ella. Si el gráfico ya está en su propia hoja, se muestra esa hoja 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 moverá.

Volver

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

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 omite los objetos de fuente de datos no válidos.

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

// Activates BigQuery operations.
SpreadsheetApp.enableBigQueryExecution();

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

// Gets the first data source sheet on the spreadsheet.
const dataSheet = ss.getDataSourceSheets()[0];

// Refreshes all data sources on the spreadsheet.
ss.refreshAllDataSources();

// Logs the last refreshed time of the first data source sheet.
console.log(`Last refresh time: ${dataSheet.getStatus().getLastRefreshedTime()}`);

Autorización

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

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

`removeEditor(emailAddress)`

Quita al 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 tienen acceso general, por ejemplo, si Spreadsheet se comparte con todo el dominio del usuario o si Spreadsheet se encuentra 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 usuarios con permiso de lectura.

Parámetros

Nombre	Tipo	Descripción
`emailAddress`	`String`	Es la dirección de correo electrónico del usuario que quieres quitar.

Volver

Spreadsheet: Este Spreadsheet, para encadenar.

Autorización

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

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

`removeEditor(user)`

En el caso de los archivos de Drive, también se quita al usuario de la lista de usuarios con permiso de lectura.

Parámetros

Nombre	Tipo	Descripción
`user`	`User`	Es una representación del usuario que se quitará.

Volver

Spreadsheet: Este Spreadsheet, para encadenar.

Autorización

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

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

`removeMenu(name)`

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

// 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`	Es 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 ámbitos:

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

`removeNamedRange(name)`

Borra un rango con nombre con el nombre determinado. Genera una excepción si no se encuentra un 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 ámbitos:

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

`removeViewer(emailAddress)`

Quita al usuario determinado de la lista de usuarios y comentaristas de Spreadsheet. Este método no tiene efecto si el usuario es editor, no un usuario que mira o comenta. Este método tampoco bloquea a los usuarios para que 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
`emailAddress`	`String`	Es la dirección de correo electrónico del usuario que quieres 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 ámbitos:

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

`removeViewer(user)`

Quita al usuario determinado de la lista de usuarios y comentaristas de Spreadsheet. Este método no tiene efecto si el usuario es un editor, no un usuario. 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 se encuentra 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`	Es una representación 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 ámbitos:

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`	Es el nombre nuevo del documento.

Autorización

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

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

`renameActiveSheet(newName)`

Cambia el nombre de la hoja activa actual al nombre nuevo que se proporciona.

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

Parámetros

Nombre	Tipo	Descripción
`newName`	`String`	Es el nombre nuevo 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 ámbitos:

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

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

`setActiveRange(range)`

Establece el rango especificado como active range en la hoja activa, con la celda superior izquierda del 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`	Es el rango que se establecerá como el activo.

Volver

Range: Es el rango activo recientemente.

Autorización

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

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

`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`	Es la lista de rangos que se deben seleccionar.

Volver

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

Autorización

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

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

`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`	Es el rango que se establecerá como la selección activa.

Volver

Range: Es el rango activo recientemente.

Autorización

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

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

`setActiveSelection(a1Notation)`

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

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

sheet.setActiveSelection("A1:D4");

Parámetros

Nombre	Tipo	Descripción
`a1Notation`	`String`	Es el rango que se establecerá como activo, como se especifica en la notación A1 o R1C1.

Volver

Range: Es el rango activo recientemente.

Autorización

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

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

`setActiveSheet(sheet)`

Establece la hoja 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 pertenezca a otra hoja de cálculo.

// 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`	Es la hoja que se establecerá como hoja activa.

Volver

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

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

`setActiveSheet(sheet, restoreSelection)`

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

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 `true`, la selección más reciente de la hoja activa nueva se vuelve a seleccionar a medida que la hoja nueva se activa. Si `false`, la hoja nueva se activa 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 ámbitos:

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`	Es la posición de la columna determinada que se establecerá.
`width`	`Integer`	Es el ancho en píxeles que se establecerá.

Volver

Sheet: Es la hoja, útil para encadenar métodos.

Autorización

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

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

`setCurrentCell(cell)`

Establece la celda especificada como current cell.

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

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

Nota:El Range especificado debe constar de una celda; de lo contrario, se arrojará 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`	Es la celda que se establecerá como la celda actual.

Volver

Range: Es la celda actual recién establecida.

Autorización

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

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

`setFrozenColumns(columns)`

Inmoviliza la cantidad determinada de columnas. Si es cero, no se inmoviliza ninguna columna.

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

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

Parámetros

Nombre	Tipo	Descripción
`columns`	`Integer`	Es la cantidad de columnas que se inmovilizarán.

Autorización

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

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

`setFrozenRows(rows)`

Inmoviliza la cantidad determinada de filas. Si es cero, no se inmoviliza ninguna fila.

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

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

Parámetros

Nombre	Tipo	Descripción
`rows`	`Integer`	Es la cantidad de filas que se inmovilizarán.

Autorización

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

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

`setIterativeCalculationConvergenceThreshold(minThreshold)`

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

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

// Sets the iterative calculation convergence threshold for the spreadsheet.
ss.setIterativeCalculationConvergenceThreshold(2);

// Logs the threshold to the console.
console.log(ss.getIterativeCalculationConvergenceThreshold());

Parámetros

Nombre	Tipo	Descripción
`minThreshold`	`Number`	Es el umbral de convergencia mínimo (debe ser un número positivo).

Volver

Spreadsheet: Esta hoja de cálculo, para encadenar.

Autorización

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

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

`setIterativeCalculationEnabled(isEnabled)`

Establece si el cálculo iterativo está activado en esta hoja de cálculo. Si la cantidad máxima de ciclos de cálculo y el umbral de convergencia no se establecieron previamente cuando se activa el cálculo, se establecerán de forma predeterminada en 50 y 0.05, respectivamente. Si alguno de ellos se configuró anteriormente, retendrán sus valores anteriores.

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

// Activates iterative calculation on the spreadsheet.
ss.setIterativeCalculationEnabled(true);

// Logs whether iterative calculation is activated for the spreadsheet.
console.log(ss.isIterativeCalculationEnabled());

Parámetros

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

Volver

Spreadsheet: Esta hoja de cálculo, para encadenar.

Autorización

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

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

`setMaxIterativeCalculationCycles(maxIterations)`

Establece la cantidad máxima de iteraciones de cálculo que se deben realizar durante el cálculo iterativo. Este valor debe estar entre 1 y 10,000 (inclusive), y el valor predeterminado es 50.

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

// Sets the max iterative calculation cycles for the spreadsheet.
ss.setMaxIterativeCalculationCycles(10);

// Logs the max iterative calculation cycles to the console.
console.log(ss.getMaxIterativeCalculationCycles());

Parámetros

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

Volver

Spreadsheet: Esta hoja de cálculo, para encadenar.

Autorización

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

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

`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`	Es el nombre que se le asignará 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 ámbitos:

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.

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

// Sets the  calculation interval for the spreadsheet to 'ON_CHANGE'.
const interval = ss.setRecalculationInterval(SpreadsheetApp.RecalculationInterval.ON_CHANGE);

// Logs the calculation interval to the console.
console.log(interval);

Parámetros

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

Volver

Spreadsheet: Esta hoja de cálculo, para encadenar.

Autorización

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

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

`setRowHeight(rowPosition, height)`

Establece la altura de la fila determinada en píxeles. De forma predeterminada, las filas se expanden para adaptarse al contenido de las celdas. Si quieres forzar filas a una altura especificada, 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`	Es la posición de la fila que se cambiará.
`height`	`Integer`	Es la altura en píxeles que se establecerá.

Volver

Sheet: Es la hoja, útil para encadenar métodos.

Autorización

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

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

`setSpreadsheetLocale(locale)`

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

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

// Sets the spreadsheet locale.
ss.setSpreadsheetLocale('fr');

// Gets the spreadsheet locale.
const ssLocale = ss.getSpreadsheetLocale();

// Logs the locale to the console.
console.log(ssLocale);

Parámetros

Nombre	Tipo	Descripción
`locale`	`String`	El código de configuración regional que se usará (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 ámbitos:

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`	Es el tema que se 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 ámbitos:

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.

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

// Sets the time zone of the spreadsheet.
ss.setSpreadsheetTimeZone('America/New_York');

// Gets the time zone of the spreadsheet.
const ssTimeZone = ss.getSpreadsheetTimeZone();

// Logs the time zone to the console.
console.log(ssTimeZone);

Parámetros

Nombre	Tipo	Descripción
`timezone`	`String`	La zona horaria, especificada en formato "long" (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 ámbitos:

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

`show(userInterface)`

Muestra un componente de interfaz de usuario personalizado en un diálogo centrado en el viewport del navegador del usuario. La ejecución de la secuencia de comandos del servidor no se suspende. Para comunicarse con el lado del servidor, el componente de la interfaz de usuario debe realizar devoluciones de llamada asíncronas a la secuencia de comandos del servidor.

Si la secuencia de comandos 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 `HtmlOutput`.

Autorización

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

https://www.googleapis.com/auth/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`	Es la columna por la que se ordenará la información.

Volver

Sheet: Es la hoja, útil para encadenar métodos.

Autorización

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

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

`sort(columnPosition, ascending)`

Ordena una hoja por columna. Toma un parámetro para especificar si es 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`	Es la columna por la que se ordenará la información.
`ascending`	`Boolean`	`true` para orden ascendente, `false` para orden descendente.

Volver

Sheet: Es la hoja, útil para encadenar métodos.

Autorización

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

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

`toast(msg)`

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

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

Parámetros

Nombre	Tipo	Descripción
`msg`	`String`	Es el 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 ámbitos:

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

// 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`	Es el 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 ámbitos:

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`	Es el mensaje que se mostrará en el aviso.
`title`	`String`	Es el título opcional del aviso.
`timeoutSeconds`	`Number`	Es el tiempo de espera en segundos. Si es `null`, el aviso dura 5 segundos de forma predeterminada. Si es negativo, el aviso permanece hasta que se descarta.

Autorización

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

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

`unhideColumn(column)`

Muestra la columna en el rango determinado.

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

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

`unhideRow(row)`

Muestra la fila en el rango determinado.

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

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 exactamente como 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`	Es el nombre del menú que se actualizará.
`subMenus`	`Object[]`	Un array 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 ámbitos:

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

`waitForAllDataExecutionsCompletion(timeoutInSeconds)`

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

Parámetros

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

Autorización

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

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

Métodos obsoletos

`getSheetProtection()`

Obsoleto. En el caso de 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. Aunque este método dejó de estar disponible, sigue disponible para brindar compatibilidad con la versión anterior de Hojas de cálculo.

Muestra una instancia de 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: Es un objeto que describe los permisos de acceso a la hoja.

Autorización

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

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

`isAnonymousView()`

Obsoleto. A partir de enero de 2014, esta función dejó de estar 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 nueva versión de Hojas de cálculo de Google, usa File.getSharingAccess() y File.getSharingPermission().

// 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: true si el documento permite la visualización anónima, false de lo contrario.

Autorización

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

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

Consulta también

Servicio de Drive

`isAnonymousWrite()`

Obsoleto. A partir de enero de 2014, esta función dejó de estar 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 nueva versión de Hojas de cálculo de Google, usa File.getSharingAccess() y File.getSharingPermission().

// 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: true si el documento permite la edición anónima, false de lo contrario.

Autorización

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

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

Consulta también

Servicio de Drive

`setAnonymousAccess(anonymousReadAllowed, anonymousWriteAllowed)`

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

Establece la política del documento sobre la lectura y escritura anónimas. Como ya no es compatible con la nueva versión 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; `false` de lo contrario.
`anonymousWriteAllowed`	`Boolean`	`true` para permitir lecturas anónimas; `false` de lo contrario.

Autorización

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

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

Consulta también

isAnonymousView()
isAnonymousWrite()
Servicio de Drive

`setSheetProtection(permissions)`

Obsoleto. En el caso de 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 dejó de estar disponible, sigue disponible para brindar compatibilidad con la versión anterior de Hojas de cálculo.

Establece los permisos de 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`	Es el objeto de permisos de acceso que se 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 ámbitos:

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