AI-generated Key Takeaways
-
This document details how to update a deployment of an Apps Script project using a PUT request.
-
The API endpoint requires the script project's Drive ID and the specific deployment ID as path parameters.
-
The request body uses a JSON structure to specify the deployment configuration, including the version number, manifest file name, and description.
-
A successful response returns an instance of the Deployment object.
-
Updating deployments requires the
https://www.googleapis.com/auth/script.deploymentsOAuth scope for authorization.
Updates a deployment of an Apps Script project.
HTTP request
PUT https://script.googleapis.com/v1/projects/{deploymentConfig.scriptId}/deployments/{deploymentId}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters | |
|---|---|
deploymentConfig.scriptId
|
The script project's Drive ID. |
deploymentId
|
The deployment ID for this deployment. |
Request body
The request body contains data with the following structure:
| JSON representation |
|---|
{ "deploymentConfig" : { "scriptId" : string , "versionNumber" : integer , "manifestFileName" : string , "description" : string } } |
| Fields | |
|---|---|
deploymentConfig.versionNumber
|
The version number on which this deployment is based. |
deploymentConfig.manifestFileName
|
The manifest file name for this deployment. |
deploymentConfig.description
|
The description for this deployment. |
Response body
If successful, the response body contains an instance of Deployment
.
Authorization Scopes
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/script.deployments
For more information, see the OAuth 2.0 Overview .
