Cette page a été traduite par l'API Cloud Translation.

Script Service

Ce service permet d'accéder aux déclencheurs de script et à la publication de scripts.

Classes

Nom	Brève description
`AuthMode`	Énumération qui identifie les catégories de services autorisés qu'Apps Script peut exécuter via une fonction déclenchée.
`AuthorizationInfo`	Objet qui vérifie si l'utilisateur a accordé l'autorisation pour les niveaux d'accès requis du script.
`AuthorizationStatus`	Énumération indiquant l'état d'autorisation d'un script.
`CalendarTriggerBuilder`	Compilateur pour les déclencheurs d'agenda.
`ClockTriggerBuilder`	Compilateur pour les déclencheurs horaires.
`DocumentTriggerBuilder`	Compilateur pour les déclencheurs de document.
`EventType`	Énumération indiquant le type d'événement déclenché.
`FormTriggerBuilder`	Compilateur pour les déclencheurs de formulaire.
`InstallationSource`	Énumération qui indique comment le script a été installé en tant que module complémentaire pour l'utilisateur actuel.
`ScriptApp`	Accéder à la publication de scripts et aux déclencheurs, et les manipuler.
`Service`	Accéder à la publication de scripts et la manipuler.
`SpreadsheetTriggerBuilder`	Compilateur pour les déclencheurs de feuille de calcul.
`StateTokenBuilder`	Permet aux scripts de créer des jetons d'état pouvant être utilisés dans les API de rappel (comme les flux OAuth).
`Trigger`	Déclencheur de script.
`TriggerBuilder`	Générateur générique pour les déclencheurs de script.
`TriggerSource`	Énumération indiquant la source de l'événement qui déclenche le déclencheur.

`AuthMode`

Propriétés

Propriété	Type	Description
`NONE`	`Enum`	Mode qui n'autorise l'accès à aucun service nécessitant une autorisation.
`CUSTOM_FUNCTION`	`Enum`	Mode qui permet d'accéder à un sous-ensemble limité de services pour une utilisation dans des fonctions de feuille de calcul personnalisées.
`LIMITED`	`Enum`	Mode qui permet d'accéder à un sous-ensemble limité de services.
`FULL`	`Enum`	Mode qui permet d'accéder à tous les services nécessitant une autorisation.

`AuthorizationInfo`

Méthodes

Méthode	Type renvoyé	Brève description
`getAuthorizationStatus()`	`AuthorizationStatus`	Obtient une valeur qui indique si l'utilisateur doit autoriser ce script à utiliser un ou plusieurs services (par exemple, `ScriptApp.AuthorizationStatus.REQUIRED`).
`getAuthorizationUrl()`	`String\|null`	Obtient l'URL d'autorisation qui peut être utilisée pour accorder l'accès au script.
`getAuthorizedScopes()`	`String[]\|null`	Obtient la liste des champs d'application autorisés pour le script.

`AuthorizationStatus`

Propriétés

Propriété	Type	Description
`REQUIRED`	`Enum`	L'utilisateur doit autoriser ce script à utiliser un ou plusieurs services.
`NOT_REQUIRED`	`Enum`	L'utilisateur a accordé à ce script toutes les autorisations dont il a besoin pour le moment.

`CalendarTriggerBuilder`

Méthodes

Méthode	Type renvoyé	Brève description
`create()`	`Trigger`	Crée le déclencheur et le renvoie.
`onEventUpdated()`	`CalendarTriggerBuilder`	Spécifie un déclencheur qui se déclenche lorsqu'une entrée d'agenda est créée, modifiée ou supprimée.

`ClockTriggerBuilder`

Méthodes

Méthode	Type renvoyé	Brève description
`after(durationMilliseconds)`	`ClockTriggerBuilder`	Spécifie la durée minimale (en millisecondes) après l'heure actuelle à laquelle le déclencheur s'exécute.
`at(date)`	`ClockTriggerBuilder`	Indique quand le déclencheur s'exécute.
`atDate(year, month, day)`	`ClockTriggerBuilder`	Indique que le déclencheur se déclenche à la date indiquée, par défaut vers minuit (+/- 15 minutes).
`atHour(hour)`	`ClockTriggerBuilder`	Indique l'heure à laquelle le déclencheur s'exécute.
`create()`	`Trigger`	Crée le déclencheur.
`everyDays(n)`	`ClockTriggerBuilder`	Spécifie d'exécuter le déclencheur tous les `n` jours.
`everyHours(n)`	`ClockTriggerBuilder`	Indique que le déclencheur doit s'exécuter toutes les `n` heures.
`everyMinutes(n)`	`ClockTriggerBuilder`	Spécifie d'exécuter le déclencheur toutes les `n` minutes.
`everyWeeks(n)`	`ClockTriggerBuilder`	Spécifie d'exécuter le déclencheur toutes les `n` semaines.
`inTimezone(timezone)`	`ClockTriggerBuilder`	Indique le fuseau horaire des dates/heures spécifiées lorsque le déclencheur s'exécute.
`nearMinute(minute)`	`ClockTriggerBuilder`	Indique la minute à laquelle le déclencheur s'exécute (plus ou moins 15 minutes).
`onMonthDay(day)`	`ClockTriggerBuilder`	Spécifie le jour du mois où le déclencheur s'exécute.
`onWeekDay(day)`	`ClockTriggerBuilder`	Spécifie le jour de la semaine où le déclencheur s'exécute.

`DocumentTriggerBuilder`

Méthodes

Méthode	Type renvoyé	Brève description
`create()`	`Trigger`	Crée et renvoie le nouveau déclencheur.
`onOpen()`	`DocumentTriggerBuilder`	Spécifie un déclencheur qui s'activera lorsque le document sera ouvert.

`EventType`

Propriétés

Propriété	Type	Description
`CLOCK`	`Enum`	Le déclencheur se déclenche une fois que l'événement temporel atteint une heure spécifique.
`ON_OPEN`	`Enum`	Le déclencheur se déclenche une fois que l'utilisateur a ouvert le fichier Google Docs, Sheets ou Forms.
`ON_EDIT`	`Enum`	Le déclencheur se déclenche une fois que l'utilisateur a modifié le fichier Google Sheets (par exemple, en saisissant une nouvelle valeur dans une cellule, ce qui est considéré comme une modification et non comme un changement).
`ON_FORM_SUBMIT`	`Enum`	Le déclencheur s'active une fois que l'utilisateur a répondu à un formulaire Google.
`ON_CHANGE`	`Enum`	Le déclencheur s'active une fois que l'utilisateur a modifié le fichier Google Sheets (par exemple, en ajoutant une ligne, ce qui est considéré comme une modification et non comme une édition).
`ON_EVENT_UPDATED`	`Enum`	Le déclencheur se déclenche lorsqu'un événement est créé, modifié ou supprimé dans l'agenda Google spécifié.

`FormTriggerBuilder`

Méthodes

Méthode	Type renvoyé	Brève description
`create()`	`Trigger`	Crée et renvoie le nouveau déclencheur.
`onFormSubmit()`	`FormTriggerBuilder`	Spécifie un déclencheur qui se déclenchera lorsqu'une réponse sera envoyée au formulaire.
`onOpen()`	`FormTriggerBuilder`	Spécifie un déclencheur qui se déclenche lorsque la vue d'édition du formulaire est ouverte.

`InstallationSource`

Propriétés

Propriété	Type	Description
`APPS_MARKETPLACE_DOMAIN_ADD_ON`	`Enum`	Le module complémentaire a été installé par l'administrateur pour le domaine de l'utilisateur.
`NONE`	`Enum`	Le script ne s'exécute pas en tant que module complémentaire.
`WEB_STORE_ADD_ON`	`Enum`	Le module complémentaire a été installé par l'utilisateur depuis le Chrome Web Store.

`ScriptApp`

Propriétés

Propriété	Type	Description
`AuthMode`	`AuthMode`	Énumération qui identifie les catégories de services autorisés qu'Apps Script peut exécuter via une fonction déclenchée.
`AuthorizationStatus`	`AuthorizationStatus`	Énumération indiquant l'état d'autorisation d'un script.
`EventType`	`EventType`	Énumération indiquant le type d'événement déclenché.
`InstallationSource`	`InstallationSource`	Énumération indiquant comment le script a été installé pour l'utilisateur en tant que module complémentaire.
`TriggerSource`	`TriggerSource`	Énumération indiquant la source de l'événement qui déclenche le déclencheur.
`WeekDay`	`Weekday`	Énumération représentant les jours de la semaine.

Méthodes

Méthode	Type renvoyé	Brève description
`deleteTrigger(trigger)`	`void`	Supprime le déclencheur donné afin qu'il ne s'exécute plus.
`getAuthorizationInfo(authMode)`	`AuthorizationInfo`	Obtient un objet qui vérifie si l'utilisateur a accordé l'autorisation pour toutes les exigences du script.
`getAuthorizationInfo(authMode, oAuthScopes)`	`AuthorizationInfo`	Obtient un objet qui vérifie si l'utilisateur a accordé l'autorisation pour les champs d'application demandés.
`getIdentityToken()`	`String\|null`	Obtient un jeton d'identité OpenID Connect pour l'utilisateur effectif, si le champ d'application `openid` a été accordé.
`getInstallationSource()`	`InstallationSource`	Renvoie une valeur d'énumération qui indique comment le script a été installé en tant que module complémentaire pour l'utilisateur actuel (par exemple, si l'utilisateur l'a installé personnellement via le Chrome Web Store ou si un administrateur de domaine l'a installé pour tous les utilisateurs).
`getOAuthToken()`	`String`	Obtient le jeton d'accès OAuth 2.0 pour l'utilisateur effectif.
`getProjectTriggers()`	`Trigger[]`	Récupère tous les déclencheurs installables associés au projet et à l'utilisateur actuels.
`getScriptId()`	`String`	Récupère l'ID unique du projet de script.
`getService()`	`Service`	Obtient un objet utilisé pour contrôler la publication du script en tant qu'application Web.
`getUserTriggers(document)`	`Trigger[]`	Renvoie tous les déclencheurs installables appartenant à cet utilisateur dans le document donné, uniquement pour ce script ou ce module complémentaire.
`getUserTriggers(form)`	`Trigger[]`	Renvoie tous les déclencheurs installables appartenant à cet utilisateur dans le formulaire donné, uniquement pour ce script ou ce module complémentaire.
`getUserTriggers(spreadsheet)`	`Trigger[]`	Récupère tous les déclencheurs installables appartenant à cet utilisateur dans la feuille de calcul donnée, uniquement pour ce script ou ce module complémentaire.
`invalidateAuth()`	`void`	Invalide l'autorisation dont dispose l'utilisateur effectif pour exécuter le script actuel.
`newStateToken()`	`StateTokenBuilder`	Crée un compilateur pour un jeton d'état pouvant être utilisé dans une API de rappel (comme un flux OAuth).
`newTrigger(functionName)`	`TriggerBuilder`	Démarre le processus de création d'un déclencheur installable qui, lorsqu'il est déclenché, appelle une fonction donnée.
`requireAllScopes(authMode)`	`void`	Valide si l'utilisateur a donné son consentement pour tous les niveaux d'accès demandés par le script.
`requireScopes(authMode, oAuthScopes)`	`void`	Valide si l'utilisateur a donné son consentement pour les niveaux d'accès demandés.

`Service`

Méthodes

Méthode	Type renvoyé	Brève description
`getUrl()`	`String`	Renvoie l'URL de l'application Web si elle a été déployée, sinon renvoie `null`.
`isEnabled()`	`Boolean`	Renvoie `true` si le script est accessible en tant qu'application Web.

`SpreadsheetTriggerBuilder`

Méthodes

Méthode	Type renvoyé	Brève description
`create()`	`Trigger`	Crée le déclencheur et le renvoie.
`onChange()`	`SpreadsheetTriggerBuilder`	Spécifie un déclencheur qui se déclenche lorsque le contenu ou la structure de la feuille de calcul sont modifiés.
`onEdit()`	`SpreadsheetTriggerBuilder`	Spécifie un déclencheur qui s'activera lorsque la feuille de calcul sera modifiée.
`onFormSubmit()`	`SpreadsheetTriggerBuilder`	Spécifie un déclencheur qui se déclenche lorsqu'un formulaire est envoyé à la feuille de calcul.
`onOpen()`	`SpreadsheetTriggerBuilder`	Spécifie un déclencheur qui s'activera lorsque la feuille de calcul sera ouverte.

`StateTokenBuilder`

Méthodes

Méthode	Type renvoyé	Brève description
`createToken()`	`String`	Construit une représentation sous forme de chaîne chiffrée du jeton d'état.
`withArgument(name, value)`	`StateTokenBuilder`	Ajoute un argument au jeton.
`withMethod(method)`	`StateTokenBuilder`	Définit une fonction de rappel.
`withTimeout(seconds)`	`StateTokenBuilder`	Définit la durée (en secondes) pendant laquelle le jeton est valide.

`Trigger`

Méthodes

Méthode	Type renvoyé	Brève description
`getEventType()`	`EventType`	Renvoie le type d'événement sur lequel le déclencheur s'active.
`getHandlerFunction()`	`String`	Renvoie la fonction qui sera appelée lorsque le déclencheur sera activé.
`getTriggerSource()`	`TriggerSource`	Affiche la source des événements qui déclencheront le déclencheur.
`getTriggerSourceId()`	`String`	Renvoie l'ID spécifique à la source.
`getUniqueId()`	`String`	Renvoie un identifiant unique qui peut être utilisé pour distinguer les déclencheurs les uns des autres.

`TriggerBuilder`

Méthodes

Méthode	Type renvoyé	Brève description
`forDocument(document)`	`DocumentTriggerBuilder`	Crée et renvoie un `DocumentTriggerBuilder` associé au document donné.
`forDocument(key)`	`DocumentTriggerBuilder`	Crée et renvoie un `DocumentTriggerBuilder` associé au document dont l'ID est spécifié.
`forForm(form)`	`FormTriggerBuilder`	Crée et renvoie un `FormTriggerBuilder` associé au formulaire donné.
`forForm(key)`	`FormTriggerBuilder`	Crée et renvoie un `FormTriggerBuilder` associé au formulaire avec l'ID donné.
`forSpreadsheet(sheet)`	`SpreadsheetTriggerBuilder`	Crée et renvoie un `SpreadsheetTriggerBuilder` associé à la feuille de calcul donnée.
`forSpreadsheet(key)`	`SpreadsheetTriggerBuilder`	Crée et renvoie un `SpreadsheetTriggerBuilder` associé à la feuille de calcul avec l'ID donné.
`forUserCalendar(emailId)`	`CalendarTriggerBuilder`	Renvoie un générateur pour créer des déclencheurs d'agenda.
`timeBased()`	`ClockTriggerBuilder`	Crée et renvoie un `ClockTriggerBuilder` pour créer des déclencheurs temporels.

`TriggerSource`

Propriétés

Propriété	Type	Description
`SPREADSHEETS`	`Enum`	Google Sheets déclenche le déclencheur.
`CLOCK`	`Enum`	Un événement temporel déclenche le déclencheur.
`FORMS`	`Enum`	Google Forms déclenche le déclencheur.
`DOCUMENTS`	`Enum`	Google Docs déclenche le déclencheur.
`CALENDAR`	`Enum`	Google Agenda déclenche le déclencheur.

Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.

Dernière mise à jour le 2025/12/11 (UTC).

Blog
Lire le blog des développeurs Google Workspace
Stack Overflow
Poser une question sous le tag google-apps-script
Exemples de code
Explorez nos exemples de code ou copiez-les pour créer les vôtres
Vidéos
Regarder les tutoriels Apps Script