简介

借助 Google Apps 脚本 API,您可以在 Google Apps 脚本中自动创建、管理和执行脚本。您可以以编程方式创建、修改和部署 Google Apps 脚本项目,并远程执行 Apps 脚本函数,而无需使用 Apps 脚本编辑器或其界面。

此 API 通常用于:

  • 创建和管理 Apps 脚本项目及部署实例。
  • 在脚本项目中添加或更新函数。
  • 从其他应用执行 Apps 脚本函数。
  • 监控脚本执行日志和状态。

Apps 脚本 API 还取代并扩展了 Apps 脚本 Execution API。您可以使用 Apps 脚本 API 远程执行 Apps 脚本函数,就像使用 Execution API 一样。

如需在应用中使用此 API,您必须 启用它

如需允许其他应用管理您的脚本,您必须 向其授予访问权限

API 概览

Apps 脚本 API 分为多个资源,每个资源都有特定的用途和一组您可以发出的请求。这些资源如下所示:

  • projects :脚本项目的表示形式。该 API 提供了用于创建、读取、监控和修改项目的方法。使用此资源可管理项目的脚本文件和元数据。
  • projects.deployments :脚本部署实例的表示形式。该 API 提供了用于创建、列出、更新和删除脚本项目部署实例的方法。使用部署实例可将脚本作为 Web 应用、插件或可执行文件提供。
  • projects.versions :脚本项目版本的表示形式。该 API 提供了用于创建和读取项目版本的方法。使用版本可跟踪脚本项目的不同迭代。
  • processes :脚本函数执行的表示形式。该 API 提供了用于列出现有进程并收集有关这些进程的信息(例如类型和当前状态)的方法。使用此资源可监控使用 scripts.run 方法启动的脚本执行。
  • scripts :提供用于远程执行 Apps 脚本函数的方法的端点。 使用此资源可从应用运行脚本项目中的函数。