Les déclencheurs simples et les déclencheurs installables permettent à Apps Script d'exécuter automatiquement une fonction si un événement spécifique 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 qui a déclenché le déclencheur. Par exemple, l'exemple de code ci-dessous montre un déclencheur onEdit(e)
simple 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é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 |
Une valeur de l'énumération LIMITED |
source |
Un objet Spreadsheet |
triggerUid |
ID du déclencheur ayant généré cet événement (déclencheurs installables uniquement). 4034124084959907503 |
user |
Un objet amin@example.com |
Changement(installable) |
|
---|---|
authMode |
Une valeur de l'énumération FULL |
changeType |
Type de modification ( INSERT_ROW |
source |
Un objet
Spreadsheet |
triggerUid |
ID du déclencheur ayant généré cet événement. 4034124084959907503 |
user |
Un objet amin@example.com |
Modifier(simple et installable) |
|
---|---|
authMode |
Une valeur de l'énumération LIMITED |
oldValue |
Valeur de la cellule avant la modification, le cas échéant. Disponible uniquement si la plage modifiée est une cellule unique. Ne sera pas définie si la cellule ne contenait aucun contenu précédent. 1234 |
range |
Un objet Range |
source |
Un objet Spreadsheet |
triggerUid |
ID du déclencheur ayant généré cet événement (déclencheurs installables uniquement). 4034124084959907503 |
user |
Un objet amin@example.com |
value |
Nouvelle valeur de cellule après la modification. Disponible uniquement si la plage modifiée est une cellule unique. 10 |
Envoi de formulaire(installable) |
|
---|---|
authMode |
Une valeur de l'énumération 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 |
triggerUid |
ID du déclencheur ayant généré cet événement. 4034124084959907503 |
values |
Tableau avec des valeurs dans le même ordre que celui affiché 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 |
Une valeur de l'énumération LIMITED |
source |
Un objet Document |
triggerUid |
ID du déclencheur ayant généré cet événement (déclencheurs installables uniquement). 4034124084959907503 |
user |
Un objet 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 |
Une valeur de l'énumération LIMITED |
source |
Un objet Presentation |
user |
Un objet 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 |
Une valeur de l'énumération LIMITED |
source |
Un objet Form |
triggerUid |
ID du déclencheur ayant généré cet événement (déclencheurs installables uniquement). 4034124084959907503 |
user |
Un objet amin@example.com |
* Cet événement ne se produit pas lorsqu'un utilisateur ouvre un formulaire pour répondre, mais lorsqu'un éditeur ouvre le formulaire pour le modifier.
Envoi de formulaire(installable) |
|
---|---|
authMode |
Une valeur de l'énumération FULL |
response |
Un objet FormResponse |
source |
Un objet Form |
triggerUid |
ID du déclencheur ayant généré cet événement. 4034124084959907503 |
Événements Google Agenda
Les déclencheurs d'Agenda se déclenchent lorsque des é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 de quelle manière. Elles indiquent plutôt 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 de l'API Calendar.
Pour effectuer une synchronisation avec Google Agenda dans Apps Script, procédez comme suit:
- Activez le service avancé des agendas pour le projet de script. Le service Agenda intégré n'est pas suffisant pour ce workflow.
- Déterminez les agendas à synchroniser. Pour chacun de ces agendas, effectuez une synchronisation préliminaire à l'aide de la méthode Events.list() du service avancé d'Agenda.
- Le résultat de la synchronisation initiale renvoie un
nextSyncToken
pour cet agenda. Stockez ce jeton pour une utilisation ultérieure. - Lorsque le déclencheur
EventUpdated
d'Apps Script s'exécute pour indiquer une modification d'événement d'agenda, effectuez une synchronisation incrémentielle pour l'agenda concerné à l'aide de lanextSyncToken
stockée. Il s'agit essentiellement d'une autre requête Events.list(), mais la spécification denextSyncToken
limite uniquement la réponse aux événements qui ont changé depuis la dernière synchronisation. - Examinez la réponse de la synchronisation pour connaître les événements 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.
- Mettez à jour le
nextSyncToken
que vous avez stocké pour cet agenda 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.
Événement mis à jour(installable) |
|
---|---|
authMode |
Une valeur de l'énumération FULL |
calendarId |
Identifiant de chaîne de l'agenda dans lequel l'événement a été mis à jour. susan@example.com |
triggerUid |
ID du déclencheur ayant généré cet événement. 4034124084959907503 |
Événements complémentaires
Le déclencheur onInstall()
s'exécute automatiquement lorsqu'un utilisateur installe un module complémentaire.
Installer(simple) |
|
---|---|
authMode |
Une valeur de l'énumération FULL |
Événements temporels
Les déclencheurs basés sur le temps (également appelés déclencheurs d'horloge) permettent aux scripts de s'exécuter à un moment précis ou à des intervalles réguliers.
Déclencheur horaire (installation) | |
---|---|
authMode |
Une valeur de l'énumération FULL |
day-of-month |
Entre Comme ce nom de propriété contient des tirets, il doit être accessible via 31 |
day-of-week |
Entre Comme ce nom de propriété contient des tirets, il doit être accessible via 7 |
hour |
Entre 23 |
minute |
Entre 59 |
month |
Entre 12 |
second |
Entre 59 |
timezone |
Fuseau horaire. UTC |
triggerUid |
ID du déclencheur ayant généré cet événement. 4034124084959907503 |
week-of-year |
Entre Comme ce nom de propriété contient des tirets, il doit être accessible via 52 |
year |
L'année 2015 |