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