Objets d'événement

Les déclencheurs simples et les déclencheurs installables permettent à Apps Script d'exécuter automatiquement une fonction si un certain événement se produit. Lorsqu'un déclencheur se déclenche, Apps Script transmet un objet d'événement à la fonction en tant qu'argument, généralement appelé e. L'objet d'événement contient des informations sur le contexte qui a déclenché le déclencheur. Par exemple, l'exemple de code ci-dessous montre un simple déclencheur onEdit(e) pour un script Google Sheets qui utilise l'objet d'é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écrit en détail les champs de l'objet d'é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

Objet Spreadsheet représentant le fichier Google Sheets auquel le script est lié.

Spreadsheet
triggerUid

ID du déclencheur qui a produit cet événement (déclencheurs installables uniquement).

4034124084959907503
user

Objet User représentant l'utilisateur actif, s'il est disponible (en fonction d'un ensemble complexe de restrictions de sécurité).

amin@example.com

Modifier

(installable)
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 produit cet événement.

4034124084959907503
user

Objet User représentant l'utilisateur actif, s'il est disponible (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 avant la modification, le cas échéant. Disponible uniquement si la plage modifiée est une seule cellule. La valeur sera "undefined" si la cellule ne contenait aucun contenu auparavant.

1234
range

Un objet Range représentant la cellule ou la plage de cellules modifiées.

Range
source

Objet Spreadsheet représentant le fichier Google Sheets auquel le script est lié.

Spreadsheet
triggerUid

ID du déclencheur qui a produit cet événement (déclencheurs installables uniquement).

4034124084959907503
user

Objet User représentant l'utilisateur actif, s'il est disponible (en fonction d'un ensemble complexe de restrictions de sécurité).

amin@example.com
value

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

10

Envoi de formulaire

(installable)
authMode

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

FULL
namedValues

Objet contenant les noms et les valeurs des questions du formulaire envoyé.

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

Un objet Range représentant la cellule ou la plage de cellules modifiées.

Range
triggerUid

ID du déclencheur qui a produit cet événement.

4034124084959907503
values

Tableau avec des valeurs dans le même ordre que 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

Objet Document représentant le fichier Google Docs auquel le script est associé.

Document
triggerUid

ID du déclencheur qui a produit cet événement (déclencheurs installables uniquement).

4034124084959907503
user

Objet User représentant l'utilisateur actif, s'il est disponible (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

Objet Presentation représentant le fichier Google Slides auquel le script est lié.

Presentation
user

Objet User représentant l'utilisateur actif, s'il est disponible (en fonction d'un ensemble complexe de restrictions de sécurité).

amin@example.com

Événements Google Forms

Les déclencheurs spécifiques à 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

Objet Form représentant le fichier Google Forms auquel le script est lié.

Form
triggerUid

ID du déclencheur qui a produit cet événement (déclencheurs installables uniquement).

4034124084959907503
user

Objet User représentant l'utilisateur actif, s'il est disponible (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 l'ouvre pour le modifier.

Envoi de formulaire

(installable)
authMode

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

FULL
response

Objet FormResponse représentant la réponse de l'utilisateur au formulaire dans son ensemble.

FormResponse
source

Objet Form représentant le fichier Google Forms auquel le script est lié.

Form
triggerUid

ID du déclencheur qui a produit cet événement.

4034124084959907503

É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. 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 à l'agenda. Pour obtenir une description complète de cette procédure, consultez le guide de synchronisation des ressources pour l'API Calendar.

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

  1. Activez le service avancé 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é Agenda.
  3. Le résultat de la synchronisation initiale renvoie un nextSyncToken pour cet agenda. Enregistrez ce jeton pour une utilisation ultérieure.
  4. Lorsque le déclencheur Apps Script EventUpdated se déclenche pour indiquer une modification d'é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 l'utilisation de nextSyncToken limite la réponse aux seuls événements qui ont changé depuis la dernière synchronisation.
  5. Examinez la réponse de la synchronisation pour savoir quels événements ont été mis à jour et faites en sorte que votre code réponde de manière appropriée. Par exemple, vous pouvez enregistrer la modification, mettre à jour une feuille de calcul, envoyer des notifications par e-mail ou effectuer d'autres actions.
  6. Mettez à jour le nextSyncToken que vous avez stocké pour ce calendrier avec celui renvoyé par la requête de synchronisation incrémentielle. Cela force la prochaine opération de synchronisation à ne renvoyer que les modifications les plus récentes.

EventUpdated

(installable)
authMode

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

FULL
calendarId

ID de chaîne de l'agenda dans lequel l'événement a été modifié.

susan@example.com
triggerUid

ID du déclencheur qui a produit cet événement.

4034124084959907503

Événements de modules complémentaires 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 déclenchés par le temps

Les déclencheurs horaires (également appelés déclencheurs d'horloge) permettent aux scripts de s'exécuter à une heure précise ou à un intervalle récurrent.

Déclencheur horaire (installable)
authMode

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

FULL
day-of-month

Entre 1 et 31.

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

7
hour

Entre 0 et 23.

23
minute

Entre 0 et 59.

59
month

Entre 1 et 12.

12
second

Entre 0 et 59.

59
timezone

Fuseau horaire.

UTC
triggerUid

ID du déclencheur qui a produit cet événement.

4034124084959907503
week-of-year

Entre 1 et 52.

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

52
year

L'année

2015