* // Deletes all triggers in the current project.
* var triggers = ScriptApp.getProjectTriggers();
* for (var i = 0; i < triggers.length; i++) {
* ScriptApp.deleteTrigger(triggers[i]);
* }
*
* var authInfo = ScriptApp.getAuthorizationInfo(ScriptApp.AuthMode.FULL);
* status = authInfo.getAuthorizationStatus();
* url = authInfo.getAuthorizationUrl();
* authMode should be ScriptApp.getAuthorizationInfo(ScriptApp.AuthMode.FULL), since no other authorization mode
* requires that users grant authorization
*
* @returns an object that can provide information about the user's authorization status
*/
function getAuthorizationInfo(
authMode: ScriptApp.AuthMode
): ScriptApp.AuthorizationInfo
/**
* 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. * *
* var idToken = ScriptApp.getIdentityToken();
* var body = idToken.split('.')[1];
* var decoded = Utilities.newBlob(Utilities.base64Decode(body)).getDataAsString();
* var payload = JSON.parse(decoded);
* var profileId = payload.sub;
* Logger.log('Profile ID: ' + profileId);
* null.
*/
function getIdentityToken(): string
/**
* 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).
*
* @returns The source of installation.
*/
function getInstallationSource(): ScriptApp.InstallationSource
/**
* 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.
*
* @returns A string representation of the OAuth 2.0 token.
*/
function getOAuthToken(): string
/**
* 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. * * @returns The project key of the current script. */ function getProjectKey(): string /** * Gets all installable triggers associated with the current project and current user. * *
* Logger.log('Current project has ' + ScriptApp.getProjectTriggers().length + ' triggers.');
* getProjectKey()
* Logger.log('Current script has ' + ScriptApp.getScriptTriggers().length + ' triggers.');
*
* // Get the URL of the published web app.
* var url = ScriptApp.getService().getUrl();
*
* var doc = DocumentApp.getActiveDocument();
* var triggers = ScriptApp.getUserTriggers(doc);
* // Log the handler function for the first trigger in the array.
* Logger.log(triggers[0].getHandlerFunction());
*
* var form = FormApp.getActiveForm();
* var triggers = ScriptApp.getUserTriggers(form);
* // Log the trigger source for the first trigger in the array.
* Logger.log(triggers[0].getTriggerSource());
*
* var ss = SpreadsheetApp.getActiveSpreadsheet();
* var triggers = ScriptApp.getUserTriggers(ss);
* // Log the event type for the first trigger in the array.
* Logger.log(triggers[0].getEventType());
*
* ScriptApp.invalidateAuth();
*
* // 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.
* var scriptUrl = 'https://script.google.com/macros/d/1234567890abcdefghijklmonpqrstuvwxyz';
* var urlSuffix = '/usercallback?state=';
* var 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).
*
* // Creates an edit trigger for a spreadsheet identified by ID.
* ScriptApp.newTrigger('myFunction')
* .forSpreadsheet('1234567890abcdefghijklmnopqrstuvwxyz_a1b2c3')
* .onEdit()
* .create();
* Library.libFunction1.
*
* @returns An object used to continue the trigger-building process.
*/
function newTrigger(
functionName: string
): ScriptApp.TriggerBuilder
enum AuthMode {
/**
* A mode that allows access to a limited subset of services for use in custom spreadsheet
* functions. Some of these services — including read-only access to Spreadsheet service —
* normally require authorization, but are permitted without authorization when used in a custom
* function. Because custom functions do not include an event parameter, this value is never
* returned; it is documented only to demonstrate that custom functions run in their own
* authorization mode.
*/
CUSTOM_FUNCTION = "CUSTOM_FUNCTION",
/**
* A mode that allows access to all services that require authorization. This mode occurs when an
* add-on or a script executes as the result of any trigger other than the cases described for
* LIMITED or NONE.
*/
FULL = "FULL",
/**
* A mode that allows access to a limited subset of services. This mode occurs when an add-on or a
* script bound to a document executes an onOpen(e) or onEdit(e) simple trigger, except in the case described for NONE.
*/
LIMITED = "LIMITED",
/**
* A mode that does not allow access to any services that require authorization. This mode occurs
* when an add-on executes an onOpen(e) simple trigger, and the user has installed an
* add-on in a different document but the add-on has not been used in the current document.
*/
NONE = "NONE",
}
class AuthorizationInfo {
private constructor();
/**
* Gets a value that indicates whether the user needs to authorize this script to use one or more
* services (for example, ScriptApp.AuthorizationStatus.REQUIRED).
*
*
* // Log the authorization status (REQUIRED or NOT_REQUIRED).
* var authInfo = ScriptApp.getAuthorizationInfo(ScriptApp.AuthMode.FULL);
* Logger.log(authInfo.getAuthorizationStatus());
* null if no authorization is required. The page at the URL will close automatically if
* it is accessed and the script does not require any authorization.
*
*
* // Log the URL used to grant access to the script.
* var authInfo = ScriptApp.getAuthorizationInfo(ScriptApp.AuthMode.FULL);
* Logger.log(authInfo.getAuthorizationUrl());
* CalendarTriggerBuilder, for chaining.
*/
onEventUpdated(): ScriptApp.CalendarTriggerBuilder
}
class ClockTriggerBuilder {
private constructor();
/**
* Specifies the minimum duration (in milliseconds) after the current time that the trigger runs.
* The actual duration might vary, but won't be less than your specified minimum.
*
*
* // Creates a trigger that runs 10 minutes later
* ScriptApp.newTrigger("myFunction")
* .timeBased()
* .after(10 * 60 * 1000)
* .create();
*
* // Creates a trigger for December 1, 2012
* var triggerDay = new Date(2012, 11, 1);
* ScriptApp.newTrigger("myFunction")
* .timeBased()
* .at(triggerDay)
* .create();
*
* // Schedules for January 1st, 2013
* ScriptApp.newTrigger("myFunction")
* .timeBased()
* .atDate(2013, 1, 1)
* .create();
*
* // Runs between 5am-6am in the timezone of the script
* ScriptApp.newTrigger("myFunction")
* .timeBased()
* .atHour(5)
* .everyDays(1) // Frequency is required if you are using atHour() or nearMinute()
* .create();
* n days.
*
*
* ScriptApp.newTrigger("myFunction")
* .timeBased()
* .everyDays(3)
* .create();
* n hours.
*
*
* ScriptApp.newTrigger("myFunction")
* .timeBased()
* .everyHours(12)
* .create();
* n minutes. n must be 1, 5, 10, 15 or 30.
*
*
* ScriptApp.newTrigger("myFunction")
* .timeBased()
* .everyMinutes(10)
* .create();
* n weeks.
*
*
* ScriptApp.newTrigger("myFunction")
* .timeBased()
* .everyWeeks(2)
* .create();
* The list of valid timezone strings corresponds with the valid timezone strings listed by Joda.org. An invalid timezone string * causes the script to throw an error. * *
* // Schedule the trigger to execute at noon every day in the US/Pacific time zone
* ScriptApp.newTrigger("myFunction")
* .timeBased()
* .atHour(12)
* .everyDays(1)
* .inTimezone("America/Los_Angeles")
* .create();
* ClockTriggerBuilder, for chaining.
*/
inTimezone(
timezone: string
): ScriptApp.ClockTriggerBuilder
/**
* Specifies the minute at which the trigger runs (plus or minus 15 minutes). If nearMinute() is not called, a random minute value is used.
*
*
* // Runs at approximately 5:30am in the timezone of the script
* ScriptApp.newTrigger("myFunction")
* .timeBased()
* .atHour(5)
* .nearMinute(30)
* .everyDays(1) // Frequency is required if you are using atHour() or nearMinute()
* .create();
*
* // Schedules for the first of every month
* ScriptApp.newTrigger("myFunction")
* .timeBased()
* .onMonthDay(1)
* .create();
*
* ScriptApp.newTrigger("myFunction")
* .timeBased()
* .onWeekDay(ScriptApp.WeekDay.FRIDAY)
* .create();
*
* var document = DocumentApp.getActiveDocument();
* ScriptApp.newTrigger('myFunction')
* .forDocument(document)
* .onOpen()
* .create();
* DocumentTriggerBuilder, for chaining.
*/
onOpen(): ScriptApp.DocumentTriggerBuilder
}
enum EventType {
/**
* The trigger fires once the time-driven event reaches a specific time.
*/
CLOCK = "CLOCK",
/**
* 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_CHANGE = "ON_CHANGE",
/**
* 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_EDIT = "ON_EDIT",
/**
* The trigger fires once an event gets created, updated, or deleted on the specified Google
* Calendar.
*/
ON_EVENT_UPDATED = "ON_EVENT_UPDATED",
/**
* The trigger fires once the user responds to a Google Form. This trigger is available either in
* the Google Form itself or in the Google Sheets file that the form sends its responses to.
*/
ON_FORM_SUBMIT = "ON_FORM_SUBMIT",
/**
* The trigger fires once the user opens the Google Docs, Sheets, or Forms file.
*/
ON_OPEN = "ON_OPEN",
}
class FormTriggerBuilder {
private constructor();
/**
* Creates and returns the new trigger.
*
* @returns The new trigger.
*/
create(): ScriptApp.Trigger
/**
* Specifies a trigger that will fire when a response is submitted to the form.
*
*
* var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
* ScriptApp.newTrigger('myFunction')
* .forForm(form)
* .onFormSubmit()
* .create();
* FormTriggerBuilder, for chaining
*/
onFormSubmit(): ScriptApp.FormTriggerBuilder
/**
* Specifies a trigger that will fire when the form's edit view is opened.
*
*
* var form = FormApp.getActiveForm();
* ScriptApp.newTrigger('myFunction')
* .forForm(form)
* .onOpen()
* .create();
* FormTriggerBuilder, for chaining.
*/
onOpen(): ScriptApp.FormTriggerBuilder
}
enum InstallationSource {
/**
* Add-on was installed by the administrator for the user's domain.
*/
APPS_MARKETPLACE_DOMAIN_ADD_ON = "APPS_MARKETPLACE_DOMAIN_ADD_ON",
/**
* Script is not running as an add-on.
*/
NONE = "NONE",
/**
* Add-on was installed by the user from the Chrome Web Store.
*/
WEB_STORE_ADD_ON = "WEB_STORE_ADD_ON",
}
class Service {
private constructor();
/**
* Disables the script from being accessed as a web app. This method is equivalent to opening the
* "Publish > Deploy as web app" dialog and clicking "disable web app".
*
*
* ScriptApp.getService().disable();
* null. If you
* are running the development mode web app, this returns the development mode url.
*
*
* // Mail the URL of the published web app.
* MailApp.sendMail("myself@example.com", "My Snazzy App",
* "My new app is now available at " + ScriptApp.getService().getUrl());
* true if the script is accessible as a web app.
*
* @returns true if the script is published as a web app; false if not
*/
isEnabled(): Boolean
}
class SpreadsheetTriggerBuilder {
private constructor();
/**
* Creates the trigger and returns it.
*
* @returns The created trigger.
*/
create(): ScriptApp.Trigger
/**
* Specifies a trigger that will fire when the spreadsheet's content or structure is changed.
*
*
* var sheet = SpreadsheetApp.getActive();
* ScriptApp.newTrigger("myFunction")
* .forSpreadsheet(sheet)
* .onChange()
* .create();
*
* var sheet = SpreadsheetApp.getActive();
* ScriptApp.newTrigger("myFunction")
* .forSpreadsheet(sheet)
* .onEdit()
* .create();
*
* var sheet = SpreadsheetApp.getActive();
* ScriptApp.newTrigger("myFunction")
* .forSpreadsheet(sheet)
* .onFormSubmit()
* .create();
*
* var sheet = SpreadsheetApp.getActive();
* ScriptApp.newTrigger("myFunction")
* .forSpreadsheet(sheet)
* .onOpen()
* .create();
*
* var stateToken = ScriptApp.newStateToken().createToken();
*
* var stateToken = ScriptApp.newStateToken().withArgument('myField', 'myValue').createToken();
* callback().
*
*
* var stateToken = ScriptApp.newStateToken().withMethod('myCallback').createToken();
*
* Library.libFunction1.
*
* @returns the state token builder, for chaining
*/
withMethod(
method: string
): ScriptApp.StateTokenBuilder
/**
* Sets the duration (in seconds) for which the token is valid. The defaults is 60 seconds; the
* maximum duration is 3600 seconds (1 hour).
*
*
* var stateToken = ScriptApp.newStateToken().withTimeout(60).createToken();
* 3600
*
* @returns the state token builder, for chaining
*/
withTimeout(
seconds: number
): ScriptApp.StateTokenBuilder
}
class Trigger {
private constructor();
/**
* Returns the event type that the trigger fires on.
*
*
* var triggers = ScriptApp.getProjectTriggers();
* for (var i = 0; i < triggers.length; i++) {
* if (triggers[i].getEventType() == ScriptApp.EventType.CLOCK) {
* // Some code here - other options are:
* // ScriptApp.EventType.ON_EDIT
* // ScriptApp.EventType.ON_FORM_SUBMIT
* // ScriptApp.EventType.ON_OPEN
* }
* }
*
* // Create a trigger for the script.
* ScriptApp.newTrigger('myFunction').forSpreadsheet('id of my spreadsheet').onEdit().create();
* Logger.log(ScriptApp.getProjectTriggers()[0].getHandlerFunction()); // logs "myFunction"
* For example, a spreadsheet onEdit trigger would return SPREADSHEETS, or a time based trigger * would return CLOCK. * *
* var triggers = ScriptApp.getProjectTriggers();
* for (var i = 0; i < triggers.length; i++) {
* if (triggers[i].getTriggerSource() == ScriptApp.TriggerSource.CLOCK) {
* Logger.log(triggers[i].getUniqueId() + " source is clock");
* } else if (triggers[i].getTriggerSource() == ScriptApp.TriggerSource.SPREADSHEETS) {
* Logger.log(triggers[i].getUniqueId() + " source is spreadsheets");
* }
* }
* For example, if the trigger source is a spreadsheet, this would be the id of the
* spreadsheet. For clock events this returns null.
*
* @returns the id of the entity in the publisher that this is a trigger for
*/
getTriggerSourceId(): string
/**
* Returns a unique identifier that can be used to distinguish triggers from each other.
*
* @returns the unique identifier of the trigger
*/
getUniqueId(): string
}
class TriggerBuilder {
private constructor();
/**
* Creates and returns a DocumentTriggerBuilder tied to the given document.
*
*
* ScriptApp.newTrigger('myFunction')
* .forDocument(DocumentApp.getActiveDocument())
* .onOpen()
* .create();
* DocumentTriggerBuilder tied to the document with the given ID.
*
*
* ScriptApp.newTrigger('myFunction')
* .forDocument('1234567890abcdefghijklmnopqrstuvwxyz')
* .onOpen()
* .create();
* FormTriggerBuilder tied to the given form.
*
*
* ScriptApp.newTrigger('myFunction')
* .forForm(FormApp.getActiveForm())
* .onFormSubmit()
* .create();
* FormTriggerBuilder tied to the form with the given ID.
*
*
* ScriptApp.newTrigger('myFunction')
* .forForm('1234567890abcdefghijklmnopqrstuvwxyz')
* .onFormSubmit()
* .create();
* SpreadsheetTriggerBuilder tied to the given spreadsheet.
*
*
* ScriptApp.newTrigger('myFunction')
* .forSpreadsheet(SpreadsheetApp.getActive())
* .onEdit()
* .create();
* SpreadsheetTriggerBuilder tied to the spreadsheet with the given
* ID.
*
*
* ScriptApp.newTrigger('myFunction')
* .forSpreadsheet('1234567890abcdefghijklmnopqrstuvwxyz')
* .onEdit()
* .create();
* ClockTriggerBuilder for building time-based triggers.
*
*
* ScriptApp.newTrigger('myFunction')
* .timeBased()
* .atDate(2013, 10, 31)
* .create();
*