Script Service

Script

Ce service fournit un accès aux déclencheurs de scripts 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 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.
CalendarTriggerBuilderCompilateur pour les déclencheurs d'agenda.
ClockTriggerBuilderCompilateur pour les déclencheurs d'horloge.
DocumentTriggerBuilderCompilateur pour les déclencheurs de document.
EventTypeÉnumération indiquant le type d'événement déclenché.
FormTriggerBuilderCompilateur 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.
ScriptAppAccéder à la publication de scripts et aux déclencheurs, et les manipuler
ServiceAccéder à la publication de scripts et la manipuler
SpreadsheetTriggerBuilderCompilateur pour les déclencheurs de feuille de calcul.
StateTokenBuilderPermet aux scripts de créer des jetons d'état pouvant être utilisés dans les API de rappel (comme les flux OAuth).
TriggerDéclencheur de script.
TriggerBuilderCompilateur 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éTypeDescription
NONEEnumMode qui n'autorise pas l'accès aux services nécessitant une autorisation.
CUSTOM_FUNCTIONEnumMode permettant d'accéder à un sous-ensemble limité de services à utiliser dans des fonctions de feuille de calcul personnalisées.
LIMITEDEnumMode qui permet d'accéder à un sous-ensemble limité de services.
FULLEnumMode qui permet d'accéder à tous les services nécessitant une autorisation.

AuthorizationInfo

Méthodes

MéthodeType renvoyéBrève description
getAuthorizationStatus()AuthorizationStatusRécupère une valeur indiquant 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 qui peut être utilisée pour 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 actuellement requises.

CalendarTriggerBuilder

Méthodes

MéthodeType renvoyéBrève description
create()TriggerCrée le déclencheur et l'affiche.
onEventUpdated()CalendarTriggerBuilderSpé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éthodeType renvoyéBrève description
after(durationMilliseconds)ClockTriggerBuilderSpécifie 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)ClockTriggerBuilderSpécifie l'heure à laquelle le déclencheur s'exécute.
create()TriggerCrée le déclencheur.
everyDays(n)ClockTriggerBuilderSpécifie l'exécution du déclencheur tous les n jours.
everyHours(n)ClockTriggerBuilderSpécifie l'exécution du déclencheur toutes les n heures.
everyMinutes(n)ClockTriggerBuilderSpécifie l'exécution du déclencheur toutes les n minutes.
everyWeeks(n)ClockTriggerBuilderSpécifie l'exécution du déclencheur toutes les n semaines.
inTimezone(timezone)ClockTriggerBuilderSpécifie le fuseau horaire des dates/heures spécifiées d'exécution du déclencheur.
nearMinute(minute)ClockTriggerBuilderSpécifie la minute à laquelle le déclencheur s'exécute (plus ou moins 15 minutes).
onMonthDay(day)ClockTriggerBuilderSpécifie la date du mois d'exécution du déclencheur.
onWeekDay(day)ClockTriggerBuilderSpécifie le jour de la semaine où le déclencheur s'exécute.

DocumentTriggerBuilder

Méthodes

MéthodeType renvoyéBrève description
create()TriggerCrée et affiche 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 une fois que l'événement basé sur le temps atteint un moment précis.
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 n'est pas considéré 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, qui compte comme une modification plutôt que comme une modification).
ON_EVENT_UPDATEDEnumLe 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éthodeType renvoyéBrève description
create()TriggerCrée et affiche 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 vue 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 dans le domaine de l'utilisateur.
NONEEnumLe script n'est pas exécuté en tant que module complémentaire.
WEB_STORE_ADD_ONEnumL'utilisateur a installé le module complémentaire à 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 la manière dont le script a été installé auprès de l'utilisateur en tant que module complémentaire.
TriggerSourceTriggerSourceÉnumération indiquant la source de l'événement qui déclenche l'activation du 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é afin 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 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()StringRé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()StringRécupère l'identifiant unique du projet de script.
getService()ServiceRé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()voidInvalide 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 (comme un flux OAuth).
newTrigger(functionName)TriggerBuilderDé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é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 l'affiche.
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 lorsqu'un formulaire est envoyé à la feuille de calcul.
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 représentation sous forme de 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 pour lequel le déclencheur s'active.
getHandlerFunction()StringRenvoie la fonction qui sera 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 spécifique à 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 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 lié à la feuille de calcul donnée.
forSpreadsheet(key)SpreadsheetTriggerBuilderCrée et renvoie un SpreadsheetTriggerBuilder lié à 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 affiche un ClockTriggerBuilder pour la création de déclencheurs temporels.

TriggerSource

Propriétés

PropriétéTypeDescription
SPREADSHEETSEnumGoogle Sheets déclenche le déclencheur.
CLOCKEnumUn événement basé sur le temps déclenche l'activation du déclencheur.
FORMSEnumGoogle Forms active le déclencheur.
DOCUMENTSEnumGoogle Docs active le déclencheur.
CALENDAREnumGoogle Agenda active le déclencheur.