已发布的 编辑器插件
可以在其编辑器的 扩展程序 菜单下创建自定义菜单项。使用 Ui.createAddonMenu 插入插件菜单,并使用 Menu.addItem 向其中添加项。菜单通常在插件的 onOpen 方法中创建。
创建根据用户互动或插件状态而变化的动态菜单。不过,插件必须在用户授权插件之前创建初始菜单。 因此,请先检查
插件的 授权模式
,然后再在 onOpen 中构建菜单。请勿在插件处于 ScriptApp.AuthMode.NONE 状态时执行任何需要授权的操作(例如检查脚本
Properties)。如需详细了解授权模式和生命周期,请参阅
授权生命周期
。
如果授权模式为 ScriptApp.AuthMode.NONE,尝试执行需要授权的操作会导致错误。这可能会导致插件菜单无法显示。
以下示例展示了如何针对不同的授权模式构建动态插件菜单:
function onOpen(e) {
// Or DocumentApp, SlidesApp, or FormApp.
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();
}