为何Google Workspace表格插件辅助函数访问SpreadsheetApp会返回null？

我正在用Apps Script开发Google Workspace表格插件，目标是让用户搜索电子表格内的标签页。主卡片渲染入口函数onHomepage中调用SpreadsheetApp.getActiveSpreadsheet().getSheets()能正常运行，但refreshSuggestions函数里调用时会报错：Cannot read properties of null (reading 'getSheets')。

我怀疑是refreshSuggestions的作用域问题？有讨论提到插件需要绑定表格才能访问数据，但我要做的是能在任意打开的表格上使用的插件，而且onHomepage里的调用完全正常。我试过谷歌开发者教程示例中的getSheetsSelection()调用SpreadsheetApp.getActiveSpreadsheet()也没问题，还调整了OAuth权限范围，当前清单文件如下。

相关代码 #

onHomepage函数 #

function onHomepage(e) {
  SpreadsheetApp.getActiveSpreadsheet().getSheets().forEach(function(sheet) {
    Logger.log(sheet.getSheetName());
  })
  return createSidebar(e);
}

createSidebar函数 #

function createSidebar(e) {
  var card = CardService.newCardBuilder();
  card.setHeader(CardService.newCardHeader().setTitle('Search Tabs'));

  // 创建带动态建议列表的输入框
  var action = CardService.newAction()
      .setFunctionName('refreshSuggestions');
  var input1 = CardService.newTextInput()
      .setFieldName('searchInput')
      .setTitle('Search')
      .setSuggestionsAction(action);

  var section = CardService.newCardSection();
  section.addWidget(input1);
  card.addSection(section);

  return [card.build()];
}

refreshSuggestions函数 #

function refreshSuggestions(e) {

  var sheets = SpreadsheetApp.getActive().getSheets();
  var sheets = ss.getSheets();

  var userInput = e && e.formInput['searchInput'].toLowerCase();

  var arrayOfSheets = [];
  tabs.forEach(function(tab) {

    if (tab.toLowerCase().indexOf(userInput) !== -1)
    arrayOfSheets.push(tab.getName());
  });
  arrayOfSheets.sort();

  return CardService.newSuggestionsResponseBuilder()
        .setSuggestions(CardService.newSuggestions()
        .addSuggestions(arrayOfSheets))
      .build();

  }

清单文件 #

{
  "timeZone": "America/New_York",
  "dependencies": {},
  "exceptionLogging": "STACKDRIVER",
  "oauthScopes": [
    "https://www.googleapis.com/auth/spreadsheets.currentonly"
  ],
  "runtimeVersion": "V8",
  "addOns": {
    "common": {
      "name": "Get Tabs",
      "layoutProperties": {
        "primaryColor": "#2772ed"
      },
      "homepageTrigger": {
        "runFunction": "onHomepage"
      }
    },
    "sheets" : {}
  }
}

请问该问题的原因是什么，如何解决？

问题原因 #

1. 变量未定义的低级错误：refreshSuggestions函数中，你先定义了sheets变量，紧接着又写了var sheets = ss.getSheets();，但ss变量从未被声明过；后续遍历的tabs变量也未定义，应该是要遍历sheets数组。这两个错误直接导致了报错。
2. 上下文验证问题：虽然onHomepage能正常获取活动表格，但如果直接在Apps Script编辑器中运行refreshSuggestions，会因为没有表格上下文导致getActiveSpreadsheet()返回null，但你的核心问题还是代码本身的变量错误。

解决步骤 #

1. 修复refreshSuggestions函数的代码错误
   修正后的函数代码如下，解决了未定义变量、空输入处理等问题：

   function refreshSuggestions(e) {
     // 正确获取当前活动表格的所有工作表
     var sheets = SpreadsheetApp.getActiveSpreadsheet().getSheets();
     // 处理用户输入为空的情况
     var userInput = (e && e.formInput['searchInput']) ? e.formInput['searchInput'].toLowerCase() : '';
   
     var arrayOfSheets = [];
     sheets.forEach(function(sheet) {
       var sheetName = sheet.getSheetName().toLowerCase();
       // 空输入时返回所有工作表，否则匹配输入内容
       if (userInput === '' || sheetName.indexOf(userInput) !== -1) {
         arrayOfSheets.push(sheet.getSheetName());
       }
     });
     arrayOfSheets.sort();
   
     return CardService.newSuggestionsResponseBuilder()
           .setSuggestions(CardService.newSuggestions().addSuggestions(arrayOfSheets))
         .build();
   }
   

2. 验证运行上下文

   • 当前的spreadsheets.currentonly权限已经足够访问打开的表格，无需调整。
   • 不要直接在编辑器中运行refreshSuggestions，必须在表格的插件界面中输入内容，触发建议刷新逻辑，确保函数在表格上下文内执行。

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