Google Workspace add-ons API
使用集合让一切井井有条
根据您的偏好保存内容并对其进行分类。
服务：gsuiteaddons.googleapis.com
如要调用此服务，我们建议您使用 Google 提供的客户端库。如果您的应用需要使用您自己的库来调用此服务，则在发出 API 请求时应使用以下信息。
发现文档
发现文档是用于说明和使用 REST API 的机器可读规范。它用于构建客户端库、IDE 插件以及与 Google API 交互的其他工具。一项服务可能会提供多个发现文档。此服务提供了以下发现文档：
服务端点
服务端点是指定 API 服务的网络地址的基本网址。一项服务可能有多个服务端点。此服务具有以下服务端点，下面的所有 URI 都与此服务端点相关：
https://gsuiteaddons.googleapis.com
| 方法 |
create |
POST /v1/{parent=projects/*}/deployments（
）
创建具有指定名称和配置的部署。 |
delete |
DELETE /v1/{name=projects/*/deployments/*}（
）
删除具有给定名称的部署。 |
get |
GET /v1/{name=projects/*/deployments/*}（
）
获取具有指定名称的部署。 |
getInstallStatus |
GET /v1/{name=projects/*/deployments/*/installStatus}（
）
获取测试部署的安装状态。 |
install |
POST /v1/{name=projects/*/deployments/*}:install（
）
将部署安装到您的账号以进行测试。 |
list |
GET /v1/{parent=projects/*}/deployments（
）
列出特定项目中的所有部署。 |
replaceDeployment |
PUT /v1/{deployment.name=projects/*/deployments/*}（
）
使用指定名称创建或替换部署。 |
uninstall |
POST /v1/{name=projects/*/deployments/*}:uninstall（
）
从用户的账号中卸载测试部署。 |
如未另行说明，那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可，并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情，请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC)：2025-07-25。
[null,null,["最后更新时间 (UTC)：2025-07-25。"],[[["\u003cp\u003eThis service, \u003ccode\u003egsuiteaddons.googleapis.com\u003c/code\u003e, provides REST APIs for managing Google Workspace Add-ons deployments.\u003c/p\u003e\n"],["\u003cp\u003eYou can use Google-provided client libraries or your own libraries with the provided discovery document and service endpoint information to interact with the APIs.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ev1.projects\u003c/code\u003e resource allows you to retrieve authorization details for add-on deployments in a project.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ev1.projects.deployments\u003c/code\u003e resource offers methods to create, delete, retrieve, install, list, replace, and uninstall add-on deployments.\u003c/p\u003e\n"],["\u003cp\u003eUse the service endpoint \u003ccode\u003ehttps://gsuiteaddons.googleapis.com\u003c/code\u003e as the base URL for all API requests.\u003c/p\u003e\n"]]],["The `gsuiteaddons.googleapis.com` service provides REST resources for managing projects and their deployments. Key actions for `v1.projects.deployments` include creating, deleting, getting, listing, and replacing deployments, and getting the install status. Additionally, deployments can be installed or uninstalled. The `v1.projects` resource supports retrieving authorization information for deployments. The API utilizes a base URL `https://gsuiteaddons.googleapis.com` and offers a Discovery Document for machine-readable specifications.\n"],null,["# Google Workspace add-ons API\n\n- [REST Resource: v1.projects](#v1.projects)\n- [REST Resource: v1.projects.deployments](#v1.projects.deployments)\n\nService: gsuiteaddons.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://gsuiteaddons.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://gsuiteaddons.googleapis.com`\n\nREST Resource: [v1.projects](/workspace/add-ons/reference/rest/v1/projects)\n---------------------------------------------------------------------------\n\n| Methods ||\n|------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------|\n| [getAuthorization](/workspace/add-ons/reference/rest/v1/projects/getAuthorization) | `GET /v1/{name=projects/*/authorization}` Gets the authorization information for deployments in a given project. |\n\nREST Resource: [v1.projects.deployments](/workspace/add-ons/reference/rest/v1/projects.deployments)\n---------------------------------------------------------------------------------------------------\n\n| Methods ||\n|--------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------|\n| [create](/workspace/add-ons/reference/rest/v1/projects.deployments/create) | `POST /v1/{parent=projects/*}/deployments` Creates a deployment with the specified name and configuration. |\n| [delete](/workspace/add-ons/reference/rest/v1/projects.deployments/delete) | `DELETE /v1/{name=projects/*/deployments/*}` Deletes the deployment with the given name. |\n| [get](/workspace/add-ons/reference/rest/v1/projects.deployments/get) | `GET /v1/{name=projects/*/deployments/*}` Gets the deployment with the specified name. |\n| [getInstallStatus](/workspace/add-ons/reference/rest/v1/projects.deployments/getInstallStatus) | `GET /v1/{name=projects/*/deployments/*/installStatus}` Gets the install status of a test deployment. |\n| [install](/workspace/add-ons/reference/rest/v1/projects.deployments/install) | `POST /v1/{name=projects/*/deployments/*}:install` Installs a deployment to your account for testing. |\n| [list](/workspace/add-ons/reference/rest/v1/projects.deployments/list) | `GET /v1/{parent=projects/*}/deployments` Lists all deployments in a particular project. |\n| [replaceDeployment](/workspace/add-ons/reference/rest/v1/projects.deployments/replaceDeployment) | `PUT /v1/{deployment.name=projects/*/deployments/*}` Creates or replaces a deployment with the specified name. |\n| [uninstall](/workspace/add-ons/reference/rest/v1/projects.deployments/uninstall) | `POST /v1/{name=projects/*/deployments/*}:uninstall` Uninstalls a test deployment from the user's account. |"]]
