Best practice

Migliora l'esperienza complessiva dei tuoi utenti seguendo queste guide per il design dei componenti aggiuntivi.

Best practice generali

Ti invitiamo a utilizzare le seguenti best practice per tutti gli annunci aggiuntivi che sviluppi.

Determinare la proprietà del componente aggiuntivo prima di iniziare

I componenti aggiuntivi sono definiti dai progetti Apps Script, che devono essere di proprietà di un account specifico o essere inseriti in un drive condiviso. Prima di scrivere il codice di un plug-in, determina quale account deve essere proprietario del progetto e quale account funge da publisher. Determina inoltre quali account devono agire come collaboratori e assicurati che questi account abbiano accesso al progetto di script e al relativo progetto Google Cloud associato.

Estendi Google Workspace, non replicarlo

I componenti aggiuntivi hanno lo scopo di fornire nuove funzionalità alle applicazioni Google Workspace che estendono o di automatizzare attività complesse. I componenti aggiuntivi che si limitano a replicare le funzionalità già presenti nell'applicazione o che non apportano miglioramenti significativi a un flusso di lavoro non supereranno probabilmente la revisione dei componenti aggiuntivi per la pubblicazione.

Mantieni gli ambiti ristretti

Quando definisci esplicitamente gli ambiti, scegli sempre l'insieme di ambiti meno permissivi possibile. Ad esempio, non fare in modo che il plug-in richieda l'accesso completo al calendario dell'utente con l'ambito https://www.googleapis.com/auth/calendar se ha bisogno solo di accesso in lettura. Per l'accesso di sola lettura, utilizza l'ambito https://www.googleapis.com/auth/calendar.readonly.

Evita di fare troppo affidamento sulle librerie

L'utilizzo delle librerie di Apps Script può far rallentare il componente aggiuntivo rispetto a quanto accadrebbe se tutto il codice di Apps Script fosse contenuto in un singolo progetto di script. Sebbene le librerie di Apps Script funzionino nei plug-in, potresti riscontrare una riduzione delle prestazioni se le utilizzi. Evita di includere librerie non necessarie nel progetto e valuta i modi per ridurre la dipendenza del tuo componente aggiuntivo da queste librerie.

La latenza descritta sopra si applica solo ai progetti Apps Script utilizzati come librerie lato server. Puoi utilizzare liberamente le librerie JavaScript lato client come jQuery senza riscontrare questa latenza.

Best practice per i componenti aggiuntivi dell'editor

Le best practice riportate di seguito si applicano solo al plug-in Editor.

Inserisci il codice HTML dell'interfaccia e JavaScript lato client nei rispettivi file di script

In un progetto Apps Script puoi creare più file di script. È più facile gestire un componente aggiuntivo complesso se inserisci il codice HTML e JavaScript che definisce le barre laterali e le finestre di dialogo del componente aggiuntivo in file di script dedicati.

Esegui test approfonditi in diverse modalità di autorizzazione

Quando testi il tuo componente aggiuntivo, assicurati di provare configurazioni con file e stati di autorizzazione diversi.