通过 Apps Script API(以前是 Apps Script Execution API),您可以 在您有权访问的脚本项目中远程执行函数。您的 应用可以调用指定的 Apps 脚本函数,并在出现以下情况时为其提供输入参数: 并接收返回的响应。
本页面上的示例说明了一些常见的执行操作 通过 API 实现有关详情,包括 授权要求 请参阅执行函数指南。
在这些示例中,占位符 scriptId 用于指明在何处提供脚本项目 ID。按照 按以下步骤查找脚本 ID:
- 在 Apps 脚本项目中,点击左上角的项目设置 。
- 在“脚本 ID”旁边点击复制。
执行函数
以下 scripts.run
请求调用名为 listFolderContent
的 Apps 脚本函数,并向其传递该函数
云端硬盘 folderId 和一个整数 MAX_SIZE
作为参数。通过
函数在开发模式下执行,这意味着最近的
所执行函数的保存版本,无论其为哪个
作为可执行文件进行部署
请求协议如下所示。通过 执行函数指南 展示了如何使用 Google Cloud 控制台 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 }] }] } } }