用户打开工作表或单击工作表中的链接时，Google表格加载项会自动打开

Question

我创建了一个Google表格加载项。 但是，它在附加菜单中有点隐藏。 当用户打开工作表或单击工作表中的链接时，是否可以自动启用附加组件？ 我搜索了Google表格文档，但一无所获。

EDIT1：

由于自动打开插件侧栏似乎​​是不好的用户体验，因此如何通过单击工作表中的链接来打开呢？ 让用户选择通过单击附加组件插入的工作表中的链接来打开侧边栏。

Answer 1

当然，您可以获取一个UI组件，该组件的附件在打开文档时自动打开。 这是插件的可怕行为，并且永远不应发布，因为它会干扰其他插件。 但是仍然可以做到。

但是有一些限制。

• 必须为该文档启用加载项。 请参阅附加授权生命周期 。
• 根据插件执行的操作，可能需要用户授权。 例如，如果UserA和UserB共享一个文档，并且UserA安装并授权了该加载项，则UserB也会看到该加载项已启用，但是需要单独对其进行授权才能使其在其帐户上运行。

这就像在onOpen()函数中添加对showSidebar()的调用那样简单，因为它不需要任何类型的授权。

function onOpen(e) {
  var ui = SpreadsheetApp.getUi()
      .createAddonMenu()
      .addItem('Show sidebar', 'showSidebar')
      .addItem('Show dialog', 'showDialog')
      .addToUi();

    // Display sidebar
    showSidebar();
}

但是，如果我们希望选择启用和禁用该行为怎么办？ onOpen()可以有一个菜单项来控制行为，而不是一味地打开附加组件侧栏，并且仅在启用时打开附加组件。

/**
 * Adds a custom menu with items to show the sidebar and dialog.
 *
 * @param {Object} e The event parameter for a simple onOpen trigger.
 */
function onOpen(e) {
  var ui = SpreadsheetApp.getUi()
      .createAddonMenu()
      .addItem('Show sidebar', 'showSidebar')
      .addItem('Show dialog', 'showDialog')
      .addSeparator()
      .addItem(autoEnabled_()?"Disable auto-sidebar":"Enable auto-sidebar", "autoToggle_")
      .addToUi();

    // Display sidebar if auto-sidebar is enabled
    if (autoEnabled_()) showSidebar();
}

现在，我们介​​绍了两个与自动侧栏的控制相关的功能： autoEnabled_()和autoToggle_() 。 第一个似乎告诉我们自动侧边栏的启用状态，而第二个似乎更改状态，并且在菜单项中作为字符串参数提供（...因此它不能接受参数）。

由于自动显示仅在打开文档时才重要，因此我们将需要某种方式来记住用户在两次使用文档之间的设置。 可以使用PropertyService来解决。 但是，我们需要小心，因为该服务需要授权。 由于这是一个附加组件，将在首次安装时与ScriptApp.AuthMode.NONE运行， ScriptApp.AuthMode.NONE我们不能依赖能够访问该服务。 因此，在这种情况下，将其包装在try...catch块中。

为了使代码易于维护，最好将诸如PropertyService之类的“混乱”函数放在一个地方。 “ Messy”，因为它依赖于字符串映射来存储和检索数据，并且我们的代码中的简单错字会引入难以发现的错误。 为了降低这种长期的质量成本，我们可以通过将状态切换为读取当前设置的子情况，将所需的两个功能组合为一个。 下面是导致autoEnabled_()函数，用autoToggle_()简单地提供一个参数回到autoEnabled_()改变状态。

/**
 * Get status of auto-sidebar, and optionally change it.
 *
 * @var {any} optSet  (optional) Any truthy value will change the setting.
 *
 * @returns {Boolean} Returns true if enabled, false if not.
 *                    Always returns false if ScriptApp.AuthMode.NONE.
 */
function autoEnabled_(optSet) {
  try {
    var autoState = PropertiesService.getUserProperties().getProperty('autoState');
  }
  catch (e) {
    // Called with ScriptApp.AuthMode.NONE
    return false;
  }

  if (optSet) {
    autoState = (autoState == 'enabled')?'disabled':'enabled';
    PropertiesService.getUserProperties()
                     .setProperty('autoState',autoState);
    // Re-run the onOpen function to update menu
    onOpen({authMode:ScriptApp.AuthMode.LIMITED});
  }

  return autoState == 'enabled';
}

/**
 * Toggle state of auto-sidebar.
 */
function autoToggle_() {autoEnabled_('toggle');}  // remove underscore and call from debugger to enable logs w/o UI

完整的代码段显示在下面。 要进行尝试，请从编辑器中作为模板提供的通用“添加”脚本开始，然后用片段中的代码替换原始的onOpen() 。

 /** * Adds a custom menu with items to show the sidebar and dialog. * * @param {Object} e The event parameter for a simple onOpen trigger. */ function onOpen(e) { var ui = SpreadsheetApp.getUi() .createAddonMenu() .addItem('Show sidebar', 'showSidebar') .addItem('Show dialog', 'showDialog') .addSeparator() .addItem(autoEnabled_()?"Disable auto-sidebar":"Enable auto-sidebar", "autoToggle_") .addToUi(); // Display sidebar if auto-sidebar is enabled if (autoEnabled_()) showSidebar(); } /** * Get status of auto-sidebar, and optionally change it. * * @var {any} optSet (optional) Any truthy value will change the setting. * * @returns {Boolean} Returns true if enabled, false if not. * Always returns false if ScriptApp.AuthMode.NONE. */ function autoEnabled_(optSet) { try { var autoState = PropertiesService.getUserProperties().getProperty('autoState'); } catch (e) { // Called with ScriptApp.AuthMode.NONE return false; } if (optSet) { autoState = (autoState == 'enabled')?'disabled':'enabled'; PropertiesService.getUserProperties() .setProperty('autoState',autoState); // Re-run the onOpen function to update menu onOpen({authMode:ScriptApp.AuthMode.LIMITED}); } return autoState == 'enabled'; } /** * Toggle state of auto-sidebar. */ function autoToggle_() {autoEnabled_('toggle');} // remove underscore and call from debugger to enable logs w/o UI 

承认

感谢Serge早在我们首次合作附加概念时就向我提出了这个想法！