1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="script_v1.html">Apps Script API</a> . <a href="script_v1.projects.html">projects</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="script_v1.projects.deployments.html">deployments()</a></code>
</p>
<p class="firstline">Returns the deployments Resource.</p>
<p class="toc_element">
<code><a href="script_v1.projects.versions.html">versions()</a></code>
</p>
<p class="firstline">Returns the versions Resource.</p>
<p class="toc_element">
<code><a href="#create">create(body, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new, empty script project with no script files and a base</p>
<p class="toc_element">
<code><a href="#get">get(scriptId, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a script project's metadata.</p>
<p class="toc_element">
<code><a href="#getContent">getContent(scriptId, versionNumber=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the content of the script project, including the code source and</p>
<p class="toc_element">
<code><a href="#getMetrics">getMetrics(scriptId, metricsFilter_deploymentId=None, x__xgafv=None, metricsGranularity=None)</a></code></p>
<p class="firstline">Get metrics data for scripts, such as number of executions and</p>
<p class="toc_element">
<code><a href="#updateContent">updateContent(scriptId, body, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the content of the specified script project.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(body, x__xgafv=None)</code>
<pre>Creates a new, empty script project with no script files and a base
manifest file.
Args:
body: object, The request body. (required)
The object takes the form of:
{ # Request to create a script project.
"title": "A String", # The title for the project.
"parentId": "A String", # The Drive ID of a parent file that the created script project is bound to.
# This is usually the ID of a Google Doc, Google Sheet, Google Form, or
# Google Slides file. If not set, a standalone script project is created.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The script project resource.
"updateTime": "A String", # When the script was last updated.
"lastModifyUser": { # A simple user profile resource. # User who last modified the script.
"domain": "A String", # The user's domain.
"email": "A String", # The user's identifying email address.
"name": "A String", # The user's display name.
"photoUrl": "A String", # The user's photo.
},
"title": "A String", # The title for the project.
"creator": { # A simple user profile resource. # User who originally created the script.
"domain": "A String", # The user's domain.
"email": "A String", # The user's identifying email address.
"name": "A String", # The user's display name.
"photoUrl": "A String", # The user's photo.
},
"scriptId": "A String", # The script project's Drive ID.
"parentId": "A String", # The parent's Drive ID that the script will be attached to. This is usually
# the ID of a Google Document or Google Sheet. This filed is optional, and
# if not set, a stand-alone script will be created.
"createTime": "A String", # When the script was created.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(scriptId, x__xgafv=None)</code>
<pre>Gets a script project's metadata.
Args:
scriptId: string, The script project's Drive ID. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The script project resource.
"updateTime": "A String", # When the script was last updated.
"lastModifyUser": { # A simple user profile resource. # User who last modified the script.
"domain": "A String", # The user's domain.
"email": "A String", # The user's identifying email address.
"name": "A String", # The user's display name.
"photoUrl": "A String", # The user's photo.
},
"title": "A String", # The title for the project.
"creator": { # A simple user profile resource. # User who originally created the script.
"domain": "A String", # The user's domain.
"email": "A String", # The user's identifying email address.
"name": "A String", # The user's display name.
"photoUrl": "A String", # The user's photo.
},
"scriptId": "A String", # The script project's Drive ID.
"parentId": "A String", # The parent's Drive ID that the script will be attached to. This is usually
# the ID of a Google Document or Google Sheet. This filed is optional, and
# if not set, a stand-alone script will be created.
"createTime": "A String", # When the script was created.
}</pre>
</div>
<div class="method">
<code class="details" id="getContent">getContent(scriptId, versionNumber=None, x__xgafv=None)</code>
<pre>Gets the content of the script project, including the code source and
metadata for each script file.
Args:
scriptId: string, The script project's Drive ID. (required)
versionNumber: integer, The version number of the project to retrieve. If not provided, the
project's HEAD version is returned.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The Content resource.
"files": [ # The list of script project files.
# One of the files is a script manifest; it must be named "appsscript",
# must have type of JSON, and include the manifest configurations for the
# project.
{ # An individual file within a script project.
# A file is a third-party source code created by one or more
# developers. It can be a server-side JS code, HTML, or a
# configuration file. Each script project can contain multiple files.
"updateTime": "A String", # Last modified date timestamp.
# This read-only field is only visible to users who have WRITER
# permission for the script project.
"lastModifyUser": { # A simple user profile resource. # The user who modified the file most recently.
# This read-only field is only visible to users who have WRITER
# permission for the script project.
"domain": "A String", # The user's domain.
"email": "A String", # The user's identifying email address.
"name": "A String", # The user's display name.
"photoUrl": "A String", # The user's photo.
},
"source": "A String", # The file content.
"functionSet": { # A set of functions. No duplicates are permitted. # The defined set of functions in the script file, if any.
"values": [ # A list of functions composing the set.
{ # Represents a function in a script project.
"name": "A String", # The function name in the script project.
},
],
},
"type": "A String", # The type of the file.
"createTime": "A String", # Creation date timestamp.
# This read-only field is only visible to users who have WRITER
# permission for the script project.
"name": "A String", # The name of the file. The file extension is not part of the file
# name, which can be identified from the type field.
},
],
"scriptId": "A String", # The script project's Drive ID.
}</pre>
</div>
<div class="method">
<code class="details" id="getMetrics">getMetrics(scriptId, metricsFilter_deploymentId=None, x__xgafv=None, metricsGranularity=None)</code>
<pre>Get metrics data for scripts, such as number of executions and
active users.
Args:
scriptId: string, Required field indicating the script to get metrics for. (required)
metricsFilter_deploymentId: string, Optional field indicating a specific deployment to retrieve metrics from.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
metricsGranularity: string, Required field indicating what granularity of metrics are returned.
Returns:
An object of the form:
{ # Resource containing usage stats for a given script, based on the supplied
# filter and mask present in the request.
"totalExecutions": [ # Number of total executions.
{ # Metrics value that holds number of executions counted.
"endTime": "A String", # Required field indicating the end time of the interval.
"startTime": "A String", # Required field indicating the start time of the interval.
"value": "A String", # Indicates the number of executions counted.
},
],
"activeUsers": [ # Number of active users.
{ # Metrics value that holds number of executions counted.
"endTime": "A String", # Required field indicating the end time of the interval.
"startTime": "A String", # Required field indicating the start time of the interval.
"value": "A String", # Indicates the number of executions counted.
},
],
"failedExecutions": [ # Number of failed executions.
{ # Metrics value that holds number of executions counted.
"endTime": "A String", # Required field indicating the end time of the interval.
"startTime": "A String", # Required field indicating the start time of the interval.
"value": "A String", # Indicates the number of executions counted.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="updateContent">updateContent(scriptId, body, x__xgafv=None)</code>
<pre>Updates the content of the specified script project.
This content is stored as the HEAD version, and is used when the script is
executed as a trigger, in the script editor, in add-on preview mode, or as
a web app or Apps Script API in development mode. This clears all the
existing files in the project.
Args:
scriptId: string, The script project's Drive ID. (required)
body: object, The request body. (required)
The object takes the form of:
{ # The Content resource.
"files": [ # The list of script project files.
# One of the files is a script manifest; it must be named "appsscript",
# must have type of JSON, and include the manifest configurations for the
# project.
{ # An individual file within a script project.
# A file is a third-party source code created by one or more
# developers. It can be a server-side JS code, HTML, or a
# configuration file. Each script project can contain multiple files.
"updateTime": "A String", # Last modified date timestamp.
# This read-only field is only visible to users who have WRITER
# permission for the script project.
"lastModifyUser": { # A simple user profile resource. # The user who modified the file most recently.
# This read-only field is only visible to users who have WRITER
# permission for the script project.
"domain": "A String", # The user's domain.
"email": "A String", # The user's identifying email address.
"name": "A String", # The user's display name.
"photoUrl": "A String", # The user's photo.
},
"source": "A String", # The file content.
"functionSet": { # A set of functions. No duplicates are permitted. # The defined set of functions in the script file, if any.
"values": [ # A list of functions composing the set.
{ # Represents a function in a script project.
"name": "A String", # The function name in the script project.
},
],
},
"type": "A String", # The type of the file.
"createTime": "A String", # Creation date timestamp.
# This read-only field is only visible to users who have WRITER
# permission for the script project.
"name": "A String", # The name of the file. The file extension is not part of the file
# name, which can be identified from the type field.
},
],
"scriptId": "A String", # The script project's Drive ID.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The Content resource.
"files": [ # The list of script project files.
# One of the files is a script manifest; it must be named "appsscript",
# must have type of JSON, and include the manifest configurations for the
# project.
{ # An individual file within a script project.
# A file is a third-party source code created by one or more
# developers. It can be a server-side JS code, HTML, or a
# configuration file. Each script project can contain multiple files.
"updateTime": "A String", # Last modified date timestamp.
# This read-only field is only visible to users who have WRITER
# permission for the script project.
"lastModifyUser": { # A simple user profile resource. # The user who modified the file most recently.
# This read-only field is only visible to users who have WRITER
# permission for the script project.
"domain": "A String", # The user's domain.
"email": "A String", # The user's identifying email address.
"name": "A String", # The user's display name.
"photoUrl": "A String", # The user's photo.
},
"source": "A String", # The file content.
"functionSet": { # A set of functions. No duplicates are permitted. # The defined set of functions in the script file, if any.
"values": [ # A list of functions composing the set.
{ # Represents a function in a script project.
"name": "A String", # The function name in the script project.
},
],
},
"type": "A String", # The type of the file.
"createTime": "A String", # Creation date timestamp.
# This read-only field is only visible to users who have WRITER
# permission for the script project.
"name": "A String", # The name of the file. The file extension is not part of the file
# name, which can be identified from the type field.
},
],
"scriptId": "A String", # The script project's Drive ID.
}</pre>
</div>
</body></html>
|
