Method: projects.deployments.getInstallStatus

  • Retrieves the installation status of a specific Google Workspace Add-on deployment.

  • Requires the deployment's full resource name as a path parameter and an empty request body.

  • Returns a JSON response indicating whether the deployment is installed for the user along with the deployment's full resource name.

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

Gets the install status of a test deployment.

HTTP request

GET https://gsuiteaddons.googleapis.com/v1/{name=projects/*/deployments/*/installStatus}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The full resource name of the deployment.

Example: projects/my_project/deployments/my_deployment/installStatus.

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

  • gsuiteaddons.deployments.installStatus

Request body

The request body must be empty.

Response body

Install status of a test deployment.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "name": string,
  "installed": boolean
}
Fields
name

string

The canonical full resource name of the deployment install status.

Example: projects/123/deployments/my_deployment/installStatus.
installed

boolean

True if the deployment is installed for the user.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authorization guide.