Google Apps Script onOpen方法签名错误排查与修复

问题场景 #

我是公司所有Google Sheets报表的所有者，需要实现：用户打开报表Workbook A时，在主访问日志Workbook B的「Access Data」工作表顶部新增一行，记录用户邮箱、访问时间及Workbook A的ID。运行初始代码时触发错误：

Exception: The parameters (String) don't match the method signature for SpreadsheetApp.Spreadsheet.setActiveSheet

将setActiveSheet替换为getSheetByName后代码正常运行，现解析该错误含义及修复原理。

初始代码 #

function onOpen(e) {
  var ss = SpreadsheetApp.getActiveSpreadsheet();
  var now = Utilities.formatDate(new Date(),"GMT-5","yyyy-MM-dd HH:mm:SS");
  var user = Session.getActiveUser().getEmail();
  var destinationSS = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/xxxxxxx').setActiveSheet('Access Data');
  var originSSID = ss.getSheetId;

  destinationSS.insertRowAfter(1)
  destinationSS.getRange('A2').setValue(now)
  destinationSS.getRange('B2').setValue(user)
  destinationSS.getRange('C2').setValue(originSSID)
}

修复后代码 #

function onOpen(e) {
  var ss = SpreadsheetApp.getActiveSpreadsheet();
  var now = Utilities.formatDate(new Date(),"GMT-5","yyyy-MM-dd HH:mm:SS");
  var user = Session.getActiveUser().getEmail();
  var destinationSS = SpreadsheetApp.openByUrl("https://docs.google.com/spreadsheets/d/xxxxx").getSheetByName("Access Data")
  var originSSID = ss.getSheetId();

  destinationSS.insertRowAfter(1)
  destinationSS.getRange('A2').setValue(now)
  destinationSS.getRange('B2').setValue(user)
  destinationSS.getRange('C2').setValue(originSSID)
}

错误含义 #

SpreadsheetApp.Spreadsheet.setActiveSheet方法的参数要求是一个Sheet对象，而非字符串。初始代码中传入了工作表名称字符串'Access Data'，与方法定义的参数类型不匹配，因此触发参数不匹配的异常。

修复原理 #

1. 替换方法适配参数类型：getSheetByName是Spreadsheet对象的方法，它的参数就是工作表名称字符串，调用后会直接返回对应名称的Sheet对象，完全符合后续代码中对destinationSS的操作需求（需要调用Sheet对象的insertRowAfter、getRange等方法）。
2. 补充方法调用括号：初始代码中ss.getSheetId缺少括号，属于语法错误，修复后的代码补上()，确保正确调用方法获取工作表ID。

内容的提问来源于stack exchange，提问作者Kyle H.