如何让Google Workspace插件的homepageTrigger多次触发？

我们开发了一款通过侧边栏运行的Google Workspace插件，使用homepageTrigger让用户从右侧菜单打开侧边栏。功能首次运行正常，但页面加载后仅能触发一次；用户打开并关闭侧边栏后，再次通过右侧菜单尝试打开会出现错误页面。需要解决如何让homepageTrigger对应的函数每次都能正常运行。

现有配置与代码 #

appsscript.json配置

{"timeZone": "Australia/Sydney","exceptionLogging": "STACKDRIVER","runtimeVersion": "V8","dependencies": {"enabledAdvancedServices": [{"userSymbol": "Drive","serviceId": "drive","version": "v2"}]},"oauthScopes": ["https://www.googleapis.com/auth/script.scriptapp","https://www.googleapis.com/auth/documents.currentonly","https://www.googleapis.com/auth/spreadsheets","https://www.googleapis.com/auth/presentations","https://www.googleapis.com/auth/script.container.ui","https://www.googleapis.com/auth/drive","https://www.googleapis.com/auth/drive.apps.readonly","https://www.googleapis.com/auth/script.external_request","https://www.googleapis.com/auth/script.locale","https://www.googleapis.com/auth/userinfo.email"],"urlFetchWhitelist": ["https://cm234-wgs-1.icognition.cloud/","https://docs.google.com/feeds/download/documents/export/Export","https://docs.google.com/spreadsheets/export","https://docs.google.com/feeds/download/presentations/Export"],"addOns": {"common": {"name": "Content Manager","logoUrl": "https://cm234-wgs-1.icognition.cloud/CMServiceApiGoogle/TrimIcon/W64h64/trim.png","homepageTrigger": {"runFunction": "showSidebar","enabled": true}},"sheets": {},"docs": {},"slides": {}}}

showSidebar函数

function showSidebar() {var sidebarName = "sidebar";if (getRecordUri() !== 0) {sidebarName = "existing_record_sidebar";}var ui = HtmlService.createHtmlOutputFromFile(sidebarName).setTitle("Content Manager");DocumentApp.getUi().showSidebar(ui);}

解决方案 #

核心问题

homepageTrigger的原生设计是文档加载时仅触发一次，重复点击右侧菜单不会重新调用绑定的showSidebar函数，而是尝试复用已失效的侧边栏实例，这就是报错的直接原因。

方案1：改用自定义顶部菜单项（推荐）

完全绕过homepageTrigger的限制，通过自定义菜单项触发侧边栏，每次点击都会重新执行showSidebar函数：

1. 修改appsscript.json，移除common下的homepageTrigger配置段；
2. 添加以下GS代码，实现安装和打开文档时创建自定义菜单：

function onInstall(e) {
  onOpen(e);
}

function onOpen(e) {
  // 根据插件适配的产品切换对应API：Docs用DocumentApp，Sheets用SpreadsheetApp，Slides用SlidesApp
  const ui = DocumentApp.getUi();
  ui.createMenu('Content Manager')
    .addItem('打开侧边栏', 'showSidebar')
    .addToUi();
}

用户点击自定义菜单项时，会每次调用showSidebar生成全新的侧边栏实例，彻底解决重复打开报错的问题。

方案2：修复homepageTrigger复用问题（仅限特殊场景）

如果必须保留右侧菜单的触发方式，可通过以下方式优化，但稳定性不如方案1：

1. 在侧边栏的HTML文件中添加关闭清理逻辑，避免实例残留：

<script>
  window.addEventListener('unload', () => {
    google.script.run.cleanupSidebar();
  });
</script>

2. 在GS代码中添加清理函数，重置可能的全局状态：

function cleanupSidebar() {
  // 清空全局变量或缓存数据，比如重置getRecordUri依赖的状态
}

3. 修改showSidebar函数，添加缓存规避逻辑：

function showSidebar() {
  let sidebarName = "sidebar";
  if (getRecordUri() !== 0) {
    sidebarName = "existing_record_sidebar";
  }
  // 生成带随机参数的HTML输出，避免浏览器缓存旧实例
  const ui = HtmlService.createHtmlOutputFromFile(sidebarName)
    .setTitle("Content Manager")
    .setSandboxMode(HtmlService.SandboxMode.IFRAME);
  DocumentApp.getUi().showSidebar(ui);
}

额外注意事项

确保getRecordUri函数每次调用都能获取最新数据，不会因为全局变量或缓存导致返回值异常，这也是侧边栏加载错误的潜在原因。

内容的提问来源于stack exchange，提问作者Jan Martin