v4.d.ts
246 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
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
/**
* Copyright 2019 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { OAuth2Client, JWT, Compute, UserRefreshClient } from 'google-auth-library';
import { GoogleConfigurable, MethodOptions, GlobalOptions, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { GaxiosPromise } from 'gaxios';
export declare namespace sheets_v4 {
export interface Options extends GlobalOptions {
version: 'v4';
}
interface StandardParameters {
/**
* 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;
}
/**
* Google Sheets API
*
* Reads and writes Google Sheets.
*
* @example
* const {google} = require('googleapis');
* const sheets = google.sheets('v4');
*
* @namespace sheets
* @type {Function}
* @version v4
* @variation v4
* @param {object=} options Options for Sheets
*/
export class Sheets {
context: APIRequestContext;
spreadsheets: Resource$Spreadsheets;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Adds a new banded range to the spreadsheet.
*/
export interface Schema$AddBandingRequest {
/**
* The banded range to add. The bandedRangeId field is optional; if one is not set, an id will be randomly generated. (It is an error to specify the ID of a range that already exists.)
*/
bandedRange?: Schema$BandedRange;
}
/**
* The result of adding a banded range.
*/
export interface Schema$AddBandingResponse {
/**
* The banded range that was added.
*/
bandedRange?: Schema$BandedRange;
}
/**
* Adds a chart to a sheet in the spreadsheet.
*/
export interface Schema$AddChartRequest {
/**
* The chart that should be added to the spreadsheet, including the position where it should be placed. The chartId field is optional; if one is not set, an id will be randomly generated. (It is an error to specify the ID of an embedded object that already exists.)
*/
chart?: Schema$EmbeddedChart;
}
/**
* The result of adding a chart to a spreadsheet.
*/
export interface Schema$AddChartResponse {
/**
* The newly added chart.
*/
chart?: Schema$EmbeddedChart;
}
/**
* Adds a new conditional format rule at the given index. All subsequent rules' indexes are incremented.
*/
export interface Schema$AddConditionalFormatRuleRequest {
/**
* The zero-based index where the rule should be inserted.
*/
index?: number | null;
/**
* The rule to add.
*/
rule?: Schema$ConditionalFormatRule;
}
/**
* Creates a group over the specified range. If the requested range is a superset of the range of an existing group G, then the depth of G is incremented and this new group G' has the depth of that group. For example, a group [C:D, depth 1] + [B:E] results in groups [B:E, depth 1] and [C:D, depth 2]. If the requested range is a subset of the range of an existing group G, then the depth of the new group G' becomes one greater than the depth of G. For example, a group [B:E, depth 1] + [C:D] results in groups [B:E, depth 1] and [C:D, depth 2]. If the requested range starts before and ends within, or starts within and ends after, the range of an existing group G, then the range of the existing group G becomes the union of the ranges, and the new group G' has depth one greater than the depth of G and range as the intersection of the ranges. For example, a group [B:D, depth 1] + [C:E] results in groups [B:E, depth 1] and [C:D, depth 2].
*/
export interface Schema$AddDimensionGroupRequest {
/**
* The range over which to create a group.
*/
range?: Schema$DimensionRange;
}
/**
* The result of adding a group.
*/
export interface Schema$AddDimensionGroupResponse {
/**
* All groups of a dimension after adding a group to that dimension.
*/
dimensionGroups?: Schema$DimensionGroup[];
}
/**
* Adds a filter view.
*/
export interface Schema$AddFilterViewRequest {
/**
* The filter to add. The filterViewId field is optional; if one is not set, an id will be randomly generated. (It is an error to specify the ID of a filter that already exists.)
*/
filter?: Schema$FilterView;
}
/**
* The result of adding a filter view.
*/
export interface Schema$AddFilterViewResponse {
/**
* The newly added filter view.
*/
filter?: Schema$FilterView;
}
/**
* Adds a named range to the spreadsheet.
*/
export interface Schema$AddNamedRangeRequest {
/**
* The named range to add. The namedRangeId field is optional; if one is not set, an id will be randomly generated. (It is an error to specify the ID of a range that already exists.)
*/
namedRange?: Schema$NamedRange;
}
/**
* The result of adding a named range.
*/
export interface Schema$AddNamedRangeResponse {
/**
* The named range to add.
*/
namedRange?: Schema$NamedRange;
}
/**
* Adds a new protected range.
*/
export interface Schema$AddProtectedRangeRequest {
/**
* The protected range to be added. The protectedRangeId field is optional; if one is not set, an id will be randomly generated. (It is an error to specify the ID of a range that already exists.)
*/
protectedRange?: Schema$ProtectedRange;
}
/**
* The result of adding a new protected range.
*/
export interface Schema$AddProtectedRangeResponse {
/**
* The newly added protected range.
*/
protectedRange?: Schema$ProtectedRange;
}
/**
* Adds a new sheet. When a sheet is added at a given index, all subsequent sheets' indexes are incremented. To add an object sheet, use AddChartRequest instead and specify EmbeddedObjectPosition.sheetId or EmbeddedObjectPosition.newSheet.
*/
export interface Schema$AddSheetRequest {
/**
* The properties the new sheet should have. All properties are optional. The sheetId field is optional; if one is not set, an id will be randomly generated. (It is an error to specify the ID of a sheet that already exists.)
*/
properties?: Schema$SheetProperties;
}
/**
* The result of adding a sheet.
*/
export interface Schema$AddSheetResponse {
/**
* The properties of the newly added sheet.
*/
properties?: Schema$SheetProperties;
}
/**
* Adds a slicer to a sheet in the spreadsheet.
*/
export interface Schema$AddSlicerRequest {
/**
* The slicer that should be added to the spreadsheet, including the position where it should be placed. The slicerId field is optional; if one is not set, an id will be randomly generated. (It is an error to specify the ID of a slicer that already exists.)
*/
slicer?: Schema$Slicer;
}
/**
* The result of adding a slicer to a spreadsheet.
*/
export interface Schema$AddSlicerResponse {
/**
* The newly added slicer.
*/
slicer?: Schema$Slicer;
}
/**
* Adds new cells after the last row with data in a sheet, inserting new rows into the sheet if necessary.
*/
export interface Schema$AppendCellsRequest {
/**
* The fields of CellData that should be updated. At least one field must be specified. The root is the CellData; 'row.values.' should not be specified. A single `"*"` can be used as short-hand for listing every field.
*/
fields?: string | null;
/**
* The data to append.
*/
rows?: Schema$RowData[];
/**
* The sheet ID to append the data to.
*/
sheetId?: number | null;
}
/**
* Appends rows or columns to the end of a sheet.
*/
export interface Schema$AppendDimensionRequest {
/**
* Whether rows or columns should be appended.
*/
dimension?: string | null;
/**
* The number of rows or columns to append.
*/
length?: number | null;
/**
* The sheet to append rows or columns to.
*/
sheetId?: number | null;
}
/**
* The response when updating a range of values in a spreadsheet.
*/
export interface Schema$AppendValuesResponse {
/**
* The spreadsheet the updates were applied to.
*/
spreadsheetId?: string | null;
/**
* The range (in A1 notation) of the table that values are being appended to (before the values were appended). Empty if no table was found.
*/
tableRange?: string | null;
/**
* Information about the updates that were applied.
*/
updates?: Schema$UpdateValuesResponse;
}
/**
* Fills in more data based on existing data.
*/
export interface Schema$AutoFillRequest {
/**
* The range to autofill. This will examine the range and detect the location that has data and automatically fill that data in to the rest of the range.
*/
range?: Schema$GridRange;
/**
* The source and destination areas to autofill. This explicitly lists the source of the autofill and where to extend that data.
*/
sourceAndDestination?: Schema$SourceAndDestination;
/**
* True if we should generate data with the "alternate" series. This differs based on the type and amount of source data.
*/
useAlternateSeries?: boolean | null;
}
/**
* Automatically resizes one or more dimensions based on the contents of the cells in that dimension.
*/
export interface Schema$AutoResizeDimensionsRequest {
/**
* The dimensions to automatically resize.
*/
dimensions?: Schema$DimensionRange;
}
/**
* A banded (alternating colors) range in a sheet.
*/
export interface Schema$BandedRange {
/**
* The id of the banded range.
*/
bandedRangeId?: number | null;
/**
* Properties for column bands. These properties are applied on a column- by-column basis throughout all the columns in the range. At least one of row_properties or column_properties must be specified.
*/
columnProperties?: Schema$BandingProperties;
/**
* The range over which these properties are applied.
*/
range?: Schema$GridRange;
/**
* Properties for row bands. These properties are applied on a row-by-row basis throughout all the rows in the range. At least one of row_properties or column_properties must be specified.
*/
rowProperties?: Schema$BandingProperties;
}
/**
* Properties referring a single dimension (either row or column). If both BandedRange.row_properties and BandedRange.column_properties are set, the fill colors are applied to cells according to the following rules: * header_color and footer_color take priority over band colors. * first_band_color takes priority over second_band_color. * row_properties takes priority over column_properties. For example, the first row color takes priority over the first column color, but the first column color takes priority over the second row color. Similarly, the row header takes priority over the column header in the top left cell, but the column header takes priority over the first row color if the row header is not set.
*/
export interface Schema$BandingProperties {
/**
* The first color that is alternating. (Required)
*/
firstBandColor?: Schema$Color;
/**
* The color of the last row or column. If this field is not set, the last row or column will be filled with either first_band_color or second_band_color, depending on the color of the previous row or column.
*/
footerColor?: Schema$Color;
/**
* The color of the first row or column. If this field is set, the first row or column will be filled with this color and the colors will alternate between first_band_color and second_band_color starting from the second row or column. Otherwise, the first row or column will be filled with first_band_color and the colors will proceed to alternate as they normally would.
*/
headerColor?: Schema$Color;
/**
* The second color that is alternating. (Required)
*/
secondBandColor?: Schema$Color;
}
/**
* Formatting options for baseline value.
*/
export interface Schema$BaselineValueFormat {
/**
* The comparison type of key value with baseline value.
*/
comparisonType?: string | null;
/**
* Description which is appended after the baseline value. This field is optional.
*/
description?: string | null;
/**
* Color to be used, in case baseline value represents a negative change for key value. This field is optional.
*/
negativeColor?: Schema$Color;
/**
* Specifies the horizontal text positioning of baseline value. This field is optional. If not specified, default positioning is used.
*/
position?: Schema$TextPosition;
/**
* Color to be used, in case baseline value represents a positive change for key value. This field is optional.
*/
positiveColor?: Schema$Color;
/**
* Text formatting options for baseline value.
*/
textFormat?: Schema$TextFormat;
}
/**
* An axis of the chart. A chart may not have more than one axis per axis position.
*/
export interface Schema$BasicChartAxis {
/**
* The format of the title. Only valid if the axis is not associated with the domain.
*/
format?: Schema$TextFormat;
/**
* The position of this axis.
*/
position?: string | null;
/**
* The title of this axis. If set, this overrides any title inferred from headers of the data.
*/
title?: string | null;
/**
* The axis title text position.
*/
titleTextPosition?: Schema$TextPosition;
/**
* The view window options for this axis.
*/
viewWindowOptions?: Schema$ChartAxisViewWindowOptions;
}
/**
* The domain of a chart. For example, if charting stock prices over time, this would be the date.
*/
export interface Schema$BasicChartDomain {
/**
* The data of the domain. For example, if charting stock prices over time, this is the data representing the dates.
*/
domain?: Schema$ChartData;
/**
* True to reverse the order of the domain values (horizontal axis).
*/
reversed?: boolean | null;
}
/**
* A single series of data in a chart. For example, if charting stock prices over time, multiple series may exist, one for the "Open Price", "High Price", "Low Price" and "Close Price".
*/
export interface Schema$BasicChartSeries {
/**
* The color for elements (i.e. bars, lines, points) associated with this series. If empty, a default color is used.
*/
color?: Schema$Color;
/**
* The line style of this series. Valid only if the chartType is AREA, LINE, or SCATTER. COMBO charts are also supported if the series chart type is AREA or LINE.
*/
lineStyle?: Schema$LineStyle;
/**
* The data being visualized in this chart series.
*/
series?: Schema$ChartData;
/**
* The minor axis that will specify the range of values for this series. For example, if charting stocks over time, the "Volume" series may want to be pinned to the right with the prices pinned to the left, because the scale of trading volume is different than the scale of prices. It is an error to specify an axis that isn't a valid minor axis for the chart's type.
*/
targetAxis?: string | null;
/**
* The type of this series. Valid only if the chartType is COMBO. Different types will change the way the series is visualized. Only LINE, AREA, and COLUMN are supported.
*/
type?: string | null;
}
/**
* The specification for a basic chart. See BasicChartType for the list of charts this supports.
*/
export interface Schema$BasicChartSpec {
/**
* The axis on the chart.
*/
axis?: Schema$BasicChartAxis[];
/**
* The type of the chart.
*/
chartType?: string | null;
/**
* The behavior of tooltips and data highlighting when hovering on data and chart area.
*/
compareMode?: string | null;
/**
* The domain of data this is charting. Only a single domain is supported.
*/
domains?: Schema$BasicChartDomain[];
/**
* The number of rows or columns in the data that are "headers". If not set, Google Sheets will guess how many rows are headers based on the data. (Note that BasicChartAxis.title may override the axis title inferred from the header values.)
*/
headerCount?: number | null;
/**
* If some values in a series are missing, gaps may appear in the chart (e.g, segments of lines in a line chart will be missing). To eliminate these gaps set this to true. Applies to Line, Area, and Combo charts.
*/
interpolateNulls?: boolean | null;
/**
* The position of the chart legend.
*/
legendPosition?: string | null;
/**
* Gets whether all lines should be rendered smooth or straight by default. Applies to Line charts.
*/
lineSmoothing?: boolean | null;
/**
* The data this chart is visualizing.
*/
series?: Schema$BasicChartSeries[];
/**
* The stacked type for charts that support vertical stacking. Applies to Area, Bar, Column, Combo, and Stepped Area charts.
*/
stackedType?: string | null;
/**
* True to make the chart 3D. Applies to Bar and Column charts.
*/
threeDimensional?: boolean | null;
}
/**
* The default filter associated with a sheet.
*/
export interface Schema$BasicFilter {
/**
* The criteria for showing/hiding values per column. The map's key is the column index, and the value is the criteria for that column.
*/
criteria?: {
[key: string]: Schema$FilterCriteria;
} | null;
/**
* The range the filter covers.
*/
range?: Schema$GridRange;
/**
* The sort order per column. Later specifications are used when values are equal in the earlier specifications.
*/
sortSpecs?: Schema$SortSpec[];
}
/**
* The request for clearing more than one range selected by a DataFilter in a spreadsheet.
*/
export interface Schema$BatchClearValuesByDataFilterRequest {
/**
* The DataFilters used to determine which ranges to clear.
*/
dataFilters?: Schema$DataFilter[];
}
/**
* The response when clearing a range of values selected with DataFilters in a spreadsheet.
*/
export interface Schema$BatchClearValuesByDataFilterResponse {
/**
* The ranges that were cleared, in A1 notation. (If the requests were for an unbounded range or a ranger larger than the bounds of the sheet, this will be the actual ranges that were cleared, bounded to the sheet's limits.)
*/
clearedRanges?: string[] | null;
/**
* The spreadsheet the updates were applied to.
*/
spreadsheetId?: string | null;
}
/**
* The request for clearing more than one range of values in a spreadsheet.
*/
export interface Schema$BatchClearValuesRequest {
/**
* The ranges to clear, in A1 notation.
*/
ranges?: string[] | null;
}
/**
* The response when clearing a range of values in a spreadsheet.
*/
export interface Schema$BatchClearValuesResponse {
/**
* The ranges that were cleared, in A1 notation. (If the requests were for an unbounded range or a ranger larger than the bounds of the sheet, this will be the actual ranges that were cleared, bounded to the sheet's limits.)
*/
clearedRanges?: string[] | null;
/**
* The spreadsheet the updates were applied to.
*/
spreadsheetId?: string | null;
}
/**
* The request for retrieving a range of values in a spreadsheet selected by a set of DataFilters.
*/
export interface Schema$BatchGetValuesByDataFilterRequest {
/**
* The data filters used to match the ranges of values to retrieve. Ranges that match any of the specified data filters will be included in the response.
*/
dataFilters?: Schema$DataFilter[];
/**
* How dates, times, and durations should be represented in the output. This is ignored if value_render_option is FORMATTED_VALUE. The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].
*/
dateTimeRenderOption?: string | null;
/**
* The major dimension that results should use. For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then a request that selects that range and sets `majorDimension=ROWS` will return `[[1,2],[3,4]]`, whereas a request that sets `majorDimension=COLUMNS` will return `[[1,3],[2,4]]`.
*/
majorDimension?: string | null;
/**
* How values should be represented in the output. The default render option is ValueRenderOption.FORMATTED_VALUE.
*/
valueRenderOption?: string | null;
}
/**
* The response when retrieving more than one range of values in a spreadsheet selected by DataFilters.
*/
export interface Schema$BatchGetValuesByDataFilterResponse {
/**
* The ID of the spreadsheet the data was retrieved from.
*/
spreadsheetId?: string | null;
/**
* The requested values with the list of data filters that matched them.
*/
valueRanges?: Schema$MatchedValueRange[];
}
/**
* The response when retrieving more than one range of values in a spreadsheet.
*/
export interface Schema$BatchGetValuesResponse {
/**
* The ID of the spreadsheet the data was retrieved from.
*/
spreadsheetId?: string | null;
/**
* The requested values. The order of the ValueRanges is the same as the order of the requested ranges.
*/
valueRanges?: Schema$ValueRange[];
}
/**
* The request for updating any aspect of a spreadsheet.
*/
export interface Schema$BatchUpdateSpreadsheetRequest {
/**
* Determines if the update response should include the spreadsheet resource.
*/
includeSpreadsheetInResponse?: boolean | null;
/**
* A list of updates to apply to the spreadsheet. Requests will be applied in the order they are specified. If any request is not valid, no requests will be applied.
*/
requests?: Schema$Request[];
/**
* True if grid data should be returned. Meaningful only if if include_spreadsheet_in_response is 'true'. This parameter is ignored if a field mask was set in the request.
*/
responseIncludeGridData?: boolean | null;
/**
* Limits the ranges included in the response spreadsheet. Meaningful only if include_spreadsheet_response is 'true'.
*/
responseRanges?: string[] | null;
}
/**
* The reply for batch updating a spreadsheet.
*/
export interface Schema$BatchUpdateSpreadsheetResponse {
/**
* The reply of the updates. This maps 1:1 with the updates, although replies to some requests may be empty.
*/
replies?: Schema$Response[];
/**
* The spreadsheet the updates were applied to.
*/
spreadsheetId?: string | null;
/**
* The spreadsheet after updates were applied. This is only set if [BatchUpdateSpreadsheetRequest.include_spreadsheet_in_response] is `true`.
*/
updatedSpreadsheet?: Schema$Spreadsheet;
}
/**
* The request for updating more than one range of values in a spreadsheet.
*/
export interface Schema$BatchUpdateValuesByDataFilterRequest {
/**
* The new values to apply to the spreadsheet. If more than one range is matched by the specified DataFilter the specified values will be applied to all of those ranges.
*/
data?: Schema$DataFilterValueRange[];
/**
* Determines if the update response should include the values of the cells that were updated. By default, responses do not include the updated values. The `updatedData` field within each of the BatchUpdateValuesResponse.responses will contain the updated values. If the range to write was larger than than the range actually written, the response will include all values in the requested range (excluding trailing empty rows and columns).
*/
includeValuesInResponse?: boolean | null;
/**
* Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is DateTimeRenderOption.SERIAL_NUMBER.
*/
responseDateTimeRenderOption?: string | null;
/**
* Determines how values in the response should be rendered. The default render option is ValueRenderOption.FORMATTED_VALUE.
*/
responseValueRenderOption?: string | null;
/**
* How the input data should be interpreted.
*/
valueInputOption?: string | null;
}
/**
* The response when updating a range of values in a spreadsheet.
*/
export interface Schema$BatchUpdateValuesByDataFilterResponse {
/**
* The response for each range updated.
*/
responses?: Schema$UpdateValuesByDataFilterResponse[];
/**
* The spreadsheet the updates were applied to.
*/
spreadsheetId?: string | null;
/**
* The total number of cells updated.
*/
totalUpdatedCells?: number | null;
/**
* The total number of columns where at least one cell in the column was updated.
*/
totalUpdatedColumns?: number | null;
/**
* The total number of rows where at least one cell in the row was updated.
*/
totalUpdatedRows?: number | null;
/**
* The total number of sheets where at least one cell in the sheet was updated.
*/
totalUpdatedSheets?: number | null;
}
/**
* The request for updating more than one range of values in a spreadsheet.
*/
export interface Schema$BatchUpdateValuesRequest {
/**
* The new values to apply to the spreadsheet.
*/
data?: Schema$ValueRange[];
/**
* Determines if the update response should include the values of the cells that were updated. By default, responses do not include the updated values. The `updatedData` field within each of the BatchUpdateValuesResponse.responses will contain the updated values. If the range to write was larger than than the range actually written, the response will include all values in the requested range (excluding trailing empty rows and columns).
*/
includeValuesInResponse?: boolean | null;
/**
* Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is DateTimeRenderOption.SERIAL_NUMBER.
*/
responseDateTimeRenderOption?: string | null;
/**
* Determines how values in the response should be rendered. The default render option is ValueRenderOption.FORMATTED_VALUE.
*/
responseValueRenderOption?: string | null;
/**
* How the input data should be interpreted.
*/
valueInputOption?: string | null;
}
/**
* The response when updating a range of values in a spreadsheet.
*/
export interface Schema$BatchUpdateValuesResponse {
/**
* One UpdateValuesResponse per requested range, in the same order as the requests appeared.
*/
responses?: Schema$UpdateValuesResponse[];
/**
* The spreadsheet the updates were applied to.
*/
spreadsheetId?: string | null;
/**
* The total number of cells updated.
*/
totalUpdatedCells?: number | null;
/**
* The total number of columns where at least one cell in the column was updated.
*/
totalUpdatedColumns?: number | null;
/**
* The total number of rows where at least one cell in the row was updated.
*/
totalUpdatedRows?: number | null;
/**
* The total number of sheets where at least one cell in the sheet was updated.
*/
totalUpdatedSheets?: number | null;
}
/**
* A condition that can evaluate to true or false. BooleanConditions are used by conditional formatting, data validation, and the criteria in filters.
*/
export interface Schema$BooleanCondition {
/**
* The type of condition.
*/
type?: string | null;
/**
* The values of the condition. The number of supported values depends on the condition type. Some support zero values, others one or two values, and ConditionType.ONE_OF_LIST supports an arbitrary number of values.
*/
values?: Schema$ConditionValue[];
}
/**
* A rule that may or may not match, depending on the condition.
*/
export interface Schema$BooleanRule {
/**
* The condition of the rule. If the condition evaluates to true, the format is applied.
*/
condition?: Schema$BooleanCondition;
/**
* The format to apply. Conditional formatting can only apply a subset of formatting: bold, italic, strikethrough, foreground color & background color.
*/
format?: Schema$CellFormat;
}
/**
* A border along a cell.
*/
export interface Schema$Border {
/**
* The color of the border.
*/
color?: Schema$Color;
/**
* The style of the border.
*/
style?: string | null;
/**
* The width of the border, in pixels. Deprecated; the width is determined by the "style" field.
*/
width?: number | null;
}
/**
* The borders of the cell.
*/
export interface Schema$Borders {
/**
* The bottom border of the cell.
*/
bottom?: Schema$Border;
/**
* The left border of the cell.
*/
left?: Schema$Border;
/**
* The right border of the cell.
*/
right?: Schema$Border;
/**
* The top border of the cell.
*/
top?: Schema$Border;
}
/**
* A <a href="/chart/interactive/docs/gallery/bubblechart">bubble chart</a>.
*/
export interface Schema$BubbleChartSpec {
/**
* The bubble border color.
*/
bubbleBorderColor?: Schema$Color;
/**
* The data containing the bubble labels. These do not need to be unique.
*/
bubbleLabels?: Schema$ChartData;
/**
* The max radius size of the bubbles, in pixels. If specified, the field must be a positive value.
*/
bubbleMaxRadiusSize?: number | null;
/**
* The minimum radius size of the bubbles, in pixels. If specific, the field must be a positive value.
*/
bubbleMinRadiusSize?: number | null;
/**
* The opacity of the bubbles between 0 and 1.0. 0 is fully transparent and 1 is fully opaque.
*/
bubbleOpacity?: number | null;
/**
* The data contianing the bubble sizes. Bubble sizes are used to draw the bubbles at different sizes relative to each other. If specified, group_ids must also be specified. This field is optional.
*/
bubbleSizes?: Schema$ChartData;
/**
* The format of the text inside the bubbles. Underline and Strikethrough are not supported.
*/
bubbleTextStyle?: Schema$TextFormat;
/**
* The data containing the bubble x-values. These values locate the bubbles in the chart horizontally.
*/
domain?: Schema$ChartData;
/**
* The data containing the bubble group IDs. All bubbles with the same group ID are drawn in the same color. If bubble_sizes is specified then this field must also be specified but may contain blank values. This field is optional.
*/
groupIds?: Schema$ChartData;
/**
* Where the legend of the chart should be drawn.
*/
legendPosition?: string | null;
/**
* The data contianing the bubble y-values. These values locate the bubbles in the chart vertically.
*/
series?: Schema$ChartData;
}
/**
* A <a href="/chart/interactive/docs/gallery/candlestickchart">candlestick chart</a>.
*/
export interface Schema$CandlestickChartSpec {
/**
* The Candlestick chart data. Only one CandlestickData is supported.
*/
data?: Schema$CandlestickData[];
/**
* The domain data (horizontal axis) for the candlestick chart. String data will be treated as discrete labels, other data will be treated as continuous values.
*/
domain?: Schema$CandlestickDomain;
}
/**
* The Candlestick chart data, each containing the low, open, close, and high values for a series.
*/
export interface Schema$CandlestickData {
/**
* The range data (vertical axis) for the close/final value for each candle. This is the top of the candle body. If greater than the open value the candle will be filled. Otherwise the candle will be hollow.
*/
closeSeries?: Schema$CandlestickSeries;
/**
* The range data (vertical axis) for the high/maximum value for each candle. This is the top of the candle's center line.
*/
highSeries?: Schema$CandlestickSeries;
/**
* The range data (vertical axis) for the low/minimum value for each candle. This is the bottom of the candle's center line.
*/
lowSeries?: Schema$CandlestickSeries;
/**
* The range data (vertical axis) for the open/initial value for each candle. This is the bottom of the candle body. If less than the close value the candle will be filled. Otherwise the candle will be hollow.
*/
openSeries?: Schema$CandlestickSeries;
}
/**
* The domain of a CandlestickChart.
*/
export interface Schema$CandlestickDomain {
/**
* The data of the CandlestickDomain.
*/
data?: Schema$ChartData;
/**
* True to reverse the order of the domain values (horizontal axis).
*/
reversed?: boolean | null;
}
/**
* The series of a CandlestickData.
*/
export interface Schema$CandlestickSeries {
/**
* The data of the CandlestickSeries.
*/
data?: Schema$ChartData;
}
/**
* Data about a specific cell.
*/
export interface Schema$CellData {
/**
* A data validation rule on the cell, if any. When writing, the new data validation rule will overwrite any prior rule.
*/
dataValidation?: Schema$DataValidationRule;
/**
* The effective format being used by the cell. This includes the results of applying any conditional formatting and, if the cell contains a formula, the computed number format. If the effective format is the default format, effective format will not be written. This field is read-only.
*/
effectiveFormat?: Schema$CellFormat;
/**
* The effective value of the cell. For cells with formulas, this is the calculated value. For cells with literals, this is the same as the user_entered_value. This field is read-only.
*/
effectiveValue?: Schema$ExtendedValue;
/**
* The formatted value of the cell. This is the value as it's shown to the user. This field is read-only.
*/
formattedValue?: string | null;
/**
* A hyperlink this cell points to, if any. This field is read-only. (To set it, use a `=HYPERLINK` formula in the userEnteredValue.formulaValue field.)
*/
hyperlink?: string | null;
/**
* Any note on the cell.
*/
note?: string | null;
/**
* A pivot table anchored at this cell. The size of pivot table itself is computed dynamically based on its data, grouping, filters, values, etc. Only the top-left cell of the pivot table contains the pivot table definition. The other cells will contain the calculated values of the results of the pivot in their effective_value fields.
*/
pivotTable?: Schema$PivotTable;
/**
* Runs of rich text applied to subsections of the cell. Runs are only valid on user entered strings, not formulas, bools, or numbers. Runs start at specific indexes in the text and continue until the next run. Properties of a run will continue unless explicitly changed in a subsequent run (and properties of the first run will continue the properties of the cell unless explicitly changed). When writing, the new runs will overwrite any prior runs. When writing a new user_entered_value, previous runs are erased.
*/
textFormatRuns?: Schema$TextFormatRun[];
/**
* The format the user entered for the cell. When writing, the new format will be merged with the existing format.
*/
userEnteredFormat?: Schema$CellFormat;
/**
* The value the user entered in the cell. e.g, `1234`, `'Hello'`, or `=NOW()` Note: Dates, Times and DateTimes are represented as doubles in serial number format.
*/
userEnteredValue?: Schema$ExtendedValue;
}
/**
* The format of a cell.
*/
export interface Schema$CellFormat {
/**
* The background color of the cell.
*/
backgroundColor?: Schema$Color;
/**
* The borders of the cell.
*/
borders?: Schema$Borders;
/**
* The horizontal alignment of the value in the cell.
*/
horizontalAlignment?: string | null;
/**
* How a hyperlink, if it exists, should be displayed in the cell.
*/
hyperlinkDisplayType?: string | null;
/**
* A format describing how number values should be represented to the user.
*/
numberFormat?: Schema$NumberFormat;
/**
* The padding of the cell.
*/
padding?: Schema$Padding;
/**
* The direction of the text in the cell.
*/
textDirection?: string | null;
/**
* The format of the text in the cell (unless overridden by a format run).
*/
textFormat?: Schema$TextFormat;
/**
* The rotation applied to text in a cell
*/
textRotation?: Schema$TextRotation;
/**
* The vertical alignment of the value in the cell.
*/
verticalAlignment?: string | null;
/**
* The wrap strategy for the value in the cell.
*/
wrapStrategy?: string | null;
}
/**
* The options that define a "view window" for a chart (such as the visible values in an axis).
*/
export interface Schema$ChartAxisViewWindowOptions {
/**
* The maximum numeric value to be shown in this view window. If unset, will automatically determine a maximum value that looks good for the data.
*/
viewWindowMax?: number | null;
/**
* The minimum numeric value to be shown in this view window. If unset, will automatically determine a minimum value that looks good for the data.
*/
viewWindowMin?: number | null;
/**
* The view window's mode.
*/
viewWindowMode?: string | null;
}
/**
* Custom number formatting options for chart attributes.
*/
export interface Schema$ChartCustomNumberFormatOptions {
/**
* Custom prefix to be prepended to the chart attribute. This field is optional.
*/
prefix?: string | null;
/**
* Custom suffix to be appended to the chart attribute. This field is optional.
*/
suffix?: string | null;
}
/**
* The data included in a domain or series.
*/
export interface Schema$ChartData {
/**
* The source ranges of the data.
*/
sourceRange?: Schema$ChartSourceRange;
}
/**
* Source ranges for a chart.
*/
export interface Schema$ChartSourceRange {
/**
* The ranges of data for a series or domain. Exactly one dimension must have a length of 1, and all sources in the list must have the same dimension with length 1. The domain (if it exists) & all series must have the same number of source ranges. If using more than one source range, then the source range at a given offset must be in order and contiguous across the domain and series. For example, these are valid configurations: domain sources: A1:A5 series1 sources: B1:B5 series2 sources: D6:D10 domain sources: A1:A5, C10:C12 series1 sources: B1:B5, D10:D12 series2 sources: C1:C5, E10:E12
*/
sources?: Schema$GridRange[];
}
/**
* The specifications of a chart.
*/
export interface Schema$ChartSpec {
/**
* The alternative text that describes the chart. This is often used for accessibility.
*/
altText?: string | null;
/**
* The background color of the entire chart. Not applicable to Org charts.
*/
backgroundColor?: Schema$Color;
/**
* A basic chart specification, can be one of many kinds of charts. See BasicChartType for the list of all charts this supports.
*/
basicChart?: Schema$BasicChartSpec;
/**
* A bubble chart specification.
*/
bubbleChart?: Schema$BubbleChartSpec;
/**
* A candlestick chart specification.
*/
candlestickChart?: Schema$CandlestickChartSpec;
/**
* The name of the font to use by default for all chart text (e.g. title, axis labels, legend). If a font is specified for a specific part of the chart it will override this font name.
*/
fontName?: string | null;
/**
* Determines how the charts will use hidden rows or columns.
*/
hiddenDimensionStrategy?: string | null;
/**
* A histogram chart specification.
*/
histogramChart?: Schema$HistogramChartSpec;
/**
* True to make a chart fill the entire space in which it's rendered with minimum padding. False to use the default padding. (Not applicable to Geo and Org charts.)
*/
maximized?: boolean | null;
/**
* An org chart specification.
*/
orgChart?: Schema$OrgChartSpec;
/**
* A pie chart specification.
*/
pieChart?: Schema$PieChartSpec;
/**
* A scorecard chart specification.
*/
scorecardChart?: Schema$ScorecardChartSpec;
/**
* The subtitle of the chart.
*/
subtitle?: string | null;
/**
* The subtitle text format. Strikethrough and underline are not supported.
*/
subtitleTextFormat?: Schema$TextFormat;
/**
* The subtitle text position. This field is optional.
*/
subtitleTextPosition?: Schema$TextPosition;
/**
* The title of the chart.
*/
title?: string | null;
/**
* The title text format. Strikethrough and underline are not supported.
*/
titleTextFormat?: Schema$TextFormat;
/**
* The title text position. This field is optional.
*/
titleTextPosition?: Schema$TextPosition;
/**
* A treemap chart specification.
*/
treemapChart?: Schema$TreemapChartSpec;
/**
* A waterfall chart specification.
*/
waterfallChart?: Schema$WaterfallChartSpec;
}
/**
* Clears the basic filter, if any exists on the sheet.
*/
export interface Schema$ClearBasicFilterRequest {
/**
* The sheet ID on which the basic filter should be cleared.
*/
sheetId?: number | null;
}
/**
* The request for clearing a range of values in a spreadsheet.
*/
export interface Schema$ClearValuesRequest {
}
/**
* The response when clearing a range of values in a spreadsheet.
*/
export interface Schema$ClearValuesResponse {
/**
* The range (in A1 notation) that was cleared. (If the request was for an unbounded range or a ranger larger than the bounds of the sheet, this will be the actual range that was cleared, bounded to the sheet's limits.)
*/
clearedRange?: string | null;
/**
* The spreadsheet the updates were applied to.
*/
spreadsheetId?: string | null;
}
/**
* Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to/from color representations in various languages over compactness; for example, the fields of this representation can be trivially provided to the constructor of "java.awt.Color" in Java; it can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" method in iOS; and, with just a little work, it can be easily formatted into a CSS "rgba()" string in JavaScript, as well. Note: this proto does not carry information about the absolute color space that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). By default, applications SHOULD assume the sRGB color space. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor_(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor_ = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ...
*/
export interface Schema$Color {
/**
* The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (this color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is to be rendered as a solid color (as if the alpha value had been explicitly given with a value of 1.0).
*/
alpha?: number | null;
/**
* The amount of blue in the color as a value in the interval [0, 1].
*/
blue?: number | null;
/**
* The amount of green in the color as a value in the interval [0, 1].
*/
green?: number | null;
/**
* The amount of red in the color as a value in the interval [0, 1].
*/
red?: number | null;
}
/**
* A rule describing a conditional format.
*/
export interface Schema$ConditionalFormatRule {
/**
* The formatting is either "on" or "off" according to the rule.
*/
booleanRule?: Schema$BooleanRule;
/**
* The formatting will vary based on the gradients in the rule.
*/
gradientRule?: Schema$GradientRule;
/**
* The ranges that are formatted if the condition is true. All the ranges must be on the same grid.
*/
ranges?: Schema$GridRange[];
}
/**
* The value of the condition.
*/
export interface Schema$ConditionValue {
/**
* A relative date (based on the current date). Valid only if the type is DATE_BEFORE, DATE_AFTER, DATE_ON_OR_BEFORE or DATE_ON_OR_AFTER. Relative dates are not supported in data validation. They are supported only in conditional formatting and conditional filters.
*/
relativeDate?: string | null;
/**
* A value the condition is based on. The value is parsed as if the user typed into a cell. Formulas are supported (and must begin with an `=` or a '+').
*/
userEnteredValue?: string | null;
}
/**
* Copies data from the source to the destination.
*/
export interface Schema$CopyPasteRequest {
/**
* The location to paste to. If the range covers a span that's a multiple of the source's height or width, then the data will be repeated to fill in the destination range. If the range is smaller than the source range, the entire source data will still be copied (beyond the end of the destination range).
*/
destination?: Schema$GridRange;
/**
* How that data should be oriented when pasting.
*/
pasteOrientation?: string | null;
/**
* What kind of data to paste.
*/
pasteType?: string | null;
/**
* The source range to copy.
*/
source?: Schema$GridRange;
}
/**
* The request to copy a sheet across spreadsheets.
*/
export interface Schema$CopySheetToAnotherSpreadsheetRequest {
/**
* The ID of the spreadsheet to copy the sheet to.
*/
destinationSpreadsheetId?: string | null;
}
/**
* A request to create developer metadata.
*/
export interface Schema$CreateDeveloperMetadataRequest {
/**
* The developer metadata to create.
*/
developerMetadata?: Schema$DeveloperMetadata;
}
/**
* The response from creating developer metadata.
*/
export interface Schema$CreateDeveloperMetadataResponse {
/**
* The developer metadata that was created.
*/
developerMetadata?: Schema$DeveloperMetadata;
}
/**
* Moves data from the source to the destination.
*/
export interface Schema$CutPasteRequest {
/**
* The top-left coordinate where the data should be pasted.
*/
destination?: Schema$GridCoordinate;
/**
* What kind of data to paste. All the source data will be cut, regardless of what is pasted.
*/
pasteType?: string | null;
/**
* The source data to cut.
*/
source?: Schema$GridRange;
}
/**
* Filter that describes what data should be selected or returned from a request.
*/
export interface Schema$DataFilter {
/**
* Selects data that matches the specified A1 range.
*/
a1Range?: string | null;
/**
* Selects data associated with the developer metadata matching the criteria described by this DeveloperMetadataLookup.
*/
developerMetadataLookup?: Schema$DeveloperMetadataLookup;
/**
* Selects data that matches the range described by the GridRange.
*/
gridRange?: Schema$GridRange;
}
/**
* A range of values whose location is specified by a DataFilter.
*/
export interface Schema$DataFilterValueRange {
/**
* The data filter describing the location of the values in the spreadsheet.
*/
dataFilter?: Schema$DataFilter;
/**
* The major dimension of the values.
*/
majorDimension?: string | null;
/**
* The data to be written. If the provided values exceed any of the ranges matched by the data filter then the request will fail. If the provided values are less than the matched ranges only the specified values will be written, existing values in the matched ranges will remain unaffected.
*/
values?: any[][] | null;
}
/**
* A data validation rule.
*/
export interface Schema$DataValidationRule {
/**
* The condition that data in the cell must match.
*/
condition?: Schema$BooleanCondition;
/**
* A message to show the user when adding data to the cell.
*/
inputMessage?: string | null;
/**
* True if the UI should be customized based on the kind of condition. If true, "List" conditions will show a dropdown.
*/
showCustomUi?: boolean | null;
/**
* True if invalid data should be rejected.
*/
strict?: boolean | null;
}
/**
* Allows you to organize the date-time values in a source data column into buckets based on selected parts of their date or time values. For example, consider a pivot table showing sales transactions by date: +----------+--------------+ | Date | SUM of Sales | +----------+--------------+ | 1/1/2017 | $621.14 | | 2/3/2017 | $708.84 | | 5/8/2017 | $326.84 | ... +----------+--------------+ Applying a date-time group rule with a DateTimeRuleType of YEAR_MONTH results in the following pivot table. +--------------+--------------+ | Grouped Date | SUM of Sales | +--------------+--------------+ | 2017-Jan | $53,731.78 | | 2017-Feb | $83,475.32 | | 2017-Mar | $94,385.05 | ... +--------------+--------------+
*/
export interface Schema$DateTimeRule {
/**
* The type of date-time grouping to apply.
*/
type?: string | null;
}
/**
* Removes the banded range with the given ID from the spreadsheet.
*/
export interface Schema$DeleteBandingRequest {
/**
* The ID of the banded range to delete.
*/
bandedRangeId?: number | null;
}
/**
* Deletes a conditional format rule at the given index. All subsequent rules' indexes are decremented.
*/
export interface Schema$DeleteConditionalFormatRuleRequest {
/**
* The zero-based index of the rule to be deleted.
*/
index?: number | null;
/**
* The sheet the rule is being deleted from.
*/
sheetId?: number | null;
}
/**
* The result of deleting a conditional format rule.
*/
export interface Schema$DeleteConditionalFormatRuleResponse {
/**
* The rule that was deleted.
*/
rule?: Schema$ConditionalFormatRule;
}
/**
* A request to delete developer metadata.
*/
export interface Schema$DeleteDeveloperMetadataRequest {
/**
* The data filter describing the criteria used to select which developer metadata entry to delete.
*/
dataFilter?: Schema$DataFilter;
}
/**
* The response from deleting developer metadata.
*/
export interface Schema$DeleteDeveloperMetadataResponse {
/**
* The metadata that was deleted.
*/
deletedDeveloperMetadata?: Schema$DeveloperMetadata[];
}
/**
* Deletes a group over the specified range by decrementing the depth of the dimensions in the range. For example, assume the sheet has a depth-1 group over B:E and a depth-2 group over C:D. Deleting a group over D:E leaves the sheet with a depth-1 group over B:D and a depth-2 group over C:C.
*/
export interface Schema$DeleteDimensionGroupRequest {
/**
* The range of the group to be deleted.
*/
range?: Schema$DimensionRange;
}
/**
* The result of deleting a group.
*/
export interface Schema$DeleteDimensionGroupResponse {
/**
* All groups of a dimension after deleting a group from that dimension.
*/
dimensionGroups?: Schema$DimensionGroup[];
}
/**
* Deletes the dimensions from the sheet.
*/
export interface Schema$DeleteDimensionRequest {
/**
* The dimensions to delete from the sheet.
*/
range?: Schema$DimensionRange;
}
/**
* Removes rows within this range that contain values in the specified columns that are duplicates of values in any previous row. Rows with identical values but different letter cases, formatting, or formulas are considered to be duplicates. This request also removes duplicate rows hidden from view (for example, due to a filter). When removing duplicates, the first instance of each duplicate row scanning from the top downwards is kept in the resulting range. Content outside of the specified range isn't removed, and rows considered duplicates do not have to be adjacent to each other in the range.
*/
export interface Schema$DeleteDuplicatesRequest {
/**
* The columns in the range to analyze for duplicate values. If no columns are selected then all columns are analyzed for duplicates.
*/
comparisonColumns?: Schema$DimensionRange[];
/**
* The range to remove duplicates rows from.
*/
range?: Schema$GridRange;
}
/**
* The result of removing duplicates in a range.
*/
export interface Schema$DeleteDuplicatesResponse {
/**
* The number of duplicate rows removed.
*/
duplicatesRemovedCount?: number | null;
}
/**
* Deletes the embedded object with the given ID.
*/
export interface Schema$DeleteEmbeddedObjectRequest {
/**
* The ID of the embedded object to delete.
*/
objectId?: number | null;
}
/**
* Deletes a particular filter view.
*/
export interface Schema$DeleteFilterViewRequest {
/**
* The ID of the filter to delete.
*/
filterId?: number | null;
}
/**
* Removes the named range with the given ID from the spreadsheet.
*/
export interface Schema$DeleteNamedRangeRequest {
/**
* The ID of the named range to delete.
*/
namedRangeId?: string | null;
}
/**
* Deletes the protected range with the given ID.
*/
export interface Schema$DeleteProtectedRangeRequest {
/**
* The ID of the protected range to delete.
*/
protectedRangeId?: number | null;
}
/**
* Deletes a range of cells, shifting other cells into the deleted area.
*/
export interface Schema$DeleteRangeRequest {
/**
* The range of cells to delete.
*/
range?: Schema$GridRange;
/**
* The dimension from which deleted cells will be replaced with. If ROWS, existing cells will be shifted upward to replace the deleted cells. If COLUMNS, existing cells will be shifted left to replace the deleted cells.
*/
shiftDimension?: string | null;
}
/**
* Deletes the requested sheet.
*/
export interface Schema$DeleteSheetRequest {
/**
* The ID of the sheet to delete.
*/
sheetId?: number | null;
}
/**
* Developer metadata associated with a location or object in a spreadsheet. Developer metadata may be used to associate arbitrary data with various parts of a spreadsheet and will remain associated at those locations as they move around and the spreadsheet is edited. For example, if developer metadata is associated with row 5 and another row is then subsequently inserted above row 5, that original metadata will still be associated with the row it was first associated with (what is now row 6). If the associated object is deleted its metadata is deleted too.
*/
export interface Schema$DeveloperMetadata {
/**
* The location where the metadata is associated.
*/
location?: Schema$DeveloperMetadataLocation;
/**
* The spreadsheet-scoped unique ID that identifies the metadata. IDs may be specified when metadata is created, otherwise one will be randomly generated and assigned. Must be positive.
*/
metadataId?: number | null;
/**
* The metadata key. There may be multiple metadata in a spreadsheet with the same key. Developer metadata must always have a key specified.
*/
metadataKey?: string | null;
/**
* Data associated with the metadata's key.
*/
metadataValue?: string | null;
/**
* The metadata visibility. Developer metadata must always have a visibility specified.
*/
visibility?: string | null;
}
/**
* A location where metadata may be associated in a spreadsheet.
*/
export interface Schema$DeveloperMetadataLocation {
/**
* Represents the row or column when metadata is associated with a dimension. The specified DimensionRange must represent a single row or column; it cannot be unbounded or span multiple rows or columns.
*/
dimensionRange?: Schema$DimensionRange;
/**
* The type of location this object represents. This field is read-only.
*/
locationType?: string | null;
/**
* The ID of the sheet when metadata is associated with an entire sheet.
*/
sheetId?: number | null;
/**
* True when metadata is associated with an entire spreadsheet.
*/
spreadsheet?: boolean | null;
}
/**
* Selects DeveloperMetadata that matches all of the specified fields. For example, if only a metadata ID is specified this considers the DeveloperMetadata with that particular unique ID. If a metadata key is specified, this considers all developer metadata with that key. If a key, visibility, and location type are all specified, this considers all developer metadata with that key and visibility that are associated with a location of that type. In general, this selects all DeveloperMetadata that matches the intersection of all the specified fields; any field or combination of fields may be specified.
*/
export interface Schema$DeveloperMetadataLookup {
/**
* Determines how this lookup matches the location. If this field is specified as EXACT, only developer metadata associated on the exact location specified is matched. If this field is specified to INTERSECTING, developer metadata associated on intersecting locations is also matched. If left unspecified, this field assumes a default value of INTERSECTING. If this field is specified, a metadataLocation must also be specified.
*/
locationMatchingStrategy?: string | null;
/**
* Limits the selected developer metadata to those entries which are associated with locations of the specified type. For example, when this field is specified as ROW this lookup only considers developer metadata associated on rows. If the field is left unspecified, all location types are considered. This field cannot be specified as SPREADSHEET when the locationMatchingStrategy is specified as INTERSECTING or when the metadataLocation is specified as a non-spreadsheet location: spreadsheet metadata cannot intersect any other developer metadata location. This field also must be left unspecified when the locationMatchingStrategy is specified as EXACT.
*/
locationType?: string | null;
/**
* Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_id.
*/
metadataId?: number | null;
/**
* Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_key.
*/
metadataKey?: string | null;
/**
* Limits the selected developer metadata to those entries associated with the specified location. This field either matches exact locations or all intersecting locations according the specified locationMatchingStrategy.
*/
metadataLocation?: Schema$DeveloperMetadataLocation;
/**
* Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_value.
*/
metadataValue?: string | null;
/**
* Limits the selected developer metadata to that which has a matching DeveloperMetadata.visibility. If left unspecified, all developer metadata visibile to the requesting project is considered.
*/
visibility?: string | null;
}
/**
* A group over an interval of rows or columns on a sheet, which can contain or be contained within other groups. A group can be collapsed or expanded as a unit on the sheet.
*/
export interface Schema$DimensionGroup {
/**
* This field is true if this group is collapsed. A collapsed group remains collapsed if an overlapping group at a shallower depth is expanded. A true value does not imply that all dimensions within the group are hidden, since a dimension's visibility can change independently from this group property. However, when this property is updated, all dimensions within it are set to hidden if this field is true, or set to visible if this field is false.
*/
collapsed?: boolean | null;
/**
* The depth of the group, representing how many groups have a range that wholly contains the range of this group.
*/
depth?: number | null;
/**
* The range over which this group exists.
*/
range?: Schema$DimensionRange;
}
/**
* Properties about a dimension.
*/
export interface Schema$DimensionProperties {
/**
* The developer metadata associated with a single row or column.
*/
developerMetadata?: Schema$DeveloperMetadata[];
/**
* True if this dimension is being filtered. This field is read-only.
*/
hiddenByFilter?: boolean | null;
/**
* True if this dimension is explicitly hidden.
*/
hiddenByUser?: boolean | null;
/**
* The height (if a row) or width (if a column) of the dimension in pixels.
*/
pixelSize?: number | null;
}
/**
* A range along a single dimension on a sheet. All indexes are zero-based. Indexes are half open: the start index is inclusive and the end index is exclusive. Missing indexes indicate the range is unbounded on that side.
*/
export interface Schema$DimensionRange {
/**
* The dimension of the span.
*/
dimension?: string | null;
/**
* The end (exclusive) of the span, or not set if unbounded.
*/
endIndex?: number | null;
/**
* The sheet this span is on.
*/
sheetId?: number | null;
/**
* The start (inclusive) of the span, or not set if unbounded.
*/
startIndex?: number | null;
}
/**
* Duplicates a particular filter view.
*/
export interface Schema$DuplicateFilterViewRequest {
/**
* The ID of the filter being duplicated.
*/
filterId?: number | null;
}
/**
* The result of a filter view being duplicated.
*/
export interface Schema$DuplicateFilterViewResponse {
/**
* The newly created filter.
*/
filter?: Schema$FilterView;
}
/**
* Duplicates the contents of a sheet.
*/
export interface Schema$DuplicateSheetRequest {
/**
* The zero-based index where the new sheet should be inserted. The index of all sheets after this are incremented.
*/
insertSheetIndex?: number | null;
/**
* If set, the ID of the new sheet. If not set, an ID is chosen. If set, the ID must not conflict with any existing sheet ID. If set, it must be non-negative.
*/
newSheetId?: number | null;
/**
* The name of the new sheet. If empty, a new name is chosen for you.
*/
newSheetName?: string | null;
/**
* The sheet to duplicate.
*/
sourceSheetId?: number | null;
}
/**
* The result of duplicating a sheet.
*/
export interface Schema$DuplicateSheetResponse {
/**
* The properties of the duplicate sheet.
*/
properties?: Schema$SheetProperties;
}
/**
* The editors of a protected range.
*/
export interface Schema$Editors {
/**
* True if anyone in the document's domain has edit access to the protected range. Domain protection is only supported on documents within a domain.
*/
domainUsersCanEdit?: boolean | null;
/**
* The email addresses of groups with edit access to the protected range.
*/
groups?: string[] | null;
/**
* The email addresses of users with edit access to the protected range.
*/
users?: string[] | null;
}
/**
* A chart embedded in a sheet.
*/
export interface Schema$EmbeddedChart {
/**
* The ID of the chart.
*/
chartId?: number | null;
/**
* The position of the chart.
*/
position?: Schema$EmbeddedObjectPosition;
/**
* The specification of the chart.
*/
spec?: Schema$ChartSpec;
}
/**
* The position of an embedded object such as a chart.
*/
export interface Schema$EmbeddedObjectPosition {
/**
* If true, the embedded object is put on a new sheet whose ID is chosen for you. Used only when writing.
*/
newSheet?: boolean | null;
/**
* The position at which the object is overlaid on top of a grid.
*/
overlayPosition?: Schema$OverlayPosition;
/**
* The sheet this is on. Set only if the embedded object is on its own sheet. Must be non-negative.
*/
sheetId?: number | null;
}
/**
* An error in a cell.
*/
export interface Schema$ErrorValue {
/**
* A message with more information about the error (in the spreadsheet's locale).
*/
message?: string | null;
/**
* The type of error.
*/
type?: string | null;
}
/**
* The kinds of value that a cell in a spreadsheet can have.
*/
export interface Schema$ExtendedValue {
/**
* Represents a boolean value.
*/
boolValue?: boolean | null;
/**
* Represents an error. This field is read-only.
*/
errorValue?: Schema$ErrorValue;
/**
* Represents a formula.
*/
formulaValue?: string | null;
/**
* Represents a double value. Note: Dates, Times and DateTimes are represented as doubles in "serial number" format.
*/
numberValue?: number | null;
/**
* Represents a string value. Leading single quotes are not included. For example, if the user typed `'123` into the UI, this would be represented as a `stringValue` of `"123"`.
*/
stringValue?: string | null;
}
/**
* Criteria for showing/hiding rows in a filter or filter view.
*/
export interface Schema$FilterCriteria {
/**
* A condition that must be true for values to be shown. (This does not override hiddenValues -- if a value is listed there, it will still be hidden.)
*/
condition?: Schema$BooleanCondition;
/**
* Values that should be hidden.
*/
hiddenValues?: string[] | null;
/**
* The background fill color to filter by; only cells with this fill color are shown. Mutually exclusive with all other filter criteria. Requests to set this field will fail with a 400 error if any other filter criteria field is set.
*/
visibleBackgroundColor?: Schema$Color;
/**
* The text color to filter by; only cells with this text color are shown. Mutually exclusive with all other filter criteria. Requests to set this field will fail with a 400 error if any other filter criteria field is set.
*/
visibleForegroundColor?: Schema$Color;
}
/**
* A filter view.
*/
export interface Schema$FilterView {
/**
* The criteria for showing/hiding values per column. The map's key is the column index, and the value is the criteria for that column.
*/
criteria?: {
[key: string]: Schema$FilterCriteria;
} | null;
/**
* The ID of the filter view.
*/
filterViewId?: number | null;
/**
* The named range this filter view is backed by, if any. When writing, only one of range or named_range_id may be set.
*/
namedRangeId?: string | null;
/**
* The range this filter view covers. When writing, only one of range or named_range_id may be set.
*/
range?: Schema$GridRange;
/**
* The sort order per column. Later specifications are used when values are equal in the earlier specifications.
*/
sortSpecs?: Schema$SortSpec[];
/**
* The name of the filter view.
*/
title?: string | null;
}
/**
* Finds and replaces data in cells over a range, sheet, or all sheets.
*/
export interface Schema$FindReplaceRequest {
/**
* True to find/replace over all sheets.
*/
allSheets?: boolean | null;
/**
* The value to search.
*/
find?: string | null;
/**
* True if the search should include cells with formulas. False to skip cells with formulas.
*/
includeFormulas?: boolean | null;
/**
* True if the search is case sensitive.
*/
matchCase?: boolean | null;
/**
* True if the find value should match the entire cell.
*/
matchEntireCell?: boolean | null;
/**
* The range to find/replace over.
*/
range?: Schema$GridRange;
/**
* The value to use as the replacement.
*/
replacement?: string | null;
/**
* True if the find value is a regex. The regular expression and replacement should follow Java regex rules at https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html. The replacement string is allowed to refer to capturing groups. For example, if one cell has the contents `"Google Sheets"` and another has `"Google Docs"`, then searching for `"o.* (.*)"` with a replacement of `"$1 Rocks"` would change the contents of the cells to `"GSheets Rocks"` and `"GDocs Rocks"` respectively.
*/
searchByRegex?: boolean | null;
/**
* The sheet to find/replace over.
*/
sheetId?: number | null;
}
/**
* The result of the find/replace.
*/
export interface Schema$FindReplaceResponse {
/**
* The number of formula cells changed.
*/
formulasChanged?: number | null;
/**
* The number of occurrences (possibly multiple within a cell) changed. For example, if replacing `"e"` with `"o"` in `"Google Sheets"`, this would be `"3"` because `"Google Sheets"` -> `"Googlo Shoots"`.
*/
occurrencesChanged?: number | null;
/**
* The number of rows changed.
*/
rowsChanged?: number | null;
/**
* The number of sheets changed.
*/
sheetsChanged?: number | null;
/**
* The number of non-formula cells changed.
*/
valuesChanged?: number | null;
}
/**
* The request for retrieving a Spreadsheet.
*/
export interface Schema$GetSpreadsheetByDataFilterRequest {
/**
* The DataFilters used to select which ranges to retrieve from the spreadsheet.
*/
dataFilters?: Schema$DataFilter[];
/**
* True if grid data should be returned. This parameter is ignored if a field mask was set in the request.
*/
includeGridData?: boolean | null;
}
/**
* A rule that applies a gradient color scale format, based on the interpolation points listed. The format of a cell will vary based on its contents as compared to the values of the interpolation points.
*/
export interface Schema$GradientRule {
/**
* The final interpolation point.
*/
maxpoint?: Schema$InterpolationPoint;
/**
* An optional midway interpolation point.
*/
midpoint?: Schema$InterpolationPoint;
/**
* The starting interpolation point.
*/
minpoint?: Schema$InterpolationPoint;
}
/**
* A coordinate in a sheet. All indexes are zero-based.
*/
export interface Schema$GridCoordinate {
/**
* The column index of the coordinate.
*/
columnIndex?: number | null;
/**
* The row index of the coordinate.
*/
rowIndex?: number | null;
/**
* The sheet this coordinate is on.
*/
sheetId?: number | null;
}
/**
* Data in the grid, as well as metadata about the dimensions.
*/
export interface Schema$GridData {
/**
* Metadata about the requested columns in the grid, starting with the column in start_column.
*/
columnMetadata?: Schema$DimensionProperties[];
/**
* The data in the grid, one entry per row, starting with the row in startRow. The values in RowData will correspond to columns starting at start_column.
*/
rowData?: Schema$RowData[];
/**
* Metadata about the requested rows in the grid, starting with the row in start_row.
*/
rowMetadata?: Schema$DimensionProperties[];
/**
* The first column this GridData refers to, zero-based.
*/
startColumn?: number | null;
/**
* The first row this GridData refers to, zero-based.
*/
startRow?: number | null;
}
/**
* Properties of a grid.
*/
export interface Schema$GridProperties {
/**
* The number of columns in the grid.
*/
columnCount?: number | null;
/**
* True if the column grouping control toggle is shown after the group.
*/
columnGroupControlAfter?: boolean | null;
/**
* The number of columns that are frozen in the grid.
*/
frozenColumnCount?: number | null;
/**
* The number of rows that are frozen in the grid.
*/
frozenRowCount?: number | null;
/**
* True if the grid isn't showing gridlines in the UI.
*/
hideGridlines?: boolean | null;
/**
* The number of rows in the grid.
*/
rowCount?: number | null;
/**
* True if the row grouping control toggle is shown after the group.
*/
rowGroupControlAfter?: boolean | null;
}
/**
* A range on a sheet. All indexes are zero-based. Indexes are half open, e.g the start index is inclusive and the end index is exclusive -- [start_index, end_index). Missing indexes indicate the range is unbounded on that side. For example, if `"Sheet1"` is sheet ID 0, then: `Sheet1!A1:A1 == sheet_id: 0, start_row_index: 0, end_row_index: 1, start_column_index: 0, end_column_index: 1` `Sheet1!A3:B4 == sheet_id: 0, start_row_index: 2, end_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1!A:B == sheet_id: 0, start_column_index: 0, end_column_index: 2` `Sheet1!A5:B == sheet_id: 0, start_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1 == sheet_id:0` The start index must always be less than or equal to the end index. If the start index equals the end index, then the range is empty. Empty ranges are typically not meaningful and are usually rendered in the UI as `#REF!`.
*/
export interface Schema$GridRange {
/**
* The end column (exclusive) of the range, or not set if unbounded.
*/
endColumnIndex?: number | null;
/**
* The end row (exclusive) of the range, or not set if unbounded.
*/
endRowIndex?: number | null;
/**
* The sheet this range is on.
*/
sheetId?: number | null;
/**
* The start column (inclusive) of the range, or not set if unbounded.
*/
startColumnIndex?: number | null;
/**
* The start row (inclusive) of the range, or not set if unbounded.
*/
startRowIndex?: number | null;
}
/**
* A <a href="/chart/interactive/docs/gallery/histogram">histogram chart</a>. A histogram chart groups data items into bins, displaying each bin as a column of stacked items. Histograms are used to display the distribution of a dataset. Each column of items represents a range into which those items fall. The number of bins can be chosen automatically or specified explicitly.
*/
export interface Schema$HistogramChartSpec {
/**
* By default the bucket size (the range of values stacked in a single column) is chosen automatically, but it may be overridden here. E.g., A bucket size of 1.5 results in buckets from 0 - 1.5, 1.5 - 3.0, etc. Cannot be negative. This field is optional.
*/
bucketSize?: number | null;
/**
* The position of the chart legend.
*/
legendPosition?: string | null;
/**
* The outlier percentile is used to ensure that outliers do not adversely affect the calculation of bucket sizes. For example, setting an outlier percentile of 0.05 indicates that the top and bottom 5% of values when calculating buckets. The values are still included in the chart, they will be added to the first or last buckets instead of their own buckets. Must be between 0.0 and 0.5.
*/
outlierPercentile?: number | null;
/**
* The series for a histogram may be either a single series of values to be bucketed or multiple series, each of the same length, containing the name of the series followed by the values to be bucketed for that series.
*/
series?: Schema$HistogramSeries[];
/**
* Whether horizontal divider lines should be displayed between items in each column.
*/
showItemDividers?: boolean | null;
}
/**
* Allows you to organize the numeric values in a source data column into buckets of a constant size. All values from HistogramRule.start to HistogramRule.end are placed into groups of size HistogramRule.interval. In addition, all values below HistogramRule.start are placed in one group, and all values above HistogramRule.end are placed in another. Only HistogramRule.interval is required, though if HistogramRule.start and HistogramRule.end are both provided, HistogramRule.start must be less than HistogramRule.end. For example, a pivot table showing average purchase amount by age that has 50+ rows: +-----+-------------------+ | Age | AVERAGE of Amount | +-----+-------------------+ | 16 | $27.13 | | 17 | $5.24 | | 18 | $20.15 | ... +-----+-------------------+ could be turned into a pivot table that looks like the one below by applying a histogram group rule with a HistogramRule.start of 25, an HistogramRule.interval of 20, and an HistogramRule.end of 65. +-------------+-------------------+ | Grouped Age | AVERAGE of Amount | +-------------+-------------------+ | < 25 | $19.34 | | 25-45 | $31.43 | | 45-65 | $35.87 | | > 65 | $27.55 | +-------------+-------------------+ | Grand Total | $29.12 | +-------------+-------------------+
*/
export interface Schema$HistogramRule {
/**
* The maximum value at which items are placed into buckets of constant size. Values above end are lumped into a single bucket. This field is optional.
*/
end?: number | null;
/**
* The size of the buckets that are created. Must be positive.
*/
interval?: number | null;
/**
* The minimum value at which items are placed into buckets of constant size. Values below start are lumped into a single bucket. This field is optional.
*/
start?: number | null;
}
/**
* A histogram series containing the series color and data.
*/
export interface Schema$HistogramSeries {
/**
* The color of the column representing this series in each bucket. This field is optional.
*/
barColor?: Schema$Color;
/**
* The data for this histogram series.
*/
data?: Schema$ChartData;
}
/**
* Inserts rows or columns in a sheet at a particular index.
*/
export interface Schema$InsertDimensionRequest {
/**
* Whether dimension properties should be extended from the dimensions before or after the newly inserted dimensions. True to inherit from the dimensions before (in which case the start index must be greater than 0), and false to inherit from the dimensions after. For example, if row index 0 has red background and row index 1 has a green background, then inserting 2 rows at index 1 can inherit either the green or red background. If `inheritFromBefore` is true, the two new rows will be red (because the row before the insertion point was red), whereas if `inheritFromBefore` is false, the two new rows will be green (because the row after the insertion point was green).
*/
inheritFromBefore?: boolean | null;
/**
* The dimensions to insert. Both the start and end indexes must be bounded.
*/
range?: Schema$DimensionRange;
}
/**
* Inserts cells into a range, shifting the existing cells over or down.
*/
export interface Schema$InsertRangeRequest {
/**
* The range to insert new cells into.
*/
range?: Schema$GridRange;
/**
* The dimension which will be shifted when inserting cells. If ROWS, existing cells will be shifted down. If COLUMNS, existing cells will be shifted right.
*/
shiftDimension?: string | null;
}
/**
* A single interpolation point on a gradient conditional format. These pin the gradient color scale according to the color, type and value chosen.
*/
export interface Schema$InterpolationPoint {
/**
* The color this interpolation point should use.
*/
color?: Schema$Color;
/**
* How the value should be interpreted.
*/
type?: string | null;
/**
* The value this interpolation point uses. May be a formula. Unused if type is MIN or MAX.
*/
value?: string | null;
}
/**
* Settings to control how circular dependencies are resolved with iterative calculation.
*/
export interface Schema$IterativeCalculationSettings {
/**
* When iterative calculation is enabled and successive results differ by less than this threshold value, the calculation rounds stop.
*/
convergenceThreshold?: number | null;
/**
* When iterative calculation is enabled, the maximum number of calculation rounds to perform.
*/
maxIterations?: number | null;
}
/**
* Formatting options for key value.
*/
export interface Schema$KeyValueFormat {
/**
* Specifies the horizontal text positioning of key value. This field is optional. If not specified, default positioning is used.
*/
position?: Schema$TextPosition;
/**
* Text formatting options for key value.
*/
textFormat?: Schema$TextFormat;
}
/**
* Properties that describe the style of a line.
*/
export interface Schema$LineStyle {
/**
* The dash type of the line.
*/
type?: string | null;
/**
* The thickness of the line, in px.
*/
width?: number | null;
}
/**
* Allows you to manually organize the values in a source data column into buckets with names of your choosing. For example, a pivot table that aggregates population by state: +-------+-------------------+ | State | SUM of Population | +-------+-------------------+ | AK | 0.7 | | AL | 4.8 | | AR | 2.9 | ... +-------+-------------------+ could be turned into a pivot table that aggregates population by time zone by providing a list of groups (for example, groupName = 'Central', items = ['AL', 'AR', 'IA', ...]) to a manual group rule. Note that a similar effect could be achieved by adding a time zone column to the source data and adjusting the pivot table. +-----------+-------------------+ | Time Zone | SUM of Population | +-----------+-------------------+ | Central | 106.3 | | Eastern | 151.9 | | Mountain | 17.4 | ... +-----------+-------------------+
*/
export interface Schema$ManualRule {
/**
* The list of group names and the corresponding items from the source data that map to each group name.
*/
groups?: Schema$ManualRuleGroup[];
}
/**
* A group name and a list of items from the source data that should be placed in the group with this name.
*/
export interface Schema$ManualRuleGroup {
/**
* The group name, which must be a string. Each group in a given ManualRule must have a unique group name.
*/
groupName?: Schema$ExtendedValue;
/**
* The items in the source data that should be placed into this group. Each item may be a string, number, or boolean. Items may appear in at most one group within a given ManualRule. Items that do not appear in any group will appear on their own.
*/
items?: Schema$ExtendedValue[];
}
/**
* A developer metadata entry and the data filters specified in the original request that matched it.
*/
export interface Schema$MatchedDeveloperMetadata {
/**
* All filters matching the returned developer metadata.
*/
dataFilters?: Schema$DataFilter[];
/**
* The developer metadata matching the specified filters.
*/
developerMetadata?: Schema$DeveloperMetadata;
}
/**
* A value range that was matched by one or more data filers.
*/
export interface Schema$MatchedValueRange {
/**
* The DataFilters from the request that matched the range of values.
*/
dataFilters?: Schema$DataFilter[];
/**
* The values matched by the DataFilter.
*/
valueRange?: Schema$ValueRange;
}
/**
* Merges all cells in the range.
*/
export interface Schema$MergeCellsRequest {
/**
* How the cells should be merged.
*/
mergeType?: string | null;
/**
* The range of cells to merge.
*/
range?: Schema$GridRange;
}
/**
* Moves one or more rows or columns.
*/
export interface Schema$MoveDimensionRequest {
/**
* The zero-based start index of where to move the source data to, based on the coordinates *before* the source data is removed from the grid. Existing data will be shifted down or right (depending on the dimension) to make room for the moved dimensions. The source dimensions are removed from the grid, so the the data may end up in a different index than specified. For example, given `A1..A5` of `0, 1, 2, 3, 4` and wanting to move `"1"` and `"2"` to between `"3"` and `"4"`, the source would be `ROWS [1..3)`,and the destination index would be `"4"` (the zero-based index of row 5). The end result would be `A1..A5` of `0, 3, 1, 2, 4`.
*/
destinationIndex?: number | null;
/**
* The source dimensions to move.
*/
source?: Schema$DimensionRange;
}
/**
* A named range.
*/
export interface Schema$NamedRange {
/**
* The name of the named range.
*/
name?: string | null;
/**
* The ID of the named range.
*/
namedRangeId?: string | null;
/**
* The range this represents.
*/
range?: Schema$GridRange;
}
/**
* The number format of a cell.
*/
export interface Schema$NumberFormat {
/**
* Pattern string used for formatting. If not set, a default pattern based on the user's locale will be used if necessary for the given type. See the [Date and Number Formats guide](/sheets/api/guides/formats) for more information about the supported patterns.
*/
pattern?: string | null;
/**
* The type of the number format. When writing, this field must be set.
*/
type?: string | null;
}
/**
* An <a href="/chart/interactive/docs/gallery/orgchart">org chart</a>. Org charts require a unique set of labels in labels and may optionally include parent_labels and tooltips. parent_labels contain, for each node, the label identifying the parent node. tooltips contain, for each node, an optional tooltip. For example, to describe an OrgChart with Alice as the CEO, Bob as the President (reporting to Alice) and Cathy as VP of Sales (also reporting to Alice), have labels contain "Alice", "Bob", "Cathy", parent_labels contain "", "Alice", "Alice" and tooltips contain "CEO", "President", "VP Sales".
*/
export interface Schema$OrgChartSpec {
/**
* The data containing the labels for all the nodes in the chart. Labels must be unique.
*/
labels?: Schema$ChartData;
/**
* The color of the org chart nodes.
*/
nodeColor?: Schema$Color;
/**
* The size of the org chart nodes.
*/
nodeSize?: string | null;
/**
* The data containing the label of the parent for the corresponding node. A blank value indicates that the node has no parent and is a top-level node. This field is optional.
*/
parentLabels?: Schema$ChartData;
/**
* The color of the selected org chart nodes.
*/
selectedNodeColor?: Schema$Color;
/**
* The data containing the tooltip for the corresponding node. A blank value results in no tooltip being displayed for the node. This field is optional.
*/
tooltips?: Schema$ChartData;
}
/**
* The location an object is overlaid on top of a grid.
*/
export interface Schema$OverlayPosition {
/**
* The cell the object is anchored to.
*/
anchorCell?: Schema$GridCoordinate;
/**
* The height of the object, in pixels. Defaults to 371.
*/
heightPixels?: number | null;
/**
* The horizontal offset, in pixels, that the object is offset from the anchor cell.
*/
offsetXPixels?: number | null;
/**
* The vertical offset, in pixels, that the object is offset from the anchor cell.
*/
offsetYPixels?: number | null;
/**
* The width of the object, in pixels. Defaults to 600.
*/
widthPixels?: number | null;
}
/**
* The amount of padding around the cell, in pixels. When updating padding, every field must be specified.
*/
export interface Schema$Padding {
/**
* The bottom padding of the cell.
*/
bottom?: number | null;
/**
* The left padding of the cell.
*/
left?: number | null;
/**
* The right padding of the cell.
*/
right?: number | null;
/**
* The top padding of the cell.
*/
top?: number | null;
}
/**
* Inserts data into the spreadsheet starting at the specified coordinate.
*/
export interface Schema$PasteDataRequest {
/**
* The coordinate at which the data should start being inserted.
*/
coordinate?: Schema$GridCoordinate;
/**
* The data to insert.
*/
data?: string | null;
/**
* The delimiter in the data.
*/
delimiter?: string | null;
/**
* True if the data is HTML.
*/
html?: boolean | null;
/**
* How the data should be pasted.
*/
type?: string | null;
}
/**
* A <a href="/chart/interactive/docs/gallery/piechart">pie chart</a>.
*/
export interface Schema$PieChartSpec {
/**
* The data that covers the domain of the pie chart.
*/
domain?: Schema$ChartData;
/**
* Where the legend of the pie chart should be drawn.
*/
legendPosition?: string | null;
/**
* The size of the hole in the pie chart.
*/
pieHole?: number | null;
/**
* The data that covers the one and only series of the pie chart.
*/
series?: Schema$ChartData;
/**
* True if the pie is three dimensional.
*/
threeDimensional?: boolean | null;
}
/**
* Criteria for showing/hiding rows in a pivot table.
*/
export interface Schema$PivotFilterCriteria {
/**
* Values that should be included. Values not listed here are excluded.
*/
visibleValues?: string[] | null;
}
/**
* A single grouping (either row or column) in a pivot table.
*/
export interface Schema$PivotGroup {
/**
* The group rule to apply to this row/column group.
*/
groupRule?: Schema$PivotGroupRule;
/**
* The labels to use for the row/column groups which can be customized. For example, in the following pivot table, the row label is `Region` (which could be renamed to `State`) and the column label is `Product` (which could be renamed `Item`). Pivot tables created before December 2017 do not have header labels. If you'd like to add header labels to an existing pivot table, please delete the existing pivot table and then create a new pivot table with same parameters. +--------------+---------+-------+ | SUM of Units | Product | | | Region | Pen | Paper | +--------------+---------+-------+ | New York | 345 | 98 | | Oregon | 234 | 123 | | Tennessee | 531 | 415 | +--------------+---------+-------+ | Grand Total | 1110 | 636 | +--------------+---------+-------+
*/
label?: string | null;
/**
* True if the headings in this pivot group should be repeated. This is only valid for row groupings and is ignored by columns. By default, we minimize repitition of headings by not showing higher level headings where they are the same. For example, even though the third row below corresponds to "Q1 Mar", "Q1" is not shown because it is redundant with previous rows. Setting repeat_headings to true would cause "Q1" to be repeated for "Feb" and "Mar". +--------------+ | Q1 | Jan | | | Feb | | | Mar | +--------+-----+ | Q1 Total | +--------------+
*/
repeatHeadings?: boolean | null;
/**
* True if the pivot table should include the totals for this grouping.
*/
showTotals?: boolean | null;
/**
* The order the values in this group should be sorted.
*/
sortOrder?: string | null;
/**
* The column offset of the source range that this grouping is based on. For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0` means this group refers to column `C`, whereas the offset `1` would refer to column `D`.
*/
sourceColumnOffset?: number | null;
/**
* The bucket of the opposite pivot group to sort by. If not specified, sorting is alphabetical by this group's values.
*/
valueBucket?: Schema$PivotGroupSortValueBucket;
/**
* Metadata about values in the grouping.
*/
valueMetadata?: Schema$PivotGroupValueMetadata[];
}
/**
* An optional setting on a PivotGroup that defines buckets for the values in the source data column rather than breaking out each individual value. Only one PivotGroup with a group rule may be added for each column in the source data, though on any given column you may add both a PivotGroup that has a rule and a PivotGroup that does not.
*/
export interface Schema$PivotGroupRule {
/**
* A DateTimeRule.
*/
dateTimeRule?: Schema$DateTimeRule;
/**
* A HistogramRule.
*/
histogramRule?: Schema$HistogramRule;
/**
* A ManualRule.
*/
manualRule?: Schema$ManualRule;
}
/**
* Information about which values in a pivot group should be used for sorting.
*/
export interface Schema$PivotGroupSortValueBucket {
/**
* Determines the bucket from which values are chosen to sort. For example, in a pivot table with one row group & two column groups, the row group can list up to two values. The first value corresponds to a value within the first column group, and the second value corresponds to a value in the second column group. If no values are listed, this would indicate that the row should be sorted according to the "Grand Total" over the column groups. If a single value is listed, this would correspond to using the "Total" of that bucket.
*/
buckets?: Schema$ExtendedValue[];
/**
* The offset in the PivotTable.values list which the values in this grouping should be sorted by.
*/
valuesIndex?: number | null;
}
/**
* Metadata about a value in a pivot grouping.
*/
export interface Schema$PivotGroupValueMetadata {
/**
* True if the data corresponding to the value is collapsed.
*/
collapsed?: boolean | null;
/**
* The calculated value the metadata corresponds to. (Note that formulaValue is not valid, because the values will be calculated.)
*/
value?: Schema$ExtendedValue;
}
/**
* A pivot table.
*/
export interface Schema$PivotTable {
/**
* Each column grouping in the pivot table.
*/
columns?: Schema$PivotGroup[];
/**
* An optional mapping of filters per source column offset. The filters are applied before aggregating data into the pivot table. The map's key is the column offset of the source range that you want to filter, and the value is the criteria for that column. For example, if the source was `C10:E15`, a key of `0` will have the filter for column `C`, whereas the key `1` is for column `D`.
*/
criteria?: {
[key: string]: Schema$PivotFilterCriteria;
} | null;
/**
* Each row grouping in the pivot table.
*/
rows?: Schema$PivotGroup[];
/**
* The range the pivot table is reading data from.
*/
source?: Schema$GridRange;
/**
* Whether values should be listed horizontally (as columns) or vertically (as rows).
*/
valueLayout?: string | null;
/**
* A list of values to include in the pivot table.
*/
values?: Schema$PivotValue[];
}
/**
* The definition of how a value in a pivot table should be calculated.
*/
export interface Schema$PivotValue {
/**
* If specified, indicates that pivot values should be displayed as the result of a calculation with another pivot value. For example, if calculated_display_type is specified as PERCENT_OF_GRAND_TOTAL, all the pivot values are displayed as the percentage of the grand total. In the Sheets UI, this is referred to as "Show As" in the value section of a pivot table.
*/
calculatedDisplayType?: string | null;
/**
* A custom formula to calculate the value. The formula must start with an `=` character.
*/
formula?: string | null;
/**
* A name to use for the value.
*/
name?: string | null;
/**
* The column offset of the source range that this value reads from. For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0` means this value refers to column `C`, whereas the offset `1` would refer to column `D`.
*/
sourceColumnOffset?: number | null;
/**
* A function to summarize the value. If formula is set, the only supported values are SUM and CUSTOM. If sourceColumnOffset is set, then `CUSTOM` is not supported.
*/
summarizeFunction?: string | null;
}
/**
* A protected range.
*/
export interface Schema$ProtectedRange {
/**
* The description of this protected range.
*/
description?: string | null;
/**
* The users and groups with edit access to the protected range. This field is only visible to users with edit access to the protected range and the document. Editors are not supported with warning_only protection.
*/
editors?: Schema$Editors;
/**
* The named range this protected range is backed by, if any. When writing, only one of range or named_range_id may be set.
*/
namedRangeId?: string | null;
/**
* The ID of the protected range. This field is read-only.
*/
protectedRangeId?: number | null;
/**
* The range that is being protected. The range may be fully unbounded, in which case this is considered a protected sheet. When writing, only one of range or named_range_id may be set.
*/
range?: Schema$GridRange;
/**
* True if the user who requested this protected range can edit the protected area. This field is read-only.
*/
requestingUserCanEdit?: boolean | null;
/**
* The list of unprotected ranges within a protected sheet. Unprotected ranges are only supported on protected sheets.
*/
unprotectedRanges?: Schema$GridRange[];
/**
* True if this protected range will show a warning when editing. Warning-based protection means that every user can edit data in the protected range, except editing will prompt a warning asking the user to confirm the edit. When writing: if this field is true, then editors is ignored. Additionally, if this field is changed from true to false and the `editors` field is not set (nor included in the field mask), then the editors will be set to all the editors in the document.
*/
warningOnly?: boolean | null;
}
/**
* Randomizes the order of the rows in a range.
*/
export interface Schema$RandomizeRangeRequest {
/**
* The range to randomize.
*/
range?: Schema$GridRange;
}
/**
* Updates all cells in the range to the values in the given Cell object. Only the fields listed in the fields field are updated; others are unchanged. If writing a cell with a formula, the formula's ranges will automatically increment for each field in the range. For example, if writing a cell with formula `=A1` into range B2:C4, B2 would be `=A1`, B3 would be `=A2`, B4 would be `=A3`, C2 would be `=B1`, C3 would be `=B2`, C4 would be `=B3`. To keep the formula's ranges static, use the `$` indicator. For example, use the formula `=$A$1` to prevent both the row and the column from incrementing.
*/
export interface Schema$RepeatCellRequest {
/**
* The data to write.
*/
cell?: Schema$CellData;
/**
* The fields that should be updated. At least one field must be specified. The root `cell` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field.
*/
fields?: string | null;
/**
* The range to repeat the cell in.
*/
range?: Schema$GridRange;
}
/**
* A single kind of update to apply to a spreadsheet.
*/
export interface Schema$Request {
/**
* Adds a new banded range
*/
addBanding?: Schema$AddBandingRequest;
/**
* Adds a chart.
*/
addChart?: Schema$AddChartRequest;
/**
* Adds a new conditional format rule.
*/
addConditionalFormatRule?: Schema$AddConditionalFormatRuleRequest;
/**
* Creates a group over the specified range.
*/
addDimensionGroup?: Schema$AddDimensionGroupRequest;
/**
* Adds a filter view.
*/
addFilterView?: Schema$AddFilterViewRequest;
/**
* Adds a named range.
*/
addNamedRange?: Schema$AddNamedRangeRequest;
/**
* Adds a protected range.
*/
addProtectedRange?: Schema$AddProtectedRangeRequest;
/**
* Adds a sheet.
*/
addSheet?: Schema$AddSheetRequest;
/**
* Adds a slicer.
*/
addSlicer?: Schema$AddSlicerRequest;
/**
* Appends cells after the last row with data in a sheet.
*/
appendCells?: Schema$AppendCellsRequest;
/**
* Appends dimensions to the end of a sheet.
*/
appendDimension?: Schema$AppendDimensionRequest;
/**
* Automatically fills in more data based on existing data.
*/
autoFill?: Schema$AutoFillRequest;
/**
* Automatically resizes one or more dimensions based on the contents of the cells in that dimension.
*/
autoResizeDimensions?: Schema$AutoResizeDimensionsRequest;
/**
* Clears the basic filter on a sheet.
*/
clearBasicFilter?: Schema$ClearBasicFilterRequest;
/**
* Copies data from one area and pastes it to another.
*/
copyPaste?: Schema$CopyPasteRequest;
/**
* Creates new developer metadata
*/
createDeveloperMetadata?: Schema$CreateDeveloperMetadataRequest;
/**
* Cuts data from one area and pastes it to another.
*/
cutPaste?: Schema$CutPasteRequest;
/**
* Removes a banded range
*/
deleteBanding?: Schema$DeleteBandingRequest;
/**
* Deletes an existing conditional format rule.
*/
deleteConditionalFormatRule?: Schema$DeleteConditionalFormatRuleRequest;
/**
* Deletes developer metadata
*/
deleteDeveloperMetadata?: Schema$DeleteDeveloperMetadataRequest;
/**
* Deletes rows or columns in a sheet.
*/
deleteDimension?: Schema$DeleteDimensionRequest;
/**
* Deletes a group over the specified range.
*/
deleteDimensionGroup?: Schema$DeleteDimensionGroupRequest;
/**
* Removes rows containing duplicate values in specified columns of a cell range.
*/
deleteDuplicates?: Schema$DeleteDuplicatesRequest;
/**
* Deletes an embedded object (e.g, chart, image) in a sheet.
*/
deleteEmbeddedObject?: Schema$DeleteEmbeddedObjectRequest;
/**
* Deletes a filter view from a sheet.
*/
deleteFilterView?: Schema$DeleteFilterViewRequest;
/**
* Deletes a named range.
*/
deleteNamedRange?: Schema$DeleteNamedRangeRequest;
/**
* Deletes a protected range.
*/
deleteProtectedRange?: Schema$DeleteProtectedRangeRequest;
/**
* Deletes a range of cells from a sheet, shifting the remaining cells.
*/
deleteRange?: Schema$DeleteRangeRequest;
/**
* Deletes a sheet.
*/
deleteSheet?: Schema$DeleteSheetRequest;
/**
* Duplicates a filter view.
*/
duplicateFilterView?: Schema$DuplicateFilterViewRequest;
/**
* Duplicates a sheet.
*/
duplicateSheet?: Schema$DuplicateSheetRequest;
/**
* Finds and replaces occurrences of some text with other text.
*/
findReplace?: Schema$FindReplaceRequest;
/**
* Inserts new rows or columns in a sheet.
*/
insertDimension?: Schema$InsertDimensionRequest;
/**
* Inserts new cells in a sheet, shifting the existing cells.
*/
insertRange?: Schema$InsertRangeRequest;
/**
* Merges cells together.
*/
mergeCells?: Schema$MergeCellsRequest;
/**
* Moves rows or columns to another location in a sheet.
*/
moveDimension?: Schema$MoveDimensionRequest;
/**
* Pastes data (HTML or delimited) into a sheet.
*/
pasteData?: Schema$PasteDataRequest;
/**
* Randomizes the order of the rows in a range.
*/
randomizeRange?: Schema$RandomizeRangeRequest;
/**
* Repeats a single cell across a range.
*/
repeatCell?: Schema$RepeatCellRequest;
/**
* Sets the basic filter on a sheet.
*/
setBasicFilter?: Schema$SetBasicFilterRequest;
/**
* Sets data validation for one or more cells.
*/
setDataValidation?: Schema$SetDataValidationRequest;
/**
* Sorts data in a range.
*/
sortRange?: Schema$SortRangeRequest;
/**
* Converts a column of text into many columns of text.
*/
textToColumns?: Schema$TextToColumnsRequest;
/**
* Trims cells of whitespace (such as spaces, tabs, or new lines).
*/
trimWhitespace?: Schema$TrimWhitespaceRequest;
/**
* Unmerges merged cells.
*/
unmergeCells?: Schema$UnmergeCellsRequest;
/**
* Updates a banded range
*/
updateBanding?: Schema$UpdateBandingRequest;
/**
* Updates the borders in a range of cells.
*/
updateBorders?: Schema$UpdateBordersRequest;
/**
* Updates many cells at once.
*/
updateCells?: Schema$UpdateCellsRequest;
/**
* Updates a chart's specifications.
*/
updateChartSpec?: Schema$UpdateChartSpecRequest;
/**
* Updates an existing conditional format rule.
*/
updateConditionalFormatRule?: Schema$UpdateConditionalFormatRuleRequest;
/**
* Updates an existing developer metadata entry
*/
updateDeveloperMetadata?: Schema$UpdateDeveloperMetadataRequest;
/**
* Updates the state of the specified group.
*/
updateDimensionGroup?: Schema$UpdateDimensionGroupRequest;
/**
* Updates dimensions' properties.
*/
updateDimensionProperties?: Schema$UpdateDimensionPropertiesRequest;
/**
* Updates an embedded object's (e.g. chart, image) position.
*/
updateEmbeddedObjectPosition?: Schema$UpdateEmbeddedObjectPositionRequest;
/**
* Updates the properties of a filter view.
*/
updateFilterView?: Schema$UpdateFilterViewRequest;
/**
* Updates a named range.
*/
updateNamedRange?: Schema$UpdateNamedRangeRequest;
/**
* Updates a protected range.
*/
updateProtectedRange?: Schema$UpdateProtectedRangeRequest;
/**
* Updates a sheet's properties.
*/
updateSheetProperties?: Schema$UpdateSheetPropertiesRequest;
/**
* Updates a slicer's specifications.
*/
updateSlicerSpec?: Schema$UpdateSlicerSpecRequest;
/**
* Updates the spreadsheet's properties.
*/
updateSpreadsheetProperties?: Schema$UpdateSpreadsheetPropertiesRequest;
}
/**
* A single response from an update.
*/
export interface Schema$Response {
/**
* A reply from adding a banded range.
*/
addBanding?: Schema$AddBandingResponse;
/**
* A reply from adding a chart.
*/
addChart?: Schema$AddChartResponse;
/**
* A reply from adding a dimension group.
*/
addDimensionGroup?: Schema$AddDimensionGroupResponse;
/**
* A reply from adding a filter view.
*/
addFilterView?: Schema$AddFilterViewResponse;
/**
* A reply from adding a named range.
*/
addNamedRange?: Schema$AddNamedRangeResponse;
/**
* A reply from adding a protected range.
*/
addProtectedRange?: Schema$AddProtectedRangeResponse;
/**
* A reply from adding a sheet.
*/
addSheet?: Schema$AddSheetResponse;
/**
* A reply from adding a slicer.
*/
addSlicer?: Schema$AddSlicerResponse;
/**
* A reply from creating a developer metadata entry.
*/
createDeveloperMetadata?: Schema$CreateDeveloperMetadataResponse;
/**
* A reply from deleting a conditional format rule.
*/
deleteConditionalFormatRule?: Schema$DeleteConditionalFormatRuleResponse;
/**
* A reply from deleting a developer metadata entry.
*/
deleteDeveloperMetadata?: Schema$DeleteDeveloperMetadataResponse;
/**
* A reply from deleting a dimension group.
*/
deleteDimensionGroup?: Schema$DeleteDimensionGroupResponse;
/**
* A reply from removing rows containing duplicate values.
*/
deleteDuplicates?: Schema$DeleteDuplicatesResponse;
/**
* A reply from duplicating a filter view.
*/
duplicateFilterView?: Schema$DuplicateFilterViewResponse;
/**
* A reply from duplicating a sheet.
*/
duplicateSheet?: Schema$DuplicateSheetResponse;
/**
* A reply from doing a find/replace.
*/
findReplace?: Schema$FindReplaceResponse;
/**
* A reply from trimming whitespace.
*/
trimWhitespace?: Schema$TrimWhitespaceResponse;
/**
* A reply from updating a conditional format rule.
*/
updateConditionalFormatRule?: Schema$UpdateConditionalFormatRuleResponse;
/**
* A reply from updating a developer metadata entry.
*/
updateDeveloperMetadata?: Schema$UpdateDeveloperMetadataResponse;
/**
* A reply from updating an embedded object's position.
*/
updateEmbeddedObjectPosition?: Schema$UpdateEmbeddedObjectPositionResponse;
}
/**
* Data about each cell in a row.
*/
export interface Schema$RowData {
/**
* The values in the row, one per column.
*/
values?: Schema$CellData[];
}
/**
* A scorecard chart. Scorecard charts are used to highlight key performance indicators, known as KPIs, on the spreadsheet. A scorecard chart can represent things like total sales, average cost, or a top selling item. You can specify a single data value, or aggregate over a range of data. Percentage or absolute difference from a baseline value can be highlighted, like changes over time.
*/
export interface Schema$ScorecardChartSpec {
/**
* The aggregation type for key and baseline chart data in scorecard chart. This field is optional.
*/
aggregateType?: string | null;
/**
* The data for scorecard baseline value. This field is optional.
*/
baselineValueData?: Schema$ChartData;
/**
* Formatting options for baseline value. This field is needed only if baseline_value_data is specified.
*/
baselineValueFormat?: Schema$BaselineValueFormat;
/**
* Custom formatting options for numeric key/baseline values in scorecard chart. This field is used only when number_format_source is set to CUSTOM. This field is optional.
*/
customFormatOptions?: Schema$ChartCustomNumberFormatOptions;
/**
* The data for scorecard key value.
*/
keyValueData?: Schema$ChartData;
/**
* Formatting options for key value.
*/
keyValueFormat?: Schema$KeyValueFormat;
/**
* The number format source used in the scorecard chart. This field is optional.
*/
numberFormatSource?: string | null;
/**
* Value to scale scorecard key and baseline value. For example, a factor of 10 can be used to divide all values in the chart by 10. This field is optional.
*/
scaleFactor?: number | null;
}
/**
* A request to retrieve all developer metadata matching the set of specified criteria.
*/
export interface Schema$SearchDeveloperMetadataRequest {
/**
* The data filters describing the criteria used to determine which DeveloperMetadata entries to return. DeveloperMetadata matching any of the specified filters will be included in the response.
*/
dataFilters?: Schema$DataFilter[];
}
/**
* A reply to a developer metadata search request.
*/
export interface Schema$SearchDeveloperMetadataResponse {
/**
* The metadata matching the criteria of the search request.
*/
matchedDeveloperMetadata?: Schema$MatchedDeveloperMetadata[];
}
/**
* Sets the basic filter associated with a sheet.
*/
export interface Schema$SetBasicFilterRequest {
/**
* The filter to set.
*/
filter?: Schema$BasicFilter;
}
/**
* Sets a data validation rule to every cell in the range. To clear validation in a range, call this with no rule specified.
*/
export interface Schema$SetDataValidationRequest {
/**
* The range the data validation rule should apply to.
*/
range?: Schema$GridRange;
/**
* The data validation rule to set on each cell in the range, or empty to clear the data validation in the range.
*/
rule?: Schema$DataValidationRule;
}
/**
* A sheet in a spreadsheet.
*/
export interface Schema$Sheet {
/**
* The banded (alternating colors) ranges on this sheet.
*/
bandedRanges?: Schema$BandedRange[];
/**
* The filter on this sheet, if any.
*/
basicFilter?: Schema$BasicFilter;
/**
* The specifications of every chart on this sheet.
*/
charts?: Schema$EmbeddedChart[];
/**
* All column groups on this sheet, ordered by increasing range start index, then by group depth.
*/
columnGroups?: Schema$DimensionGroup[];
/**
* The conditional format rules in this sheet.
*/
conditionalFormats?: Schema$ConditionalFormatRule[];
/**
* Data in the grid, if this is a grid sheet. The number of GridData objects returned is dependent on the number of ranges requested on this sheet. For example, if this is representing `Sheet1`, and the spreadsheet was requested with ranges `Sheet1!A1:C10` and `Sheet1!D15:E20`, then the first GridData will have a startRow/startColumn of `0`, while the second one will have `startRow 14` (zero-based row 15), and `startColumn 3` (zero-based column D).
*/
data?: Schema$GridData[];
/**
* The developer metadata associated with a sheet.
*/
developerMetadata?: Schema$DeveloperMetadata[];
/**
* The filter views in this sheet.
*/
filterViews?: Schema$FilterView[];
/**
* The ranges that are merged together.
*/
merges?: Schema$GridRange[];
/**
* The properties of the sheet.
*/
properties?: Schema$SheetProperties;
/**
* The protected ranges in this sheet.
*/
protectedRanges?: Schema$ProtectedRange[];
/**
* All row groups on this sheet, ordered by increasing range start index, then by group depth.
*/
rowGroups?: Schema$DimensionGroup[];
/**
* The slicers on this sheet.
*/
slicers?: Schema$Slicer[];
}
/**
* Properties of a sheet.
*/
export interface Schema$SheetProperties {
/**
* Additional properties of the sheet if this sheet is a grid. (If the sheet is an object sheet, containing a chart or image, then this field will be absent.) When writing it is an error to set any grid properties on non-grid sheets.
*/
gridProperties?: Schema$GridProperties;
/**
* True if the sheet is hidden in the UI, false if it's visible.
*/
hidden?: boolean | null;
/**
* The index of the sheet within the spreadsheet. When adding or updating sheet properties, if this field is excluded then the sheet is added or moved to the end of the sheet list. When updating sheet indices or inserting sheets, movement is considered in "before the move" indexes. For example, if there were 3 sheets (S1, S2, S3) in order to move S1 ahead of S2 the index would have to be set to 2. A sheet index update request is ignored if the requested index is identical to the sheets current index or if the requested new index is equal to the current sheet index + 1.
*/
index?: number | null;
/**
* True if the sheet is an RTL sheet instead of an LTR sheet.
*/
rightToLeft?: boolean | null;
/**
* The ID of the sheet. Must be non-negative. This field cannot be changed once set.
*/
sheetId?: number | null;
/**
* The type of sheet. Defaults to GRID. This field cannot be changed once set.
*/
sheetType?: string | null;
/**
* The color of the tab in the UI.
*/
tabColor?: Schema$Color;
/**
* The name of the sheet.
*/
title?: string | null;
}
/**
* A slicer in a sheet.
*/
export interface Schema$Slicer {
/**
* The position of the slicer. Note that slicer can be positioned only on existing sheet. Also, width and height of slicer can be automatically adjusted to keep it within permitted limits.
*/
position?: Schema$EmbeddedObjectPosition;
/**
* The ID of the slicer.
*/
slicerId?: number | null;
/**
* The specification of the slicer.
*/
spec?: Schema$SlicerSpec;
}
/**
* The specifications of a slicer.
*/
export interface Schema$SlicerSpec {
/**
* True if the filter should apply to pivot tables. If not set, default to `True`.
*/
applyToPivotTables?: boolean | null;
/**
* The background color of the slicer.
*/
backgroundColor?: Schema$Color;
/**
* The column index in the data table on which the filter is applied to.
*/
columnIndex?: number | null;
/**
* The data range of the slicer.
*/
dataRange?: Schema$GridRange;
/**
* The filtering criteria of the slicer.
*/
filterCriteria?: Schema$FilterCriteria;
/**
* The horizontal alignment of title in the slicer. If unspecified, defaults to `LEFT`
*/
horizontalAlignment?: string | null;
/**
* The text format of title in the slicer.
*/
textFormat?: Schema$TextFormat;
/**
* The title of the slicer.
*/
title?: string | null;
}
/**
* Sorts data in rows based on a sort order per column.
*/
export interface Schema$SortRangeRequest {
/**
* The range to sort.
*/
range?: Schema$GridRange;
/**
* The sort order per column. Later specifications are used when values are equal in the earlier specifications.
*/
sortSpecs?: Schema$SortSpec[];
}
/**
* A sort order associated with a specific column or row.
*/
export interface Schema$SortSpec {
/**
* The background fill color to sort by. Mutually exclusive with sorting by text color. Requests to set this field will fail with a 400 error if foreground color is also set.
*/
backgroundColor?: Schema$Color;
/**
* The dimension the sort should be applied to.
*/
dimensionIndex?: number | null;
/**
* The text color to sort by. Mutually exclusive with sorting by background fill color. Requests to set this field will fail with a 400 error if background color is also set.
*/
foregroundColor?: Schema$Color;
/**
* The order data should be sorted.
*/
sortOrder?: string | null;
}
/**
* A combination of a source range and how to extend that source.
*/
export interface Schema$SourceAndDestination {
/**
* The dimension that data should be filled into.
*/
dimension?: string | null;
/**
* The number of rows or columns that data should be filled into. Positive numbers expand beyond the last row or last column of the source. Negative numbers expand before the first row or first column of the source.
*/
fillLength?: number | null;
/**
* The location of the data to use as the source of the autofill.
*/
source?: Schema$GridRange;
}
/**
* Resource that represents a spreadsheet.
*/
export interface Schema$Spreadsheet {
/**
* The developer metadata associated with a spreadsheet.
*/
developerMetadata?: Schema$DeveloperMetadata[];
/**
* The named ranges defined in a spreadsheet.
*/
namedRanges?: Schema$NamedRange[];
/**
* Overall properties of a spreadsheet.
*/
properties?: Schema$SpreadsheetProperties;
/**
* The sheets that are part of a spreadsheet.
*/
sheets?: Schema$Sheet[];
/**
* The ID of the spreadsheet. This field is read-only.
*/
spreadsheetId?: string | null;
/**
* The url of the spreadsheet. This field is read-only.
*/
spreadsheetUrl?: string | null;
}
/**
* Properties of a spreadsheet.
*/
export interface Schema$SpreadsheetProperties {
/**
* The amount of time to wait before volatile functions are recalculated.
*/
autoRecalc?: string | null;
/**
* The default format of all cells in the spreadsheet. CellData.effectiveFormat will not be set if the cell's format is equal to this default format. This field is read-only.
*/
defaultFormat?: Schema$CellFormat;
/**
* Determines whether and how circular references are resolved with iterative calculation. Absence of this field means that circular references will result in calculation errors.
*/
iterativeCalculationSettings?: Schema$IterativeCalculationSettings;
/**
* The locale of the spreadsheet in one of the following formats: * an ISO 639-1 language code such as `en` * an ISO 639-2 language code such as `fil`, if no 639-1 code exists * a combination of the ISO language code and country code, such as `en_US` Note: when updating this field, not all locales/languages are supported.
*/
locale?: string | null;
/**
* The time zone of the spreadsheet, in CLDR format such as `America/New_York`. If the time zone isn't recognized, this may be a custom time zone such as `GMT-07:00`.
*/
timeZone?: string | null;
/**
* The title of the spreadsheet.
*/
title?: string | null;
}
/**
* The format of a run of text in a cell. Absent values indicate that the field isn't specified.
*/
export interface Schema$TextFormat {
/**
* True if the text is bold.
*/
bold?: boolean | null;
/**
* The font family.
*/
fontFamily?: string | null;
/**
* The size of the font.
*/
fontSize?: number | null;
/**
* The foreground color of the text.
*/
foregroundColor?: Schema$Color;
/**
* True if the text is italicized.
*/
italic?: boolean | null;
/**
* True if the text has a strikethrough.
*/
strikethrough?: boolean | null;
/**
* True if the text is underlined.
*/
underline?: boolean | null;
}
/**
* A run of a text format. The format of this run continues until the start index of the next run. When updating, all fields must be set.
*/
export interface Schema$TextFormatRun {
/**
* The format of this run. Absent values inherit the cell's format.
*/
format?: Schema$TextFormat;
/**
* The character index where this run starts.
*/
startIndex?: number | null;
}
/**
* Position settings for text.
*/
export interface Schema$TextPosition {
/**
* Horizontal alignment setting for the piece of text.
*/
horizontalAlignment?: string | null;
}
/**
* The rotation applied to text in a cell.
*/
export interface Schema$TextRotation {
/**
* The angle between the standard orientation and the desired orientation. Measured in degrees. Valid values are between -90 and 90. Positive angles are angled upwards, negative are angled downwards. Note: For LTR text direction positive angles are in the counterclockwise direction, whereas for RTL they are in the clockwise direction
*/
angle?: number | null;
/**
* If true, text reads top to bottom, but the orientation of individual characters is unchanged. For example: | V | | e | | r | | t | | i | | c | | a | | l |
*/
vertical?: boolean | null;
}
/**
* Splits a column of text into multiple columns, based on a delimiter in each cell.
*/
export interface Schema$TextToColumnsRequest {
/**
* The delimiter to use. Used only if delimiterType is CUSTOM.
*/
delimiter?: string | null;
/**
* The delimiter type to use.
*/
delimiterType?: string | null;
/**
* The source data range. This must span exactly one column.
*/
source?: Schema$GridRange;
}
/**
* A color scale for a treemap chart.
*/
export interface Schema$TreemapChartColorScale {
/**
* The background color for cells with a color value greater than or equal to maxValue. Defaults to #109618 if not specified.
*/
maxValueColor?: Schema$Color;
/**
* The background color for cells with a color value at the midpoint between minValue and maxValue. Defaults to #efe6dc if not specified.
*/
midValueColor?: Schema$Color;
/**
* The background color for cells with a color value less than or equal to minValue. Defaults to #dc3912 if not specified.
*/
minValueColor?: Schema$Color;
/**
* The background color for cells that have no color data associated with them. Defaults to #000000 if not specified.
*/
noDataColor?: Schema$Color;
}
/**
* A <a href="/chart/interactive/docs/gallery/treemap">Treemap chart</a>.
*/
export interface Schema$TreemapChartSpec {
/**
* The data that determines the background color of each treemap data cell. This field is optional. If not specified, size_data is used to determine background colors. If specified, the data is expected to be numeric. color_scale will determine how the values in this data map to data cell background colors.
*/
colorData?: Schema$ChartData;
/**
* The color scale for data cells in the treemap chart. Data cells are assigned colors based on their color values. These color values come from color_data, or from size_data if color_data is not specified. Cells with color values less than or equal to min_value will have minValueColor as their background color. Cells with color values greater than or equal to max_value will have maxValueColor as their background color. Cells with color values between min_value and max_value will have background colors on a gradient between minValueColor and maxValueColor, the midpoint of the gradient being midValueColor. Cells with missing or non-numeric color values will have noDataColor as their background color.
*/
colorScale?: Schema$TreemapChartColorScale;
/**
* The background color for header cells.
*/
headerColor?: Schema$Color;
/**
* True to hide tooltips.
*/
hideTooltips?: boolean | null;
/**
* The number of additional data levels beyond the labeled levels to be shown on the treemap chart. These levels are not interactive and are shown without their labels. Defaults to 0 if not specified.
*/
hintedLevels?: number | null;
/**
* The data that contains the treemap cell labels.
*/
labels?: Schema$ChartData;
/**
* The number of data levels to show on the treemap chart. These levels are interactive and are shown with their labels. Defaults to 2 if not specified.
*/
levels?: number | null;
/**
* The maximum possible data value. Cells with values greater than this will have the same color as cells with this value. If not specified, defaults to the actual maximum value from color_data, or the maximum value from size_data if color_data is not specified.
*/
maxValue?: number | null;
/**
* The minimum possible data value. Cells with values less than this will have the same color as cells with this value. If not specified, defaults to the actual minimum value from color_data, or the minimum value from size_data if color_data is not specified.
*/
minValue?: number | null;
/**
* The data the contains the treemap cells' parent labels.
*/
parentLabels?: Schema$ChartData;
/**
* The data that determines the size of each treemap data cell. This data is expected to be numeric. The cells corresponding to non-numeric or missing data will not be rendered. If color_data is not specified, this data is used to determine data cell background colors as well.
*/
sizeData?: Schema$ChartData;
/**
* The text format for all labels on the chart.
*/
textFormat?: Schema$TextFormat;
}
/**
* Trims the whitespace (such as spaces, tabs, or new lines) in every cell in the specified range. This request removes all whitespace from the start and end of each cell's text, and reduces any subsequence of remaining whitespace characters to a single space. If the resulting trimmed text starts with a '+' or '=' character, the text remains as a string value and isn't interpreted as a formula.
*/
export interface Schema$TrimWhitespaceRequest {
/**
* The range whose cells to trim.
*/
range?: Schema$GridRange;
}
/**
* The result of trimming whitespace in cells.
*/
export interface Schema$TrimWhitespaceResponse {
/**
* The number of cells that were trimmed of whitespace.
*/
cellsChangedCount?: number | null;
}
/**
* Unmerges cells in the given range.
*/
export interface Schema$UnmergeCellsRequest {
/**
* The range within which all cells should be unmerged. If the range spans multiple merges, all will be unmerged. The range must not partially span any merge.
*/
range?: Schema$GridRange;
}
/**
* Updates properties of the supplied banded range.
*/
export interface Schema$UpdateBandingRequest {
/**
* The banded range to update with the new properties.
*/
bandedRange?: Schema$BandedRange;
/**
* The fields that should be updated. At least one field must be specified. The root `bandedRange` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field.
*/
fields?: string | null;
}
/**
* Updates the borders of a range. If a field is not set in the request, that means the border remains as-is. For example, with two subsequent UpdateBordersRequest: 1. range: A1:A5 `{ top: RED, bottom: WHITE }` 2. range: A1:A5 `{ left: BLUE }` That would result in A1:A5 having a borders of `{ top: RED, bottom: WHITE, left: BLUE }`. If you want to clear a border, explicitly set the style to NONE.
*/
export interface Schema$UpdateBordersRequest {
/**
* The border to put at the bottom of the range.
*/
bottom?: Schema$Border;
/**
* The horizontal border to put within the range.
*/
innerHorizontal?: Schema$Border;
/**
* The vertical border to put within the range.
*/
innerVertical?: Schema$Border;
/**
* The border to put at the left of the range.
*/
left?: Schema$Border;
/**
* The range whose borders should be updated.
*/
range?: Schema$GridRange;
/**
* The border to put at the right of the range.
*/
right?: Schema$Border;
/**
* The border to put at the top of the range.
*/
top?: Schema$Border;
}
/**
* Updates all cells in a range with new data.
*/
export interface Schema$UpdateCellsRequest {
/**
* The fields of CellData that should be updated. At least one field must be specified. The root is the CellData; 'row.values.' should not be specified. A single `"*"` can be used as short-hand for listing every field.
*/
fields?: string | null;
/**
* The range to write data to. If the data in rows does not cover the entire requested range, the fields matching those set in fields will be cleared.
*/
range?: Schema$GridRange;
/**
* The data to write.
*/
rows?: Schema$RowData[];
/**
* The coordinate to start writing data at. Any number of rows and columns (including a different number of columns per row) may be written.
*/
start?: Schema$GridCoordinate;
}
/**
* Updates a chart's specifications. (This does not move or resize a chart. To move or resize a chart, use UpdateEmbeddedObjectPositionRequest.)
*/
export interface Schema$UpdateChartSpecRequest {
/**
* The ID of the chart to update.
*/
chartId?: number | null;
/**
* The specification to apply to the chart.
*/
spec?: Schema$ChartSpec;
}
/**
* Updates a conditional format rule at the given index, or moves a conditional format rule to another index.
*/
export interface Schema$UpdateConditionalFormatRuleRequest {
/**
* The zero-based index of the rule that should be replaced or moved.
*/
index?: number | null;
/**
* The zero-based new index the rule should end up at.
*/
newIndex?: number | null;
/**
* The rule that should replace the rule at the given index.
*/
rule?: Schema$ConditionalFormatRule;
/**
* The sheet of the rule to move. Required if new_index is set, unused otherwise.
*/
sheetId?: number | null;
}
/**
* The result of updating a conditional format rule.
*/
export interface Schema$UpdateConditionalFormatRuleResponse {
/**
* The index of the new rule.
*/
newIndex?: number | null;
/**
* The new rule that replaced the old rule (if replacing), or the rule that was moved (if moved)
*/
newRule?: Schema$ConditionalFormatRule;
/**
* The old index of the rule. Not set if a rule was replaced (because it is the same as new_index).
*/
oldIndex?: number | null;
/**
* The old (deleted) rule. Not set if a rule was moved (because it is the same as new_rule).
*/
oldRule?: Schema$ConditionalFormatRule;
}
/**
* A request to update properties of developer metadata. Updates the properties of the developer metadata selected by the filters to the values provided in the DeveloperMetadata resource. Callers must specify the properties they wish to update in the fields parameter, as well as specify at least one DataFilter matching the metadata they wish to update.
*/
export interface Schema$UpdateDeveloperMetadataRequest {
/**
* The filters matching the developer metadata entries to update.
*/
dataFilters?: Schema$DataFilter[];
/**
* The value that all metadata matched by the data filters will be updated to.
*/
developerMetadata?: Schema$DeveloperMetadata;
/**
* The fields that should be updated. At least one field must be specified. The root `developerMetadata` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field.
*/
fields?: string | null;
}
/**
* The response from updating developer metadata.
*/
export interface Schema$UpdateDeveloperMetadataResponse {
/**
* The updated developer metadata.
*/
developerMetadata?: Schema$DeveloperMetadata[];
}
/**
* Updates the state of the specified group.
*/
export interface Schema$UpdateDimensionGroupRequest {
/**
* The group whose state should be updated. The range and depth of the group should specify a valid group on the sheet, and all other fields updated.
*/
dimensionGroup?: Schema$DimensionGroup;
/**
* The fields that should be updated. At least one field must be specified. The root `dimensionGroup` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field.
*/
fields?: string | null;
}
/**
* Updates properties of dimensions within the specified range.
*/
export interface Schema$UpdateDimensionPropertiesRequest {
/**
* The fields that should be updated. At least one field must be specified. The root `properties` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field.
*/
fields?: string | null;
/**
* Properties to update.
*/
properties?: Schema$DimensionProperties;
/**
* The rows or columns to update.
*/
range?: Schema$DimensionRange;
}
/**
* Update an embedded object's position (such as a moving or resizing a chart or image).
*/
export interface Schema$UpdateEmbeddedObjectPositionRequest {
/**
* The fields of OverlayPosition that should be updated when setting a new position. Used only if newPosition.overlayPosition is set, in which case at least one field must be specified. The root `newPosition.overlayPosition` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field.
*/
fields?: string | null;
/**
* An explicit position to move the embedded object to. If newPosition.sheetId is set, a new sheet with that ID will be created. If newPosition.newSheet is set to true, a new sheet will be created with an ID that will be chosen for you.
*/
newPosition?: Schema$EmbeddedObjectPosition;
/**
* The ID of the object to moved.
*/
objectId?: number | null;
}
/**
* The result of updating an embedded object's position.
*/
export interface Schema$UpdateEmbeddedObjectPositionResponse {
/**
* The new position of the embedded object.
*/
position?: Schema$EmbeddedObjectPosition;
}
/**
* Updates properties of the filter view.
*/
export interface Schema$UpdateFilterViewRequest {
/**
* The fields that should be updated. At least one field must be specified. The root `filter` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field.
*/
fields?: string | null;
/**
* The new properties of the filter view.
*/
filter?: Schema$FilterView;
}
/**
* Updates properties of the named range with the specified namedRangeId.
*/
export interface Schema$UpdateNamedRangeRequest {
/**
* The fields that should be updated. At least one field must be specified. The root `namedRange` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field.
*/
fields?: string | null;
/**
* The named range to update with the new properties.
*/
namedRange?: Schema$NamedRange;
}
/**
* Updates an existing protected range with the specified protectedRangeId.
*/
export interface Schema$UpdateProtectedRangeRequest {
/**
* The fields that should be updated. At least one field must be specified. The root `protectedRange` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field.
*/
fields?: string | null;
/**
* The protected range to update with the new properties.
*/
protectedRange?: Schema$ProtectedRange;
}
/**
* Updates properties of the sheet with the specified sheetId.
*/
export interface Schema$UpdateSheetPropertiesRequest {
/**
* The fields that should be updated. At least one field must be specified. The root `properties` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field.
*/
fields?: string | null;
/**
* The properties to update.
*/
properties?: Schema$SheetProperties;
}
/**
* Updates a slicer’s specifications. (This does not move or resize a slicer. To move or resize a slicer use UpdateEmbeddedObjectPositionRequest.
*/
export interface Schema$UpdateSlicerSpecRequest {
/**
* The fields that should be updated. At least one field must be specified. The root `SlicerSpec` is implied and should not be specified. A single "*"` can be used as short-hand for listing every field.
*/
fields?: string | null;
/**
* The id of the slicer to update.
*/
slicerId?: number | null;
/**
* The specification to apply to the slicer.
*/
spec?: Schema$SlicerSpec;
}
/**
* Updates properties of a spreadsheet.
*/
export interface Schema$UpdateSpreadsheetPropertiesRequest {
/**
* The fields that should be updated. At least one field must be specified. The root 'properties' is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field.
*/
fields?: string | null;
/**
* The properties to update.
*/
properties?: Schema$SpreadsheetProperties;
}
/**
* The response when updating a range of values by a data filter in a spreadsheet.
*/
export interface Schema$UpdateValuesByDataFilterResponse {
/**
* The data filter that selected the range that was updated.
*/
dataFilter?: Schema$DataFilter;
/**
* The number of cells updated.
*/
updatedCells?: number | null;
/**
* The number of columns where at least one cell in the column was updated.
*/
updatedColumns?: number | null;
/**
* The values of the cells in the range matched by the dataFilter after all updates were applied. This is only included if the request's `includeValuesInResponse` field was `true`.
*/
updatedData?: Schema$ValueRange;
/**
* The range (in A1 notation) that updates were applied to.
*/
updatedRange?: string | null;
/**
* The number of rows where at least one cell in the row was updated.
*/
updatedRows?: number | null;
}
/**
* The response when updating a range of values in a spreadsheet.
*/
export interface Schema$UpdateValuesResponse {
/**
* The spreadsheet the updates were applied to.
*/
spreadsheetId?: string | null;
/**
* The number of cells updated.
*/
updatedCells?: number | null;
/**
* The number of columns where at least one cell in the column was updated.
*/
updatedColumns?: number | null;
/**
* The values of the cells after updates were applied. This is only included if the request's `includeValuesInResponse` field was `true`.
*/
updatedData?: Schema$ValueRange;
/**
* The range (in A1 notation) that updates were applied to.
*/
updatedRange?: string | null;
/**
* The number of rows where at least one cell in the row was updated.
*/
updatedRows?: number | null;
}
/**
* Data within a range of the spreadsheet.
*/
export interface Schema$ValueRange {
/**
* The major dimension of the values. For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension=ROWS` will return `[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return `[[1,3],[2,4]]`. For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]` will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS` then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`. When writing, if this field is not set, it defaults to ROWS.
*/
majorDimension?: string | null;
/**
* The range the values cover, in A1 notation. For output, this range indicates the entire requested range, even though the values will exclude trailing rows and columns. When appending values, this field represents the range to search for a table, after which values will be appended.
*/
range?: string | null;
/**
* The data that was read or to be written. This is an array of arrays, the outer array representing all the data and each inner array representing a major dimension. Each item in the inner array corresponds with one cell. For output, empty trailing rows and columns will not be included. For input, supported value types are: bool, string, and double. Null values will be skipped. To set a cell to an empty value, set the string value to an empty string.
*/
values?: any[][] | null;
}
/**
* Styles for a waterfall chart column.
*/
export interface Schema$WaterfallChartColumnStyle {
/**
* The color of the column.
*/
color?: Schema$Color;
/**
* The label of the column's legend.
*/
label?: string | null;
}
/**
* A custom subtotal column for a waterfall chart series.
*/
export interface Schema$WaterfallChartCustomSubtotal {
/**
* True if the data point at subtotal_index is the subtotal. If false, the subtotal will be computed and appear after the data point.
*/
dataIsSubtotal?: boolean | null;
/**
* A label for the subtotal column.
*/
label?: string | null;
/**
* The 0-based index of a data point within the series. If data_is_subtotal is true, the data point at this index is the subtotal. Otherwise, the subtotal appears after the data point with this index. A series can have multiple subtotals at arbitrary indices, but subtotals do not affect the indices of the data points. For example, if a series has three data points, their indices will always be 0, 1, and 2, regardless of how many subtotals exist on the series or what data points they are associated with.
*/
subtotalIndex?: number | null;
}
/**
* The domain of a waterfall chart.
*/
export interface Schema$WaterfallChartDomain {
/**
* The data of the WaterfallChartDomain.
*/
data?: Schema$ChartData;
/**
* True to reverse the order of the domain values (horizontal axis).
*/
reversed?: boolean | null;
}
/**
* A single series of data for a waterfall chart.
*/
export interface Schema$WaterfallChartSeries {
/**
* Custom subtotal columns appearing in this series. The order in which subtotals are defined is not significant. Only one subtotal may be defined for each data point.
*/
customSubtotals?: Schema$WaterfallChartCustomSubtotal[];
/**
* The data being visualized in this series.
*/
data?: Schema$ChartData;
/**
* True to hide the subtotal column from the end of the series. By default, a subtotal column will appear at the end of each series. Setting this field to true will hide that subtotal column for this series.
*/
hideTrailingSubtotal?: boolean | null;
/**
* Styles for all columns in this series with negative values.
*/
negativeColumnsStyle?: Schema$WaterfallChartColumnStyle;
/**
* Styles for all columns in this series with positive values.
*/
positiveColumnsStyle?: Schema$WaterfallChartColumnStyle;
/**
* Styles for all subtotal columns in this series.
*/
subtotalColumnsStyle?: Schema$WaterfallChartColumnStyle;
}
/**
* A waterfall chart.
*/
export interface Schema$WaterfallChartSpec {
/**
* The line style for the connector lines.
*/
connectorLineStyle?: Schema$LineStyle;
/**
* The domain data (horizontal axis) for the waterfall chart.
*/
domain?: Schema$WaterfallChartDomain;
/**
* True to interpret the first value as a total.
*/
firstValueIsTotal?: boolean | null;
/**
* True to hide connector lines between columns.
*/
hideConnectorLines?: boolean | null;
/**
* The data this waterfall chart is visualizing.
*/
series?: Schema$WaterfallChartSeries[];
/**
* The stacked type.
*/
stackedType?: string | null;
}
export class Resource$Spreadsheets {
context: APIRequestContext;
developerMetadata: Resource$Spreadsheets$Developermetadata;
sheets: Resource$Spreadsheets$Sheets;
values: Resource$Spreadsheets$Values;
constructor(context: APIRequestContext);
/**
* sheets.spreadsheets.batchUpdate
* @desc Applies one or more updates to the spreadsheet. Each request is validated before being applied. If any request is not valid then the entire request will fail and nothing will be applied. Some requests have replies to give you some information about how they are applied. The replies will mirror the requests. For example, if you applied 4 updates and the 3rd one had a reply, then the response will have 2 empty replies, the actual reply, and another empty reply, in that order. Due to the collaborative nature of spreadsheets, it is not guaranteed that the spreadsheet will reflect exactly your changes after this completes, however it is guaranteed that the updates in the request will be applied together atomically. Your changes may be altered with respect to collaborator changes. If there are no collaborators, the spreadsheet should reflect your changes.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Google Sheets API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/sheets
* // 2. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var sheets = google.sheets('v4');
*
* authorize(function(authClient) {
* var request = {
* // The spreadsheet to apply the updates to.
* spreadsheetId: 'my-spreadsheet-id', // TODO: Update placeholder value.
*
* resource: {
* // A list of updates to apply to the spreadsheet.
* // Requests will be applied in the order they are specified.
* // If any request is not valid, no requests will be applied.
* requests: [], // TODO: Update placeholder value.
*
* // TODO: Add desired properties to the request body.
* },
*
* auth: authClient,
* };
*
* sheets.spreadsheets.batchUpdate(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* // TODO: Change placeholder below to generate authentication credentials. See
* // https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample
* //
* // Authorize using one of the following scopes:
* // 'https://www.googleapis.com/auth/drive'
* // 'https://www.googleapis.com/auth/drive.file'
* // 'https://www.googleapis.com/auth/spreadsheets'
* var authClient = null;
*
* if (authClient == null) {
* console.log('authentication failed');
* return;
* }
* callback(authClient);
* }
* @alias sheets.spreadsheets.batchUpdate
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.spreadsheetId The spreadsheet to apply the updates to.
* @param {().BatchUpdateSpreadsheetRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
batchUpdate(params?: Params$Resource$Spreadsheets$Batchupdate, options?: MethodOptions): GaxiosPromise<Schema$BatchUpdateSpreadsheetResponse>;
batchUpdate(params: Params$Resource$Spreadsheets$Batchupdate, options: MethodOptions | BodyResponseCallback<Schema$BatchUpdateSpreadsheetResponse>, callback: BodyResponseCallback<Schema$BatchUpdateSpreadsheetResponse>): void;
batchUpdate(params: Params$Resource$Spreadsheets$Batchupdate, callback: BodyResponseCallback<Schema$BatchUpdateSpreadsheetResponse>): void;
batchUpdate(callback: BodyResponseCallback<Schema$BatchUpdateSpreadsheetResponse>): void;
/**
* sheets.spreadsheets.create
* @desc Creates a spreadsheet, returning the newly created spreadsheet.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Google Sheets API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/sheets
* // 2. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var sheets = google.sheets('v4');
*
* authorize(function(authClient) {
* var request = {
* resource: {
* // TODO: Add desired properties to the request body.
* },
*
* auth: authClient,
* };
*
* sheets.spreadsheets.create(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* // TODO: Change placeholder below to generate authentication credentials. See
* // https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample
* //
* // Authorize using one of the following scopes:
* // 'https://www.googleapis.com/auth/drive'
* // 'https://www.googleapis.com/auth/drive.file'
* // 'https://www.googleapis.com/auth/spreadsheets'
* var authClient = null;
*
* if (authClient == null) {
* console.log('authentication failed');
* return;
* }
* callback(authClient);
* }
* @alias sheets.spreadsheets.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {().Spreadsheet} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
create(params?: Params$Resource$Spreadsheets$Create, options?: MethodOptions): GaxiosPromise<Schema$Spreadsheet>;
create(params: Params$Resource$Spreadsheets$Create, options: MethodOptions | BodyResponseCallback<Schema$Spreadsheet>, callback: BodyResponseCallback<Schema$Spreadsheet>): void;
create(params: Params$Resource$Spreadsheets$Create, callback: BodyResponseCallback<Schema$Spreadsheet>): void;
create(callback: BodyResponseCallback<Schema$Spreadsheet>): void;
/**
* sheets.spreadsheets.get
* @desc Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. By default, data within grids will not be returned. You can include grid data one of two ways: * Specify a field mask listing your desired fields using the `fields` URL parameter in HTTP * Set the includeGridData URL parameter to true. If a field mask is set, the `includeGridData` parameter is ignored For large spreadsheets, it is recommended to retrieve only the specific fields of the spreadsheet that you want. To retrieve only subsets of the spreadsheet, use the ranges URL parameter. Multiple ranges can be specified. Limiting the range will return only the portions of the spreadsheet that intersect the requested ranges. Ranges are specified using A1 notation.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Google Sheets API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/sheets
* // 2. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var sheets = google.sheets('v4');
*
* authorize(function(authClient) {
* var request = {
* // The spreadsheet to request.
* spreadsheetId: 'my-spreadsheet-id', // TODO: Update placeholder value.
*
* // The ranges to retrieve from the spreadsheet.
* ranges: [], // TODO: Update placeholder value.
*
* // True if grid data should be returned.
* // This parameter is ignored if a field mask was set in the request.
* includeGridData: false, // TODO: Update placeholder value.
*
* auth: authClient,
* };
*
* sheets.spreadsheets.get(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* // TODO: Change placeholder below to generate authentication credentials. See
* // https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample
* //
* // Authorize using one of the following scopes:
* // 'https://www.googleapis.com/auth/drive'
* // 'https://www.googleapis.com/auth/drive.file'
* // 'https://www.googleapis.com/auth/drive.readonly'
* // 'https://www.googleapis.com/auth/spreadsheets'
* // 'https://www.googleapis.com/auth/spreadsheets.readonly'
* var authClient = null;
*
* if (authClient == null) {
* console.log('authentication failed');
* return;
* }
* callback(authClient);
* }
* @alias sheets.spreadsheets.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.includeGridData True if grid data should be returned. This parameter is ignored if a field mask was set in the request.
* @param {string=} params.ranges The ranges to retrieve from the spreadsheet.
* @param {string} params.spreadsheetId The spreadsheet to request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Spreadsheets$Get, options?: MethodOptions): GaxiosPromise<Schema$Spreadsheet>;
get(params: Params$Resource$Spreadsheets$Get, options: MethodOptions | BodyResponseCallback<Schema$Spreadsheet>, callback: BodyResponseCallback<Schema$Spreadsheet>): void;
get(params: Params$Resource$Spreadsheets$Get, callback: BodyResponseCallback<Schema$Spreadsheet>): void;
get(callback: BodyResponseCallback<Schema$Spreadsheet>): void;
/**
* sheets.spreadsheets.getByDataFilter
* @desc Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. This method differs from GetSpreadsheet in that it allows selecting which subsets of spreadsheet data to return by specifying a dataFilters parameter. Multiple DataFilters can be specified. Specifying one or more data filters will return the portions of the spreadsheet that intersect ranges matched by any of the filters. By default, data within grids will not be returned. You can include grid data one of two ways: * Specify a field mask listing your desired fields using the `fields` URL parameter in HTTP * Set the includeGridData parameter to true. If a field mask is set, the `includeGridData` parameter is ignored For large spreadsheets, it is recommended to retrieve only the specific fields of the spreadsheet that you want.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Google Sheets API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/sheets
* // 2. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var sheets = google.sheets('v4');
*
* authorize(function(authClient) {
* var request = {
* // The spreadsheet to request.
* spreadsheetId: 'my-spreadsheet-id', // TODO: Update placeholder value.
*
* resource: {
* // The DataFilters used to select which ranges to retrieve from
* // the spreadsheet.
* dataFilters: [], // TODO: Update placeholder value.
*
* // True if grid data should be returned.
* // This parameter is ignored if a field mask was set in the request.
* includeGridData: false, // TODO: Update placeholder value.
*
* // TODO: Add desired properties to the request body.
* },
*
* auth: authClient,
* };
*
* sheets.spreadsheets.getByDataFilter(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* // TODO: Change placeholder below to generate authentication credentials. See
* // https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample
* //
* // Authorize using one of the following scopes:
* // 'https://www.googleapis.com/auth/drive'
* // 'https://www.googleapis.com/auth/drive.file'
* // 'https://www.googleapis.com/auth/spreadsheets'
* var authClient = null;
*
* if (authClient == null) {
* console.log('authentication failed');
* return;
* }
* callback(authClient);
* }
* @alias sheets.spreadsheets.getByDataFilter
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.spreadsheetId The spreadsheet to request.
* @param {().GetSpreadsheetByDataFilterRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
getByDataFilter(params?: Params$Resource$Spreadsheets$Getbydatafilter, options?: MethodOptions): GaxiosPromise<Schema$Spreadsheet>;
getByDataFilter(params: Params$Resource$Spreadsheets$Getbydatafilter, options: MethodOptions | BodyResponseCallback<Schema$Spreadsheet>, callback: BodyResponseCallback<Schema$Spreadsheet>): void;
getByDataFilter(params: Params$Resource$Spreadsheets$Getbydatafilter, callback: BodyResponseCallback<Schema$Spreadsheet>): void;
getByDataFilter(callback: BodyResponseCallback<Schema$Spreadsheet>): void;
}
export interface Params$Resource$Spreadsheets$Batchupdate extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The spreadsheet to apply the updates to.
*/
spreadsheetId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$BatchUpdateSpreadsheetRequest;
}
export interface Params$Resource$Spreadsheets$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Request body metadata
*/
requestBody?: Schema$Spreadsheet;
}
export interface Params$Resource$Spreadsheets$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* True if grid data should be returned. This parameter is ignored if a field mask was set in the request.
*/
includeGridData?: boolean;
/**
* The ranges to retrieve from the spreadsheet.
*/
ranges?: string[];
/**
* The spreadsheet to request.
*/
spreadsheetId?: string;
}
export interface Params$Resource$Spreadsheets$Getbydatafilter extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The spreadsheet to request.
*/
spreadsheetId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GetSpreadsheetByDataFilterRequest;
}
export class Resource$Spreadsheets$Developermetadata {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* sheets.spreadsheets.developerMetadata.get
* @desc Returns the developer metadata with the specified ID. The caller must specify the spreadsheet ID and the developer metadata's unique metadataId.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Google Sheets API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/sheets
* // 2. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var sheets = google.sheets('v4');
*
* authorize(function(authClient) {
* var request = {
* // The ID of the spreadsheet to retrieve metadata from.
* spreadsheetId: 'my-spreadsheet-id', // TODO: Update placeholder value.
*
* // The ID of the developer metadata to retrieve.
* metadataId: 0, // TODO: Update placeholder value.
*
* auth: authClient,
* };
*
* sheets.spreadsheets.developerMetadata.get(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* // TODO: Change placeholder below to generate authentication credentials. See
* // https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample
* //
* // Authorize using one of the following scopes:
* // 'https://www.googleapis.com/auth/drive'
* // 'https://www.googleapis.com/auth/drive.file'
* // 'https://www.googleapis.com/auth/spreadsheets'
* var authClient = null;
*
* if (authClient == null) {
* console.log('authentication failed');
* return;
* }
* callback(authClient);
* }
* @alias sheets.spreadsheets.developerMetadata.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer} params.metadataId The ID of the developer metadata to retrieve.
* @param {string} params.spreadsheetId The ID of the spreadsheet to retrieve metadata from.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Spreadsheets$Developermetadata$Get, options?: MethodOptions): GaxiosPromise<Schema$DeveloperMetadata>;
get(params: Params$Resource$Spreadsheets$Developermetadata$Get, options: MethodOptions | BodyResponseCallback<Schema$DeveloperMetadata>, callback: BodyResponseCallback<Schema$DeveloperMetadata>): void;
get(params: Params$Resource$Spreadsheets$Developermetadata$Get, callback: BodyResponseCallback<Schema$DeveloperMetadata>): void;
get(callback: BodyResponseCallback<Schema$DeveloperMetadata>): void;
/**
* sheets.spreadsheets.developerMetadata.search
* @desc Returns all developer metadata matching the specified DataFilter. If the provided DataFilter represents a DeveloperMetadataLookup object, this will return all DeveloperMetadata entries selected by it. If the DataFilter represents a location in a spreadsheet, this will return all developer metadata associated with locations intersecting that region.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Google Sheets API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/sheets
* // 2. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var sheets = google.sheets('v4');
*
* authorize(function(authClient) {
* var request = {
* // The ID of the spreadsheet to retrieve metadata from.
* spreadsheetId: 'my-spreadsheet-id', // TODO: Update placeholder value.
*
* resource: {
* // TODO: Add desired properties to the request body.
* },
*
* auth: authClient,
* };
*
* sheets.spreadsheets.developerMetadata.search(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* // TODO: Change placeholder below to generate authentication credentials. See
* // https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample
* //
* // Authorize using one of the following scopes:
* // 'https://www.googleapis.com/auth/drive'
* // 'https://www.googleapis.com/auth/drive.file'
* // 'https://www.googleapis.com/auth/spreadsheets'
* var authClient = null;
*
* if (authClient == null) {
* console.log('authentication failed');
* return;
* }
* callback(authClient);
* }
* @alias sheets.spreadsheets.developerMetadata.search
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.spreadsheetId The ID of the spreadsheet to retrieve metadata from.
* @param {().SearchDeveloperMetadataRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
search(params?: Params$Resource$Spreadsheets$Developermetadata$Search, options?: MethodOptions): GaxiosPromise<Schema$SearchDeveloperMetadataResponse>;
search(params: Params$Resource$Spreadsheets$Developermetadata$Search, options: MethodOptions | BodyResponseCallback<Schema$SearchDeveloperMetadataResponse>, callback: BodyResponseCallback<Schema$SearchDeveloperMetadataResponse>): void;
search(params: Params$Resource$Spreadsheets$Developermetadata$Search, callback: BodyResponseCallback<Schema$SearchDeveloperMetadataResponse>): void;
search(callback: BodyResponseCallback<Schema$SearchDeveloperMetadataResponse>): void;
}
export interface Params$Resource$Spreadsheets$Developermetadata$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the developer metadata to retrieve.
*/
metadataId?: number;
/**
* The ID of the spreadsheet to retrieve metadata from.
*/
spreadsheetId?: string;
}
export interface Params$Resource$Spreadsheets$Developermetadata$Search extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the spreadsheet to retrieve metadata from.
*/
spreadsheetId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$SearchDeveloperMetadataRequest;
}
export class Resource$Spreadsheets$Sheets {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* sheets.spreadsheets.sheets.copyTo
* @desc Copies a single sheet from a spreadsheet to another spreadsheet. Returns the properties of the newly created sheet.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Google Sheets API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/sheets
* // 2. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var sheets = google.sheets('v4');
*
* authorize(function(authClient) {
* var request = {
* // The ID of the spreadsheet containing the sheet to copy.
* spreadsheetId: 'my-spreadsheet-id', // TODO: Update placeholder value.
*
* // The ID of the sheet to copy.
* sheetId: 0, // TODO: Update placeholder value.
*
* resource: {
* // The ID of the spreadsheet to copy the sheet to.
* destinationSpreadsheetId: '', // TODO: Update placeholder value.
*
* // TODO: Add desired properties to the request body.
* },
*
* auth: authClient,
* };
*
* sheets.spreadsheets.sheets.copyTo(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* // TODO: Change placeholder below to generate authentication credentials. See
* // https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample
* //
* // Authorize using one of the following scopes:
* // 'https://www.googleapis.com/auth/drive'
* // 'https://www.googleapis.com/auth/drive.file'
* // 'https://www.googleapis.com/auth/spreadsheets'
* var authClient = null;
*
* if (authClient == null) {
* console.log('authentication failed');
* return;
* }
* callback(authClient);
* }
* @alias sheets.spreadsheets.sheets.copyTo
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer} params.sheetId The ID of the sheet to copy.
* @param {string} params.spreadsheetId The ID of the spreadsheet containing the sheet to copy.
* @param {().CopySheetToAnotherSpreadsheetRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
copyTo(params?: Params$Resource$Spreadsheets$Sheets$Copyto, options?: MethodOptions): GaxiosPromise<Schema$SheetProperties>;
copyTo(params: Params$Resource$Spreadsheets$Sheets$Copyto, options: MethodOptions | BodyResponseCallback<Schema$SheetProperties>, callback: BodyResponseCallback<Schema$SheetProperties>): void;
copyTo(params: Params$Resource$Spreadsheets$Sheets$Copyto, callback: BodyResponseCallback<Schema$SheetProperties>): void;
copyTo(callback: BodyResponseCallback<Schema$SheetProperties>): void;
}
export interface Params$Resource$Spreadsheets$Sheets$Copyto extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the sheet to copy.
*/
sheetId?: number;
/**
* The ID of the spreadsheet containing the sheet to copy.
*/
spreadsheetId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CopySheetToAnotherSpreadsheetRequest;
}
export class Resource$Spreadsheets$Values {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* sheets.spreadsheets.values.append
* @desc Appends values to a spreadsheet. The input range is used to search for existing data and find a "table" within that range. Values will be appended to the next row of the table, starting with the first column of the table. See the [guide](/sheets/api/guides/values#appending_values) and [sample code](/sheets/api/samples/writing#append_values) for specific details of how tables are detected and data is appended. The caller must specify the spreadsheet ID, range, and a valueInputOption. The `valueInputOption` only controls how the input data will be added to the sheet (column-wise or row-wise), it does not influence what cell the data starts being written to.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Google Sheets API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/sheets
* // 2. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var sheets = google.sheets('v4');
*
* authorize(function(authClient) {
* var request = {
* // The ID of the spreadsheet to update.
* spreadsheetId: 'my-spreadsheet-id', // TODO: Update placeholder value.
*
* // The A1 notation of a range to search for a logical table of data.
* // Values will be appended after the last row of the table.
* range: 'my-range', // TODO: Update placeholder value.
*
* // How the input data should be interpreted.
* valueInputOption: '', // TODO: Update placeholder value.
*
* // How the input data should be inserted.
* insertDataOption: '', // TODO: Update placeholder value.
*
* resource: {
* // TODO: Add desired properties to the request body.
* },
*
* auth: authClient,
* };
*
* sheets.spreadsheets.values.append(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* // TODO: Change placeholder below to generate authentication credentials. See
* // https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample
* //
* // Authorize using one of the following scopes:
* // 'https://www.googleapis.com/auth/drive'
* // 'https://www.googleapis.com/auth/drive.file'
* // 'https://www.googleapis.com/auth/spreadsheets'
* var authClient = null;
*
* if (authClient == null) {
* console.log('authentication failed');
* return;
* }
* callback(authClient);
* }
* @alias sheets.spreadsheets.values.append
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.includeValuesInResponse Determines if the update response should include the values of the cells that were appended. By default, responses do not include the updated values.
* @param {string=} params.insertDataOption How the input data should be inserted.
* @param {string} params.range The A1 notation of a range to search for a logical table of data. Values will be appended after the last row of the table.
* @param {string=} params.responseDateTimeRenderOption Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].
* @param {string=} params.responseValueRenderOption Determines how values in the response should be rendered. The default render option is ValueRenderOption.FORMATTED_VALUE.
* @param {string} params.spreadsheetId The ID of the spreadsheet to update.
* @param {string=} params.valueInputOption How the input data should be interpreted.
* @param {().ValueRange} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
append(params?: Params$Resource$Spreadsheets$Values$Append, options?: MethodOptions): GaxiosPromise<Schema$AppendValuesResponse>;
append(params: Params$Resource$Spreadsheets$Values$Append, options: MethodOptions | BodyResponseCallback<Schema$AppendValuesResponse>, callback: BodyResponseCallback<Schema$AppendValuesResponse>): void;
append(params: Params$Resource$Spreadsheets$Values$Append, callback: BodyResponseCallback<Schema$AppendValuesResponse>): void;
append(callback: BodyResponseCallback<Schema$AppendValuesResponse>): void;
/**
* sheets.spreadsheets.values.batchClear
* @desc Clears one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges. Only values are cleared -- all other properties of the cell (such as formatting, data validation, etc..) are kept.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Google Sheets API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/sheets
* // 2. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var sheets = google.sheets('v4');
*
* authorize(function(authClient) {
* var request = {
* // The ID of the spreadsheet to update.
* spreadsheetId: 'my-spreadsheet-id', // TODO: Update placeholder value.
*
* resource: {
* // The ranges to clear, in A1 notation.
* ranges: [], // TODO: Update placeholder value.
*
* // TODO: Add desired properties to the request body.
* },
*
* auth: authClient,
* };
*
* sheets.spreadsheets.values.batchClear(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* // TODO: Change placeholder below to generate authentication credentials. See
* // https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample
* //
* // Authorize using one of the following scopes:
* // 'https://www.googleapis.com/auth/drive'
* // 'https://www.googleapis.com/auth/drive.file'
* // 'https://www.googleapis.com/auth/spreadsheets'
* var authClient = null;
*
* if (authClient == null) {
* console.log('authentication failed');
* return;
* }
* callback(authClient);
* }
* @alias sheets.spreadsheets.values.batchClear
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.spreadsheetId The ID of the spreadsheet to update.
* @param {().BatchClearValuesRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
batchClear(params?: Params$Resource$Spreadsheets$Values$Batchclear, options?: MethodOptions): GaxiosPromise<Schema$BatchClearValuesResponse>;
batchClear(params: Params$Resource$Spreadsheets$Values$Batchclear, options: MethodOptions | BodyResponseCallback<Schema$BatchClearValuesResponse>, callback: BodyResponseCallback<Schema$BatchClearValuesResponse>): void;
batchClear(params: Params$Resource$Spreadsheets$Values$Batchclear, callback: BodyResponseCallback<Schema$BatchClearValuesResponse>): void;
batchClear(callback: BodyResponseCallback<Schema$BatchClearValuesResponse>): void;
/**
* sheets.spreadsheets.values.batchClearByDataFilter
* @desc Clears one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more DataFilters. Ranges matching any of the specified data filters will be cleared. Only values are cleared -- all other properties of the cell (such as formatting, data validation, etc..) are kept.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Google Sheets API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/sheets
* // 2. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var sheets = google.sheets('v4');
*
* authorize(function(authClient) {
* var request = {
* // The ID of the spreadsheet to update.
* spreadsheetId: 'my-spreadsheet-id', // TODO: Update placeholder value.
*
* resource: {
* // The DataFilters used to determine which ranges to clear.
* dataFilters: [], // TODO: Update placeholder value.
*
* // TODO: Add desired properties to the request body.
* },
*
* auth: authClient,
* };
*
* sheets.spreadsheets.values.batchClearByDataFilter(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* // TODO: Change placeholder below to generate authentication credentials. See
* // https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample
* //
* // Authorize using one of the following scopes:
* // 'https://www.googleapis.com/auth/drive'
* // 'https://www.googleapis.com/auth/drive.file'
* // 'https://www.googleapis.com/auth/spreadsheets'
* var authClient = null;
*
* if (authClient == null) {
* console.log('authentication failed');
* return;
* }
* callback(authClient);
* }
* @alias sheets.spreadsheets.values.batchClearByDataFilter
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.spreadsheetId The ID of the spreadsheet to update.
* @param {().BatchClearValuesByDataFilterRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
batchClearByDataFilter(params?: Params$Resource$Spreadsheets$Values$Batchclearbydatafilter, options?: MethodOptions): GaxiosPromise<Schema$BatchClearValuesByDataFilterResponse>;
batchClearByDataFilter(params: Params$Resource$Spreadsheets$Values$Batchclearbydatafilter, options: MethodOptions | BodyResponseCallback<Schema$BatchClearValuesByDataFilterResponse>, callback: BodyResponseCallback<Schema$BatchClearValuesByDataFilterResponse>): void;
batchClearByDataFilter(params: Params$Resource$Spreadsheets$Values$Batchclearbydatafilter, callback: BodyResponseCallback<Schema$BatchClearValuesByDataFilterResponse>): void;
batchClearByDataFilter(callback: BodyResponseCallback<Schema$BatchClearValuesByDataFilterResponse>): void;
/**
* sheets.spreadsheets.values.batchGet
* @desc Returns one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Google Sheets API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/sheets
* // 2. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var sheets = google.sheets('v4');
*
* authorize(function(authClient) {
* var request = {
* // The ID of the spreadsheet to retrieve data from.
* spreadsheetId: 'my-spreadsheet-id', // TODO: Update placeholder value.
*
* // The A1 notation of the values to retrieve.
* ranges: [], // TODO: Update placeholder value.
*
* // How values should be represented in the output.
* // The default render option is ValueRenderOption.FORMATTED_VALUE.
* valueRenderOption: '', // TODO: Update placeholder value.
*
* // How dates, times, and durations should be represented in the output.
* // This is ignored if value_render_option is
* // FORMATTED_VALUE.
* // The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].
* dateTimeRenderOption: '', // TODO: Update placeholder value.
*
* auth: authClient,
* };
*
* sheets.spreadsheets.values.batchGet(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* // TODO: Change placeholder below to generate authentication credentials. See
* // https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample
* //
* // Authorize using one of the following scopes:
* // 'https://www.googleapis.com/auth/drive'
* // 'https://www.googleapis.com/auth/drive.file'
* // 'https://www.googleapis.com/auth/drive.readonly'
* // 'https://www.googleapis.com/auth/spreadsheets'
* // 'https://www.googleapis.com/auth/spreadsheets.readonly'
* var authClient = null;
*
* if (authClient == null) {
* console.log('authentication failed');
* return;
* }
* callback(authClient);
* }
* @alias sheets.spreadsheets.values.batchGet
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.dateTimeRenderOption How dates, times, and durations should be represented in the output. This is ignored if value_render_option is FORMATTED_VALUE. The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].
* @param {string=} params.majorDimension The major dimension that results should use. For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension=ROWS` will return `[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return `[[1,3],[2,4]]`.
* @param {string=} params.ranges The A1 notation of the values to retrieve.
* @param {string} params.spreadsheetId The ID of the spreadsheet to retrieve data from.
* @param {string=} params.valueRenderOption How values should be represented in the output. The default render option is ValueRenderOption.FORMATTED_VALUE.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
batchGet(params?: Params$Resource$Spreadsheets$Values$Batchget, options?: MethodOptions): GaxiosPromise<Schema$BatchGetValuesResponse>;
batchGet(params: Params$Resource$Spreadsheets$Values$Batchget, options: MethodOptions | BodyResponseCallback<Schema$BatchGetValuesResponse>, callback: BodyResponseCallback<Schema$BatchGetValuesResponse>): void;
batchGet(params: Params$Resource$Spreadsheets$Values$Batchget, callback: BodyResponseCallback<Schema$BatchGetValuesResponse>): void;
batchGet(callback: BodyResponseCallback<Schema$BatchGetValuesResponse>): void;
/**
* sheets.spreadsheets.values.batchGetByDataFilter
* @desc Returns one or more ranges of values that match the specified data filters. The caller must specify the spreadsheet ID and one or more DataFilters. Ranges that match any of the data filters in the request will be returned.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Google Sheets API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/sheets
* // 2. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var sheets = google.sheets('v4');
*
* authorize(function(authClient) {
* var request = {
* // The ID of the spreadsheet to retrieve data from.
* spreadsheetId: 'my-spreadsheet-id', // TODO: Update placeholder value.
*
* resource: {
* // How values should be represented in the output.
* // The default render option is ValueRenderOption.FORMATTED_VALUE.
* valueRenderOption: '', // TODO: Update placeholder value.
*
* // The data filters used to match the ranges of values to retrieve. Ranges
* // that match any of the specified data filters will be included in the
* // response.
* dataFilters: [], // TODO: Update placeholder value.
*
* // How dates, times, and durations should be represented in the output.
* // This is ignored if value_render_option is
* // FORMATTED_VALUE.
* // The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].
* dateTimeRenderOption: '', // TODO: Update placeholder value.
*
* // TODO: Add desired properties to the request body.
* },
*
* auth: authClient,
* };
*
* sheets.spreadsheets.values.batchGetByDataFilter(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* // TODO: Change placeholder below to generate authentication credentials. See
* // https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample
* //
* // Authorize using one of the following scopes:
* // 'https://www.googleapis.com/auth/drive'
* // 'https://www.googleapis.com/auth/drive.file'
* // 'https://www.googleapis.com/auth/spreadsheets'
* var authClient = null;
*
* if (authClient == null) {
* console.log('authentication failed');
* return;
* }
* callback(authClient);
* }
* @alias sheets.spreadsheets.values.batchGetByDataFilter
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.spreadsheetId The ID of the spreadsheet to retrieve data from.
* @param {().BatchGetValuesByDataFilterRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
batchGetByDataFilter(params?: Params$Resource$Spreadsheets$Values$Batchgetbydatafilter, options?: MethodOptions): GaxiosPromise<Schema$BatchGetValuesByDataFilterResponse>;
batchGetByDataFilter(params: Params$Resource$Spreadsheets$Values$Batchgetbydatafilter, options: MethodOptions | BodyResponseCallback<Schema$BatchGetValuesByDataFilterResponse>, callback: BodyResponseCallback<Schema$BatchGetValuesByDataFilterResponse>): void;
batchGetByDataFilter(params: Params$Resource$Spreadsheets$Values$Batchgetbydatafilter, callback: BodyResponseCallback<Schema$BatchGetValuesByDataFilterResponse>): void;
batchGetByDataFilter(callback: BodyResponseCallback<Schema$BatchGetValuesByDataFilterResponse>): void;
/**
* sheets.spreadsheets.values.batchUpdate
* @desc Sets values in one or more ranges of a spreadsheet. The caller must specify the spreadsheet ID, a valueInputOption, and one or more ValueRanges.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Google Sheets API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/sheets
* // 2. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var sheets = google.sheets('v4');
*
* authorize(function(authClient) {
* var request = {
* // The ID of the spreadsheet to update.
* spreadsheetId: 'my-spreadsheet-id', // TODO: Update placeholder value.
*
* resource: {
* // How the input data should be interpreted.
* valueInputOption: '', // TODO: Update placeholder value.
*
* // The new values to apply to the spreadsheet.
* data: [], // TODO: Update placeholder value.
*
* // TODO: Add desired properties to the request body.
* },
*
* auth: authClient,
* };
*
* sheets.spreadsheets.values.batchUpdate(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* // TODO: Change placeholder below to generate authentication credentials. See
* // https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample
* //
* // Authorize using one of the following scopes:
* // 'https://www.googleapis.com/auth/drive'
* // 'https://www.googleapis.com/auth/drive.file'
* // 'https://www.googleapis.com/auth/spreadsheets'
* var authClient = null;
*
* if (authClient == null) {
* console.log('authentication failed');
* return;
* }
* callback(authClient);
* }
* @alias sheets.spreadsheets.values.batchUpdate
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.spreadsheetId The ID of the spreadsheet to update.
* @param {().BatchUpdateValuesRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
batchUpdate(params?: Params$Resource$Spreadsheets$Values$Batchupdate, options?: MethodOptions): GaxiosPromise<Schema$BatchUpdateValuesResponse>;
batchUpdate(params: Params$Resource$Spreadsheets$Values$Batchupdate, options: MethodOptions | BodyResponseCallback<Schema$BatchUpdateValuesResponse>, callback: BodyResponseCallback<Schema$BatchUpdateValuesResponse>): void;
batchUpdate(params: Params$Resource$Spreadsheets$Values$Batchupdate, callback: BodyResponseCallback<Schema$BatchUpdateValuesResponse>): void;
batchUpdate(callback: BodyResponseCallback<Schema$BatchUpdateValuesResponse>): void;
/**
* sheets.spreadsheets.values.batchUpdateByDataFilter
* @desc Sets values in one or more ranges of a spreadsheet. The caller must specify the spreadsheet ID, a valueInputOption, and one or more DataFilterValueRanges.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Google Sheets API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/sheets
* // 2. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var sheets = google.sheets('v4');
*
* authorize(function(authClient) {
* var request = {
* // The ID of the spreadsheet to update.
* spreadsheetId: 'my-spreadsheet-id', // TODO: Update placeholder value.
*
* resource: {
* // How the input data should be interpreted.
* valueInputOption: '', // TODO: Update placeholder value.
*
* // The new values to apply to the spreadsheet. If more than one range is
* // matched by the specified DataFilter the specified values will be
* // applied to all of those ranges.
* data: [], // TODO: Update placeholder value.
*
* // TODO: Add desired properties to the request body.
* },
*
* auth: authClient,
* };
*
* sheets.spreadsheets.values.batchUpdateByDataFilter(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* // TODO: Change placeholder below to generate authentication credentials. See
* // https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample
* //
* // Authorize using one of the following scopes:
* // 'https://www.googleapis.com/auth/drive'
* // 'https://www.googleapis.com/auth/drive.file'
* // 'https://www.googleapis.com/auth/spreadsheets'
* var authClient = null;
*
* if (authClient == null) {
* console.log('authentication failed');
* return;
* }
* callback(authClient);
* }
* @alias sheets.spreadsheets.values.batchUpdateByDataFilter
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.spreadsheetId The ID of the spreadsheet to update.
* @param {().BatchUpdateValuesByDataFilterRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
batchUpdateByDataFilter(params?: Params$Resource$Spreadsheets$Values$Batchupdatebydatafilter, options?: MethodOptions): GaxiosPromise<Schema$BatchUpdateValuesByDataFilterResponse>;
batchUpdateByDataFilter(params: Params$Resource$Spreadsheets$Values$Batchupdatebydatafilter, options: MethodOptions | BodyResponseCallback<Schema$BatchUpdateValuesByDataFilterResponse>, callback: BodyResponseCallback<Schema$BatchUpdateValuesByDataFilterResponse>): void;
batchUpdateByDataFilter(params: Params$Resource$Spreadsheets$Values$Batchupdatebydatafilter, callback: BodyResponseCallback<Schema$BatchUpdateValuesByDataFilterResponse>): void;
batchUpdateByDataFilter(callback: BodyResponseCallback<Schema$BatchUpdateValuesByDataFilterResponse>): void;
/**
* sheets.spreadsheets.values.clear
* @desc Clears values from a spreadsheet. The caller must specify the spreadsheet ID and range. Only values are cleared -- all other properties of the cell (such as formatting, data validation, etc..) are kept.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Google Sheets API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/sheets
* // 2. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var sheets = google.sheets('v4');
*
* authorize(function(authClient) {
* var request = {
* // The ID of the spreadsheet to update.
* spreadsheetId: 'my-spreadsheet-id', // TODO: Update placeholder value.
*
* // The A1 notation of the values to clear.
* range: 'my-range', // TODO: Update placeholder value.
*
* resource: {
* // TODO: Add desired properties to the request body.
* },
*
* auth: authClient,
* };
*
* sheets.spreadsheets.values.clear(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* // TODO: Change placeholder below to generate authentication credentials. See
* // https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample
* //
* // Authorize using one of the following scopes:
* // 'https://www.googleapis.com/auth/drive'
* // 'https://www.googleapis.com/auth/drive.file'
* // 'https://www.googleapis.com/auth/spreadsheets'
* var authClient = null;
*
* if (authClient == null) {
* console.log('authentication failed');
* return;
* }
* callback(authClient);
* }
* @alias sheets.spreadsheets.values.clear
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.range The A1 notation of the values to clear.
* @param {string} params.spreadsheetId The ID of the spreadsheet to update.
* @param {().ClearValuesRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
clear(params?: Params$Resource$Spreadsheets$Values$Clear, options?: MethodOptions): GaxiosPromise<Schema$ClearValuesResponse>;
clear(params: Params$Resource$Spreadsheets$Values$Clear, options: MethodOptions | BodyResponseCallback<Schema$ClearValuesResponse>, callback: BodyResponseCallback<Schema$ClearValuesResponse>): void;
clear(params: Params$Resource$Spreadsheets$Values$Clear, callback: BodyResponseCallback<Schema$ClearValuesResponse>): void;
clear(callback: BodyResponseCallback<Schema$ClearValuesResponse>): void;
/**
* sheets.spreadsheets.values.get
* @desc Returns a range of values from a spreadsheet. The caller must specify the spreadsheet ID and a range.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Google Sheets API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/sheets
* // 2. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var sheets = google.sheets('v4');
*
* authorize(function(authClient) {
* var request = {
* // The ID of the spreadsheet to retrieve data from.
* spreadsheetId: 'my-spreadsheet-id', // TODO: Update placeholder value.
*
* // The A1 notation of the values to retrieve.
* range: 'my-range', // TODO: Update placeholder value.
*
* // How values should be represented in the output.
* // The default render option is ValueRenderOption.FORMATTED_VALUE.
* valueRenderOption: '', // TODO: Update placeholder value.
*
* // How dates, times, and durations should be represented in the output.
* // This is ignored if value_render_option is
* // FORMATTED_VALUE.
* // The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].
* dateTimeRenderOption: '', // TODO: Update placeholder value.
*
* auth: authClient,
* };
*
* sheets.spreadsheets.values.get(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* // TODO: Change placeholder below to generate authentication credentials. See
* // https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample
* //
* // Authorize using one of the following scopes:
* // 'https://www.googleapis.com/auth/drive'
* // 'https://www.googleapis.com/auth/drive.file'
* // 'https://www.googleapis.com/auth/drive.readonly'
* // 'https://www.googleapis.com/auth/spreadsheets'
* // 'https://www.googleapis.com/auth/spreadsheets.readonly'
* var authClient = null;
*
* if (authClient == null) {
* console.log('authentication failed');
* return;
* }
* callback(authClient);
* }
* @alias sheets.spreadsheets.values.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.dateTimeRenderOption How dates, times, and durations should be represented in the output. This is ignored if value_render_option is FORMATTED_VALUE. The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].
* @param {string=} params.majorDimension The major dimension that results should use. For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension=ROWS` will return `[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return `[[1,3],[2,4]]`.
* @param {string} params.range The A1 notation of the values to retrieve.
* @param {string} params.spreadsheetId The ID of the spreadsheet to retrieve data from.
* @param {string=} params.valueRenderOption How values should be represented in the output. The default render option is ValueRenderOption.FORMATTED_VALUE.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Spreadsheets$Values$Get, options?: MethodOptions): GaxiosPromise<Schema$ValueRange>;
get(params: Params$Resource$Spreadsheets$Values$Get, options: MethodOptions | BodyResponseCallback<Schema$ValueRange>, callback: BodyResponseCallback<Schema$ValueRange>): void;
get(params: Params$Resource$Spreadsheets$Values$Get, callback: BodyResponseCallback<Schema$ValueRange>): void;
get(callback: BodyResponseCallback<Schema$ValueRange>): void;
/**
* sheets.spreadsheets.values.update
* @desc Sets values in a range of a spreadsheet. The caller must specify the spreadsheet ID, range, and a valueInputOption.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Google Sheets API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/sheets
* // 2. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* const {google} = require('googleapis');
* var sheets = google.sheets('v4');
*
* authorize(function(authClient) {
* var request = {
* // The ID of the spreadsheet to update.
* spreadsheetId: 'my-spreadsheet-id', // TODO: Update placeholder value.
*
* // The A1 notation of the values to update.
* range: 'my-range', // TODO: Update placeholder value.
*
* // How the input data should be interpreted.
* valueInputOption: '', // TODO: Update placeholder value.
*
* resource: {
* // TODO: Add desired properties to the request body. All existing properties
* // will be replaced.
* },
*
* auth: authClient,
* };
*
* sheets.spreadsheets.values.update(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* // TODO: Change placeholder below to generate authentication credentials. See
* // https://developers.google.com/sheets/quickstart/nodejs#step_3_set_up_the_sample
* //
* // Authorize using one of the following scopes:
* // 'https://www.googleapis.com/auth/drive'
* // 'https://www.googleapis.com/auth/drive.file'
* // 'https://www.googleapis.com/auth/spreadsheets'
* var authClient = null;
*
* if (authClient == null) {
* console.log('authentication failed');
* return;
* }
* callback(authClient);
* }
* @alias sheets.spreadsheets.values.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.includeValuesInResponse Determines if the update response should include the values of the cells that were updated. By default, responses do not include the updated values. If the range to write was larger than than the range actually written, the response will include all values in the requested range (excluding trailing empty rows and columns).
* @param {string} params.range The A1 notation of the values to update.
* @param {string=} params.responseDateTimeRenderOption Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is DateTimeRenderOption.SERIAL_NUMBER.
* @param {string=} params.responseValueRenderOption Determines how values in the response should be rendered. The default render option is ValueRenderOption.FORMATTED_VALUE.
* @param {string} params.spreadsheetId The ID of the spreadsheet to update.
* @param {string=} params.valueInputOption How the input data should be interpreted.
* @param {().ValueRange} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update(params?: Params$Resource$Spreadsheets$Values$Update, options?: MethodOptions): GaxiosPromise<Schema$UpdateValuesResponse>;
update(params: Params$Resource$Spreadsheets$Values$Update, options: MethodOptions | BodyResponseCallback<Schema$UpdateValuesResponse>, callback: BodyResponseCallback<Schema$UpdateValuesResponse>): void;
update(params: Params$Resource$Spreadsheets$Values$Update, callback: BodyResponseCallback<Schema$UpdateValuesResponse>): void;
update(callback: BodyResponseCallback<Schema$UpdateValuesResponse>): void;
}
export interface Params$Resource$Spreadsheets$Values$Append extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Determines if the update response should include the values of the cells that were appended. By default, responses do not include the updated values.
*/
includeValuesInResponse?: boolean;
/**
* How the input data should be inserted.
*/
insertDataOption?: string;
/**
* The A1 notation of a range to search for a logical table of data. Values will be appended after the last row of the table.
*/
range?: string;
/**
* Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].
*/
responseDateTimeRenderOption?: string;
/**
* Determines how values in the response should be rendered. The default render option is ValueRenderOption.FORMATTED_VALUE.
*/
responseValueRenderOption?: string;
/**
* The ID of the spreadsheet to update.
*/
spreadsheetId?: string;
/**
* How the input data should be interpreted.
*/
valueInputOption?: string;
/**
* Request body metadata
*/
requestBody?: Schema$ValueRange;
}
export interface Params$Resource$Spreadsheets$Values$Batchclear extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the spreadsheet to update.
*/
spreadsheetId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$BatchClearValuesRequest;
}
export interface Params$Resource$Spreadsheets$Values$Batchclearbydatafilter extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the spreadsheet to update.
*/
spreadsheetId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$BatchClearValuesByDataFilterRequest;
}
export interface Params$Resource$Spreadsheets$Values$Batchget extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* How dates, times, and durations should be represented in the output. This is ignored if value_render_option is FORMATTED_VALUE. The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].
*/
dateTimeRenderOption?: string;
/**
* The major dimension that results should use. For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension=ROWS` will return `[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return `[[1,3],[2,4]]`.
*/
majorDimension?: string;
/**
* The A1 notation of the values to retrieve.
*/
ranges?: string[];
/**
* The ID of the spreadsheet to retrieve data from.
*/
spreadsheetId?: string;
/**
* How values should be represented in the output. The default render option is ValueRenderOption.FORMATTED_VALUE.
*/
valueRenderOption?: string;
}
export interface Params$Resource$Spreadsheets$Values$Batchgetbydatafilter extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the spreadsheet to retrieve data from.
*/
spreadsheetId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$BatchGetValuesByDataFilterRequest;
}
export interface Params$Resource$Spreadsheets$Values$Batchupdate extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the spreadsheet to update.
*/
spreadsheetId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$BatchUpdateValuesRequest;
}
export interface Params$Resource$Spreadsheets$Values$Batchupdatebydatafilter extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the spreadsheet to update.
*/
spreadsheetId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$BatchUpdateValuesByDataFilterRequest;
}
export interface Params$Resource$Spreadsheets$Values$Clear extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The A1 notation of the values to clear.
*/
range?: string;
/**
* The ID of the spreadsheet to update.
*/
spreadsheetId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$ClearValuesRequest;
}
export interface Params$Resource$Spreadsheets$Values$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* How dates, times, and durations should be represented in the output. This is ignored if value_render_option is FORMATTED_VALUE. The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].
*/
dateTimeRenderOption?: string;
/**
* The major dimension that results should use. For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension=ROWS` will return `[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return `[[1,3],[2,4]]`.
*/
majorDimension?: string;
/**
* The A1 notation of the values to retrieve.
*/
range?: string;
/**
* The ID of the spreadsheet to retrieve data from.
*/
spreadsheetId?: string;
/**
* How values should be represented in the output. The default render option is ValueRenderOption.FORMATTED_VALUE.
*/
valueRenderOption?: string;
}
export interface Params$Resource$Spreadsheets$Values$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Determines if the update response should include the values of the cells that were updated. By default, responses do not include the updated values. If the range to write was larger than than the range actually written, the response will include all values in the requested range (excluding trailing empty rows and columns).
*/
includeValuesInResponse?: boolean;
/**
* The A1 notation of the values to update.
*/
range?: string;
/**
* Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is DateTimeRenderOption.SERIAL_NUMBER.
*/
responseDateTimeRenderOption?: string;
/**
* Determines how values in the response should be rendered. The default render option is ValueRenderOption.FORMATTED_VALUE.
*/
responseValueRenderOption?: string;
/**
* The ID of the spreadsheet to update.
*/
spreadsheetId?: string;
/**
* How the input data should be interpreted.
*/
valueInputOption?: string;
/**
* Request body metadata
*/
requestBody?: Schema$ValueRange;
}
export {};
}