Stay organized with collections Save and categorize content based on your preferences.
Script
This service provides access to script triggers and script publishing.
ClassesAuthMode
Properties Property Type Description NONE
Enum
A mode that does not allow access to any services that require authorization. CUSTOM_FUNCTION
Enum
A mode that allows access to a limited subset of services for use in custom spreadsheet functions. LIMITED
Enum
A mode that allows access to a limited subset of services. FULL
Enum
A mode that allows access to all services that require authorization. AuthorizationStatus
Properties Property Type Description REQUIRED
Enum
The user needs to authorize this script to use one or more services. NOT_REQUIRED
Enum
The user has granted this script all the authorization it currently requires. CalendarTriggerBuilder
ClockTriggerBuilder
DocumentTriggerBuilder
EventType
Properties Property Type Description CLOCK
Enum
The trigger fires once the time-driven event reaches a specific time. ON_OPEN
Enum
The trigger fires once the user opens the Google Docs, Sheets, or Forms file. ON_EDIT
Enum
The trigger fires once the user edits the Google Sheets file (for example, by entering a new value into a cell, which counts as an edit instead of a change). ON_FORM_SUBMIT
Enum
The trigger fires once the user responds to a Google Form. ON_CHANGE
Enum
The trigger fires once the user changes the Google Sheets file (for example, by adding a row, which counts as a change instead of an edit). ON_EVENT_UPDATED
Enum
The trigger fires once an event gets created, updated, or deleted on the specified Google Calendar. FormTriggerBuilder
InstallationSource
Properties Property Type Description APPS_MARKETPLACE_DOMAIN_ADD_ON
Enum
Add-on was installed by the administrator for the user's domain. NONE
Enum
Script is not running as an add-on. WEB_STORE_ADD_ON
Enum
Add-on was installed by the user from the Chrome Web Store. ScriptApp
Properties Property Type Description AuthMode
AuthMode
An enumeration that identifies which categories of authorized services Apps Script is able to execute through a triggered function. AuthorizationStatus
AuthorizationStatus
An enumeration denoting the authorization status of a script. EventType
EventType
An enumeration denoting the type of triggered event. InstallationSource
InstallationSource
An enumeration denoting how the script was installed to the user as an add-on. TriggerSource
TriggerSource
An enumeration denoting the source of the event that causes the trigger to fire. WeekDay
Weekday
An enumeration representing the days of the week. Methods Method Return type Brief description deleteTrigger(trigger)
void
Removes the given trigger so it no longer runs. getAuthorizationInfo(authMode)
AuthorizationInfo
Gets an object that checks if the user has granted authorization for all the script requirements. getAuthorizationInfo(authMode, oAuthScopes)
AuthorizationInfo
Gets an object that checks if the user has granted authorization for the requested scopes. getIdentityToken()
String
Gets an OpenID Connect identity token for the effective user, if the openid
scope has been granted. getInstallationSource()
InstallationSource
Returns an enum value that indicates how the script came to be installed as an add-on for the current user (for example, whether the user installed it personally through the Chrome Web Store, or whether a domain administrator installed it for all users). getOAuthToken()
String
Gets the OAuth 2.0 access token for the effective user. getProjectTriggers()
Trigger[]
Gets all installable triggers associated with the current project and current user. getScriptId()
String
Gets the script project's unique ID. getService()
Service
Gets an object used to control publishing the script as a web app. getUserTriggers(document)
Trigger[]
Gets all installable triggers owned by this user in the given document, for this script or add-on only. getUserTriggers(form)
Trigger[]
Gets all installable triggers owned by this user in the given form, for this script or add-on only. getUserTriggers(spreadsheet)
Trigger[]
Gets all installable triggers owned by this user in the given spreadsheet, for this script or add-on only. invalidateAuth()
void
Invalidates the authorization the effective user has to execute the current script. newStateToken()
StateTokenBuilder
Creates a builder for a state token that can be used in a callback API (like an OAuth flow). newTrigger(functionName)
TriggerBuilder
Begins the process of creating an installable trigger that, when fired, calls a given function. requireAllScopes(authMode)
void
Validates if the user has granted consent for all of the scopes requested by the script. requireScopes(authMode, oAuthScopes)
void
Validates if the user has granted consent for the requested scopes. Service
Methods Method Return type Brief description getUrl()
String
Returns the URL of the web app, if it has been deployed; otherwise returns null
. isEnabled()
Boolean
Returns true
if the script is accessible as a web app. SpreadsheetTriggerBuilder
StateTokenBuilder
Trigger
TriggerBuilder
TriggerSource
Properties Property Type Description SPREADSHEETS
Enum
Google Sheets causes the trigger to fire. CLOCK
Enum
A time-driven event causes the trigger to fire. FORMS
Enum
Google Forms causes the trigger to fire. DOCUMENTS
Enum
Google Docs causes the trigger to fire. CALENDAR
Enum
Google Calendar causes the trigger to fire.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-01-08 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-08 UTC."],[[["The Script service empowers developers to automate tasks and control web app deployments within Google Apps Script."],["Triggers automate script execution based on events like opening documents, form submissions, or time-based occurrences."],["Script publishing controls how scripts are deployed as web apps, managing access and properties."],["Authorization management handles user permissions for script execution, with different authorization levels and status checks."],["Developers can utilize the `ScriptApp` class, trigger builders, and authorization classes to build robust and automated solutions."]]],[]]
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4