Librerie

Una libreria è un progetto di script le cui funzioni possono essere riutilizzate in altri script.

Uno script che utilizza una libreria non viene eseguito altrettanto rapidamente come se tutto il codice fosse contenuto in un unico progetto di script. Sebbene le librerie possano rendere più comodi lo sviluppo e la manutenzione, utilizzale con parsimonia nei progetti in cui la velocità è fondamentale. A causa di questo problema, l'utilizzo della libreria deve essere limitato nei componenti aggiuntivi di Google Workspace.

Ottenere l'accesso a una biblioteca

Per includere una libreria nel tuo progetto, devi disporre almeno dell'accesso a livello di visualizzazione. Se non sei l'autore della libreria che vuoi includere, contatta l'autore e richiedi l'accesso.

Devi avere l'ID script della libreria che vuoi includere. Quando hai accesso alla libreria, trova l'ID script nella pagina Impostazioni progetto .

Aggiungere una libreria al progetto di script

A sinistra dell'editor Apps Script, accanto a "Librerie", fai clic su Aggiungi una libreria .
Nel campo "ID script", incolla l'ID script della libreria.
Fai clic su Cerca.
Se si verifica un errore, assicurati di disporre almeno dell'accesso a livello di visualizzazione al progetto che stai cercando di includere.
Fai clic sul menu a discesa Versione e seleziona la versione della libreria da utilizzare.
Controlla se il nome predefinito "Identificatore" è quello che vuoi utilizzare con questa libreria. Questo è il nome che lo script utilizza per fare riferimento alla libreria. Ad esempio, se lo imposti su Test, chiama un metodo di quella libreria come segue: Test.libraryMethod.
Se utilizzi un nome identificatore che corrisponde al nome di un servizio già esistente, ad esempio MailApp, o di una libreria aggiunta in precedenza, la libreria che hai aggiunto più di recente sostituisce il servizio o la libreria esistente.
Fai clic su Aggiungi.

Utilizzare una libreria

Utilizza la libreria inclusa come faresti con un servizio predefinito. Ad esempio, se Test è l'identificatore della tua libreria, digita Test seguito immediatamente da un punto per visualizzare l'elenco dei metodi nella libreria.

Apri la documentazione di riferimento per una libreria inclusa seguendo questi passaggi:

A sinistra dell'editor di script, accanto al nome della libreria, fai clic su Altro > Apri in una nuova scheda.

Rimuovere una raccolta

A sinistra dell'editor di script, accanto al nome della libreria, fai clic su Altro > Rimuovi > Rimuovi libreria.

Se una libreria viene eliminata dall'autore, devi comunque rimuoverla dall'elenco delle librerie incluse.

Aggiornare una libreria

Modifica la versione della libreria o aggiorna il relativo identificatore.

A sinistra dell'editor, nella sezione "Librerie", fai clic sul nome della libreria.
Apporta le modifiche e fai clic su Save (Salva).

Creare e condividere una raccolta

Per utilizzare e condividere il progetto di script come una raccolta:

Crea un deployment con controllo delle versioni del tuo script.
Condividi almeno l'accesso a livello di visualizzazione con tutti i potenziali utenti della libreria.
Fornisci a questi utenti l'ID script, che si trova nella pagina Impostazioni progetto .

Best practice

Ecco alcune linee guida da seguire quando scrivi una libreria:

Scegli un nome significativo per il tuo progetto, in quanto viene utilizzato come identificatore predefinito quando la tua libreria viene inclusa da altri.
Per fare in modo che uno o più metodi dello script non siano visibili (né utilizzabili) dagli utenti della libreria, termina il nome del metodo con un trattino basso. Ad esempio, myPrivateMethod_.
Solo le proprietà globali enumerabili sono visibili agli utenti della libreria. Sono incluse dichiarazioni di funzioni, variabili create al di fuori di una funzione con var e proprietà impostate esplicitamente sull'oggetto globale. Ad esempio, Object.defineProperty() con enumerable impostato su false crea un simbolo che puoi utilizzare nella tua libreria, ma questo simbolo non è accessibile ai tuoi utenti.

Per garantire che gli utenti della libreria possano utilizzare il completamento automatico dell'editor di script e la documentazione generata automaticamente, includi la documentazione in stile JSDoc per tutte le tue funzioni. Ecco un esempio:

/**
 * Raises a number to the given power, and returns the result.
 *
 * @param {number} base the number we're raising to a power
 * @param {number} exp the exponent we're raising the base to
 * @return {number} the result of the exponential calculation
 */
function power(base, exp) { ... }

Definizione dell'ambito delle risorse

Quando lavori con le librerie, esistono due tipi di risorse: condivise e non condivise. Una risorsa condivisa significa che sia la libreria sia lo script di inclusione hanno un accesso integrato alla stessa istanza della risorsa. Il seguente diagramma illustra una risorsa condivisa utilizzando l'esempio di Proprietà utente:

Risorsa condivisa

Una risorsa non condivisa significa che sia la libreria che lo script che la include hanno accesso integrato solo alla propria istanza della risorsa. Tuttavia, una libreria può fornire l'accesso alle sue risorse non condivise tramite funzioni esplicite che operano su di esse. Ecco un esempio di funzione da includere nella libreria per esporre le proprietà dello script:

  function getLibraryProperty(key) {
    const scriptProperties = PropertiesService.getScriptProperties();
    return scriptProperties.getProperty(key);
  }

Il seguente diagramma illustra una risorsa non condivisa utilizzando l'esempio di Proprietà script:

Esempio di risorsa non condivisa

Questa tabella elenca le risorse condivise e non condivise a titolo di riferimento:

Risorsa	Condiviso*	Non condiviso**	Note
Blocca			La stessa istanza è visibile a tutti, inclusi gli script, quando viene creata nella raccolta.
Proprietà script			La stessa istanza è visibile a tutti, inclusi gli script, quando viene creata nella raccolta.
Cache			La stessa istanza è visibile a tutti, inclusi gli script, quando viene creata nella raccolta.
Trigger			I trigger semplici creati nella libreria non vengono attivati dallo script incluso.
ScriptApp
UiApp
Proprietà utente
Logger e trascrizione esecuzione
Sites, Fogli e altri contenitori			Una chiamata a `getActive` restituisce il contenitore del incluso lo script.
MailApp e GmailApp
* Ciò significa che la libreria non ha una propria istanza della funzionalità/risorsa e utilizza invece quella creata dallo script che l'ha richiamata. ** Ciò significa che la libreria ha una propria istanza della risorsa/funzionalità e che tutti gli script che utilizzano la libreria condividono e hanno accesso alla stessa istanza.

Testare una libreria

Per testare la libreria, utilizza la distribuzione della testa. Chiunque abbia accesso a livello di editor allo script può utilizzare la distribuzione head.

Devi comunque salvare almeno una versione della libreria.

Eseguire il debug di una libreria

Quando esegui il debug di uno script che include una libreria, non puoi entrare nel codice della libreria o impostare punti di interruzione. Se provi a eseguire il debug di una funzione di libreria in modalità di debug, il debugger ignora la funzione e passa alla riga successiva nello script chiamante.

L'utilizzo di HEAD (modalità di sviluppo) per la versione della libreria non consente di eseguire il debug della libreria o di raggiungere i punti di interruzione al suo interno.

Per eseguire il debug del codice della libreria, utilizza uno dei seguenti metodi:

Esegui il debug dal progetto della libreria: apri il progetto dello script della libreria nell'editor Apps Script. Per testare le funzioni della libreria con argomenti specifici, crea una funzione "test" temporanea all'interno del progetto della libreria che chiama le funzioni della libreria, quindi esegui la funzione di test in modalità di debug.
Logging: utilizza console.log() all'interno delle funzioni della libreria per generare informazioni nei log di esecuzione. Quando la libreria viene chiamata da un altro script, questi log vengono visualizzati nei log di esecuzione dello script chiamante.