管理项目

本部分简要介绍了可用于创建、读取、修改和监控 Apps Script 项目的 Apps Script API 方法。项目管理示例页面显示了 API 管理请求示例。每个方法的参考文档都提供了实现详情。

API 方法概览
创建项目

projects.create

结果:创建一个基本空项目,其中没有项目文件和默认的项目清单

选项:您可以提供项目标题。您还可以通过提供 Google 文档、Google 表格、Google 表单或 Google 幻灯片文件的 Google 云端硬盘 ID 来创建绑定脚本,以用作脚本的父级。

读取项目元数据

projects.get

结果:检索 Project 对象,该对象表示项目元数据。这些数据包括项目标题、脚本 ID、创建者、创建时间和其他详细信息。

阅读项目内容

projects.getContent

结果:返回一个 File 对象数组,每个项目中的代码和 HTML 文件对应一个对象。该列表还包含 JSON 文件形式的项目清单。文件对象包含文件的源内容 (File.source) 和其他元数据,例如文件中的函数列表 (File.functionSet)。

选项:您可以使用查询参数指定要检索的内容的版本

更新项目内容

projects.updateContent

结果:更改脚本项目中的文件内容。 您可以将新内容作为 File 对象数组提供。其中一个 File 对象必须是 JSON 类型,并表示脚本项目的新项目清单。新内容会存储为项目的 HEAD 版本。当脚本在脚本编辑器中、插件预览模式下或开发模式下作为触发器执行时,就会使用此参数。

注意:更新脚本项目内容时,常见做法是先发出 projects.getContent 请求以检索现有 File 的数组,对这些对象执行所需操作,然后将 File 用作 projects.updateContent 请求的输入。

警告:新内容会替换脚本项目中的所有现有文件。系统会移除未通过请求更新的文件。

读取项目指标

projects.getMetrics

结果:读取与项目相关的特定指标。 这些指标包括用户数、执行总数、执行错误总数和其他详细信息。 使用 MetricType 指定您请求的信息。

选项:使用 MetricsFilter 将结果限制为特定部署或脚本函数。 您还可以使用 MetricsIntervalConfig 定义特定的指标间隔时间。