Migliora le informazioni esperienza complessiva seguendo queste guide per i componenti la progettazione.
Best practice generali
Ti invitiamo a seguire le seguenti best practice per tutti i componenti aggiuntivi che lo sviluppo di applicazioni.
Determinare la proprietà di un componente aggiuntivo prima di iniziare
I componenti aggiuntivi sono definiti da progetti Apps Script, che devono essere di proprietà di un account o altro posizionato su un Drive condiviso. Prima di programmare un componente aggiuntivo, stabilisci quale account debba essere il proprietario del progetto e quale account funge da publisher. Determinare anche quali account devono intervenire come collaboratori e assicurati che questi account abbiano accesso allo script progetto e le relative istanze Progetto piattaforma cloud.
Estendi Google Workspace, non replicarlo
hanno lo scopo di fornire nuove funzionalità le applicazioni di Google Workspace che estendono per automatizzare attività complesse. che si limitano a replicare le funzionalità già presenti un'applicazione o quelli che non apportano miglioramenti significativi a un hanno poche probabilità di superare la revisione dei componenti aggiuntivi per pubblicazione.
Riduci gli ambiti
Quando definisci gli ambiti in modo esplicito,
e scegli sempre l'insieme di ambiti meno permissivo possibile. Ad esempio, non
per richiedere l'accesso completo al calendario dell'utente con il componente aggiuntivo
https://www.googleapis.com/auth/calendar ambito se deve solo leggere
l'accesso. Per l'accesso di sola lettura, utilizza il metodo
https://www.googleapis.com/auth/calendar.readonly ambito.
Evita di fare troppo affidamento sulle librerie
L'utilizzo delle librerie di Apps Script può causare per essere eseguito più lentamente se tutto il codice di Apps Script fosse contenuto in un singolo progetto di script. Anche se le librerie di Apps Script funzionano nei componenti aggiuntivi, potresti riscontrare prestazioni se utilizzate. Evita di includere librerie non necessarie nel tuo e valuta come ridurre la dipendenza del componente aggiuntivo da questi ultimi.
La latenza descritta sopra si applica solo ai progetti Apps Script in uso come librerie lato server. Puoi utilizzare le librerie JavaScript lato client come jQuery liberamente senza riscontrare questa latenza.
Best practice per i componenti aggiuntivi di Google Workspace
Le seguenti best practice si applicano Componenti aggiuntivi di Google Workspace e utilizzo del servizio carta.
Utilizzare solo poche schede
Se il componente aggiuntivo utilizza troppe schede, la configurazione di navigazione diventa complessa e difficile da gestire.
Evita l'impulso di creare più carte del necessario.
Utilizzare le funzioni di creazione dei widget
Durante la scrittura di codice che crea Card
o altri oggetti UI complessi, valuta la possibilità di inserire quel codice nella sua funzione.
Questa funzione di creazione deve semplicemente creare l'oggetto e restituirlo. Ciò consente
puoi rigenerare rapidamente l'oggetto ogni volta che l'interfaccia utente deve essere aggiornata. Ricorda
per chiamare build() dopo aver utilizzato le classi del builder nella
Servizio carta.
Utilizza schede semplici
Se una determinata scheda ha troppi widget, potrebbe occupare troppo lo schermo e diventano meno utili. Le sezioni di schede di grandi dimensioni vengono visualizzate come elementi UI comprimibili, In questo modo le informazioni vengono nascoste all'utente. Punta a semplificare il componente aggiuntivo e a fornire esattamente ciò di cui l'utente ha bisogno e niente di più.
Utilizzare le schede degli errori
Crea schede per le condizioni di errore. Se il componente aggiuntivo genera un errore, dovrebbe mostrare una scheda con le informazioni sull'errore e le istruzioni per correggerlo se possibile. Ad esempio, se il componente aggiuntivo non riesce a connettersi a un perché l'autorizzazione non è riuscita, visualizza una scheda in cui viene indicato e chiedi all'utente per verificare i dati dell'account utilizzati.
Scrivere test e messaggi di prova
Ti consigliamo di testare a fondo tutti i componenti aggiuntivi che crei. Creare funzioni di test creare schede e widget utilizzando dati di test e quindi verificare che gli oggetti siano come previsto.
Quando utilizzi le funzioni di callback di azione, di solito è necessario costruire un oggetto risposta. Puoi usare istruzioni come di seguito per verificare che le risposte vengano create correttamente:
Logger.log(response.printJson());
Eseguire funzioni di test che crei direttamente da Apps Script utilizzando il menu Esegui. Quando un componente aggiuntivo funzionante funziona, assicurati di installare la versione non pubblicata per testarlo.
Utilizza dati di test appropriati per ogni applicazione host estesa al componente aggiuntivo. Per Ad esempio, se il componente aggiuntivo estende Gmail, probabilmente avrai bisogno di alcune email di prova. e i relativi ID messaggio, per garantirti che il componente aggiuntivo funzioni previsto quando vengono forniti contenuti del messaggio diversi. Puoi ottenere l'ID messaggio per un dato messaggio elencando i messaggi mediante Users.messages.list dell'API Gmail oppure utilizzando il comando Servizio Gmail.
Best practice per le conferenze di Calendar
Se il tuo componente aggiuntivo integra terze parti conferenza calendario in Google Calendar, segui queste best practice aggiuntive:
Tieni la luce onCreateFunction
Ogni onCreateFunction
che definisci nel manifest viene chiamato in modo sincrono quando un utente tenta di
per creare una soluzione per conferenze di questo tipo. Assicurati che queste funzioni eseguano solo
il lavoro minimo necessario per creare la conferenza. Troppo lavoro in queste
può causare un'esperienza utente lenta per il componente aggiuntivo.
Utilizza i campi ConferenceData appropriati per i dati della conferenza
Quando crei
ConferenceData
, puoi compilarli con i dettagli della conferenza (accesso
codici, numeri di telefono, PIN, URI e così via). Assicurati di utilizzare il modello
Campo EntryPoint
per queste informazioni. Non inserire questi dettagli nel ConferenceData
Note.
Non aggiungere dettagli della conferenza all'evento di Google Calendar
Non è necessario aggiungere nel componente aggiuntivo informazioni sulla terza parte creata conferenze alla descrizione dell'evento in Google Calendar. Google Calendar automaticamente quando necessario.