Attivatori per i componenti aggiuntivi di Google Workspace

Gli attivatori di Apps Script fanno in modo che una funzione script specificata (la funzione di trigger) venga eseguita ogni volta che si verifica un evento specifico. Solo determinati eventi possono attivare gli attivatori e ogni applicazione Google Workspace supporta un insieme diverso di eventi.

Quando viene attivato un attivatore, viene creato un oggetto evento. Questa struttura JSON contiene dettagli sull'evento che si è verificato. Le informazioni nella struttura dell'oggetto evento sono organizzate in modo diverso in base al tipo di attivatore.

Una volta creato l'oggetto evento, Apps Script lo passa come parametro alla funzione di attivazione. La funzione di trigger è una funzione di callback che devi implementare autonomamente per eseguire le azioni appropriate per rispondere all'evento. Ad esempio, in un componente aggiuntivo di Google Workspace che espande Gmail, puoi definire un attivatore che crea una nuova interfaccia della scheda quando l'utente apre un thread di messaggi. In questo caso, implementi una funzione di callback contestuale per creare le schede che compongono la nuova UI utilizzando i dati passati nell'oggetto evento.

Questa pagina fornisce linee guida sull'utilizzo degli attivatori nei progetti dei componenti aggiuntivi di Google Workspace.

Attivatori manifest

A differenza dei componenti aggiuntivi di Editor, i componenti aggiuntivi di Google Workspace attualmente non possono utilizzare gli attivatori semplici di Apps Script. Utilizzano invece gli attivatori progettati specificamente per i componenti aggiuntivi di Google Workspace: gli attivatori manifest.

Gli attivatori manifest sono definiti completamente nel manifest del componente aggiuntivo Google Workspace. Ecco alcuni esempi di attivatori manifest:

  • Attivatori della home page che creano e mostrano la home page del componente aggiuntivo.
  • Eventi di attivazione di apertura del calendario che mostrano una nuova scheda o eseguono altre azioni quando viene aperto un evento di Calendar.
  • Attivatori eventUpdate di Calendar che mostrano una nuova scheda o intraprendono altre azioni quando un utente modifica e salva un evento di Calendar.
  • Attivatori onItemsSelected di Drive che mostrano una nuova scheda o eseguono altre azioni quando un utente seleziona uno o più file o cartelle in Drive.
  • Attivatori di composizione di Gmail che mostrano una scheda del componente aggiuntivo quando l'utente apre il componente aggiuntivo nella finestra di composizione di Gmail.
  • Attivati contestuali di Gmail che mostrano una nuova scheda o intraprendono altre azioni quando l'utente apre un messaggio Gmail.
  • Trigger onFileScopeGranted di Editor che mostrano una nuova scheda quando gli utenti grant authorization for the drive.file OAuth scope in the current Editor document.

Nell'elenco riportato sopra, solo gli attivatori della home page sono non contestuali; gli altri sono attivatori contestuali. Per ulteriori informazioni sulle definizioni degli attivatori del manifest, consulta Manifest.

Oltre agli attivatori manifest, i componenti aggiuntivi di Google Workspace possono utilizzare anche gli attivatori installabili di Apps Script.

Restrizioni

L'utilizzo degli attivatori manifest è soggetto a determinate limitazioni.

  • Questi attivatori vengono utilizzati solo nei progetti dei componenti aggiuntivi di Google Workspace e non hanno alcun scopo in altre applicazioni.
  • Poiché sono definiti nel file manifest del componente aggiuntivo e non nel relativo codice, non puoi utilizzare il servizio Script di Apps Script per creare o modificare questi attivatori.
  • Al momento, gli attivatori contestuali di Gmail possono avere solo un criterio unconditional. Ciò significa che gli attivatori contestuali vengono attivati per ogni messaggio email, indipendentemente dal contenuto.
  • Ogni componente aggiuntivo può avere un solo attivatore di ogni tipo, per utente e per documento.