एडिटर ऐड-ऑन के लिए पसंद के मुताबिक मेन्यू

पब्लिश किए गए एडिटर के ऐड-ऑन अपने एडिटर के एक्सटेंशन मेन्यू में जाकर, कस्टम मेन्यू आइटम बना सकते हैं. Ui.createAddonMenu() तरीके का इस्तेमाल करके, ऐड-ऑन मेन्यू डाला जा सकता है. साथ ही, Menu.addItem() तरीके का इस्तेमाल करके, उसमें आइटम जोड़े जा सकते हैं. आम तौर पर, मेन्यू, ऐड-ऑन के onOpen(e) तरीके से बनाए जाते हैं.

चेतावनी: पब्लिश नहीं किए गए ऐड-ऑन भी पसंद के मुताबिक टॉप-लेवल मेन्यू बना सकते हैं. हालांकि, अगर ऐड-ऑन को पब्लिश किया जाता है, तो ये अपने-आप ऐड-ऑन मेन्यू में चले जाते हैं. ऐसा होने पर, हो सकता है कि उपयोगकर्ता को आपका मनचाहा अनुभव न मिले. अगर आपको ऐड-ऑन पब्लिश करना है, तो ऐड-ऑन मेन्यू तय करने के लिए, हमेशा Ui.createAddonMenu() का इस्तेमाल करें.

ऐसे डाइनैमिक मेन्यू बनाए जा सकते हैं जो उपयोगकर्ता के इंटरैक्शन या ऐड-ऑन की स्थिति के आधार पर बदलते हैं. हालांकि, उपयोगकर्ता से अनुमति मिलने से पहले, ऐड-ऑन को शुरुआती मेन्यू बनाना होगा. इसलिए, onOpen(e) में मेन्यू बनाने से पहले, आपको ऐड-ऑन के अनुमति मोड की जांच करनी होगी. जब ऐड-ऑन ScriptApp.AuthMode.NONE में हो, तब ऐसी कोई भी कार्रवाई न करें जिसके लिए अनुमति की ज़रूरत हो. जैसे, स्क्रिप्ट Properties की जांच करना. देखें अनुमति की लाइफ़साइकल पर जाकर, अनुमति देने वाले मोड और लाइफ़साइकल के बारे में ज़्यादा जानकारी पाएं.

चेतावनी: अगर अनुमति मोड ScriptApp.AuthMode.NONE होने पर, अनुमति की ज़रूरत वाली कार्रवाइयां की जाती हैं, तो गड़बड़ी का मैसेज दिखता है. यह आपके ऐड-ऑन मेन्यू को दिखने से रोक सकता है.

यहां दिए गए उदाहरण में, अनुमति के अलग-अलग मोड के लिए डाइनैमिक ऐड-ऑन मेन्यू बनाने का तरीका बताया गया है:

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