管理项目

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

API 方法概览
创建项目

projects.create

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

选项:您可以提供项目名称。您还可以创建绑定脚本,只需提供 Google 文档、Google 表格、Google 表单或幻灯片文件的 Google 云端硬盘 ID 作为脚本的父级即可。

读取项目元数据

projects.get

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

读取项目内容

projects.getContent

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

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

更新项目内容

projects.updateContent

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

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

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

读取项目指标

projects.getMetrics

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

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