Se vuoi creare un nuovo componente aggiuntivo di Google Workspace, segui questa procedura generale:
- Imposta i progetti del componente aggiuntivo e scegli un proprietario e i collaboratori.
- Progetta l'aspetto e il comportamento del tuo componente aggiuntivo.
- configurare il manifest del progetto o la risorsa di deployment del componente aggiuntivo.
- Scrivi il codice per definire l'aspetto e il comportamento del componente aggiuntivo.
- Verifica gli ambiti OAuth del componente aggiuntivo.
- Testare il componente aggiuntivo nelle applicazioni host che estende.
- Pubblica il componente aggiuntivo.
Configura i progetti del componente aggiuntivo e scegli un proprietario e i collaboratori
Se crei un componente aggiuntivo in Apps Script, crei sia un progetto Apps Script sia un progetto Google Cloud. Se crei il componente aggiuntivo in una lingua diversa 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 di progetto e le impostazioni associate, mentre i collaboratori possono aiutare con 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 account abbia la proprietà esclusiva. Il posizionamento del file di script del componente aggiuntivo in un Drive condiviso garantisce che più collaboratori abbiano accesso al progetto dello script.
Quando pubblichi un componente aggiuntivo, un singolo account utente agisce da publisher. L'account di pubblicazione deve disporre dell'accesso in modifica al progetto di script, ma non è necessario che sia 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. Questo contribuisce a garantire che qualcuno del tuo team possa sempre accedere alle impostazioni Cloud del componente aggiuntivo.
Per creare un progetto Google Cloud, consulta Creare un progetto Google Cloud.
Progetta l'aspetto e il comportamento dei componenti aggiuntivi
Decidi l'aspetto che vuoi per il tuo componente aggiuntivo e come deve comportarsi prima di iniziare a crearlo. 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 le linee guida su come progettare l'esperienza utente dei componenti aggiuntivi.
Configurare il manifest del progetto dei componenti aggiuntivi
Nei progetti Apps Script, il manifest del progetto è un file JSON speciale. Specifica una varietà di dettagli sul progetto, come le dipendenze dalle 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 la sezione File manifest per i dettagli su come configurare il file manifest del tuo componente aggiuntivo in Apps Script.
Man mano che aggiungi codice e caratteristiche al componente aggiuntivo, modifica il file manifest in base alle tue esigenze per produrre l'aspetto e il comportamento richiesti per il componente aggiuntivo.
Codifica il componente aggiuntivo
Per il componente aggiuntivo devi implementare un'interfaccia basata su carta. 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 inoltre implementare eventuali funzioni trigger specificate nel file manifest del componente aggiuntivo. Se il componente aggiuntivo si connette a un servizio di terze parti non Google tramite OAuth, devi configurare anche il protocollo OAuth per quel servizio.
Costruire schede
Per definire l'interfaccia utente di un componente aggiuntivo, puoi creare oggetti Card e riempirli di widget. Le funzioni trigger specificate nel file manifest devono restituire un singolo oggetto Card o un array di oggetti Card che rappresentano "pagine" diverse dell'interfaccia del componente aggiuntivo. Il componente aggiuntivo può anche creare e visualizzare nuove schede in risposta alle azioni degli utenti.
In Apps Script, puoi creare schede utilizzando la classe CardBuilder. Ogni scheda richiede una CardHeader e uno o più CardSections. Dovresti
compilare ogni sezione delle schede 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 tua scheda tramite CardBuilder, devi chiamare CardBuilder.build() per creare l'oggetto Card corrispondente.
Puoi utilizzare altri servizi integrati di Apps Script, ad esempio CalendarApp, per recuperare le informazioni da visualizzare nelle schede dei componenti aggiuntivi che crei.
Puoi utilizzare i dati recuperati da servizi non Google.
Se i componenti aggiuntivi di Google Workspace richiedono l'accesso ad API non Google che richiedono OAuth, devi configurare il servizio e connetterti a questo servizio. Per maggiori dettagli, consulta la guida Connessione ai servizi non Google.
Ordine di costruzione
Quando crei una carta, devi costruire partendo dalla ricarica. Vale a dire, devi utilizzare questo ordine di costruzione:
- Crea il widget.
- Aggiungi il widget alla sezione della scheda.
- Ripeti finché la sezione delle schede 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 l'aggiunta non vengono applicate nella 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 ulteriori dettagli, consulta Azioni universali.
Verifica gli ambiti OAuth dei componenti aggiuntivi
Gli ambiti definiscono le azioni che il componente aggiuntivo può eseguire per conto di un utente. Una best practice prevede che i componenti aggiuntivi abbiano ambiti solo per le azioni che devono avere per funzionare e nient'altro.
Nei progetti dei componenti aggiuntivi, imposta esplicitamente gli ambiti dei componenti aggiuntivi per assicurarti che il componente aggiuntivo utilizzi l'insieme di ambiti meno permissivo possibile. Sei tu a definire gli ambiti utilizzati dal componente aggiuntivo nel manifest del componente aggiuntivo.
Per ulteriori dettagli, consulta la sezione Ambiti.
Testa il componente aggiuntivo
Puoi testare i componenti aggiuntivi non pubblicati installando prima 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 che estende. Devi verificare che il componente aggiuntivo si comporti come previsto per i contesti e le azioni degli utenti.
Per maggiori dettagli, vedi Test dei componenti aggiuntivi di Google Workspace.
Pubblica 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 completato.
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 la pagina relativa alla pubblicazione del componente aggiuntivo di Google Workspace.