Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 5ae088dc027b89517b896a89a0aeb2ca80f492cf / . / docs / dyn / script_v1.projects.versions.html
blob: d6a8078a4d1b20380a09e0c68449b7ccb6098b21 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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.versions.html">versions</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]81 <code><a href="#create">create(scriptId, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]82<p class="firstline">Creates a new immutable version using the current code, with a unique version number.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]83<p class="toc_element">
84 <code><a href="#get">get(scriptId, versionNumber, x__xgafv=None)</a></code></p>
85<p class="firstline">Gets a version of a script project.</p>
86<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]87 <code><a href="#list">list(scriptId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]88<p class="firstline">List the versions of a 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<h3>Method Details</h3>
93<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]94 <code class="details" id="close">close()</code>
95 <pre>Close httplib2 connections.</pre>
96</div>
97
98<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]99 <code class="details" id="create">create(scriptId, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]100 <pre>Creates a new immutable version using the current code, with a unique version number.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]101
102Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]103 scriptId: string, The script project&#x27;s Drive ID. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]104 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]105 The object takes the form of:
106
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]107{ # A resource representing a script project version. A version is a &quot;snapshot&quot; of a script project and is similar to a read-only branched release. When creating deployments, the version to use must be specified.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]108 &quot;scriptId&quot;: &quot;A String&quot;, # The script project&#x27;s Drive ID.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]109 &quot;description&quot;: &quot;A String&quot;, # The description for this version.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]110 &quot;createTime&quot;: &quot;A String&quot;, # When the version was created.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]111 &quot;versionNumber&quot;: 42, # The incremental ID that is created by Apps Script when a version is created. This is system assigned number and is immutable once created.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]112}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]113
114 x__xgafv: string, V1 error format.
115 Allowed values
116 1 - v1 error format
117 2 - v2 error format
118
119Returns:
120 An object of the form:
121
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]122 { # A resource representing a script project version. A version is a &quot;snapshot&quot; of a script project and is similar to a read-only branched release. When creating deployments, the version to use must be specified.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]123 &quot;scriptId&quot;: &quot;A String&quot;, # The script project&#x27;s Drive ID.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]124 &quot;description&quot;: &quot;A String&quot;, # The description for this version.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]125 &quot;createTime&quot;: &quot;A String&quot;, # When the version was created.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]126 &quot;versionNumber&quot;: 42, # The incremental ID that is created by Apps Script when a version is created. This is system assigned number and is immutable once created.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]127 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]128</div>
129
130<div class="method">
131 <code class="details" id="get">get(scriptId, versionNumber, x__xgafv=None)</code>
132 <pre>Gets a version of a script project.
133
134Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]135 scriptId: string, The script project&#x27;s Drive ID. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]136 versionNumber: integer, The version number. (required)
137 x__xgafv: string, V1 error format.
138 Allowed values
139 1 - v1 error format
140 2 - v2 error format
141
142Returns:
143 An object of the form:
144
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]145 { # A resource representing a script project version. A version is a &quot;snapshot&quot; of a script project and is similar to a read-only branched release. When creating deployments, the version to use must be specified.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]146 &quot;scriptId&quot;: &quot;A String&quot;, # The script project&#x27;s Drive ID.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]147 &quot;description&quot;: &quot;A String&quot;, # The description for this version.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]148 &quot;createTime&quot;: &quot;A String&quot;, # When the version was created.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]149 &quot;versionNumber&quot;: 42, # The incremental ID that is created by Apps Script when a version is created. This is system assigned number and is immutable once created.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]150 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]151</div>
152
153<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]154 <code class="details" id="list">list(scriptId, pageSize=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]155 <pre>List the versions of a script project.
156
157Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]158 scriptId: string, The script project&#x27;s Drive ID. (required)
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]159 pageSize: integer, The maximum number of versions on each returned page. Defaults to 50.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]160 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]161 x__xgafv: string, V1 error format.
162 Allowed values
163 1 - v1 error format
164 2 - v2 error format
165
166Returns:
167 An object of the form:
168
169 { # Response with the list of the versions for the specified script project.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]170 &quot;nextPageToken&quot;: &quot;A String&quot;, # The token use to fetch the next page of records. if not exist in the response, that means no more versions to list.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]171 &quot;versions&quot;: [ # The list of versions.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]172 { # A resource representing a script project version. A version is a &quot;snapshot&quot; of a script project and is similar to a read-only branched release. When creating deployments, the version to use must be specified.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]173 &quot;scriptId&quot;: &quot;A String&quot;, # The script project&#x27;s Drive ID.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]174 &quot;description&quot;: &quot;A String&quot;, # The description for this version.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]175 &quot;createTime&quot;: &quot;A String&quot;, # When the version was created.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]176 &quot;versionNumber&quot;: 42, # The incremental ID that is created by Apps Script when a version is created. This is system assigned number and is immutable once created.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]177 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]178 ],
179 }</pre>
180</div>
181
182<div class="method">
183 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
184 <pre>Retrieves the next page of results.
185
186Args:
187 previous_request: The request for the previous page. (required)
188 previous_response: The response from the request for the previous page. (required)
189
190Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]191 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]192 page. Returns None if there are no more items in the collection.
193 </pre>
194</div>
195
196</body></html>