Google Workspace add-ons API
Stay organized with collections
Save and categorize content based on your preferences.
Service: gsuiteaddons.googleapis.com
To call this service, we recommend that you use the Google-provided client libraries. If your application needs to use your own libraries to call this service, use the following information when you make the API requests.
Discovery document
A Discovery Document 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:
Service endpoint
A 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:
https://gsuiteaddons.googleapis.com
| Methods |
getAuthorization |
GET /v1/{name=projects/*/authorization}
Gets the authorization information for deployments in a given project. |
| Methods |
create |
POST /v1/{parent=projects/*}/deployments
Creates a deployment with the specified name and configuration. |
delete |
DELETE /v1/{name=projects/*/deployments/*}
Deletes the deployment with the given name. |
get |
GET /v1/{name=projects/*/deployments/*}
Gets the deployment with the specified name. |
getInstallStatus |
GET /v1/{name=projects/*/deployments/*/installStatus}
Gets the install status of a test deployment. |
install |
POST /v1/{name=projects/*/deployments/*}:install
Installs a deployment to your account for testing. |
list |
GET /v1/{parent=projects/*}/deployments
Lists all deployments in a particular project. |
replaceDeployment |
PUT /v1/{deployment.name=projects/*/deployments/*}
Creates or replaces a deployment with the specified name. |
uninstall |
POST /v1/{name=projects/*/deployments/*}:uninstall
Uninstalls a test deployment from the user’s account. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-02-27 UTC.
[null,null,["Last updated 2025-02-27 UTC."],[[["\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. |"]]
