如何在Google Sheets中通过代码终止Google Apps Script执行？

问题背景 #

能否在Google Sheets的脚本端停止/取消执行？是否有可用的类可以实现，还是仅能通过在目标函数中设置return语句来终止？

场景：打开带有“Start”和“Stop”按钮的侧边栏，点击“Start”启动脚本，点击“Stop”时希望终止该特定执行流程。点击事件代码如下：

function runDomains() {
  const input = {
    col : 1,
    row: 1,
    toogleCheck: document.querySelector('#flexSwitchCheckChecked').classList[1]
  }
  console.log(input);
  runButton.innerText = 'Working...';
  runButton.disabled = true;
  google.script.run.withSuccessHandler(done).startScript(input)
}

此前仅找到论坛提到用函数内return的方案，想了解更完整的实现方式。

可行实现方案 #

Google Apps Script没有提供直接强制终止服务器端脚本的API或类，无法通过客户端“Stop”按钮直接叫停已发起的google.script.run请求。要实现终止效果，需通过「标记位检查」手动控制执行流程，步骤如下：

1. 定义全局终止标记
   在服务器端脚本中声明全局变量作为终止开关，初始设为false：

   let isExecutionStopped = false;
   

2. 客户端触发终止指令
   给“Stop”按钮绑定点击事件，调用服务器端函数切换标记状态：

   // 客户端Stop按钮点击逻辑
   function stopExecution() {
     google.script.run.setStopFlag(true);
     runButton.innerText = 'Start';
     runButton.disabled = false;
   }
   

3. 服务器端函数检查标记并终止
   在startScript的业务逻辑中，定期插入标记检查点，一旦标记为true就用return终止执行：

   // 服务器端：更新终止标记的函数
   function setStopFlag(flag) {
     isExecutionStopped = flag;
   }
   
   function startScript(input) {
     // 每次启动前重置标记，避免上次终止状态影响新执行
     isExecutionStopped = false;
     
     // 示例：循环处理任务的场景
     const totalTasks = 100;
     for (let i = 0; i < totalTasks; i++) {
       // 执行业务逻辑前先检查终止标记
       if (isExecutionStopped) {
         return; // 终止后续流程
       }
       
       // 这里编写你的具体业务代码
       // 比如读写单元格、调用API等
       SpreadsheetApp.getActiveSheet().getRange(i+1, input.col).setValue(`Task ${i+1} processed`);
     }
   }
   

关键注意点 #

• 这是优雅终止的方式，无法中断正在执行的同步耗时操作（比如大文件处理、长时间API请求），只能在代码的检查点处停止后续流程。
• 如果脚本是通过时间驱动触发器执行的，需改用PropertiesService存储终止标记（全局变量在触发器环境中会重新初始化），示例：

  // 触发器场景下用脚本属性存标记
  function setStopFlag(flag) {
    PropertiesService.getScriptProperties().setProperty('isStopped', flag.toString());
  }
  
  function checkStopFlag() {
    const flag = PropertiesService.getScriptProperties().getProperty('isStopped');
    return flag === 'true';
  }
  

内容的提问来源于stack exchange，提问作者Emīls Bisenieks