blob: 1ea25f27f7dea3ffeb9b754ce51e005e6863e4d0 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001<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">
Dan O'Mearadd494642020-05-01 07:42:23 -070078 <code><a href="#create">create(scriptId, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070079<p class="firstline">Creates a deployment of an Apps Script project.</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(scriptId, deploymentId, x__xgafv=None)</a></code></p>
82<p class="firstline">Deletes a deployment of an Apps Script project.</p>
83<p class="toc_element">
84 <code><a href="#get">get(scriptId, deploymentId, x__xgafv=None)</a></code></p>
85<p class="firstline">Gets a deployment of an Apps Script project.</p>
86<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -070087 <code><a href="#list">list(scriptId, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070088<p class="firstline">Lists the deployments of an Apps Script project.</p>
89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070093 <code><a href="#update">update(scriptId, deploymentId, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070094<p class="firstline">Updates a deployment of an Apps Script project.</p>
95<h3>Method Details</h3>
96<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -070097 <code class="details" id="create">create(scriptId, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070098 <pre>Creates a deployment of an Apps Script project.
99
100Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700101 scriptId: string, The script project&#x27;s Drive ID. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700102 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700103 The object takes the form of:
104
105{ # Metadata the defines how a deployment is configured.
Bu Sun Kim65020912020-05-20 12:08:20 -0700106 &quot;scriptId&quot;: &quot;A String&quot;, # The script project&#x27;s Drive ID.
107 &quot;description&quot;: &quot;A String&quot;, # The description for this deployment.
108 &quot;manifestFileName&quot;: &quot;A String&quot;, # The manifest file name for this deployment.
109 &quot;versionNumber&quot;: 42, # The version number on which this deployment is based.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700110 }
111
112 x__xgafv: string, V1 error format.
113 Allowed values
114 1 - v1 error format
115 2 - v2 error format
116
117Returns:
118 An object of the form:
119
120 { # Representation of a single script deployment.
Bu Sun Kim65020912020-05-20 12:08:20 -0700121 &quot;deploymentId&quot;: &quot;A String&quot;, # The deployment ID for this deployment.
122 &quot;updateTime&quot;: &quot;A String&quot;, # Last modified date time stamp.
123 &quot;entryPoints&quot;: [ # The deployment&#x27;s entry points.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700124 { # A configuration that defines how a deployment is accessed externally.
Bu Sun Kim65020912020-05-20 12:08:20 -0700125 &quot;executionApi&quot;: { # An API executable entry point. # An entry point specification for Apps Script API execution calls.
126 &quot;entryPointConfig&quot;: { # API executable entry point configuration. # The entry point&#x27;s configuration.
127 &quot;access&quot;: &quot;A String&quot;, # Who has permission to run the API executable.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700128 },
129 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700130 &quot;webApp&quot;: { # A web application entry point. # An entry point specification for web apps.
131 &quot;entryPointConfig&quot;: { # Web app entry point configuration. # The entry point&#x27;s configuration.
132 &quot;access&quot;: &quot;A String&quot;, # Who has permission to run the web app.
133 &quot;executeAs&quot;: &quot;A String&quot;, # Who to execute the web app as.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700134 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700135 &quot;url&quot;: &quot;A String&quot;, # The URL for the web application.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700136 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700137 &quot;entryPointType&quot;: &quot;A String&quot;, # The type of the entry point.
138 &quot;addOn&quot;: { # An add-on entry point. # Add-on properties.
139 &quot;title&quot;: &quot;A String&quot;, # The add-on&#x27;s required title.
140 &quot;description&quot;: &quot;A String&quot;, # The add-on&#x27;s optional description.
141 &quot;reportIssueUrl&quot;: &quot;A String&quot;, # The add-on&#x27;s optional report issue URL.
142 &quot;addOnType&quot;: &quot;A String&quot;, # The add-on&#x27;s required list of supported container types.
143 &quot;postInstallTipUrl&quot;: &quot;A String&quot;, # The add-on&#x27;s required post install tip URL.
144 &quot;helpUrl&quot;: &quot;A String&quot;, # The add-on&#x27;s optional help URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700145 },
146 },
147 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700148 &quot;deploymentConfig&quot;: { # Metadata the defines how a deployment is configured. # The deployment configuration.
149 &quot;scriptId&quot;: &quot;A String&quot;, # The script project&#x27;s Drive ID.
150 &quot;description&quot;: &quot;A String&quot;, # The description for this deployment.
151 &quot;manifestFileName&quot;: &quot;A String&quot;, # The manifest file name for this deployment.
152 &quot;versionNumber&quot;: 42, # The version number on which this deployment is based.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700153 },
154 }</pre>
155</div>
156
157<div class="method">
158 <code class="details" id="delete">delete(scriptId, deploymentId, x__xgafv=None)</code>
159 <pre>Deletes a deployment of an Apps Script project.
160
161Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700162 scriptId: string, The script project&#x27;s Drive ID. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700163 deploymentId: string, The deployment ID to be undeployed. (required)
164 x__xgafv: string, V1 error format.
165 Allowed values
166 1 - v1 error format
167 2 - v2 error format
168
169Returns:
170 An object of the form:
171
172 { # A generic empty message that you can re-use to avoid defining duplicated
173 # empty messages in your APIs. A typical example is to use it as the request
174 # or the response type of an API method. For instance:
175 #
176 # service Foo {
177 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
178 # }
179 #
180 # 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:
Bu Sun Kim65020912020-05-20 12:08:20 -0700189 scriptId: string, The script project&#x27;s Drive ID. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700190 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700200 &quot;deploymentId&quot;: &quot;A String&quot;, # The deployment ID for this deployment.
201 &quot;updateTime&quot;: &quot;A String&quot;, # Last modified date time stamp.
202 &quot;entryPoints&quot;: [ # The deployment&#x27;s entry points.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700203 { # A configuration that defines how a deployment is accessed externally.
Bu Sun Kim65020912020-05-20 12:08:20 -0700204 &quot;executionApi&quot;: { # An API executable entry point. # An entry point specification for Apps Script API execution calls.
205 &quot;entryPointConfig&quot;: { # API executable entry point configuration. # The entry point&#x27;s configuration.
206 &quot;access&quot;: &quot;A String&quot;, # Who has permission to run the API executable.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700207 },
208 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700209 &quot;webApp&quot;: { # A web application entry point. # An entry point specification for web apps.
210 &quot;entryPointConfig&quot;: { # Web app entry point configuration. # The entry point&#x27;s configuration.
211 &quot;access&quot;: &quot;A String&quot;, # Who has permission to run the web app.
212 &quot;executeAs&quot;: &quot;A String&quot;, # Who to execute the web app as.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700213 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700214 &quot;url&quot;: &quot;A String&quot;, # The URL for the web application.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700215 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700216 &quot;entryPointType&quot;: &quot;A String&quot;, # The type of the entry point.
217 &quot;addOn&quot;: { # An add-on entry point. # Add-on properties.
218 &quot;title&quot;: &quot;A String&quot;, # The add-on&#x27;s required title.
219 &quot;description&quot;: &quot;A String&quot;, # The add-on&#x27;s optional description.
220 &quot;reportIssueUrl&quot;: &quot;A String&quot;, # The add-on&#x27;s optional report issue URL.
221 &quot;addOnType&quot;: &quot;A String&quot;, # The add-on&#x27;s required list of supported container types.
222 &quot;postInstallTipUrl&quot;: &quot;A String&quot;, # The add-on&#x27;s required post install tip URL.
223 &quot;helpUrl&quot;: &quot;A String&quot;, # The add-on&#x27;s optional help URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700224 },
225 },
226 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700227 &quot;deploymentConfig&quot;: { # Metadata the defines how a deployment is configured. # The deployment configuration.
228 &quot;scriptId&quot;: &quot;A String&quot;, # The script project&#x27;s Drive ID.
229 &quot;description&quot;: &quot;A String&quot;, # The description for this deployment.
230 &quot;manifestFileName&quot;: &quot;A String&quot;, # The manifest file name for this deployment.
231 &quot;versionNumber&quot;: 42, # The version number on which this deployment is based.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700232 },
233 }</pre>
234</div>
235
236<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700237 <code class="details" id="list">list(scriptId, pageToken=None, pageSize=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700238 <pre>Lists the deployments of an Apps Script project.
239
240Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700241 scriptId: string, The script project&#x27;s Drive ID. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700242 pageToken: string, The token for continuing a previous list request on the next page. This
243should be set to the value of `nextPageToken` from a previous response.
Bu Sun Kim65020912020-05-20 12:08:20 -0700244 pageSize: integer, The maximum number of deployments on each returned page. Defaults to 50.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700245 x__xgafv: string, V1 error format.
246 Allowed values
247 1 - v1 error format
248 2 - v2 error format
249
250Returns:
251 An object of the form:
252
253 { # Response with the list of deployments for the specified Apps Script project.
Bu Sun Kim65020912020-05-20 12:08:20 -0700254 &quot;deployments&quot;: [ # The list of deployments.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700255 { # Representation of a single script deployment.
Bu Sun Kim65020912020-05-20 12:08:20 -0700256 &quot;deploymentId&quot;: &quot;A String&quot;, # The deployment ID for this deployment.
257 &quot;updateTime&quot;: &quot;A String&quot;, # Last modified date time stamp.
258 &quot;entryPoints&quot;: [ # The deployment&#x27;s entry points.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700259 { # A configuration that defines how a deployment is accessed externally.
Bu Sun Kim65020912020-05-20 12:08:20 -0700260 &quot;executionApi&quot;: { # An API executable entry point. # An entry point specification for Apps Script API execution calls.
261 &quot;entryPointConfig&quot;: { # API executable entry point configuration. # The entry point&#x27;s configuration.
262 &quot;access&quot;: &quot;A String&quot;, # Who has permission to run the API executable.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700263 },
264 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700265 &quot;webApp&quot;: { # A web application entry point. # An entry point specification for web apps.
266 &quot;entryPointConfig&quot;: { # Web app entry point configuration. # The entry point&#x27;s configuration.
267 &quot;access&quot;: &quot;A String&quot;, # Who has permission to run the web app.
268 &quot;executeAs&quot;: &quot;A String&quot;, # Who to execute the web app as.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700269 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700270 &quot;url&quot;: &quot;A String&quot;, # The URL for the web application.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700271 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700272 &quot;entryPointType&quot;: &quot;A String&quot;, # The type of the entry point.
273 &quot;addOn&quot;: { # An add-on entry point. # Add-on properties.
274 &quot;title&quot;: &quot;A String&quot;, # The add-on&#x27;s required title.
275 &quot;description&quot;: &quot;A String&quot;, # The add-on&#x27;s optional description.
276 &quot;reportIssueUrl&quot;: &quot;A String&quot;, # The add-on&#x27;s optional report issue URL.
277 &quot;addOnType&quot;: &quot;A String&quot;, # The add-on&#x27;s required list of supported container types.
278 &quot;postInstallTipUrl&quot;: &quot;A String&quot;, # The add-on&#x27;s required post install tip URL.
279 &quot;helpUrl&quot;: &quot;A String&quot;, # The add-on&#x27;s optional help URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700280 },
281 },
282 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700283 &quot;deploymentConfig&quot;: { # Metadata the defines how a deployment is configured. # The deployment configuration.
284 &quot;scriptId&quot;: &quot;A String&quot;, # The script project&#x27;s Drive ID.
285 &quot;description&quot;: &quot;A String&quot;, # The description for this deployment.
286 &quot;manifestFileName&quot;: &quot;A String&quot;, # The manifest file name for this deployment.
287 &quot;versionNumber&quot;: 42, # The version number on which this deployment is based.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700288 },
289 },
290 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700291 &quot;nextPageToken&quot;: &quot;A String&quot;, # The token that can be used in the next call to get the next page of
292 # results.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700293 }</pre>
294</div>
295
296<div class="method">
297 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
298 <pre>Retrieves the next page of results.
299
300Args:
301 previous_request: The request for the previous page. (required)
302 previous_response: The response from the request for the previous page. (required)
303
304Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700305 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700306 page. Returns None if there are no more items in the collection.
307 </pre>
308</div>
309
310<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700311 <code class="details" id="update">update(scriptId, deploymentId, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700312 <pre>Updates a deployment of an Apps Script project.
313
314Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700315 scriptId: string, The script project&#x27;s Drive ID. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700316 deploymentId: string, The deployment ID for this deployment. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700317 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700318 The object takes the form of:
319
320{ # Request with deployment information to update an existing deployment.
Bu Sun Kim65020912020-05-20 12:08:20 -0700321 &quot;deploymentConfig&quot;: { # Metadata the defines how a deployment is configured. # The deployment configuration.
322 &quot;scriptId&quot;: &quot;A String&quot;, # The script project&#x27;s Drive ID.
323 &quot;description&quot;: &quot;A String&quot;, # The description for this deployment.
324 &quot;manifestFileName&quot;: &quot;A String&quot;, # The manifest file name for this deployment.
325 &quot;versionNumber&quot;: 42, # The version number on which this deployment is based.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700326 },
327 }
328
329 x__xgafv: string, V1 error format.
330 Allowed values
331 1 - v1 error format
332 2 - v2 error format
333
334Returns:
335 An object of the form:
336
337 { # Representation of a single script deployment.
Bu Sun Kim65020912020-05-20 12:08:20 -0700338 &quot;deploymentId&quot;: &quot;A String&quot;, # The deployment ID for this deployment.
339 &quot;updateTime&quot;: &quot;A String&quot;, # Last modified date time stamp.
340 &quot;entryPoints&quot;: [ # The deployment&#x27;s entry points.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700341 { # A configuration that defines how a deployment is accessed externally.
Bu Sun Kim65020912020-05-20 12:08:20 -0700342 &quot;executionApi&quot;: { # An API executable entry point. # An entry point specification for Apps Script API execution calls.
343 &quot;entryPointConfig&quot;: { # API executable entry point configuration. # The entry point&#x27;s configuration.
344 &quot;access&quot;: &quot;A String&quot;, # Who has permission to run the API executable.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700345 },
346 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700347 &quot;webApp&quot;: { # A web application entry point. # An entry point specification for web apps.
348 &quot;entryPointConfig&quot;: { # Web app entry point configuration. # The entry point&#x27;s configuration.
349 &quot;access&quot;: &quot;A String&quot;, # Who has permission to run the web app.
350 &quot;executeAs&quot;: &quot;A String&quot;, # Who to execute the web app as.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700351 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700352 &quot;url&quot;: &quot;A String&quot;, # The URL for the web application.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700353 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700354 &quot;entryPointType&quot;: &quot;A String&quot;, # The type of the entry point.
355 &quot;addOn&quot;: { # An add-on entry point. # Add-on properties.
356 &quot;title&quot;: &quot;A String&quot;, # The add-on&#x27;s required title.
357 &quot;description&quot;: &quot;A String&quot;, # The add-on&#x27;s optional description.
358 &quot;reportIssueUrl&quot;: &quot;A String&quot;, # The add-on&#x27;s optional report issue URL.
359 &quot;addOnType&quot;: &quot;A String&quot;, # The add-on&#x27;s required list of supported container types.
360 &quot;postInstallTipUrl&quot;: &quot;A String&quot;, # The add-on&#x27;s required post install tip URL.
361 &quot;helpUrl&quot;: &quot;A String&quot;, # The add-on&#x27;s optional help URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700362 },
363 },
364 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700365 &quot;deploymentConfig&quot;: { # Metadata the defines how a deployment is configured. # The deployment configuration.
366 &quot;scriptId&quot;: &quot;A String&quot;, # The script project&#x27;s Drive ID.
367 &quot;description&quot;: &quot;A String&quot;, # The description for this deployment.
368 &quot;manifestFileName&quot;: &quot;A String&quot;, # The manifest file name for this deployment.
369 &quot;versionNumber&quot;: 42, # The version number on which this deployment is based.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700370 },
371 }</pre>
372</div>
373
374</body></html>