Se vuoi creare un nuovo componente aggiuntivo di Google Workspace, segui questa procedura generale:
- Configura i progetti del componente aggiuntivo e scegli un proprietario e i collaboratori.
- Progetta l'aspetto e il comportamento del tuo componente aggiuntivo.
- Configura 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.
- Testa il componente aggiuntivo all'interno delle applicazioni host che estende.
- Pubblicare il componente aggiuntivo.
Configura i progetti del componente aggiuntivo e scegli un proprietario e i collaboratori
Se crei il tuo componente aggiuntivo in Apps Script, puoi creare sia un progetto Apps Script sia un progetto Google Cloud. Se crei il 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 a cui assegnare la proprietà dei progetti e decidi quali altri account sono collaboratori. 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 singolo account abbia la proprietà esclusiva. Se posizioni il file di script del componente aggiuntivo in un Drive condiviso, più collaboratori avranno accesso al progetto di script.
Quando pubblichi un componente aggiuntivo, un singolo account utente agisce come editore. L'account di pubblicazione deve avere accesso in modifica al progetto di script, ma non è necessario che sia il proprietario.
Per creare un progetto Apps Script, consulta l'articolo Progetti Script.
Progetti Google Cloud
Ti consigliamo di aggiungere collaboratori al progetto Cloud del componente aggiuntivo. Ciò garantisce 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
Stabilisci l'aspetto e il comportamento del componente aggiuntivo prima di iniziare a svilupparlo. Considera per quali casi d'uso il componente aggiuntivo dovrebbe cercare di 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 per i componenti aggiuntivi.
Configura il manifest del progetto del componente aggiuntivo
Nei progetti Apps Script, il manifest del progetto è un file JSON speciale. Specifica una varietà di dettagli sul progetto, come 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.
Per informazioni dettagliate su come configurare il file manifest del tuo componente aggiuntivo in Apps Script, consulta Manifest.
Man mano che aggiungi codice e funzionalità al componente aggiuntivo, modifica il manifest in base alle esigenze per produrre l'aspetto e il comportamento richiesti.
Codificare il componente aggiuntivo
Devi implementare un'interfaccia basata su schede per il componente aggiuntivo. Utilizza Card service di Apps Script oppure, se scrivi in un altro linguaggio di codice, restituisci JSON nel formato corretto per l'interfaccia da visualizzare sotto forma di schede.
Devi inoltre implementare eventuali funzioni trigger specificate nel manifest del componente aggiuntivo. Se il componente aggiuntivo si connette a un servizio di terze parti non Google utilizzando OAuth, devi configurare anche OAuth per quel servizio.
Creazione delle schede
Per definire un'interfaccia utente aggiuntiva, devi creare oggetti Card e inserirli con i widget. Le funzioni trigger specificate nel file 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 mostrare nuove schede in risposta alle azioni degli utenti.
In Apps Script, puoi creare le schede utilizzando la classe CardBuilder. Ogni scheda richiede un elemento CardHeader e uno o più CardSections. Devi compilare ogni sezione della scheda con i singoli widget che costituiscono l'interfaccia del componente aggiuntivo. I widget di interazione sono solitamente collegati alle azioni per definire il loro comportamento di interazione.
Dopo aver aggiunto tutte le sezioni e i widget alla tua scheda tramite il relativo CardBuilder, devi chiamare CardBuilder.build() per creare l'oggetto Card corrispondente.
Puoi utilizzare altri servizi Apps Script integrati, 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 devono accedere ad API non Google che richiedono OAuth, devi configurare e connetterti a quel servizio. Per ulteriori dettagli, consulta la guida alla connessione a servizi non Google.
Ordine di costruzione
Quando crei una carta, devi costruire dall'alto. Vale a dire che devi utilizzare questo ordine di costruzione:
- Creare il widget.
- Aggiungi il widget alla sezione della scheda.
- Ripeti l'operazione fino a quando la sezione della scheda non ha tutti i widget.
- Aggiungi la sezione della scheda alla scheda.
Questa operazione è necessaria perché, quando aggiungi un widget a una scheda o a una sezione della scheda, in realtà viene aggiunta una copia di tale widget. Eventuali modifiche apportate all'oggetto widget dopo averlo aggiunto non vengono riportate 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.
Verificare gli ambiti OAuth del componente aggiuntivo
Gli ambiti definiscono le azioni che il componente aggiuntivo può eseguire per conto di un utente. Come best practice, per i componenti aggiuntivi devono essere definiti solo gli ambiti per le azioni che devono avere per poter funzionare e nient'altro.
Nei progetti dei componenti aggiuntivi, imposta esplicitamente gli ambiti dei componenti aggiuntivi in modo 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.
Testare 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 Testare i componenti aggiuntivi di Google Workspace.
Pubblicare il componente aggiuntivo
La pubblicazione del componente aggiuntivo lo rende disponibile pubblicamente o solo agli utenti del 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 il completamento.
I componenti aggiuntivi di Google Workspace vengono pubblicati in Google Workspace Marketplace. I componenti aggiuntivi disponibili pubblicamente devono completare la revisione dell'app prima di essere pubblicati.
Per ulteriori dettagli, consulta Pubblicazione di un componente aggiuntivo di Google Workspace.