Se vuoi creare un nuovo componente aggiuntivo di Google Workspace, segui queste indicazioni generali procedura:
- Configura i progetti del componente aggiuntivo e scegli un proprietario e collaboratori.
- Progetta l'aspetto e il comportamento del tuo componente aggiuntivo.
- Configurare il file manifest del progetto del componente aggiuntivo risorsa di deployment.
- Scrivi il codice per definire l'aspetto e il funzionamento del componente aggiuntivo comportamento degli utenti.
- 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 tuo componente aggiuntivo in Apps Script, crei un progetto Apps Script e 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 un componente aggiuntivo, scegline una di proprietà dei progetti e decidere quali altri account 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 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 disporre dell'accesso in modifica allo script progetto, ma non è necessario che ne sia il proprietario.
Per creare un progetto Apps Script, vedi Progetti di script.
Progetti Google Cloud
Ti consigliamo di aggiungere collaboratori al componenti aggiuntivi progetto Cloud. 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 quali casi d'uso dovrebbe 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 le linee guida su come progettare il tuo componente aggiuntivo un'esperienza senza intervento manuale.
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 la sua libreria delle dipendenze. 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.
Per i dettagli su come configurare i file, consulta la sezione File manifest del componente aggiuntivo in Apps Script.
Quando aggiungi codice e caratteristiche al componente aggiuntivo, modifica il manifest in base alle esigenze per produrre il componente aggiuntivo richiesto aspetto e comportamento.
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 inoltre implementare eventuali attivatori di Google specificate in del file 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
Per definire l'interfaccia utente di un componente aggiuntivo devi creare
Card oggetti e riempirli 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 schede utilizzando
CardBuilder. Ciascuna
la carta 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 tua scheda tramite
CardBuilder, devi chiamare
CardBuilder.build()
per creare l'oggetto Card corrispondente.
Puoi usare altri script Apps Script integrati
servizi 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 i componenti aggiuntivi di Google Workspace richiedono l'accesso ad API non Google che richiedono OAuth, devono configurare e connettersi al servizio. Consulta la sezione Come connettersi a Guida ai servizi non Google per ulteriori dettagli.
Ordine di costruzione
Quando crei una carta, devi costruire partendo dalla ricarica. Vale a dire che devi utilizzare 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, 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 saperne di più, consulta la sezione Azioni universali i dettagli.
Verifica gli ambiti OAuth dei componenti aggiuntivi
Gli ambiti definiscono quali azioni vengono può assumere per conto di un utente. È una best practice per fare in modo che i componenti aggiuntivi abbiano ambiti solo per le azioni una funzione di ordine e nient'altro.
Nei progetti aggiuntivi, imposta esplicitamente il componente aggiuntivo di applicazione per garantire il componente aggiuntivo utilizza l'insieme di ambiti meno permissivo possibile. Sei tu a definire gli ambiti utilizzati dal componente aggiuntivo il componente aggiuntivo manifest.
Per ulteriori dettagli, consulta la sezione Ambiti.
Testa 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 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 per altri utenti pubblicamente o solo agli utenti del tuo dominio. Prima di iniziare la pubblicazione assicurati di consultare 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 su Google Workspace Marketplace. Disponibili al pubblico i componenti aggiuntivi devono completare la revisione dell'app prima vengono pubblicati.
Consulta la pagina relativa alla pubblicazione del componente aggiuntivo di Google Workspace per ulteriori dettagli.