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

Mit veröffentlichten Editor-Add-ons können im Editormenü Erweiterungen benutzerdefinierte Menüpunkte erstellt werden. Sie können ein Add-on-Menü mit der Methode Ui.createAddonMenu() einfügen und mit der Methode Menu.addItem() Elemente hinzufügen. Menüs werden normalerweise in der Methode onOpen(e) des Add-ons erstellt.

Sie können dynamische Menüs erstellen, die sich je nach Nutzerinteraktionen oder Add-on-Status ändern. Allerdings muss für Add-ons ein Einstiegsmenü erstellt werden, bevor das Add-on vom Nutzer autorisiert wird. Aus diesem Grund 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 Skript Properties zu prüfen, während sich das Add-on in ScriptApp.AuthMode.NONE befindet. Weitere Informationen zu Autorisierungsmodi und zum Lebenszyklus finden Sie im 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();
}