管理项目

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

API 方法概览
创建项目

<ph type="x-smartling-placeholder"></ph> projects.create

结果:创建一个没有项目的基本的空项目 默认 项目清单

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

读取项目元数据

<ph type="x-smartling-placeholder"></ph> projects.get

Results:检索 <ph type="x-smartling-placeholder"></ph> Project 对象表示项目元数据。这些数据包括 项目标题、脚本 ID、创建用户、创建时间等 。

读取项目内容

<ph type="x-smartling-placeholder"></ph> projects.getContent

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

选项:您可以指定 版本 使用查询参数进行检索。

更新项目内容

<ph type="x-smartling-placeholder"></ph> projects.updateContent

结果:更改脚本项目中的文件内容。 您以 File 对象的操作。这些 File 对象中的一个必须具有 JSON 类型 表示脚本项目的新 项目清单。新的 内容存储为项目的 HEAD 版本。它用于 脚本作为触发器在脚本编辑器或插件中执行 预览模式下创建,也可以在开发模式下作为 Web 应用或 Apps Script API 创建。

注意:更新脚本项目内容时, 做法是 <ph type="x-smartling-placeholder"></ph> projects.getContent 请求检索现有 File 的数组, 来满足这些对象的需要,然后将 File 用作 输入 projects.updateContent 请求。

警告:新内容替换了 现有文件。请求未更新的文件 移除。

读取项目指标

<ph type="x-smartling-placeholder"></ph> projects.getMetrics

结果:读取有关项目的某些指标。 这些指标包括用户数量、 执行次数、执行错误总数以及其他详细信息。 使用 <ph type="x-smartling-placeholder"></ph> MetricType 指定您请求的信息。

选项:将结果限制为特定部署 或者使用 <ph type="x-smartling-placeholder"></ph> MetricsFilter。 您还可以使用 <ph type="x-smartling-placeholder"></ph> MetricsIntervalConfig 的数据。