Enum AuthMode

AuthMode

一种枚举,用于标识 Apps 脚本能够通过触发型函数执行哪些类别的授权服务。这些值在触发型函数中作为authMode属性公开,该属性是事件参数 e的。如需了解详情,请参阅插件的授权生命周期指南

如需调用枚举,请调用其父类、名称和属性。例如, 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();
}

属性

属性类型说明
NONEEnum一种模式,不允许访问任何需要授权的服务。当插件执行 onOpen(e) 简单触发器,且用户已在其他文档中安装插件,但该插件尚未在当前文档中使用时,就会出现此模式。
CUSTOM_FUNCTIONEnum一种模式,允许访问有限的服务子集,以用于自定义电子表格函数。其中一些服务(包括对电子表格服务的只读访问权限)通常需要授权,但在自定义函数中使用时无需授权。由于自定义函数不包含事件形参,因此永远不会返回此值;仅记录此值是为了说明自定义函数以自己的授权模式运行。
LIMITEDEnum一种模式,允许访问有限的服务子集。当插件或绑定到文档的脚本执行 onOpen(e)onEdit(e) 简单触发器时,就会出现此模式,但 NONE 中描述的情况除外。
FULLEnum一种模式,允许访问所有需要授权的服务。当插件或脚本因任何触发器而执行时,就会出现此模式,但 LIMITEDNONE 中描述的情况除外。