Enum AuthMode | Apps Script | Google for Developers (2024)

Stay organized with collections Save and categorize content based on your preferences.

An enumeration that identifies which categories of authorized services Apps Script is able toexecute through a triggered function. These values are exposed in triggered functions as the authModeproperty of the event parameter, e. Formore information, see the guide to theauthorization lifecycle for add-ons.

To call an enum, you call its parent class, name, and property. For example, ScriptApp.AuthMode.CUSTOM_FUNCTION.

function onOpen(e) { var menu = SpreadsheetApp.getUi().createAddonMenu(); if (e && e.authMode == ScriptApp.AuthMode.NONE) { // Add a normal menu item (works in all authorization modes). menu.addItem('Start workflow', 'startWorkflow'); } else { // Add a menu item based on properties (doesn't work in AuthMode.NONE). var properties = PropertiesService.getDocumentProperties(); var workflowStarted = properties.getProperty('workflowStarted'); if (workflowStarted) { menu.addItem('Check workflow status', 'checkWorkflow'); } else { menu.addItem('Start workflow', 'startWorkflow'); } // Record analytics. UrlFetchApp.fetch('http://www.example.com/analytics?event=open'); } menu.addToUi();}

Properties

Property	Type	Description
`NONE`	`Enum`	A mode that does not allow access to any services that require authorization. This mode occurswhen an add-on executes an `onOpen(e)` simple trigger, and the user has installed anadd-on in a different document but the add-on has not been used in the current document.
`CUSTOM_FUNCTION`	`Enum`	A mode that allows access to a limited subset of services for use in custom spreadsheetfunctions. Some of these services — including read-only access to Spreadsheet service —normally require authorization, but are permitted without authorization when used in a customfunction. Because custom functions do not include an event parameter, this value is neverreturned; it is documented only to demonstrate that custom functions run in their ownauthorization mode.
`LIMITED`	`Enum`	A mode that allows access to a limited subset of services. This mode occurs when an add-on or ascript bound to a document executes an `onOpen(e)` or `onEdit(e)` simple trigger, except in the case described for `NONE`.
`FULL`	`Enum`	A mode that allows access to all services that require authorization. This mode occurs when anadd-on or a script executes as the result of any trigger other than the cases described for`LIMITED` or `NONE`.