Funzioni personalizzate in Fogli Google

Fogli Google offre centinaia di funzioni integrate come AVERAGE, SUM e VLOOKUP. Quando questi elementi non sono sufficienti per le tue esigenze, puoi utilizzare Google Apps Script per scrivere funzioni personalizzate, ad esempio per convertire metri in miglia o recuperare contenuti in tempo reale da Internet, quindi puoi utilizzarle in Fogli Google proprio come una funzione integrata.

Per iniziare

Le funzioni personalizzate vengono create usando JavaScript standard. Se è la prima volta che utilizzi JavaScript, Codecademy offre un ottimo corso per principianti. Nota: questo corso non è stato sviluppato da e non è associato a Google.

Ecco una semplice funzione personalizzata denominata DOUBLE, che moltiplica un valore di input per 2:

/**
 * Multiplies an input value by 2.
 * @param {number} input The number to double.
 * @return The input multiplied by 2.
 * @customfunction
*/
function DOUBLE(input) {
  return input * 2;
}

Se non sai scrivere JavaScript e non hai tempo per imparare, controlla l'archivio dei componenti aggiuntivi per vedere se qualcun altro ha già creato la funzione personalizzata di cui hai bisogno.

crea una funzione personalizzata

Per scrivere una funzione personalizzata:

  1. Crea o apri un foglio di lavoro in Fogli Google.
  2. Seleziona la voce di menu Estensioni > Apps Script.
  3. Elimina eventuale codice nell'editor di script. Per la funzione DOUBLE riportata sopra, basta copiare e incollare il codice nell'editor di script.
  4. In alto, fai clic su Salva .

Ora puoi utilizzare la funzione personalizzata.

Ottieni una funzione personalizzata dall' Google Workspace Marketplace

L' Google Workspace Marketplace offre diverse funzioni personalizzate come componenti aggiuntivi per Fogli Google. Per utilizzare o esplorare questi componenti aggiuntivi:

  1. Crea o apri un foglio di lavoro in Fogli Google.
  2. In alto, fai clic su Componenti aggiuntivi > Installa componenti aggiuntivi.
  3. Quando si apre Google Workspace Marketplace, fai clic sulla casella di ricerca nell'angolo in alto a destra.
  4. Digita "funzione personalizzata" e premi Invio.
  5. Se trovi un componente aggiuntivo di funzioni personalizzate che ti interessa, fai clic su Installa per installarlo.
  6. Una finestra di dialogo potrebbe indicare che il componente aggiuntivo richiede l'autorizzazione. In tal caso, leggi attentamente l'avviso e fai clic su Consenti.
  7. Il componente aggiuntivo diventa disponibile nel foglio di lavoro. Per utilizzare il componente aggiuntivo in un altro foglio di lavoro, apri l'altro e, in alto, fai clic su Componenti aggiuntivi > Gestisci componenti aggiuntivi. Trova il componente aggiuntivo che vuoi utilizzare e fai clic su Opzioni > Utilizza in questo documento.

Utilizzo di una funzione personalizzata

Dopo aver scritto una funzione personalizzata o installata una funzione daGoogle Workspace Marketplace, è facile da utilizzare come una funzione integrata:

  1. Fai clic sulla cella in cui vuoi utilizzare la funzione.
  2. Digita un segno di uguale (=) seguito dal nome della funzione e da qualsiasi valore di input, ad esempio =DOUBLE(A1), e premi Invio.
  3. La cella mostrerà temporaneamente Loading..., poi restituirà il risultato.

Linee guida per le funzioni personalizzate

Prima di scrivere una funzione personalizzata, è necessario conoscere alcune linee guida.

Denominazione

Oltre alle convenzioni standard per la denominazione delle funzioni JavaScript, tieni presente quanto segue:

  • Il nome di una funzione personalizzata deve essere diverso dai nomi delle funzioni integrate come SUM().
  • Il nome di una funzione personalizzata non può terminare con un trattino basso (_), che indica una funzione privata in Apps Script.
  • Il nome di una funzione personalizzata deve essere dichiarato con la sintassi function myFunction(), non con var myFunction = new Function().
  • L'uso delle lettere maiuscole non è importante, anche se i nomi delle funzioni del foglio di lavoro sono tradizionalmente in lettere maiuscole.

Argomenti

Analogamente a una funzione integrata, una funzione personalizzata può assumere argomenti come valori di input:

  • Se chiami la tua funzione con un riferimento a una singola cella come argomento (come =DOUBLE(A1)), l'argomento sarà il valore della cella.

  • Se chiami la funzione con un riferimento a un intervallo di celle come argomento (come =DOUBLE(A1:B10)), l'argomento sarà un array bidimensionale dei valori delle celle. Ad esempio, nello screenshot seguente, gli argomenti in =DOUBLE(A1:B2) sono interpretati da Apps Script come double([[1,3],[2,4]]). Tieni presente che il codice campione per DOUBLE di cui sopra dovrà essere modificato per accettare un array come input.


  • Gli argomenti delle funzioni personalizzate devono essere deterministici. In altre parole, le funzioni integrate dei fogli di lavoro che restituiscono un risultato diverso ogni volta che vengono calcolate, ad esempio NOW() o RAND(), non sono consentite come argomenti per una funzione personalizzata. Se una funzione personalizzata tenta di restituire un valore in base a una di queste funzioni volatili integrate, visualizzerà Loading... a tempo indeterminato.

Valori restituiti

Ogni funzione personalizzata deve restituire un valore da visualizzare, in questo modo:

  • Se una funzione personalizzata restituisce un valore, questo viene visualizzato nella cella da cui è stata chiamata la funzione.
  • Se una funzione personalizzata restituisce un array bidimensionale di valori, i valori vengono spostati nelle celle adiacenti, purché queste siano vuote. Se in questo modo l'array a sovrascrivere i contenuti esistenti delle celle, la funzione personalizzata genererà invece un errore. Per un esempio, consulta la sezione sull'ottimizzazione delle funzioni personalizzate.
  • Una funzione personalizzata non può influire su celle diverse da quelle in cui restituisce un valore. In altre parole, una funzione personalizzata non può modificare celle arbitrarie, ma solo le celle da cui viene richiamata e le celle adiacenti. Per modificare celle arbitrarie, utilizza un menu personalizzato per eseguire una funzione.
  • Una chiamata di funzione personalizzata deve essere restituita entro 30 secondi. In caso contrario, la cella mostrerà un errore: Internal error executing the custom function.

Tipi di dati

Fogli Google archivia i dati in diversi formati a seconda della natura dei dati. Quando questi valori vengono utilizzati in funzioni personalizzate, Apps Script li considera il tipo di dati appropriato in JavaScript. Ecco le aree di confusione più comuni:

  • Le ore e le date in Fogli diventano oggetti Date in Apps Script. Se il foglio di lavoro e lo script utilizzano fusi orari diversi (un problema raro), la funzione personalizzata dovrà compensare.
  • Anche i valori di durata in Fogli diventano Date oggetti, ma l'utilizzo può essere complicato.
  • I valori percentuali in Fogli diventano numeri decimali in Apps Script. Ad esempio, una cella con il valore 10% diventa 0.1 in Apps Script.

Completamento automatico

Fogli Google supporta il completamento automatico per le funzioni personalizzate, in modo molto simile alle funzioni integrate. Mentre digiti il nome di una funzione in una cella, viene visualizzato un elenco di funzioni integrate e personalizzate corrispondenti al testo inserito.

Le funzioni personalizzate verranno visualizzate in questo elenco se il relativo script include un tag JsDoc @customfunction, come nell'esempio DOUBLE() riportato di seguito.

/**
 * Multiplies the input value by 2.
 *
 * @param {number} input The value to multiply.
 * @return The input multiplied by 2.
 * @customfunction
 */
function DOUBLE(input) {
  return input * 2;
}

Avanzata

Utilizzo dei servizi Google Apps Script

Le funzioni personalizzate possono chiamare determinati servizi Google Apps Script per eseguire attività più complesse. Ad esempio, una funzione personalizzata può chiamare il servizio Lingua per tradurre una frase dall'inglese in spagnolo.

A differenza della maggior parte degli altri tipi di script di Apps Script, le funzioni personalizzate non chiedono mai agli utenti di autorizzare l'accesso ai dati personali. Di conseguenza, possono chiamare solo i servizi che non hanno accesso a dati personali, in particolare i seguenti:

Servizi supportati Note
Cache Funziona, ma non particolarmente utile nelle funzioni personalizzate
HTML Può generare codice HTML, ma non può visualizzarlo (raramente utile)
JDBC
Lingua
Blocca Funziona, ma non particolarmente utile nelle funzioni personalizzate
Maps Può calcolare le indicazioni stradali, ma non visualizzare le mappe
Proprietà getUserProperties() ottiene solo le proprietà del proprietario del foglio di lavoro. Gli editor dei fogli di lavoro non possono impostare le proprietà utente in una funzione personalizzata.
Foglio di lavoro Sola lettura (è possibile utilizzare la maggior parte dei metodi get*(), ma non set*()).
Impossibile aprire altri fogli di lavoro (SpreadsheetApp.openById() o SpreadsheetApp.openByUrl()).
Recupero URL
Utilità
XML

Se la funzione personalizzata genera il messaggio di errore You do not have permission to call X service., il servizio richiede l'autorizzazione dell'utente e pertanto non può essere utilizzato in una funzione personalizzata.

Per utilizzare un servizio diverso da quelli elencati in precedenza, crea un menu personalizzato che esegua una funzione Apps Script anziché scrivere una funzione personalizzata. Una funzione che viene attivata da un menu chiederà all'utente l'autorizzazione, se necessario, e può quindi utilizzare tutti i servizi di Apps Script.

Condivisione

Le funzioni personalizzate iniziano associate al foglio di lavoro in cui sono state create. Ciò significa che una funzione personalizzata scritta in un foglio di lavoro non può essere utilizzata in altri fogli di lavoro a meno che non utilizzi uno dei seguenti metodi:

  • Fai clic su Estensioni > Apps Script per aprire l'editor di script, poi copia il testo dello script dal foglio di lavoro originale e incollalo nell'editor di script di un altro foglio di lavoro.
  • Crea una copia del foglio di lavoro che contiene la funzione personalizzata facendo clic su File > Crea una copia. Quando un foglio di lavoro viene copiato, vengono copiati anche tutti gli script allegati. Chiunque abbia accesso al foglio di lavoro può copiare lo script. (I collaboratori che hanno solo accesso in visualizzazione non possono aprire l'editor di script nel foglio di lavoro originale. Tuttavia, quando creano una copia, ne diventano il proprietario e possono visualizzare lo script.
  • Pubblica lo script come componente aggiuntivo dell'editor di Fogli Google.

Ottimizzazione

Ogni volta che una funzione personalizzata viene utilizzata in un foglio di lavoro, Fogli Google effettua una chiamata separata al server di Apps Script. Se il foglio di lavoro contiene decine (o centinaia o migliaia) di chiamate di funzioni personalizzate, il processo può essere piuttosto lento.

Di conseguenza, se prevedi di utilizzare una funzione personalizzata più volte su un ampio intervallo di dati, valuta la possibilità di modificare la funzione in modo che accetti un intervallo come input sotto forma di array bidimensionale, quindi restituisce un array bidimensionale che può overflow nelle celle appropriate.

Ad esempio, la funzione DOUBLE() mostrata sopra può essere riscritta per accettare una singola cella o intervallo di celle nel seguente modo:

/**
 * Multiplies the input value by 2.
 *
 * @param {number|Array<Array<number>>} input The value or range of cells
 *     to multiply.
 * @return The input multiplied by 2.
 * @customfunction
 */
function DOUBLE(input) {
  return Array.isArray(input) ?
      input.map(row => row.map(cell => cell * 2)) :
      input * 2;
}

L'approccio descritto sopra utilizza il metodo map dell'oggetto Array di JavaScript per chiamare in modo ricorsivo DOUBLE su ogni valore nell'array bidimensionale di celle. Restituisce un array bidimensionale che contiene i risultati. In questo modo, puoi chiamare DOUBLE solo una volta, ma fare in modo che venga calcolato per un numero elevato di celle contemporaneamente, come mostrato nello screenshot di seguito. Potresti ottenere lo stesso risultato con istruzioni if nidificate anziché la chiamata map.

Analogamente, la funzione personalizzata riportata di seguito recupera in modo efficiente i contenuti in tempo reale da Internet e utilizza un array bidimensionale per visualizzare due colonne di risultati con una sola chiamata di funzione. Se ogni cella richiedesse una propria chiamata di funzione, l'operazione richiederebbe molto più tempo, poiché il server Apps Script dovrebbe scaricare e analizzare ogni volta il feed XML.

/**
 * Show the title and date for the first page of posts on the
 * Developer blog.
 *
 * @return Two columns of data representing posts on the
 *     Developer blog.
 * @customfunction
 */
function getBlogPosts() {
  var array = [];
  var url = 'https://gsuite-developers.googleblog.com/atom.xml';
  var xml = UrlFetchApp.fetch(url).getContentText();
  var document = XmlService.parse(xml);
  var root = document.getRootElement();
  var atom = XmlService.getNamespace('http://www.w3.org/2005/Atom');
  var entries = document.getRootElement().getChildren('entry', atom);
  for (var i = 0; i < entries.length; i++) {
    var title = entries[i].getChild('title', atom).getText();
    var date = entries[i].getChild('published', atom).getValue();
    array.push([title, date]);
  }
  return array;
}

Queste tecniche possono essere applicate a quasi tutte le funzioni personalizzate utilizzate ripetutamente in un foglio di lavoro, anche se i dettagli di implementazione variano a seconda del comportamento della funzione.