Google Workspace add-ons API

  • This service, gsuiteaddons.googleapis.com, provides REST APIs for managing Google Workspace Add-ons deployments.

  • You can use Google-provided client libraries or your own libraries with the provided discovery document and service endpoint information to interact with the APIs.

  • The v1.projects resource allows you to retrieve authorization details for add-on deployments in a project.

  • The v1.projects.deployments resource offers methods to create, delete, retrieve, install, list, replace, and uninstall add-on deployments.

  • Use the service endpoint https://gsuiteaddons.googleapis.com as the base URL for all API requests.

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

REST Resource: v1.projects

Methods
getAuthorization GET /v1/{name=projects/*/authorization}
Gets the authorization information for deployments in a given project.

REST Resource: v1.projects.deployments

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.