执行 Apps 脚本函数

借助 Apps 脚本 API（以前称为 Apps 脚本执行 API），您可以远程执行您有权访问的脚本项目中的函数。您的应用可以调用给定的 Apps 脚本函数，并在需要时为其提供输入参数，然后接收返回的响应。

本页面的示例展示了如何使用该 API 实现一些常见的执行操作。如需了解详情（包括特殊的授权要求），请参阅执行函数指南。

在这些示例中，占位符 scriptId 用于指示您提供脚本项目 ID 的位置。请按照以下步骤查找脚本 ID：

  1. 在 Apps 脚本项目中，点击左上角的项目设置图标 。
  2. 点击“脚本 ID”旁边的复制。

执行函数

以下 scripts.run 请求调用名为 listFolderContent 的 Apps 脚本函数，并向其传递 Drive folderId 和整数 MAX_SIZE 作为实参。该函数在开发模式下执行，这意味着无论部署为可执行文件的版本是什么，系统都会执行最近保存的函数版本。

请求协议如下所示。执行函数指南介绍了如何使用 Google API 客户端库以不同语言实现运行请求。

POST https://script.googleapis.com/v1/scripts/scriptId:run
 
{
  "function": "listFolderContent",
  "parameters": [
    folderId,
    MAX_SIZE
  ],
  "devMode": true
}

此请求的响应（在调用的 Apps 脚本函数完成后）包含执行结果或错误响应。在此示例中，该函数成功返回了一个文件名数组：

{
  "response": {
    "result": [
      "fileTitle1",
      "fileTitle2",
      "fileTitle3"
    ]
  },
}

如果函数在执行 Apps 脚本期间遇到错误，响应可能如下所示：

{
  "response": {
    "error": {
      "code": 3,
      "message": "ScriptError",
      "details": [{
        "@type": "type.googleapis.com/google.apps.script.v1.ExecutionError",
        "errorMessage": "The script enountered an exeception it could not resolve.",
        "errorType": "ScriptError",
        "scriptStackTraceElements": [{
          "function": "listFolderContent",
          "lineNumber": 14
        }]
      }]
    }
  }
}