เมนูที่กำหนดเองสำหรับส่วนเสริมของ Editor

ส่วนเสริมของผู้แก้ไขที่เผยแพร่ สามารถสร้างรายการเมนูที่กำหนดเองได้ในเมนูส่วนขยายของเครื่องมือแก้ไข คุณแทรกเมนูส่วนเสริมได้โดยใช้เมธอด 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();
}