Oggetti evento

I trigger semplici e i trigger installabili consentono a Google Apps Script di eseguire automaticamente una funzione se si verifica un determinato evento. Quando un trigger viene attivato, Apps Script passa alla funzione un oggetto evento come argomento, in genere e. L'oggetto evento contiene informazioni sul contesto che ha causato l'attivazione del trigger. Ad esempio, il seguente codice di esempio mostra un semplice attivatore onEdit(e) per uno script Google Fogli che utilizza l'oggetto evento per determinare quale cella è stata 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 i campi nell'oggetto evento per diversi tipi di attivatori.

Gli eventi prodotti da attivatori installabili contengono un triggerUid che identifica l'attivatore che ha prodotto l'evento. Ciò è utile per gli script con più trigger installabili.

Eventi Fogli Google

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

Apri

(semplice e installabile)
authMode

Un valore dell'enumerazione ScriptApp.AuthMode.

LIMITED
source

Un oggetto Spreadsheet che rappresenta il file Fogli 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 restrizioni di sicurezza).

amin@example.com

Cambia

(installabile)
authMode

Un valore dell'enumerazione 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 Fogli 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 restrizioni di sicurezza).

amin@example.com

Modifica

(semplice e installabile)
authMode

Un valore dell'enumerazione ScriptApp.AuthMode.

LIMITED
oldValue

Il valore della cella prima della modifica, se presente. Disponibile solo se l'intervallo modificato è una singola cella. È indefinito se la cella non aveva contenuti precedenti.

1234
range

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

Range
source

Un oggetto Spreadsheet, che rappresenta il file Fogli 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 restrizioni di sicurezza).

amin@example.com
value

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

10

Invio del modulo

(installabile)
authMode

Un valore dell'enumerazione ScriptApp.AuthMode.

FULL
namedValues

Un oggetto contenente i nomi e i valori delle domande dell'invio del 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 modificato.

Range
triggerUid

ID dell'attivatore che ha generato questo evento.

4034124084959907503
values

Array con 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

I trigger consentono a Documenti di rispondere quando un utente apre un documento.

Apri

(semplice e installabile)
authMode

Un valore dell'enumerazione ScriptApp.AuthMode.

LIMITED
source

Un oggetto Document, che rappresenta il file Docs 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 restrizioni di sicurezza).

amin@example.com

Eventi di Presentazioni Google

I trigger consentono a Presentazioni di rispondere quando un utente apre una presentazione.

Apri

(semplice)
authMode

Un valore dell'enumerazione ScriptApp.AuthMode.

LIMITED
source

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

Presentation
user

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

amin@example.com

Eventi di Moduli Google

I trigger specifici per Moduli consentono agli script di rispondere quando un utente modifica un modulo o invia una risposta.

Apri

* (semplice e installabile)
authMode

Un valore dell'enumerazione ScriptApp.AuthMode.

LIMITED
source

Un oggetto Form, che rappresenta il file di moduli 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 restrizioni 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 del modulo

(installabile)
authMode

Un valore dell'enumerazione 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 moduli a cui è associato lo script.

Form
triggerUid

ID dell'attivatore che ha generato questo evento.

4034124084959907503

Eventi di Google Calendar

I trigger di Google Calendar si attivano quando gli eventi di calendario di un utente vengono aggiornati (creati, modificati o eliminati).

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

Per sincronizzare con Calendar in Apps Script, svolgi i seguenti passaggi:

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

A volte i token di sincronizzazione vengono invalidati dal server, causando un errore 410. In questo caso, il codice deve eseguire una sincronizzazione completa e sostituire tutti i dati e i token sincronizzati archiviati per quel calendario.

EventUpdated

(installabile)
authMode

Un valore dell'enum ScriptApp.AuthMode.

FULL
calendarId

L'ID stringa del calendario in cui è stato aggiornato l'evento.

susan@example.com
triggerUid

ID dell'attivatore che ha generato questo evento.

4034124084959907503

Eventi dei componenti aggiuntivi di Google Workspace

Il trigger onInstall() viene eseguito automaticamente quando un utente installa un componente aggiuntivo.

Installa

(semplice)
authMode

Un valore dell'enumerazione 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 sul tempo (chiamati anche trigger orologio) consentono agli script di essere eseguiti a un'ora specifica o a un intervallo ricorrente.

Basato sul tempo (installabile)
authMode

Un valore dell'enumerazione ScriptApp.AuthMode.

FULL
day-of-month

Tra 1 e 31.

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

31
day-of-week

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

Poiché il nome di questa proprietà contiene trattini, è necessario accedervi tramite e['day-of-week'] anziché 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é il nome di questa proprietà contiene trattini, è necessario accedervi tramite e['week-of-year'] anziché la notazione puntata.

52
year

L'anno.

2015