Method: projects.deployments.install
Stay organized with collections
Save and categorize content based on your preferences.
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.
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-04-22 UTC.
[null,null,["Last updated 2025-04-22 UTC."],[[["\u003cp\u003eInstalls a specified add-on deployment to your account for testing purposes.\u003c/p\u003e\n"],["\u003cp\u003eUtilizes an HTTP POST request to the designated endpoint with the deployment's resource name.\u003c/p\u003e\n"],["\u003cp\u003eRequires an empty request body and returns an empty JSON object upon successful installation.\u003c/p\u003e\n"],["\u003cp\u003eNeeds authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eGrants permission through specific IAM roles for deployment installation.\u003c/p\u003e\n"]]],["This document details the process of installing a deployment for testing via an HTTP POST request to `https://gsuiteaddons.googleapis.com/v1/{name=projects/*/deployments/*}:install`. The `name` parameter, specifying the deployment, is required and needs the `gsuiteaddons.deployments.install` IAM permission. The request body must be empty. A successful operation returns an empty JSON object. Authorization requires the `https://www.googleapis.com/auth/cloud-platform` OAuth scope. The URL uses gRPC Transcoding.\n"],null,["# Method: projects.deployments.install\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nInstalls a deployment to your account for testing. For more information, see [Test your add-on](https://developers.google.com/workspace/add-ons/guides/alternate-runtimes#test_your_add-on)\n\n### HTTP request\n\n`POST https://gsuiteaddons.googleapis.com/v1/{name=projects/*/deployments/*}:install`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Required. The full resource name of the deployment to install. Example: `projects/my_project/deployments/my_deployment`. Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `name`: - `gsuiteaddons.deployments.install` |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body is an empty JSON object.\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
