Benutzerdefinierte Menüs für Editor-Add-ons

Veröffentlichte Editor-Add-ons können benutzerdefinierte Menüelemente im Menü Erweiterungen des jeweiligen Editors erstellen. Sie können ein Add-on-Menü mit der Methode Ui.createAddonMenu() einfügen und Elemente mit der Methode Menu.addItem() hinzufügen. Menüs werden in der Regel in der onOpen(e)-Methode des Add-ons erstellt.

Sie können dynamische Menüs erstellen, die sich basierend auf Nutzerinteraktionen oder dem Add-on-Status ändern. Add-ons müssen jedoch ein erstes Menü erstellen, bevor sie vom Nutzer autorisiert werden. Daher müssen Sie den Autorisierungsmodus des Add-ons prüfen, bevor Sie Menüs in onOpen(e) erstellen. Versuchen Sie nicht, Aktionen auszuführen, die eine Autorisierung erfordern (z. B. das Prüfen des Skripts Properties), während sich das Add-on im Status ScriptApp.AuthMode.NONE befindet. Weitere Informationen zu den Autorisierungsmodi und zum Autorisierungslebenszyklus finden Sie unter Autorisierungslebenszyklus.

Das folgende Beispiel zeigt, wie Sie ein dynamisches Add-on-Menü für verschiedene Autorisierungsmodi erstellen:

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();
}