Class Spreadsheet

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étodoTipo de datos que se muestraDescripción breve
addDeveloperMetadata(key)SpreadsheetAgrega metadatos del desarrollador con la clave especificada a la hoja de cálculo de nivel superior.
addDeveloperMetadata(key, visibility)SpreadsheetAgrega metadatos del desarrollador con la clave y la visibilidad especificadas a la hoja de cálculo.
addDeveloperMetadata(key, value)SpreadsheetAgrega metadatos del desarrollador con la clave y el valor especificados a la hoja de cálculo.
addDeveloperMetadata(key, value, visibility)SpreadsheetAgrega metadatos del desarrollador con la clave, el valor y la visibilidad especificados a la hoja de cálculo.
addEditor(emailAddress)SpreadsheetAgrega el usuario determinado a la lista de editores del Spreadsheet.
addEditor(user)SpreadsheetAgrega el usuario determinado a la lista de editores del Spreadsheet.
addEditors(emailAddresses)SpreadsheetAgrega el array de usuarios determinado a la lista de editores del Spreadsheet.
addMenu(name, subMenus)voidCrea un menú nuevo en la IU de la hoja de cálculo.
addViewer(emailAddress)SpreadsheetAgrega el usuario determinado a la lista de visualizadores de Spreadsheet.
addViewer(user)SpreadsheetAgrega el usuario determinado a la lista de visualizadores de Spreadsheet.
addViewers(emailAddresses)SpreadsheetAgrega el array de usuarios determinado a la lista de visualizadores de Spreadsheet.
appendRow(rowContents)SheetAgrega una fila en la parte inferior de la región de datos actual en la hoja.
autoResizeColumn(columnPosition)SheetEstablece el ancho de la columna determinada para que se ajuste a su contenido.
copy(name)SpreadsheetCopia la hoja de cálculo y muestra la nueva.
createDeveloperMetadataFinder()DeveloperMetadataFinderMuestra un DeveloperMetadataFinder para encontrar metadatos del desarrollador dentro del alcance de esta hoja de cálculo.
createTextFinder(findText)TextFinderCrea un buscador de texto para la hoja de cálculo, que se puede usar para buscar y reemplazar texto en la hoja de cálculo.
deleteActiveSheet()SheetBorra la hoja activa actualmente.
deleteColumn(columnPosition)SheetBorra la columna en la posición de columna especificada.
deleteColumns(columnPosition, howMany)voidBorra varias columnas a partir de la posición de columna especificada.
deleteRow(rowPosition)SheetBorra la fila en la posición de fila especificada.
deleteRows(rowPosition, howMany)voidBorra una cantidad de filas a partir de la posición de fila especificada.
deleteSheet(sheet)voidBorra la hoja especificada.
duplicateActiveSheet()SheetDuplica la hoja activa y la convierte en la hoja activa.
getActiveCell()RangeMuestra la celda activa en esta hoja.
getActiveRange()RangeMuestra el rango seleccionado en la hoja activa o null si no hay un rango activo.
getActiveRangeList()RangeListMuestra la lista de rangos activos en la hoja activa o null si no hay rangos activos.
getActiveSheet()SheetObtiene la hoja activa en una hoja de cálculo.
getAs(contentType)BlobMuestra 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()BlobMuestra los datos dentro de este objeto como un BLOB.
getColumnWidth(columnPosition)IntegerObtiene el ancho en píxeles de la columna determinada.
getCurrentCell()RangeMuestra la celda actual en la hoja activa o null si no hay ninguna celda actual.
getDataRange()RangeMuestra un Range que corresponde a las dimensiones en las que están presentes los datos.
getDataSourceFormulas()DataSourceFormula[]Obtiene todas las fórmulas de la fuente de datos.
getDataSourcePivotTables()DataSourcePivotTable[]Obtiene todas las tablas dinámicas de la fuente de datos.
getDataSourceRefreshSchedules()DataSourceRefreshSchedule[]Obtiene las programaciones de actualización de esta hoja de cálculo.
getDataSourceSheets()DataSourceSheet[]Devuelve todas las hojas de la fuente de datos de 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 para este Spreadsheet.
getFormUrl()StringMuestra la URL del formulario que envía sus respuestas a esta hoja de cálculo o null si la hoja de cálculo no tiene un formulario asociado.
getFrozenColumns()IntegerMuestra el número de columnas inmovilizadas.
getFrozenRows()IntegerMuestra el número de filas inmovilizadas.
getId()StringObtiene un identificador único para esta hoja de cálculo.
getImages()OverGridImage[]Muestra todas las imágenes sobre la hoja en la cuadrícula.
getIterativeCalculationConvergenceThreshold()NumberMuestra el valor de umbral utilizado durante el cálculo iterativo.
getLastColumn()IntegerMuestra la posición de la última columna que tiene contenido.
getLastRow()IntegerMuestra la posición de la última fila que tiene contenido.
getMaxIterativeCalculationCycles()IntegerMuestra el número máximo de iteraciones para usar durante el cálculo iterativo.
getName()StringObtiene el nombre del documento.
getNamedRanges()NamedRange[]Obtiene todos los rangos con nombre de esta hoja de cálculo.
getNumSheets()IntegerMuestra el número de hojas en esta hoja de cálculo.
getOwner()UserMuestra el propietario del documento o null para un documento de 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 las hojas protegidos en la hoja de cálculo.
getRange(a1Notation)RangeMuestra el rango especificado en la notación A1 o R1C1.
getRangeByName(name)RangeMuestra un rango con nombre o null si no se encuentra un rango con el nombre especificado.
getRangeList(a1Notations)RangeListMuestra la colección RangeList que representa los rangos de la misma hoja especificada por una lista no vacía de notaciones A1 o R1C1.
getRecalculationInterval()RecalculationIntervalMuestra el intervalo de cálculo de esta hoja de cálculo.
getRowHeight(rowPosition)IntegerObtiene la altura en píxeles de la fila determinada.
getSelection()SelectionMuestra el Selection actual en la hoja de cálculo.
getSheetByName(name)SheetMuestra una hoja con el nombre determinado.
getSheetId()IntegerMuestra el ID de la hoja representada por este objeto.
getSheetName()StringMuestra el nombre de la hoja.
getSheetValues(startRow, startColumn, numRows, numColumns)Object[][]Muestra la cuadrícula rectangular de valores para este rango a partir de las coordenadas proporcionadas.
getSheets()Sheet[]Obtiene todas las hojas en esta hoja de cálculo.
getSpreadsheetLocale()StringObtiene la configuración regional de la hoja de cálculo.
getSpreadsheetTheme()SpreadsheetThemeMuestra el tema actual de la hoja de cálculo o null si no se aplicó ningún tema.
getSpreadsheetTimeZone()StringObtiene la zona horaria de la hoja de cálculo.
getUrl()StringMuestra la URL de la hoja de cálculo determinada.
getViewers()User[]Obtiene la lista de lectores y comentaristas de este Spreadsheet.
hideColumn(column)voidOculta las columnas en el rango especificado.
hideRow(row)voidOculta las filas en el rango especificado.
insertColumnAfter(afterPosition)SheetInserta una columna después de la posición determinada de la columna.
insertColumnBefore(beforePosition)SheetInserta una columna antes de la posición de columna determinada.
insertColumnsAfter(afterPosition, howMany)SheetInserta un número determinado de columnas después de la posición de columna determinada.
insertColumnsBefore(beforePosition, howMany)SheetInserta una cantidad de columnas antes de la posición de la columna determinada.
insertDataSourceSheet(spec)DataSourceSheetInserta un nuevo DataSourceSheet en la hoja de cálculo y, luego, inicia la ejecución de datos.
insertImage(blobSource, column, row)OverGridImageInserta un Spreadsheet como imagen en el documento en una fila y columna determinadas.
insertImage(blobSource, column, row, offsetX, offsetY)OverGridImageInserta un Spreadsheet como imagen en el documento en una fila y columna determinadas, con un desplazamiento de píxeles.
insertImage(url, column, row)OverGridImageInserta una imagen en el documento en una fila y columna determinadas.
insertImage(url, column, row, offsetX, offsetY)OverGridImageInserta una imagen en el documento en una fila y columna determinadas, con un desplazamiento de píxeles.
insertRowAfter(afterPosition)SheetInserta una fila después de la posición de fila determinada.
insertRowBefore(beforePosition)SheetInserta una fila antes de la posición de fila determinada.
insertRowsAfter(afterPosition, howMany)SheetInserta una cantidad de filas después de la posición de fila determinada.
insertRowsBefore(beforePosition, howMany)SheetInserta una cantidad de filas antes de la posición de fila determinada.
insertSheet()SheetInserta una hoja nueva en la hoja de cálculo con un nombre de hoja predeterminado.
insertSheet(sheetIndex)SheetInserta una nueva hoja en la hoja de cálculo con el índice dado.
insertSheet(sheetIndex, options)SheetInserta una hoja nueva en la hoja de cálculo con el índice determinado y usa argumentos avanzados opcionales.
insertSheet(options)SheetInserta una hoja nueva en la hoja de cálculo con un nombre de hoja predeterminado y argumentos avanzados opcionales.
insertSheet(sheetName)SheetInserta una nueva hoja en la hoja de cálculo con el nombre dado.
insertSheet(sheetName, sheetIndex)SheetInserta una nueva hoja en la hoja de cálculo con el nombre dado en el índice dado.
insertSheet(sheetName, sheetIndex, options)SheetInserta una hoja nueva en la hoja de cálculo con el nombre dado en el índice dado y usa argumentos avanzados opcionales.
insertSheet(sheetName, options)SheetInserta una hoja nueva en la hoja de cálculo con el nombre dado y utiliza argumentos avanzados opcionales.
insertSheetWithDataSourceTable(spec)SheetInserta una hoja nueva en la hoja de cálculo, crea una DataSourceTable que abarca toda la hoja con la especificación de fuente de datos determinada y, luego, inicia la ejecución de los datos.
isColumnHiddenByUser(columnPosition)BooleanMuestra si la columna determinada está oculta por el usuario.
isIterativeCalculationEnabled()BooleanMuestra si el cálculo iterativo está activado en esta hoja de cálculo.
isRowHiddenByFilter(rowPosition)BooleanMuestra si la fila dada está oculta por un filtro (no por una vista de filtro).
isRowHiddenByUser(rowPosition)BooleanMuestra si la fila dada está oculta por el usuario.
moveActiveSheet(pos)voidMueve la hoja activa a la posición determinada en la lista de hojas.
moveChartToObjectSheet(chart)SheetCrea una hoja SheetType.OBJECT nueva y mueve el gráfico proporcionado a ella.
refreshAllDataSources()voidActualiza 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)SpreadsheetQuita al usuario determinado de la lista de editores del Spreadsheet.
removeEditor(user)SpreadsheetQuita al usuario determinado de la lista de editores del Spreadsheet.
removeMenu(name)voidQuita un menú que agregó addMenu(name, subMenus).
removeNamedRange(name)voidBorra un rango con nombre que tiene el nombre dado.
removeViewer(emailAddress)SpreadsheetQuita al usuario determinado de la lista de lectores y comentaristas del Spreadsheet.
removeViewer(user)SpreadsheetQuita al usuario determinado de la lista de lectores y comentaristas del Spreadsheet.
rename(newName)voidCambia el nombre del documento.
renameActiveSheet(newName)voidCambia el nombre de la hoja activa actual por el nombre nuevo asignado.
resetSpreadsheetTheme()SpreadsheetThemeElimina el tema aplicado y establece el tema predeterminado en la hoja de cálculo.
setActiveRange(range)RangeEstablece el rango especificado como active range en la hoja activa, con la celda superior izquierda en el rango como current cell.
setActiveRangeList(rangeList)RangeListEstablece la lista especificada de rangos como el active ranges en la hoja activa.
setActiveSelection(range)RangeEstablece la región de selección activa para esta hoja.
setActiveSelection(a1Notation)RangeEstablece la selección activa, como se especifica en la notación A1 o la notación R1C1.
setActiveSheet(sheet)SheetEstablece la hoja determinada como la hoja activa en la hoja de cálculo.
setActiveSheet(sheet, restoreSelection)SheetEstablece 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)SheetEstablece el ancho de una columna determinada en píxeles.
setCurrentCell(cell)RangeEstablece la celda especificada como current cell.
setFrozenColumns(columns)voidInmoviliza el número determinado de columnas.
setFrozenRows(rows)voidInmoviliza la cantidad de filas especificada.
setIterativeCalculationConvergenceThreshold(minThreshold)SpreadsheetEstablece el valor de umbral mínimo para el cálculo iterativo.
setIterativeCalculationEnabled(isEnabled)SpreadsheetEstablece si el cálculo iterativo se activa en esta hoja de cálculo.
setMaxIterativeCalculationCycles(maxIterations)SpreadsheetEstablece la cantidad máxima de iteraciones de cálculo que deben realizarse durante un cálculo iterativo.
setNamedRange(name, range)voidNombra un rango.
setRecalculationInterval(recalculationInterval)SpreadsheetEstablece la frecuencia con la que se debe volver a calcular esta hoja de cálculo.
setRowHeight(rowPosition, height)SheetEstablece la altura de la fila en píxeles.
setSpreadsheetLocale(locale)voidEstablece la configuración regional de la hoja de cálculo.
setSpreadsheetTheme(theme)SpreadsheetThemeEstablece un tema en la hoja de cálculo.
setSpreadsheetTimeZone(timezone)voidEstablece la zona horaria para la hoja de cálculo.
show(userInterface)voidMuestra un componente de interfaz de usuario personalizado en un diálogo centrado en el viewport del navegador del usuario.
sort(columnPosition)SheetOrdena una hoja por columna, de forma ascendente.
sort(columnPosition, ascending)SheetOrdena una hoja por columna.
toast(msg)voidMuestra una ventana emergente en la esquina inferior derecha de la hoja de cálculo con el mensaje dado.
toast(msg, title)voidMuestra una ventana emergente en la esquina inferior derecha de la hoja de cálculo con el mensaje y el título proporcionados.
toast(msg, title, timeoutSeconds)voidMuestra una ventana emergente en la esquina inferior derecha de la hoja de cálculo con el título y el mensaje especificados, que permanece visible durante un período determinado.
unhideColumn(column)voidMuestra la columna en el rango especificado.
unhideRow(row)voidMuestra la fila en el rango especificado.
updateMenu(name, subMenus)voidActualiza un menú que agregó addMenu(name, subMenus).
waitForAllDataExecutionsCompletion(timeoutInSeconds)voidEspera hasta que se completen todas las ejecuciones actuales en la hoja de cálculo y se agota el tiempo de espera después de la cantidad de segundos proporcionada.

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

NombreTipoDescripción
keyStringLa clave de los nuevos metadatos del desarrollador.

Devolvedor

Spreadsheet: Esta hoja de cálculo se usa para encadenar.

Autorización

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

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

addDeveloperMetadata(key, visibility)

Agrega metadatos del desarrollador con la clave y 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

NombreTipoDescripción
keyStringLa clave de los nuevos metadatos del desarrollador.
visibilityDeveloperMetadataVisibilityLa visibilidad de los nuevos metadatos del desarrollador

Devolvedor

Spreadsheet: Esta hoja de cálculo se usa para encadenar.

Autorización

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

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

addDeveloperMetadata(key, value)

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

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

NombreTipoDescripción
keyStringLa clave de los nuevos metadatos del desarrollador.
valueStringEl valor de los nuevos metadatos del desarrollador.

Devolvedor

Spreadsheet: Esta hoja de cálculo se usa para encadenar.

Autorización

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

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

addDeveloperMetadata(key, value, visibility)

Agrega metadatos del desarrollador con la clave, el valor y la visibilidad especificados 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

NombreTipoDescripción
keyStringLa clave de los nuevos metadatos del desarrollador.
valueStringEl valor de los nuevos metadatos del desarrollador.
visibilityDeveloperMetadataVisibilityLa visibilidad de los nuevos metadatos del desarrollador

Devolvedor

Spreadsheet: Esta hoja de cálculo se usa para encadenar.

Autorización

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

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

addEditor(emailAddress)

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

Parámetros

NombreTipoDescripción
emailAddressStringEs la dirección de correo electrónico del usuario que se agregará.

Devolvedor

Spreadsheet: Es este Spreadsheet para encadenamiento.

Autorización

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

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

addEditor(user)

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

Parámetros

NombreTipoDescripción
userUserEs una representación del usuario que se agregará.

Devolvedor

Spreadsheet: Es este Spreadsheet para encadenamiento.

Autorización

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

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

addEditors(emailAddresses)

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

Parámetros

NombreTipoDescripción
emailAddressesString[]Un array de direcciones de correo electrónico de los usuarios que se agregarán.

Devolvedor

Spreadsheet: Es este Spreadsheet para encadenamiento.

Autorización

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

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

addMenu(name, subMenus)

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

Cada entrada del menú ejecuta una función definida por el usuario. Por lo general, querrás llamarla 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

NombreTipoDescripción
nameStringEl nombre del menú que se creará.
subMenusObject[]Un array de mapas de JavaScript con los parámetros name y functionName . Puedes usar funciones de las bibliotecas incluidas, como Library.libFunction1.

Autorización

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

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

addViewer(emailAddress)

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

Parámetros

NombreTipoDescripción
emailAddressStringEs la dirección de correo electrónico del usuario que se agregará.

Devolvedor

Spreadsheet: Es este Spreadsheet para encadenamiento.

Autorización

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

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

addViewer(user)

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

Parámetros

NombreTipoDescripción
userUserEs una representación del usuario que se agregará.

Devolvedor

Spreadsheet: Es este Spreadsheet para encadenamiento.

Autorización

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

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

addViewers(emailAddresses)

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

Parámetros

NombreTipoDescripción
emailAddressesString[]Un array de direcciones de correo electrónico de los usuarios que se agregarán.

Devolvedor

Spreadsheet: Es este Spreadsheet para encadenamiento.

Autorización

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

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

appendRow(rowContents)

Agrega una fila en 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

NombreTipoDescripción
rowContentsObject[]Un array de valores para insertar después de la última fila en la hoja.

Devolvedor

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

Autorización

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

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

autoResizeColumn(columnPosition)

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

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

sheet.getRange('a1').setValue('Whenever it is a damp, drizzly November in my soul...');

// Sets the first column to a width which fits the text
sheet.autoResizeColumn(1);

Parámetros

NombreTipoDescripción
columnPositionIntegerLa posición de la columna determinada a la que se le debe cambiar el tamaño.

Devolvedor

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

Autorización

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

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

copy(name)

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

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

Parámetros

NombreTipoDescripción
nameStringEs el nombre de la copia.

Devolvedor

Spreadsheet: Esta hoja de cálculo se usa para encadenar.

Autorización

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

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

createDeveloperMetadataFinder()

Muestra un DeveloperMetadataFinder para encontrar metadatos del desarrollador dentro del alcance de esta hoja de cálculo. De forma predeterminada, esto considera 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());

Devolvedor

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 en la hoja de cálculo. La búsqueda comienza en 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

NombreTipoDescripción
findTextStringEl texto que se va a buscar.

Devolvedor

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

Devolvedor

Sheet: Es la nueva hoja activa.

Autorización

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

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

deleteColumn(columnPosition)

Borra la columna en la posición de columna especificada.

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

Parámetros

NombreTipoDescripción
columnPositionIntegerEs la posición de la columna, que comienza en 1 para la primera columna.

Devolvedor

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

Autorización

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

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

deleteColumns(columnPosition, howMany)

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

NombreTipoDescripción
columnPositionIntegerLa posición de la primera columna que se borrará.
howManyIntegerLa 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 alcances:

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

deleteRow(rowPosition)

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

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

Parámetros

NombreTipoDescripción
rowPositionIntegerEs la posición de la fila, que comienza en 1 para la primera fila.

Devolvedor

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

Autorización

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

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

deleteRows(rowPosition, howMany)

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

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

Parámetros

NombreTipoDescripción
rowPositionIntegerLa posición de la primera fila que se borrará.
howManyIntegerLa 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 alcances:

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

deleteSheet(sheet)

Borra la hoja especificada.

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

Parámetros

NombreTipoDescripción
sheetSheetLa 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 alcances:

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

duplicateActiveSheet()

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

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

Devolvedor

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

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

getActiveCell()

Muestra la celda activa en esta hoja.

Nota: Es preferible 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();

Devolvedor

Range: Es la celda activa en ese momento.

Autorización

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

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

getActiveRange()

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

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

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

Devolvedor

Range: El rango activo

Autorización

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

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

Consulta también


getActiveRangeList()

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

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

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

Devolvedor

RangeList: Es la lista de rangos activos.

Autorización

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

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

Consulta también


getActiveSheet()

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

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

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

Devolvedor

Sheet: Es la hoja activa en 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 de archivo, por ejemplo, “myfile.pdf”. Sin embargo, se supone que la parte del nombre de archivo que sigue al último punto (si existe) es una extensión existente que se debe reemplazar. En consecuencia, “ShoppingList.12.25.2014” se convierte en “ShoppingList.12.25.pdf”.

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

Parámetros

NombreTipoDescripción
contentTypeStringEl tipo de MIME al que se realizará la conversión. Para la mayoría de los BLOB, 'application/pdf' es la única opción válida. En el caso de las imágenes en formato BMP, GIF, JPEG o PNG, también es válido cualquiera de los valores 'image/bmp', 'image/gif', 'image/jpeg' o 'image/png'.

Devolvedor

Blob: Son 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());

Devolvedor

Banding[]: Son las bandas en esta hoja de cálculo.

Autorización

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

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

getBlob()

Muestra los datos dentro de este objeto como un BLOB.

Devolvedor

Blob: Son los datos como un BLOB.


getColumnWidth(columnPosition)

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

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

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

Parámetros

NombreTipoDescripción
columnPositionIntegerLa posición de la columna que se examinará.

Devolvedor

Integer: Ancho de columna en píxeles

Autorización

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

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

getCurrentCell()

Muestra la celda actual en la hoja activa o null si no hay ninguna 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. Actualmente, no hay más de una celda. Cuando un usuario selecciona uno o más rangos de celdas, una de las celdas de la selección es la actual.

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

Devolvedor

Range: Es la celda actual.

Autorización

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

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

getDataRange()

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

Esto es funcionalmente equivalente a crear un Rango delimitado por A1 y (Sheet.getLastColumn(), Sheet.getLastRow()).

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

// This represents ALL the data
var range = sheet.getDataRange();
var values = range.getValues();

// This logs the spreadsheet in CSV format with a trailing comma
for (var i = 0; i < values.length; i++) {
  var row = "";
  for (var j = 0; j < values[i].length; j++) {
    if (values[i][j]) {
      row = row + values[i][j];
    }
    row = row + ",";
  }
  Logger.log(row);
}

Devolvedor

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

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

getDataSourceFormulas()

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

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

Devolvedor

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

Autorización

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

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

getDataSourcePivotTables()

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

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

Devolvedor

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

Autorización

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

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

getDataSourceRefreshSchedules()

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

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

Devolvedor

DataSourceRefreshSchedule[]: Son los programas de actualización de esta hoja de cálculo.

Autorización

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

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

getDataSourceSheets()

Devuelve todas las hojas de la fuente 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 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());

Devolvedor

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

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

Devolvedor

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

Autorización

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

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

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

Devolvedor

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

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

Devolvedor

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

Autorización

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

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

getEditors()

Obtiene la lista de editores para este Spreadsheet.

Devolvedor

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

Autorización

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

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

getFormUrl()

Muestra la URL del formulario que envía sus respuestas a esta hoja de cálculo o null si la 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);

Devolvedor

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

Autorización

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

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

getFrozenColumns()

Muestra el número de columnas inmovilizadas.

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

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

Devolvedor

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

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

getFrozenRows()

Muestra el número de filas inmovilizadas.

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

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

Devolvedor

Integer: La cantidad de filas inmovilizadas

Autorización

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

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

getId()

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

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

Devolvedor

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


getImages()

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

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

Devolvedor

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

Autorización

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

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

getIterativeCalculationConvergenceThreshold()

Muestra el valor de umbral utilizado durante el cálculo iterativo. Cuando los resultados de un cálculo sucesivo difieren en menos que este valor, el cálculo iterativo se detiene.

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

Devolvedor

Number: Es el umbral de convergencia.

Autorización

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

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

getLastColumn()

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

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

// This logs the value in the very last cell of this sheet
var lastRow = sheet.getLastRow();
var lastColumn = sheet.getLastColumn();
var lastCell = sheet.getRange(lastRow, lastColumn);
Logger.log(lastCell.getValue());

Devolvedor

Integer: Es la última columna de la hoja que incluye contenido.

Autorización

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

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

getLastRow()

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

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

// This logs the value in the very last cell of this sheet
var lastRow = sheet.getLastRow();
var lastColumn = sheet.getLastColumn();
var lastCell = sheet.getRange(lastRow, lastColumn);
Logger.log(lastCell.getValue());

Devolvedor

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

Autorización

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

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

getMaxIterativeCalculationCycles()

Muestra el número máximo de iteraciones para usar 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());

Devolvedor

Integer: Es la cantidad máxima de iteraciones de cálculo.

Autorización

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

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

getName()

Obtiene el nombre del documento.

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

Devolvedor

String: Es el nombre de la hoja de cálculo.

Autorización

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

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

getNamedRanges()

Obtiene todos los rangos con nombre 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());
}

Devolvedor

NamedRange[]: Es un array de todos los rangos con nombre de la hoja de cálculo.

Autorización

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

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

getNumSheets()

Muestra el número de hojas en esta hoja de cálculo.

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

Devolvedor

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


getOwner()

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

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

Devolvedor

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

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

getPredefinedSpreadsheetThemes()

Muestra la lista de temas predefinidos.

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

Devolvedor

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

  • 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 las hojas protegidos en la hoja de cálculo.

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

Parámetros

NombreTipoDescripción
typeProtectionTypeEl tipo de área protegida, ya sea SpreadsheetApp.ProtectionType.RANGE o SpreadsheetApp.ProtectionType.SHEET.

Devolvedor

Protection[]: Es un array de objetos que representan todos los rangos o las hojas protegidos en una hoja de cálculo.

Autorización

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

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

getRange(a1Notation)

Muestra el rango especificado 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

NombreTipoDescripción
a1NotationStringRango que se va a mostrar, como se especifica en la notación A1 o la notación R1C1

Devolvedor

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

Autorización

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

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

getRangeByName(name)

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

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

Parámetros

NombreTipoDescripción
nameStringEl nombre del rango que se obtendrá.

Devolvedor

Range: Es el rango de celdas con el nombre determinado.


getRangeList(a1Notations)

Muestra la colección RangeList que representa los rangos de 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

NombreTipoDescripción
a1NotationsString[]Lista de rangos que se mostrarán, como se especifica en la notación A1 o la notación R1C1.

Devolvedor

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

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

getRecalculationInterval()

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

Devolvedor

RecalculationInterval: Es el intervalo de cálculo de esta hoja de cálculo.

Autorización

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

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

getRowHeight(rowPosition)

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

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

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

Parámetros

NombreTipoDescripción
rowPositionIntegerLa posición de la fila que se examinará.

Devolvedor

Integer: Altura de fila en píxeles

Autorización

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

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

getSelection()

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

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

Devolvedor

Selection: Es la selección actual.

Autorización

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

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

getSheetByName(name)

Muestra una hoja con el nombre determinado.

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

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

NombreTipoDescripción
nameStringEl nombre de la hoja que se va a obtener.

Devolvedor

Sheet: Es la hoja con el nombre determinado.


getSheetId()

Muestra el ID de la hoja representada por este objeto.

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

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

Logger.log(sheet.getSheetId());

Devolvedor

Integer: Es un ID para la hoja exclusiva de la hoja de cálculo.

Autorización

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

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

getSheetName()

Muestra el nombre de la hoja.

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

Logger.log(sheet.getSheetName());

Devolvedor

String: Es el nombre de la hoja.

Autorización

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

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

getSheetValues(startRow, startColumn, numRows, numColumns)

Muestra la cuadrícula rectangular de valores para este rango a partir de las coordenadas proporcionadas. Un valor -1 dado 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

NombreTipoDescripción
startRowIntegerLa posición de la fila inicial.
startColumnIntegerEs la posición de la columna inicial.
numRowsIntegerLa cantidad de filas para las que se mostrarán valores.
numColumnsIntegerEl número de columnas para las que se devuelven valores.

Devolvedor

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

Autorización

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

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

getSheets()

Obtiene todas las hojas en 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());
}

Devolvedor

Sheet[]: Es un array de todas las hojas en 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);

Devolvedor

String: Es la configuración regional de la hoja de cálculo.

Autorización

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

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

getSpreadsheetTheme()

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

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

Devolvedor

SpreadsheetTheme: Es el tema aplicado actualmente.

Autorización

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

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

getSpreadsheetTimeZone()

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

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

Devolvedor

String: Es la zona horaria, especificada en formato "largo" (por ejemplo, "America/New_York", según la lista de Joda.org).

Autorización

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

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

getUrl()

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

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

Devolvedor

String: Es la URL de la hoja de cálculo determinada.

Autorización

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

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

getViewers()

Obtiene la lista de lectores y comentaristas de este Spreadsheet.

Devolvedor

User[]: Es un array de usuarios con permiso de lectura o comentarios.

Autorización

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

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

hideColumn(column)

Oculta las columnas en el rango especificado.

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

NombreTipoDescripción
columnRangeEl rango de columnas que se ocultará.

Autorización

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

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

hideRow(row)

Oculta las filas en el 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

NombreTipoDescripción
rowRangeEl rango de filas que se ocultará.

Autorización

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

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

insertColumnAfter(afterPosition)

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

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

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

Parámetros

NombreTipoDescripción
afterPositionIntegerLa columna después de la cual se debe agregar la columna nueva.

Devolvedor

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

Autorización

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

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

insertColumnBefore(beforePosition)

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

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

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

Parámetros

NombreTipoDescripción
beforePositionIntegerLa columna antes de la que se debe agregar la columna nueva.

Devolvedor

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

Autorización

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

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

insertColumnsAfter(afterPosition, howMany)

Inserta un número determinado de columnas después de la posición de columna determinada.

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

NombreTipoDescripción
afterPositionIntegerLa columna después de la cual se debe agregar la columna nueva.
howManyIntegerLa cantidad de columnas que se insertarán.

Devolvedor

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

Autorización

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

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

insertColumnsBefore(beforePosition, howMany)

Inserta una cantidad de columnas antes de la posición de la 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

NombreTipoDescripción
beforePositionIntegerLa columna antes de la que se debe agregar la columna nueva.
howManyIntegerLa cantidad de columnas que se insertarán.

Devolvedor

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

Autorización

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

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

insertDataSourceSheet(spec)

Inserta un nuevo DataSourceSheet en la hoja de cálculo y, luego, inicia la ejecución de datos. Como efecto secundario, esto también convierte a la hoja nueva en la hoja activa.

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

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

NombreTipoDescripción
specDataSourceSpecLa especificación de fuente de datos con la que se insertará.

Devolvedor

DataSourceSheet: Es la nueva hoja de fuente de datos.

Autorización

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

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

insertImage(blobSource, column, row)

Inserta un Spreadsheet como 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 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

NombreTipoDescripción
blobSourceBlobSourceEs el BLOB que contiene el contenido de la imagen, el tipo de MIME y el nombre (opcionalmente).
columnIntegerEs la posición de la columna.
rowIntegerEs la posición de la fila.

Devolvedor

OverGridImage: Es la imagen insertada.

Autorización

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

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

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

Inserta un Spreadsheet como 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 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

NombreTipoDescripción
blobSourceBlobSourceEs el BLOB que contiene el contenido de la imagen, el tipo de MIME y el nombre (opcionalmente).
columnIntegerEs la posición de la columna.
rowIntegerEs la posición de la fila.
offsetXIntegerDesplazamiento horizontal desde la esquina de la celda en píxeles.
offsetYIntegerDesplazamiento vertical desde la esquina de la celda en píxeles.

Devolvedor

OverGridImage: Es la imagen insertada.

Autorización

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

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

insertImage(url, column, row)

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

La URL proporcionada debe ser de acceso público.

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

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

Parámetros

NombreTipoDescripción
urlStringEs la URL de la imagen.
columnIntegerPosición de la columna de la cuadrícula.
rowIntegerLa posición de la fila de la cuadrícula.

Devolvedor

OverGridImage: Es la imagen insertada.

Autorización

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

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

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

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

La URL proporcionada debe ser de acceso público.

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

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

Parámetros

NombreTipoDescripción
urlStringLa URL de la imagen.
columnIntegerEs la posición de la columna.
rowIntegerEs la posición de la fila.
offsetXIntegerDesplazamiento horizontal desde la esquina de la celda en píxeles.
offsetYIntegerDesplazamiento vertical desde la esquina de la celda en píxeles.

Devolvedor

OverGridImage: Es la imagen insertada.

Autorización

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

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

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

NombreTipoDescripción
afterPositionIntegerLa fila después de la cual se debe agregar la fila nueva.

Devolvedor

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

Autorización

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

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

insertRowBefore(beforePosition)

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

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

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

Parámetros

NombreTipoDescripción
beforePositionIntegerLa fila antes de la que se debe agregar la fila nueva.

Devolvedor

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

Autorización

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

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

insertRowsAfter(afterPosition, howMany)

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

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

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

Parámetros

NombreTipoDescripción
afterPositionIntegerLa fila después de la cual se deben agregar las filas nuevas.
howManyIntegerLa cantidad de filas que se insertarán.

Devolvedor

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

Autorización

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

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

insertRowsBefore(beforePosition, howMany)

Inserta 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

NombreTipoDescripción
beforePositionIntegerLa fila antes de la que se deben agregar las filas nuevas.
howManyIntegerLa cantidad de filas que se insertarán.

Devolvedor

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

Autorización

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

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

insertSheet()

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

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

Devolvedor

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

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

insertSheet(sheetIndex)

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

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

Parámetros

NombreTipoDescripción
sheetIndexIntegerEl índice de la hoja recién creada. Para insertar una hoja como la primera de la hoja de cálculo, establece el valor en 0.

Devolvedor

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

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

insertSheet(sheetIndex, options)

Inserta una hoja nueva en la hoja de cálculo con 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

NombreTipoDescripción
sheetIndexIntegerEl índice de la hoja recién creada. Para insertar una hoja como la primera de la hoja de cálculo, establece el valor en 0.
optionsObjectArgumentos opcionales avanzados de JavaScript.

Parámetros avanzados

NombreTipoDescripción
templateSheetTodos los datos del objeto de la 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.

Devolvedor

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

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

insertSheet(options)

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

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

Parámetros

NombreTipoDescripción
optionsObjectArgumentos opcionales avanzados de JavaScript, que se enumeran a continuación.

Parámetros avanzados

NombreTipoDescripción
templateSheetTodos los datos del objeto de la hoja de plantilla se copian en la hoja nueva. La plantilla de hoja debe ser una de las hojas de este objeto de hoja de cálculo.

Devolvedor

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

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

insertSheet(sheetName)

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

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

Parámetros

NombreTipoDescripción
sheetNameStringEl nombre de la hoja nueva.

Devolvedor

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

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

insertSheet(sheetName, sheetIndex)

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

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

Parámetros

NombreTipoDescripción
sheetNameStringEl nombre de la hoja nueva.
sheetIndexIntegerEl índice de la hoja recién creada. Para insertar una hoja como la primera de la hoja de cálculo, establece el valor en 0.

Devolvedor

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

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

insertSheet(sheetName, sheetIndex, options)

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

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

Parámetros

NombreTipoDescripción
sheetNameStringEl nombre de la hoja nueva.
sheetIndexIntegerEl índice de la hoja recién insertada. Para insertar una hoja como la primera de una hoja de cálculo, establece el valor en 0.
optionsObjectArgumentos opcionales avanzados de JavaScript.

Parámetros avanzados

NombreTipoDescripción
templateSheetTodos los datos del objeto de la 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.

Devolvedor

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

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

insertSheet(sheetName, options)

Inserta una hoja nueva en la hoja de cálculo con el nombre dado y utiliza 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

NombreTipoDescripción
sheetNameStringEl nombre de la hoja nueva.
optionsObjectArgumentos opcionales avanzados de JavaScript.

Parámetros avanzados

NombreTipoDescripción
templateSheetTodos los datos del objeto de la 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.

Devolvedor

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

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

insertSheetWithDataSourceTable(spec)

Inserta una hoja nueva en la hoja de cálculo, crea una DataSourceTable que abarca toda la hoja con la especificación de fuente de datos determinada y, luego, inicia la ejecución de los datos. Como efecto secundario, la nueva hoja se convierte en la hoja activa.

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

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

NombreTipoDescripción
specDataSourceSpecLa especificación de fuente de datos con la que se insertará.

Devolvedor

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

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

isColumnHiddenByUser(columnPosition)

Muestra si la columna determinada está oculta por el usuario.

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

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

Parámetros

NombreTipoDescripción
columnPositionIntegerLa posición de la columna que se examinará.

Devolvedor

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

Autorización

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

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

isIterativeCalculationEnabled()

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

Devolvedor

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

Autorización

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

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

isRowHiddenByFilter(rowPosition)

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

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

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

Parámetros

NombreTipoDescripción
rowPositionIntegerLa posición de la fila que se examinará.

Devolvedor

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

Autorización

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

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

isRowHiddenByUser(rowPosition)

Muestra si la fila dada está oculta por el usuario.

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

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

Parámetros

NombreTipoDescripción
rowPositionIntegerLa posición de la fila que se examinará.

Devolvedor

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

Autorización

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

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

moveActiveSheet(pos)

Mueve la hoja activa a la posición determinada en la lista de hojas. Muestra 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

NombreTipoDescripción
posIntegerLa 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 alcances:

  • 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 se encuentra en su propia hoja, esta se muestra sin crear una nueva.

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

Parámetros

NombreTipoDescripción
chartEmbeddedChartEl gráfico que se moverá.

Devolvedor

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

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

refreshAllDataSources()

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

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

// 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 alcances:

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

removeEditor(emailAddress)

Quita al usuario determinado de la lista de editores del 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 está en una unidad compartida a la que el usuario puede acceder.

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

Parámetros

NombreTipoDescripción
emailAddressStringEs la dirección de correo electrónico del usuario que se quitará.

Devolvedor

Spreadsheet: Es este Spreadsheet para encadenamiento.

Autorización

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

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

removeEditor(user)

Quita al usuario determinado de la lista de editores del 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 está en una unidad compartida a la que el usuario puede acceder.

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

Parámetros

NombreTipoDescripción
userUserEs una representación del usuario que se quitará.

Devolvedor

Spreadsheet: Es este Spreadsheet para encadenamiento.

Autorización

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

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

removeMenu(name)

Quita un menú que agregó addMenu(name, subMenus). El argumento name debe tener el mismo valor que la llamada 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

NombreTipoDescripción
nameStringEs el nombre del menú que se quitará.

Autorización

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

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

removeNamedRange(name)

Borra un rango con nombre que tiene el nombre dado. Muestra una excepción si no se encuentra un rango con el nombre dado 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

NombreTipoDescripción
nameStringEl nombre del rango.

Autorización

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

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

removeViewer(emailAddress)

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

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

Parámetros

NombreTipoDescripción
emailAddressStringEs la dirección de correo electrónico del usuario que se quitará.

Devolvedor

Spreadsheet: Es este Spreadsheet para encadenamiento.

Autorización

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

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

removeViewer(user)

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

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

Parámetros

NombreTipoDescripción
userUserEs una representación del usuario que se quitará.

Devolvedor

Spreadsheet: Es este Spreadsheet para encadenamiento.

Autorización

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

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

rename(newName)

Cambia el nombre del documento.

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

Parámetros

NombreTipoDescripción
newNameStringEs 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 alcances:

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

renameActiveSheet(newName)

Cambia el nombre de la hoja activa actual por el nombre nuevo asignado.

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

Parámetros

NombreTipoDescripción
newNameStringEl 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 alcances:

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

resetSpreadsheetTheme()

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

Devolvedor

SpreadsheetTheme: Es el tema predeterminado.

Autorización

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

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

setActiveRange(range)

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

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

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

Parámetros

NombreTipoDescripción
rangeRangeEs el rango que se establecerá como el rango activo.

Devolvedor

Range: Es el nuevo rango activo.

Autorización

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

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

setActiveRangeList(rangeList)

Establece la lista especificada de rangos como el 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

NombreTipoDescripción
rangeListRangeListEs la lista de rangos para seleccionar.

Devolvedor

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

Autorización

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

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

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

NombreTipoDescripción
rangeRangeEs el rango que se establecerá como la selección activa.

Devolvedor

Range: Es el nuevo rango activo.

Autorización

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

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

setActiveSelection(a1Notation)

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

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

sheet.setActiveSelection("A1:D4");

Parámetros

NombreTipoDescripción
a1NotationStringEl rango que se establece como activo, como se especifica en la notación A1 o en la notación R1C1.

Devolvedor

Range: Es el nuevo rango activo.

Autorización

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

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

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

NombreTipoDescripción
sheetSheetLa hoja que se va a establecer como hoja activa.

Devolvedor

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

  • 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 otra hoja de cálculo.

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

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

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

Parámetros

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

Devolvedor

Sheet: Es la nueva hoja activa.

Autorización

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

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

setColumnWidth(columnPosition, width)

Establece el ancho de una 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

NombreTipoDescripción
columnPositionIntegerLa posición de la columna determinada que se va a establecer.
widthIntegerEs el ancho en píxeles que se usará.

Devolvedor

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

Autorización

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

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

setCurrentCell(cell)

Establece la celda especificada como current cell.

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

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

Nota: El Range especificado debe constar de una celda; de lo contrario, 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

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

Devolvedor

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

Autorización

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

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

setFrozenColumns(columns)

Inmoviliza el número determinado de columnas. Si es cero, ninguna columna se inmoviliza.

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

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

Parámetros

NombreTipoDescripción
columnsIntegerLa 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 alcances:

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

setFrozenRows(rows)

Inmoviliza la cantidad de filas especificada. 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

NombreTipoDescripción
rowsIntegerLa 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 alcances:

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

setIterativeCalculationConvergenceThreshold(minThreshold)

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

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

NombreTipoDescripción
minThresholdNumberEl umbral de convergencia mínimo (debe ser no negativo).

Devolvedor

Spreadsheet: Esta hoja de cálculo se usa para encadenar.

Autorización

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

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

setIterativeCalculationEnabled(isEnabled)

Establece si el cálculo iterativo se activa en esta hoja de cálculo. Si la cantidad máxima de ciclos de cálculo y el umbral de convergencia no se establecieron antes cuando se activa el cálculo, la cantidad predeterminada es 50 y 0.05, respectivamente. Si alguno se configuró antes, conservan 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

NombreTipoDescripción
isEnabledBooleantrue si se debe habilitar el cálculo iterativo; de lo contrario, false.

Devolvedor

Spreadsheet: Esta hoja de cálculo se usa para encadenar.

Autorización

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

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

setMaxIterativeCalculationCycles(maxIterations)

Establece la cantidad máxima de iteraciones de cálculo que deben realizarse durante un 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

NombreTipoDescripción
maxIterationsIntegerEl número máximo de iteraciones de cálculo (entre 1 y 10,000).

Devolvedor

Spreadsheet: Esta hoja de cálculo se usa para encadenar.

Autorización

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

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

setNamedRange(name, range)

Nombra 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

NombreTipoDescripción
nameStringEl nombre que se asignará al rango.
rangeRangeLa especificación del rango.

Autorización

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

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

setRecalculationInterval(recalculationInterval)

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

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

NombreTipoDescripción
recalculationIntervalRecalculationIntervalEl nuevo intervalo de nuevo cálculo.

Devolvedor

Spreadsheet: Esta hoja de cálculo se usa para encadenar.

Autorización

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

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

setRowHeight(rowPosition, height)

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

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

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

Parámetros

NombreTipoDescripción
rowPositionIntegerLa posición de la fila que se cambiará.
heightIntegerEs la altura en píxeles para establecerla.

Devolvedor

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

Autorización

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

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

setSpreadsheetLocale(locale)

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

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

NombreTipoDescripción
localeStringEl 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 alcances:

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

setSpreadsheetTheme(theme)

Establece un tema en la hoja de cálculo.

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

Parámetros

NombreTipoDescripción
themeSpreadsheetThemeEl tema que se aplicará.

Devolvedor

SpreadsheetTheme: Es el nuevo tema actual.

Autorización

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

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

setSpreadsheetTimeZone(timezone)

Establece la zona horaria para 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

NombreTipoDescripción
timezoneStringLa zona horaria, especificada en formato "largo" (por ejemplo, "America/New_York", como se indica en Joda.org).

Autorización

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

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

show(userInterface)

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

Si la secuencia de comandos del servidor mostraba 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

NombreTipoDescripción
userInterfaceObjectEs un objeto HtmlOutput.

Autorización

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

  • https://www.googleapis.com/auth/script.container.ui

sort(columnPosition)

Ordena una hoja por columna, de forma ascendente.

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

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

Parámetros

NombreTipoDescripción
columnPositionIntegerLa columna que se usará para ordenar.

Devolvedor

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

Autorización

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

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

sort(columnPosition, ascending)

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

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

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

Parámetros

NombreTipoDescripción
columnPositionIntegerLa columna que se usará para ordenar.
ascendingBooleantrue para los tipos ascendentes, false para los descendentes.

Devolvedor

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

Autorización

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

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

toast(msg)

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

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

Parámetros

NombreTipoDescripción
msgStringEs 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 alcances:

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

toast(msg, title)

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

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

Parámetros

NombreTipoDescripción
msgStringEs el mensaje que se mostrará en el aviso.
titleStringEs el título opcional del aviso.

Autorización

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

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

toast(msg, title, timeoutSeconds)

Muestra una ventana emergente en la esquina inferior derecha de la hoja de cálculo con el título y el mensaje especificados, que permanece visible 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

NombreTipoDescripción
msgStringEs el mensaje que se mostrará en el aviso.
titleStringEs el título opcional del aviso.
timeoutSecondsNumberEs el tiempo de espera en segundos. Si es null, el aviso predeterminado es de 5 segundos. Si es negativo, 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 alcances:

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

unhideColumn(column)

Muestra la columna en el rango especificado.

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

NombreTipoDescripción
columnRangeEl rango que se muestra, si está oculto.

Autorización

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

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

unhideRow(row)

Muestra la fila en el rango especificado.

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

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

Parámetros

NombreTipoDescripción
rowRangeEl rango que se muestra, si está oculto.

Autorización

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

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

updateMenu(name, subMenus)

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

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

Parámetros

NombreTipoDescripción
nameStringEl nombre del menú que se actualizará.
subMenusObject[]Un array de mapas de JavaScript con los parámetros name y functionName . Puedes usar funciones de las bibliotecas incluidas, como Library.libFunction1.

Autorización

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

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

waitForAllDataExecutionsCompletion(timeoutInSeconds)

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

Parámetros

NombreTipoDescripción
timeoutInSecondsIntegerEl tiempo de espera para las ejecuciones de datos, en segundos. El máximo es 300 segundos.

Autorización

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

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

Métodos obsoletos