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 script.

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 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 horaires.
`DocumentTriggerBuilder`	Générateur de déclencheurs de documents.
`EventType`	Énumération indiquant le type d'événement déclenché.
`FormTriggerBuilder`	Compilateur pour les déclencheurs de formulaire.
`InstallationSource`	Énumération indiquant comment le script a été installé en tant que module complémentaire pour l'utilisateur actuel.
`ScriptApp`	Accéder et manipuler la publication et les déclencheurs de script.
`Service`	Accédez à la publication de script et manipulez-la.
`SpreadsheetTriggerBuilder`	Outil de création de déclencheurs de feuilles 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`	Un déclencheur de script.
`TriggerBuilder`	Un compilateur 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 pas l'accès à des services nécessitant une autorisation.
`CUSTOM_FUNCTION`	`Enum`	Mode qui permet d'accéder à un sous-ensemble limité de services à utiliser dans les 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 qui indique 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 permettant d'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 dont il a actuellement besoin.

`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, 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 pendant 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 donné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 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`	Indique que le déclencheur doit s'exécuter toutes les `n` semaines.
`inTimezone(timezone)`	`ClockTriggerBuilder`	Spécifie le fuseau horaire pour les 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 la date du mois à laquelle le déclencheur s'exécute.
`onWeekDay(day)`	`ClockTriggerBuilder`	Indique 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 se déclenchera 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 basé sur le temps atteint un moment spécifique.
`ON_OPEN`	`Enum`	Le déclencheur se déclenche lorsque l'utilisateur ouvre le fichier Google Docs, Sheets ou Forms.
`ON_EDIT`	`Enum`	Le déclencheur se déclenche une fois que l'utilisateur modifie le fichier Google Sheets (par exemple, en saisissant une nouvelle valeur dans une cellule, ce qui est considéré comme une modification plutôt qu'un changement).
`ON_FORM_SUBMIT`	`Enum`	Le déclencheur se déclenche une fois que l'utilisateur a répondu à un formulaire Google.
`ON_CHANGE`	`Enum`	Le déclencheur se déclenche une fois que l'utilisateur modifie le fichier Google Sheets (par exemple, en ajoutant une ligne, ce qui est considéré comme une modification plutôt qu'une modification).
`ON_EVENT_UPDATED`	`Enum`	Le déclencheur se déclenche lorsqu'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 se déclenchera lorsqu'une réponse sera envoyée au formulaire.
`onOpen()`	`FormTriggerBuilder`	Spécifie un déclencheur qui se déclenchera lorsque la vue de modification du formulaire sera 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`	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 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é en tant que module complémentaire pour l'utilisateur.
`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`	Récupère un 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.
`getIdentityToken()`	`String`	Récupère un jeton d'identité OpenIDConnect pour l'utilisateur effectif, si le champ d'application `openid` a été accordé.
`getInstallationSource()`	`InstallationSource`	Renvoie une valeur d'énumération indiquant comment le script a été installé en tant qu'add-on 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'ID 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 dans le formulaire donné, 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`	Annule l'autorisation dont dispose l'utilisateur effectif pour exécuter le script en cours.
`newStateToken()`	`StateTokenBuilder`	Crée un constructeur pour un jeton d'état pouvant être utilisé dans une API de rappel (comme un flux OAuth).
`newTrigger(functionName)`	`TriggerBuilder`	Lance le processus de création d'un déclencheur installable qui, lorsqu'il est déclenché, 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 le renvoie.
`onChange()`	`SpreadsheetTriggerBuilder`	Spécifie un déclencheur qui se déclenchera lorsque le contenu ou la structure de la feuille de calcul sera modifié.
`onEdit()`	`SpreadsheetTriggerBuilder`	Indique un déclencheur qui se déclenchera lorsque la feuille de calcul sera modifiée.
`onFormSubmit()`	`SpreadsheetTriggerBuilder`	Spécifie un déclencheur qui se déclenchera lorsqu'un formulaire sera envoyé à la feuille de calcul.
`onOpen()`	`SpreadsheetTriggerBuilder`	Spécifie un déclencheur qui se déclenchera lorsque la feuille de calcul sera ouverte.

`StateTokenBuilder`

Méthodes

Méthode	Type renvoyé	Brève description
`createToken()`	`String`	Construit une représentation chiffrée de la chaîne 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`	Indique le type d'événement sur lequel le déclencheur se déclenche.
`getHandlerFunction()`	`String`	Renvoie la fonction qui sera appelée lorsque le déclencheur se déclenchera.
`getTriggerSource()`	`TriggerSource`	Indique la source des événements qui déclencheront le déclencheur.
`getTriggerSourceId()`	`String`	Renvoie l'ID propre à la source.
`getUniqueId()`	`String`	Renvoie un identifiant unique qui permet 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` associé au document donné.
`forDocument(key)`	`DocumentTriggerBuilder`	Crée et renvoie un `DocumentTriggerBuilder` associé au document avec l'ID donné.
`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 permettant de créer des déclencheurs d'agenda.
`timeBased()`	`ClockTriggerBuilder`	Crée et renvoie un `ClockTriggerBuilder` pour créer des déclencheurs basés sur le temps.

`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 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 2024/12/03 (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