管理项目

本部分简要介绍了可用于创建、读取、修改和监控 Google Apps 脚本项目的 Google Apps 脚本 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 版本。当脚本作为触发器、在脚本编辑器中、在 Google Workspace 插件预览模式下执行时,或者当脚本作为开发模式下的 Web 应用或 Apps 脚本 API 执行时,系统会使用该版本。

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

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

读取项目指标

projects.getMetrics

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

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