Enum AuthMode
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
AuthMode
Énumération qui identifie les catégories de services autorisés qu'Apps Script peut exécuter via une fonction déclenchée. Ces valeurs sont exposées dans les fonctions déclenchées en tant que propriété authMode
du paramètre d'événement, e
. Pour en savoir plus, consultez le guide du cycle de vie de l'autorisation des modules complémentaires.
Pour appeler un énumération, vous devez appeler sa classe parente, son nom et sa propriété. Par exemple,
ScriptApp.AuthMode.CUSTOM_FUNCTION
.
function onOpen(e) {
const 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).
const properties = PropertiesService.getDocumentProperties();
const 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();
}
Propriétés
Propriété | Type | Description |
NONE | Enum | Mode qui n'autorise pas l'accès à des services nécessitant une autorisation. Ce mode se produit lorsqu'un module complémentaire exécute un déclencheur simple onOpen(e) et que l'utilisateur a installé un module complémentaire dans un autre document, mais que le module complémentaire n'a pas été utilisé dans le document actuel. |
CUSTOM_FUNCTION | Enum | Mode qui permet d'accéder à un sous-ensemble limité de services à utiliser dans les fonctions de feuille de calcul personnalisées. Certains de ces services, y compris l'accès en lecture seule au service Sheets, nécessitent normalement une autorisation, mais sont autorisés sans autorisation lorsqu'ils sont utilisés dans une fonction personnalisée. Étant donné que les fonctions personnalisées n'incluent pas de paramètre d'événement, cette valeur n'est jamais renvoyée. Elle n'est documentée que pour démontrer que les fonctions personnalisées s'exécutent dans leur propre mode d'autorisation. |
LIMITED | Enum | Mode qui permet d'accéder à un sous-ensemble limité de services. Ce mode se produit lorsqu'un module complémentaire ou un script lié à un document exécute un déclencheur simple onOpen(e) ou onEdit(e) , sauf dans le cas décrit pour NONE . |
FULL | Enum | Mode qui permet d'accéder à tous les services nécessitant une autorisation. Ce mode se produit lorsqu'un module complémentaire ou un script s'exécute en raison de tout déclencheur autre que les cas décrits pour LIMITED ou NONE . |
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/26 (UTC).
[null,null,["Dernière mise à jour le 2025/07/26 (UTC)."],[[["\u003cp\u003eAuthMode defines the level of access Apps Script has to authorized services when a triggered function is executed.\u003c/p\u003e\n"],["\u003cp\u003eIt's crucial for understanding how add-ons and scripts interact with Google services, especially concerning user authorization.\u003c/p\u003e\n"],["\u003cp\u003eDifferent AuthModes like NONE, LIMITED, and FULL, dictate the scope of service access, impacting functionalities within triggered functions.\u003c/p\u003e\n"],["\u003cp\u003eCustom functions operate under a specific authorization mode that allows restricted access to certain services without explicit user authorization.\u003c/p\u003e\n"]]],[],null,["# Enum AuthMode\n\nAuthMode\n\nAn enumeration that identifies which categories of authorized services Apps Script is able to\nexecute through a triggered function. These values are exposed in [triggered functions](/apps-script/understanding_triggers) as the `auth``Mode`\nproperty of the [event parameter](/apps-script/understanding_events), `e`. For\nmore information, see the [guide to the\nauthorization lifecycle for add-ons](/gsuite/add-ons/concepts/addon-authorization#authorization_modes).\n\nTo call an enum, you call its parent class, name, and property. For example, `\nScriptApp.AuthMode.CUSTOM_FUNCTION`.\n\n```javascript\nfunction onOpen(e) {\n const menu = SpreadsheetApp.getUi().createAddonMenu();\n if (e && e.authMode === ScriptApp.AuthMode.NONE) {\n // Add a normal menu item (works in all authorization modes).\n menu.addItem('Start workflow', 'startWorkflow');\n } else {\n // Add a menu item based on properties (doesn't work in AuthMode.NONE).\n const properties = PropertiesService.getDocumentProperties();\n const workflowStarted = properties.getProperty('workflowStarted');\n if (workflowStarted) {\n menu.addItem('Check workflow status', 'checkWorkflow');\n } else {\n menu.addItem('Start workflow', 'startWorkflow');\n }\n // Record analytics.\n UrlFetchApp.fetch('http://www.example.com/analytics?event=open');\n }\n menu.addToUi();\n}\n``` \n\n### Properties\n\n| Property | Type | Description |\n|-------------------|--------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `NONE` | `Enum` | A mode that does not allow access to any services that require authorization. This mode occurs when an add-on executes an `on``Open(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. |\n| `CUSTOM_FUNCTION` | `Enum` | 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. |\n| `LIMITED` | `Enum` | A mode that allows access to a limited subset of services. This mode occurs when an add-on or a script [bound](/apps-script/scripts_containers) to a document executes an `on``Open(e)` or `on``Edit(e)` simple trigger, except in the case described for `NONE`. |\n| `FULL` | `Enum` | 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`. |"]]