• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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="#create">create(scriptId, body, x__xgafv=None)</a></code></p>
79<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">
87  <code><a href="#list">list(scriptId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
88<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">
93  <code><a href="#update">update(scriptId, deploymentId, body, x__xgafv=None)</a></code></p>
94<p class="firstline">Updates a deployment of an Apps Script project.</p>
95<h3>Method Details</h3>
96<div class="method">
97    <code class="details" id="create">create(scriptId, body, x__xgafv=None)</code>
98  <pre>Creates a deployment of an Apps Script project.
99
100Args:
101  scriptId: string, The script project's Drive ID. (required)
102  body: object, The request body. (required)
103    The object takes the form of:
104
105{ # Metadata the defines how a deployment is configured.
106    "manifestFileName": "A String", # The manifest file name for this deployment.
107    "versionNumber": 42, # The version number on which this deployment is based.
108    "scriptId": "A String", # The script project's Drive ID.
109    "description": "A String", # The description for this deployment.
110  }
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.
121    "entryPoints": [ # The deployment's entry points.
122      { # A configuration that defines how a deployment is accessed externally.
123        "entryPointType": "A String", # The type of the entry point.
124        "webApp": { # A web application entry point. # An entry point specification for web apps.
125          "url": "A String", # The URL for the web application.
126          "entryPointConfig": { # Web app entry point configuration. # The entry point's configuration.
127            "access": "A String", # Who has permission to run the web app.
128            "executeAs": "A String", # Who to execute the web app as.
129          },
130        },
131        "executionApi": { # An API executable entry point. # An entry point specification for Apps Script API execution calls.
132          "entryPointConfig": { # API executable entry point configuration. # The entry point's configuration.
133            "access": "A String", # Who has permission to run the API executable.
134          },
135        },
136        "addOn": { # An add-on entry point. # Add-on properties.
137          "reportIssueUrl": "A String", # The add-on's optional report issue URL.
138          "postInstallTipUrl": "A String", # The add-on's required post install tip URL.
139          "description": "A String", # The add-on's optional description.
140          "title": "A String", # The add-on's required title.
141          "addOnType": "A String", # The add-on's required list of supported container types.
142          "helpUrl": "A String", # The add-on's optional help URL.
143        },
144      },
145    ],
146    "deploymentId": "A String", # The deployment ID for this deployment.
147    "updateTime": "A String", # Last modified date time stamp.
148    "deploymentConfig": { # Metadata the defines how a deployment is configured. # The deployment configuration.
149        "manifestFileName": "A String", # The manifest file name for this deployment.
150        "versionNumber": 42, # The version number on which this deployment is based.
151        "scriptId": "A String", # The script project's Drive ID.
152        "description": "A String", # The description for this deployment.
153      },
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:
162  scriptId: string, The script project's Drive ID. (required)
163  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:
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    "entryPoints": [ # The deployment's entry points.
201      { # A configuration that defines how a deployment is accessed externally.
202        "entryPointType": "A String", # The type of the entry point.
203        "webApp": { # A web application entry point. # An entry point specification for web apps.
204          "url": "A String", # The URL for the web application.
205          "entryPointConfig": { # Web app entry point configuration. # The entry point's configuration.
206            "access": "A String", # Who has permission to run the web app.
207            "executeAs": "A String", # Who to execute the web app as.
208          },
209        },
210        "executionApi": { # An API executable entry point. # An entry point specification for Apps Script API execution calls.
211          "entryPointConfig": { # API executable entry point configuration. # The entry point's configuration.
212            "access": "A String", # Who has permission to run the API executable.
213          },
214        },
215        "addOn": { # An add-on entry point. # Add-on properties.
216          "reportIssueUrl": "A String", # The add-on's optional report issue URL.
217          "postInstallTipUrl": "A String", # The add-on's required post install tip URL.
218          "description": "A String", # The add-on's optional description.
219          "title": "A String", # The add-on's required title.
220          "addOnType": "A String", # The add-on's required list of supported container types.
221          "helpUrl": "A String", # The add-on's optional help URL.
222        },
223      },
224    ],
225    "deploymentId": "A String", # The deployment ID for this deployment.
226    "updateTime": "A String", # Last modified date time stamp.
227    "deploymentConfig": { # Metadata the defines how a deployment is configured. # The deployment configuration.
228        "manifestFileName": "A String", # The manifest file name for this deployment.
229        "versionNumber": 42, # The version number on which this deployment is based.
230        "scriptId": "A String", # The script project's Drive ID.
231        "description": "A String", # The description for this deployment.
232      },
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
244should be set to the value of `nextPageToken` from a previous response.
245  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.
254    "nextPageToken": "A String", # The token that can be used in the next call to get the next page of
255        # results.
256    "deployments": [ # The list of deployments.
257      { # Representation of a single script deployment.
258        "entryPoints": [ # The deployment's entry points.
259          { # A configuration that defines how a deployment is accessed externally.
260            "entryPointType": "A String", # The type of the entry point.
261            "webApp": { # A web application entry point. # An entry point specification for web apps.
262              "url": "A String", # The URL for the web application.
263              "entryPointConfig": { # Web app entry point configuration. # The entry point's configuration.
264                "access": "A String", # Who has permission to run the web app.
265                "executeAs": "A String", # Who to execute the web app as.
266              },
267            },
268            "executionApi": { # An API executable entry point. # An entry point specification for Apps Script API execution calls.
269              "entryPointConfig": { # API executable entry point configuration. # The entry point's configuration.
270                "access": "A String", # Who has permission to run the API executable.
271              },
272            },
273            "addOn": { # An add-on entry point. # Add-on properties.
274              "reportIssueUrl": "A String", # The add-on's optional report issue URL.
275              "postInstallTipUrl": "A String", # The add-on's required post install tip URL.
276              "description": "A String", # The add-on's optional description.
277              "title": "A String", # The add-on's required title.
278              "addOnType": "A String", # The add-on's required list of supported container types.
279              "helpUrl": "A String", # The add-on's optional help URL.
280            },
281          },
282        ],
283        "deploymentId": "A String", # The deployment ID for this deployment.
284        "updateTime": "A String", # Last modified date time stamp.
285        "deploymentConfig": { # Metadata the defines how a deployment is configured. # The deployment configuration.
286            "manifestFileName": "A String", # The manifest file name for this deployment.
287            "versionNumber": 42, # The version number on which this deployment is based.
288            "scriptId": "A String", # The script project's Drive ID.
289            "description": "A String", # The description for this deployment.
290          },
291      },
292    ],
293  }</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:
305  A request object that you can call 'execute()' on to request the next
306  page. Returns None if there are no more items in the collection.
307    </pre>
308</div>
309
310<div class="method">
311    <code class="details" id="update">update(scriptId, deploymentId, body, x__xgafv=None)</code>
312  <pre>Updates a deployment of an Apps Script project.
313
314Args:
315  scriptId: string, The script project's Drive ID. (required)
316  deploymentId: string, The deployment ID for this deployment. (required)
317  body: object, The request body. (required)
318    The object takes the form of:
319
320{ # Request with deployment information to update an existing deployment.
321    "deploymentConfig": { # Metadata the defines how a deployment is configured. # The deployment configuration.
322        "manifestFileName": "A String", # The manifest file name for this deployment.
323        "versionNumber": 42, # The version number on which this deployment is based.
324        "scriptId": "A String", # The script project's Drive ID.
325        "description": "A String", # The description for this deployment.
326      },
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.
338    "entryPoints": [ # The deployment's entry points.
339      { # A configuration that defines how a deployment is accessed externally.
340        "entryPointType": "A String", # The type of the entry point.
341        "webApp": { # A web application entry point. # An entry point specification for web apps.
342          "url": "A String", # The URL for the web application.
343          "entryPointConfig": { # Web app entry point configuration. # The entry point's configuration.
344            "access": "A String", # Who has permission to run the web app.
345            "executeAs": "A String", # Who to execute the web app as.
346          },
347        },
348        "executionApi": { # An API executable entry point. # An entry point specification for Apps Script API execution calls.
349          "entryPointConfig": { # API executable entry point configuration. # The entry point's configuration.
350            "access": "A String", # Who has permission to run the API executable.
351          },
352        },
353        "addOn": { # An add-on entry point. # Add-on properties.
354          "reportIssueUrl": "A String", # The add-on's optional report issue URL.
355          "postInstallTipUrl": "A String", # The add-on's required post install tip URL.
356          "description": "A String", # The add-on's optional description.
357          "title": "A String", # The add-on's required title.
358          "addOnType": "A String", # The add-on's required list of supported container types.
359          "helpUrl": "A String", # The add-on's optional help URL.
360        },
361      },
362    ],
363    "deploymentId": "A String", # The deployment ID for this deployment.
364    "updateTime": "A String", # Last modified date time stamp.
365    "deploymentConfig": { # Metadata the defines how a deployment is configured. # The deployment configuration.
366        "manifestFileName": "A String", # The manifest file name for this deployment.
367        "versionNumber": 42, # The version number on which this deployment is based.
368        "scriptId": "A String", # The script project's Drive ID.
369        "description": "A String", # The description for this deployment.
370      },
371  }</pre>
372</div>
373
374</body></html>