Objets d'événement

Les déclencheurs simples et les déclencheurs installables permettent à Apps Script d'exécuter une fonction automatiquement si un certain événement se produit. Lorsqu'un déclencheur est exécuté, Apps Script transmet à la fonction un objet d'événement en tant qu'argument, généralement appelé e. L'objet événement contient des informations sur le contexte ayant déclenché l'activation du déclencheur. L'exemple de code ci-dessous illustre un déclencheur onEdit(e) simple pour un script Google Sheets qui utilise l'objet événement pour déterminer quelle cellule a été modifiée.

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());
}

Cette page détaille les champs de l'objet événement pour différents types de déclencheurs.

Événements Google Sheets

Les différents déclencheurs spécifiques à Google Sheets permettent aux scripts de répondre aux actions d'un utilisateur dans une feuille de calcul.

Ouvrir

(simple et installable)
authMode

Valeur de l'énumération ScriptApp.AuthMode.

LIMITED
source

Un objet Spreadsheet, représentant le fichier Google Sheets auquel le script est lié.

Spreadsheet
triggerUid

ID du déclencheur ayant généré cet événement (déclencheurs installables uniquement).

4034124084959907503
user

Un objet User représentant l'utilisateur actif, le cas échéant (en fonction d'un ensemble complexe de restrictions de sécurité)

amin@example.com

Changement

(à installer)
authMode

Valeur de l'énumération ScriptApp.AuthMode.

FULL
changeType

Type de modification (EDIT, INSERT_ROW, INSERT_COLUMN, REMOVE_ROW, REMOVE_COLUMN, INSERT_GRID, REMOVE_GRID, FORMAT ou OTHER).

INSERT_ROW
source

Un objet Spreadsheet, représentant le fichier Google Sheets auquel le script est lié.

Spreadsheet
triggerUid

ID du déclencheur qui a généré cet événement.

4034124084959907503
user

Un objet User représentant l'utilisateur actif, le cas échéant (en fonction d'un ensemble complexe de restrictions de sécurité)

amin@example.com

Modifier

(simple et installable)
authMode

Valeur de l'énumération ScriptApp.AuthMode.

LIMITED
oldValue

Valeur de la cellule antérieure à la modification, le cas échéant. Uniquement disponible si la plage modifiée est une seule cellule. La valeur sera indéfinie si la cellule n'avait pas de contenu précédent.

1234
range

Un objet Range, qui représente la cellule ou la plage de cellules modifiées.

Range
source

Un objet Spreadsheet, représentant le fichier Google Sheets auquel le script est lié.

Spreadsheet
triggerUid

ID du déclencheur ayant généré cet événement (déclencheurs installables uniquement).

4034124084959907503
user

Un objet User représentant l'utilisateur actif, le cas échéant (en fonction d'un ensemble complexe de restrictions de sécurité)

amin@example.com
value

Nouvelle valeur de cellule après la modification. Uniquement disponible si la plage modifiée est une seule cellule.

10

Envoi de formulaire

(à installer)
authMode

Valeur de l'énumération ScriptApp.AuthMode.

FULL
namedValues

Objet contenant les noms et les valeurs des questions de l'envoi du formulaire.

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

Un objet Range, qui représente la cellule ou la plage de cellules modifiées.

Range
triggerUid

ID du déclencheur qui a généré cet événement.

4034124084959907503
values

Tableau contenant les valeurs dans le même ordre qu'elles apparaissent dans la feuille de calcul.

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

Événements Google Docs

Les déclencheurs permettent à Google Docs de répondre lorsqu'un utilisateur ouvre un document.

Ouvrir

(simple et installable)
authMode

Valeur de l'énumération ScriptApp.AuthMode.

LIMITED
source

Un objet Document, représentant le fichier Google Docs auquel le script est lié

Document
triggerUid

ID du déclencheur ayant généré cet événement (déclencheurs installables uniquement).

4034124084959907503
user

Un objet User représentant l'utilisateur actif, le cas échéant (en fonction d'un ensemble complexe de restrictions de sécurité)

amin@example.com

Événements Google Slides

Les déclencheurs permettent à Google Slides de répondre lorsqu'un utilisateur ouvre une présentation.

Ouvrir

(simple)
authMode

Valeur de l'énumération ScriptApp.AuthMode.

LIMITED
source

Un objet Presentation, représentant le fichier Google Slides auquel le script est lié.

Presentation
user

Un objet User représentant l'utilisateur actif, le cas échéant (en fonction d'un ensemble complexe de restrictions de sécurité)

amin@example.com

Événements Google Forms

Les déclencheurs propres à Google Forms permettent aux scripts de répondre lorsqu'un utilisateur modifie un formulaire ou envoie une réponse.

Ouvrir

* (simple et installable)
authMode

Valeur de l'énumération ScriptApp.AuthMode.

LIMITED
source

Un objet Form, représentant le fichier Google Forms auquel le script est lié

Form
triggerUid

ID du déclencheur ayant généré cet événement (déclencheurs installables uniquement).

4034124084959907503
user

Un objet User représentant l'utilisateur actif, le cas échéant (en fonction d'un ensemble complexe de restrictions de sécurité)

amin@example.com

* Cet événement ne se produit pas lorsqu'un utilisateur ouvre un formulaire pour y répondre, mais lorsqu'un éditeur ouvre le formulaire pour le modifier.

Envoi de formulaire

(à installer)
authMode

Valeur de l'énumération ScriptApp.AuthMode.

FULL
response

Un objet FormResponse, qui représente la réponse de l'utilisateur au formulaire dans son ensemble.

FormResponse
source

Un objet Form, représentant le fichier Google Forms auquel le script est lié

Form
triggerUid

ID du déclencheur qui a généré cet événement.

4034124084959907503

des événements Google Agenda ;

Les déclencheurs d'agenda se déclenchent lorsque les événements d'agenda d'un utilisateur sont mis à jour (créés, modifiés ou supprimés).

Ces déclencheurs ne vous indiquent pas quel événement a changé ni comment il a changé. Au lieu de cela, ils indiquent que votre code doit effectuer une opération de synchronisation incrémentielle pour récupérer les modifications récentes apportées au calendrier. Pour obtenir une description complète de cette procédure, consultez le guide de synchronisation des ressources de l'API Calendar.

Pour synchroniser votre agenda avec Agenda dans Apps Script, procédez comme suit:

  1. Activez le service avancé d'Agenda pour le projet de script. Le service Agenda intégré n'est pas suffisant pour ce workflow.
  2. Déterminez les agendas à synchroniser. Pour chacun de ces agendas, effectuez une synchronisation initiale à l'aide de la méthode Events.list() du service avancé d'Agenda.
  3. Le résultat de la synchronisation initiale renvoie un nextSyncToken pour cet agenda. Stockez ce jeton pour une utilisation ultérieure.
  4. Lorsque le déclencheur EventUpdated Apps Script s'exécute et indique une modification d'un événement d'agenda, effectuez une synchronisation incrémentielle pour l'agenda concerné à l'aide du nextSyncToken stocké. Il s'agit essentiellement d'une autre requête Events.list(), mais fournir la valeur nextSyncToken limite la réponse aux événements qui ont été modifiés depuis la dernière synchronisation.
  5. Examinez la réponse de la synchronisation pour savoir quels événements ont été mis à jour et faire en sorte que votre code réponde de manière appropriée. Par exemple, vous pouvez consigner la modification, mettre à jour une feuille de calcul, envoyer des notifications par e-mail ou effectuer d'autres actions.
  6. Remplacez le nextSyncToken que vous avez stocké pour cet agenda par celui renvoyé par la requête de synchronisation incrémentielle. Cela oblige la prochaine opération de synchronisation à ne renvoyer que les modifications les plus récentes.

EventUpdated

(à installer)
authMode

Valeur de l'énumération ScriptApp.AuthMode.

FULL
calendarId

Identifiant de l'agenda dans lequel la mise à jour de l'événement a eu lieu.

susan@example.com
triggerUid

ID du déclencheur qui a généré cet événement.

4034124084959907503

Événements du module complémentaire Google Workspace

Le déclencheur onInstall() s'exécute automatiquement lorsqu'un utilisateur installe un module complémentaire.

Installer

(simple)
authMode

Valeur de l'énumération ScriptApp.AuthMode.

FULL

Événements de l'application Google Chat

Pour en savoir plus sur les objets d'événement dans Google Chat, consultez Recevoir des interactions avec votre application Google Chat et y répondre.

Événements basés sur le temps

Les déclencheurs basés sur le temps (également appelés "déclencheurs d'horloge") permettent aux scripts de s'exécuter à un moment particulier ou à intervalles réguliers.

Basé sur le temps (installable)
authMode

Valeur de l'énumération ScriptApp.AuthMode.

FULL
day-of-month

Entre le 1 et le 31

Comme ce nom de propriété contient des tirets, il doit être accessible via e['day-of-month'] plutôt que via la notation par points.

31
day-of-week

Entre 1 (lundi) et 7 (dimanche)

Comme ce nom de propriété contient des tirets, il doit être accessible via e['day-of-week'] plutôt que via la notation par points.

7
hour

Entre le 0 et le 23

23
minute

Entre le 0 et le 59

59
month

Entre le 1 et le 12

12
second

Entre le 0 et le 59

59
timezone

Fuseau horaire.

UTC
triggerUid

ID du déclencheur qui a généré cet événement.

4034124084959907503
week-of-year

Entre le 1 et le 52

Comme ce nom de propriété contient des tirets, il doit être accessible via e['week-of-year'] plutôt que via la notation par points.

52
year

L'année

2015