Stay organized with collections Save and categorize content based on your preferences.
ScriptAppAccess and manipulate script publishing and triggers. This class allows users to create script triggers and control publishing the script as a service.
Properties Property Type DescriptionAuthMode
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. Deprecated methods Method Return type Brief description getProjectKey()
String
Gets the project key of the current script. getScriptTriggers()
Trigger[]
Gets all installable triggers associated with the current project and current user. Detailed documentation deleteTrigger(trigger)
Removes the given trigger so it no longer runs.
// Deletes all triggers in the current project. const triggers = ScriptApp.getProjectTriggers(); for (let i = 0; i < triggers.length; i++) { ScriptApp.deleteTrigger(triggers[i]); }Parameters Name Type Description
trigger
Trigger
The trigger to delete.
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/script.scriptapp
getAuthorizationInfo(authMode)
Gets an object that checks if the user has granted authorization for all the script requirements. The object also provides an authorization URL for users to grant those permissions, in case any of the script requirements are not authorized.
Some script executions can start without a user's consent for all required scopes used by the script. The information in this object lets you control access to sections of code that require certain scopes and request authorization of those scopes for subsequent executions.
const authInfo = ScriptApp.getAuthorizationInfo(ScriptApp.AuthMode.FULL); const status = authInfo.getAuthorizationStatus(); const url = authInfo.getAuthorizationUrl();Parameters Name Type Description
authMode
AuthMode
The authorization mode for which authorization information is requested; in almost all cases, the value for authMode
should be ScriptApp.getAuthorizationInfo(ScriptApp.AuthMode.FULL)
, since no other authorization mode requires that users grant authorization. Return
AuthorizationInfo
— An object that can provide information about the user's authorization status.
getAuthorizationInfo(authMode, oAuthScopes)
Gets an object that checks if the user has granted authorization for the requested scopes. The object also provides an authorization URL for users to grant those permissions, in case any of the requested scopes are not authorized.
Some script executions can start without a user's consent for all required scopes used by the script. The information in this object lets you control access to sections of code that require certain scopes and request authorization of those scopes for subsequent executions. Scopes that are invalid or not required by the script lead to an error.
const authInfo = ScriptApp.getAuthorizationInfo(ScriptApp.AuthMode.FULL, [ 'https://www.googleapis.com/auth/documents', 'https://www.googleapis.com/auth/presentations', ]); const status = authInfo.getAuthorizationStatus(); const url = authInfo.getAuthorizationUrl();Parameters Name Type Description
authMode
AuthMode
The authorization mode for which authorization information is requested; in almost all cases, the value for authMode
should be ScriptApp.AuthMode.FULL
, since no other authorization mode requires that users grant authorization. oAuthScopes
String[]
The OAuth scopes for which authorization information is requested. Return
AuthorizationInfo
— An object that provides information about the user's authorization status and an authorization URL in case some consents are missing.
getIdentityToken()
Gets an OpenID Connect identity token for the effective user, if the openid
scope has been granted. This scope is not included by default, and you must add it as an explicit scope in the manifest file to request it. Include the scopes https://www.googleapis.com/auth/userinfo.email
or https://www.googleapis.com/auth/userinfo.profile
to return additional user information in the token.
The returned ID token is an encoded JSON Web Token (JWT), and it must be decoded to extract information from it. The following examples shows how to decode the token and extract the effective user's Google profile ID.
const idToken = ScriptApp.getIdentityToken(); const body = idToken.split('.')[1]; const decoded = Utilities .newBlob( Utilities.base64Decode(body), ) .getDataAsString(); const payload = JSON.parse(decoded); Logger.log(`Profile ID: ${payload.sub}`);
See the
OpenID Connectdocumentation for the full list of fields (claims) returned.
ReturnString
— The identity token if available; otherwise null
.
getInstallationSource()
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).
ReturnInstallationSource
— The source of installation.
getOAuthToken()
Gets the OAuth 2.0 access token for the effective user. If the script's OAuth scopes are sufficient to authorize another Google API that normally requires its own OAuth flow (like Google Picker), scripts can bypass the second authorization prompt by passing this token instead. The token expires after a time (a few minutes at minimum); scripts should handle authorization failures and call this method to obtain a fresh token when needed.
The token returned by this method only includes scopes that the script currently needs. Scopes that were previously authorized but are no longer used by the script are not included in the returned token. If additional OAuth scopes are needed beyond what the script itself requires, they can be specified in the script's manifest file.
ReturnString
— A string representation of the OAuth 2.0 token.
getProjectTriggers()
Gets all installable triggers associated with the current project and current user.
Logger.log( `Current project has ${ScriptApp.getProjectTriggers().length} triggers.`, );Return
Trigger[]
— An array of the current user's triggers associated with this project.
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/script.scriptapp
getScriptId()
Gets the script project's unique ID. This is the preferred method to get the unique identifier for the script project as opposed to getProjectKey()
. This ID can be used in all places where project key was previously provided.
String
— The script project's ID.
getService()
Gets an object used to control publishing the script as a web app.
// Get the URL of the published web app. const url = ScriptApp.getService().getUrl();Return
Service
— An object used to observe and control publishing the script as a web app.
getUserTriggers(document)
Gets all installable triggers owned by this user in the given document, for this script or add-on only. This method cannot be used to see the triggers attached to other scripts.
const doc = DocumentApp.getActiveDocument(); const triggers = ScriptApp.getUserTriggers(doc); // Log the handler function for the first trigger in the array. Logger.log(triggers[0].getHandlerFunction());Parameters Name Type Description
document
Document
A Google Docs file that may contain installable triggers. Return
Trigger[]
— An array of triggers owned by this user in the given document.
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/script.scriptapp
getUserTriggers(form)
Gets all installable triggers owned by this user in the given form, for this script or add-on only. This method cannot be used to see the triggers attached to other scripts.
const form = FormApp.getActiveForm(); const triggers = ScriptApp.getUserTriggers(form); // Log the trigger source for the first trigger in the array. Logger.log(triggers[0].getTriggerSource());Parameters Name Type Description
form
Form
A Google Forms file that may contain installable triggers. Return
Trigger[]
— An array of triggers owned by this user in the given form.
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/script.scriptapp
Gets all installable triggers owned by this user in the given spreadsheet, for this script or add-on only. This method cannot be used to see the triggers attached to other scripts.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const triggers = ScriptApp.getUserTriggers(ss); // Log the event type for the first trigger in the array. Logger.log(triggers[0].getEventType());Parameters Name Type Description
spreadsheet
Spreadsheet
A Google Sheets file that may contain installable triggers. Return
Trigger[]
— An array of triggers owned by this user in the given spreadsheet.
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/script.scriptapp
invalidateAuth()
Invalidates the authorization the effective user has to execute the current script. Used to invalidate any permissions for the current script. This is especially useful for functions tagged as one-shot authorization. Since one-shot authorization functions can only be called the first run after the script has acquired authorization, if you wish to perform an action afterwards, you must revoke any authorization the script had, so the user can see the authorization dialog again.
ScriptApp.invalidateAuth();Throws
Error
— when invalidation fails
newStateToken()
Creates a builder for a state token that can be used in a callback API (like an OAuth flow).
// Generate a callback URL, given the name of a callback function. The script // does not need to be published as a web app; the /usercallback URL suffix // replaces /edit in any script's URL. function getCallbackURL(callbackFunction) { // IMPORTANT: Replace string below with the URL from your script, minus the // /edit at the end. const scriptUrl = 'https://script.google.com/macros/d/1234567890abcdefghijklmonpqrstuvwxyz'; const urlSuffix = '/usercallback?state='; const stateToken = ScriptApp.newStateToken() .withMethod(callbackFunction) .withTimeout(120) .createToken(); return scriptUrl + urlSuffix + stateToken; }
In most OAuth2 flows, the state
token is passed to the authorization endpoint directly (not as part of the callback URL), and the authorization endpoint then passes it as part of the callback URL.
For example:
https://accounts.google.com/o/oauth2/auth?state=token_generated_with_this_method&callback_uri=https://script.google.com/macros/d/1234567890abcdefghijklmonpqrstuvwxyz/usercallback&other_oauth2_parameters
https://script.google.com/macros/d/1234567890abcdefghijklmonpqrstuvwxyz/usercallback?state=token_generated_with_this_method&other_params_that_include_tokens_or_grants
http://script.google.com/...
), causes the browser request to /usercallback
, which invokes the method specified by StateTokenBuilder.withMethod(method)
.StateTokenBuilder
— An object used to continue the state-token-building process.
newTrigger(functionName)
Begins the process of creating an installable trigger that, when fired, calls a given function.
// Creates an edit trigger for a spreadsheet identified by ID. ScriptApp.newTrigger('myFunction') .forSpreadsheet('1234567890abcdefghijklmnopqrstuvwxyz_a1b2c3') .onEdit() .create();
Before creating a trigger, verify that the associated function has all the necessary OAuth permissions
Parameters Name Type DescriptionfunctionName
String
The function to call when the trigger fires. You can use functions from included libraries, such as Library.libFunction1
. Return
TriggerBuilder
— An object used to continue the trigger-building process.
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/script.scriptapp
requireAllScopes(authMode)
Validates if the user has granted consent for all of the scopes requested by the script. Use this method if an execution flow relies on all of the scopes that a script requests. If any consents are missing, then this method ends the current execution and renders an authorization prompt to request the missing consents.
This method only works when users run the script from a surface that supports granular consent, for example, from within the Apps Script IDE. When the script is run with missing consents from an unsupported surface, such as a Google Workspace add-on, the script renders an authorization prompt at the start of the execution to request all the scopes.
ScriptApp.requireAllScopes(ScriptApp.AuthMode.FULL);Parameters Name Type Description
authMode
AuthMode
The authorization mode for which script scopes needs to be evaluated, in almost all cases, the value for authMode
should be ScriptApp.AuthMode.FULL
, since no other authorization mode requires that users grant authorization. requireScopes(authMode, oAuthScopes)
Validates if the user has granted consent for the requested scopes. Use this method if an execution flow relies on one or more services. If any of the specified consents are missing, then this method ends the current execution and renders an authorization prompt to request the missing consents. Scopes that are invalid or not required by the script lead to an error.
This method only works when users run the script from a surface that supports granular consent, for example, from within the Apps Script IDE. When the script is run with missing consents from an unsupported surface, such as a Google Workspace add-on, the script renders an authorization prompt at the start of the execution to request all the scopes.
ScriptApp.requireScopes(ScriptApp.AuthMode.FULL, [ 'https://www.googleapis.com/auth/documents', 'https://www.googleapis.com/auth/presentations', ]);Parameters Name Type Description
authMode
AuthMode
The authorization mode for which requested scopes needs to be evaluated, in almost all cases, the value for authMode
should be ScriptApp.AuthMode.FULL
, since no other authorization mode requires that users grant authorization. oAuthScopes
String[]
The OAuth scopes that are required to complete the given execution flow. Deprecated methods getProjectKey()
Deprecated. use getScriptId()
instead.
Gets the project key of the current script. The project key is a unique identifier for scripts and used to compose the callback URL used in conjunction with newStateToken()
.
When called in a library, this returns the project key of the outer-most script being executed.
ReturnString
— The project key of the current script.
getScriptTriggers()
Deprecated. This function is deprecated and should not be used in new scripts.
Gets all installable triggers associated with the current project and current user.
Logger.log( `Current script has ${ScriptApp.getScriptTriggers().length} triggers.`, );Return
Trigger[]
— An array of the current user's triggers associated with this project.
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/script.scriptapp
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-08-04 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-08-04 UTC."],[[["The `ScriptApp` class in Apps Script allows developers to manage script triggers, control authorization, and publish scripts as web apps."],["Developers can use methods like `newTrigger()` to automate script execution based on events like spreadsheet edits and `deleteTrigger()` to remove existing triggers."],["`newStateToken()` facilitates secure OAuth2 authorization flows by generating unique tokens for callback functions."],["Methods like `getProjectKey()` and `getScriptTriggers()` are deprecated and should be replaced by `getScriptId()` and `getProjectTriggers()` respectively."],["Comprehensive documentation provides detailed explanations, examples, and usage guidelines for each `ScriptApp` method."]]],[]]
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