Class SpreadsheetApp

SpreadsheetApp

Accedere ai file di Fogli Google e crearli. Questa è la classe principale del servizio fogli di lavoro.

Proprietà

ProprietàTipoDescrizione
AutoFillSeriesAutoFillSeriesUn'enumerazione dei tipi di serie utilizzati per calcolare i valori compilati automaticamente.
BandingThemeBandingThemeUn elenco dei possibili temi a bande.
BooleanCriteriaBooleanCriteriaUn'enumerazione dei criteri booleani di formattazione condizionale.
BorderStyleBorderStyleUn'enumerazione degli stili validi per l'impostazione dei bordi su un elemento Range.
ColorTypeColorTypeUn'enumerazione dei possibili tipi di colore.
CopyPasteTypeCopyPasteTypeUn'enumerazione dei possibili tipi di incolla.
DataExecutionErrorCodeDataExecutionErrorCodeUn'enumerazione dei possibili codici di errore di esecuzione dei dati.
DataExecutionStateDataExecutionStateUn'enumerazione dei possibili stati di esecuzione dei dati.
DataSourceParameterTypeDataSourceParameterTypeUn'enumerazione dei possibili tipi di parametri dell'origine dati.
DataSourceRefreshScopeDataSourceRefreshScopeUn'enumerazione dei possibili ambiti di aggiornamento dell'origine dati.
DataSourceTypeDataSourceTypeUn'enumerazione dei possibili tipi di origini dati.
DataValidationCriteriaDataValidationCriteriaUn'enumerazione che rappresenta i criteri di convalida dei dati che possono essere impostati in un intervallo.
DateTimeGroupingRuleTypeDateTimeGroupingRuleTypeUn'enumerazione di una regola di raggruppamento di data e ora.
DeveloperMetadataLocationTypeDeveloperMetadataLocationTypeUn'enumerazione dei possibili tipi di posizione dei metadati degli sviluppatori.
DeveloperMetadataVisibilityDeveloperMetadataVisibilityUn'enumerazione delle possibili visibilità dei metadati dello sviluppatore.
DimensionDimensionUn'enumerazione delle possibili dimensioni di un foglio di lavoro.
DirectionDirectionUn'enumerazione delle possibili direzioni che è possibile spostare all'interno di un foglio di lavoro utilizzando la freccia chiave.
FrequencyTypeFrequencyTypeUn'enumerazione dei possibili tipi di frequenza.
GroupControlTogglePositionGroupControlTogglePositionUn'enumerazione delle posizioni in cui può trovarsi il pulsante di attivazione/disattivazione del controllo gruppo.
InterpolationTypeInterpolationTypeUn'enumerazione dei tipi di interpolazione del gradiente del formato condizionale.
PivotTableSummarizeFunctionPivotTableSummarizeFunctionUn'enumerazione delle funzioni che possono essere utilizzate per riepilogare i valori in una tabella pivot.
PivotValueDisplayTypePivotValueDisplayTypeUn'enumerazione dei modi in cui un valore pivot può essere visualizzato.
ProtectionTypeProtectionTypeUn'enumerazione che rappresenta le parti di un foglio di lavoro che possono essere protette dalle modifiche.
RecalculationIntervalRecalculationIntervalUn'enumerazione degli intervalli possibili che possono essere utilizzati nel ricalcolo del foglio di lavoro.
RelativeDateRelativeDateUn'enumerazione delle opzioni di date relative per il calcolo di un valore da utilizzare nell'elemento BooleanCriteria basato su date.
SheetTypeSheetTypeUn'enumerazione dei diversi tipi di fogli che possono esistere in un foglio di lavoro.
SortOrderSortOrderUn'enumerazione di ordinamento.
TextDirectionTextDirectionUn'enumerazione di direzioni di testo valide.
TextToColumnsDelimiterTextToColumnsDelimiterUn'enumerazione dei delimitatori preimpostati per suddividere il testo in colonne.
ThemeColorTypeThemeColorTypeUn'enumerazione dei possibili tipi di colore del tema.
ValueTypeValueTypeUn'enumerazione dei tipi di valori restituiti da Range.getValue() e Range.getValues() dalla classe Range del servizio Fogli di lavoro. I valori di enumerazione elencati di seguito si aggiungono a Number, Boolean, Date o String.
WrapStrategyWrapStrategyUn'enumerazione delle strategie utilizzate per l'aggregazione delle celle.

Metodi

MetodoTipo restituitoBreve descrizione
create(name)SpreadsheetCrea un nuovo foglio di lavoro con il nome specificato.
create(name, rows, columns)SpreadsheetCrea un nuovo foglio di lavoro con il nome specificato e il numero specificato di righe e colonne.
enableAllDataSourcesExecution()voidAttiva l'esecuzione dei dati per tutti i tipi di origini dati.
enableBigQueryExecution()voidAttiva l'esecuzione dei dati per le origini dati BigQuery.
enableLookerExecution()voidAttiva l'esecuzione dei dati per le origini dati di Looker.
flush()voidApplica tutte le modifiche in attesa al foglio di lavoro.
getActive()SpreadsheetRestituisce il foglio di lavoro attualmente attivo o null se non è presente.
getActiveRange()RangeRestituisce l'intervallo selezionato nel foglio attivo o null se non è presente alcun intervallo attivo.
getActiveRangeList()RangeListRestituisce l'elenco di intervalli attivi nel foglio attivo o null se non sono presenti intervalli selezionato.
getActiveSheet()SheetRecupera il foglio attivo in un foglio di lavoro.
getActiveSpreadsheet()SpreadsheetRestituisce il foglio di lavoro attualmente attivo o null se non è presente.
getCurrentCell()RangeRestituisce la cella corrente (evidenziata) selezionata in uno degli intervalli attivi nel foglio attivo o null se non esiste una cella corrente.
getSelection()SelectionRestituisce il valore Selection corrente nel foglio di lavoro.
getUi()UiRestituisce un'istanza dell'ambiente di interfaccia utente del foglio di lavoro che consente allo script di Aggiungere funzionalità come menu, finestre di dialogo e barre laterali.
newCellImage()CellImageBuilderCrea un builder per un CellImage.
newColor()ColorBuilderCrea un builder per un Color.
newConditionalFormatRule()ConditionalFormatRuleBuilderCrea un generatore per una regola di formattazione condizionale.
newDataSourceSpec()DataSourceSpecBuilderCrea un builder per un DataSourceSpec.
newDataValidation()DataValidationBuilderCrea un builder per una regola di convalida dei dati.
newFilterCriteria()FilterCriteriaBuilderCrea un builder per un FilterCriteria.
newRichTextValue()RichTextValueBuilderCrea un generatore per un valore RTF.
newTextStyle()TextStyleBuilderCrea un generatore per uno stile di testo.
open(file)SpreadsheetApre il foglio di lavoro corrispondente all'oggetto File specificato.
openById(id)SpreadsheetApre il foglio di lavoro con l'ID specificato.
openByUrl(url)SpreadsheetApre il foglio di lavoro con l'URL specificato.
setActiveRange(range)RangeImposta l'intervallo specificato come active range, con il valore superiore cella di sinistra nell'intervallo come current cell.
setActiveRangeList(rangeList)RangeListImposta l'elenco di intervalli specificato come active ranges.
setActiveSheet(sheet)SheetImposta il foglio attivo in un foglio di lavoro.
setActiveSheet(sheet, restoreSelection)SheetImposta il foglio attivo in un foglio di lavoro, con l'opzione per ripristinare la selezione più recente nel foglio.
setActiveSpreadsheet(newActiveSpreadsheet)voidImposta il foglio di lavoro attivo.
setCurrentCell(cell)RangeImposta la cella specificata come current cell.

Documentazione dettagliata

create(name)

Crea un nuovo foglio di lavoro con il nome specificato.

// The code below creates a new spreadsheet "Finances" and logs the URL for it
var ssNew = SpreadsheetApp.create("Finances");
Logger.log(ssNew.getUrl());

Parametri

NomeTipoDescrizione
nameStringIl nome del foglio di lavoro.

Invio

Spreadsheet: un nuovo 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

create(name, rows, columns)

Crea un nuovo foglio di lavoro con il nome specificato e il numero specificato di righe e colonne.

// The code below creates a new spreadsheet "Finances" with 50 rows and 5 columns and logs the
// URL for it
var ssNew = SpreadsheetApp.create("Finances", 50, 5);
Logger.log(ssNew.getUrl());

Parametri

NomeTipoDescrizione
nameStringNome del foglio di lavoro.
rowsIntegerIl numero di righe per il foglio di lavoro.
columnsIntegerIl numero di colonne del foglio di lavoro.

Invio

Spreadsheet: un nuovo 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

enableAllDataSourcesExecution()

Attiva l'esecuzione dei dati per tutti i tipi di origini dati.

L'esecuzione dei dati genera un'eccezione se il tipo di origine dati non è attivo. Utilizza questo metodo attivare l'esecuzione dei dati per tutti i tipi di origini dati.

// Turns data execution on for all types of data sources.
SpreadsheetApp.enableAllDataSourcesExecution();

// 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 the first data source sheet in the spreadsheet and refreshes the data.
ss.getDataSourceSheets()[0].refreshData();

Autorizzazione

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

  • https://www.googleapis.com/auth/bigquery.readonly

enableBigQueryExecution()

Attiva l'esecuzione dei dati per le origini dati BigQuery.

L'esecuzione dei dati per l'origine dati BigQuery genera un'eccezione, se non è attiva.

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

// 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 the first data source sheet in the spreadsheet and refreshes the BigQuery data.
ss.getDataSourceSheets()[0].refreshData();

Autorizzazione

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

  • https://www.googleapis.com/auth/bigquery.readonly

enableLookerExecution()

Attiva l'esecuzione dei dati per le origini dati di Looker.

L'esecuzione dei dati per l'origine dati di Looker genera un'eccezione, se non è attiva.

// Turns data execution on for Looker data sources.
SpreadsheetApp.enableLookerExecution();

// 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 the first data source sheet in the spreadsheet and refreshes the associated Looker
// data.
ss.getDataSourceSheets()[0].refreshData();

flush()

Applica tutte le modifiche in attesa al foglio di lavoro.

Le operazioni sui fogli di lavoro a volte vengono raggruppate per migliorare le prestazioni, ad esempio quando eseguendo più chiamate a Range.getValue(). Tuttavia, a volte potresti voler assicurarti che tutti le modifiche in attesa vengono apportate immediatamente, ad esempio per mostrare i dati agli utenti mentre è in esecuzione uno script.

// The code below changes the background color of cells A1 and B1 twenty times. You should be
// able to see the updates live in the spreadsheet. If flush() is not called, the updates may
// be applied live or may all be applied at once when the script completes.
function colors() {
  var sheet = SpreadsheetApp.getActiveSheet();
  for (var i = 0; i < 20; i++) {
    if ((i % 2) == 0) {
      sheet.getRange('A1').setBackground('green');
      sheet.getRange('B1').setBackground('red');
    } else {
      sheet.getRange('A1').setBackground('red');
      sheet.getRange('B1').setBackground('green');
    }
    SpreadsheetApp.flush();
  }
}

getActive()

Restituisce il foglio di lavoro attualmente attivo o null se non è presente.

Le funzioni eseguite nel contesto di un foglio di lavoro possono ottenere un riferimento dell'oggetto Foglio di lavoro corrispondente richiamando questa funzione.

// The code below logs the URL for the active spreadsheet.
Logger.log(SpreadsheetApp.getActive().getUrl());

Invio

Spreadsheet: l'oggetto Foglio di lavoro 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

getActiveRange()

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

Questo in genere indica l'intervallo selezionato da un utente nel foglio attivo, ma in un funzione si riferisce alla cella che viene ricalcolata attivamente.

// The code below logs the background color for the active range.
var colorObject = SpreadsheetApp.getActiveRange().getBackgroundObject();
// Assume the color has ColorType.RGB.
Logger.log(colorObject.asRgbColor().asHexString());

Invio

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

getActiveRangeList()

Restituisce l'elenco di intervalli attivi nel foglio attivo o null se non sono presenti intervalli selezionato. L'intervallo attivo contenente la cella evidenziata corrente viene posizionato per ultimo nell'elenco.

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

// Returns the list of active ranges.
var rangeList = SpreadsheetApp.getActiveRangeList();

Invio

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

getActiveSheet()

Recupera il foglio attivo in un foglio di lavoro.

Il foglio attivo di un foglio di lavoro è il foglio visualizzato nel foglio di lavoro nell'interfaccia utente.

// The code below logs the name of the active sheet.
Logger.log(SpreadsheetApp.getActiveSheet().getName());

Invio

Sheet: l'oggetto Fogli 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

getActiveSpreadsheet()

Restituisce il foglio di lavoro attualmente attivo o null se non è presente.

Le funzioni eseguite nel contesto di un foglio di lavoro possono ottenere un riferimento dell'oggetto Spreadsheet corrispondente chiamando questa funzione.

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

Invio

Spreadsheet: l'oggetto Foglio di lavoro 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

getCurrentCell()

Restituisce la cella corrente (evidenziata) selezionata in uno degli intervalli attivi nella foglio attivo o null se non è presente una cella corrente.

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

Invio

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

getSelection()

Restituisce il valore Selection corrente nel foglio di lavoro.

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

Invio

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

getUi()

Restituisce un'istanza dell'ambiente di interfaccia utente del foglio di lavoro che consente allo script di Aggiungere funzionalità come menu, finestre di dialogo e barre laterali. Uno script può interagire con l'interfaccia utente solo attuale di un foglio di lavoro aperto e solo se lo script è associato al foglio di lavoro. Per ulteriori informazioni, vedi le guide ai menu, alle finestre di dialogo e alle barre laterali.

// Add a custom menu to the active spreadsheet, including a separator and a sub-menu.
function onOpen(e) {
  SpreadsheetApp.getUi()
      .createMenu('My Menu')
      .addItem('My menu item', 'myFunction')
      .addSeparator()
      .addSubMenu(SpreadsheetApp.getUi().createMenu('My sub-menu')
          .addItem('One sub-menu item', 'mySecondFunction')
          .addItem('Another sub-menu item', 'myThirdFunction'))
      .addToUi();
}

Invio

Ui: un'istanza dell'ambiente di interfaccia utente di questo foglio di lavoro


newCellImage()

Crea un builder per un CellImage.

// 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets cell A1 on Sheet1.
const range = sheet.getRange('A1');

// Builds an image using a source URL.
const cellImage = SpreadsheetApp.newCellImage()
  .setSourceUrl('https://www.gstatic.com/images/branding/productlogos/apps_script/v10/web-64dp/logo_apps_script_color_1x_web_64dp.png')
  .build();

// Sets the image in cell A1.
range.setValue(cellImage);

Invio

CellImageBuilder: il nuovo builder.


newColor()

Crea un builder per un Color.

var rgbColor = SpreadsheetApp.newColor().setRgbColor("#FF0000").build();

Invio

ColorBuilder: il nuovo builder.


newConditionalFormatRule()

Crea un generatore per una regola di formattazione condizionale.

// Adds a conditional format rule to a sheet that causes all cells in range A1:B3 to turn red
// if they contain a number between 1 and 10.
var sheet = SpreadsheetApp.getActive().getActiveSheet();
var range = sheet.getRange('A1:B3');
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenNumberBetween(1, 10)
    .setBackground("#FF0000")
    .setRanges([range])
    .build()
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Invio

ConditionalFormatRuleBuilder: il nuovo builder.


newDataSourceSpec()

Crea un builder per un DataSourceSpec.

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

// Enables BigQuery.
SpreadsheetApp.enableBigQueryExecution();

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

Invio

DataSourceSpecBuilder: il nuovo builder.


newDataValidation()

Crea un builder per una regola di convalida dei dati.

var cell = SpreadsheetApp.getActive().getRange('A1');
var rule = SpreadsheetApp.newDataValidation()
    .requireNumberBetween(1, 100)
    .setAllowInvalid(false)
    .setHelpText('Number must be between 1 and 100.')
    .build();
cell.setDataValidation(rule);

Invio

DataValidationBuilder: il nuovo builder.


newFilterCriteria()

Crea un builder per un FilterCriteria.

// 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Sets the range to A1:D20.
const range = sheet.getRange('A1:D20');

// Creates a filter and applies it to the specified range.
range.createFilter();

// Gets the current filter for the range and creates filter criteria that only shows cells
// that aren't empty.
const filter = range.getFilter();
const criteria = SpreadsheetApp.newFilterCriteria().whenCellNotEmpty().build();

// Sets the criteria to  column C.
filter.setColumnFilterCriteria(3, criteria);

Invio

FilterCriteriaBuilder: il nuovo builder


newRichTextValue()

Crea un generatore per un valore RTF.

// Sets cell A1 to have the text "Hello world", with "Hello" bolded.
var cell = SpreadsheetApp.getActive().getRange('A1');
var bold = SpreadsheetApp.newTextStyle().setBold(true).build();
var value = SpreadsheetApp.newRichTextValue()
    .setText("Hello world")
    .setTextStyle(0, 5, bold)
    .build();
cell.setRichTextValue(value);

Invio

RichTextValueBuilder: il nuovo builder.


newTextStyle()

Crea un generatore per uno stile di testo.

// Sets range A1:B3 to have red, size 22, bolded, underlined text.
var range = SpreadsheetApp.getActive().getRange('A1:B3');
var style = SpreadsheetApp.newTextStyle()
    .setForegroundColor("red")
    .setFontSize(22)
    .setBold(true)
    .setUnderline(true)
    .build();
range.setTextStyle(style);

Invio

TextStyleBuilder: il nuovo builder.


open(file)

Apre il foglio di lavoro corrispondente all'oggetto File specificato.

// Get any starred spreadsheets from Google Drive, then open the spreadsheets and log the name
// of the first sheet within each spreadsheet.
var files = DriveApp.searchFiles(
    'starred = true and mimeType = "' + MimeType.GOOGLE_SHEETS + '"');
while (files.hasNext()) {
  var spreadsheet = SpreadsheetApp.open(files.next());
  var sheet = spreadsheet.getSheets()[0];
  Logger.log(sheet.getName());
}

Parametri

NomeTipoDescrizione
fileFileIl file da aprire.

Invio

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

openById(id)

Apre il foglio di lavoro con l'ID specificato. Un ID foglio di lavoro può essere estratto dal relativo URL. Per ad esempio, l'ID foglio di lavoro nell'URL https://docs.google.com/spreadsheets/d/abc1234567/edit#gid=0 è "abc1234567".

// The code below opens a spreadsheet using its ID and logs the name for it.
// Note that the spreadsheet is NOT physically opened on the client side.
// It is opened on the server only (for modification by the script).
var ss = SpreadsheetApp.openById("abc1234567");
Logger.log(ss.getName());

Parametri

NomeTipoDescrizione
idStringL'identificatore univoco del foglio di lavoro.

Invio

Spreadsheet: l'oggetto foglio di lavoro con l'ID specificato

Autorizzazione

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

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

openByUrl(url)

Apre il foglio di lavoro con l'URL specificato. Genera un'eccezione di scripting se l'URL non esiste o se l'utente non è autorizzato ad accedervi.

// Opens a spreadsheet by its URL and logs its name.
// Note that the spreadsheet doesn't physically open on the client side.
// It opens on the server only (for modification by the script).
var ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc1234567/edit');
console.log(ss.getName());

Parametri

NomeTipoDescrizione
urlStringL'URL del foglio di lavoro.

Invio

Spreadsheet: l'oggetto del foglio di lavoro con l'URL specificato.

Autorizzazione

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

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

setActiveRange(range)

Imposta l'intervallo specificato come active range, con il valore superiore cella di sinistra nell'intervallo come current cell.

L'interfaccia utente del foglio di lavoro mostra il foglio che contiene l'intervallo scelto e seleziona le celle definite nell'intervallo scelto.

// The code below sets range C1:D4 in the first sheet as the active range.
var range = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0].getRange('C1:D4');
SpreadsheetApp.setActiveRange(range);

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

Parametri

NomeTipoDescrizione
rangeRangeL'intervallo da impostare come intervallo attivo.

Invio

Range: il nuovo intervallo attivo


setActiveRangeList(rangeList)

Imposta l'elenco di intervalli specificato come active ranges. L'ultima intervallo nell'elenco è impostato come active range.

// The code below sets ranges [D4, B2:C4] in the active sheet as the active ranges.
var rangeList = SpreadsheetApp.getActiveSheet().getRanges(['D4', 'B2:C4']);
SpreadsheetApp.setActiveRangeList(rangeList);

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

Invio

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

setActiveSheet(sheet)

Imposta il foglio attivo in un foglio di lavoro. Nella UI di Fogli Google viene visualizzato il foglio scelto, a meno che il foglio appartiene a un altro foglio di lavoro.

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

Parametri

NomeTipoDescrizione
sheetSheetIl nuovo foglio attivo.

Invio

Sheet: il foglio su cui è stato impostato il nuovo foglio attivo


setActiveSheet(sheet, restoreSelection)

Imposta il foglio attivo in un foglio di lavoro, con l'opzione per ripristinare la selezione più recente nel foglio. L'interfaccia utente di Fogli Google mostra il foglio scelto, a meno che non appartenga a un in un foglio di lavoro diverso.

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.
restoreSelectionBooleanSe true, la selezione più recente del nuovo foglio attivo viene selezionato di nuovo quando il nuovo foglio diventa attivo. se false, il nuovo foglio diventa attivo senza modificare la selezione corrente.

Invio

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

setActiveSpreadsheet(newActiveSpreadsheet)

Imposta il foglio di lavoro attivo.

// The code below makes the spreadsheet with key "1234567890" the active spreadsheet
var ss = SpreadsheetApp.openById("1234567890");
SpreadsheetApp.setActiveSpreadsheet(ss);

Parametri

NomeTipoDescrizione
newActiveSpreadsheetSpreadsheetIl foglio di lavoro da rendere attivo.

setCurrentCell(cell)

Imposta la cella specificata come current cell.

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

Se la cella specificata non è presente in alcun intervallo selezionato, la selezione esistente è rimosso e la cella diventa la cella corrente e l'intervallo attivo.

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

// The code below sets the cell B5 in the first sheet as the current cell.
var cell = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0].getRange('B5');
SpreadsheetApp.setCurrentCell(cell);

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

Parametri

NomeTipoDescrizione
cellRangeLa cella da impostare come cella corrente.

Invio

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