Apps Script API
使用集合让一切井井有条
根据您的偏好保存内容并对其进行分类。
管理和执行 Google Apps 脚本项目。
服务:script.googleapis.com
要调用此服务,我们建议您使用 Google 提供的客户端库。如果您的应用程序需要使用自己的库来调用此服务,请在发出 API 请求时使用以下信息。
发现文档
发现文档是用于说明和使用 REST API 的机器可读规范。它用于构建客户端库、IDE 插件以及与 Google API 交互的其他工具。一项服务可能会提供多个发现文档。此服务提供了以下发现文档:
服务端点
服务端点是指定 API 服务的网络地址的基本网址。一项服务可能有多个服务端点。此服务具有以下服务端点,下面的所有 URI 都与此服务端点相关:
https://script.googleapis.com
方法 |
list |
GET /v1/processes
列出由用户或用户代表执行的进程的相关信息,例如进程类型和当前状态。 |
listScriptProcesses |
GET /v1/processes:listScriptProcesses
列出脚本已执行的进程的相关信息,例如进程类型和当前状态。 |
方法 |
create |
POST /v1/projects
创建一个新的空脚本项目,其中不含脚本文件和一个基本清单文件。 |
get |
GET /v1/projects/{scriptId}
获取脚本项目的元数据。 |
getContent |
GET /v1/projects/{scriptId}/content
获取脚本项目的内容,包括每个脚本文件的代码源和元数据。 |
getMetrics |
GET /v1/projects/{scriptId}/metrics
获取脚本的指标数据,例如执行次数和活跃用户数。 |
updateContent |
PUT /v1/projects/{scriptId}/content
更新指定脚本项目的内容。 |
方法 |
create |
POST /v1/projects/{scriptId}/deployments
创建 Apps 脚本项目的部署。 |
delete |
DELETE /v1/projects/{scriptId}/deployments/{deploymentId}
删除 Apps 脚本项目的部署。 |
get |
GET /v1/projects/{scriptId}/deployments/{deploymentId}
获取 Apps 脚本项目的部署。 |
list |
GET /v1/projects/{scriptId}/deployments
列出 Apps 脚本项目的部署。 |
update |
PUT /v1/projects/{deploymentConfig.scriptId}/deployments/{deploymentId}
更新 Apps 脚本项目的部署。 |
方法 |
create |
POST /v1/projects/{scriptId}/versions
使用当前代码创建新的不可变版本,具有唯一的版本号。 |
get |
GET /v1/projects/{scriptId}/versions/{versionNumber}
获取脚本项目的一个版本。 |
list |
GET /v1/projects/{scriptId}/versions
列出脚本项目的版本。 |
方法 |
run |
POST /v1/scripts/{scriptId}:run
在 Apps 脚本项目中运行函数。 |
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2025-07-26。
[null,null,["最后更新时间 (UTC):2025-07-26。"],[[["\u003cp\u003eThe Apps Script API manages and executes Google Apps Script projects, providing functionality for creating, deploying, and running scripts.\u003c/p\u003e\n"],["\u003cp\u003eIt offers REST resources for managing projects, deployments, versions, processes, and scripts themselves, allowing programmatic control over various aspects of Apps Script projects.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can leverage the API using Google-provided client libraries or their own libraries by adhering to the provided discovery document and service endpoint.\u003c/p\u003e\n"],["\u003cp\u003eThe API enables functionalities such as retrieving project metadata, updating script content, listing deployments, running script functions, and managing versions.\u003c/p\u003e\n"],["\u003cp\u003eUsers can manage and execute Google Apps Scripts projects.\u003c/p\u003e\n"]]],[],null,["# Apps Script API\n\nManages and executes Google Apps Script projects.\n\n- [REST Resource: v1.processes](#v1.processes)\n- [REST Resource: v1.projects](#v1.projects)\n- [REST Resource: v1.projects.deployments](#v1.projects.deployments)\n- [REST Resource: v1.projects.versions](#v1.projects.versions)\n- [REST Resource: v1.scripts](#v1.scripts)\n\nService: script.googleapis.com\n------------------------------\n\nTo call this service, we recommend that you use the Google-provided [client libraries](https://cloud.google.com/apis/docs/client-libraries-explained). If your application needs to use your own libraries to call this service, use the following information when you make the API requests.\n\n### Discovery document\n\nA [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:\n\n- \u003chttps://script.googleapis.com/$discovery/rest?version=v1\u003e\n\n### Service endpoint\n\nA [service endpoint](https://cloud.google.com/apis/design/glossary#api_service_endpoint) is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:\n\n- `https://script.googleapis.com`\n\nREST Resource: [v1.processes](/apps-script/api/reference/rest/v1/processes)\n---------------------------------------------------------------------------\n\n| Methods ||\n|-----------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|\n| [list](/apps-script/api/reference/rest/v1/processes/list) | `GET /v1/processes` List information about processes made by or on behalf of a user, such as process type and current status. |\n| [listScriptProcesses](/apps-script/api/reference/rest/v1/processes/listScriptProcesses) | `GET /v1/processes:listScriptProcesses` List information about a script's executed processes, such as process type and current status. |\n\nREST Resource: [v1.projects](/apps-script/api/reference/rest/v1/projects)\n-------------------------------------------------------------------------\n\n| Methods ||\n|----------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------|\n| [create](/apps-script/api/reference/rest/v1/projects/create) | `POST /v1/projects` Creates a new, empty script project with no script files and a base manifest file. |\n| [get](/apps-script/api/reference/rest/v1/projects/get) | `GET /v1/projects/{scriptId}` Gets a script project's metadata. |\n| [getContent](/apps-script/api/reference/rest/v1/projects/getContent) | `GET /v1/projects/{scriptId}/content` Gets the content of the script project, including the code source and metadata for each script file. |\n| [getMetrics](/apps-script/api/reference/rest/v1/projects/getMetrics) | `GET /v1/projects/{scriptId}/metrics` Get metrics data for scripts, such as number of executions and active users. |\n| [updateContent](/apps-script/api/reference/rest/v1/projects/updateContent) | `PUT /v1/projects/{scriptId}/content` Updates the content of the specified script project. |\n\nREST Resource: [v1.projects.deployments](/apps-script/api/reference/rest/v1/projects.deployments)\n-------------------------------------------------------------------------------------------------\n\n| Methods ||\n|--------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------|\n| [create](/apps-script/api/reference/rest/v1/projects.deployments/create) | `POST /v1/projects/{scriptId}/deployments` Creates a deployment of an Apps Script project. |\n| [delete](/apps-script/api/reference/rest/v1/projects.deployments/delete) | `DELETE /v1/projects/{scriptId}/deployments/{deploymentId}` Deletes a deployment of an Apps Script project. |\n| [get](/apps-script/api/reference/rest/v1/projects.deployments/get) | `GET /v1/projects/{scriptId}/deployments/{deploymentId}` Gets a deployment of an Apps Script project. |\n| [list](/apps-script/api/reference/rest/v1/projects.deployments/list) | `GET /v1/projects/{scriptId}/deployments` Lists the deployments of an Apps Script project. |\n| [update](/apps-script/api/reference/rest/v1/projects.deployments/update) | `PUT /v1/projects/{deploymentConfig.scriptId}/deployments/{deploymentId}` Updates a deployment of an Apps Script project. |\n\nREST Resource: [v1.projects.versions](/apps-script/api/reference/rest/v1/projects.versions)\n-------------------------------------------------------------------------------------------\n\n| Methods ||\n|-----------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------|\n| [create](/apps-script/api/reference/rest/v1/projects.versions/create) | `POST /v1/projects/{scriptId}/versions` Creates a new immutable version using the current code, with a unique version number. |\n| [get](/apps-script/api/reference/rest/v1/projects.versions/get) | `GET /v1/projects/{scriptId}/versions/{versionNumber}` Gets a version of a script project. |\n| [list](/apps-script/api/reference/rest/v1/projects.versions/list) | `GET /v1/projects/{scriptId}/versions` List the versions of a script project. |\n\nREST Resource: [v1.scripts](/apps-script/api/reference/rest/v1/scripts)\n-----------------------------------------------------------------------\n\n| Methods ||\n|-------------------------------------------------------|------------------------------------------------------------------------------|\n| [run](/apps-script/api/reference/rest/v1/scripts/run) | `POST /v1/scripts/{scriptId}:run` Runs a function in an Apps Script project. |"]]