Class Spreadsheet

Spreadsheet

Acceder a archivos de Hojas de cálculo de Google y modificarlos. Las operaciones comunes son agregar hojas nuevas y agregar 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 a la hoja de cálculo los metadatos del desarrollador con la clave y el valor especificados.
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 de Spreadsheet.
addEditor(user)SpreadsheetAgrega el usuario determinado a la lista de editores de Spreadsheet.
addEditors(emailAddresses)SpreadsheetAgrega el array determinado de usuarios a la lista de editores de Spreadsheet.
addMenu(name, subMenus)voidCrea un menú nuevo en la IU de la hoja de cálculo.
addViewer(emailAddress)SpreadsheetAgrega el usuario específico a la lista de lectores de Spreadsheet.
addViewer(user)SpreadsheetAgrega el usuario específico a la lista de lectores de Spreadsheet.
addViewers(emailAddresses)SpreadsheetAgrega el array determinado de usuarios a la lista de visualizadores de Spreadsheet.
appendRow(rowContents)SheetAgrega una fila al final de la región de datos actual en la hoja.
autoResizeColumn(columnPosition)SheetConfigura el ancho de la columna determinada para que se ajuste a su contenido.
copy(name)SpreadsheetCopia la hoja de cálculo y devuelve la nueva.
createDeveloperMetadataFinder()DeveloperMetadataFinderMuestra un DeveloperMetadataFinder para encontrar metadatos del desarrollador dentro del permiso 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 actualmente activa.
deleteColumn(columnPosition)SheetBorra la columna en la posición dada.
deleteColumns(columnPosition, howMany)voidBorra una cantidad de columnas que comienzan en la posición determinada de la columna.
deleteRow(rowPosition)SheetElimina la fila en la posición de fila especificada.
deleteRows(rowPosition, howMany)voidElimina una cantidad de filas que comienzan en 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 ningún rango activo.
getActiveRangeList()RangeListMuestra la lista de rangos activos en la hoja activa o null si no hay ningún rango activo o rangos.
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 en 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 una celda actual.
getDataRange()RangeMuestra un objeto Range que corresponde a las dimensiones en las que están presentes los datos.
getDataSourceFormulas()DataSourceFormula[]Obtiene todas las fórmulas de fuente de datos.
getDataSourcePivotTables()DataSourcePivotTable[]Obtiene todas las tablas dinámicas de la fuente de datos.
getDataSourceRefreshSchedules()DataSourceRefreshSchedule[]Obtiene los programas de actualización de esta hoja de cálculo.
getDataSourceSheets()DataSourceSheet[]Muestra todas las hojas de fuente de datos de la hoja de cálculo.
getDataSourceTables()DataSourceTable[]Obtiene todas las tablas de fuentes de datos.
getDataSources()DataSource[]Muestra todas las fuentes de datos de la hoja de cálculo.
getDeveloperMetadata()DeveloperMetadata[]Obtiene los metadatos del desarrollador asociados con la hoja de cálculo de nivel superior.
getEditors()User[]Obtiene la lista de editores de este Spreadsheet.
getFormUrl()StringDevuelve la URL del formulario que envía sus respuestas a esta hoja de cálculo o null si esta hoja de cálculo no tiene ningún 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 en la cuadrícula de la hoja.
getIterativeCalculationConvergenceThreshold()NumberMuestra el valor de umbral que se usó 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 la cantidad máxima de iteraciones que se usarán 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 de 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 representa todos los rangos u hojas protegidos en la hoja de cálculo.
getRange(a1Notation)RangeMuestra el rango como se especifica en la notación A1 o en la notación R1C1.
getRangeByName(name)RangeMuestra un rango con nombre, o null si no se encuentra ningún rango con el nombre proporcionado.
getRangeList(a1Notations)RangeListDevuelve la colección RangeList que representa los rangos de la misma hoja especificada. con una lista no vacía de notaciones A1 o R1C1.
getRecalculationInterval()RecalculationIntervalDevuelve el intervalo de cálculo para 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)SheetDevuelve una hoja con el nombre dado.
getSheetId()IntegerDevuelve 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 de 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 aplica ningún tema.
getSpreadsheetTimeZone()StringObtiene la zona horaria de la hoja de cálculo.
getUrl()StringMuestra la URL de la hoja de cálculo especificada.
getViewers()User[]Obtiene la lista de lectores y comentaristas de este Spreadsheet.
hideColumn(column)voidOculta las columnas del rango especificado.
hideRow(row)voidOculta las filas en el rango especificado.
insertColumnAfter(afterPosition)SheetInserta una columna después de la posición dada de la columna.
insertColumnBefore(beforePosition)SheetInserta una columna antes de la posición de la columna especificada.
insertColumnsAfter(afterPosition, howMany)SheetInserta un número determinado de columnas después de la posición de la columna especificada.
insertColumnsBefore(beforePosition, howMany)SheetInserta una cantidad de columnas antes de la posición de la columna especificada.
insertDataSourceSheet(spec)DataSourceSheetInserta un DataSourceSheet nuevo en la hoja de cálculo e inicia la ejecución de datos.
insertImage(blobSource, column, row)OverGridImageInserta un objeto Spreadsheet como imagen en el documento en una fila y columna determinadas.
insertImage(blobSource, column, row, offsetX, offsetY)OverGridImageInserta un elemento 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 desplazamiento de píxeles.
insertRowAfter(afterPosition)SheetInserta una fila después de la posición de fila especificada.
insertRowBefore(beforePosition)SheetInserta una fila antes de la posición de fila especificada.
insertRowsAfter(afterPosition, howMany)SheetInserta una cantidad de filas después de la posición de fila especificada.
insertRowsBefore(beforePosition, howMany)SheetInserta una cantidad de filas antes de la posición de fila especificada.
insertSheet()SheetInserta una hoja nueva en la hoja de cálculo con un nombre de hoja predeterminado.
insertSheet(sheetIndex)SheetInserta una hoja nueva en la hoja de cálculo en el índice determinado.
insertSheet(sheetIndex, options)SheetInserta una hoja nueva en la hoja de cálculo en el índice determinado y usa la función avanzada argumentos.
insertSheet(options)SheetInserta una hoja nueva en la hoja de cálculo con un nombre de hoja predeterminado y un avanzado opcional. argumentos.
insertSheet(sheetName)SheetInserta una hoja nueva en la hoja de cálculo con el nombre dado.
insertSheet(sheetName, sheetIndex)SheetInserta una hoja nueva en la hoja de cálculo con el nombre que se indica en el índice indicado.
insertSheet(sheetName, sheetIndex, options)SheetInserta una hoja nueva en la hoja de cálculo con el nombre dado en el índice dado y utiliza argumentos avanzados opcionales.
insertSheet(sheetName, options)SheetInserta una hoja nueva en la hoja de cálculo con el nombre dado y utiliza la opción avanzada argumentos.
insertSheetWithDataSourceTable(spec)SheetInserta una nueva hoja en la hoja de cálculo, crea un DataSourceTable que abarca la toda la hoja con la especificación de fuente de datos dada y comienza la ejecución de los datos.
isColumnHiddenByUser(columnPosition)BooleanMuestra si el usuario ocultó la columna especificada.
isIterativeCalculationEnabled()BooleanMuestra si el cálculo iterativo está activado en esta hoja de cálculo.
isRowHiddenByFilter(rowPosition)BooleanMuestra si un filtro (no una vista de filtro) ocultó la fila especificada.
isRowHiddenByUser(rowPosition)BooleanMuestra si el usuario ocultó la fila especificada.
moveActiveSheet(pos)voidMueve la hoja activa a la posición determinada en la lista de hojas.
moveChartToObjectSheet(chart)SheetCrea una nueva hoja de SheetType.OBJECT 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 las entradas no válidas. objetos de fuente de datos.
removeEditor(emailAddress)SpreadsheetQuita al usuario determinado de la lista de editores de Spreadsheet.
removeEditor(user)SpreadsheetQuita al usuario determinado de la lista de editores de Spreadsheet.
removeMenu(name)voidQuita un menú que agregó addMenu(name, subMenus).
removeNamedRange(name)voidBorra un rango con nombre con ese nombre.
removeViewer(emailAddress)SpreadsheetQuita al usuario específico de la lista de lectores y comentaristas de Spreadsheet.
removeViewer(user)SpreadsheetQuita al usuario específico de la lista de lectores y comentaristas de Spreadsheet.
rename(newName)voidCambia el nombre del documento.
renameActiveSheet(newName)voidCambia el nombre de la hoja activa actual por el nuevo nombre que se proporcionó.
resetSpreadsheetTheme()SpreadsheetThemeQuita 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 del rango como current cell.
setActiveRangeList(rangeList)RangeListEstablece la lista especificada de rangos como active ranges en el 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 dada 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 la opción de restablecer la la selección más reciente dentro de esa hoja.
setColumnWidth(columnPosition, width)SheetEstablece el ancho de la 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 del umbral mínimo para el cálculo iterativo.
setIterativeCalculationEnabled(isEnabled)SpreadsheetEstablece si se activa el cálculo iterativo en esta hoja de cálculo.
setMaxIterativeCalculationCycles(maxIterations)SpreadsheetEstablece la cantidad máxima de iteraciones de cálculo que se deben realizar durante la iteración cálculo.
setNamedRange(name, range)voidAsigna el nombre a 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 determinada 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 de la hoja de cálculo.
show(userInterface)voidMuestra un componente de interfaz de usuario personalizada en un diálogo centrado en el navegador del usuario. viewport.
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 dado y título.
toast(msg, title, timeoutSeconds)voidMuestra una ventana emergente en la esquina inferior derecha de la hoja de cálculo con el título y mensaje, 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 el tiempo de espera se agota después de la 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 para los nuevos metadatos del desarrollador.

Volver

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

Autorización

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

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

addDeveloperMetadata(key, visibility)

Agrega metadatos del desarrollador con la clave y 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 para los nuevos metadatos del desarrollador.
visibilityDeveloperMetadataVisibilityLa visibilidad de los nuevos metadatos del desarrollador

Volver

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

Autorización

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

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

addDeveloperMetadata(key, value)

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

// 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 para los nuevos metadatos del desarrollador.
valueStringEl valor de los nuevos metadatos del desarrollador.

Volver

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

Autorización

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

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

addDeveloperMetadata(key, value, visibility)

Agrega metadatos del desarrollador con la clave, el valor y la visibilidad especificados 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 para los nuevos metadatos del desarrollador.
valueStringEl valor de los nuevos metadatos del desarrollador.
visibilityDeveloperMetadataVisibilityLa visibilidad de los nuevos metadatos del desarrollador

Volver

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

Autorización

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

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

addEditor(emailAddress)

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

Parámetros

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

Volver

Spreadsheet: Este Spreadsheet, para el encadenamiento.

Autorización

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

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

addEditor(user)

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

Parámetros

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

Volver

Spreadsheet: Este Spreadsheet, para el encadenamiento.

Autorización

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

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

addEditors(emailAddresses)

Agrega el array determinado de usuarios a la lista de editores de Spreadsheet. Si alguno de los usuarios ya estaban en la lista de usuarios; este método los hace desaparecer 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.

Volver

Spreadsheet: Este Spreadsheet, para el encadenamiento.

Autorización

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

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

addMenu(name, subMenus)

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

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

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

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

Parámetros

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 específico a la lista de lectores de Spreadsheet. Si el usuario ya estaba en la lista de editores, este método no tiene efecto.

Parámetros

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

Volver

Spreadsheet: Este Spreadsheet, para el encadenamiento.

Autorización

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

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

addViewer(user)

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

Parámetros

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

Volver

Spreadsheet: Este Spreadsheet, para el encadenamiento.

Autorización

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

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

addViewers(emailAddresses)

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

Parámetros

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

Volver

Spreadsheet: Este Spreadsheet, para el encadenamiento.

Autorización

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

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

appendRow(rowContents)

Agrega una fila al final 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 de la hoja.

Volver

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

Autorización

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

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

autoResizeColumn(columnPosition)

Configura 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 debe cambiar el tamaño.

Volver

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

Autorización

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

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

copy(name)

Copia la hoja de cálculo y devuelve 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.

Volver

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

Autorización

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

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

createDeveloperMetadataFinder()

Muestra un DeveloperMetadataFinder para encontrar metadatos del desarrollador dentro del permiso de esta hoja de cálculo. Por defecto, se consideran todos los metadatos asociados a la hoja de cálculo hojas, filas y columnas.

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

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

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

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

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

Volver

DeveloperMetadataFinder: Es un buscador de metadatos de 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

Volver

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


deleteActiveSheet()

Borra la hoja actualmente activa.

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

Volver

Sheet: Es la nueva hoja activa.

Autorización

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

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

deleteColumn(columnPosition)

Borra la columna en la posición dada.

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

Volver

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

Autorización

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

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

deleteColumns(columnPosition, howMany)

Borra una cantidad de columnas que comienzan en la posición determinada de la columna.

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)

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

Volver

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

Autorización

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

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

deleteRows(rowPosition, howMany)

Elimina una cantidad de filas que comienzan en 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();

Volver

Sheet: Es la hoja nueva.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes 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 el valor actual celda destacada.

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

Volver

Range: Es la celda activa actual.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes 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 ningún rango activo. Si cuando se seleccionan varios rangos, este método devuelve solo el último rango seleccionado.

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

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

Volver

Range: Es el rango activo.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes 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 ningún rango activo o rangos.

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

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

Volver

RangeList: 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 hoja de cálculo de la IU de Google.

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

Volver

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. Esta agrega la extensión adecuada al nombre del archivo, por ejemplo, "miarchivo.pdf". Sin embargo, supone que la parte del nombre de archivo que sigue al último punto (si corresponde) es una parte extensión que debe reemplazarse. Por lo tanto, "ShoppingList.12.25.2014" se convierte en “ShoppingList.12.25.pdf”.

Para ver las cuotas diarias de las conversiones, consulta Cuotas para Google Servicios Es posible que los dominios de Google Workspace recién creados estén sujetos temporalmente a restricciones y cuotas.

Parámetros

NombreTipoDescripción
contentTypeStringEl tipo de MIME en el que se convertirá. 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 se aplica cualquiera de los siguientes valores: 'image/bmp', 'image/gif', 'image/jpeg' o 'image/png'. válido. 'text/markdown' también es válido para Documentos de Google.

Volver

Blob: Los datos como un BLOB.


getBandings()

Muestra todas las bandas 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');

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

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

Volver

Banding[]: 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.

Volver

Blob: Los datos como un BLOB.


getColumnWidth(columnPosition)

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

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

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

Parámetros

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

Volver

Integer: Ancho de columna en píxeles

Autorización

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

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

getCurrentCell()

Muestra la celda actual en la hoja activa o null si no hay una celda actual. El la celda actual es la que está enfocada en la IU de Hojas de cálculo de Google y está destacada con una luz borde. Nunca hay más de una celda actual. Cuando un usuario selecciona uno o más rangos de celdas, una de las celdas de la selección es la celda actual.

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

Volver

Range: Es la celda actual.

Autorización

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

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

getDataRange()

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

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

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

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

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

Volver

Range: Un rango que 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 fuente de datos.

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

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

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

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

Volver

DataSourceFormula[]: Es una lista de fórmulas de 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());

Volver

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

Autorización

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

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

getDataSourceRefreshSchedules()

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

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

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

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

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

Volver

DataSourceRefreshSchedule[]: Son las programaciones de actualización de esta hoja de cálculo.

Autorización

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

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

getDataSourceSheets()

Muestra todas las hojas de 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());

Volver

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

Autorización

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

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

getDataSourceTables()

Obtiene todas las tablas de fuentes de datos.

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

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

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

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

Volver

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

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes 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());

Volver

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

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes 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());

Volver

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

Autorización

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

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

getEditors()

Obtiene la lista de editores de este Spreadsheet.

Volver

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

Autorización

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

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

getFormUrl()

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

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

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

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

Volver

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

Autorización

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

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

getFrozenColumns()

Muestra el número de columnas inmovilizadas.

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

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

Volver

Integer: La cantidad de columnas inmovilizadas

Autorización

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

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

getFrozenRows()

Muestra el número de filas inmovilizadas.

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

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

Volver

Integer: Es la cantidad de filas inmovilizadas.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes 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());

Volver

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


getImages()

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

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

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

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

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

Volver

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

Autorización

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

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

getIterativeCalculationConvergenceThreshold()

Muestra el valor de umbral que se usó durante el cálculo iterativo. Cuando los resultados de sucesivos Si el cálculo difiere por un valor menor que este, se detiene el cálculo iterativo.

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

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

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

Volver

Number: Es el umbral de convergencia.

Autorización

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

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

getLastColumn()

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

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

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

Volver

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

Volver

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

Autorización

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

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

getMaxIterativeCalculationCycles()

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

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

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

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

Volver

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

Autorización

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

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

getName()

Obtiene el nombre del documento.

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

Volver

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

Autorización

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

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

getNamedRanges()

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

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

Volver

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

Autorización

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

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

getNumSheets()

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

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

Volver

Integer: Es la cantidad de hojas 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());

Volver

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

Autorización

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

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

getPredefinedSpreadsheetThemes()

Muestra la lista de temas predefinidos.

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

Volver

SpreadsheetTheme[]: 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 representa todos los rangos u 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

Volver

Protection[]: Es un array de objetos que representa todos los rangos o las hojas protegidas de la hoja de cálculo.

Autorización

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

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

getRange(a1Notation)

Muestra el rango como se especifica en la notación A1 o en la notación 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 en la notación R1C1.

Volver

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

Autorización

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

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

getRangeByName(name)

Muestra un rango con nombre, o null si no se encuentra ningún rango con el nombre proporcionado. Si hay varios hojas de la hoja de cálculo usan el mismo nombre de rango, especifica el nombre de la hoja sin incluir comillas, 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 debe obtener.

Volver

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


getRangeList(a1Notations)

Devuelve la colección RangeList que representa los rangos de la misma hoja especificada. con 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[]La lista de rangos que se mostrarán, como se especifica en la notación A1 o en la notación R1C1.

Volver

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

Autorización

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

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

getRecalculationInterval()

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

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

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

Volver

RecalculationInterval: Es el intervalo de cálculo para 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 debe examinar.

Volver

Integer: La altura de las filas en píxeles

Autorización

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

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

getSelection()

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

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

Volver

Selection: Es la selección actual.

Autorización

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

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

getSheetByName(name)

Devuelve una hoja con el nombre dado.

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

// 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 debe obtener.

Volver

Sheet: Es la hoja con el nombre determinado.


getSheetId()

Devuelve el ID de la hoja representada por este objeto.

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

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

Logger.log(sheet.getSheetId());

Volver

Integer: Es un ID de la hoja único de la hoja de cálculo.

Autorización

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

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

getSheetName()

Muestra el nombre de la hoja.

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

Logger.log(sheet.getSheetName());

Volver

String: Es el nombre de la hoja.

Autorización

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

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

getSheetValues(startRow, startColumn, numRows, numColumns)

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

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

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

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

Parámetros

NombreTipoDescripción
startRowIntegerLa posición de la fila inicial.
startColumnIntegerLa posición de la columna inicial.
numRowsIntegerLa cantidad de filas para las que se mostrarán valores.
numColumnsIntegerLa cantidad de columnas para las que se muestran valores.

Volver

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

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

Volver

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


getSpreadsheetLocale()

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

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

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

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

Volver

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

Autorización

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

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

getSpreadsheetTheme()

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

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

Volver

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

Volver

String: Indica la zona horaria, especificada en “long”. (por ejemplo, “América/Nueva_York”, como se indica 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 especificada.

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

Volver

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

Autorización

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

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

getViewers()

Obtiene la lista de lectores y comentaristas de este Spreadsheet.

Volver

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

Autorización

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

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

hideColumn(column)

Oculta las columnas del 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 dada 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
afterPositionIntegerColumna después de la cual se debe agregar la nueva columna.

Volver

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

Autorización

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

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

insertColumnBefore(beforePosition)

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

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

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

Parámetros

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

Volver

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

Autorización

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

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

insertColumnsAfter(afterPosition, howMany)

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

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

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

Parámetros

NombreTipoDescripción
afterPositionIntegerColumna después de la cual se debe agregar la nueva columna.
howManyIntegerNúmero de columnas que se insertarán.

Volver

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

Autorización

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

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

insertColumnsBefore(beforePosition, howMany)

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

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 nueva columna.
howManyIntegerNúmero de columnas que se insertarán.

Volver

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

Autorización

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

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

insertDataSourceSheet(spec)

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

Arroja una excepción si el tipo de fuente de datos no está habilitado. Usar métodos SpreadsheetApp#enable...Execution() para habilitar la ejecución de datos para una fuente de datos específica el tipo de letra.

// 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 la fuente de datos con la que se insertará.

Volver

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 objeto Spreadsheet como imagen en el documento en una fila y columna determinadas. La imagen el tamaño 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
blobSourceBlobSourceEl BLOB que incluye el contenido de la imagen, el tipo de MIME y el nombre (opcional).
columnIntegerLa posición de la columna.
rowIntegerLa posición de la fila.

Volver

OverGridImage: Es la imagen insertada.

Autorización

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

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

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

Inserta un elemento 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 BLOB máximo admitido es de 2 MB.

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

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

Parámetros

NombreTipoDescripción
blobSourceBlobSourceEl BLOB que incluye el contenido de la imagen, el tipo de MIME y el nombre (opcional).
columnIntegerLa posición de la columna.
rowIntegerLa posición de la fila.
offsetXIntegerDesplazamiento horizontal a partir de la esquina de la celda en píxeles.
offsetYIntegerDesplazamiento vertical desde la esquina de la celda en píxeles.

Volver

OverGridImage: Es la imagen insertada.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes 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.
columnIntegerLa posición de la columna de la cuadrícula.
rowIntegerLa posición de la fila de la cuadrícula.

Volver

OverGridImage: Es la imagen insertada.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes 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 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
urlStringEs la URL de la imagen.
columnIntegerLa posición de la columna.
rowIntegerLa posición de la fila.
offsetXIntegerDesplazamiento horizontal a partir de la esquina de la celda en píxeles.
offsetYIntegerDesplazamiento vertical desde la esquina de la celda en píxeles.

Volver

OverGridImage: Es la imagen insertada.

Autorización

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

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

insertRowAfter(afterPosition)

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

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

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

Parámetros

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

Volver

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

Autorización

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

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

insertRowBefore(beforePosition)

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

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

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

Parámetros

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

Volver

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

Autorización

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

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

insertRowsAfter(afterPosition, howMany)

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

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

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

Parámetros

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

Volver

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

Autorización

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

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

insertRowsBefore(beforePosition, howMany)

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

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.

Volver

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

Autorización

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

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

insertSheet()

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

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

Volver

Sheet: Es la hoja nueva.

Autorización

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

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

insertSheet(sheetIndex)

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

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 en la hoja de cálculo, establécelo en 0.

Volver

Sheet: Es la hoja nueva.

Autorización

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

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

insertSheet(sheetIndex, options)

Inserta una hoja nueva en la hoja de cálculo en el índice determinado y usa la función avanzada argumentos. 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 en la hoja de cálculo, establécelo en 0.
optionsObjectArgumentos avanzados opcionales de JavaScript.

Parámetros avanzados

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

Volver

Sheet: Es la hoja nueva.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes 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 un avanzado opcional. argumentos. 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 avanzados opcionales de JavaScript, que se enumeran a continuación.

Parámetros avanzados

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

Volver

Sheet: Es la hoja nueva.

Autorización

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

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

insertSheet(sheetName)

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

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

Parámetros

NombreTipoDescripción
sheetNameStringEs el nombre de la hoja nueva.

Volver

Sheet: Es la hoja nueva.

Autorización

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

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

insertSheet(sheetName, sheetIndex)

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

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

Parámetros

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

Volver

Sheet: Es la hoja nueva.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes 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 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', 1, {template: templateSheet});

Parámetros

NombreTipoDescripción
sheetNameStringEs el nombre de la hoja nueva.
sheetIndexIntegerEl índice de la hoja insertada recientemente. Para insertar una hoja como la primera en hoja de cálculo, establécelo en 0.
optionsObjectArgumentos avanzados opcionales de JavaScript.

Parámetros avanzados

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

Volver

Sheet: Es la hoja nueva.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes 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 la opción avanzada argumentos. 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
sheetNameStringEs el nombre de la hoja nueva.
optionsObjectArgumentos avanzados opcionales de JavaScript.

Parámetros avanzados

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

Volver

Sheet: Es la hoja nueva.

Autorización

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

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

insertSheetWithDataSourceTable(spec)

Inserta una nueva hoja en la hoja de cálculo, crea un DataSourceTable que abarca la toda la hoja con la especificación de fuente de datos dada y comienza la ejecución de los datos. Como complemento hace que la hoja nueva se convierta en hoja activa.

Arroja una excepción si el tipo de fuente de datos no está habilitado. Usar métodos SpreadsheetApp#enable...Execution() para habilitar la ejecución de datos para una fuente de datos específica el tipo de letra.

// 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 la fuente de datos con la que se insertará.

Volver

Sheet: Es la hoja nueva.

Autorización

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

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

isColumnHiddenByUser(columnPosition)

Muestra si el usuario ocultó la columna especificada.

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 debe examinar.

Volver

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

Volver

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

Autorización

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

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

isRowHiddenByFilter(rowPosition)

Muestra si un filtro (no una vista de filtro) ocultó la fila especificada.

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 debe examinar.

Volver

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 el usuario ocultó la fila especificada.

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 debe examinar.

Volver

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. Arroja una excepción si el es negativa o mayor que el número de hojas.

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

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

spreadsheet.moveActiveSheet(2);

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

Parámetros

NombreTipoDescripción
posIntegerEs la posición de índice 1 a la que se moverá la hoja activa en la lista de hojas.

Autorización

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

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

moveChartToObjectSheet(chart)

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

Volver