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

Script Service

Ce service fournit un accès aux déclencheurs de scripts et à la publication de scripts.

Classes

Nom	Brève description
`AuthMode`	Énumération identifiant les catégories de services autorisés qu'Apps Script peut exécuter via une fonction déclenchée.
`AuthorizationInfo`	Objet utilisé pour déterminer si l'utilisateur doit autoriser ce script à utiliser un ou plusieurs services, et pour fournir l'URL d'une boîte de dialogue d'autorisation.
`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 d'horloge.
`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 indiquant la manière dont 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`	Compilateur générique pour les déclencheurs de script.
`TriggerSource`	Énumération indiquant la source de l'événement qui déclenche l'activation du déclencheur.

`AuthMode`

Propriétés

Propriété	Type	Description
`NONE`	`Enum`	Mode qui n'autorise pas l'accès aux services nécessitant une autorisation.
`CUSTOM_FUNCTION`	`Enum`	Mode permettant d'accéder à un sous-ensemble limité de services à utiliser 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`	Récupère une valeur indiquant si l'utilisateur doit autoriser ce script à utiliser un ou plusieurs services (par exemple, `ScriptApp.AuthorizationStatus.REQUIRED`).
`getAuthorizationUrl()`	`String`	Récupère l'URL d'autorisation qui peut être utilisée pour accorder l'accès au 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 actuellement requises.

`CalendarTriggerBuilder`

Méthodes

Méthode	Type renvoyé	Brève description
`create()`	`Trigger`	Crée le déclencheur et l'affiche.
`onEventUpdated()`	`CalendarTriggerBuilder`	Spécifie un déclencheur qui s'active lorsqu'une entrée d'agenda est créée, mise à jour 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 d'exécution du déclencheur.
`at(date)`	`ClockTriggerBuilder`	Indique le moment où le déclencheur s'exécute.
`atDate(year, month, day)`	`ClockTriggerBuilder`	Indique que le déclencheur s'exécute à la date donnée, par défaut vers minuit (+/- 15 minutes).
`atHour(hour)`	`ClockTriggerBuilder`	Spécifie l'heure à laquelle le déclencheur s'exécute.
`create()`	`Trigger`	Crée le déclencheur.
`everyDays(n)`	`ClockTriggerBuilder`	Spécifie l'exécution du déclencheur tous les `n` jours.
`everyHours(n)`	`ClockTriggerBuilder`	Spécifie l'exécution du déclencheur toutes les `n` heures.
`everyMinutes(n)`	`ClockTriggerBuilder`	Spécifie l'exécution du déclencheur toutes les `n` minutes.
`everyWeeks(n)`	`ClockTriggerBuilder`	Spécifie l'exécution du déclencheur toutes les `n` semaines.
`inTimezone(timezone)`	`ClockTriggerBuilder`	Spécifie le fuseau horaire des dates/heures spécifiées d'exécution du déclencheur.
`nearMinute(minute)`	`ClockTriggerBuilder`	Spécifie la minute à laquelle le déclencheur s'exécute (plus ou moins 15 minutes).
`onMonthDay(day)`	`ClockTriggerBuilder`	Spécifie la date du mois d'exécution du déclencheur.
`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 affiche le nouveau déclencheur.
`onOpen()`	`DocumentTriggerBuilder`	Spécifie un déclencheur qui s'active lorsque le document est ouvert.

`EventType`

Propriétés

Propriété	Type	Description
`CLOCK`	`Enum`	Le déclencheur s'active une fois que l'événement basé sur le temps atteint un moment précis.
`ON_OPEN`	`Enum`	Le déclencheur s'active lorsque l'utilisateur ouvre le fichier Google Docs, Sheets ou Forms.
`ON_EDIT`	`Enum`	Le déclencheur s'active lorsque l'utilisateur modifie le fichier Google Sheets (par exemple, en saisissant une nouvelle valeur dans une cellule, ce qui n'est pas considéré comme une modification).
`ON_FORM_SUBMIT`	`Enum`	Le déclencheur s'active lorsque l'utilisateur répond à un formulaire Google Forms.
`ON_CHANGE`	`Enum`	Le déclencheur s'active lorsque l'utilisateur modifie le fichier Google Sheets (par exemple, en ajoutant une ligne, qui compte comme une modification plutôt que comme une modification).
`ON_EVENT_UPDATED`	`Enum`	Le déclencheur s'exécute une fois qu'un événement est créé, mis à jour ou supprimé dans l'agenda Google spécifié.

`FormTriggerBuilder`

Méthodes

Méthode	Type renvoyé	Brève description
`create()`	`Trigger`	Crée et affiche le nouveau déclencheur.
`onFormSubmit()`	`FormTriggerBuilder`	Spécifie un déclencheur qui s'active lorsqu'une réponse est envoyée au formulaire.
`onOpen()`	`FormTriggerBuilder`	Spécifie un déclencheur qui s'active lorsque la vue de modification 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 dans le domaine de l'utilisateur.
`NONE`	`Enum`	Le script n'est pas exécuté en tant que module complémentaire.
`WEB_STORE_ADD_ON`	`Enum`	L'utilisateur a installé le module complémentaire à partir du Chrome Web Store.

`ScriptApp`

Propriétés

Propriété	Type	Description
`AuthMode`	`AuthMode`	Énumération identifiant 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 la manière dont le script a été installé auprès de l'utilisateur en tant que module complémentaire.
`TriggerSource`	`TriggerSource`	Énumération indiquant la source de l'événement qui déclenche l'activation du 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`	Récupère un objet permettant de déterminer si l'utilisateur doit autoriser ce script à utiliser un ou plusieurs services, et pour fournir l'URL d'une boîte de dialogue d'autorisation.
`getIdentityToken()`	`String`	Récupère 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 la manière dont 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`	Récupère le jeton d'accès OAuth 2.0 de 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'identifiant unique du projet de script.
`getService()`	`Service`	Récupère un objet utilisé pour contrôler la publication du script en tant qu'application Web.
`getUserTriggers(document)`	`Trigger[]`	Récupère tous les déclencheurs installables appartenant à cet utilisateur dans le document donné, pour ce script ou ce module complémentaire uniquement.
`getUserTriggers(form)`	`Trigger[]`	Récupère tous les déclencheurs installables appartenant à cet utilisateur, sous la forme donnée, pour ce script ou ce module complémentaire uniquement.
`getUserTriggers(spreadsheet)`	`Trigger[]`	Récupère tous les déclencheurs installables appartenant à cet utilisateur dans la feuille de calcul donnée, pour ce script ou ce module complémentaire uniquement.
`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 qui peut ê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 exécuté, appelle une fonction donnée.

`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 l'affiche.
`onChange()`	`SpreadsheetTriggerBuilder`	Spécifie un déclencheur qui s'active lorsque le contenu ou la structure de la feuille de calcul est modifié.
`onEdit()`	`SpreadsheetTriggerBuilder`	Spécifie un déclencheur qui s'active lorsque la feuille de calcul est modifiée.
`onFormSubmit()`	`SpreadsheetTriggerBuilder`	Spécifie un déclencheur qui s'active lorsqu'un formulaire est envoyé à la feuille de calcul.
`onOpen()`	`SpreadsheetTriggerBuilder`	Spécifie un déclencheur qui s'active lorsque la feuille de calcul est 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) de validité du jeton.

`Trigger`

Méthodes

Méthode	Type renvoyé	Brève description
`getEventType()`	`EventType`	Renvoie le type d'événement pour lequel le déclencheur s'active.
`getHandlerFunction()`	`String`	Renvoie la fonction qui sera appelée lorsque le déclencheur est exécuté.
`getTriggerSource()`	`TriggerSource`	Renvoie la source des événements qui activeront le déclencheur.
`getTriggerSourceId()`	`String`	Renvoie l'ID spécifique à la source.
`getUniqueId()`	`String`	Renvoie un identifiant unique permettant de 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` lié au document donné.
`forDocument(key)`	`DocumentTriggerBuilder`	Crée et renvoie un `DocumentTriggerBuilder` lié au document avec l'ID donné.
`forForm(form)`	`FormTriggerBuilder`	Crée et renvoie un `FormTriggerBuilder` lié au formulaire donné.
`forForm(key)`	`FormTriggerBuilder`	Crée et renvoie un `FormTriggerBuilder` lié au formulaire avec l'ID donné.
`forSpreadsheet(sheet)`	`SpreadsheetTriggerBuilder`	Crée et renvoie un `SpreadsheetTriggerBuilder` lié à la feuille de calcul donnée.
`forSpreadsheet(key)`	`SpreadsheetTriggerBuilder`	Crée et renvoie un `SpreadsheetTriggerBuilder` lié à la feuille de calcul avec l'ID donné.
`forUserCalendar(emailId)`	`CalendarTriggerBuilder`	Renvoie un compilateur permettant de créer des déclencheurs d'agenda.
`timeBased()`	`ClockTriggerBuilder`	Crée et affiche un `ClockTriggerBuilder` pour la création de 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 basé sur le temps déclenche l'activation du déclencheur.
`FORMS`	`Enum`	Google Forms active le déclencheur.
`DOCUMENTS`	`Enum`	Google Docs active le déclencheur.
`CALENDAR`	`Enum`	Google Agenda active 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 2023/12/01 (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