Oggetti evento

Gli trigger semplici e gli trigger installabili consentono ad Apps Script di eseguire automaticamente una funzione se si verifica un determinato evento. Quando viene attivato un trigger, Apps Script passa alla funzione un oggetto evento come argomento, in genere chiamato e. L'oggetto evento contiene informazioni sul contesto che ha attivato l'attivatore. Ad esempio, il codice di esempio riportato di seguito mostra un semplice attivatore onEdit(e) per uno script di Fogli Google che utilizza l'oggetto evento per determinare la cellula modificata.

function onEdit(e){
  // Set a comment on the edited cell to indicate when it was changed.
  var range = e.range;
  range.setNote('Last modified: ' + new Date());
}

Questa pagina descrive in dettaglio i campi dell'oggetto evento per diversi tipi di attivatori.

Eventi di Fogli Google

I vari attivatori specifici di Fogli Google consentono agli script di rispondere alle azioni di un utente in un foglio di lavoro.

Apri

(semplici e installabili)
authMode

Un valore dell'enum ScriptApp.AuthMode.

LIMITED
source

Un oggetto Spreadsheet che rappresenta il file di Fogli Google a cui è associato lo script.

Spreadsheet
triggerUid

ID dell'attivatore che ha generato questo evento (solo attivatori installabili).

4034124084959907503
user

Un oggetto User, che rappresenta l'utente attivo, se disponibile (a seconda di un complesso insieme di limitazioni di sicurezza).

amin@example.com

Cambia

(installabile)
authMode

Un valore dell'enum ScriptApp.AuthMode.

FULL
changeType

Il tipo di modifica (EDIT, INSERT_ROW, INSERT_COLUMN, REMOVE_ROW, REMOVE_COLUMN, INSERT_GRID, REMOVE_GRID, FORMAT o OTHER).

INSERT_ROW
source

Un oggetto Spreadsheet che rappresenta il file di Fogli Google a cui è associato lo script.

Spreadsheet
triggerUid

ID dell'attivatore che ha generato questo evento.

4034124084959907503
user

Un oggetto User, che rappresenta l'utente attivo, se disponibile (a seconda di un complesso insieme di limitazioni di sicurezza).

amin@example.com

Modifica

(semplici e installabili)
authMode

Un valore dell'enum ScriptApp.AuthMode.

LIMITED
oldValue

Valore della cella prima della modifica, se presente. Disponibile solo se l'intervallo modificato è costituito da una singola cella. Non sarà definito se la cella non aveva contenuti precedenti.

1234
range

Un oggetto Range, che rappresenta la cella o l'intervallo di celle modificate.

Range
source

Un oggetto Spreadsheet che rappresenta il file di Fogli Google a cui è associato lo script.

Spreadsheet
triggerUid

ID dell'attivatore che ha generato questo evento (solo attivatori installabili).

4034124084959907503
user

Un oggetto User, che rappresenta l'utente attivo, se disponibile (a seconda di un complesso insieme di limitazioni di sicurezza).

amin@example.com
value

Nuovo valore della cella dopo la modifica. Disponibile solo se l'intervallo modificato è costituito da una singola cella.

10

Invio modulo

(installabile)
authMode

Un valore dell'enum ScriptApp.AuthMode.

FULL
namedValues

Un oggetto contenente i nomi e i valori delle domande inviati con il modulo.

{
  'First Name': ['Jane'],
  'Timestamp': ['6/7/2015 20:54:13'],
  'Last Name': ['Doe']
}
range

Un oggetto Range, che rappresenta la cella o l'intervallo di celle modificate.

Range
triggerUid

ID dell'attivatore che ha generato questo evento.

4034124084959907503
values

Array con i valori nello stesso ordine in cui appaiono nel foglio di lavoro.

['2015/05/04 15:00', 'amin@example.com', 'Bob', '27', 'Bill',
'28', 'Susan', '25']

Eventi di Documenti Google

Gli attivatori consentono a Documenti Google di rispondere quando un utente apre un documento.

Apri

(semplici e installabili)
authMode

Un valore dell'enum ScriptApp.AuthMode.

LIMITED
source

Un oggetto Document, che rappresenta il file di Documenti Google a cui è associato lo script.

Document
triggerUid

ID dell'attivatore che ha generato questo evento (solo attivatori installabili).

4034124084959907503
user

Un oggetto User, che rappresenta l'utente attivo, se disponibile (a seconda di un complesso insieme di limitazioni di sicurezza).

amin@example.com

Eventi di Presentazioni Google

Gli attivatori consentono a Presentazioni Google di rispondere quando un utente apre una presentazione.

Apri

(simple)
authMode

Un valore dell'enum ScriptApp.AuthMode.

LIMITED
source

Un oggetto Presentation, che rappresenta il file di Presentazioni Google a cui è associato lo script.

Presentation
user

Un oggetto User, che rappresenta l'utente attivo, se disponibile (a seconda di un complesso insieme di limitazioni di sicurezza).

amin@example.com

Eventi di Moduli Google

Gli attivatori specifici di Moduli Google consentono agli script di rispondere quando un utente modifica un modulo o invia una risposta.

Apri

* (semplici e installabili)
authMode

Un valore dell'enum ScriptApp.AuthMode.

LIMITED
source

Un oggetto Form, che rappresenta il file di Google Forms a cui è associato lo script.

Form
triggerUid

ID dell'attivatore che ha generato questo evento (solo attivatori installabili).

4034124084959907503
user

Un oggetto User, che rappresenta l'utente attivo, se disponibile (a seconda di un complesso insieme di limitazioni di sicurezza).

amin@example.com

* Questo evento non si verifica quando un utente apre un modulo per rispondere, ma quando un editor lo apre per modificarlo.

Invio modulo

(installabile)
authMode

Un valore dell'enum ScriptApp.AuthMode.

FULL
response

Un oggetto FormResponse, che rappresenta la risposta dell'utente al modulo nel suo complesso.

FormResponse
source

Un oggetto Form, che rappresenta il file di Google Forms a cui è associato lo script.

Form
triggerUid

ID dell'attivatore che ha generato questo evento.

4034124084959907503

Eventi di Google Calendar

Gli attivatori di Calendar vengono attivati quando gli eventi di calendario di un utente vengono aggiornati (creati, modificati o eliminati).

Questi attivatori non indicano quale evento è cambiato o come è cambiato. Indicano invece che il codice deve eseguire un'operazione di sincronizzazione incrementale per rilevare le modifiche recenti al calendario. Per una descrizione completa di questa procedura, consulta la guida alla sincronizzazione delle risorse per l'API Calendar.

Per eseguire la sincronizzazione con Calendar in Apps Script, svolgi i seguenti passaggi:

  1. Abilita il servizio avanzato di Calendar per il progetto di script. Il servizio Calendar integrato non è sufficiente per questo flusso di lavoro.
  2. Determina quali calendari devono essere sincronizzati. Per ogni calendario, esegui un'operazione di sincronizzazione iniziale utilizzando il metodo Events.list() del servizio avanzato Calendar.
  3. Il risultato della sincronizzazione iniziale restituisce un nextSyncToken per quel calendario. Memorizza questo token per utilizzarlo in un secondo momento.
  4. Quando l'attivatore EventUpdated di Apps Script si attiva indicando una modifica dell'evento nel calendario, esegui una sincronizzazione incrementale per il calendario interessato utilizzando il valore nextSyncToken memorizzato. Si tratta essenzialmente di un'altra richiesta Events.list(), ma l'indicazione di nextSyncToken limita la risposta solo agli eventi che sono stati modificati dall'ultima sincronizzazione.
  5. Esamina la risposta della sincronizzazione per scoprire quali eventi sono stati aggiornati e fai in modo che il codice risponda di conseguenza. Ad esempio, puoi registrare la modifica, aggiornare un foglio di lavoro, inviare avvisi via email o intraprendere altre azioni.
  6. Aggiorna il valore nextSyncToken memorizzato per il calendario con quello restituito dalla richiesta di sincronizzazione incrementale. In questo modo, l'operazione di sincronizzazione successiva restituirà solo le modifiche più recenti.

EventUpdated

(installabile)
authMode

Un valore dell'enum ScriptApp.AuthMode.

FULL
calendarId

L'ID stringa del calendario in cui è avvenuto l'aggiornamento dell'evento.

susan@example.com
triggerUid

ID dell'attivatore che ha generato questo evento.

4034124084959907503

Eventi dei componenti aggiuntivi di Google Workspace

L'attivatore onInstall() viene eseguito automaticamente quando un utente installa un componente aggiuntivo.

Installa

(simple)
authMode

Un valore dell'enum ScriptApp.AuthMode.

FULL

Eventi dell'app Google Chat

Per informazioni sugli oggetti evento in Google Chat, consulta Ricevere e rispondere alle interazioni con l'app Google Chat.

Eventi basati sul tempo

I trigger basati su tempo (chiamati anche trigger dell'orologio) consentono di eseguire gli script in un determinato momento o a un intervallo ricorrente.

In base al tempo (installabile)
authMode

Un valore dell'enum ScriptApp.AuthMode.

FULL
day-of-month

Tra 1 e 31.

Poiché questo nome della proprietà contiene trattini, è necessario accedervi tramite e['day-of-month'] anziché con la notazione puntata.

31
day-of-week

Tra 1 (lunedì) e 7 (domenica).

Poiché questo nome della proprietà contiene trattini, è necessario accedervi tramite e['day-of-week'] anziché con la notazione puntata.

7
hour

Tra 0 e 23.

23
minute

Tra 0 e 59.

59
month

Tra 1 e 12.

12
second

Tra 0 e 59.

59
timezone

Il fuso orario.

UTC
triggerUid

ID dell'attivatore che ha generato questo evento.

4034124084959907503
week-of-year

Tra 1 e 52.

Poiché questo nome della proprietà contiene trattini, è necessario accedervi tramite e['week-of-year'] anziché con la notazione puntata.

52
year

L'anno.

2015