Method: projects.deployments.install

  • Installs a specified add-on deployment to your account for testing purposes.

  • Utilizes an HTTP POST request to the designated endpoint with the deployment's resource name.

  • Requires an empty request body and returns an empty JSON object upon successful installation.

  • Needs authorization with the https://www.googleapis.com/auth/cloud-platform scope.

  • Grants permission through specific IAM roles for deployment installation.

Installs a deployment to your account for testing. For more information, see Test your add-on

HTTP request

POST https://gsuiteaddons.googleapis.com/v1/{name=projects/*/deployments/*}:install

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The full resource name of the deployment to install.

Example: projects/my_project/deployments/my_deployment.

Authorization requires the following IAM permission on the specified resource name:

  • gsuiteaddons.deployments.install

Request body

The request body must be empty.

Response body

If successful, the response body is an empty JSON object.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authorization guide.