Quando vuoi creare un nuovo componente aggiuntivo di Google Workspace, segui questa procedura generale:
- Configura i progetti del tuo componente aggiuntivo e scegli un proprietario e i collaboratori.
- Progetta l'aspetto e il comportamento del tuo componente aggiuntivo.
- Configurare il file manifest del progetto del componente aggiuntivo risorsa di deployment.
- Scrivi codice per definire l'aspetto e il comportamento del componente aggiuntivo.
- Verifica gli ambiti OAuth del componente aggiuntivo.
- Testa il componente aggiuntivo nel applicazioni in hosting si estende.
- Pubblica il componente aggiuntivo.
Configura i progetti del componente aggiuntivo e scegli un proprietario e i 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 un componente aggiuntivo, scegline una di proprietà dei progetti e decidere quali altri account collaboratori. 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 lo script di Apps Script del tuo componente aggiuntivo di progetto in un file condiviso guidare in modo che un singolo account ha la proprietà esclusiva. Posizionamento del componente aggiuntivo file di script su un Drive condiviso garantisce che più collaboratori abbiano accesso del progetto script.
Quando pubblichi un componente aggiuntivo, un singolo account utente agisce come 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 plug-in. Questo aiuta a garantire che qualcuno nel tuo team possa sempre accedere le 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
Scegli l'aspetto e le modalità di visualizzazione del componente aggiuntivo dovrebbe comportarsi prima di iniziare a crearlo. Valuta i casi d'uso per i quali il plug-in deve tentare di fornire soluzioni. Avvia con un design semplice per iniziare subito a lavorare, per poi aggiungere ulteriori perfezionamenti.
Consulta la guida di stile per i componenti aggiuntivi di Google Workspace per indicazioni su come progettare l'esperienza utente del componente aggiuntivo.
Configura 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 manifest fornisce anche le informazioni di base informazioni necessarie all'applicazione host per visualizzare 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 funzionalità al componente aggiuntivo, modifica il manifest in base alle esigenze per ottenere l'aspetto e il comportamento richiesti.
Codifica il componente aggiuntivo
Devi implementare un'interfaccia basata su carta per il come componente aggiuntivo. Utilizza Apps Script Servizio carta o se scrivi in un altro linguaggio di programmazione, un file JSON formattato correttamente per consentire il rendering dell'interfaccia come schede.
Devi anche implementare eventuali funzioni di attivazione specificate nel manifest del componente aggiuntivo. Se le tue il componente aggiuntivo si collega a un servizio di terze parti non Google tramite OAuth, devi configurare OAuth per questo Google Cloud.
Costruire schede
Puoi definire un'interfaccia utente del componente aggiuntivo creando oggetti Card e compilandoli con widget. Funzioni di trigger specificate in
il file manifest deve restituire un solo
Card o un array di
Card oggetti che rappresentano
diverse "pagine" dell'interfaccia dei componenti aggiuntivi. Il tuo
può anche creare e visualizzare nuove schede
risposta alle azioni degli utenti.
In Apps Script, crei le schede utilizzando la classe
CardBuilder. Ogni scheda richiede un CardHeader e uno o più CardSections. Dovresti
completano ogni sezione della scheda con i singoli widget che compongono la
l'interfaccia del componente aggiuntivo. Interazione
widget sono
generalmente collegato 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 carta, devi costruire partendo dalla ricarica. In altre parole, devi utilizzare questo ordine di compilazione:
- Crea il widget.
- Aggiungi il widget alla sezione della scheda.
- Ripeti finché la sezione delle schede non contiene tutti i widget.
- Aggiungi la sezione della scheda alla scheda.
Questo è necessario perché, quando aggiungi un widget a una scheda o a una sezione della scheda, in realtà aggiungi una copia del widget. Qualsiasi modifica apportata al widget dopo averlo aggiunto non si rifletteranno nell'ultima scheda.
Azioni universali
Puoi utilizzare le azioni universali per fornire funzionalità indipendenti dal contesto. Le azioni universali sono voci di menu disponibile nell'interfaccia utente del componente aggiuntivo, indipendentemente dalla scheda visualizzati. Tutte le azioni universali definite vengono sempre visualizzate nella menu della scheda del componente aggiuntivo.
Per maggiori dettagli, consulta Azioni universali.
Verifica gli ambiti OAuth dei componenti aggiuntivi
Gli ambiti definiscono le azioni che il plug-in può eseguire per conto di un utente. È una best practice per fare in modo che i componenti aggiuntivi abbiano ambiti solo per le azioni devono funzionare e nient'altro.
Nei progetti aggiuntivi, imposta esplicitamente il componente aggiuntivo per garantire il componente aggiuntivo utilizza l'insieme di ambiti meno permissivo possibile. Puoi 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 non pubblicato come componente aggiuntivo. Una volta installato e autorizzato, puoi utilizzare il componente aggiuntivo nel tuo account e testarne l'aspetto e il comportamento nelle applicazioni host 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 per altri utenti pubblicamente o solo agli utenti del tuo dominio. Prima di iniziare la procedura di pubblicazione, consulta 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. Disponibili al pubblico i componenti aggiuntivi devono completare la revisione dell'app prima vengono pubblicati.
Per maggiori dettagli, consulta Pubblicazione del componente aggiuntivo di Google Workspace.