Questa pagina fornisce una panoramica su come progettare, creare e pubblicare i componenti aggiuntivi di Google Workspace. Questa panoramica spiega i seguenti passaggi:
- Determina in quali applicazioni di Google Workspace vuoi che il componente aggiuntivo sia disponibile per gli utenti.
- Imposta i progetti del componente aggiuntivo e scegli un proprietario e i collaboratori.
- Progetta l'aspetto e il comportamento del tuo componente aggiuntivo.
- Configura il file manifest del progetto o la risorsa di deployment del componente aggiuntivo.
- Scrivi codice per definire l'aspetto e il comportamento del componente aggiuntivo.
- Verifica gli ambiti OAuth del componente aggiuntivo.
- Testa il componente aggiuntivo in una o più applicazioni Google Workspace.
- Pubblica il componente aggiuntivo.
Scegliere le applicazioni host di Google Workspace
Puoi configurare i componenti aggiuntivi di Google Workspace in modo che vengano visualizzati nelle seguenti applicazioni host di Google Workspace:
- Gmail
- Google Calendar
- Documenti Google
- Google Drive
- Fogli Google
- Presentazioni Google
Per scoprire come eseguire il build per le applicazioni Google Workspace, consulta Estendere l'interfaccia utente di Google Workspace.
Configura i progetti del tuo componente aggiuntivo e scegli un proprietario e dei collaboratori
Se crei il componente aggiuntivo in Apps Script, crei sia un progetto Apps Script sia un progetto Google Cloud. Se crei il tuo componente aggiuntivo in un linguaggio diverso da Apps Script, devi solo creare un progetto Google Cloud.
Prima di iniziare lo sviluppo di componenti aggiuntivi, scegli un singolo account utente di proprietà dei progetti e decidi quali altri account collaborano. Il proprietario dei progetti crea e gestisce i file del progetto e le impostazioni associate, mentre i collaboratori possono fornire assistenza per la programmazione e i test.
Progetti Apps Script
Puoi creare i file di progetto Apps Script del tuo componente aggiuntivo in un drive condiviso in modo che nessun singolo account ne abbia la proprietà esclusiva. Se inserisci il file dello script del componente aggiuntivo in un Drive condiviso, più collaboratori avranno accesso al progetto dello script.
Quando pubblichi un componente aggiuntivo, un singolo account utente funge da editore. L'account di pubblicazione deve avere accesso in modifica al progetto sceneggiatura, ma non deve essere il proprietario.
Per creare un progetto Apps Script, vedi Progetti di script.
Progetti Google Cloud
Ti consigliamo di aggiungere collaboratori al progetto Cloud del componente aggiuntivo. In questo modo, un membro del tuo team può sempre accedere alle impostazioni Cloud del componente aggiuntivo.
Per creare un progetto Google Cloud, consulta Creare un progetto Google Cloud.
Progettare l'aspetto e il comportamento del componente aggiuntivo
Prima di iniziare a creare il componente aggiuntivo, decidi come deve apparire e come deve comportarsi. Valuta per quali casi d'uso il componente aggiuntivo dovrebbe provare a fornire soluzioni. Inizia con un design semplice per iniziare a lavorare, poi aggiungi altri perfezionamenti.
Consulta la guida di stile per i componenti aggiuntivi di Google Workspace per indicazioni su come progettare l'esperienza utente del componente aggiuntivo.
Configurare il manifest del progetto del componente aggiuntivo
Nei progetti Apps Script, il manifest del progetto è un file JSON speciale. Specifica una serie di dettagli sul progetto, ad esempio le dipendenze delle librerie. Per i componenti aggiuntivi di Google Workspace, il file manifest fornisce anche le informazioni di base necessarie all'applicazione host per visualizzare correttamente il componente aggiuntivo.
Consulta Manifest per informazioni dettagliate su come configurare il manifest del componente aggiuntivo in Apps Script.
Man mano che aggiungi codice e caratteristiche al tuo componente aggiuntivo, modifica il file manifest in base alle tue esigenze per produrre l'aspetto e il comportamento richiesti per il componente aggiuntivo.
Codificare il componente aggiuntivo
Devi implementare un'interfaccia basata su schede per il plug-in. Utilizza il servizio per le carte di Apps Script oppure, se stai scrivendo in un altro linguaggio di codice, restituisci un JSON formattato correttamente affinché l'interfaccia venga visualizzata come schede.
Devi anche implementare eventuali funzioni di attivazione specificate nel manifest del componente aggiuntivo. Se il tuo plug-in si connette a un servizio di terze parti non Google utilizzando OAuth, devi configurare OAuth anche per quel servizio.
Carte di costruzione
Puoi definire un'interfaccia utente del componente aggiuntivo creando oggetti
Card e compilandoli con
widget. Le funzioni di attivazione specificate nel manifest devono restituire un singolo oggetto Card o un array di oggetti Card che rappresentano diverse "pagine" dell'interfaccia del componente aggiuntivo. Il componente aggiuntivo può anche creare e visualizzare nuove schede in risposta alle azioni degli utenti.
In Apps Script, crei le schede utilizzando la classe
CardBuilder. Ogni scheda richiede una CardHeader e uno o più CardSections. Devi compilare ogni sezione della scheda con i singoli widget che compongono l'interfaccia del componente aggiuntivo. I widget
di interazione sono
in genere collegati ad azioni per definire
il loro comportamento di interazione.
Dopo aver aggiunto tutte le sezioni e i widget alla scheda tramite il relativo
CardBuilder, devi chiamare
CardBuilder.build()
per creare l'oggetto Card corrispondente.
Puoi utilizzare altri servizi di Apps Script integrati, come CalendarApp, per recuperare le informazioni da visualizzare nelle schede dei componenti aggiuntivi che crei.
Puoi utilizzare i dati recuperati da servizi non Google.
Se il tuo componente aggiuntivo ha bisogno di accedere ad API non Google che richiedono OAuth, devi configurare e connetterti a quel servizio. Per ulteriori dettagli, consulta la guida alla connessione ai servizi non Google.
Ordine di costruzione
Quando crei una scheda, devi iniziare dall'alto verso il basso. In altre parole, devi utilizzare questo ordine di compilazione:
- Crea il widget.
- Aggiungi il widget alla sezione della scheda.
- Ripeti finché la sezione della scheda non contiene tutti i widget.
- Aggiungi la sezione delle schede alla scheda.
Questa operazione è necessaria perché quando aggiungi un widget a una scheda o a una sezione delle schede, in realtà aggiungi una copia del widget. Eventuali modifiche apportate all'oggetto widget dopo averlo aggiunto non vengono applicate alla scheda finale.
Azioni universali
Puoi utilizzare le azioni universali per fornire funzionalità indipendenti dal contesto. Le azioni universali sono voci di menu disponibili nell'interfaccia utente del componente aggiuntivo indipendentemente dalla scheda visualizzata. Tutte le azioni universali definite vengono sempre visualizzate nel menu della scheda del componente aggiuntivo.
Per maggiori dettagli, consulta Azioni universali.
Verifica gli ambiti OAuth del componente aggiuntivo
Gli ambiti definiscono le azioni che il componente aggiuntivo può eseguire per conto di un utente. È una best practice per i componenti aggiuntivi avere ambiti solo per le azioni che devono avere per funzionare e nient'altro.
Nei progetti dei componenti aggiuntivi, imposta in modo esplicito gli scopi del componente aggiuntivo per assicurarti che utilizzi l'insieme di scopi meno permissivi possibile. Puoi definire gli ambiti utilizzati dal componente aggiuntivo nel manifest del componente aggiuntivo.
Per ulteriori dettagli, consulta la sezione Ampi dello spettro.
Testa il componente aggiuntivo
Per testare i componenti aggiuntivi non pubblicati, devi prima installare il componente aggiuntivo non pubblicato. Una volta installato e autorizzato, puoi utilizzare il componente aggiuntivo nel tuo account e testarne l'aspetto e il comportamento nelle applicazioni host a cui si estende. Devi verificare che il componente aggiuntivo si comporti come previsto per i contesti e le azioni utente.
Per ulteriori dettagli, consulta la sezione Testare i componenti aggiuntivi di Google Workspace.
Pubblicare il componente aggiuntivo
La pubblicazione del componente aggiuntivo lo rende disponibile ad altri, pubblicamente o solo agli utenti del tuo dominio. Prima di iniziare la procedura di pubblicazione, assicurati di leggere la panoramica della pubblicazione. La pubblicazione è un processo complesso che richiede preparazione e tempo per essere completata.
I componenti aggiuntivi di Google Workspace vengono pubblicati su Google Workspace Marketplace. I componenti aggiuntivi disponibili pubblicamente devono completare la revisione dell'app prima di essere pubblicati.
Per maggiori dettagli, consulta Pubblicazione del componente aggiuntivo di Google Workspace.