เมนูที่กำหนดเองสำหรับส่วนเสริมเครื่องมือแก้ไข

ส่วนเสริมของเอดิเตอร์ที่เผยแพร่แล้ว จะสร้างรายการในเมนูที่กำหนดเองได้ในเมนูส่วนขยายของเอดิเตอร์ คุณสามารถ แทรกเมนูส่วนเสริมโดยใช้วิธีUi.createAddonMenu() และเพิ่มรายการลงในเมนูโดยใช้วิธี Menu.addItem() โดยปกติแล้ว เมนูจะสร้างขึ้นในonOpen(e)เมธอดของส่วนเสริม

ข้อควรระวัง: ส่วนเสริมที่ยังไม่ได้เผยแพร่ก็สามารถ สร้างเมนูระดับบนสุดที่กำหนดเองได้ แต่ระบบจะย้ายเมนูเหล่านี้ไปไว้ใต้เมนูส่วนเสริมโดยอัตโนมัติหากมีการเผยแพร่ส่วนเสริม และอาจไม่ส่งผลให้ผู้ใช้ได้รับประสบการณ์ตามที่คุณต้องการ หากคุณ ตั้งใจที่จะเผยแพร่ส่วนเสริม ให้ใช้ Ui.createAddonMenu() เพื่อ กำหนดเมนูส่วนเสริมเสมอ

คุณสร้างเมนูแบบไดนามิกที่เปลี่ยนแปลงตามการโต้ตอบของผู้ใช้หรือสถานะของส่วนเสริมได้ อย่างไรก็ตาม ส่วนเสริมต้องสร้างเมนูเริ่มต้นก่อนที่ผู้ใช้จะให้สิทธิ์ส่วนเสริม ด้วยเหตุนี้ คุณจึงต้องตรวจสอบ โหมดการให้สิทธิ์ ของส่วนเสริมก่อนที่จะสร้างเมนูใน onOpen(e) อย่าพยายามดำเนินการใดๆ ที่ต้องมีการให้สิทธิ์ (เช่น การตรวจสอบสคริปต์ Properties) ขณะที่ส่วนเสริมอยู่ในScriptApp.AuthMode.NONE ดูรายละเอียดเพิ่มเติมเกี่ยวกับโหมดการให้สิทธิ์และวงจรการใช้งานได้ที่วงจรการให้สิทธิ์

คำเตือน: หากคุณพยายามดำเนินการที่ต้องมีการให้สิทธิ์เมื่อโหมดการให้สิทธิ์เป็น 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();
}