Script Service

Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.
Script

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

Classes

NomBrè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.
AuthorizationInfoObjet permettant de déterminer si l'utilisateur doit autoriser ce script à utiliser un ou plusieurs services et à fournir l'URL d'une boîte de dialogue d'autorisation.
AuthorizationStatusÉnumération indiquant l'état d'autorisation d'un script.
CalendarTriggerBuilderOutil de création des déclencheurs d'agenda.
ClockTriggerBuilderOutil de création d'horloge.
DocumentTriggerBuilderOutil de création pour les déclencheurs de document
EventTypeÉnumération indiquant le type d'événement déclenché.
FormTriggerBuilderOutil de création des déclencheurs de formulaires.
InstallationSourceÉnumération indiquant comment le script a été installé en tant que module complémentaire pour l'utilisateur actuel.
ScriptAppAccéder à des publications et déclencheurs de script, et les manipuler
ServiceAccéder à la publication de scripts et la manipuler.
SpreadsheetTriggerBuilderOutil de création des déclencheurs de la feuille de calcul.
StateTokenBuilderPermet aux scripts de créer des jetons d'état pouvant être utilisés dans les API de rappel (telles que les flux OAuth).
TriggerDéclencheur de script.
TriggerBuilderOutil de création 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éTypeDescription
NONEEnumMode n'autorisant pas l'accès aux services nécessitant une autorisation.
CUSTOM_FUNCTIONEnumMode autorisant l'accès à un sous-ensemble limité de services à utiliser dans des fonctions de feuille de calcul personnalisées.
LIMITEDEnumMode autorisant l'accès à un sous-ensemble limité de services.
FULLEnumMode autorisant l'accès à tous les services nécessitant une autorisation.

AuthorizationInfo

Méthodes

MéthodeType renvoyéBrève description
getAuthorizationStatus()AuthorizationStatusRécupère une valeur qui indique si l'utilisateur doit autoriser ce script à utiliser un ou plusieurs services (par exemple, ScriptApp.AuthorizationStatus.REQUIRED).
getAuthorizationUrl()StringRécupère l'URL d'autorisation permettant d'accorder l'accès au script.

AuthorizationStatus

Propriétés

PropriétéTypeDescription
REQUIREDEnumL'utilisateur doit autoriser ce script à utiliser un ou plusieurs services.
NOT_REQUIREDEnumL'utilisateur a accordé à ce script toutes les autorisations requises.

CalendarTriggerBuilder

Méthodes

MéthodeType renvoyéBrève description
create()TriggerCrée le déclencheur et le renvoie.
onEventUpdated()CalendarTriggerBuilderSpécifie un déclencheur qui se déclenche lors de la création, la mise à jour ou la suppression d'une entrée d'agenda.

ClockTriggerBuilder

Méthodes

MéthodeType renvoyéBrève description
after(durationMilliseconds)ClockTriggerBuilderIndique la durée minimale (en millisecondes) après l'heure actuelle d'exécution du déclencheur.
at(date)ClockTriggerBuilderIndique le moment où le déclencheur s'exécute.
atDate(year, month, day)ClockTriggerBuilderIndique que le déclencheur s'exécute à la date donnée, par défaut vers minuit (+/- 15 minutes).
atHour(hour)ClockTriggerBuilderIndique l'heure à laquelle le déclencheur s'exécute.
create()TriggerCrée le déclencheur.
everyDays(n)ClockTriggerBuilderIndique d'exécuter le déclencheur tous les n jours.
everyHours(n)ClockTriggerBuilderIndique d'exécuter le déclencheur toutes les n heures.
everyMinutes(n)ClockTriggerBuilderSpécifie d'exécuter le déclencheur toutes les n minutes.
everyWeeks(n)ClockTriggerBuilderIndique d'exécuter le déclencheur toutes les n semaines.
inTimezone(timezone)ClockTriggerBuilderIndique le fuseau horaire des dates et heures spécifiées lors de l'exécution du déclencheur.
nearMinute(minute)ClockTriggerBuilderIndique la minute à laquelle le déclencheur s'exécute (plus ou moins 15 minutes).
onMonthDay(day)ClockTriggerBuilderIndique la date du mois au cours duquel le déclencheur s'exécute.
onWeekDay(day)ClockTriggerBuilderIndique le jour de la semaine pendant lequel le déclencheur est exécuté.

DocumentTriggerBuilder

Méthodes

MéthodeType renvoyéBrève description
create()TriggerCrée et renvoie le nouveau déclencheur.
onOpen()DocumentTriggerBuilderSpécifie un déclencheur qui s'active lorsque le document est ouvert.

EventType

Propriétés

PropriétéTypeDescription
CLOCKEnumLe déclencheur s'active lorsque l'événement associé à une période atteint une heure spécifique.
ON_OPENEnumLe déclencheur s'active lorsque l'utilisateur ouvre le fichier Google Docs, Sheets ou Forms.
ON_EDITEnumLe déclencheur s'active lorsque l'utilisateur modifie le fichier Google Sheets (par exemple, en saisissant une nouvelle valeur dans une cellule, ce qui compte comme une modification et non comme une modification).
ON_FORM_SUBMITEnumLe déclencheur s'active lorsque l'utilisateur répond à un formulaire Google Forms.
ON_CHANGEEnumLe déclencheur s'active lorsque l'utilisateur modifie le fichier Google Sheets (par exemple, en ajoutant une ligne, ce qui compte comme une modification et non comme une modification).
ON_EVENT_UPDATEDEnumLe déclencheur s'active lorsqu'un événement est créé, mis à jour ou supprimé dans l'agenda Google spécifié.

FormTriggerBuilder

Méthodes

MéthodeType renvoyéBrève description
create()TriggerCrée et renvoie le nouveau déclencheur.
onFormSubmit()FormTriggerBuilderSpécifie un déclencheur qui s'active lorsqu'une réponse est envoyée au formulaire.
onOpen()FormTriggerBuilderSpécifie un déclencheur qui s'active lorsque la fenêtre de modification du formulaire est ouverte.

InstallationSource

Propriétés

PropriétéTypeDescription
APPS_MARKETPLACE_DOMAIN_ADD_ONEnumLe module complémentaire a été installé par l'administrateur du domaine de l'utilisateur.
NONEEnumLe script n'est pas exécuté en tant que module complémentaire.
WEB_STORE_ADD_ONEnumLe module complémentaire a été installé par l'utilisateur à partir du Chrome Web Store.

ScriptApp

Propriétés

PropriétéTypeDescription
AuthModeAuthModeÉnumération identifiant les catégories de services autorisés qu'Apps Script peut exécuter via une fonction déclenchée.
AuthorizationStatusAuthorizationStatusÉnumération indiquant l'état d'autorisation d'un script.
EventTypeEventTypeÉnumération indiquant le type d'événement déclenché.
InstallationSourceInstallationSourceÉnumération indiquant comment le script a été installé pour l'utilisateur en tant que module complémentaire.
TriggerSourceTriggerSourceÉnumération indiquant la source de l'événement qui déclenche le déclencheur.
WeekDayWeekdayÉnumération représentant les jours de la semaine.

Méthodes

MéthodeType renvoyéBrève description
deleteTrigger(trigger)voidSupprime le déclencheur donné pour qu'il ne s'exécute plus.
getAuthorizationInfo(authMode)AuthorizationInfoRé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()StringRécupère un jeton d'identité OpenID Connect pour l'utilisateur effectif si le champ d'application openid a été accordé.
getInstallationSource()InstallationSourceRenvoie 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()StringRécupère 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()StringRécupère l'identifiant unique du projet.
getService()ServiceRécupère un objet permettant de 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()voidAnnule l'autorisation dont dispose l'utilisateur effectif pour exécuter le script actuel.
newStateToken()StateTokenBuilderCrée un compilateur pour un jeton d'état qui peut être utilisé dans une API de rappel (par exemple, un flux OAuth).
newTrigger(functionName)TriggerBuilderDémarre 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éthodeType renvoyéBrève description
getUrl()StringRenvoie l'URL de l'application Web, si elle a été déployée. Sinon, renvoie null.
isEnabled()BooleanRenvoie true si le script est accessible en tant qu'application Web.

SpreadsheetTriggerBuilder

Méthodes

MéthodeType renvoyéBrève description
create()TriggerCrée le déclencheur et le renvoie.
onChange()SpreadsheetTriggerBuilderSpécifie un déclencheur qui s'active lorsque le contenu ou la structure de la feuille de calcul est modifié.
onEdit()SpreadsheetTriggerBuilderSpécifie un déclencheur qui s'active lorsque la feuille de calcul est modifiée.
onFormSubmit()SpreadsheetTriggerBuilderSpécifie un déclencheur qui s'active lorsque la feuille de calcul comporte un formulaire.
onOpen()SpreadsheetTriggerBuilderSpécifie un déclencheur qui s'active lorsque la feuille de calcul est ouverte.

StateTokenBuilder

Méthodes

MéthodeType renvoyéBrève description
createToken()StringConstruit une chaîne chiffrée du jeton d'état.
withArgument(name, value)StateTokenBuilderAjoute un argument au jeton.
withMethod(method)StateTokenBuilderDéfinit une fonction de rappel.
withTimeout(seconds)StateTokenBuilderDéfinit la durée (en secondes) de validité du jeton.

Trigger

Méthodes

MéthodeType renvoyéBrève description
getEventType()EventTypeRenvoie le type d'événement associé au déclencheur.
getHandlerFunction()StringRenvoie la fonction qui est appelée lorsque le déclencheur est exécuté.
getTriggerSource()TriggerSourceRenvoie la source des événements qui activeront le déclencheur.
getTriggerSourceId()StringRenvoie l'ID propre à la source.
getUniqueId()StringRenvoie un identifiant unique permettant de distinguer les déclencheurs les uns des autres.

TriggerBuilder

Méthodes

MéthodeType renvoyéBrève description
forDocument(document)DocumentTriggerBuilderCrée et renvoie un objet DocumentTriggerBuilder lié au document donné.
forDocument(key)DocumentTriggerBuilderCrée et renvoie un DocumentTriggerBuilder lié au document avec l'ID donné.
forForm(form)FormTriggerBuilderCrée et renvoie un FormTriggerBuilder lié au formulaire donné.
forForm(key)FormTriggerBuilderCrée et renvoie un FormTriggerBuilder lié au formulaire avec l'ID donné.
forSpreadsheet(sheet)SpreadsheetTriggerBuilderCrée et renvoie un SpreadsheetTriggerBuilder associé à la feuille de calcul donnée.
forSpreadsheet(key)SpreadsheetTriggerBuilderCrée et renvoie un SpreadsheetTriggerBuilder associé à la feuille de calcul avec l'ID donné.
forUserCalendar(emailId)CalendarTriggerBuilderRenvoie un compilateur permettant de créer des déclencheurs d'agenda.
timeBased()ClockTriggerBuilderCrée et renvoie un ClockTriggerBuilder pour créer des déclencheurs basés sur l'heure.

TriggerSource

Propriétés

PropriétéTypeDescription
SPREADSHEETSEnumGoogle Sheets déclenche le déclencheur.
CLOCKEnumUn déclencheur basé sur l'heure déclenche le déclencheur.
FORMSEnumGoogle Forms déclenche le déclencheur.
DOCUMENTSEnumGoogle Docs déclenche le déclencheur.
CALENDAREnumGoogle Agenda active le déclencheur.