v1.d.ts
87.9 KB
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
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
/// <reference types="node" />
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosPromise, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace script_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Apps Script API
*
* Manages and executes Google Apps Script projects.
*
* @example
* ```js
* const {google} = require('googleapis');
* const script = google.script('v1');
* ```
*/
export class Script {
context: APIRequestContext;
processes: Resource$Processes;
projects: Resource$Projects;
scripts: Resource$Scripts;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* The Content resource.
*/
export interface Schema$Content {
/**
* 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.
*/
files?: Schema$File[];
/**
* The script project's Drive ID.
*/
scriptId?: string | null;
}
/**
* Request to create a script project. Request to create a script project.
*/
export interface Schema$CreateProjectRequest {
/**
* 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.
*/
parentId?: string | null;
/**
* The title for the project.
*/
title?: string | null;
}
/**
* Representation of a single script deployment.
*/
export interface Schema$Deployment {
/**
* The deployment configuration.
*/
deploymentConfig?: Schema$DeploymentConfig;
/**
* The deployment ID for this deployment.
*/
deploymentId?: string | null;
/**
* The deployment's entry points.
*/
entryPoints?: Schema$EntryPoint[];
/**
* Last modified date time stamp.
*/
updateTime?: string | null;
}
/**
* Metadata the defines how a deployment is configured.
*/
export interface Schema$DeploymentConfig {
/**
* The description for this deployment.
*/
description?: string | null;
/**
* The manifest file name for this deployment.
*/
manifestFileName?: string | null;
/**
* The script project's Drive ID.
*/
scriptId?: string | null;
/**
* The version number on which this deployment is based.
*/
versionNumber?: number | null;
}
/**
* A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \} The JSON representation for `Empty` is empty JSON object `{\}`.
*/
export interface Schema$Empty {
}
/**
* A configuration that defines how a deployment is accessed externally.
*/
export interface Schema$EntryPoint {
/**
* Add-on properties.
*/
addOn?: Schema$GoogleAppsScriptTypeAddOnEntryPoint;
/**
* The type of the entry point.
*/
entryPointType?: string | null;
/**
* An entry point specification for Apps Script API execution calls.
*/
executionApi?: Schema$GoogleAppsScriptTypeExecutionApiEntryPoint;
/**
* An entry point specification for web apps.
*/
webApp?: Schema$GoogleAppsScriptTypeWebAppEntryPoint;
}
/**
* The response for executing or debugging a function in an Apps Script project.
*/
export interface Schema$ExecuteStreamResponse {
/**
* The result of the execution.
*/
result?: Schema$ScriptExecutionResult;
}
/**
* An object that provides information about the nature of an error resulting from an attempted execution of a script function using the Apps Script API. If a run call succeeds but the script function (or Apps Script itself) throws an exception, the response body's error field contains a Status object. The `Status` object's `details` field contains an array with a single one of these `ExecutionError` objects.
*/
export interface Schema$ExecutionError {
/**
* The error message thrown by Apps Script, usually localized into the user's language.
*/
errorMessage?: string | null;
/**
* The error type, for example `TypeError` or `ReferenceError`. If the error type is unavailable, this field is not included.
*/
errorType?: string | null;
/**
* An array of objects that provide a stack trace through the script to show where the execution failed, with the deepest call first.
*/
scriptStackTraceElements?: Schema$ScriptStackTraceElement[];
}
/**
* A request to run the function in a script. The script is identified by the specified `script_id`. Executing a function on a script returns results based on the implementation of the script.
*/
export interface Schema$ExecutionRequest {
/**
* If `true` and the user is an owner of the script, the script runs at the most recently saved version rather than the version deployed for use with the Apps Script API. Optional; default is `false`.
*/
devMode?: boolean | null;
/**
* The name of the function to execute in the given script. The name does not include parentheses or parameters. It can reference a function in an included library such as `Library.libFunction1`.
*/
function?: string | null;
/**
* The parameters to be passed to the function being executed. The object type for each parameter should match the expected type in Apps Script. Parameters cannot be Apps Script-specific object types (such as a `Document` or a `Calendar`); they can only be primitive types such as `string`, `number`, `array`, `object`, or `boolean`. Optional.
*/
parameters?: any[] | null;
/**
* *Deprecated*. For use with Android add-ons only. An ID that represents the user's current session in the Android app for Google Docs or Sheets, included as extra data in the [Intent](https://developer.android.com/guide/components/intents-filters.html) that launches the add-on. When an Android add-on is run with a session state, it gains the privileges of a [bound](https://developers.google.com/apps-script/guides/bound) script—that is, it can access information like the user's current cursor position (in Docs) or selected cell (in Sheets). To retrieve the state, call `Intent.getStringExtra("com.google.android.apps.docs.addons.SessionState")`. Optional.
*/
sessionState?: string | null;
}
/**
* An object that provides the return value of a function executed using the Apps Script API. If the script function returns successfully, the response body's response field contains this `ExecutionResponse` object.
*/
export interface Schema$ExecutionResponse {
/**
* The return value of the script function. The type matches the object type returned in Apps Script. Functions called using the Apps Script API cannot return Apps Script-specific objects (such as a `Document` or a `Calendar`); they can only return primitive types such as a `string`, `number`, `array`, `object`, or `boolean`.
*/
result?: any | null;
}
/**
* 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.
*/
export interface Schema$File {
/**
* Creation date timestamp. This read-only field is only visible to users who have WRITER permission for the script project.
*/
createTime?: string | null;
/**
* The defined set of functions in the script file, if any.
*/
functionSet?: Schema$GoogleAppsScriptTypeFunctionSet;
/**
* 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.
*/
lastModifyUser?: Schema$GoogleAppsScriptTypeUser;
/**
* The name of the file. The file extension is not part of the file name, which can be identified from the type field.
*/
name?: string | null;
/**
* The file content.
*/
source?: string | null;
/**
* The type of the file.
*/
type?: string | null;
/**
* Last modified date timestamp. This read-only field is only visible to users who have WRITER permission for the script project.
*/
updateTime?: string | null;
}
/**
* An add-on entry point.
*/
export interface Schema$GoogleAppsScriptTypeAddOnEntryPoint {
/**
* The add-on's required list of supported container types.
*/
addOnType?: string | null;
/**
* The add-on's optional description.
*/
description?: string | null;
/**
* The add-on's optional help URL.
*/
helpUrl?: string | null;
/**
* The add-on's required post install tip URL.
*/
postInstallTipUrl?: string | null;
/**
* The add-on's optional report issue URL.
*/
reportIssueUrl?: string | null;
/**
* The add-on's required title.
*/
title?: string | null;
}
/**
* API executable entry point configuration.
*/
export interface Schema$GoogleAppsScriptTypeExecutionApiConfig {
/**
* Who has permission to run the API executable.
*/
access?: string | null;
}
/**
* An API executable entry point.
*/
export interface Schema$GoogleAppsScriptTypeExecutionApiEntryPoint {
/**
* The entry point's configuration.
*/
entryPointConfig?: Schema$GoogleAppsScriptTypeExecutionApiConfig;
}
/**
* Represents a function in a script project.
*/
export interface Schema$GoogleAppsScriptTypeFunction {
/**
* The function name in the script project.
*/
name?: string | null;
}
/**
* A set of functions. No duplicates are permitted.
*/
export interface Schema$GoogleAppsScriptTypeFunctionSet {
/**
* A list of functions composing the set.
*/
values?: Schema$GoogleAppsScriptTypeFunction[];
}
/**
* Representation of a single script process execution that was started from the script editor, a trigger, an application, or using the Apps Script API. This is distinct from the `Operation` resource, which only represents executions started via the Apps Script API.
*/
export interface Schema$GoogleAppsScriptTypeProcess {
/**
* Duration the execution spent executing.
*/
duration?: string | null;
/**
* Name of the function the started the execution.
*/
functionName?: string | null;
/**
* The executions status.
*/
processStatus?: string | null;
/**
* The executions type.
*/
processType?: string | null;
/**
* Name of the script being executed.
*/
projectName?: string | null;
/**
* Time the execution started.
*/
startTime?: string | null;
/**
* The executing users access level to the script.
*/
userAccessLevel?: string | null;
}
/**
* A simple user profile resource.
*/
export interface Schema$GoogleAppsScriptTypeUser {
/**
* The user's domain.
*/
domain?: string | null;
/**
* The user's identifying email address.
*/
email?: string | null;
/**
* The user's display name.
*/
name?: string | null;
/**
* The user's photo.
*/
photoUrl?: string | null;
}
/**
* Web app entry point configuration.
*/
export interface Schema$GoogleAppsScriptTypeWebAppConfig {
/**
* Who has permission to run the web app.
*/
access?: string | null;
/**
* Who to execute the web app as.
*/
executeAs?: string | null;
}
/**
* A web application entry point.
*/
export interface Schema$GoogleAppsScriptTypeWebAppEntryPoint {
/**
* The entry point's configuration.
*/
entryPointConfig?: Schema$GoogleAppsScriptTypeWebAppConfig;
/**
* The URL for the web application.
*/
url?: string | null;
}
/**
* Response with the list of deployments for the specified Apps Script project.
*/
export interface Schema$ListDeploymentsResponse {
/**
* The list of deployments.
*/
deployments?: Schema$Deployment[];
/**
* The token that can be used in the next call to get the next page of results.
*/
nextPageToken?: string | null;
}
/**
* Response with the list of Process resources.
*/
export interface Schema$ListScriptProcessesResponse {
/**
* Token for the next page of results. If empty, there are no more pages remaining.
*/
nextPageToken?: string | null;
/**
* List of processes matching request parameters.
*/
processes?: Schema$GoogleAppsScriptTypeProcess[];
}
/**
* Response with the list of Process resources.
*/
export interface Schema$ListUserProcessesResponse {
/**
* Token for the next page of results. If empty, there are no more pages remaining.
*/
nextPageToken?: string | null;
/**
* List of processes matching request parameters.
*/
processes?: Schema$GoogleAppsScriptTypeProcess[];
}
/**
* `ListValue` is a wrapper around a repeated field of values.
*/
export interface Schema$ListValue {
/**
* Repeated field of dynamically typed values.
*/
values?: Schema$Value[];
}
/**
* Response with the list of the versions for the specified script project.
*/
export interface Schema$ListVersionsResponse {
/**
* The token use to fetch the next page of records. if not exist in the response, that means no more versions to list.
*/
nextPageToken?: string | null;
/**
* The list of versions.
*/
versions?: Schema$Version[];
}
/**
* Resource containing usage stats for a given script, based on the supplied filter and mask present in the request.
*/
export interface Schema$Metrics {
/**
* Number of active users.
*/
activeUsers?: Schema$MetricsValue[];
/**
* Number of failed executions.
*/
failedExecutions?: Schema$MetricsValue[];
/**
* Number of total executions.
*/
totalExecutions?: Schema$MetricsValue[];
}
/**
* Metrics value that holds number of executions counted.
*/
export interface Schema$MetricsValue {
/**
* Required field indicating the end time of the interval.
*/
endTime?: string | null;
/**
* Required field indicating the start time of the interval.
*/
startTime?: string | null;
/**
* Indicates the number of executions counted.
*/
value?: string | null;
}
/**
* A representation of an execution of an Apps Script function started with run. The execution response does not arrive until the function finishes executing. The maximum execution runtime is listed in the [Apps Script quotas guide](/apps-script/guides/services/quotas#current_limitations). After execution has started, it can have one of four outcomes: - If the script function returns successfully, the response field contains an ExecutionResponse object with the function's return value in the object's `result` field. - If the script function (or Apps Script itself) throws an exception, the error field contains a Status object. The `Status` object's `details` field contains an array with a single ExecutionError object that provides information about the nature of the error. - If the execution has not yet completed, the done field is `false` and the neither the `response` nor `error` fields are present. - If the `run` call itself fails (for example, because of a malformed request or an authorization error), the method returns an HTTP response code in the 4XX range with a different format for the response body. Client libraries automatically convert a 4XX response into an exception class.
*/
export interface Schema$Operation {
/**
* This field indicates whether the script execution has completed. A completed execution has a populated `response` field containing the ExecutionResponse from function that was executed.
*/
done?: boolean | null;
/**
* If a `run` call succeeds but the script function (or Apps Script itself) throws an exception, this field contains a Status object. The `Status` object's `details` field contains an array with a single ExecutionError object that provides information about the nature of the error.
*/
error?: Schema$Status;
/**
* If the script function returns successfully, this field contains an ExecutionResponse object with the function's return value.
*/
response?: {
[key: string]: any;
} | null;
}
/**
* The script project resource.
*/
export interface Schema$Project {
/**
* When the script was created.
*/
createTime?: string | null;
/**
* User who originally created the script.
*/
creator?: Schema$GoogleAppsScriptTypeUser;
/**
* User who last modified the script.
*/
lastModifyUser?: Schema$GoogleAppsScriptTypeUser;
/**
* 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.
*/
parentId?: string | null;
/**
* The script project's Drive ID.
*/
scriptId?: string | null;
/**
* The title for the project.
*/
title?: string | null;
/**
* When the script was last updated.
*/
updateTime?: string | null;
}
/**
* The result of an execution.
*/
export interface Schema$ScriptExecutionResult {
/**
* The returned value of the execution.
*/
returnValue?: Schema$Value;
}
/**
* A stack trace through the script that shows where the execution failed.
*/
export interface Schema$ScriptStackTraceElement {
/**
* The name of the function that failed.
*/
function?: string | null;
/**
* The line number where the script failed.
*/
lineNumber?: number | null;
}
/**
* If a `run` call succeeds but the script function (or Apps Script itself) throws an exception, the response body's error field contains this `Status` object.
*/
export interface Schema$Status {
/**
* The status code. For this API, this value either: - 10, indicating a `SCRIPT_TIMEOUT` error, - 3, indicating an `INVALID_ARGUMENT` error, or - 1, indicating a `CANCELLED` execution.
*/
code?: number | null;
/**
* An array that contains a single ExecutionError object that provides information about the nature of the error.
*/
details?: Array<{
[key: string]: any;
}> | null;
/**
* A developer-facing error message, which is in English. Any user-facing error message is localized and sent in the details field, or localized by the client.
*/
message?: string | null;
}
/**
* `Struct` represents a structured data value, consisting of fields which map to dynamically typed values.
*/
export interface Schema$Struct {
/**
* Unordered map of dynamically typed values.
*/
fields?: {
[key: string]: Schema$Value;
} | null;
}
/**
* Request with deployment information to update an existing deployment.
*/
export interface Schema$UpdateDeploymentRequest {
/**
* The deployment configuration.
*/
deploymentConfig?: Schema$DeploymentConfig;
}
/**
* `Value` represents a dynamically typed value which is the outcome of an executed script.
*/
export interface Schema$Value {
/**
* Represents a boolean value.
*/
boolValue?: boolean | null;
/**
* Represents raw byte values.
*/
bytesValue?: string | null;
/**
* Represents a date in ms since the epoch.
*/
dateValue?: string | null;
/**
* Represents a repeated `Value`.
*/
listValue?: Schema$ListValue;
/**
* Represents a null value.
*/
nullValue?: string | null;
/**
* Represents a double value.
*/
numberValue?: number | null;
/**
* Represents a structured proto value.
*/
protoValue?: {
[key: string]: any;
} | null;
/**
* Represents a string value.
*/
stringValue?: string | null;
/**
* Represents a structured value.
*/
structValue?: Schema$Struct;
}
/**
* A resource representing a script project version. A version is a "snapshot" of a script project and is similar to a read-only branched release. When creating deployments, the version to use must be specified.
*/
export interface Schema$Version {
/**
* When the version was created.
*/
createTime?: string | null;
/**
* The description for this version.
*/
description?: string | null;
/**
* The script project's Drive ID.
*/
scriptId?: string | null;
/**
* The incremental ID that is created by Apps Script when a version is created. This is system assigned number and is immutable once created.
*/
versionNumber?: number | null;
}
export class Resource$Processes {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* List information about processes made by or on behalf of a user, such as process type and current status.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/script.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const script = google.script('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/script.processes'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await script.processes.list({
* // The maximum number of returned processes per page of results. Defaults to 50.
* pageSize: 'placeholder-value',
* // 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.
* pageToken: 'placeholder-value',
* // Optional field used to limit returned processes to those originating from projects with a specific deployment ID.
* 'userProcessFilter.deploymentId': 'placeholder-value',
* // Optional field used to limit returned processes to those that completed on or before the given timestamp.
* 'userProcessFilter.endTime': 'placeholder-value',
* // Optional field used to limit returned processes to those originating from a script function with the given function name.
* 'userProcessFilter.functionName': 'placeholder-value',
* // Optional field used to limit returned processes to those originating from projects with project names containing a specific string.
* 'userProcessFilter.projectName': 'placeholder-value',
* // Optional field used to limit returned processes to those originating from projects with a specific script ID.
* 'userProcessFilter.scriptId': 'placeholder-value',
* // Optional field used to limit returned processes to those that were started on or after the given timestamp.
* 'userProcessFilter.startTime': 'placeholder-value',
* // Optional field used to limit returned processes to those having one of the specified process statuses.
* 'userProcessFilter.statuses': 'placeholder-value',
* // Optional field used to limit returned processes to those having one of the specified process types.
* 'userProcessFilter.types': 'placeholder-value',
* // Optional field used to limit returned processes to those having one of the specified user access levels.
* 'userProcessFilter.userAccessLevels': 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "nextPageToken": "my_nextPageToken",
* // "processes": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Processes$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Processes$List, options?: MethodOptions): GaxiosPromise<Schema$ListUserProcessesResponse>;
list(params: Params$Resource$Processes$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Processes$List, options: MethodOptions | BodyResponseCallback<Schema$ListUserProcessesResponse>, callback: BodyResponseCallback<Schema$ListUserProcessesResponse>): void;
list(params: Params$Resource$Processes$List, callback: BodyResponseCallback<Schema$ListUserProcessesResponse>): void;
list(callback: BodyResponseCallback<Schema$ListUserProcessesResponse>): void;
/**
* List information about a script's executed processes, such as process type and current status.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/script.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const script = google.script('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/script.processes'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await script.processes.listScriptProcesses({
* // The maximum number of returned processes per page of results. Defaults to 50.
* pageSize: 'placeholder-value',
* // 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.
* pageToken: 'placeholder-value',
* // The script ID of the project whose processes are listed.
* scriptId: 'placeholder-value',
* // Optional field used to limit returned processes to those originating from projects with a specific deployment ID.
* 'scriptProcessFilter.deploymentId': 'placeholder-value',
* // Optional field used to limit returned processes to those that completed on or before the given timestamp.
* 'scriptProcessFilter.endTime': 'placeholder-value',
* // Optional field used to limit returned processes to those originating from a script function with the given function name.
* 'scriptProcessFilter.functionName': 'placeholder-value',
* // Optional field used to limit returned processes to those that were started on or after the given timestamp.
* 'scriptProcessFilter.startTime': 'placeholder-value',
* // Optional field used to limit returned processes to those having one of the specified process statuses.
* 'scriptProcessFilter.statuses': 'placeholder-value',
* // Optional field used to limit returned processes to those having one of the specified process types.
* 'scriptProcessFilter.types': 'placeholder-value',
* // Optional field used to limit returned processes to those having one of the specified user access levels.
* 'scriptProcessFilter.userAccessLevels': 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "nextPageToken": "my_nextPageToken",
* // "processes": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
listScriptProcesses(params: Params$Resource$Processes$Listscriptprocesses, options: StreamMethodOptions): GaxiosPromise<Readable>;
listScriptProcesses(params?: Params$Resource$Processes$Listscriptprocesses, options?: MethodOptions): GaxiosPromise<Schema$ListScriptProcessesResponse>;
listScriptProcesses(params: Params$Resource$Processes$Listscriptprocesses, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
listScriptProcesses(params: Params$Resource$Processes$Listscriptprocesses, options: MethodOptions | BodyResponseCallback<Schema$ListScriptProcessesResponse>, callback: BodyResponseCallback<Schema$ListScriptProcessesResponse>): void;
listScriptProcesses(params: Params$Resource$Processes$Listscriptprocesses, callback: BodyResponseCallback<Schema$ListScriptProcessesResponse>): void;
listScriptProcesses(callback: BodyResponseCallback<Schema$ListScriptProcessesResponse>): void;
}
export interface Params$Resource$Processes$List extends StandardParameters {
/**
* The maximum number of returned processes per page of results. Defaults to 50.
*/
pageSize?: number;
/**
* 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.
*/
pageToken?: string;
/**
* Optional field used to limit returned processes to those originating from projects with a specific deployment ID.
*/
'userProcessFilter.deploymentId'?: string;
/**
* Optional field used to limit returned processes to those that completed on or before the given timestamp.
*/
'userProcessFilter.endTime'?: string;
/**
* Optional field used to limit returned processes to those originating from a script function with the given function name.
*/
'userProcessFilter.functionName'?: string;
/**
* Optional field used to limit returned processes to those originating from projects with project names containing a specific string.
*/
'userProcessFilter.projectName'?: string;
/**
* Optional field used to limit returned processes to those originating from projects with a specific script ID.
*/
'userProcessFilter.scriptId'?: string;
/**
* Optional field used to limit returned processes to those that were started on or after the given timestamp.
*/
'userProcessFilter.startTime'?: string;
/**
* Optional field used to limit returned processes to those having one of the specified process statuses.
*/
'userProcessFilter.statuses'?: string[];
/**
* Optional field used to limit returned processes to those having one of the specified process types.
*/
'userProcessFilter.types'?: string[];
/**
* Optional field used to limit returned processes to those having one of the specified user access levels.
*/
'userProcessFilter.userAccessLevels'?: string[];
}
export interface Params$Resource$Processes$Listscriptprocesses extends StandardParameters {
/**
* The maximum number of returned processes per page of results. Defaults to 50.
*/
pageSize?: number;
/**
* 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.
*/
pageToken?: string;
/**
* The script ID of the project whose processes are listed.
*/
scriptId?: string;
/**
* Optional field used to limit returned processes to those originating from projects with a specific deployment ID.
*/
'scriptProcessFilter.deploymentId'?: string;
/**
* Optional field used to limit returned processes to those that completed on or before the given timestamp.
*/
'scriptProcessFilter.endTime'?: string;
/**
* Optional field used to limit returned processes to those originating from a script function with the given function name.
*/
'scriptProcessFilter.functionName'?: string;
/**
* Optional field used to limit returned processes to those that were started on or after the given timestamp.
*/
'scriptProcessFilter.startTime'?: string;
/**
* Optional field used to limit returned processes to those having one of the specified process statuses.
*/
'scriptProcessFilter.statuses'?: string[];
/**
* Optional field used to limit returned processes to those having one of the specified process types.
*/
'scriptProcessFilter.types'?: string[];
/**
* Optional field used to limit returned processes to those having one of the specified user access levels.
*/
'scriptProcessFilter.userAccessLevels'?: string[];
}
export class Resource$Projects {
context: APIRequestContext;
deployments: Resource$Projects$Deployments;
versions: Resource$Projects$Versions;
constructor(context: APIRequestContext);
/**
* Creates a new, empty script project with no script files and a base manifest file.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/script.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const script = google.script('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/script.projects'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await script.projects.create({
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "parentId": "my_parentId",
* // "title": "my_title"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "createTime": "my_createTime",
* // "creator": {},
* // "lastModifyUser": {},
* // "parentId": "my_parentId",
* // "scriptId": "my_scriptId",
* // "title": "my_title",
* // "updateTime": "my_updateTime"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
create(params: Params$Resource$Projects$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
create(params?: Params$Resource$Projects$Create, options?: MethodOptions): GaxiosPromise<Schema$Project>;
create(params: Params$Resource$Projects$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
create(params: Params$Resource$Projects$Create, options: MethodOptions | BodyResponseCallback<Schema$Project>, callback: BodyResponseCallback<Schema$Project>): void;
create(params: Params$Resource$Projects$Create, callback: BodyResponseCallback<Schema$Project>): void;
create(callback: BodyResponseCallback<Schema$Project>): void;
/**
* Gets a script project's metadata.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/script.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const script = google.script('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/script.projects',
* 'https://www.googleapis.com/auth/script.projects.readonly',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await script.projects.get({
* // The script project's Drive ID.
* scriptId: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "createTime": "my_createTime",
* // "creator": {},
* // "lastModifyUser": {},
* // "parentId": "my_parentId",
* // "scriptId": "my_scriptId",
* // "title": "my_title",
* // "updateTime": "my_updateTime"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Projects$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Projects$Get, options?: MethodOptions): GaxiosPromise<Schema$Project>;
get(params: Params$Resource$Projects$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Projects$Get, options: MethodOptions | BodyResponseCallback<Schema$Project>, callback: BodyResponseCallback<Schema$Project>): void;
get(params: Params$Resource$Projects$Get, callback: BodyResponseCallback<Schema$Project>): void;
get(callback: BodyResponseCallback<Schema$Project>): void;
/**
* Gets the content of the script project, including the code source and metadata for each script file.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/script.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const script = google.script('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/script.projects',
* 'https://www.googleapis.com/auth/script.projects.readonly',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await script.projects.getContent({
* // The script project's Drive ID.
* scriptId: 'placeholder-value',
* // The version number of the project to retrieve. If not provided, the project's HEAD version is returned.
* versionNumber: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "files": [],
* // "scriptId": "my_scriptId"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
getContent(params: Params$Resource$Projects$Getcontent, options: StreamMethodOptions): GaxiosPromise<Readable>;
getContent(params?: Params$Resource$Projects$Getcontent, options?: MethodOptions): GaxiosPromise<Schema$Content>;
getContent(params: Params$Resource$Projects$Getcontent, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
getContent(params: Params$Resource$Projects$Getcontent, options: MethodOptions | BodyResponseCallback<Schema$Content>, callback: BodyResponseCallback<Schema$Content>): void;
getContent(params: Params$Resource$Projects$Getcontent, callback: BodyResponseCallback<Schema$Content>): void;
getContent(callback: BodyResponseCallback<Schema$Content>): void;
/**
* Get metrics data for scripts, such as number of executions and active users.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/script.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const script = google.script('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/script.metrics'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await script.projects.getMetrics({
* // Optional field indicating a specific deployment to retrieve metrics from.
* 'metricsFilter.deploymentId': 'placeholder-value',
* // Required field indicating what granularity of metrics are returned.
* metricsGranularity: 'placeholder-value',
* // Required field indicating the script to get metrics for.
* scriptId: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "activeUsers": [],
* // "failedExecutions": [],
* // "totalExecutions": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
getMetrics(params: Params$Resource$Projects$Getmetrics, options: StreamMethodOptions): GaxiosPromise<Readable>;
getMetrics(params?: Params$Resource$Projects$Getmetrics, options?: MethodOptions): GaxiosPromise<Schema$Metrics>;
getMetrics(params: Params$Resource$Projects$Getmetrics, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
getMetrics(params: Params$Resource$Projects$Getmetrics, options: MethodOptions | BodyResponseCallback<Schema$Metrics>, callback: BodyResponseCallback<Schema$Metrics>): void;
getMetrics(params: Params$Resource$Projects$Getmetrics, callback: BodyResponseCallback<Schema$Metrics>): void;
getMetrics(callback: BodyResponseCallback<Schema$Metrics>): void;
/**
* 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.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/script.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const script = google.script('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/script.projects'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await script.projects.updateContent({
* // The script project's Drive ID.
* scriptId: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "files": [],
* // "scriptId": "my_scriptId"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "files": [],
* // "scriptId": "my_scriptId"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
updateContent(params: Params$Resource$Projects$Updatecontent, options: StreamMethodOptions): GaxiosPromise<Readable>;
updateContent(params?: Params$Resource$Projects$Updatecontent, options?: MethodOptions): GaxiosPromise<Schema$Content>;
updateContent(params: Params$Resource$Projects$Updatecontent, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
updateContent(params: Params$Resource$Projects$Updatecontent, options: MethodOptions | BodyResponseCallback<Schema$Content>, callback: BodyResponseCallback<Schema$Content>): void;
updateContent(params: Params$Resource$Projects$Updatecontent, callback: BodyResponseCallback<Schema$Content>): void;
updateContent(callback: BodyResponseCallback<Schema$Content>): void;
}
export interface Params$Resource$Projects$Create extends StandardParameters {
/**
* Request body metadata
*/
requestBody?: Schema$CreateProjectRequest;
}
export interface Params$Resource$Projects$Get extends StandardParameters {
/**
* The script project's Drive ID.
*/
scriptId?: string;
}
export interface Params$Resource$Projects$Getcontent extends StandardParameters {
/**
* The script project's Drive ID.
*/
scriptId?: string;
/**
* The version number of the project to retrieve. If not provided, the project's HEAD version is returned.
*/
versionNumber?: number;
}
export interface Params$Resource$Projects$Getmetrics extends StandardParameters {
/**
* Optional field indicating a specific deployment to retrieve metrics from.
*/
'metricsFilter.deploymentId'?: string;
/**
* Required field indicating what granularity of metrics are returned.
*/
metricsGranularity?: string;
/**
* Required field indicating the script to get metrics for.
*/
scriptId?: string;
}
export interface Params$Resource$Projects$Updatecontent extends StandardParameters {
/**
* The script project's Drive ID.
*/
scriptId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Content;
}
export class Resource$Projects$Deployments {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Creates a deployment of an Apps Script project.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/script.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const script = google.script('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/script.deployments'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await script.projects.deployments.create({
* // The script project's Drive ID.
* scriptId: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "description": "my_description",
* // "manifestFileName": "my_manifestFileName",
* // "scriptId": "my_scriptId",
* // "versionNumber": 0
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "deploymentConfig": {},
* // "deploymentId": "my_deploymentId",
* // "entryPoints": [],
* // "updateTime": "my_updateTime"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
create(params: Params$Resource$Projects$Deployments$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
create(params?: Params$Resource$Projects$Deployments$Create, options?: MethodOptions): GaxiosPromise<Schema$Deployment>;
create(params: Params$Resource$Projects$Deployments$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
create(params: Params$Resource$Projects$Deployments$Create, options: MethodOptions | BodyResponseCallback<Schema$Deployment>, callback: BodyResponseCallback<Schema$Deployment>): void;
create(params: Params$Resource$Projects$Deployments$Create, callback: BodyResponseCallback<Schema$Deployment>): void;
create(callback: BodyResponseCallback<Schema$Deployment>): void;
/**
* Deletes a deployment of an Apps Script project.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/script.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const script = google.script('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/script.deployments'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await script.projects.deployments.delete({
* // The deployment ID to be undeployed.
* deploymentId: 'placeholder-value',
* // The script project's Drive ID.
* scriptId: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {}
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
delete(params: Params$Resource$Projects$Deployments$Delete, options: StreamMethodOptions): GaxiosPromise<Readable>;
delete(params?: Params$Resource$Projects$Deployments$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Projects$Deployments$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
delete(params: Params$Resource$Projects$Deployments$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Projects$Deployments$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* Gets a deployment of an Apps Script project.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/script.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const script = google.script('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/script.deployments',
* 'https://www.googleapis.com/auth/script.deployments.readonly',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await script.projects.deployments.get({
* // The deployment ID.
* deploymentId: 'placeholder-value',
* // The script project's Drive ID.
* scriptId: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "deploymentConfig": {},
* // "deploymentId": "my_deploymentId",
* // "entryPoints": [],
* // "updateTime": "my_updateTime"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Projects$Deployments$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Projects$Deployments$Get, options?: MethodOptions): GaxiosPromise<Schema$Deployment>;
get(params: Params$Resource$Projects$Deployments$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Projects$Deployments$Get, options: MethodOptions | BodyResponseCallback<Schema$Deployment>, callback: BodyResponseCallback<Schema$Deployment>): void;
get(params: Params$Resource$Projects$Deployments$Get, callback: BodyResponseCallback<Schema$Deployment>): void;
get(callback: BodyResponseCallback<Schema$Deployment>): void;
/**
* Lists the deployments of an Apps Script project.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/script.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const script = google.script('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/script.deployments',
* 'https://www.googleapis.com/auth/script.deployments.readonly',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await script.projects.deployments.list({
* // The maximum number of deployments on each returned page. Defaults to 50.
* pageSize: 'placeholder-value',
* // 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.
* pageToken: 'placeholder-value',
* // The script project's Drive ID.
* scriptId: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "deployments": [],
* // "nextPageToken": "my_nextPageToken"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Projects$Deployments$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Projects$Deployments$List, options?: MethodOptions): GaxiosPromise<Schema$ListDeploymentsResponse>;
list(params: Params$Resource$Projects$Deployments$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Projects$Deployments$List, options: MethodOptions | BodyResponseCallback<Schema$ListDeploymentsResponse>, callback: BodyResponseCallback<Schema$ListDeploymentsResponse>): void;
list(params: Params$Resource$Projects$Deployments$List, callback: BodyResponseCallback<Schema$ListDeploymentsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListDeploymentsResponse>): void;
/**
* Updates a deployment of an Apps Script project.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/script.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const script = google.script('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/script.deployments'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await script.projects.deployments.update({
* // The deployment ID for this deployment.
* deploymentId: 'placeholder-value',
* // The script project's Drive ID.
* scriptId: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "deploymentConfig": {}
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "deploymentConfig": {},
* // "deploymentId": "my_deploymentId",
* // "entryPoints": [],
* // "updateTime": "my_updateTime"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
update(params: Params$Resource$Projects$Deployments$Update, options: StreamMethodOptions): GaxiosPromise<Readable>;
update(params?: Params$Resource$Projects$Deployments$Update, options?: MethodOptions): GaxiosPromise<Schema$Deployment>;
update(params: Params$Resource$Projects$Deployments$Update, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
update(params: Params$Resource$Projects$Deployments$Update, options: MethodOptions | BodyResponseCallback<Schema$Deployment>, callback: BodyResponseCallback<Schema$Deployment>): void;
update(params: Params$Resource$Projects$Deployments$Update, callback: BodyResponseCallback<Schema$Deployment>): void;
update(callback: BodyResponseCallback<Schema$Deployment>): void;
}
export interface Params$Resource$Projects$Deployments$Create extends StandardParameters {
/**
* The script project's Drive ID.
*/
scriptId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$DeploymentConfig;
}
export interface Params$Resource$Projects$Deployments$Delete extends StandardParameters {
/**
* The deployment ID to be undeployed.
*/
deploymentId?: string;
/**
* The script project's Drive ID.
*/
scriptId?: string;
}
export interface Params$Resource$Projects$Deployments$Get extends StandardParameters {
/**
* The deployment ID.
*/
deploymentId?: string;
/**
* The script project's Drive ID.
*/
scriptId?: string;
}
export interface Params$Resource$Projects$Deployments$List extends StandardParameters {
/**
* The maximum number of deployments on each returned page. Defaults to 50.
*/
pageSize?: number;
/**
* 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.
*/
pageToken?: string;
/**
* The script project's Drive ID.
*/
scriptId?: string;
}
export interface Params$Resource$Projects$Deployments$Update extends StandardParameters {
/**
* The deployment ID for this deployment.
*/
deploymentId?: string;
/**
* The script project's Drive ID.
*/
scriptId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$UpdateDeploymentRequest;
}
export class Resource$Projects$Versions {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Creates a new immutable version using the current code, with a unique version number.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/script.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const script = google.script('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/script.projects'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await script.projects.versions.create({
* // The script project's Drive ID.
* scriptId: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "createTime": "my_createTime",
* // "description": "my_description",
* // "scriptId": "my_scriptId",
* // "versionNumber": 0
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "createTime": "my_createTime",
* // "description": "my_description",
* // "scriptId": "my_scriptId",
* // "versionNumber": 0
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
create(params: Params$Resource$Projects$Versions$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
create(params?: Params$Resource$Projects$Versions$Create, options?: MethodOptions): GaxiosPromise<Schema$Version>;
create(params: Params$Resource$Projects$Versions$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
create(params: Params$Resource$Projects$Versions$Create, options: MethodOptions | BodyResponseCallback<Schema$Version>, callback: BodyResponseCallback<Schema$Version>): void;
create(params: Params$Resource$Projects$Versions$Create, callback: BodyResponseCallback<Schema$Version>): void;
create(callback: BodyResponseCallback<Schema$Version>): void;
/**
* Gets a version of a script project.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/script.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const script = google.script('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/script.projects',
* 'https://www.googleapis.com/auth/script.projects.readonly',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await script.projects.versions.get({
* // The script project's Drive ID.
* scriptId: 'placeholder-value',
* // The version number.
* versionNumber: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "createTime": "my_createTime",
* // "description": "my_description",
* // "scriptId": "my_scriptId",
* // "versionNumber": 0
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Projects$Versions$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Projects$Versions$Get, options?: MethodOptions): GaxiosPromise<Schema$Version>;
get(params: Params$Resource$Projects$Versions$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Projects$Versions$Get, options: MethodOptions | BodyResponseCallback<Schema$Version>, callback: BodyResponseCallback<Schema$Version>): void;
get(params: Params$Resource$Projects$Versions$Get, callback: BodyResponseCallback<Schema$Version>): void;
get(callback: BodyResponseCallback<Schema$Version>): void;
/**
* List the versions of a script project.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/script.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const script = google.script('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/script.projects',
* 'https://www.googleapis.com/auth/script.projects.readonly',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await script.projects.versions.list({
* // The maximum number of versions on each returned page. Defaults to 50.
* pageSize: 'placeholder-value',
* // 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.
* pageToken: 'placeholder-value',
* // The script project's Drive ID.
* scriptId: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "nextPageToken": "my_nextPageToken",
* // "versions": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Projects$Versions$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Projects$Versions$List, options?: MethodOptions): GaxiosPromise<Schema$ListVersionsResponse>;
list(params: Params$Resource$Projects$Versions$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Projects$Versions$List, options: MethodOptions | BodyResponseCallback<Schema$ListVersionsResponse>, callback: BodyResponseCallback<Schema$ListVersionsResponse>): void;
list(params: Params$Resource$Projects$Versions$List, callback: BodyResponseCallback<Schema$ListVersionsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListVersionsResponse>): void;
}
export interface Params$Resource$Projects$Versions$Create extends StandardParameters {
/**
* The script project's Drive ID.
*/
scriptId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Version;
}
export interface Params$Resource$Projects$Versions$Get extends StandardParameters {
/**
* The script project's Drive ID.
*/
scriptId?: string;
/**
* The version number.
*/
versionNumber?: number;
}
export interface Params$Resource$Projects$Versions$List extends StandardParameters {
/**
* The maximum number of versions on each returned page. Defaults to 50.
*/
pageSize?: number;
/**
* 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.
*/
pageToken?: string;
/**
* The script project's Drive ID.
*/
scriptId?: string;
}
export class Resource$Scripts {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Runs a function in an Apps Script project. The script project must be deployed for use with the Apps Script API and the calling application must share the same Cloud Platform project. This method requires authorization with an OAuth 2.0 token that includes at least one of the scopes listed in the [Authorization](#authorization-scopes) section; script projects that do not require authorization cannot be executed through this API. To find the correct scopes to include in the authentication token, open the script project **Overview** page and scroll down to "Project OAuth Scopes." The error `403, PERMISSION_DENIED: The caller does not have permission` indicates that the Cloud Platform project used to authorize the request is not the same as the one used by the script.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/script.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const script = google.script('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://mail.google.com/',
* 'https://www.google.com/calendar/feeds',
* 'https://www.google.com/m8/feeds',
* 'https://www.googleapis.com/auth/admin.directory.group',
* 'https://www.googleapis.com/auth/admin.directory.user',
* 'https://www.googleapis.com/auth/documents',
* 'https://www.googleapis.com/auth/drive',
* 'https://www.googleapis.com/auth/forms',
* 'https://www.googleapis.com/auth/forms.currentonly',
* 'https://www.googleapis.com/auth/groups',
* 'https://www.googleapis.com/auth/spreadsheets',
* 'https://www.googleapis.com/auth/userinfo.email',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await script.scripts.run({
* // The script ID of the script to be executed. Find the script ID on the **Project settings** page under "IDs."
* scriptId: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "devMode": false,
* // "function": "my_function",
* // "parameters": [],
* // "sessionState": "my_sessionState"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "done": false,
* // "error": {},
* // "response": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
run(params: Params$Resource$Scripts$Run, options: StreamMethodOptions): GaxiosPromise<Readable>;
run(params?: Params$Resource$Scripts$Run, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
run(params: Params$Resource$Scripts$Run, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
run(params: Params$Resource$Scripts$Run, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
run(params: Params$Resource$Scripts$Run, callback: BodyResponseCallback<Schema$Operation>): void;
run(callback: BodyResponseCallback<Schema$Operation>): void;
}
export interface Params$Resource$Scripts$Run extends StandardParameters {
/**
* The script ID of the script to be executed. Find the script ID on the **Project settings** page under "IDs."
*/
scriptId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$ExecutionRequest;
}
export {};
}