管理项目

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

API 方法概览
创建项目

projects.create

结果:创建一个不包含任何项目文件且具有默认项目清单的基本空项目。

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

读取项目元数据

projects.get

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

阅读项目内容

projects.getContent

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

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

更新项目内容

projects.updateContent

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

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

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

读取项目指标

projects.getMetrics

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

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