Class Spreadsheet

Foglio di lavoro

Accedere ai file di Fogli Google e modificarli. Le operazioni più comuni sono l'aggiunta di nuovi fogli e l'aggiunta di collaboratori.

Metodi

MetodoTipo restituitoBreve descrizione
addDeveloperMetadata(key)SpreadsheetAggiunge i metadati dello sviluppatore con la chiave specificata al foglio di lavoro di primo livello.
addDeveloperMetadata(key, visibility)SpreadsheetAggiunge al foglio di lavoro i metadati dello sviluppatore con la chiave e la visibilità specificate.
addDeveloperMetadata(key, value)SpreadsheetAggiunge al foglio di lavoro i metadati dello sviluppatore con la chiave e il valore specificati.
addDeveloperMetadata(key, value, visibility)SpreadsheetAggiunge al foglio di lavoro i metadati dello sviluppatore con la chiave, il valore e la visibilità specificati.
addEditor(emailAddress)SpreadsheetAggiunge l'utente specificato all'elenco degli editor per Spreadsheet.
addEditor(user)SpreadsheetAggiunge l'utente specificato all'elenco degli editor per Spreadsheet.
addEditors(emailAddresses)SpreadsheetAggiunge l'array specificato di utenti all'elenco degli editor per Spreadsheet.
addMenu(name, subMenus)voidCrea un nuovo menu nell'interfaccia utente del foglio di lavoro.
addViewer(emailAddress)SpreadsheetAggiunge l'utente specificato all'elenco dei visualizzatori per Spreadsheet.
addViewer(user)SpreadsheetAggiunge l'utente specificato all'elenco dei visualizzatori per Spreadsheet.
addViewers(emailAddresses)SpreadsheetAggiunge l'array specificato di utenti all'elenco dei visualizzatori per Spreadsheet.
appendRow(rowContents)SheetAccoda una riga alla fine dell'area di dati corrente nel foglio.
autoResizeColumn(columnPosition)SheetConsente di impostare la larghezza della colonna specificata per adattarla ai suoi contenuti.
copy(name)SpreadsheetCopia il foglio di lavoro e restituisce quello nuovo.
createDeveloperMetadataFinder()DeveloperMetadataFinderRestituisce un valore DeveloperMetadataFinder per trovare i metadati dello sviluppatore nell'ambito di questo foglio di lavoro.
createTextFinder(findText)TextFinderCrea una ricerca di testo per il foglio di lavoro, che può essere utilizzata per trovare e sostituire testo all'interno del foglio di lavoro.
deleteActiveSheet()SheetElimina il foglio attualmente attivo.
deleteColumn(columnPosition)SheetElimina la colonna nella posizione specificata.
deleteColumns(columnPosition, howMany)voidElimina un numero di colonne a partire dalla posizione della colonna specificata.
deleteRow(rowPosition)SheetElimina la riga nella posizione specificata per la riga.
deleteRows(rowPosition, howMany)voidElimina un numero di righe a partire dalla posizione della riga specificata.
deleteSheet(sheet)voidElimina il foglio specificato.
duplicateActiveSheet()SheetDuplica il foglio attivo e lo imposta come foglio attivo.
getActiveCell()RangeRestituisce la cella attiva in questo foglio.
getActiveRange()RangeRestituisce l'intervallo selezionato nel foglio attivo oppure null se non è presente alcun intervallo attivo.
getActiveRangeList()RangeListRestituisce l'elenco di intervalli attivi nel foglio attivo o null se non sono presenti intervalli attivi.
getActiveSheet()SheetRestituisce il foglio attivo in un foglio di lavoro.
getAs(contentType)BlobRestituisce i dati all'interno di questo oggetto sotto forma di blob convertito nel tipo di contenuto specificato.
getBandings()Banding[]Restituisce tutte le bande in questo foglio di lavoro.
getBlob()BlobRestituisce i dati all'interno di questo oggetto sotto forma di blob.
getColumnWidth(columnPosition)IntegerRestituisce la larghezza in pixel della colonna specificata.
getCurrentCell()RangeRestituisce la cella corrente nel foglio attivo o null se non c'è alcuna cella corrente.
getDataRange()RangeRestituisce un valore Range corrispondente alle dimensioni in cui sono presenti i dati.
getDataSourceFormulas()DataSourceFormula[]Restituisce tutte le formule dell'origine dati.
getDataSourcePivotTables()DataSourcePivotTable[]Restituisce tutte le tabelle pivot dell'origine dati.
getDataSourceRefreshSchedules()DataSourceRefreshSchedule[]Visualizza le pianificazioni degli aggiornamenti di questo foglio di lavoro.
getDataSourceSheets()DataSourceSheet[]Restituisce tutti i fogli delle origini dati nel foglio di lavoro.
getDataSourceTables()DataSourceTable[]Restituisce tutte le tabelle dell'origine dati.
getDataSources()DataSource[]Restituisce tutte le origini dati nel foglio di lavoro.
getDeveloperMetadata()DeveloperMetadata[]Restituisce i metadati dello sviluppatore associati al foglio di lavoro di primo livello.
getEditors()User[]Consente di acquisire l'elenco degli editor di Spreadsheet.
getFormUrl()StringRestituisce l'URL del modulo che invia le risposte a questo foglio di lavoro oppure null se il foglio di lavoro non ha alcun modulo associato.
getFrozenColumns()IntegerRestituisce il numero di colonne bloccate.
getFrozenRows()IntegerRestituisce il numero di righe bloccate.
getId()StringRestituisce un identificatore univoco per il foglio di lavoro.
getImages()OverGridImage[]Restituisce tutte le immagini over-the-grid nel foglio.
getIterativeCalculationConvergenceThreshold()NumberRestituisce il valore di soglia utilizzato durante il calcolo iterativo.
getLastColumn()IntegerRestituisce la posizione dell'ultima colonna con contenuti.
getLastRow()IntegerRestituisce la posizione dell'ultima riga con contenuti.
getMaxIterativeCalculationCycles()IntegerRestituisce il numero massimo di iterazioni da utilizzare durante un calcolo iterativo.
getName()StringRestituisce il nome del documento.
getNamedRanges()NamedRange[]Recupera tutti gli intervalli denominati in questo foglio di lavoro.
getNumSheets()IntegerRestituisce il numero di fogli in questo foglio di lavoro.
getOwner()UserRestituisce il proprietario del documento o null per un documento di un Drive condiviso.
getPredefinedSpreadsheetThemes()SpreadsheetTheme[]Restituisce l'elenco di temi predefiniti.
getProtections(type)Protection[]Restituisce un array di oggetti che rappresentano tutti gli intervalli o fogli protetti nel foglio di lavoro.
getRange(a1Notation)RangeRestituisce l'intervallo come specificato nella notazione A1 o nella notazione R1C1.
getRangeByName(name)RangeRestituisce un intervallo denominato o null se non viene trovato alcun intervallo con il nome specificato.
getRangeList(a1Notations)RangeListRestituisce la raccolta RangeList che rappresenta gli intervalli nello stesso foglio specificati da un elenco non vuoto di notazioni A1 o R1C1.
getRecalculationInterval()RecalculationIntervalRestituisce l'intervallo di calcolo per questo foglio di lavoro.
getRowHeight(rowPosition)IntegerRestituisce l'altezza in pixel della riga specificata.
getSelection()SelectionRestituisce il valore Selection corrente nel foglio di lavoro.
getSheetByName(name)SheetRestituisce un foglio con il nome specificato.
getSheetId()IntegerRestituisce l'ID del foglio rappresentato da questo oggetto.
getSheetName()StringRestituisce il nome del foglio.
getSheetValues(startRow, startColumn, numRows, numColumns)Object[][]Restituisce la griglia rettangolare di valori per questo intervallo a partire dalle coordinate specificate.
getSheets()Sheet[]Recupera tutti i fogli del foglio di lavoro.
getSpreadsheetLocale()StringRecupera le impostazioni internazionali del foglio di lavoro.
getSpreadsheetTheme()SpreadsheetThemeRestituisce il tema corrente del foglio di lavoro o null se non è applicato alcun tema.
getSpreadsheetTimeZone()StringRestituisce il fuso orario del foglio di lavoro.
getUrl()StringRestituisce l'URL del foglio di lavoro specificato.
getViewers()User[]Visualizza l'elenco di spettatori e commentatori per Spreadsheet.
hideColumn(column)voidNasconde la colonna o le colonne nell'intervallo specificato.
hideRow(row)voidNasconde le righe nell'intervallo specificato.
insertColumnAfter(afterPosition)SheetInserisce una colonna dopo la posizione della colonna specificata.
insertColumnBefore(beforePosition)SheetInserisce una colonna prima della posizione della colonna specificata.
insertColumnsAfter(afterPosition, howMany)SheetInserisce un determinato numero di colonne dopo la posizione della colonna specificata.
insertColumnsBefore(beforePosition, howMany)SheetInserisce un numero di colonne prima della posizione della colonna specificata.
insertDataSourceSheet(spec)DataSourceSheetInserisce un nuovo DataSourceSheet nel foglio di lavoro e avvia l'esecuzione dei dati.
insertImage(blobSource, column, row)OverGridImageInserisce un elemento Spreadsheet come immagine nel documento in una determinata riga e colonna.
insertImage(blobSource, column, row, offsetX, offsetY)OverGridImageInserisce un valore Spreadsheet come immagine nel documento in una determinata riga e colonna, con un offset di pixel.
insertImage(url, column, row)OverGridImageInserisce un'immagine nel documento in una determinata riga e colonna.
insertImage(url, column, row, offsetX, offsetY)OverGridImageInserisce un'immagine nel documento in una determinata riga e colonna, con un offset di pixel.
insertRowAfter(afterPosition)SheetInserisce una riga dopo la posizione della riga specificata.
insertRowBefore(beforePosition)SheetInserisce una riga prima della posizione della riga specificata.
insertRowsAfter(afterPosition, howMany)SheetInserisce un numero di righe dopo la posizione della riga specificata.
insertRowsBefore(beforePosition, howMany)SheetInserisce un numero di righe prima della posizione della riga specificata.
insertSheet()SheetInserisce un nuovo foglio nel foglio di lavoro, utilizzando un nome predefinito per il foglio.
insertSheet(sheetIndex)SheetInserisce un nuovo foglio nel foglio di lavoro nell'indice specificato.
insertSheet(sheetIndex, options)SheetInserisce un nuovo foglio nel foglio di lavoro all'indice specificato e utilizza argomenti avanzati facoltativi.
insertSheet(options)SheetInserisce un nuovo foglio nel foglio di lavoro, utilizzando un nome predefinito e argomenti avanzati facoltativi.
insertSheet(sheetName)SheetInserisce un nuovo foglio con il nome specificato nel foglio di lavoro.
insertSheet(sheetName, sheetIndex)SheetInserisce un nuovo foglio nel foglio di lavoro con il nome specificato nell'indice specificato.
insertSheet(sheetName, sheetIndex, options)SheetInserisce un nuovo foglio nel foglio di lavoro con il nome specificato nell'indice specificato e utilizza argomenti avanzati facoltativi.
insertSheet(sheetName, options)SheetInserisce un nuovo foglio nel foglio di lavoro con il nome specificato e utilizza argomenti avanzati facoltativi.
insertSheetWithDataSourceTable(spec)SheetInserisce un nuovo foglio nel foglio di lavoro, crea un elemento DataSourceTable che copre l'intero foglio con la specifica dell'origine dati specificata e avvia l'esecuzione dei dati.
isColumnHiddenByUser(columnPosition)BooleanIndica se la colonna specificata è nascosta dall'utente.
isIterativeCalculationEnabled()BooleanIndica se il calcolo iterativo è attivato in questo foglio di lavoro.
isRowHiddenByFilter(rowPosition)BooleanRestituisce se la riga specificata è nascosta da un filtro (non da una visualizzazione filtrata).
isRowHiddenByUser(rowPosition)BooleanRestituisce se la riga specificata è nascosta dall'utente.
moveActiveSheet(pos)voidSposta il foglio attivo nella posizione specificata nell'elenco dei fogli.
moveChartToObjectSheet(chart)SheetCrea un nuovo foglio SheetType.OBJECT e sposta al suo interno il grafico fornito.
refreshAllDataSources()voidAggiorna tutte le origini dati supportate e i relativi oggetti delle origini dati collegati, saltando gli oggetti non validi.
removeEditor(emailAddress)SpreadsheetRimuove l'utente specificato dall'elenco degli editor per Spreadsheet.
removeEditor(user)SpreadsheetRimuove l'utente specificato dall'elenco degli editor per Spreadsheet.
removeMenu(name)voidRimuove un menu aggiunto da addMenu(name, subMenus).
removeNamedRange(name)voidElimina un intervallo denominato con il nome specificato.
removeViewer(emailAddress)SpreadsheetRimuove l'utente specificato dall'elenco dei visualizzatori e commentatori per Spreadsheet.
removeViewer(user)SpreadsheetRimuove l'utente specificato dall'elenco dei visualizzatori e commentatori per Spreadsheet.
rename(newName)voidRinomina il documento.
renameActiveSheet(newName)voidRinomina il foglio attivo corrente con il nuovo nome.
resetSpreadsheetTheme()SpreadsheetThemeRimuove il tema applicato e imposta il tema predefinito nel foglio di lavoro.
setActiveRange(range)RangeImposta l'intervallo specificato come active range nel foglio attivo, con la cella in alto a sinistra nell'intervallo come current cell.
setActiveRangeList(rangeList)RangeListImposta l'elenco specificato di intervalli come active ranges nel foglio attivo.
setActiveSelection(range)RangeImposta la regione di selezione attiva per questo foglio.
setActiveSelection(a1Notation)RangeImposta la selezione attiva, come specificato nella notazione A1 o R1C1.
setActiveSheet(sheet)SheetImposta il foglio specificato in modo che sia il foglio attivo nel foglio di lavoro.
setActiveSheet(sheet, restoreSelection)SheetImposta il foglio specificato come foglio attivo nel foglio di lavoro, con un'opzione per ripristinare la selezione più recente all'interno del foglio.
setColumnWidth(columnPosition, width)SheetImposta la larghezza della colonna specificata in pixel.
setCurrentCell(cell)RangeImposta la cella specificata come current cell.
setFrozenColumns(columns)voidBlocca il numero di colonne specificato.
setFrozenRows(rows)voidBlocca il numero specificato di righe.
setIterativeCalculationConvergenceThreshold(minThreshold)SpreadsheetImposta il valore della soglia minima per il calcolo iterativo.
setIterativeCalculationEnabled(isEnabled)SpreadsheetConsente di impostare se il calcolo iterativo è attivato in questo foglio di lavoro.
setMaxIterativeCalculationCycles(maxIterations)SpreadsheetImposta il numero massimo di iterazioni di calcolo che devono essere eseguite durante un calcolo iterativo.
setNamedRange(name, range)voidAssegna un nome a un intervallo.
setRecalculationInterval(recalculationInterval)SpreadsheetImposta la frequenza di ricalcolo di questo foglio di lavoro.
setRowHeight(rowPosition, height)SheetImposta l'altezza in pixel della riga specificata.
setSpreadsheetLocale(locale)voidImposta le impostazioni internazionali del foglio di lavoro.
setSpreadsheetTheme(theme)SpreadsheetThemeImposta un tema nel foglio di lavoro.
setSpreadsheetTimeZone(timezone)voidImposta il fuso orario per il foglio di lavoro.
show(userInterface)voidMostra un componente dell'interfaccia utente personalizzato in una finestra di dialogo centrata nell'area visibile del browser dell'utente.
sort(columnPosition)SheetOrdina un foglio per colonna, in ordine crescente.
sort(columnPosition, ascending)SheetOrdina un foglio per colonna.
toast(msg)voidMostra una finestra popup nell'angolo in basso a destra del foglio di lavoro con il messaggio specificato.
toast(msg, title)voidMostra una finestra popup nell'angolo in basso a destra del foglio di lavoro con il messaggio e il titolo specificati.
toast(msg, title, timeoutSeconds)voidMostra una finestra popup nell'angolo in basso a destra del foglio di lavoro con il titolo e il messaggio specificati, che rimane visibile per un determinato periodo di tempo.
unhideColumn(column)voidMostra la colonna nell'intervallo specificato.
unhideRow(row)voidMostra la riga nell'intervallo specificato.
updateMenu(name, subMenus)voidConsente di aggiornare un menu aggiunto da addMenu(name, subMenus).
waitForAllDataExecutionsCompletion(timeoutInSeconds)voidAttende il completamento di tutte le esecuzioni correnti nel foglio di lavoro, con timeout dopo il numero di secondi specificato.

Documentazione dettagliata

addDeveloperMetadata(key)

Aggiunge i metadati dello sviluppatore con la chiave specificata al foglio di lavoro di primo livello.

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

Parametri

NomeTipoDescrizione
keyStringLa chiave per i nuovi metadati dello sviluppatore.

Ritorni

Spreadsheet - Questo foglio di lavoro, per il concatenamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

addDeveloperMetadata(key, visibility)

Aggiunge al foglio di lavoro i metadati dello sviluppatore con la chiave e la visibilità specificate.

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

Parametri

NomeTipoDescrizione
keyStringLa chiave per i nuovi metadati dello sviluppatore.
visibilityDeveloperMetadataVisibilityLa visibilità dei nuovi metadati dello sviluppatore.

Ritorni

Spreadsheet - Questo foglio di lavoro, per il concatenamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

addDeveloperMetadata(key, value)

Aggiunge al foglio di lavoro i metadati dello sviluppatore con la chiave e il valore specificati.

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

Parametri

NomeTipoDescrizione
keyStringLa chiave per i nuovi metadati dello sviluppatore.
valueStringIl valore dei nuovi metadati dello sviluppatore.

Ritorni

Spreadsheet - Questo foglio di lavoro, per il concatenamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

addDeveloperMetadata(key, value, visibility)

Aggiunge al foglio di lavoro i metadati dello sviluppatore con la chiave, il valore e la visibilità specificati.

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

Parametri

NomeTipoDescrizione
keyStringLa chiave per i nuovi metadati dello sviluppatore.
valueStringIl valore dei nuovi metadati dello sviluppatore.
visibilityDeveloperMetadataVisibilityLa visibilità dei nuovi metadati dello sviluppatore.

Ritorni

Spreadsheet - Questo foglio di lavoro, per il concatenamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

addEditor(emailAddress)

Aggiunge l'utente specificato all'elenco degli editor per Spreadsheet. Se l'utente era già nell'elenco degli spettatori, scegli questo metodo per escluderlo.

Parametri

NomeTipoDescrizione
emailAddressStringL'indirizzo email dell'utente da aggiungere.

Ritorni

Spreadsheet - Questo Spreadsheet, per il concatenamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

addEditor(user)

Aggiunge l'utente specificato all'elenco degli editor per Spreadsheet. Se l'utente era già nell'elenco degli spettatori, scegli questo metodo per escluderlo.

Parametri

NomeTipoDescrizione
userUserUna rappresentazione dell'utente da aggiungere.

Ritorni

Spreadsheet - Questo Spreadsheet, per il concatenamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

addEditors(emailAddresses)

Aggiunge l'array specificato di utenti all'elenco degli editor per Spreadsheet. Se uno degli utenti era già presente nell'elenco degli spettatori, questo metodo lo promuove fuori dall'elenco degli spettatori.

Parametri

NomeTipoDescrizione
emailAddressesString[]Un array di indirizzi email degli utenti da aggiungere.

Ritorni

Spreadsheet - Questo Spreadsheet, per il concatenamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

addMenu(name, subMenus)

Crea un nuovo menu nell'interfaccia utente del foglio di lavoro.

Ogni voce di menu esegue una funzione definita dall'utente. Generalmente, è consigliabile richiamare la funzione dalla funzione onOpen(), in modo che il menu venga creato automaticamente al caricamento del foglio di lavoro.

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

Parametri

NomeTipoDescrizione
nameStringIl nome del menu da creare.
subMenusObject[]Un array di mappe JavaScript con i parametri name e functionName . Puoi utilizzare le funzioni delle librerie incluse, ad esempio Library.libFunction1.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

addViewer(emailAddress)

Aggiunge l'utente specificato all'elenco dei visualizzatori per Spreadsheet. Se l'utente era già nell'elenco degli editor, questo metodo non ha effetto.

Parametri

NomeTipoDescrizione
emailAddressStringL'indirizzo email dell'utente da aggiungere.

Ritorni

Spreadsheet - Questo Spreadsheet, per il concatenamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

addViewer(user)

Aggiunge l'utente specificato all'elenco dei visualizzatori per Spreadsheet. Se l'utente era già nell'elenco degli editor, questo metodo non ha effetto.

Parametri

NomeTipoDescrizione
userUserUna rappresentazione dell'utente da aggiungere.

Ritorni

Spreadsheet - Questo Spreadsheet, per il concatenamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

addViewers(emailAddresses)

Aggiunge l'array specificato di utenti all'elenco dei visualizzatori per Spreadsheet. Se qualcuno degli utenti era già presente nell'elenco degli editor, questo metodo non produce alcun effetto.

Parametri

NomeTipoDescrizione
emailAddressesString[]Un array di indirizzi email degli utenti da aggiungere.

Ritorni

Spreadsheet - Questo Spreadsheet, per il concatenamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

appendRow(rowContents)

Accoda una riga alla fine dell'area di dati corrente nel foglio. Se i contenuti di una cella iniziano con =, vengono interpretati come una formula.

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"]);

Parametri

NomeTipoDescrizione
rowContentsObject[]Un array di valori da inserire dopo l'ultima riga del foglio.

Ritorni

Sheet: il foglio, utile per il concatenamento dei metodi.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

autoResizeColumn(columnPosition)

Consente di impostare la larghezza della colonna specificata per adattarla ai suoi contenuti.

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

Parametri

NomeTipoDescrizione
columnPositionIntegerLa posizione della colonna da ridimensionare.

Ritorni

Sheet: il foglio, utile per il collegamento dei metodi

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

copy(name)

Copia il foglio di lavoro e restituisce quello nuovo.

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

Parametri

NomeTipoDescrizione
nameStringIl nome della copia.

Ritorni

Spreadsheet - Questo foglio di lavoro, per il concatenamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

createDeveloperMetadataFinder()

Restituisce un valore DeveloperMetadataFinder per trovare i metadati dello sviluppatore nell'ambito di questo foglio di lavoro. Per impostazione predefinita, vengono considerati tutti i metadati associati a foglio di lavoro, fogli, righe e colonne.

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

Ritorni

DeveloperMetadataFinder: uno sviluppatore che si occupa di ricerca dei metadati nell'ambito di questo foglio di lavoro.


createTextFinder(findText)

Crea una ricerca di testo per il foglio di lavoro, che può essere utilizzata per trovare e sostituire testo all'interno del foglio di lavoro. La ricerca inizia dal primo foglio del foglio di lavoro.

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

Parametri

NomeTipoDescrizione
findTextStringIl testo da cercare.

Ritorni

TextFinder: il valore TextFinder del foglio di lavoro.


deleteActiveSheet()

Elimina il foglio attualmente attivo.

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

Ritorni

Sheet: il nuovo foglio attivo.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

deleteColumn(columnPosition)

Elimina la colonna nella posizione specificata.

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

Parametri

NomeTipoDescrizione
columnPositionIntegerLa posizione della colonna, a partire da 1 per la prima colonna.

Ritorni

Sheet: il foglio, utile per il collegamento dei metodi

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

deleteColumns(columnPosition, howMany)

Elimina un numero di colonne a partire dalla posizione della colonna specificata.

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

Parametri

NomeTipoDescrizione
columnPositionIntegerLa posizione della prima colonna da eliminare.
howManyIntegerIl numero di colonne da eliminare.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

deleteRow(rowPosition)

Elimina la riga nella posizione specificata per la riga.

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

Parametri

NomeTipoDescrizione
rowPositionIntegerLa posizione della riga, a partire da 1 per la prima riga.

Ritorni

Sheet: il foglio, utile per il collegamento dei metodi

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

deleteRows(rowPosition, howMany)

Elimina un numero di righe a partire dalla posizione della riga specificata.

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

Parametri

NomeTipoDescrizione
rowPositionIntegerLa posizione della prima riga da eliminare.
howManyIntegerIl numero di righe da eliminare.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

deleteSheet(sheet)

Elimina il foglio specificato.

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

Parametri

NomeTipoDescrizione
sheetSheetIl foglio da eliminare.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

duplicateActiveSheet()

Duplica il foglio attivo e lo imposta come foglio attivo.

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

Ritorni

Sheet: il nuovo foglio.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getActiveCell()

Restituisce la cella attiva in questo foglio.

Nota: è preferibile utilizzare getCurrentCell(), che restituisce la cella evidenziata corrente.

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

Ritorni

Range: la cella attiva corrente

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getActiveRange()

Restituisce l'intervallo selezionato nel foglio attivo oppure null se non è presente alcun intervallo attivo. Se sono selezionati più intervalli, questo metodo restituisce solo l'ultimo intervallo selezionato.

Il termine "intervallo attivo" fa riferimento all'intervallo selezionato da un utente nel foglio attivo, ma in una funzione personalizzata fa riferimento alla cella che viene ricalcolata attivamente.

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

Ritorni

Range: l'intervallo attivo

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

Vedi anche


getActiveRangeList()

Restituisce l'elenco di intervalli attivi nel foglio attivo o null se non sono presenti intervalli attivi.

Se è stato selezionato un singolo intervallo, si comporta come una chiamata getActiveRange().

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

Ritorni

RangeList: l'elenco degli intervalli attivi

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

Vedi anche


getActiveSheet()

Restituisce il foglio attivo in un foglio di lavoro.

Il foglio attivo in un foglio di lavoro è quello visualizzato nell'interfaccia utente del foglio di lavoro.

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

Ritorni

Sheet: foglio attivo nel foglio di lavoro.


getAs(contentType)

Restituisce i dati all'interno di questo oggetto sotto forma di blob convertito nel tipo di contenuto specificato. Questo metodo aggiunge l'estensione appropriata al nome del file, ad esempio "myfile.pdf". Tuttavia, si presuppone che la parte del nome del file che segue l'ultimo punto (se presente) sia un'estensione esistente che deve essere sostituita. Di conseguenza, "ShoppingList.12.25.2014" diventa "ShoppingList.12.25.pdf".

Per visualizzare le quote giornaliere per le conversioni, consulta Quote per i servizi Google. I domini Google Workspace appena creati potrebbero essere temporaneamente soggetti a quote più severe.

Parametri

NomeTipoDescrizione
contentTypeStringIl tipo MIME in cui eseguire la conversione. Per la maggior parte dei blob, 'application/pdf' è l'unica opzione valida. Per le immagini in formato BMP, GIF, JPEG o PNG, è valido anche qualsiasi formato 'image/bmp', 'image/gif', 'image/jpeg' o 'image/png'.

Ritorni

Blob: i dati sotto forma di blob.


getBandings()

Restituisce tutte le bande in questo foglio di lavoro.

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

Ritorni

Banding[]: le bande in questo foglio di lavoro.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getBlob()

Restituisce i dati all'interno di questo oggetto sotto forma di blob.

Ritorni

Blob: i dati sotto forma di blob.


getColumnWidth(columnPosition)

Restituisce la larghezza in pixel della colonna specificata.

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

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

Parametri

NomeTipoDescrizione
columnPositionIntegerLa posizione della colonna da esaminare.

Ritorni

Integer: larghezza colonna in pixel

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getCurrentCell()

Restituisce la cella corrente nel foglio attivo o null se non c'è alcuna cella corrente. La cella corrente è quella evidenziata nell'interfaccia utente di Fogli Google ed è evidenziata da un bordo scuro. Non c'è mai più di una cella corrente. Quando un utente seleziona uno o più intervalli di celle, una delle celle della selezione è la cella corrente.

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

Ritorni

Range: la cella corrente

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getDataRange()

Restituisce un valore Range corrispondente alle dimensioni in cui sono presenti i dati.

Ciò equivale a creare un intervallo limitato da A1 e (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);
}

Ritorni

Range: un intervallo composto da tutti i dati nel foglio di lavoro

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getDataSourceFormulas()

Restituisce tutte le formule dell'origine dati.

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

Ritorni

DataSourceFormula[]: un elenco di formule dell'origine dati.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getDataSourcePivotTables()

Restituisce tutte le tabelle pivot dell'origine dati.

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

Ritorni

DataSourcePivotTable[]: un elenco di tabelle pivot dell'origine dati.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getDataSourceRefreshSchedules()

Visualizza le pianificazioni degli aggiornamenti di questo foglio di lavoro.

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

Ritorni

DataSourceRefreshSchedule[]: le pianificazioni degli aggiornamenti del foglio di lavoro.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getDataSourceSheets()

Restituisce tutti i fogli delle origini dati nel foglio di lavoro.

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

Ritorni

DataSourceSheet[]: un array di tutti i fogli di origini dati.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getDataSourceTables()

Restituisce tutte le tabelle dell'origine dati.

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

Ritorni

DataSourceTable[]: un elenco di tabelle di origini dati.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getDataSources()

Restituisce tutte le origini dati nel foglio di lavoro.

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

Ritorni

DataSource[]: un array di tutte le origini dati.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getDeveloperMetadata()

Restituisce i metadati dello sviluppatore associati al foglio di lavoro di primo livello.

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

Ritorni

DeveloperMetadata[]: i metadati dello sviluppatore associati a questo intervallo.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getEditors()

Consente di acquisire l'elenco degli editor di Spreadsheet.

Ritorni

User[]: un array di utenti con autorizzazione di modifica.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getFormUrl()

Restituisce l'URL del modulo che invia le risposte a questo foglio di lavoro oppure null se il foglio di lavoro non ha alcun modulo associato. Se più moduli inviano risposte al foglio di lavoro, l'URL del modulo restituito è indeterminato. In alternativa, le associazioni di URL del modulo per foglio possono essere recuperate tramite il metodo 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);

Ritorni

String: l'URL del modulo che inserisce le risposte nel foglio di lavoro oppure null se al foglio di lavoro non è associato un modulo.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getFrozenColumns()

Restituisce il numero di colonne bloccate.

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

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

Ritorni

Integer: il numero di colonne bloccate

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getFrozenRows()

Restituisce il numero di righe bloccate.

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

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

Ritorni

Integer: il numero di righe bloccate

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getId()

Restituisce un identificatore univoco per il foglio di lavoro. L'ID di un foglio di lavoro può essere estratto dal relativo URL. Ad esempio, l'ID del foglio di lavoro nell'URL https://docs.google.com/spreadsheets/d/abc1234567/edit#gid=0 è "abc1234567".

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

Ritorni

String: l'ID (o chiave) univoco del foglio di lavoro.


getImages()

Restituisce tutte le immagini over-the-grid nel foglio.

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

Ritorni

OverGridImage[]: un array di immagini over-the-grid.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getIterativeCalculationConvergenceThreshold()

Restituisce il valore di soglia utilizzato durante il calcolo iterativo. Quando i risultati dei calcoli successivi differiscono di meno di questo valore, il calcolo iterativo si interrompe.

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

Ritorni

Number: la soglia di convergenza.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getLastColumn()

Restituisce la posizione dell'ultima colonna con contenuti.

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

Ritorni

Integer: l'ultima colonna del foglio con contenuti

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getLastRow()

Restituisce la posizione dell'ultima riga con contenuti.

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

Ritorni

Integer: l'ultima riga del foglio con contenuti

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getMaxIterativeCalculationCycles()

Restituisce il numero massimo di iterazioni da utilizzare durante un calcolo 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());

Ritorni

Integer: il numero massimo di iterazioni del calcolo.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getName()

Restituisce il nome del documento.

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

Ritorni

String: nome del foglio di lavoro.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getNamedRanges()

Recupera tutti gli intervalli denominati in questo foglio di lavoro.

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

Ritorni

NamedRange[]: un array di tutti gli intervalli denominati nel foglio di lavoro.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getNumSheets()

Restituisce il numero di fogli in questo foglio di lavoro.

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

Ritorni

Integer: il numero di fogli nel foglio di lavoro.


getOwner()

Restituisce il proprietario del documento o null per un documento di un Drive condiviso.

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

Ritorni

User: proprietario del documento o null se il documento si trova in un Drive condiviso.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getPredefinedSpreadsheetThemes()

Restituisce l'elenco di temi predefiniti.

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

Ritorni

SpreadsheetTheme[]: elenco di temi predefiniti.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getProtections(type)

Restituisce un array di oggetti che rappresentano tutti gli intervalli o fogli protetti nel foglio di lavoro.

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

Parametri

NomeTipoDescrizione
typeProtectionTypeIl tipo di area protetta, SpreadsheetApp.ProtectionType.RANGE o SpreadsheetApp.ProtectionType.SHEET.

Ritorni

Protection[]: un array di oggetti che rappresenta tutti gli intervalli o fogli protetti nel foglio di lavoro.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getRange(a1Notation)

Restituisce l'intervallo come specificato nella notazione A1 o nella notazione 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");

Parametri

NomeTipoDescrizione
a1NotationStringL'intervallo da restituire, come specificato nella notazione A1 o nella notazione R1C1.

Ritorni

Range: l'intervallo nella località designata

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getRangeByName(name)

Restituisce un intervallo denominato o null se non viene trovato alcun intervallo con il nome specificato. Se più fogli del foglio di lavoro utilizzano lo stesso nome di intervallo, specifica il nome del foglio senza virgolette aggiuntive, ad esempio getRangeByName('TaxRates') o getRangeByName('Sheet Name!TaxRates'), ma non 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());
}

Parametri

NomeTipoDescrizione
nameStringIl nome dell'intervallo da ottenere.

Ritorni

Range: l'intervallo di celle con il nome specificato.


getRangeList(a1Notations)

Restituisce la raccolta RangeList che rappresenta gli intervalli nello stesso foglio specificati da un elenco non vuoto di notazioni 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']);

Parametri

NomeTipoDescrizione
a1NotationsString[]L'elenco di intervalli da restituire, come specificato nella notazione A1 o R1C1.

Ritorni

RangeList: l'elenco di intervalli nella località designata

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getRecalculationInterval()

Restituisce l'intervallo di calcolo per questo foglio di lavoro.

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

Ritorni

RecalculationInterval: intervallo di calcolo per questo foglio di lavoro.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getRowHeight(rowPosition)

Restituisce l'altezza in pixel della riga specificata.

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

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

Parametri

NomeTipoDescrizione
rowPositionIntegerLa posizione della riga da esaminare.

Ritorni

Integer: altezza riga in pixel

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getSelection()

Restituisce il valore Selection corrente nel foglio di lavoro.

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

Ritorni

Selection: la selezione corrente

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getSheetByName(name)

Restituisce un foglio con il nome specificato.

Se più fogli hanno lo stesso nome, viene restituito quello più a sinistra. Restituisce null se non è presente alcun foglio con il nome specificato.

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

Parametri

NomeTipoDescrizione
nameStringIl nome del foglio da recuperare.

Ritorni

Sheet: il foglio con il nome specificato.


getSheetId()

Restituisce l'ID del foglio rappresentato da questo oggetto.

Questo è un ID del foglio univoco per il foglio di lavoro. L'ID è un numero intero monotonico crescente assegnato al momento della creazione del foglio, indipendente dalla posizione del foglio. Ciò è utile in combinazione con metodi come Range.copyFormatToRange(gridId, column, columnEnd, row, rowEnd) che accettano un parametro gridId anziché un'istanza Sheet.

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

Logger.log(sheet.getSheetId());

Ritorni

Integer: un ID del foglio univoco per il foglio di lavoro

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getSheetName()

Restituisce il nome del foglio.

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

Logger.log(sheet.getSheetName());

Ritorni

String: il nome del foglio

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getSheetValues(startRow, startColumn, numRows, numColumns)

Restituisce la griglia rettangolare di valori per questo intervallo a partire dalle coordinate specificate. Un valore -1 specificato come posizione della riga o della colonna equivale a ottenere l'ultima riga o colonna contenente dati nel foglio.

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

Parametri

NomeTipoDescrizione
startRowIntegerLa posizione della riga iniziale.
startColumnIntegerLa posizione della colonna iniziale.
numRowsIntegerIl numero di righe per cui restituire i valori.
numColumnsIntegerIl numero di colonne per cui restituire i valori.

Ritorni

Object[][]: una matrice bidimensionale di valori

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getSheets()

Recupera tutti i fogli del foglio di lavoro.

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

Ritorni

Sheet[]: un array di tutti i fogli nel foglio di lavoro.


getSpreadsheetLocale()

Recupera le impostazioni internazionali del foglio di lavoro.

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

Ritorni

String: le impostazioni internazionali del foglio di lavoro.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getSpreadsheetTheme()

Restituisce il tema corrente del foglio di lavoro o null se non è applicato alcun tema.

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

Ritorni

SpreadsheetTheme: tema attualmente applicato.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getSpreadsheetTimeZone()

Restituisce il fuso orario del foglio di lavoro.

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

Ritorni

String: il fuso orario specificato in formato "lungo" (ad esempio "America/New_York", come indicato da Joda.org).

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getUrl()

Restituisce l'URL del foglio di lavoro specificato.

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

Ritorni

String: l'URL del foglio di lavoro fornito.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getViewers()

Visualizza l'elenco di spettatori e commentatori per Spreadsheet.

Ritorni

User[]: un array di utenti con autorizzazione di visualizzazione o commento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

hideColumn(column)

Nasconde la colonna o le colonne nell'intervallo specificato.

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

Parametri

NomeTipoDescrizione
columnRangeL'intervallo di colonne da nascondere.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

hideRow(row)

Nasconde le righe nell'intervallo specificato.

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

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

Parametri

NomeTipoDescrizione
rowRangeL'intervallo di righe da nascondere.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

insertColumnAfter(afterPosition)

Inserisce una colonna dopo la posizione della colonna specificata.

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

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

Parametri

NomeTipoDescrizione
afterPositionIntegerLa colonna dopo la quale aggiungere la nuova colonna.

Ritorni

Sheet: il foglio, utile per il collegamento dei metodi

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

insertColumnBefore(beforePosition)

Inserisce una colonna prima della posizione della colonna specificata.

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

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

Parametri

NomeTipoDescrizione
beforePositionIntegerLa colonna prima della quale aggiungere la nuova colonna.

Ritorni

Sheet: il foglio, utile per il collegamento dei metodi

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

insertColumnsAfter(afterPosition, howMany)

Inserisce un determinato numero di colonne dopo la posizione della colonna specificata.

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

Parametri

NomeTipoDescrizione
afterPositionIntegerLa colonna dopo la quale aggiungere la nuova colonna.
howManyIntegerIl numero di colonne da inserire.

Ritorni

Sheet: il foglio, utile per il collegamento dei metodi

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

insertColumnsBefore(beforePosition, howMany)

Inserisce un numero di colonne prima della posizione della colonna specificata.

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

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

Parametri

NomeTipoDescrizione
beforePositionIntegerLa colonna prima della quale aggiungere la nuova colonna.
howManyIntegerIl numero di colonne da inserire.

Ritorni

Sheet: il foglio, utile per il collegamento dei metodi

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

insertDataSourceSheet(spec)

Inserisce un nuovo DataSourceSheet nel foglio di lavoro e avvia l'esecuzione dei dati. Come effetto collaterale, anche il nuovo foglio diventa attivo.

Genera un'eccezione se il tipo di origine dati non è abilitato. Utilizza i metodi SpreadsheetApp#enable...Execution() per attivare l'esecuzione dei dati per un tipo di origine dati specifico.

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

Parametri

NomeTipoDescrizione
specDataSourceSpecLa specifica dell'origine dati con cui eseguire l'inserimento.

Ritorni

DataSourceSheet: il nuovo foglio dell'origine dati.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

insertImage(blobSource, column, row)

Inserisce un elemento Spreadsheet come immagine nel documento in una determinata riga e colonna. Le dimensioni dell'immagine vengono recuperate dai contenuti del blob. Le dimensioni massime supportate per il blob sono 2 MB.

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

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

Parametri

NomeTipoDescrizione
blobSourceBlobSourceIl blob contenente i contenuti dell'immagine, il tipo MIME e (facoltativamente) il nome.
columnIntegerLa posizione della colonna.
rowIntegerLa posizione della riga.

Ritorni

OverGridImage: l'immagine inserita.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

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

Inserisce un valore Spreadsheet come immagine nel documento in una determinata riga e colonna, con un offset di pixel. Le dimensioni dell'immagine vengono recuperate dai contenuti del blob. Le dimensioni massime supportate per il blob sono 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);

Parametri

NomeTipoDescrizione
blobSourceBlobSourceIl blob contenente i contenuti dell'immagine, il tipo MIME e (facoltativamente) il nome.
columnIntegerLa posizione della colonna.
rowIntegerLa posizione della riga.
offsetXIntegerLo scostamento orizzontale dall'angolo della cella in pixel.
offsetYIntegerL'offset verticale dall'angolo della cella in pixel.

Ritorni

OverGridImage: l'immagine inserita.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

insertImage(url, column, row)

Inserisce un'immagine nel documento in una determinata riga e colonna.

L'URL fornito deve essere accessibile pubblicamente.

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

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

Parametri

NomeTipoDescrizione
urlStringL'URL dell'immagine.
columnIntegerLa posizione della colonna della griglia.
rowIntegerLa posizione della riga della griglia.

Ritorni

OverGridImage: l'immagine inserita.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

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

Inserisce un'immagine nel documento in una determinata riga e colonna, con un offset di pixel.

L'URL fornito deve essere accessibile pubblicamente.

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

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

Parametri

NomeTipoDescrizione
urlStringL'URL dell'immagine.
columnIntegerLa posizione della colonna.
rowIntegerLa posizione della riga.
offsetXIntegerLo scostamento orizzontale dall'angolo della cella in pixel.
offsetYIntegerL'offset verticale dall'angolo della cella in pixel.

Ritorni

OverGridImage: l'immagine inserita.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

insertRowAfter(afterPosition)

Inserisce una riga dopo la posizione della riga specificata.

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

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

Parametri

NomeTipoDescrizione
afterPositionIntegerLa riga dopo la quale aggiungere la nuova riga.

Ritorni

Sheet: il foglio, utile per il collegamento dei metodi

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

insertRowBefore(beforePosition)

Inserisce una riga prima della posizione della riga specificata.

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

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

Parametri

NomeTipoDescrizione
beforePositionIntegerLa riga prima della quale aggiungere la nuova riga.

Ritorni

Sheet: il foglio, utile per il collegamento dei metodi

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

insertRowsAfter(afterPosition, howMany)

Inserisce un numero di righe dopo la posizione della riga specificata.

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

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

Parametri

NomeTipoDescrizione
afterPositionIntegerLa riga dopo la quale aggiungere le nuove righe.
howManyIntegerIl numero di righe da inserire.

Ritorni

Sheet: il foglio, utile per il collegamento dei metodi

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

insertRowsBefore(beforePosition, howMany)

Inserisce un numero di righe prima della posizione della riga specificata.

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

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

Parametri

NomeTipoDescrizione
beforePositionIntegerLa riga prima della quale aggiungere le nuove righe.
howManyIntegerIl numero di righe da inserire.

Ritorni

Sheet: il foglio, utile per il collegamento dei metodi

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

insertSheet()

Inserisce un nuovo foglio nel foglio di lavoro, utilizzando un nome predefinito per il foglio. Il nuovo foglio diventa il foglio attivo.

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

Ritorni

Sheet: il nuovo foglio.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

insertSheet(sheetIndex)

Inserisce un nuovo foglio nel foglio di lavoro nell'indice specificato. Il nuovo foglio diventa il foglio attivo.

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

Parametri

NomeTipoDescrizione
sheetIndexIntegerL'indice del foglio appena creato. Per inserire un foglio come primo nel foglio di lavoro, imposta il valore su 0.

Ritorni

Sheet: il nuovo foglio.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

insertSheet(sheetIndex, options)

Inserisce un nuovo foglio nel foglio di lavoro all'indice specificato e utilizza argomenti avanzati facoltativi. Il nuovo foglio diventa il foglio attivo.

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

Parametri

NomeTipoDescrizione
sheetIndexIntegerL'indice del foglio appena creato. Per inserire un foglio come primo nel foglio di lavoro, imposta il valore su 0.
optionsObjectArgomenti avanzati JavaScript facoltativi.

Parametri avanzati

NomeTipoDescrizione
templateSheetTutti i dati dell'oggetto del foglio del modello vengono copiati nel nuovo foglio. Il modello di foglio deve essere uno dei fogli dell'oggetto Foglio di lavoro.

Ritorni

Sheet: il nuovo foglio.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

insertSheet(options)

Inserisce un nuovo foglio nel foglio di lavoro, utilizzando un nome predefinito e argomenti avanzati facoltativi. Il nuovo foglio diventa il foglio attivo.

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

Parametri

NomeTipoDescrizione
optionsObjectArgomenti avanzati JavaScript facoltativi, elencati di seguito.

Parametri avanzati

NomeTipoDescrizione
templateSheetTutti i dati dell'oggetto del foglio del modello vengono copiati nel nuovo foglio. Il modello di foglio deve essere uno dei fogli di questo oggetto Foglio di lavoro.

Ritorni

Sheet: il nuovo foglio.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

insertSheet(sheetName)

Inserisce un nuovo foglio con il nome specificato nel foglio di lavoro. Il nuovo foglio diventa il foglio attivo.

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

Parametri

NomeTipoDescrizione
sheetNameStringIl nome del nuovo foglio.

Ritorni

Sheet: il nuovo foglio.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

insertSheet(sheetName, sheetIndex)

Inserisce un nuovo foglio nel foglio di lavoro con il nome specificato nell'indice specificato. Il nuovo foglio diventa il foglio attivo.

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

Parametri

NomeTipoDescrizione
sheetNameStringIl nome del nuovo foglio.
sheetIndexIntegerL'indice del foglio appena creato. Per inserire un foglio come primo nel foglio di lavoro, imposta il valore su 0.

Ritorni

Sheet: il nuovo foglio.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

insertSheet(sheetName, sheetIndex, options)

Inserisce un nuovo foglio nel foglio di lavoro con il nome specificato nell'indice specificato e utilizza argomenti avanzati facoltativi. Il nuovo foglio diventa il foglio attivo.

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

Parametri

NomeTipoDescrizione
sheetNameStringIl nome del nuovo foglio.
sheetIndexIntegerL'indice del foglio appena inserito. Per inserire un foglio come primo in un foglio di lavoro, imposta il valore su 0.
optionsObjectArgomenti avanzati JavaScript facoltativi.

Parametri avanzati

NomeTipoDescrizione
templateSheetTutti i dati dell'oggetto del foglio del modello vengono copiati nel nuovo foglio. Il modello di foglio deve essere uno dei fogli dell'oggetto Foglio di lavoro.

Ritorni

Sheet: il nuovo foglio.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

insertSheet(sheetName, options)

Inserisce un nuovo foglio nel foglio di lavoro con il nome specificato e utilizza argomenti avanzati facoltativi. Il nuovo foglio diventa il foglio attivo.

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

Parametri

NomeTipoDescrizione
sheetNameStringIl nome del nuovo foglio.
optionsObjectArgomenti avanzati JavaScript facoltativi.

Parametri avanzati

NomeTipoDescrizione
templateSheetTutti i dati dell'oggetto del foglio del modello vengono copiati nel nuovo foglio. Il modello di foglio deve essere uno dei fogli dell'oggetto Foglio di lavoro.

Ritorni

Sheet: il nuovo foglio.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

insertSheetWithDataSourceTable(spec)

Inserisce un nuovo foglio nel foglio di lavoro, crea un elemento DataSourceTable che copre l'intero foglio con la specifica dell'origine dati specificata e avvia l'esecuzione dei dati. Come effetto collaterale, imposta il nuovo foglio come foglio attivo.

Genera un'eccezione se il tipo di origine dati non è abilitato. Utilizza i metodi SpreadsheetApp#enable...Execution() per attivare l'esecuzione dei dati per un tipo di origine dati specifico.

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

Parametri

NomeTipoDescrizione
specDataSourceSpecLa specifica dell'origine dati con cui eseguire l'inserimento.

Ritorni

Sheet: il nuovo foglio.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

isColumnHiddenByUser(columnPosition)

Indica se la colonna specificata è nascosta dall'utente.

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

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

Parametri

NomeTipoDescrizione
columnPositionIntegerLa posizione della colonna da esaminare.

Ritorni

Boolean: true se la colonna è nascosta, false in caso contrario.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

isIterativeCalculationEnabled()

Indica se il calcolo iterativo è attivato in questo foglio di lavoro.

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

Ritorni

Boolean: true se il calcolo iterativo è attivato, false in caso contrario.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

isRowHiddenByFilter(rowPosition)

Restituisce se la riga specificata è nascosta da un filtro (non da una visualizzazione filtrata).

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

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

Parametri

NomeTipoDescrizione
rowPositionIntegerLa posizione della riga da esaminare.

Ritorni

Boolean: true se la riga è nascosta, false in caso contrario.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

isRowHiddenByUser(rowPosition)

Restituisce se la riga specificata è nascosta dall'utente.

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

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

Parametri

NomeTipoDescrizione
rowPositionIntegerLa posizione della riga da esaminare.

Ritorni

Boolean: true se la riga è nascosta, false in caso contrario.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

moveActiveSheet(pos)

Sposta il foglio attivo nella posizione specificata nell'elenco dei fogli. Genera un'eccezione se la posizione è negativa o maggiore del numero di fogli.

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

Parametri

NomeTipoDescrizione
posIntegerLa posizione di indice 1 in cui spostare il foglio attivo nell'elenco dei fogli.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

moveChartToObjectSheet(chart)

Crea un nuovo foglio SheetType.OBJECT e sposta al suo interno il grafico fornito. Se il grafico si trova già sul proprio foglio, viene restituito questo foglio senza crearne uno nuovo.

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

Parametri

NomeTipoDescrizione
chartEmbeddedChartIl grafico da spostare.

Ritorni

Sheet: il foglio in cui si trova il grafico.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

refreshAllDataSources()

Aggiorna tutte le origini dati supportate e i relativi oggetti delle origini dati collegati, saltando gli oggetti non validi.

Utilizza i metodi SpreadsheetApp#enable...Execution() per attivare l'esecuzione dei dati per un tipo di origine dati specifico.

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

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

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

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

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

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

removeEditor(emailAddress)

Rimuove l'utente specificato dall'elenco degli editor per Spreadsheet. Questo metodo non impedisce agli utenti di accedere a Spreadsheet se appartengono a una classe di utenti con accesso generale, ad esempio se Spreadsheet è condiviso con l'intero dominio dell'utente o se Spreadsheet si trova su un Drive condiviso a cui l'utente può accedere.

Per i file di Drive, l'utente viene rimosso anche dall'elenco dei visualizzatori.

Parametri

NomeTipoDescrizione
emailAddressStringL'indirizzo email dell'utente da rimuovere.

Ritorni

Spreadsheet - Questo Spreadsheet, per il concatenamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

removeEditor(user)

Rimuove l'utente specificato dall'elenco degli editor per Spreadsheet. Questo metodo non impedisce agli utenti di accedere a Spreadsheet se appartengono a una classe di utenti con accesso generale, ad esempio se Spreadsheet è condiviso con l'intero dominio dell'utente o se Spreadsheet si trova su un Drive condiviso a cui l'utente può accedere.

Per i file di Drive, l'utente viene rimosso anche dall'elenco dei visualizzatori.

Parametri

NomeTipoDescrizione
userUserUna rappresentazione dell'utente da rimuovere.

Ritorni

Spreadsheet - Questo Spreadsheet, per il concatenamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

removeMenu(name)

Rimuove un menu aggiunto da addMenu(name, subMenus). L'argomento name deve avere lo stesso valore della chiamata corrispondente a addMenu(name, subMenus).

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

Parametri

NomeTipoDescrizione
nameStringIl nome del menu da rimuovere.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

removeNamedRange(name)

Elimina un intervallo denominato con il nome specificato. Genera un'eccezione se nel foglio di lavoro non viene trovato alcun intervallo con il nome specificato.

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

Parametri

NomeTipoDescrizione
nameStringIl nome dell'intervallo.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

removeViewer(emailAddress)

Rimuove l'utente specificato dall'elenco dei visualizzatori e commentatori per Spreadsheet. Questo metodo non ha effetto se l'utente è un editor, non un visualizzatore o un commentatore. Questo metodo non impedisce inoltre agli utenti di accedere a Spreadsheet se appartengono a una classe di utenti con accesso generale, ad esempio se Spreadsheet è condiviso con l'intero dominio dell'utente o se Spreadsheet si trova in un Drive condiviso a cui l'utente può accedere.

Per i file di Drive, l'utente viene rimosso anche dall'elenco degli editor.

Parametri

NomeTipoDescrizione
emailAddressStringL'indirizzo email dell'utente da rimuovere.

Ritorni

Spreadsheet - Questo Spreadsheet per il concatenamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

removeViewer(user)

Rimuove l'utente specificato dall'elenco dei visualizzatori e commentatori per Spreadsheet. Questo metodo non ha effetto se l'utente è un editor, non un visualizzatore. Questo metodo non impedisce inoltre agli utenti di accedere a Spreadsheet se appartengono a una classe di utenti con accesso generale, ad esempio se Spreadsheet è condiviso con l'intero dominio dell'utente o se Spreadsheet si trova su un Drive condiviso a cui l'utente può accedere.

Per i file di Drive, l'utente viene rimosso anche dall'elenco degli editor.

Parametri

NomeTipoDescrizione
userUserUna rappresentazione dell'utente da rimuovere.

Ritorni

Spreadsheet - Questo Spreadsheet per il concatenamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

rename(newName)

Rinomina il documento.

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

Parametri

NomeTipoDescrizione
newNameStringIl nuovo nome del documento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

renameActiveSheet(newName)

Rinomina il foglio attivo corrente con il nuovo nome.

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

Parametri

NomeTipoDescrizione
newNameStringIl nuovo nome del foglio attivo corrente.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

resetSpreadsheetTheme()

Rimuove il tema applicato e imposta il tema predefinito nel foglio di lavoro.

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

Ritorni

SpreadsheetTheme: tema predefinito.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

setActiveRange(range)

Imposta l'intervallo specificato come active range nel foglio attivo, con la cella in alto a sinistra nell'intervallo come current cell.

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

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

Parametri

NomeTipoDescrizione
rangeRangeL'intervallo da impostare come intervallo attivo.

Ritorni

Range: l'intervallo appena attivo

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

setActiveRangeList(rangeList)

Imposta l'elenco specificato di intervalli come active ranges nel foglio attivo. L'ultimo intervallo nell'elenco è impostato come active range.

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

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

Parametri

NomeTipoDescrizione
rangeListRangeListL'elenco di intervalli da selezionare.

Ritorni

RangeList: l'elenco di intervalli appena selezionato

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

setActiveSelection(range)

Imposta la regione di selezione attiva per questo foglio.

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

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

Parametri

NomeTipoDescrizione
rangeRangeL'intervallo da impostare come selezione attiva.

Ritorni

Range: l'intervallo appena attivo

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

setActiveSelection(a1Notation)

Imposta la selezione attiva, come specificato nella notazione A1 o R1C1.

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

sheet.setActiveSelection("A1:D4");

Parametri

NomeTipoDescrizione
a1NotationStringL'intervallo da impostare come attivo, come specificato nella notazione A1 o nella notazione R1C1.

Ritorni

Range: l'intervallo appena attivo

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

setActiveSheet(sheet)

Imposta il foglio specificato in modo che sia il foglio attivo nel foglio di lavoro. La UI di Fogli Google mostra il foglio scelto, a meno che il foglio non appartenga a un altro foglio di lavoro.

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

Parametri

NomeTipoDescrizione
sheetSheetIl foglio da impostare come foglio attivo.

Ritorni

Sheet: il foglio attivo.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

setActiveSheet(sheet, restoreSelection)

Imposta il foglio specificato come foglio attivo nel foglio di lavoro, con un'opzione per ripristinare la selezione più recente all'interno del foglio. L'interfaccia utente di Fogli Google mostra il foglio scelto, a meno che il foglio non appartenga a un altro foglio di lavoro.

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

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

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

Parametri

NomeTipoDescrizione
sheetSheetIl nuovo foglio attivo.
restoreSelectionBooleanTf true, la selezione più recente del nuovo foglio attivo viene selezionata di nuovo quando il nuovo foglio diventa attivo; se false, il nuovo foglio diventa attivo senza modificare la selezione corrente.

Ritorni

Sheet: il nuovo foglio attivo.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

setColumnWidth(columnPosition, width)

Imposta la larghezza della colonna specificata in pixel.

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

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

Parametri

NomeTipoDescrizione
columnPositionIntegerLa posizione della colonna da impostare.
widthIntegerLa larghezza in pixel da impostare.

Ritorni

Sheet: il foglio, utile per il collegamento dei metodi

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

setCurrentCell(cell)

Imposta la cella specificata come current cell.

Se la cella specificata è presente in un intervallo già selezionato, questo intervallo diventa l'intervallo attivo con la cella come cella corrente.

Se la cella specificata non è presente in nessun intervallo selezionato, qualsiasi selezione esistente viene rimossa e la cella diventa la cella corrente e l'intervallo attivo.

Nota: il valore Range specificato deve essere composto da una cella, altrimenti genera un'eccezione.

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

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

Parametri

NomeTipoDescrizione
cellRangeLa cella da impostare come cella corrente.

Ritorni

Range: la cella corrente appena impostata

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

setFrozenColumns(columns)

Blocca il numero di colonne specificato. Se il valore è zero, nessuna colonna è bloccata.

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

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

Parametri

NomeTipoDescrizione
columnsIntegerIl numero di colonne da bloccare.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

setFrozenRows(rows)

Blocca il numero specificato di righe. Se il valore è zero, nessuna riga è bloccata.

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

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

Parametri

NomeTipoDescrizione
rowsIntegerIl numero di righe da bloccare.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

setIterativeCalculationConvergenceThreshold(minThreshold)

Imposta il valore della soglia minima per il calcolo iterativo. Quando i risultati dei calcoli successivi differiscono di meno di questo valore, il calcolo iterativo si interrompe. Questo valore non deve essere negativo e il valore predefinito è 0, 05.

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

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

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

Parametri

NomeTipoDescrizione
minThresholdNumberLa soglia minima di convergenza (deve essere un numero non negativo).

Ritorni

Spreadsheet - Questo foglio di lavoro, per il concatenamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

setIterativeCalculationEnabled(isEnabled)

Consente di impostare se il calcolo iterativo è attivato in questo foglio di lavoro. Se il numero massimo di cicli di calcolo e la soglia di convergenza non sono stati precedentemente impostati al momento dell'attivazione del calcolo, il valore predefinito è rispettivamente 50 e 0,05. Se una delle due è stata impostata in precedenza, conservano i valori precedenti.

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

Parametri

NomeTipoDescrizione
isEnabledBooleantrue se il calcolo iterativo deve essere abilitato; false in caso contrario.

Ritorni

Spreadsheet - Questo foglio di lavoro, per il concatenamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

setMaxIterativeCalculationCycles(maxIterations)

Imposta il numero massimo di iterazioni di calcolo che devono essere eseguite durante un calcolo iterativo. Questo valore deve essere compreso tra 1 e 10.000 (inclusi) e il valore predefinito è 50.

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

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

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

Parametri

NomeTipoDescrizione
maxIterationsIntegerIl numero massimo di iterazioni di calcolo (compreso tra 1 e 10.000).

Ritorni

Spreadsheet - Questo foglio di lavoro, per il concatenamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

setNamedRange(name, range)

Assegna un nome a un intervallo.

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

Parametri

NomeTipoDescrizione
nameStringIl nome da assegnare all'intervallo.
rangeRangeLa specifica dell'intervallo.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

setRecalculationInterval(recalculationInterval)

Imposta la frequenza di ricalcolo di questo foglio di lavoro.

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

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

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

Parametri

NomeTipoDescrizione
recalculationIntervalRecalculationIntervalIl nuovo intervallo di ricalcolo.

Ritorni

Spreadsheet - Questo foglio di lavoro, per il concatenamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

setRowHeight(rowPosition, height)

Imposta l'altezza in pixel della riga specificata. Per impostazione predefinita, le righe si espandono per adattarsi al contenuto della cella. Se vuoi forzare le righe a un'altezza specificata, utilizza Sheet.setRowHeightsForced(startRow, numRows, height).

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

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

Parametri

NomeTipoDescrizione
rowPositionIntegerLa posizione della riga da modificare.
heightIntegerL'altezza in pixel da impostare.

Ritorni

Sheet: il foglio, utile per il concatenamento dei metodi.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

setSpreadsheetLocale(locale)

Imposta le impostazioni internazionali del foglio di lavoro.

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

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

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

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

Parametri

NomeTipoDescrizione
localeStringIl codice delle impostazioni internazionali da utilizzare (ad esempio, "en", "fr" o "en_US").

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

setSpreadsheetTheme(theme)

Imposta un tema nel foglio di lavoro.

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

Parametri

NomeTipoDescrizione
themeSpreadsheetThemeIl tema da applicare.

Ritorni

SpreadsheetTheme: il nuovo tema corrente.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

setSpreadsheetTimeZone(timezone)

Imposta il fuso orario per il foglio di lavoro.

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

Parametri

NomeTipoDescrizione
timezoneStringIl fuso orario specificato in formato "long" (ad esempio "America/New_York", come indicato da Joda.org).

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

show(userInterface)

Mostra un componente dell'interfaccia utente personalizzato in una finestra di dialogo centrata nell'area visibile del browser dell'utente. L'esecuzione dello script lato server non è sospesa. Per comunicare con il lato server, il componente dell'interfaccia utente deve eseguire callback asincroni allo script lato server.

Se in precedenza lo script lato server mostrava una finestra di dialogo che non è stata ancora ignorata, la finestra di dialogo esistente viene sostituita con l'interfaccia utente della finestra di dialogo appena richiesta.

Lo snippet di codice riportato di seguito mostra una semplice applicazione HtmlService in una finestra di dialogo con il titolo, l'altezza e la larghezza specificati:

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

SpreadsheetApp.getActiveSpreadsheet().show(htmlApp);

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

Parametri

NomeTipoDescrizione
userInterfaceObjectUn HtmlOutput.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

sort(columnPosition)

Ordina un foglio per colonna, in ordine crescente.

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

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

Parametri

NomeTipoDescrizione
columnPositionIntegerLa colonna in base alla quale ordinare.

Ritorni

Sheet: il foglio, utile per il collegamento dei metodi

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

sort(columnPosition, ascending)

Ordina un foglio per colonna. Utilizza un parametro per specificare in ordine crescente o decrescente.

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

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

Parametri

NomeTipoDescrizione
columnPositionIntegerLa colonna in base alla quale ordinare.
ascendingBooleantrue per l'ordinamento crescente, false per l'ordinamento decrescente.

Ritorni

Sheet: il foglio, utile per il collegamento dei metodi

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

toast(msg)

Mostra una finestra popup nell'angolo in basso a destra del foglio di lavoro con il messaggio specificato.

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

Parametri

NomeTipoDescrizione
msgStringIl messaggio da mostrare nel toast.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

toast(msg, title)

Mostra una finestra popup nell'angolo in basso a destra del foglio di lavoro con il messaggio e il titolo specificati.

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

Parametri

NomeTipoDescrizione
msgStringIl messaggio da mostrare nel toast.
titleStringIl titolo facoltativo del toast.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

toast(msg, title, timeoutSeconds)

Mostra una finestra popup nell'angolo in basso a destra del foglio di lavoro con il titolo e il messaggio specificati, che rimane visibile per un determinato periodo di tempo.

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

Parametri

NomeTipoDescrizione
msgStringIl messaggio da mostrare nel toast.
titleStringIl titolo facoltativo del toast.
timeoutSecondsNumberIl timeout in secondi; se null, il toast è di 5 secondi per impostazione predefinita; se negativo, il toast rimane fino a quando non viene ignorato.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

unhideColumn(column)

Mostra la colonna nell'intervallo specificato.

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

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

Parametri

NomeTipoDescrizione
columnRangeL'intervallo da mostrare, se nascosto.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

unhideRow(row)

Mostra la riga nell'intervallo specificato.

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

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

Parametri

NomeTipoDescrizione
rowRangeL'intervallo da mostrare, se nascosto.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

updateMenu(name, subMenus)

Consente di aggiornare un menu aggiunto da addMenu(name, subMenus). Funziona esattamente come addMenu(name, subMenus).

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

Parametri

NomeTipoDescrizione
nameStringIl nome del menu da aggiornare.
subMenusObject[]Un array di mappe JavaScript con i parametri name e functionName . Puoi utilizzare le funzioni delle librerie incluse, ad esempio Library.libFunction1.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

waitForAllDataExecutionsCompletion(timeoutInSeconds)

Attende il completamento di tutte le esecuzioni correnti nel foglio di lavoro, con timeout dopo il numero di secondi specificato. Genera un'eccezione se le esecuzioni non vengono completate al timeout, ma non le annulla.

Parametri

NomeTipoDescrizione
timeoutInSecondsIntegerIl tempo di attesa per le esecuzioni dei dati, in secondi. Il massimo è 300 secondi.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

Metodi deprecati