1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="script_v1.html">Apps Script API</a> . <a href="script_v1.projects.html">projects</a> . <a href="script_v1.projects.deployments.html">deployments</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#create">create(scriptId, body=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Creates a deployment of an Apps Script project.</p> 83<p class="toc_element"> 84 <code><a href="#delete">delete(scriptId, deploymentId, x__xgafv=None)</a></code></p> 85<p class="firstline">Deletes a deployment of an Apps Script project.</p> 86<p class="toc_element"> 87 <code><a href="#get">get(scriptId, deploymentId, x__xgafv=None)</a></code></p> 88<p class="firstline">Gets a deployment of an Apps Script project.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(scriptId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Lists the deployments of an Apps Script project.</p> 92<p class="toc_element"> 93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 94<p class="firstline">Retrieves the next page of results.</p> 95<p class="toc_element"> 96 <code><a href="#update">update(scriptId, deploymentId, body=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Updates a deployment of an Apps Script project.</p> 98<h3>Method Details</h3> 99<div class="method"> 100 <code class="details" id="close">close()</code> 101 <pre>Close httplib2 connections.</pre> 102</div> 103 104<div class="method"> 105 <code class="details" id="create">create(scriptId, body=None, x__xgafv=None)</code> 106 <pre>Creates a deployment of an Apps Script project. 107 108Args: 109 scriptId: string, The script project's Drive ID. (required) 110 body: object, The request body. 111 The object takes the form of: 112 113{ # Metadata the defines how a deployment is configured. 114 "description": "A String", # The description for this deployment. 115 "manifestFileName": "A String", # The manifest file name for this deployment. 116 "scriptId": "A String", # The script project's Drive ID. 117 "versionNumber": 42, # The version number on which this deployment is based. 118} 119 120 x__xgafv: string, V1 error format. 121 Allowed values 122 1 - v1 error format 123 2 - v2 error format 124 125Returns: 126 An object of the form: 127 128 { # Representation of a single script deployment. 129 "deploymentConfig": { # Metadata the defines how a deployment is configured. # The deployment configuration. 130 "description": "A String", # The description for this deployment. 131 "manifestFileName": "A String", # The manifest file name for this deployment. 132 "scriptId": "A String", # The script project's Drive ID. 133 "versionNumber": 42, # The version number on which this deployment is based. 134 }, 135 "deploymentId": "A String", # The deployment ID for this deployment. 136 "entryPoints": [ # The deployment's entry points. 137 { # A configuration that defines how a deployment is accessed externally. 138 "addOn": { # An add-on entry point. # Add-on properties. 139 "addOnType": "A String", # The add-on's required list of supported container types. 140 "description": "A String", # The add-on's optional description. 141 "helpUrl": "A String", # The add-on's optional help URL. 142 "postInstallTipUrl": "A String", # The add-on's required post install tip URL. 143 "reportIssueUrl": "A String", # The add-on's optional report issue URL. 144 "title": "A String", # The add-on's required title. 145 }, 146 "entryPointType": "A String", # The type of the entry point. 147 "executionApi": { # An API executable entry point. # An entry point specification for Apps Script API execution calls. 148 "entryPointConfig": { # API executable entry point configuration. # The entry point's configuration. 149 "access": "A String", # Who has permission to run the API executable. 150 }, 151 }, 152 "webApp": { # A web application entry point. # An entry point specification for web apps. 153 "entryPointConfig": { # Web app entry point configuration. # The entry point's configuration. 154 "access": "A String", # Who has permission to run the web app. 155 "executeAs": "A String", # Who to execute the web app as. 156 }, 157 "url": "A String", # The URL for the web application. 158 }, 159 }, 160 ], 161 "updateTime": "A String", # Last modified date time stamp. 162}</pre> 163</div> 164 165<div class="method"> 166 <code class="details" id="delete">delete(scriptId, deploymentId, x__xgafv=None)</code> 167 <pre>Deletes a deployment of an Apps Script project. 168 169Args: 170 scriptId: string, The script project's Drive ID. (required) 171 deploymentId: string, The deployment ID to be undeployed. (required) 172 x__xgafv: string, V1 error format. 173 Allowed values 174 1 - v1 error format 175 2 - v2 error format 176 177Returns: 178 An object of the form: 179 180 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. 181}</pre> 182</div> 183 184<div class="method"> 185 <code class="details" id="get">get(scriptId, deploymentId, x__xgafv=None)</code> 186 <pre>Gets a deployment of an Apps Script project. 187 188Args: 189 scriptId: string, The script project's Drive ID. (required) 190 deploymentId: string, The deployment ID. (required) 191 x__xgafv: string, V1 error format. 192 Allowed values 193 1 - v1 error format 194 2 - v2 error format 195 196Returns: 197 An object of the form: 198 199 { # Representation of a single script deployment. 200 "deploymentConfig": { # Metadata the defines how a deployment is configured. # The deployment configuration. 201 "description": "A String", # The description for this deployment. 202 "manifestFileName": "A String", # The manifest file name for this deployment. 203 "scriptId": "A String", # The script project's Drive ID. 204 "versionNumber": 42, # The version number on which this deployment is based. 205 }, 206 "deploymentId": "A String", # The deployment ID for this deployment. 207 "entryPoints": [ # The deployment's entry points. 208 { # A configuration that defines how a deployment is accessed externally. 209 "addOn": { # An add-on entry point. # Add-on properties. 210 "addOnType": "A String", # The add-on's required list of supported container types. 211 "description": "A String", # The add-on's optional description. 212 "helpUrl": "A String", # The add-on's optional help URL. 213 "postInstallTipUrl": "A String", # The add-on's required post install tip URL. 214 "reportIssueUrl": "A String", # The add-on's optional report issue URL. 215 "title": "A String", # The add-on's required title. 216 }, 217 "entryPointType": "A String", # The type of the entry point. 218 "executionApi": { # An API executable entry point. # An entry point specification for Apps Script API execution calls. 219 "entryPointConfig": { # API executable entry point configuration. # The entry point's configuration. 220 "access": "A String", # Who has permission to run the API executable. 221 }, 222 }, 223 "webApp": { # A web application entry point. # An entry point specification for web apps. 224 "entryPointConfig": { # Web app entry point configuration. # The entry point's configuration. 225 "access": "A String", # Who has permission to run the web app. 226 "executeAs": "A String", # Who to execute the web app as. 227 }, 228 "url": "A String", # The URL for the web application. 229 }, 230 }, 231 ], 232 "updateTime": "A String", # Last modified date time stamp. 233}</pre> 234</div> 235 236<div class="method"> 237 <code class="details" id="list">list(scriptId, pageSize=None, pageToken=None, x__xgafv=None)</code> 238 <pre>Lists the deployments of an Apps Script project. 239 240Args: 241 scriptId: string, The script project's Drive ID. (required) 242 pageSize: integer, The maximum number of deployments on each returned page. Defaults to 50. 243 pageToken: string, The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from a previous response. 244 x__xgafv: string, V1 error format. 245 Allowed values 246 1 - v1 error format 247 2 - v2 error format 248 249Returns: 250 An object of the form: 251 252 { # Response with the list of deployments for the specified Apps Script project. 253 "deployments": [ # The list of deployments. 254 { # Representation of a single script deployment. 255 "deploymentConfig": { # Metadata the defines how a deployment is configured. # The deployment configuration. 256 "description": "A String", # The description for this deployment. 257 "manifestFileName": "A String", # The manifest file name for this deployment. 258 "scriptId": "A String", # The script project's Drive ID. 259 "versionNumber": 42, # The version number on which this deployment is based. 260 }, 261 "deploymentId": "A String", # The deployment ID for this deployment. 262 "entryPoints": [ # The deployment's entry points. 263 { # A configuration that defines how a deployment is accessed externally. 264 "addOn": { # An add-on entry point. # Add-on properties. 265 "addOnType": "A String", # The add-on's required list of supported container types. 266 "description": "A String", # The add-on's optional description. 267 "helpUrl": "A String", # The add-on's optional help URL. 268 "postInstallTipUrl": "A String", # The add-on's required post install tip URL. 269 "reportIssueUrl": "A String", # The add-on's optional report issue URL. 270 "title": "A String", # The add-on's required title. 271 }, 272 "entryPointType": "A String", # The type of the entry point. 273 "executionApi": { # An API executable entry point. # An entry point specification for Apps Script API execution calls. 274 "entryPointConfig": { # API executable entry point configuration. # The entry point's configuration. 275 "access": "A String", # Who has permission to run the API executable. 276 }, 277 }, 278 "webApp": { # A web application entry point. # An entry point specification for web apps. 279 "entryPointConfig": { # Web app entry point configuration. # The entry point's configuration. 280 "access": "A String", # Who has permission to run the web app. 281 "executeAs": "A String", # Who to execute the web app as. 282 }, 283 "url": "A String", # The URL for the web application. 284 }, 285 }, 286 ], 287 "updateTime": "A String", # Last modified date time stamp. 288 }, 289 ], 290 "nextPageToken": "A String", # The token that can be used in the next call to get the next page of results. 291}</pre> 292</div> 293 294<div class="method"> 295 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 296 <pre>Retrieves the next page of results. 297 298Args: 299 previous_request: The request for the previous page. (required) 300 previous_response: The response from the request for the previous page. (required) 301 302Returns: 303 A request object that you can call 'execute()' on to request the next 304 page. Returns None if there are no more items in the collection. 305 </pre> 306</div> 307 308<div class="method"> 309 <code class="details" id="update">update(scriptId, deploymentId, body=None, x__xgafv=None)</code> 310 <pre>Updates a deployment of an Apps Script project. 311 312Args: 313 scriptId: string, The script project's Drive ID. (required) 314 deploymentId: string, The deployment ID for this deployment. (required) 315 body: object, The request body. 316 The object takes the form of: 317 318{ # Request with deployment information to update an existing deployment. 319 "deploymentConfig": { # Metadata the defines how a deployment is configured. # The deployment configuration. 320 "description": "A String", # The description for this deployment. 321 "manifestFileName": "A String", # The manifest file name for this deployment. 322 "scriptId": "A String", # The script project's Drive ID. 323 "versionNumber": 42, # The version number on which this deployment is based. 324 }, 325} 326 327 x__xgafv: string, V1 error format. 328 Allowed values 329 1 - v1 error format 330 2 - v2 error format 331 332Returns: 333 An object of the form: 334 335 { # Representation of a single script deployment. 336 "deploymentConfig": { # Metadata the defines how a deployment is configured. # The deployment configuration. 337 "description": "A String", # The description for this deployment. 338 "manifestFileName": "A String", # The manifest file name for this deployment. 339 "scriptId": "A String", # The script project's Drive ID. 340 "versionNumber": 42, # The version number on which this deployment is based. 341 }, 342 "deploymentId": "A String", # The deployment ID for this deployment. 343 "entryPoints": [ # The deployment's entry points. 344 { # A configuration that defines how a deployment is accessed externally. 345 "addOn": { # An add-on entry point. # Add-on properties. 346 "addOnType": "A String", # The add-on's required list of supported container types. 347 "description": "A String", # The add-on's optional description. 348 "helpUrl": "A String", # The add-on's optional help URL. 349 "postInstallTipUrl": "A String", # The add-on's required post install tip URL. 350 "reportIssueUrl": "A String", # The add-on's optional report issue URL. 351 "title": "A String", # The add-on's required title. 352 }, 353 "entryPointType": "A String", # The type of the entry point. 354 "executionApi": { # An API executable entry point. # An entry point specification for Apps Script API execution calls. 355 "entryPointConfig": { # API executable entry point configuration. # The entry point's configuration. 356 "access": "A String", # Who has permission to run the API executable. 357 }, 358 }, 359 "webApp": { # A web application entry point. # An entry point specification for web apps. 360 "entryPointConfig": { # Web app entry point configuration. # The entry point's configuration. 361 "access": "A String", # Who has permission to run the web app. 362 "executeAs": "A String", # Who to execute the web app as. 363 }, 364 "url": "A String", # The URL for the web application. 365 }, 366 }, 367 ], 368 "updateTime": "A String", # Last modified date time stamp. 369}</pre> 370</div> 371 372</body></html>