編輯器外掛程式的自訂選單

發布的編輯器外掛程式可以在編輯器的「擴充功能」選單下方建立自訂選單項目。您可以使用 Ui.createAddonMenu() 方法插入外掛程式選單,並使用 Menu.addItem() 方法在選單中新增項目。選單通常是在外掛程式的 onOpen(e) 方法中建立。

您可以建立動態選單,根據使用者互動或外掛程式狀態變更。不過,外掛程式必須在使用者授權「前」建立初始選單。因此,您必須先檢查外掛程式的授權模式,再於 onOpen(e) 中建構選單。外掛程式處於 ScriptApp.AuthMode.NONE 狀態時,請勿嘗試執行任何需要授權的動作 (例如檢查指令碼 Properties)。如要進一步瞭解授權模式和生命週期,請參閱授權生命週期

以下範例說明如何為不同授權模式建構動態外掛程式選單:

function onOpen(e) {   var menu = SpreadsheetApp.getUi().createAddonMenu(); // Or DocumentApp or SlidesApp or FormApp.   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(); }