v1.d.ts
192 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
/**
* 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 games_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* Data format for the response.
*/
alt?: 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;
/**
* An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
*/
quotaUser?: string;
/**
* Deprecated. Please use quotaUser instead.
*/
userIp?: string;
}
/**
* Google Play Game Services API
*
* The API for Google Play Game Services.
*
* @example
* const {google} = require('googleapis');
* const games = google.games('v1');
*
* @namespace games
* @type {Function}
* @version v1
* @variation v1
* @param {object=} options Options for Games
*/
export class Games {
context: APIRequestContext;
achievementDefinitions: Resource$Achievementdefinitions;
achievements: Resource$Achievements;
applications: Resource$Applications;
events: Resource$Events;
leaderboards: Resource$Leaderboards;
metagame: Resource$Metagame;
players: Resource$Players;
pushtokens: Resource$Pushtokens;
revisions: Resource$Revisions;
rooms: Resource$Rooms;
scores: Resource$Scores;
snapshots: Resource$Snapshots;
turnBasedMatches: Resource$Turnbasedmatches;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* This is a JSON template for an achievement definition object.
*/
export interface Schema$AchievementDefinition {
/**
* The type of the achievement. Possible values are: - "STANDARD" - Achievement is either locked or unlocked. - "INCREMENTAL" - Achievement is incremental.
*/
achievementType?: string | null;
/**
* The description of the achievement.
*/
description?: string | null;
/**
* Experience points which will be earned when unlocking this achievement.
*/
experiencePoints?: string | null;
/**
* The total steps for an incremental achievement as a string.
*/
formattedTotalSteps?: string | null;
/**
* The ID of the achievement.
*/
id?: string | null;
/**
* The initial state of the achievement. Possible values are: - "HIDDEN" - Achievement is hidden. - "REVEALED" - Achievement is revealed. - "UNLOCKED" - Achievement is unlocked.
*/
initialState?: string | null;
/**
* Indicates whether the revealed icon image being returned is a default image, or is provided by the game.
*/
isRevealedIconUrlDefault?: boolean | null;
/**
* Indicates whether the unlocked icon image being returned is a default image, or is game-provided.
*/
isUnlockedIconUrlDefault?: boolean | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#achievementDefinition.
*/
kind?: string | null;
/**
* The name of the achievement.
*/
name?: string | null;
/**
* The image URL for the revealed achievement icon.
*/
revealedIconUrl?: string | null;
/**
* The total steps for an incremental achievement.
*/
totalSteps?: number | null;
/**
* The image URL for the unlocked achievement icon.
*/
unlockedIconUrl?: string | null;
}
/**
* This is a JSON template for a list of achievement definition objects.
*/
export interface Schema$AchievementDefinitionsListResponse {
/**
* The achievement definitions.
*/
items?: Schema$AchievementDefinition[];
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#achievementDefinitionsListResponse.
*/
kind?: string | null;
/**
* Token corresponding to the next page of results.
*/
nextPageToken?: string | null;
}
/**
* This is a JSON template for an achievement increment response
*/
export interface Schema$AchievementIncrementResponse {
/**
* The current steps recorded for this incremental achievement.
*/
currentSteps?: number | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#achievementIncrementResponse.
*/
kind?: string | null;
/**
* Whether the current steps for the achievement has reached the number of steps required to unlock.
*/
newlyUnlocked?: boolean | null;
}
/**
* This is a JSON template for an achievement reveal response
*/
export interface Schema$AchievementRevealResponse {
/**
* The current state of the achievement for which a reveal was attempted. This might be UNLOCKED if the achievement was already unlocked. Possible values are: - "REVEALED" - Achievement is revealed. - "UNLOCKED" - Achievement is unlocked.
*/
currentState?: string | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#achievementRevealResponse.
*/
kind?: string | null;
}
/**
* This is a JSON template for an achievement set steps at least response.
*/
export interface Schema$AchievementSetStepsAtLeastResponse {
/**
* The current steps recorded for this incremental achievement.
*/
currentSteps?: number | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#achievementSetStepsAtLeastResponse.
*/
kind?: string | null;
/**
* Whether the the current steps for the achievement has reached the number of steps required to unlock.
*/
newlyUnlocked?: boolean | null;
}
/**
* This is a JSON template for an achievement unlock response
*/
export interface Schema$AchievementUnlockResponse {
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#achievementUnlockResponse.
*/
kind?: string | null;
/**
* Whether this achievement was newly unlocked (that is, whether the unlock request for the achievement was the first for the player).
*/
newlyUnlocked?: boolean | null;
}
/**
* This is a JSON template for a list of achievement update requests.
*/
export interface Schema$AchievementUpdateMultipleRequest {
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#achievementUpdateMultipleRequest.
*/
kind?: string | null;
/**
* The individual achievement update requests.
*/
updates?: Schema$AchievementUpdateRequest[];
}
/**
* This is a JSON template for an achievement unlock response.
*/
export interface Schema$AchievementUpdateMultipleResponse {
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#achievementUpdateListResponse.
*/
kind?: string | null;
/**
* The updated state of the achievements.
*/
updatedAchievements?: Schema$AchievementUpdateResponse[];
}
/**
* This is a JSON template for a request to update an achievement.
*/
export interface Schema$AchievementUpdateRequest {
/**
* The achievement this update is being applied to.
*/
achievementId?: string | null;
/**
* The payload if an update of type INCREMENT was requested for the achievement.
*/
incrementPayload?: Schema$GamesAchievementIncrement;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#achievementUpdateRequest.
*/
kind?: string | null;
/**
* The payload if an update of type SET_STEPS_AT_LEAST was requested for the achievement.
*/
setStepsAtLeastPayload?: Schema$GamesAchievementSetStepsAtLeast;
/**
* The type of update being applied. Possible values are: - "REVEAL" - Achievement is revealed. - "UNLOCK" - Achievement is unlocked. - "INCREMENT" - Achievement is incremented. - "SET_STEPS_AT_LEAST" - Achievement progress is set to at least the passed value.
*/
updateType?: string | null;
}
/**
* This is a JSON template for an achievement update response.
*/
export interface Schema$AchievementUpdateResponse {
/**
* The achievement this update is was applied to.
*/
achievementId?: string | null;
/**
* The current state of the achievement. Possible values are: - "HIDDEN" - Achievement is hidden. - "REVEALED" - Achievement is revealed. - "UNLOCKED" - Achievement is unlocked.
*/
currentState?: string | null;
/**
* The current steps recorded for this achievement if it is incremental.
*/
currentSteps?: number | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#achievementUpdateResponse.
*/
kind?: string | null;
/**
* Whether this achievement was newly unlocked (that is, whether the unlock request for the achievement was the first for the player).
*/
newlyUnlocked?: boolean | null;
/**
* Whether the requested updates actually affected the achievement.
*/
updateOccurred?: boolean | null;
}
/**
* This is a JSON template for aggregate stats.
*/
export interface Schema$AggregateStats {
/**
* The number of messages sent between a pair of peers.
*/
count?: string | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#aggregateStats.
*/
kind?: string | null;
/**
* The maximum amount.
*/
max?: string | null;
/**
* The minimum amount.
*/
min?: string | null;
/**
* The total number of bytes sent for messages between a pair of peers.
*/
sum?: string | null;
}
/**
* This is a JSON template for an anonymous player
*/
export interface Schema$AnonymousPlayer {
/**
* The base URL for the image to display for the anonymous player.
*/
avatarImageUrl?: string | null;
/**
* The name to display for the anonymous player.
*/
displayName?: string | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#anonymousPlayer.
*/
kind?: string | null;
}
/**
* This is a JSON template for the Application resource.
*/
export interface Schema$Application {
/**
* The number of achievements visible to the currently authenticated player.
*/
achievement_count?: number | null;
/**
* The assets of the application.
*/
assets?: Schema$ImageAsset[];
/**
* The author of the application.
*/
author?: string | null;
/**
* The category of the application.
*/
category?: Schema$ApplicationCategory;
/**
* The description of the application.
*/
description?: string | null;
/**
* A list of features that have been enabled for the application. Possible values are: - "SNAPSHOTS" - Snapshots has been enabled
*/
enabledFeatures?: string[] | null;
/**
* The ID of the application.
*/
id?: string | null;
/**
* The instances of the application.
*/
instances?: Schema$Instance[];
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#application.
*/
kind?: string | null;
/**
* The last updated timestamp of the application.
*/
lastUpdatedTimestamp?: string | null;
/**
* The number of leaderboards visible to the currently authenticated player.
*/
leaderboard_count?: number | null;
/**
* The name of the application.
*/
name?: string | null;
/**
* A hint to the client UI for what color to use as an app-themed color. The color is given as an RGB triplet (e.g. "E0E0E0").
*/
themeColor?: string | null;
}
/**
* This is a JSON template for an application category object.
*/
export interface Schema$ApplicationCategory {
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#applicationCategory.
*/
kind?: string | null;
/**
* The primary category.
*/
primary?: string | null;
/**
* The secondary category.
*/
secondary?: string | null;
}
/**
* This is a JSON template for a third party application verification response resource.
*/
export interface Schema$ApplicationVerifyResponse {
/**
* An alternate ID that was once used for the player that was issued the auth token used in this request. (This field is not normally populated.)
*/
alternate_player_id?: string | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#applicationVerifyResponse.
*/
kind?: string | null;
/**
* The ID of the player that was issued the auth token used in this request.
*/
player_id?: string | null;
}
/**
* This is a JSON template for data related to individual game categories.
*/
export interface Schema$Category {
/**
* The category name.
*/
category?: string | null;
/**
* Experience points earned in this category.
*/
experiencePoints?: string | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#category.
*/
kind?: string | null;
}
/**
* This is a JSON template for a list of category data objects.
*/
export interface Schema$CategoryListResponse {
/**
* The list of categories with usage data.
*/
items?: Schema$Category[];
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#categoryListResponse.
*/
kind?: string | null;
/**
* Token corresponding to the next page of results.
*/
nextPageToken?: string | null;
}
/**
* This is a JSON template for a batch update failure resource.
*/
export interface Schema$EventBatchRecordFailure {
/**
* The cause for the update failure. Possible values are: - "TOO_LARGE": A batch request was issued with more events than are allowed in a single batch. - "TIME_PERIOD_EXPIRED": A batch was sent with data too far in the past to record. - "TIME_PERIOD_SHORT": A batch was sent with a time range that was too short. - "TIME_PERIOD_LONG": A batch was sent with a time range that was too long. - "ALREADY_UPDATED": An attempt was made to record a batch of data which was already seen. - "RECORD_RATE_HIGH": An attempt was made to record data faster than the server will apply updates.
*/
failureCause?: string | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#eventBatchRecordFailure.
*/
kind?: string | null;
/**
* The time range which was rejected; empty for a request-wide failure.
*/
range?: Schema$EventPeriodRange;
}
/**
* This is a JSON template for an event child relationship resource.
*/
export interface Schema$EventChild {
/**
* The ID of the child event.
*/
childId?: string | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#eventChild.
*/
kind?: string | null;
}
/**
* This is a JSON template for an event definition resource.
*/
export interface Schema$EventDefinition {
/**
* A list of events that are a child of this event.
*/
childEvents?: Schema$EventChild[];
/**
* Description of what this event represents.
*/
description?: string | null;
/**
* The name to display for the event.
*/
displayName?: string | null;
/**
* The ID of the event.
*/
id?: string | null;
/**
* The base URL for the image that represents the event.
*/
imageUrl?: string | null;
/**
* Indicates whether the icon image being returned is a default image, or is game-provided.
*/
isDefaultImageUrl?: boolean | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#eventDefinition.
*/
kind?: string | null;
/**
* The visibility of event being tracked in this definition. Possible values are: - "REVEALED": This event should be visible to all users. - "HIDDEN": This event should only be shown to users that have recorded this event at least once.
*/
visibility?: string | null;
}
/**
* This is a JSON template for a ListDefinitions response.
*/
export interface Schema$EventDefinitionListResponse {
/**
* The event definitions.
*/
items?: Schema$EventDefinition[];
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#eventDefinitionListResponse.
*/
kind?: string | null;
/**
* The pagination token for the next page of results.
*/
nextPageToken?: string | null;
}
/**
* This is a JSON template for an event period time range.
*/
export interface Schema$EventPeriodRange {
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#eventPeriodRange.
*/
kind?: string | null;
/**
* The time when this update period ends, in millis, since 1970 UTC (Unix Epoch).
*/
periodEndMillis?: string | null;
/**
* The time when this update period begins, in millis, since 1970 UTC (Unix Epoch).
*/
periodStartMillis?: string | null;
}
/**
* This is a JSON template for an event period update resource.
*/
export interface Schema$EventPeriodUpdate {
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#eventPeriodUpdate.
*/
kind?: string | null;
/**
* The time period being covered by this update.
*/
timePeriod?: Schema$EventPeriodRange;
/**
* The updates being made for this time period.
*/
updates?: Schema$EventUpdateRequest[];
}
/**
* This is a JSON template for an event update failure resource.
*/
export interface Schema$EventRecordFailure {
/**
* The ID of the event that was not updated.
*/
eventId?: string | null;
/**
* The cause for the update failure. Possible values are: - "NOT_FOUND" - An attempt was made to set an event that was not defined. - "INVALID_UPDATE_VALUE" - An attempt was made to increment an event by a non-positive value.
*/
failureCause?: string | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#eventRecordFailure.
*/
kind?: string | null;
}
/**
* This is a JSON template for an event period update resource.
*/
export interface Schema$EventRecordRequest {
/**
* The current time when this update was sent, in milliseconds, since 1970 UTC (Unix Epoch).
*/
currentTimeMillis?: string | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#eventRecordRequest.
*/
kind?: string | null;
/**
* The request ID used to identify this attempt to record events.
*/
requestId?: string | null;
/**
* A list of the time period updates being made in this request.
*/
timePeriods?: Schema$EventPeriodUpdate[];
}
/**
* This is a JSON template for an event period update resource.
*/
export interface Schema$EventUpdateRequest {
/**
* The ID of the event being modified in this update.
*/
definitionId?: string | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#eventUpdateRequest.
*/
kind?: string | null;
/**
* The number of times this event occurred in this time period.
*/
updateCount?: string | null;
}
/**
* This is a JSON template for an event period update resource.
*/
export interface Schema$EventUpdateResponse {
/**
* Any batch-wide failures which occurred applying updates.
*/
batchFailures?: Schema$EventBatchRecordFailure[];
/**
* Any failures updating a particular event.
*/
eventFailures?: Schema$EventRecordFailure[];
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#eventUpdateResponse.
*/
kind?: string | null;
/**
* The current status of any updated events
*/
playerEvents?: Schema$PlayerEvent[];
}
/**
* This is a JSON template for the payload to request to increment an achievement.
*/
export interface Schema$GamesAchievementIncrement {
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#GamesAchievementIncrement.
*/
kind?: string | null;
/**
* The requestId associated with an increment to an achievement.
*/
requestId?: string | null;
/**
* The number of steps to be incremented.
*/
steps?: number | null;
}
/**
* This is a JSON template for the payload to request to increment an achievement.
*/
export interface Schema$GamesAchievementSetStepsAtLeast {
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#GamesAchievementSetStepsAtLeast.
*/
kind?: string | null;
/**
* The minimum number of steps for the achievement to be set to.
*/
steps?: number | null;
}
/**
* This is a JSON template for an image asset object.
*/
export interface Schema$ImageAsset {
/**
* The height of the asset.
*/
height?: number | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#imageAsset.
*/
kind?: string | null;
/**
* The name of the asset.
*/
name?: string | null;
/**
* The URL of the asset.
*/
url?: string | null;
/**
* The width of the asset.
*/
width?: number | null;
}
/**
* This is a JSON template for the Instance resource.
*/
export interface Schema$Instance {
/**
* URI which shows where a user can acquire this instance.
*/
acquisitionUri?: string | null;
/**
* Platform dependent details for Android.
*/
androidInstance?: Schema$InstanceAndroidDetails;
/**
* Platform dependent details for iOS.
*/
iosInstance?: Schema$InstanceIosDetails;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#instance.
*/
kind?: string | null;
/**
* Localized display name.
*/
name?: string | null;
/**
* The platform type. Possible values are: - "ANDROID" - Instance is for Android. - "IOS" - Instance is for iOS - "WEB_APP" - Instance is for Web App.
*/
platformType?: string | null;
/**
* Flag to show if this game instance supports realtime play.
*/
realtimePlay?: boolean | null;
/**
* Flag to show if this game instance supports turn based play.
*/
turnBasedPlay?: boolean | null;
/**
* Platform dependent details for Web.
*/
webInstance?: Schema$InstanceWebDetails;
}
/**
* This is a JSON template for the Android instance details resource.
*/
export interface Schema$InstanceAndroidDetails {
/**
* Flag indicating whether the anti-piracy check is enabled.
*/
enablePiracyCheck?: boolean | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#instanceAndroidDetails.
*/
kind?: string | null;
/**
* Android package name which maps to Google Play URL.
*/
packageName?: string | null;
/**
* Indicates that this instance is the default for new installations.
*/
preferred?: boolean | null;
}
/**
* This is a JSON template for the iOS details resource.
*/
export interface Schema$InstanceIosDetails {
/**
* Bundle identifier.
*/
bundleIdentifier?: string | null;
/**
* iTunes App ID.
*/
itunesAppId?: string | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#instanceIosDetails.
*/
kind?: string | null;
/**
* Indicates that this instance is the default for new installations on iPad devices.
*/
preferredForIpad?: boolean | null;
/**
* Indicates that this instance is the default for new installations on iPhone devices.
*/
preferredForIphone?: boolean | null;
/**
* Flag to indicate if this instance supports iPad.
*/
supportIpad?: boolean | null;
/**
* Flag to indicate if this instance supports iPhone.
*/
supportIphone?: boolean | null;
}
/**
* This is a JSON template for the Web details resource.
*/
export interface Schema$InstanceWebDetails {
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#instanceWebDetails.
*/
kind?: string | null;
/**
* Launch URL for the game.
*/
launchUrl?: string | null;
/**
* Indicates that this instance is the default for new installations.
*/
preferred?: boolean | null;
}
/**
* This is a JSON template for the Leaderboard resource.
*/
export interface Schema$Leaderboard {
/**
* The icon for the leaderboard.
*/
iconUrl?: string | null;
/**
* The leaderboard ID.
*/
id?: string | null;
/**
* Indicates whether the icon image being returned is a default image, or is game-provided.
*/
isIconUrlDefault?: boolean | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#leaderboard.
*/
kind?: string | null;
/**
* The name of the leaderboard.
*/
name?: string | null;
/**
* How scores are ordered. Possible values are: - "LARGER_IS_BETTER" - Larger values are better; scores are sorted in descending order. - "SMALLER_IS_BETTER" - Smaller values are better; scores are sorted in ascending order.
*/
order?: string | null;
}
/**
* This is a JSON template for the Leaderboard Entry resource.
*/
export interface Schema$LeaderboardEntry {
/**
* The localized string for the numerical value of this score.
*/
formattedScore?: string | null;
/**
* The localized string for the rank of this score for this leaderboard.
*/
formattedScoreRank?: string | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#leaderboardEntry.
*/
kind?: string | null;
/**
* The player who holds this score.
*/
player?: Schema$Player;
/**
* The rank of this score for this leaderboard.
*/
scoreRank?: string | null;
/**
* Additional information about the score. Values must contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986.
*/
scoreTag?: string | null;
/**
* The numerical value of this score.
*/
scoreValue?: string | null;
/**
* The time span of this high score. Possible values are: - "ALL_TIME" - The score is an all-time high score. - "WEEKLY" - The score is a weekly high score. - "DAILY" - The score is a daily high score.
*/
timeSpan?: string | null;
/**
* The timestamp at which this score was recorded, in milliseconds since the epoch in UTC.
*/
writeTimestampMillis?: string | null;
}
/**
* This is a JSON template for a list of leaderboard objects.
*/
export interface Schema$LeaderboardListResponse {
/**
* The leaderboards.
*/
items?: Schema$Leaderboard[];
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#leaderboardListResponse.
*/
kind?: string | null;
/**
* Token corresponding to the next page of results.
*/
nextPageToken?: string | null;
}
/**
* This is a JSON template for a score rank in a leaderboard.
*/
export interface Schema$LeaderboardScoreRank {
/**
* The number of scores in the leaderboard as a string.
*/
formattedNumScores?: string | null;
/**
* The rank in the leaderboard as a string.
*/
formattedRank?: string | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#leaderboardScoreRank.
*/
kind?: string | null;
/**
* The number of scores in the leaderboard.
*/
numScores?: string | null;
/**
* The rank in the leaderboard.
*/
rank?: string | null;
}
/**
* This is a JSON template for a ListScores response.
*/
export interface Schema$LeaderboardScores {
/**
* The scores in the leaderboard.
*/
items?: Schema$LeaderboardEntry[];
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#leaderboardScores.
*/
kind?: string | null;
/**
* The pagination token for the next page of results.
*/
nextPageToken?: string | null;
/**
* The total number of scores in the leaderboard.
*/
numScores?: string | null;
/**
* The score of the requesting player on the leaderboard. The player's score may appear both here and in the list of scores above. If you are viewing a public leaderboard and the player is not sharing their gameplay information publicly, the scoreRank and formattedScoreRank values will not be present.
*/
playerScore?: Schema$LeaderboardEntry;
/**
* The pagination token for the previous page of results.
*/
prevPageToken?: string | null;
}
/**
* This is a JSON template for the metagame config resource
*/
export interface Schema$MetagameConfig {
/**
* Current version of the metagame configuration data. When this data is updated, the version number will be increased by one.
*/
currentVersion?: number | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#metagameConfig.
*/
kind?: string | null;
/**
* The list of player levels.
*/
playerLevels?: Schema$PlayerLevel[];
}
/**
* This is a JSON template for network diagnostics reported for a client.
*/
export interface Schema$NetworkDiagnostics {
/**
* The Android network subtype.
*/
androidNetworkSubtype?: number | null;
/**
* The Android network type.
*/
androidNetworkType?: number | null;
/**
* iOS network type as defined in Reachability.h.
*/
iosNetworkType?: number | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#networkDiagnostics.
*/
kind?: string | null;
/**
* The MCC+MNC code for the client's network connection. On Android: http://developer.android.com/reference/android/telephony/TelephonyManager.html#getNetworkOperator() On iOS, see: https://developer.apple.com/library/ios/documentation/NetworkingInternet/Reference/CTCarrier/Reference/Reference.html
*/
networkOperatorCode?: string | null;
/**
* The name of the carrier of the client's network connection. On Android: http://developer.android.com/reference/android/telephony/TelephonyManager.html#getNetworkOperatorName() On iOS: https://developer.apple.com/library/ios/documentation/NetworkingInternet/Reference/CTCarrier/Reference/Reference.html#//apple_ref/occ/instp/CTCarrier/carrierName
*/
networkOperatorName?: string | null;
/**
* The amount of time in milliseconds it took for the client to establish a connection with the XMPP server.
*/
registrationLatencyMillis?: number | null;
}
/**
* This is a JSON template for a result for a match participant.
*/
export interface Schema$ParticipantResult {
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#participantResult.
*/
kind?: string | null;
/**
* The ID of the participant.
*/
participantId?: string | null;
/**
* The placement or ranking of the participant in the match results; a number from one to the number of participants in the match. Multiple participants may have the same placing value in case of a type.
*/
placing?: number | null;
/**
* The result of the participant for this match. Possible values are: - "MATCH_RESULT_WIN" - The participant won the match. - "MATCH_RESULT_LOSS" - The participant lost the match. - "MATCH_RESULT_TIE" - The participant tied the match. - "MATCH_RESULT_NONE" - There was no winner for the match (nobody wins or loses this kind of game.) - "MATCH_RESULT_DISCONNECT" - The participant disconnected / left during the match. - "MATCH_RESULT_DISAGREED" - Different clients reported different results for this participant.
*/
result?: string | null;
}
/**
* This is a JSON template for peer channel diagnostics.
*/
export interface Schema$PeerChannelDiagnostics {
/**
* Number of bytes received.
*/
bytesReceived?: Schema$AggregateStats;
/**
* Number of bytes sent.
*/
bytesSent?: Schema$AggregateStats;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#peerChannelDiagnostics.
*/
kind?: string | null;
/**
* Number of messages lost.
*/
numMessagesLost?: number | null;
/**
* Number of messages received.
*/
numMessagesReceived?: number | null;
/**
* Number of messages sent.
*/
numMessagesSent?: number | null;
/**
* Number of send failures.
*/
numSendFailures?: number | null;
/**
* Roundtrip latency stats in milliseconds.
*/
roundtripLatencyMillis?: Schema$AggregateStats;
}
/**
* This is a JSON template for peer session diagnostics.
*/
export interface Schema$PeerSessionDiagnostics {
/**
* Connected time in milliseconds.
*/
connectedTimestampMillis?: string | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#peerSessionDiagnostics.
*/
kind?: string | null;
/**
* The participant ID of the peer.
*/
participantId?: string | null;
/**
* Reliable channel diagnostics.
*/
reliableChannel?: Schema$PeerChannelDiagnostics;
/**
* Unreliable channel diagnostics.
*/
unreliableChannel?: Schema$PeerChannelDiagnostics;
}
/**
* This is a JSON template for metadata about a player playing a game with the currently authenticated user.
*/
export interface Schema$Played {
/**
* True if the player was auto-matched with the currently authenticated user.
*/
autoMatched?: boolean | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#played.
*/
kind?: string | null;
/**
* The last time the player played the game in milliseconds since the epoch in UTC.
*/
timeMillis?: string | null;
}
/**
* This is a JSON template for a Player resource.
*/
export interface Schema$Player {
/**
* The base URL for the image that represents the player.
*/
avatarImageUrl?: string | null;
/**
* The url to the landscape mode player banner image.
*/
bannerUrlLandscape?: string | null;
/**
* The url to the portrait mode player banner image.
*/
bannerUrlPortrait?: string | null;
/**
* The name to display for the player.
*/
displayName?: string | null;
/**
* An object to represent Play Game experience information for the player.
*/
experienceInfo?: Schema$PlayerExperienceInfo;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#player.
*/
kind?: string | null;
/**
* Details about the last time this player played a multiplayer game with the currently authenticated player. Populated for PLAYED_WITH player collection members.
*/
lastPlayedWith?: Schema$Played;
/**
* An object representation of the individual components of the player's name. For some players, these fields may not be present.
*/
name?: {
familyName?: string;
givenName?: string;
} | null;
/**
* The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs.
*/
originalPlayerId?: string | null;
/**
* The ID of the player.
*/
playerId?: string | null;
playerStattus?: string | null;
/**
* The player's profile settings. Controls whether or not the player's profile is visible to other players.
*/
profileSettings?: Schema$ProfileSettings;
/**
* The player's title rewarded for their game activities.
*/
title?: string | null;
}
/**
* This is a JSON template for an achievement object.
*/
export interface Schema$PlayerAchievement {
/**
* The state of the achievement. Possible values are: - "HIDDEN" - Achievement is hidden. - "REVEALED" - Achievement is revealed. - "UNLOCKED" - Achievement is unlocked.
*/
achievementState?: string | null;
/**
* The current steps for an incremental achievement.
*/
currentSteps?: number | null;
/**
* Experience points earned for the achievement. This field is absent for achievements that have not yet been unlocked and 0 for achievements that have been unlocked by testers but that are unpublished.
*/
experiencePoints?: string | null;
/**
* The current steps for an incremental achievement as a string.
*/
formattedCurrentStepsString?: string | null;
/**
* The ID of the achievement.
*/
id?: string | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#playerAchievement.
*/
kind?: string | null;
/**
* The timestamp of the last modification to this achievement's state.
*/
lastUpdatedTimestamp?: string | null;
}
/**
* This is a JSON template for a list of achievement objects.
*/
export interface Schema$PlayerAchievementListResponse {
/**
* The achievements.
*/
items?: Schema$PlayerAchievement[];
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#playerAchievementListResponse.
*/
kind?: string | null;
/**
* Token corresponding to the next page of results.
*/
nextPageToken?: string | null;
}
/**
* This is a JSON template for an event status resource.
*/
export interface Schema$PlayerEvent {
/**
* The ID of the event definition.
*/
definitionId?: string | null;
/**
* The current number of times this event has occurred, as a string. The formatting of this string depends on the configuration of your event in the Play Games Developer Console.
*/
formattedNumEvents?: string | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#playerEvent.
*/
kind?: string | null;
/**
* The current number of times this event has occurred.
*/
numEvents?: string | null;
/**
* The ID of the player.
*/
playerId?: string | null;
}
/**
* This is a JSON template for a ListByPlayer response.
*/
export interface Schema$PlayerEventListResponse {
/**
* The player events.
*/
items?: Schema$PlayerEvent[];
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#playerEventListResponse.
*/
kind?: string | null;
/**
* The pagination token for the next page of results.
*/
nextPageToken?: string | null;
}
/**
* This is a JSON template for 1P/3P metadata about the player's experience.
*/
export interface Schema$PlayerExperienceInfo {
/**
* The current number of experience points for the player.
*/
currentExperiencePoints?: string | null;
/**
* The current level of the player.
*/
currentLevel?: Schema$PlayerLevel;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#playerExperienceInfo.
*/
kind?: string | null;
/**
* The timestamp when the player was leveled up, in millis since Unix epoch UTC.
*/
lastLevelUpTimestampMillis?: string | null;
/**
* The next level of the player. If the current level is the maximum level, this should be same as the current level.
*/
nextLevel?: Schema$PlayerLevel;
}
/**
* This is a JSON template for a player leaderboard score object.
*/
export interface Schema$PlayerLeaderboardScore {
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#playerLeaderboardScore.
*/
kind?: string | null;
/**
* The ID of the leaderboard this score is in.
*/
leaderboard_id?: string | null;
/**
* The public rank of the score in this leaderboard. This object will not be present if the user is not sharing their scores publicly.
*/
publicRank?: Schema$LeaderboardScoreRank;
/**
* The formatted value of this score.
*/
scoreString?: string | null;
/**
* Additional information about the score. Values must contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986.
*/
scoreTag?: string | null;
/**
* The numerical value of this score.
*/
scoreValue?: string | null;
/**
* The social rank of the score in this leaderboard.
*/
socialRank?: Schema$LeaderboardScoreRank;
/**
* The time span of this score. Possible values are: - "ALL_TIME" - The score is an all-time score. - "WEEKLY" - The score is a weekly score. - "DAILY" - The score is a daily score.
*/
timeSpan?: string | null;
/**
* The timestamp at which this score was recorded, in milliseconds since the epoch in UTC.
*/
writeTimestamp?: string | null;
}
/**
* This is a JSON template for a list of player leaderboard scores.
*/
export interface Schema$PlayerLeaderboardScoreListResponse {
/**
* The leaderboard scores.
*/
items?: Schema$PlayerLeaderboardScore[];
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#playerLeaderboardScoreListResponse.
*/
kind?: string | null;
/**
* The pagination token for the next page of results.
*/
nextPageToken?: string | null;
/**
* The Player resources for the owner of this score.
*/
player?: Schema$Player;
}
/**
* This is a JSON template for 1P/3P metadata about a user's level.
*/
export interface Schema$PlayerLevel {
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.
*/
kind?: string | null;
/**
* The level for the user.
*/
level?: number | null;
/**
* The maximum experience points for this level.
*/
maxExperiencePoints?: string | null;
/**
* The minimum experience points for this level.
*/
minExperiencePoints?: string | null;
}
/**
* This is a JSON template for a third party player list response.
*/
export interface Schema$PlayerListResponse {
/**
* The players.
*/
items?: Schema$Player[];
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#playerListResponse.
*/
kind?: string | null;
/**
* Token corresponding to the next page of results.
*/
nextPageToken?: string | null;
}
/**
* This is a JSON template for a player score.
*/
export interface Schema$PlayerScore {
/**
* The formatted score for this player score.
*/
formattedScore?: string | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#playerScore.
*/
kind?: string | null;
/**
* The numerical value for this player score.
*/
score?: string | null;
/**
* Additional information about this score. Values will contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986.
*/
scoreTag?: string | null;
/**
* The time span for this player score. Possible values are: - "ALL_TIME" - The score is an all-time score. - "WEEKLY" - The score is a weekly score. - "DAILY" - The score is a daily score.
*/
timeSpan?: string | null;
}
/**
* This is a JSON template for a list of score submission statuses.
*/
export interface Schema$PlayerScoreListResponse {
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#playerScoreListResponse.
*/
kind?: string | null;
/**
* The score submissions statuses.
*/
submittedScores?: Schema$PlayerScoreResponse[];
}
/**
* This is a JSON template for a list of leaderboard entry resources.
*/
export interface Schema$PlayerScoreResponse {
/**
* The time spans where the submitted score is better than the existing score for that time span. Possible values are: - "ALL_TIME" - The score is an all-time score. - "WEEKLY" - The score is a weekly score. - "DAILY" - The score is a daily score.
*/
beatenScoreTimeSpans?: string[] | null;
/**
* The formatted value of the submitted score.
*/
formattedScore?: string | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#playerScoreResponse.
*/
kind?: string | null;
/**
* The leaderboard ID that this score was submitted to.
*/
leaderboardId?: string | null;
/**
* Additional information about this score. Values will contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986.
*/
scoreTag?: string | null;
/**
* The scores in time spans that have not been beaten. As an example, the submitted score may be better than the player's DAILY score, but not better than the player's scores for the WEEKLY or ALL_TIME time spans.
*/
unbeatenScores?: Schema$PlayerScore[];
}
/**
* This is a JSON template for a list of score submission requests
*/
export interface Schema$PlayerScoreSubmissionList {
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#playerScoreSubmissionList.
*/
kind?: string | null;
/**
* The score submissions.
*/
scores?: Schema$ScoreSubmission[];
}
/**
* This is a JSON template for profile settings
*/
export interface Schema$ProfileSettings {
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#profileSettings.
*/
kind?: string | null;
profileVisible?: boolean | null;
}
/**
* This is a JSON template for a push token resource.
*/
export interface Schema$PushToken {
/**
* The revision of the client SDK used by your application, in the same format that's used by revisions.check. Used to send backward compatible messages. Format: [PLATFORM_TYPE]:[VERSION_NUMBER]. Possible values of PLATFORM_TYPE are: - IOS - Push token is for iOS
*/
clientRevision?: string | null;
/**
* Unique identifier for this push token.
*/
id?: Schema$PushTokenId;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#pushToken.
*/
kind?: string | null;
/**
* The preferred language for notifications that are sent using this token.
*/
language?: string | null;
}
/**
* This is a JSON template for a push token ID resource.
*/
export interface Schema$PushTokenId {
/**
* A push token ID for iOS devices.
*/
ios?: {
apns_device_token?: string;
apns_environment?: string;
} | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#pushTokenId.
*/
kind?: string | null;
}
/**
* This is a JSON template for the result of checking a revision.
*/
export interface Schema$RevisionCheckResponse {
/**
* The version of the API this client revision should use when calling API methods.
*/
apiVersion?: string | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#revisionCheckResponse.
*/
kind?: string | null;
/**
* The result of the revision check. Possible values are: - "OK" - The revision being used is current. - "DEPRECATED" - There is currently a newer version available, but the revision being used still works. - "INVALID" - The revision being used is not supported in any released version.
*/
revisionStatus?: string | null;
}
/**
* This is a JSON template for a room resource object.
*/
export interface Schema$Room {
/**
* The ID of the application being played.
*/
applicationId?: string | null;
/**
* Criteria for auto-matching players into this room.
*/
autoMatchingCriteria?: Schema$RoomAutoMatchingCriteria;
/**
* Auto-matching status for this room. Not set if the room is not currently in the auto-matching queue.
*/
autoMatchingStatus?: Schema$RoomAutoMatchStatus;
/**
* Details about the room creation.
*/
creationDetails?: Schema$RoomModification;
/**
* This short description is generated by our servers and worded relative to the player requesting the room. It is intended to be displayed when the room is shown in a list (that is, an invitation to a room.)
*/
description?: string | null;
/**
* The ID of the participant that invited the user to the room. Not set if the user was not invited to the room.
*/
inviterId?: string | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#room.
*/
kind?: string | null;
/**
* Details about the last update to the room.
*/
lastUpdateDetails?: Schema$RoomModification;
/**
* The participants involved in the room, along with their statuses. Includes participants who have left or declined invitations.
*/
participants?: Schema$RoomParticipant[];
/**
* Globally unique ID for a room.
*/
roomId?: string | null;
/**
* The version of the room status: an increasing counter, used by the client to ignore out-of-order updates to room status.
*/
roomStatusVersion?: number | null;
/**
* The status of the room. Possible values are: - "ROOM_INVITING" - One or more players have been invited and not responded. - "ROOM_AUTO_MATCHING" - One or more slots need to be filled by auto-matching. - "ROOM_CONNECTING" - Players have joined and are connecting to each other (either before or after auto-matching). - "ROOM_ACTIVE" - All players have joined and connected to each other. - "ROOM_DELETED" - The room should no longer be shown on the client. Returned in sync calls when a player joins a room (as a tombstone), or for rooms where all joined participants have left.
*/
status?: string | null;
/**
* The variant / mode of the application being played; can be any integer value, or left blank.
*/
variant?: number | null;
}
/**
* This is a JSON template for a room auto-match criteria object.
*/
export interface Schema$RoomAutoMatchingCriteria {
/**
* A bitmask indicating when auto-matches are valid. When ANDed with other exclusive bitmasks, the result must be zero. Can be used to support exclusive roles within a game.
*/
exclusiveBitmask?: string | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#roomAutoMatchingCriteria.
*/
kind?: string | null;
/**
* The maximum number of players that should be added to the room by auto-matching.
*/
maxAutoMatchingPlayers?: number | null;
/**
* The minimum number of players that should be added to the room by auto-matching.
*/
minAutoMatchingPlayers?: number | null;
}
/**
* This is a JSON template for status of room automatching that is in progress.
*/
export interface Schema$RoomAutoMatchStatus {
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#roomAutoMatchStatus.
*/
kind?: string | null;
/**
* An estimate for the amount of time (in seconds) that auto-matching is expected to take to complete.
*/
waitEstimateSeconds?: number | null;
}
/**
* This is a JSON template for the client address when setting up a room.
*/
export interface Schema$RoomClientAddress {
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#roomClientAddress.
*/
kind?: string | null;
/**
* The XMPP address of the client on the Google Games XMPP network.
*/
xmppAddress?: string | null;
}
/**
* This is a JSON template for a room creation request.
*/
export interface Schema$RoomCreateRequest {
/**
* Criteria for auto-matching players into this room.
*/
autoMatchingCriteria?: Schema$RoomAutoMatchingCriteria;
/**
* The capabilities that this client supports for realtime communication.
*/
capabilities?: string[] | null;
/**
* Client address for the player creating the room.
*/
clientAddress?: Schema$RoomClientAddress;
/**
* The player IDs to invite to the room.
*/
invitedPlayerIds?: string[] | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#roomCreateRequest.
*/
kind?: string | null;
/**
* Network diagnostics for the client creating the room.
*/
networkDiagnostics?: Schema$NetworkDiagnostics;
/**
* A randomly generated numeric ID. This number is used at the server to ensure that the request is handled correctly across retries.
*/
requestId?: string | null;
/**
* The variant / mode of the application to be played. This can be any integer value, or left blank. You should use a small number of variants to keep the auto-matching pool as large as possible.
*/
variant?: number | null;
}
/**
* This is a JSON template for a join room request.
*/
export interface Schema$RoomJoinRequest {
/**
* The capabilities that this client supports for realtime communication.
*/
capabilities?: string[] | null;
/**
* Client address for the player joining the room.
*/
clientAddress?: Schema$RoomClientAddress;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#roomJoinRequest.
*/
kind?: string | null;
/**
* Network diagnostics for the client joining the room.
*/
networkDiagnostics?: Schema$NetworkDiagnostics;
}
/**
* This is a JSON template for room leave diagnostics.
*/
export interface Schema$RoomLeaveDiagnostics {
/**
* Android network subtype. http://developer.android.com/reference/android/net/NetworkInfo.html#getSubtype()
*/
androidNetworkSubtype?: number | null;
/**
* Android network type. http://developer.android.com/reference/android/net/NetworkInfo.html#getType()
*/
androidNetworkType?: number | null;
/**
* iOS network type as defined in Reachability.h.
*/
iosNetworkType?: number | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#roomLeaveDiagnostics.
*/
kind?: string | null;
/**
* The MCC+MNC code for the client's network connection. On Android: http://developer.android.com/reference/android/telephony/TelephonyManager.html#getNetworkOperator() On iOS, see: https://developer.apple.com/library/ios/documentation/NetworkingInternet/Reference/CTCarrier/Reference/Reference.html
*/
networkOperatorCode?: string | null;
/**
* The name of the carrier of the client's network connection. On Android: http://developer.android.com/reference/android/telephony/TelephonyManager.html#getNetworkOperatorName() On iOS: https://developer.apple.com/library/ios/documentation/NetworkingInternet/Reference/CTCarrier/Reference/Reference.html#//apple_ref/occ/instp/CTCarrier/carrierName
*/
networkOperatorName?: string | null;
/**
* Diagnostics about all peer sessions.
*/
peerSession?: Schema$PeerSessionDiagnostics[];
/**
* Whether or not sockets were used.
*/
socketsUsed?: boolean | null;
}
/**
* This is a JSON template for a leave room request.
*/
export interface Schema$RoomLeaveRequest {
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#roomLeaveRequest.
*/
kind?: string | null;
/**
* Diagnostics for a player leaving the room.
*/
leaveDiagnostics?: Schema$RoomLeaveDiagnostics;
/**
* Reason for leaving the match. Possible values are: - "PLAYER_LEFT" - The player chose to leave the room.. - "GAME_LEFT" - The game chose to remove the player from the room. - "REALTIME_ABANDONED" - The player switched to another application and abandoned the room. - "REALTIME_PEER_CONNECTION_FAILURE" - The client was unable to establish a connection to other peer(s). - "REALTIME_SERVER_CONNECTION_FAILURE" - The client was unable to communicate with the server. - "REALTIME_SERVER_ERROR" - The client received an error response when it tried to communicate with the server. - "REALTIME_TIMEOUT" - The client timed out while waiting for a room. - "REALTIME_CLIENT_DISCONNECTING" - The client disconnects without first calling Leave. - "REALTIME_SIGN_OUT" - The user signed out of G+ while in the room. - "REALTIME_GAME_CRASHED" - The game crashed. - "REALTIME_ROOM_SERVICE_CRASHED" - RoomAndroidService crashed. - "REALTIME_DIFFERENT_CLIENT_ROOM_OPERATION" - Another client is trying to enter a room. - "REALTIME_SAME_CLIENT_ROOM_OPERATION" - The same client is trying to enter a new room.
*/
reason?: string | null;
}
/**
* This is a JSON template for a list of rooms.
*/
export interface Schema$RoomList {
/**
* The rooms.
*/
items?: Schema$Room[];
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#roomList.
*/
kind?: string | null;
/**
* The pagination token for the next page of results.
*/
nextPageToken?: string | null;
}
/**
* This is a JSON template for room modification metadata.
*/
export interface Schema$RoomModification {
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#roomModification.
*/
kind?: string | null;
/**
* The timestamp at which they modified the room, in milliseconds since the epoch in UTC.
*/
modifiedTimestampMillis?: string | null;
/**
* The ID of the participant that modified the room.
*/
participantId?: string | null;
}
/**
* This is a JSON template for an update on the status of a peer in a room.
*/
export interface Schema$RoomP2PStatus {
/**
* The amount of time in milliseconds it took to establish connections with this peer.
*/
connectionSetupLatencyMillis?: number | null;
/**
* The error code in event of a failure. Possible values are: - "P2P_FAILED" - The client failed to establish a P2P connection with the peer. - "PRESENCE_FAILED" - The client failed to register to receive P2P connections. - "RELAY_SERVER_FAILED" - The client received an error when trying to use the relay server to establish a P2P connection with the peer.
*/
error?: string | null;
/**
* More detailed diagnostic message returned in event of a failure.
*/
error_reason?: string | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#roomP2PStatus.
*/
kind?: string | null;
/**
* The ID of the participant.
*/
participantId?: string | null;
/**
* The status of the peer in the room. Possible values are: - "CONNECTION_ESTABLISHED" - The client established a P2P connection with the peer. - "CONNECTION_FAILED" - The client failed to establish directed presence with the peer.
*/
status?: string | null;
/**
* The amount of time in milliseconds it took to send packets back and forth on the unreliable channel with this peer.
*/
unreliableRoundtripLatencyMillis?: number | null;
}
/**
* This is a JSON template for an update on the status of peers in a room.
*/
export interface Schema$RoomP2PStatuses {
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#roomP2PStatuses.
*/
kind?: string | null;
/**
* The updates for the peers.
*/
updates?: Schema$RoomP2PStatus[];
}
/**
* This is a JSON template for a participant in a room.
*/
export interface Schema$RoomParticipant {
/**
* True if this participant was auto-matched with the requesting player.
*/
autoMatched?: boolean | null;
/**
* Information about a player that has been anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.)
*/
autoMatchedPlayer?: Schema$AnonymousPlayer;
/**
* The capabilities which can be used when communicating with this participant.
*/
capabilities?: string[] | null;
/**
* Client address for the participant.
*/
clientAddress?: Schema$RoomClientAddress;
/**
* True if this participant is in the fully connected set of peers in the room.
*/
connected?: boolean | null;
/**
* An identifier for the participant in the scope of the room. Cannot be used to identify a player across rooms or in other contexts.
*/
id?: string | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#roomParticipant.
*/
kind?: string | null;
/**
* The reason the participant left the room; populated if the participant status is PARTICIPANT_LEFT. Possible values are: - "PLAYER_LEFT" - The player explicitly chose to leave the room. - "GAME_LEFT" - The game chose to remove the player from the room. - "ABANDONED" - The player switched to another application and abandoned the room. - "PEER_CONNECTION_FAILURE" - The client was unable to establish or maintain a connection to other peer(s) in the room. - "SERVER_ERROR" - The client received an error response when it tried to communicate with the server. - "TIMEOUT" - The client timed out while waiting for players to join and connect. - "PRESENCE_FAILURE" - The client's XMPP connection ended abruptly.
*/
leaveReason?: string | null;
/**
* Information about the player. Not populated if this player was anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.)
*/
player?: Schema$Player;
/**
* The status of the participant with respect to the room. Possible values are: - "PARTICIPANT_INVITED" - The participant has been invited to join the room, but has not yet responded. - "PARTICIPANT_JOINED" - The participant has joined the room (either after creating it or accepting an invitation.) - "PARTICIPANT_DECLINED" - The participant declined an invitation to join the room. - "PARTICIPANT_LEFT" - The participant joined the room and then left it.
*/
status?: string | null;
}
/**
* This is a JSON template for the status of a room that the player has joined.
*/
export interface Schema$RoomStatus {
/**
* Auto-matching status for this room. Not set if the room is not currently in the automatching queue.
*/
autoMatchingStatus?: Schema$RoomAutoMatchStatus;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#roomStatus.
*/
kind?: string | null;
/**
* The participants involved in the room, along with their statuses. Includes participants who have left or declined invitations.
*/
participants?: Schema$RoomParticipant[];
/**
* Globally unique ID for a room.
*/
roomId?: string | null;
/**
* The status of the room. Possible values are: - "ROOM_INVITING" - One or more players have been invited and not responded. - "ROOM_AUTO_MATCHING" - One or more slots need to be filled by auto-matching. - "ROOM_CONNECTING" - Players have joined are connecting to each other (either before or after auto-matching). - "ROOM_ACTIVE" - All players have joined and connected to each other. - "ROOM_DELETED" - All joined players have left.
*/
status?: string | null;
/**
* The version of the status for the room: an increasing counter, used by the client to ignore out-of-order updates to room status.
*/
statusVersion?: number | null;
}
/**
* This is a JSON template for a request to submit a score to leaderboards.
*/
export interface Schema$ScoreSubmission {
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#scoreSubmission.
*/
kind?: string | null;
/**
* The leaderboard this score is being submitted to.
*/
leaderboardId?: string | null;
/**
* The new score being submitted.
*/
score?: string | null;
/**
* Additional information about this score. Values will contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986.
*/
scoreTag?: string | null;
/**
* Signature Values will contain URI-safe characters as defined by section 2.3 of RFC 3986.
*/
signature?: string | null;
}
/**
* This is a JSON template for an snapshot object.
*/
export interface Schema$Snapshot {
/**
* The cover image of this snapshot. May be absent if there is no image.
*/
coverImage?: Schema$SnapshotImage;
/**
* The description of this snapshot.
*/
description?: string | null;
/**
* The ID of the file underlying this snapshot in the Drive API. Only present if the snapshot is a view on a Drive file and the file is owned by the caller.
*/
driveId?: string | null;
/**
* The duration associated with this snapshot, in millis.
*/
durationMillis?: string | null;
/**
* The ID of the snapshot.
*/
id?: string | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#snapshot.
*/
kind?: string | null;
/**
* The timestamp (in millis since Unix epoch) of the last modification to this snapshot.
*/
lastModifiedMillis?: string | null;
/**
* The progress value (64-bit integer set by developer) associated with this snapshot.
*/
progressValue?: string | null;
/**
* The title of this snapshot.
*/
title?: string | null;
/**
* The type of this snapshot. Possible values are: - "SAVE_GAME" - A snapshot representing a save game.
*/
type?: string | null;
/**
* The unique name provided when the snapshot was created.
*/
uniqueName?: string | null;
}
/**
* This is a JSON template for an image of a snapshot.
*/
export interface Schema$SnapshotImage {
/**
* The height of the image.
*/
height?: number | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#snapshotImage.
*/
kind?: string | null;
/**
* The MIME type of the image.
*/
mime_type?: string | null;
/**
* The URL of the image. This URL may be invalidated at any time and should not be cached.
*/
url?: string | null;
/**
* The width of the image.
*/
width?: number | null;
}
/**
* This is a JSON template for a list of snapshot objects.
*/
export interface Schema$SnapshotListResponse {
/**
* The snapshots.
*/
items?: Schema$Snapshot[];
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#snapshotListResponse.
*/
kind?: string | null;
/**
* Token corresponding to the next page of results. If there are no more results, the token is omitted.
*/
nextPageToken?: string | null;
}
/**
* This is a JSON template for an turn-based auto-match criteria object.
*/
export interface Schema$TurnBasedAutoMatchingCriteria {
/**
* A bitmask indicating when auto-matches are valid. When ANDed with other exclusive bitmasks, the result must be zero. Can be used to support exclusive roles within a game.
*/
exclusiveBitmask?: string | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedAutoMatchingCriteria.
*/
kind?: string | null;
/**
* The maximum number of players that should be added to the match by auto-matching.
*/
maxAutoMatchingPlayers?: number | null;
/**
* The minimum number of players that should be added to the match by auto-matching.
*/
minAutoMatchingPlayers?: number | null;
}
/**
* This is a JSON template for a turn-based match resource object.
*/
export interface Schema$TurnBasedMatch {
/**
* The ID of the application being played.
*/
applicationId?: string | null;
/**
* Criteria for auto-matching players into this match.
*/
autoMatchingCriteria?: Schema$TurnBasedAutoMatchingCriteria;
/**
* Details about the match creation.
*/
creationDetails?: Schema$TurnBasedMatchModification;
/**
* The data / game state for this match.
*/
data?: Schema$TurnBasedMatchData;
/**
* This short description is generated by our servers based on turn state and is localized and worded relative to the player requesting the match. It is intended to be displayed when the match is shown in a list.
*/
description?: string | null;
/**
* The ID of the participant that invited the user to the match. Not set if the user was not invited to the match.
*/
inviterId?: string | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatch.
*/
kind?: string | null;
/**
* Details about the last update to the match.
*/
lastUpdateDetails?: Schema$TurnBasedMatchModification;
/**
* Globally unique ID for a turn-based match.
*/
matchId?: string | null;
/**
* The number of the match in a chain of rematches. Will be set to 1 for the first match and incremented by 1 for each rematch.
*/
matchNumber?: number | null;
/**
* The version of this match: an increasing counter, used to avoid out-of-date updates to the match.
*/
matchVersion?: number | null;
/**
* The participants involved in the match, along with their statuses. Includes participants who have left or declined invitations.
*/
participants?: Schema$TurnBasedMatchParticipant[];
/**
* The ID of the participant that is taking a turn.
*/
pendingParticipantId?: string | null;
/**
* The data / game state for the previous match; set for the first turn of rematches only.
*/
previousMatchData?: Schema$TurnBasedMatchData;
/**
* The ID of a rematch of this match. Only set for completed matches that have been rematched.
*/
rematchId?: string | null;
/**
* The results reported for this match.
*/
results?: Schema$ParticipantResult[];
/**
* The status of the match. Possible values are: - "MATCH_AUTO_MATCHING" - One or more slots need to be filled by auto-matching; the match cannot be established until they are filled. - "MATCH_ACTIVE" - The match has started. - "MATCH_COMPLETE" - The match has finished. - "MATCH_CANCELED" - The match was canceled. - "MATCH_EXPIRED" - The match expired due to inactivity. - "MATCH_DELETED" - The match should no longer be shown on the client. Returned only for tombstones for matches when sync is called.
*/
status?: string | null;
/**
* The status of the current user in the match. Derived from the match type, match status, the user's participant status, and the pending participant for the match. Possible values are: - "USER_INVITED" - The user has been invited to join the match and has not responded yet. - "USER_AWAITING_TURN" - The user is waiting for their turn. - "USER_TURN" - The user has an action to take in the match. - "USER_MATCH_COMPLETED" - The match has ended (it is completed, canceled, or expired.)
*/
userMatchStatus?: string | null;
/**
* The variant / mode of the application being played; can be any integer value, or left blank.
*/
variant?: number | null;
/**
* The ID of another participant in the match that can be used when describing the participants the user is playing with.
*/
withParticipantId?: string | null;
}
/**
* This is a JSON template for a turn-based match creation request.
*/
export interface Schema$TurnBasedMatchCreateRequest {
/**
* Criteria for auto-matching players into this match.
*/
autoMatchingCriteria?: Schema$TurnBasedAutoMatchingCriteria;
/**
* The player ids to invite to the match.
*/
invitedPlayerIds?: string[] | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchCreateRequest.
*/
kind?: string | null;
/**
* A randomly generated numeric ID. This number is used at the server to ensure that the request is handled correctly across retries.
*/
requestId?: string | null;
/**
* The variant / mode of the application to be played. This can be any integer value, or left blank. You should use a small number of variants to keep the auto-matching pool as large as possible.
*/
variant?: number | null;
}
/**
* This is a JSON template for a turn-based match data object.
*/
export interface Schema$TurnBasedMatchData {
/**
* The byte representation of the data (limited to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option.
*/
data?: string | null;
/**
* True if this match has data available but it wasn't returned in a list response; fetching the match individually will retrieve this data.
*/
dataAvailable?: boolean | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchData.
*/
kind?: string | null;
}
/**
* This is a JSON template for sending a turn-based match data object.
*/
export interface Schema$TurnBasedMatchDataRequest {
/**
* The byte representation of the data (limited to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option.
*/
data?: string | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchDataRequest.
*/
kind?: string | null;
}
/**
* This is a JSON template for a list of turn-based matches.
*/
export interface Schema$TurnBasedMatchList {
/**
* The matches.
*/
items?: Schema$TurnBasedMatch[];
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchList.
*/
kind?: string | null;
/**
* The pagination token for the next page of results.
*/
nextPageToken?: string | null;
}
/**
* This is a JSON template for turn-based match modification metadata.
*/
export interface Schema$TurnBasedMatchModification {
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchModification.
*/
kind?: string | null;
/**
* The timestamp at which they modified the match, in milliseconds since the epoch in UTC.
*/
modifiedTimestampMillis?: string | null;
/**
* The ID of the participant that modified the match.
*/
participantId?: string | null;
}
/**
* This is a JSON template for a participant in a turn-based match.
*/
export interface Schema$TurnBasedMatchParticipant {
/**
* True if this participant was auto-matched with the requesting player.
*/
autoMatched?: boolean | null;
/**
* Information about a player that has been anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.)
*/
autoMatchedPlayer?: Schema$AnonymousPlayer;
/**
* An identifier for the participant in the scope of the match. Cannot be used to identify a player across matches or in other contexts.
*/
id?: string | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchParticipant.
*/
kind?: string | null;
/**
* Information about the player. Not populated if this player was anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.)
*/
player?: Schema$Player;
/**
* The status of the participant with respect to the match. Possible values are: - "PARTICIPANT_NOT_INVITED_YET" - The participant is slated to be invited to the match, but the invitation has not been sent; the invite will be sent when it becomes their turn. - "PARTICIPANT_INVITED" - The participant has been invited to join the match, but has not yet responded. - "PARTICIPANT_JOINED" - The participant has joined the match (either after creating it or accepting an invitation.) - "PARTICIPANT_DECLINED" - The participant declined an invitation to join the match. - "PARTICIPANT_LEFT" - The participant joined the match and then left it. - "PARTICIPANT_FINISHED" - The participant finished playing in the match. - "PARTICIPANT_UNRESPONSIVE" - The participant did not take their turn in the allotted time.
*/
status?: string | null;
}
/**
* This is a JSON template for a rematch response.
*/
export interface Schema$TurnBasedMatchRematch {
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchRematch.
*/
kind?: string | null;
/**
* The old match that the rematch was created from; will be updated such that the rematchId field will point at the new match.
*/
previousMatch?: Schema$TurnBasedMatch;
/**
* The newly created match; a rematch of the old match with the same participants.
*/
rematch?: Schema$TurnBasedMatch;
}
/**
* This is a JSON template for a turn-based match results object.
*/
export interface Schema$TurnBasedMatchResults {
/**
* The final match data.
*/
data?: Schema$TurnBasedMatchDataRequest;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchResults.
*/
kind?: string | null;
/**
* The version of the match being updated.
*/
matchVersion?: number | null;
/**
* The match results for the participants in the match.
*/
results?: Schema$ParticipantResult[];
}
/**
* This is a JSON template for a list of turn-based matches returned from a sync.
*/
export interface Schema$TurnBasedMatchSync {
/**
* The matches.
*/
items?: Schema$TurnBasedMatch[];
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchSync.
*/
kind?: string | null;
/**
* True if there were more matches available to fetch at the time the response was generated (which were not returned due to page size limits.)
*/
moreAvailable?: boolean | null;
/**
* The pagination token for the next page of results.
*/
nextPageToken?: string | null;
}
/**
* This is a JSON template for the object representing a turn.
*/
export interface Schema$TurnBasedMatchTurn {
/**
* The shared game state data after the turn is over.
*/
data?: Schema$TurnBasedMatchDataRequest;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchTurn.
*/
kind?: string | null;
/**
* The version of this match: an increasing counter, used to avoid out-of-date updates to the match.
*/
matchVersion?: number | null;
/**
* The ID of the participant who should take their turn next. May be set to the current player's participant ID to update match state without changing the turn. If not set, the match will wait for other player(s) to join via automatching; this is only valid if automatch criteria is set on the match with remaining slots for automatched players.
*/
pendingParticipantId?: string | null;
/**
* The match results for the participants in the match.
*/
results?: Schema$ParticipantResult[];
}
export class Resource$Achievementdefinitions {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* games.achievementDefinitions.list
* @desc Lists all the achievement definitions for your application.
* @alias games.achievementDefinitions.list
* @memberOf! ()
*
* @param {object=} params Parameters for request
* @param {string=} params.language The preferred language to use for strings returned by this method.
* @param {integer=} params.maxResults The maximum number of achievement resources to return in the response, used for paging. For any response, the actual number of achievement resources returned may be less than the specified maxResults.
* @param {string=} params.pageToken The token returned by the previous 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
*/
list(params?: Params$Resource$Achievementdefinitions$List, options?: MethodOptions): GaxiosPromise<Schema$AchievementDefinitionsListResponse>;
list(params: Params$Resource$Achievementdefinitions$List, options: MethodOptions | BodyResponseCallback<Schema$AchievementDefinitionsListResponse>, callback: BodyResponseCallback<Schema$AchievementDefinitionsListResponse>): void;
list(params: Params$Resource$Achievementdefinitions$List, callback: BodyResponseCallback<Schema$AchievementDefinitionsListResponse>): void;
list(callback: BodyResponseCallback<Schema$AchievementDefinitionsListResponse>): void;
}
export interface Params$Resource$Achievementdefinitions$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The preferred language to use for strings returned by this method.
*/
language?: string;
/**
* The maximum number of achievement resources to return in the response, used for paging. For any response, the actual number of achievement resources returned may be less than the specified maxResults.
*/
maxResults?: number;
/**
* The token returned by the previous request.
*/
pageToken?: string;
}
export class Resource$Achievements {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* games.achievements.increment
* @desc Increments the steps of the achievement with the given ID for the currently authenticated player.
* @alias games.achievements.increment
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.achievementId The ID of the achievement used by this method.
* @param {string=} params.requestId A randomly generated numeric ID for each request specified by the caller. This number is used at the server to ensure that the request is handled correctly across retries.
* @param {integer} params.stepsToIncrement The number of steps to increment.
* @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
*/
increment(params?: Params$Resource$Achievements$Increment, options?: MethodOptions): GaxiosPromise<Schema$AchievementIncrementResponse>;
increment(params: Params$Resource$Achievements$Increment, options: MethodOptions | BodyResponseCallback<Schema$AchievementIncrementResponse>, callback: BodyResponseCallback<Schema$AchievementIncrementResponse>): void;
increment(params: Params$Resource$Achievements$Increment, callback: BodyResponseCallback<Schema$AchievementIncrementResponse>): void;
increment(callback: BodyResponseCallback<Schema$AchievementIncrementResponse>): void;
/**
* games.achievements.list
* @desc Lists the progress for all your application's achievements for the currently authenticated player.
* @alias games.achievements.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.language The preferred language to use for strings returned by this method.
* @param {integer=} params.maxResults The maximum number of achievement resources to return in the response, used for paging. For any response, the actual number of achievement resources returned may be less than the specified maxResults.
* @param {string=} params.pageToken The token returned by the previous request.
* @param {string} params.playerId A player ID. A value of me may be used in place of the authenticated player's ID.
* @param {string=} params.state Tells the server to return only achievements with the specified state. If this parameter isn't specified, all achievements are returned.
* @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
*/
list(params?: Params$Resource$Achievements$List, options?: MethodOptions): GaxiosPromise<Schema$PlayerAchievementListResponse>;
list(params: Params$Resource$Achievements$List, options: MethodOptions | BodyResponseCallback<Schema$PlayerAchievementListResponse>, callback: BodyResponseCallback<Schema$PlayerAchievementListResponse>): void;
list(params: Params$Resource$Achievements$List, callback: BodyResponseCallback<Schema$PlayerAchievementListResponse>): void;
list(callback: BodyResponseCallback<Schema$PlayerAchievementListResponse>): void;
/**
* games.achievements.reveal
* @desc Sets the state of the achievement with the given ID to REVEALED for the currently authenticated player.
* @alias games.achievements.reveal
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.achievementId The ID of the achievement used by this method.
* @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
*/
reveal(params?: Params$Resource$Achievements$Reveal, options?: MethodOptions): GaxiosPromise<Schema$AchievementRevealResponse>;
reveal(params: Params$Resource$Achievements$Reveal, options: MethodOptions | BodyResponseCallback<Schema$AchievementRevealResponse>, callback: BodyResponseCallback<Schema$AchievementRevealResponse>): void;
reveal(params: Params$Resource$Achievements$Reveal, callback: BodyResponseCallback<Schema$AchievementRevealResponse>): void;
reveal(callback: BodyResponseCallback<Schema$AchievementRevealResponse>): void;
/**
* games.achievements.setStepsAtLeast
* @desc Sets the steps for the currently authenticated player towards unlocking an achievement. If the steps parameter is less than the current number of steps that the player already gained for the achievement, the achievement is not modified.
* @alias games.achievements.setStepsAtLeast
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.achievementId The ID of the achievement used by this method.
* @param {integer} params.steps The minimum value to set the steps to.
* @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
*/
setStepsAtLeast(params?: Params$Resource$Achievements$Setstepsatleast, options?: MethodOptions): GaxiosPromise<Schema$AchievementSetStepsAtLeastResponse>;
setStepsAtLeast(params: Params$Resource$Achievements$Setstepsatleast, options: MethodOptions | BodyResponseCallback<Schema$AchievementSetStepsAtLeastResponse>, callback: BodyResponseCallback<Schema$AchievementSetStepsAtLeastResponse>): void;
setStepsAtLeast(params: Params$Resource$Achievements$Setstepsatleast, callback: BodyResponseCallback<Schema$AchievementSetStepsAtLeastResponse>): void;
setStepsAtLeast(callback: BodyResponseCallback<Schema$AchievementSetStepsAtLeastResponse>): void;
/**
* games.achievements.unlock
* @desc Unlocks this achievement for the currently authenticated player.
* @alias games.achievements.unlock
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.achievementId The ID of the achievement used by this method.
* @param {string=} params.builtinGameId Override used only by built-in games in Play Games application.
* @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
*/
unlock(params?: Params$Resource$Achievements$Unlock, options?: MethodOptions): GaxiosPromise<Schema$AchievementUnlockResponse>;
unlock(params: Params$Resource$Achievements$Unlock, options: MethodOptions | BodyResponseCallback<Schema$AchievementUnlockResponse>, callback: BodyResponseCallback<Schema$AchievementUnlockResponse>): void;
unlock(params: Params$Resource$Achievements$Unlock, callback: BodyResponseCallback<Schema$AchievementUnlockResponse>): void;
unlock(callback: BodyResponseCallback<Schema$AchievementUnlockResponse>): void;
/**
* games.achievements.updateMultiple
* @desc Updates multiple achievements for the currently authenticated player.
* @alias games.achievements.updateMultiple
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.builtinGameId Override used only by built-in games in Play Games application.
* @param {().AchievementUpdateMultipleRequest} 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
*/
updateMultiple(params?: Params$Resource$Achievements$Updatemultiple, options?: MethodOptions): GaxiosPromise<Schema$AchievementUpdateMultipleResponse>;
updateMultiple(params: Params$Resource$Achievements$Updatemultiple, options: MethodOptions | BodyResponseCallback<Schema$AchievementUpdateMultipleResponse>, callback: BodyResponseCallback<Schema$AchievementUpdateMultipleResponse>): void;
updateMultiple(params: Params$Resource$Achievements$Updatemultiple, callback: BodyResponseCallback<Schema$AchievementUpdateMultipleResponse>): void;
updateMultiple(callback: BodyResponseCallback<Schema$AchievementUpdateMultipleResponse>): void;
}
export interface Params$Resource$Achievements$Increment extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the achievement used by this method.
*/
achievementId?: string;
/**
* A randomly generated numeric ID for each request specified by the caller. This number is used at the server to ensure that the request is handled correctly across retries.
*/
requestId?: string;
/**
* The number of steps to increment.
*/
stepsToIncrement?: number;
}
export interface Params$Resource$Achievements$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The preferred language to use for strings returned by this method.
*/
language?: string;
/**
* The maximum number of achievement resources to return in the response, used for paging. For any response, the actual number of achievement resources returned may be less than the specified maxResults.
*/
maxResults?: number;
/**
* The token returned by the previous request.
*/
pageToken?: string;
/**
* A player ID. A value of me may be used in place of the authenticated player's ID.
*/
playerId?: string;
/**
* Tells the server to return only achievements with the specified state. If this parameter isn't specified, all achievements are returned.
*/
state?: string;
}
export interface Params$Resource$Achievements$Reveal extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the achievement used by this method.
*/
achievementId?: string;
}
export interface Params$Resource$Achievements$Setstepsatleast extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the achievement used by this method.
*/
achievementId?: string;
/**
* The minimum value to set the steps to.
*/
steps?: number;
}
export interface Params$Resource$Achievements$Unlock extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the achievement used by this method.
*/
achievementId?: string;
/**
* Override used only by built-in games in Play Games application.
*/
builtinGameId?: string;
}
export interface Params$Resource$Achievements$Updatemultiple extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Override used only by built-in games in Play Games application.
*/
builtinGameId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$AchievementUpdateMultipleRequest;
}
export class Resource$Applications {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* games.applications.get
* @desc Retrieves the metadata of the application with the given ID. If the requested application is not available for the specified platformType, the returned response will not include any instance data.
* @alias games.applications.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.applicationId The application ID from the Google Play developer console.
* @param {string=} params.language The preferred language to use for strings returned by this method.
* @param {string=} params.platformType Restrict application details returned to the specific platform.
* @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$Applications$Get, options?: MethodOptions): GaxiosPromise<Schema$Application>;
get(params: Params$Resource$Applications$Get, options: MethodOptions | BodyResponseCallback<Schema$Application>, callback: BodyResponseCallback<Schema$Application>): void;
get(params: Params$Resource$Applications$Get, callback: BodyResponseCallback<Schema$Application>): void;
get(callback: BodyResponseCallback<Schema$Application>): void;
/**
* games.applications.played
* @desc Indicate that the the currently authenticated user is playing your application.
* @alias games.applications.played
* @memberOf! ()
*
* @param {object=} params Parameters for request
* @param {string=} params.builtinGameId Override used only by built-in games in Play Games application.
* @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
*/
played(params?: Params$Resource$Applications$Played, options?: MethodOptions): GaxiosPromise<void>;
played(params: Params$Resource$Applications$Played, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
played(params: Params$Resource$Applications$Played, callback: BodyResponseCallback<void>): void;
played(callback: BodyResponseCallback<void>): void;
/**
* games.applications.verify
* @desc Verifies the auth token provided with this request is for the application with the specified ID, and returns the ID of the player it was granted for.
* @alias games.applications.verify
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.applicationId The application ID from the Google Play developer console.
* @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
*/
verify(params?: Params$Resource$Applications$Verify, options?: MethodOptions): GaxiosPromise<Schema$ApplicationVerifyResponse>;
verify(params: Params$Resource$Applications$Verify, options: MethodOptions | BodyResponseCallback<Schema$ApplicationVerifyResponse>, callback: BodyResponseCallback<Schema$ApplicationVerifyResponse>): void;
verify(params: Params$Resource$Applications$Verify, callback: BodyResponseCallback<Schema$ApplicationVerifyResponse>): void;
verify(callback: BodyResponseCallback<Schema$ApplicationVerifyResponse>): void;
}
export interface Params$Resource$Applications$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The application ID from the Google Play developer console.
*/
applicationId?: string;
/**
* The preferred language to use for strings returned by this method.
*/
language?: string;
/**
* Restrict application details returned to the specific platform.
*/
platformType?: string;
}
export interface Params$Resource$Applications$Played extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Override used only by built-in games in Play Games application.
*/
builtinGameId?: string;
}
export interface Params$Resource$Applications$Verify extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The application ID from the Google Play developer console.
*/
applicationId?: string;
}
export class Resource$Events {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* games.events.listByPlayer
* @desc Returns a list showing the current progress on events in this application for the currently authenticated user.
* @alias games.events.listByPlayer
* @memberOf! ()
*
* @param {object=} params Parameters for request
* @param {string=} params.language The preferred language to use for strings returned by this method.
* @param {integer=} params.maxResults The maximum number of events to return in the response, used for paging. For any response, the actual number of events to return may be less than the specified maxResults.
* @param {string=} params.pageToken The token returned by the previous 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
*/
listByPlayer(params?: Params$Resource$Events$Listbyplayer, options?: MethodOptions): GaxiosPromise<Schema$PlayerEventListResponse>;
listByPlayer(params: Params$Resource$Events$Listbyplayer, options: MethodOptions | BodyResponseCallback<Schema$PlayerEventListResponse>, callback: BodyResponseCallback<Schema$PlayerEventListResponse>): void;
listByPlayer(params: Params$Resource$Events$Listbyplayer, callback: BodyResponseCallback<Schema$PlayerEventListResponse>): void;
listByPlayer(callback: BodyResponseCallback<Schema$PlayerEventListResponse>): void;
/**
* games.events.listDefinitions
* @desc Returns a list of the event definitions in this application.
* @alias games.events.listDefinitions
* @memberOf! ()
*
* @param {object=} params Parameters for request
* @param {string=} params.language The preferred language to use for strings returned by this method.
* @param {integer=} params.maxResults The maximum number of event definitions to return in the response, used for paging. For any response, the actual number of event definitions to return may be less than the specified maxResults.
* @param {string=} params.pageToken The token returned by the previous 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
*/
listDefinitions(params?: Params$Resource$Events$Listdefinitions, options?: MethodOptions): GaxiosPromise<Schema$EventDefinitionListResponse>;
listDefinitions(params: Params$Resource$Events$Listdefinitions, options: MethodOptions | BodyResponseCallback<Schema$EventDefinitionListResponse>, callback: BodyResponseCallback<Schema$EventDefinitionListResponse>): void;
listDefinitions(params: Params$Resource$Events$Listdefinitions, callback: BodyResponseCallback<Schema$EventDefinitionListResponse>): void;
listDefinitions(callback: BodyResponseCallback<Schema$EventDefinitionListResponse>): void;
/**
* games.events.record
* @desc Records a batch of changes to the number of times events have occurred for the currently authenticated user of this application.
* @alias games.events.record
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.language The preferred language to use for strings returned by this method.
* @param {().EventRecordRequest} 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
*/
record(params?: Params$Resource$Events$Record, options?: MethodOptions): GaxiosPromise<Schema$EventUpdateResponse>;
record(params: Params$Resource$Events$Record, options: MethodOptions | BodyResponseCallback<Schema$EventUpdateResponse>, callback: BodyResponseCallback<Schema$EventUpdateResponse>): void;
record(params: Params$Resource$Events$Record, callback: BodyResponseCallback<Schema$EventUpdateResponse>): void;
record(callback: BodyResponseCallback<Schema$EventUpdateResponse>): void;
}
export interface Params$Resource$Events$Listbyplayer extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The preferred language to use for strings returned by this method.
*/
language?: string;
/**
* The maximum number of events to return in the response, used for paging. For any response, the actual number of events to return may be less than the specified maxResults.
*/
maxResults?: number;
/**
* The token returned by the previous request.
*/
pageToken?: string;
}
export interface Params$Resource$Events$Listdefinitions extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The preferred language to use for strings returned by this method.
*/
language?: string;
/**
* The maximum number of event definitions to return in the response, used for paging. For any response, the actual number of event definitions to return may be less than the specified maxResults.
*/
maxResults?: number;
/**
* The token returned by the previous request.
*/
pageToken?: string;
}
export interface Params$Resource$Events$Record extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The preferred language to use for strings returned by this method.
*/
language?: string;
/**
* Request body metadata
*/
requestBody?: Schema$EventRecordRequest;
}
export class Resource$Leaderboards {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* games.leaderboards.get
* @desc Retrieves the metadata of the leaderboard with the given ID.
* @alias games.leaderboards.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.language The preferred language to use for strings returned by this method.
* @param {string} params.leaderboardId The ID of the leaderboard.
* @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$Leaderboards$Get, options?: MethodOptions): GaxiosPromise<Schema$Leaderboard>;
get(params: Params$Resource$Leaderboards$Get, options: MethodOptions | BodyResponseCallback<Schema$Leaderboard>, callback: BodyResponseCallback<Schema$Leaderboard>): void;
get(params: Params$Resource$Leaderboards$Get, callback: BodyResponseCallback<Schema$Leaderboard>): void;
get(callback: BodyResponseCallback<Schema$Leaderboard>): void;
/**
* games.leaderboards.list
* @desc Lists all the leaderboard metadata for your application.
* @alias games.leaderboards.list
* @memberOf! ()
*
* @param {object=} params Parameters for request
* @param {string=} params.language The preferred language to use for strings returned by this method.
* @param {integer=} params.maxResults The maximum number of leaderboards to return in the response. For any response, the actual number of leaderboards returned may be less than the specified maxResults.
* @param {string=} params.pageToken The token returned by the previous 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
*/
list(params?: Params$Resource$Leaderboards$List, options?: MethodOptions): GaxiosPromise<Schema$LeaderboardListResponse>;
list(params: Params$Resource$Leaderboards$List, options: MethodOptions | BodyResponseCallback<Schema$LeaderboardListResponse>, callback: BodyResponseCallback<Schema$LeaderboardListResponse>): void;
list(params: Params$Resource$Leaderboards$List, callback: BodyResponseCallback<Schema$LeaderboardListResponse>): void;
list(callback: BodyResponseCallback<Schema$LeaderboardListResponse>): void;
}
export interface Params$Resource$Leaderboards$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The preferred language to use for strings returned by this method.
*/
language?: string;
/**
* The ID of the leaderboard.
*/
leaderboardId?: string;
}
export interface Params$Resource$Leaderboards$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The preferred language to use for strings returned by this method.
*/
language?: string;
/**
* The maximum number of leaderboards to return in the response. For any response, the actual number of leaderboards returned may be less than the specified maxResults.
*/
maxResults?: number;
/**
* The token returned by the previous request.
*/
pageToken?: string;
}
export class Resource$Metagame {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* games.metagame.getMetagameConfig
* @desc Return the metagame configuration data for the calling application.
* @alias games.metagame.getMetagameConfig
* @memberOf! ()
*
* @param {object=} params Parameters for 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
*/
getMetagameConfig(params?: Params$Resource$Metagame$Getmetagameconfig, options?: MethodOptions): GaxiosPromise<Schema$MetagameConfig>;
getMetagameConfig(params: Params$Resource$Metagame$Getmetagameconfig, options: MethodOptions | BodyResponseCallback<Schema$MetagameConfig>, callback: BodyResponseCallback<Schema$MetagameConfig>): void;
getMetagameConfig(params: Params$Resource$Metagame$Getmetagameconfig, callback: BodyResponseCallback<Schema$MetagameConfig>): void;
getMetagameConfig(callback: BodyResponseCallback<Schema$MetagameConfig>): void;
/**
* games.metagame.listCategoriesByPlayer
* @desc List play data aggregated per category for the player corresponding to playerId.
* @alias games.metagame.listCategoriesByPlayer
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.collection The collection of categories for which data will be returned.
* @param {string=} params.language The preferred language to use for strings returned by this method.
* @param {integer=} params.maxResults The maximum number of category resources to return in the response, used for paging. For any response, the actual number of category resources returned may be less than the specified maxResults.
* @param {string=} params.pageToken The token returned by the previous request.
* @param {string} params.playerId A player ID. A value of me may be used in place of the authenticated player's ID.
* @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
*/
listCategoriesByPlayer(params?: Params$Resource$Metagame$Listcategoriesbyplayer, options?: MethodOptions): GaxiosPromise<Schema$CategoryListResponse>;
listCategoriesByPlayer(params: Params$Resource$Metagame$Listcategoriesbyplayer, options: MethodOptions | BodyResponseCallback<Schema$CategoryListResponse>, callback: BodyResponseCallback<Schema$CategoryListResponse>): void;
listCategoriesByPlayer(params: Params$Resource$Metagame$Listcategoriesbyplayer, callback: BodyResponseCallback<Schema$CategoryListResponse>): void;
listCategoriesByPlayer(callback: BodyResponseCallback<Schema$CategoryListResponse>): void;
}
export interface Params$Resource$Metagame$Getmetagameconfig extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
}
export interface Params$Resource$Metagame$Listcategoriesbyplayer extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The collection of categories for which data will be returned.
*/
collection?: string;
/**
* The preferred language to use for strings returned by this method.
*/
language?: string;
/**
* The maximum number of category resources to return in the response, used for paging. For any response, the actual number of category resources returned may be less than the specified maxResults.
*/
maxResults?: number;
/**
* The token returned by the previous request.
*/
pageToken?: string;
/**
* A player ID. A value of me may be used in place of the authenticated player's ID.
*/
playerId?: string;
}
export class Resource$Players {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* games.players.get
* @desc Retrieves the Player resource with the given ID. To retrieve the player for the currently authenticated user, set playerId to me.
* @alias games.players.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.language The preferred language to use for strings returned by this method.
* @param {string} params.playerId A player ID. A value of me may be used in place of the authenticated player's ID.
* @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$Players$Get, options?: MethodOptions): GaxiosPromise<Schema$Player>;
get(params: Params$Resource$Players$Get, options: MethodOptions | BodyResponseCallback<Schema$Player>, callback: BodyResponseCallback<Schema$Player>): void;
get(params: Params$Resource$Players$Get, callback: BodyResponseCallback<Schema$Player>): void;
get(callback: BodyResponseCallback<Schema$Player>): void;
/**
* games.players.list
* @desc Get the collection of players for the currently authenticated user.
* @alias games.players.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.collection Collection of players being retrieved
* @param {string=} params.language The preferred language to use for strings returned by this method.
* @param {integer=} params.maxResults The maximum number of player resources to return in the response, used for paging. For any response, the actual number of player resources returned may be less than the specified maxResults.
* @param {string=} params.pageToken The token returned by the previous 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
*/
list(params?: Params$Resource$Players$List, options?: MethodOptions): GaxiosPromise<Schema$PlayerListResponse>;
list(params: Params$Resource$Players$List, options: MethodOptions | BodyResponseCallback<Schema$PlayerListResponse>, callback: BodyResponseCallback<Schema$PlayerListResponse>): void;
list(params: Params$Resource$Players$List, callback: BodyResponseCallback<Schema$PlayerListResponse>): void;
list(callback: BodyResponseCallback<Schema$PlayerListResponse>): void;
}
export interface Params$Resource$Players$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The preferred language to use for strings returned by this method.
*/
language?: string;
/**
* A player ID. A value of me may be used in place of the authenticated player's ID.
*/
playerId?: string;
}
export interface Params$Resource$Players$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Collection of players being retrieved
*/
collection?: string;
/**
* The preferred language to use for strings returned by this method.
*/
language?: string;
/**
* The maximum number of player resources to return in the response, used for paging. For any response, the actual number of player resources returned may be less than the specified maxResults.
*/
maxResults?: number;
/**
* The token returned by the previous request.
*/
pageToken?: string;
}
export class Resource$Pushtokens {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* games.pushtokens.remove
* @desc Removes a push token for the current user and application. Removing a non-existent push token will report success.
* @alias games.pushtokens.remove
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {().PushTokenId} 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
*/
remove(params?: Params$Resource$Pushtokens$Remove, options?: MethodOptions): GaxiosPromise<void>;
remove(params: Params$Resource$Pushtokens$Remove, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
remove(params: Params$Resource$Pushtokens$Remove, callback: BodyResponseCallback<void>): void;
remove(callback: BodyResponseCallback<void>): void;
/**
* games.pushtokens.update
* @desc Registers a push token for the current user and application.
* @alias games.pushtokens.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {().PushToken} 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$Pushtokens$Update, options?: MethodOptions): GaxiosPromise<void>;
update(params: Params$Resource$Pushtokens$Update, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
update(params: Params$Resource$Pushtokens$Update, callback: BodyResponseCallback<void>): void;
update(callback: BodyResponseCallback<void>): void;
}
export interface Params$Resource$Pushtokens$Remove extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Request body metadata
*/
requestBody?: Schema$PushTokenId;
}
export interface Params$Resource$Pushtokens$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Request body metadata
*/
requestBody?: Schema$PushToken;
}
export class Resource$Revisions {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* games.revisions.check
* @desc Checks whether the games client is out of date.
* @alias games.revisions.check
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.clientRevision The revision of the client SDK used by your application. Format: [PLATFORM_TYPE]:[VERSION_NUMBER]. Possible values of PLATFORM_TYPE are: - "ANDROID" - Client is running the Android SDK. - "IOS" - Client is running the iOS SDK. - "WEB_APP" - Client is running as a Web App.
* @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
*/
check(params?: Params$Resource$Revisions$Check, options?: MethodOptions): GaxiosPromise<Schema$RevisionCheckResponse>;
check(params: Params$Resource$Revisions$Check, options: MethodOptions | BodyResponseCallback<Schema$RevisionCheckResponse>, callback: BodyResponseCallback<Schema$RevisionCheckResponse>): void;
check(params: Params$Resource$Revisions$Check, callback: BodyResponseCallback<Schema$RevisionCheckResponse>): void;
check(callback: BodyResponseCallback<Schema$RevisionCheckResponse>): void;
}
export interface Params$Resource$Revisions$Check extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The revision of the client SDK used by your application. Format: [PLATFORM_TYPE]:[VERSION_NUMBER]. Possible values of PLATFORM_TYPE are: - "ANDROID" - Client is running the Android SDK. - "IOS" - Client is running the iOS SDK. - "WEB_APP" - Client is running as a Web App.
*/
clientRevision?: string;
}
export class Resource$Rooms {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* games.rooms.create
* @desc Create a room. For internal use by the Games SDK only. Calling this method directly is unsupported.
* @alias games.rooms.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.language The preferred language to use for strings returned by this method.
* @param {().RoomCreateRequest} 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$Rooms$Create, options?: MethodOptions): GaxiosPromise<Schema$Room>;
create(params: Params$Resource$Rooms$Create, options: MethodOptions | BodyResponseCallback<Schema$Room>, callback: BodyResponseCallback<Schema$Room>): void;
create(params: Params$Resource$Rooms$Create, callback: BodyResponseCallback<Schema$Room>): void;
create(callback: BodyResponseCallback<Schema$Room>): void;
/**
* games.rooms.decline
* @desc Decline an invitation to join a room. For internal use by the Games SDK only. Calling this method directly is unsupported.
* @alias games.rooms.decline
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.language The preferred language to use for strings returned by this method.
* @param {string} params.roomId The ID of the room.
* @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
*/
decline(params?: Params$Resource$Rooms$Decline, options?: MethodOptions): GaxiosPromise<Schema$Room>;
decline(params: Params$Resource$Rooms$Decline, options: MethodOptions | BodyResponseCallback<Schema$Room>, callback: BodyResponseCallback<Schema$Room>): void;
decline(params: Params$Resource$Rooms$Decline, callback: BodyResponseCallback<Schema$Room>): void;
decline(callback: BodyResponseCallback<Schema$Room>): void;
/**
* games.rooms.dismiss
* @desc Dismiss an invitation to join a room. For internal use by the Games SDK only. Calling this method directly is unsupported.
* @alias games.rooms.dismiss
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.roomId The ID of the room.
* @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
*/
dismiss(params?: Params$Resource$Rooms$Dismiss, options?: MethodOptions): GaxiosPromise<void>;
dismiss(params: Params$Resource$Rooms$Dismiss, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
dismiss(params: Params$Resource$Rooms$Dismiss, callback: BodyResponseCallback<void>): void;
dismiss(callback: BodyResponseCallback<void>): void;
/**
* games.rooms.get
* @desc Get the data for a room.
* @alias games.rooms.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.language The preferred language to use for strings returned by this method.
* @param {string} params.roomId The ID of the room.
* @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$Rooms$Get, options?: MethodOptions): GaxiosPromise<Schema$Room>;
get(params: Params$Resource$Rooms$Get, options: MethodOptions | BodyResponseCallback<Schema$Room>, callback: BodyResponseCallback<Schema$Room>): void;
get(params: Params$Resource$Rooms$Get, callback: BodyResponseCallback<Schema$Room>): void;
get(callback: BodyResponseCallback<Schema$Room>): void;
/**
* games.rooms.join
* @desc Join a room. For internal use by the Games SDK only. Calling this method directly is unsupported.
* @alias games.rooms.join
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.language The preferred language to use for strings returned by this method.
* @param {string} params.roomId The ID of the room.
* @param {().RoomJoinRequest} 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
*/
join(params?: Params$Resource$Rooms$Join, options?: MethodOptions): GaxiosPromise<Schema$Room>;
join(params: Params$Resource$Rooms$Join, options: MethodOptions | BodyResponseCallback<Schema$Room>, callback: BodyResponseCallback<Schema$Room>): void;
join(params: Params$Resource$Rooms$Join, callback: BodyResponseCallback<Schema$Room>): void;
join(callback: BodyResponseCallback<Schema$Room>): void;
/**
* games.rooms.leave
* @desc Leave a room. For internal use by the Games SDK only. Calling this method directly is unsupported.
* @alias games.rooms.leave
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.language The preferred language to use for strings returned by this method.
* @param {string} params.roomId The ID of the room.
* @param {().RoomLeaveRequest} 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
*/
leave(params?: Params$Resource$Rooms$Leave, options?: MethodOptions): GaxiosPromise<Schema$Room>;
leave(params: Params$Resource$Rooms$Leave, options: MethodOptions | BodyResponseCallback<Schema$Room>, callback: BodyResponseCallback<Schema$Room>): void;
leave(params: Params$Resource$Rooms$Leave, callback: BodyResponseCallback<Schema$Room>): void;
leave(callback: BodyResponseCallback<Schema$Room>): void;
/**
* games.rooms.list
* @desc Returns invitations to join rooms.
* @alias games.rooms.list
* @memberOf! ()
*
* @param {object=} params Parameters for request
* @param {string=} params.language The preferred language to use for strings returned by this method.
* @param {integer=} params.maxResults The maximum number of rooms to return in the response, used for paging. For any response, the actual number of rooms to return may be less than the specified maxResults.
* @param {string=} params.pageToken The token returned by the previous 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
*/
list(params?: Params$Resource$Rooms$List, options?: MethodOptions): GaxiosPromise<Schema$RoomList>;
list(params: Params$Resource$Rooms$List, options: MethodOptions | BodyResponseCallback<Schema$RoomList>, callback: BodyResponseCallback<Schema$RoomList>): void;
list(params: Params$Resource$Rooms$List, callback: BodyResponseCallback<Schema$RoomList>): void;
list(callback: BodyResponseCallback<Schema$RoomList>): void;
/**
* games.rooms.reportStatus
* @desc Updates sent by a client reporting the status of peers in a room. For internal use by the Games SDK only. Calling this method directly is unsupported.
* @alias games.rooms.reportStatus
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.language The preferred language to use for strings returned by this method.
* @param {string} params.roomId The ID of the room.
* @param {().RoomP2PStatuses} 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
*/
reportStatus(params?: Params$Resource$Rooms$Reportstatus, options?: MethodOptions): GaxiosPromise<Schema$RoomStatus>;
reportStatus(params: Params$Resource$Rooms$Reportstatus, options: MethodOptions | BodyResponseCallback<Schema$RoomStatus>, callback: BodyResponseCallback<Schema$RoomStatus>): void;
reportStatus(params: Params$Resource$Rooms$Reportstatus, callback: BodyResponseCallback<Schema$RoomStatus>): void;
reportStatus(callback: BodyResponseCallback<Schema$RoomStatus>): void;
}
export interface Params$Resource$Rooms$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The preferred language to use for strings returned by this method.
*/
language?: string;
/**
* Request body metadata
*/
requestBody?: Schema$RoomCreateRequest;
}
export interface Params$Resource$Rooms$Decline extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The preferred language to use for strings returned by this method.
*/
language?: string;
/**
* The ID of the room.
*/
roomId?: string;
}
export interface Params$Resource$Rooms$Dismiss extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the room.
*/
roomId?: string;
}
export interface Params$Resource$Rooms$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The preferred language to use for strings returned by this method.
*/
language?: string;
/**
* The ID of the room.
*/
roomId?: string;
}
export interface Params$Resource$Rooms$Join extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The preferred language to use for strings returned by this method.
*/
language?: string;
/**
* The ID of the room.
*/
roomId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$RoomJoinRequest;
}
export interface Params$Resource$Rooms$Leave extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The preferred language to use for strings returned by this method.
*/
language?: string;
/**
* The ID of the room.
*/
roomId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$RoomLeaveRequest;
}
export interface Params$Resource$Rooms$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The preferred language to use for strings returned by this method.
*/
language?: string;
/**
* The maximum number of rooms to return in the response, used for paging. For any response, the actual number of rooms to return may be less than the specified maxResults.
*/
maxResults?: number;
/**
* The token returned by the previous request.
*/
pageToken?: string;
}
export interface Params$Resource$Rooms$Reportstatus extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The preferred language to use for strings returned by this method.
*/
language?: string;
/**
* The ID of the room.
*/
roomId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$RoomP2PStatuses;
}
export class Resource$Scores {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* games.scores.get
* @desc Get high scores, and optionally ranks, in leaderboards for the currently authenticated player. For a specific time span, leaderboardId can be set to ALL to retrieve data for all leaderboards in a given time span. NOTE: You cannot ask for 'ALL' leaderboards and 'ALL' timeSpans in the same request; only one parameter may be set to 'ALL'.
* @alias games.scores.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.includeRankType The types of ranks to return. If the parameter is omitted, no ranks will be returned.
* @param {string=} params.language The preferred language to use for strings returned by this method.
* @param {string} params.leaderboardId The ID of the leaderboard. Can be set to 'ALL' to retrieve data for all leaderboards for this application.
* @param {integer=} params.maxResults The maximum number of leaderboard scores to return in the response. For any response, the actual number of leaderboard scores returned may be less than the specified maxResults.
* @param {string=} params.pageToken The token returned by the previous request.
* @param {string} params.playerId A player ID. A value of me may be used in place of the authenticated player's ID.
* @param {string} params.timeSpan The time span for the scores and ranks you're requesting.
* @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$Scores$Get, options?: MethodOptions): GaxiosPromise<Schema$PlayerLeaderboardScoreListResponse>;
get(params: Params$Resource$Scores$Get, options: MethodOptions | BodyResponseCallback<Schema$PlayerLeaderboardScoreListResponse>, callback: BodyResponseCallback<Schema$PlayerLeaderboardScoreListResponse>): void;
get(params: Params$Resource$Scores$Get, callback: BodyResponseCallback<Schema$PlayerLeaderboardScoreListResponse>): void;
get(callback: BodyResponseCallback<Schema$PlayerLeaderboardScoreListResponse>): void;
/**
* games.scores.list
* @desc Lists the scores in a leaderboard, starting from the top.
* @alias games.scores.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.collection The collection of scores you're requesting.
* @param {string=} params.language The preferred language to use for strings returned by this method.
* @param {string} params.leaderboardId The ID of the leaderboard.
* @param {integer=} params.maxResults The maximum number of leaderboard scores to return in the response. For any response, the actual number of leaderboard scores returned may be less than the specified maxResults.
* @param {string=} params.pageToken The token returned by the previous request.
* @param {string} params.timeSpan The time span for the scores and ranks you're requesting.
* @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
*/
list(params?: Params$Resource$Scores$List, options?: MethodOptions): GaxiosPromise<Schema$LeaderboardScores>;
list(params: Params$Resource$Scores$List, options: MethodOptions | BodyResponseCallback<Schema$LeaderboardScores>, callback: BodyResponseCallback<Schema$LeaderboardScores>): void;
list(params: Params$Resource$Scores$List, callback: BodyResponseCallback<Schema$LeaderboardScores>): void;
list(callback: BodyResponseCallback<Schema$LeaderboardScores>): void;
/**
* games.scores.listWindow
* @desc Lists the scores in a leaderboard around (and including) a player's score.
* @alias games.scores.listWindow
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.collection The collection of scores you're requesting.
* @param {string=} params.language The preferred language to use for strings returned by this method.
* @param {string} params.leaderboardId The ID of the leaderboard.
* @param {integer=} params.maxResults The maximum number of leaderboard scores to return in the response. For any response, the actual number of leaderboard scores returned may be less than the specified maxResults.
* @param {string=} params.pageToken The token returned by the previous request.
* @param {integer=} params.resultsAbove The preferred number of scores to return above the player's score. More scores may be returned if the player is at the bottom of the leaderboard; fewer may be returned if the player is at the top. Must be less than or equal to maxResults.
* @param {boolean=} params.returnTopIfAbsent True if the top scores should be returned when the player is not in the leaderboard. Defaults to true.
* @param {string} params.timeSpan The time span for the scores and ranks you're requesting.
* @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
*/
listWindow(params?: Params$Resource$Scores$Listwindow, options?: MethodOptions): GaxiosPromise<Schema$LeaderboardScores>;
listWindow(params: Params$Resource$Scores$Listwindow, options: MethodOptions | BodyResponseCallback<Schema$LeaderboardScores>, callback: BodyResponseCallback<Schema$LeaderboardScores>): void;
listWindow(params: Params$Resource$Scores$Listwindow, callback: BodyResponseCallback<Schema$LeaderboardScores>): void;
listWindow(callback: BodyResponseCallback<Schema$LeaderboardScores>): void;
/**
* games.scores.submit
* @desc Submits a score to the specified leaderboard.
* @alias games.scores.submit
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.language The preferred language to use for strings returned by this method.
* @param {string} params.leaderboardId The ID of the leaderboard.
* @param {string} params.score The score you're submitting. The submitted score is ignored if it is worse than a previously submitted score, where worse depends on the leaderboard sort order. The meaning of the score value depends on the leaderboard format type. For fixed-point, the score represents the raw value. For time, the score represents elapsed time in milliseconds. For currency, the score represents a value in micro units.
* @param {string=} params.scoreTag Additional information about the score you're submitting. Values must contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986.
* @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
*/
submit(params?: Params$Resource$Scores$Submit, options?: MethodOptions): GaxiosPromise<Schema$PlayerScoreResponse>;
submit(params: Params$Resource$Scores$Submit, options: MethodOptions | BodyResponseCallback<Schema$PlayerScoreResponse>, callback: BodyResponseCallback<Schema$PlayerScoreResponse>): void;
submit(params: Params$Resource$Scores$Submit, callback: BodyResponseCallback<Schema$PlayerScoreResponse>): void;
submit(callback: BodyResponseCallback<Schema$PlayerScoreResponse>): void;
/**
* games.scores.submitMultiple
* @desc Submits multiple scores to leaderboards.
* @alias games.scores.submitMultiple
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.language The preferred language to use for strings returned by this method.
* @param {().PlayerScoreSubmissionList} 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
*/
submitMultiple(params?: Params$Resource$Scores$Submitmultiple, options?: MethodOptions): GaxiosPromise<Schema$PlayerScoreListResponse>;
submitMultiple(params: Params$Resource$Scores$Submitmultiple, options: MethodOptions | BodyResponseCallback<Schema$PlayerScoreListResponse>, callback: BodyResponseCallback<Schema$PlayerScoreListResponse>): void;
submitMultiple(params: Params$Resource$Scores$Submitmultiple, callback: BodyResponseCallback<Schema$PlayerScoreListResponse>): void;
submitMultiple(callback: BodyResponseCallback<Schema$PlayerScoreListResponse>): void;
}
export interface Params$Resource$Scores$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The types of ranks to return. If the parameter is omitted, no ranks will be returned.
*/
includeRankType?: string;
/**
* The preferred language to use for strings returned by this method.
*/
language?: string;
/**
* The ID of the leaderboard. Can be set to 'ALL' to retrieve data for all leaderboards for this application.
*/
leaderboardId?: string;
/**
* The maximum number of leaderboard scores to return in the response. For any response, the actual number of leaderboard scores returned may be less than the specified maxResults.
*/
maxResults?: number;
/**
* The token returned by the previous request.
*/
pageToken?: string;
/**
* A player ID. A value of me may be used in place of the authenticated player's ID.
*/
playerId?: string;
/**
* The time span for the scores and ranks you're requesting.
*/
timeSpan?: string;
}
export interface Params$Resource$Scores$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The collection of scores you're requesting.
*/
collection?: string;
/**
* The preferred language to use for strings returned by this method.
*/
language?: string;
/**
* The ID of the leaderboard.
*/
leaderboardId?: string;
/**
* The maximum number of leaderboard scores to return in the response. For any response, the actual number of leaderboard scores returned may be less than the specified maxResults.
*/
maxResults?: number;
/**
* The token returned by the previous request.
*/
pageToken?: string;
/**
* The time span for the scores and ranks you're requesting.
*/
timeSpan?: string;
}
export interface Params$Resource$Scores$Listwindow extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The collection of scores you're requesting.
*/
collection?: string;
/**
* The preferred language to use for strings returned by this method.
*/
language?: string;
/**
* The ID of the leaderboard.
*/
leaderboardId?: string;
/**
* The maximum number of leaderboard scores to return in the response. For any response, the actual number of leaderboard scores returned may be less than the specified maxResults.
*/
maxResults?: number;
/**
* The token returned by the previous request.
*/
pageToken?: string;
/**
* The preferred number of scores to return above the player's score. More scores may be returned if the player is at the bottom of the leaderboard; fewer may be returned if the player is at the top. Must be less than or equal to maxResults.
*/
resultsAbove?: number;
/**
* True if the top scores should be returned when the player is not in the leaderboard. Defaults to true.
*/
returnTopIfAbsent?: boolean;
/**
* The time span for the scores and ranks you're requesting.
*/
timeSpan?: string;
}
export interface Params$Resource$Scores$Submit extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The preferred language to use for strings returned by this method.
*/
language?: string;
/**
* The ID of the leaderboard.
*/
leaderboardId?: string;
/**
* The score you're submitting. The submitted score is ignored if it is worse than a previously submitted score, where worse depends on the leaderboard sort order. The meaning of the score value depends on the leaderboard format type. For fixed-point, the score represents the raw value. For time, the score represents elapsed time in milliseconds. For currency, the score represents a value in micro units.
*/
score?: string;
/**
* Additional information about the score you're submitting. Values must contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986.
*/
scoreTag?: string;
}
export interface Params$Resource$Scores$Submitmultiple extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The preferred language to use for strings returned by this method.
*/
language?: string;
/**
* Request body metadata
*/
requestBody?: Schema$PlayerScoreSubmissionList;
}
export class Resource$Snapshots {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* games.snapshots.get
* @desc Retrieves the metadata for a given snapshot ID.
* @alias games.snapshots.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.language The preferred language to use for strings returned by this method.
* @param {string} params.snapshotId The ID of the snapshot.
* @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$Snapshots$Get, options?: MethodOptions): GaxiosPromise<Schema$Snapshot>;
get(params: Params$Resource$Snapshots$Get, options: MethodOptions | BodyResponseCallback<Schema$Snapshot>, callback: BodyResponseCallback<Schema$Snapshot>): void;
get(params: Params$Resource$Snapshots$Get, callback: BodyResponseCallback<Schema$Snapshot>): void;
get(callback: BodyResponseCallback<Schema$Snapshot>): void;
/**
* games.snapshots.list
* @desc Retrieves a list of snapshots created by your application for the player corresponding to the player ID.
* @alias games.snapshots.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.language The preferred language to use for strings returned by this method.
* @param {integer=} params.maxResults The maximum number of snapshot resources to return in the response, used for paging. For any response, the actual number of snapshot resources returned may be less than the specified maxResults.
* @param {string=} params.pageToken The token returned by the previous request.
* @param {string} params.playerId A player ID. A value of me may be used in place of the authenticated player's ID.
* @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
*/
list(params?: Params$Resource$Snapshots$List, options?: MethodOptions): GaxiosPromise<Schema$SnapshotListResponse>;
list(params: Params$Resource$Snapshots$List, options: MethodOptions | BodyResponseCallback<Schema$SnapshotListResponse>, callback: BodyResponseCallback<Schema$SnapshotListResponse>): void;
list(params: Params$Resource$Snapshots$List, callback: BodyResponseCallback<Schema$SnapshotListResponse>): void;
list(callback: BodyResponseCallback<Schema$SnapshotListResponse>): void;
}
export interface Params$Resource$Snapshots$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The preferred language to use for strings returned by this method.
*/
language?: string;
/**
* The ID of the snapshot.
*/
snapshotId?: string;
}
export interface Params$Resource$Snapshots$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The preferred language to use for strings returned by this method.
*/
language?: string;
/**
* The maximum number of snapshot resources to return in the response, used for paging. For any response, the actual number of snapshot resources returned may be less than the specified maxResults.
*/
maxResults?: number;
/**
* The token returned by the previous request.
*/
pageToken?: string;
/**
* A player ID. A value of me may be used in place of the authenticated player's ID.
*/
playerId?: string;
}
export class Resource$Turnbasedmatches {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* games.turnBasedMatches.cancel
* @desc Cancel a turn-based match.
* @alias games.turnBasedMatches.cancel
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.matchId The ID of the match.
* @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
*/
cancel(params?: Params$Resource$Turnbasedmatches$Cancel, options?: MethodOptions): GaxiosPromise<void>;
cancel(params: Params$Resource$Turnbasedmatches$Cancel, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
cancel(params: Params$Resource$Turnbasedmatches$Cancel, callback: BodyResponseCallback<void>): void;
cancel(callback: BodyResponseCallback<void>): void;
/**
* games.turnBasedMatches.create
* @desc Create a turn-based match.
* @alias games.turnBasedMatches.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.language The preferred language to use for strings returned by this method.
* @param {().TurnBasedMatchCreateRequest} 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$Turnbasedmatches$Create, options?: MethodOptions): GaxiosPromise<Schema$TurnBasedMatch>;
create(params: Params$Resource$Turnbasedmatches$Create, options: MethodOptions | BodyResponseCallback<Schema$TurnBasedMatch>, callback: BodyResponseCallback<Schema$TurnBasedMatch>): void;
create(params: Params$Resource$Turnbasedmatches$Create, callback: BodyResponseCallback<Schema$TurnBasedMatch>): void;
create(callback: BodyResponseCallback<Schema$TurnBasedMatch>): void;
/**
* games.turnBasedMatches.decline
* @desc Decline an invitation to play a turn-based match.
* @alias games.turnBasedMatches.decline
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.language The preferred language to use for strings returned by this method.
* @param {string} params.matchId The ID of the match.
* @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
*/
decline(params?: Params$Resource$Turnbasedmatches$Decline, options?: MethodOptions): GaxiosPromise<Schema$TurnBasedMatch>;
decline(params: Params$Resource$Turnbasedmatches$Decline, options: MethodOptions | BodyResponseCallback<Schema$TurnBasedMatch>, callback: BodyResponseCallback<Schema$TurnBasedMatch>): void;
decline(params: Params$Resource$Turnbasedmatches$Decline, callback: BodyResponseCallback<Schema$TurnBasedMatch>): void;
decline(callback: BodyResponseCallback<Schema$TurnBasedMatch>): void;
/**
* games.turnBasedMatches.dismiss
* @desc Dismiss a turn-based match from the match list. The match will no longer show up in the list and will not generate notifications.
* @alias games.turnBasedMatches.dismiss
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.matchId The ID of the match.
* @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
*/
dismiss(params?: Params$Resource$Turnbasedmatches$Dismiss, options?: MethodOptions): GaxiosPromise<void>;
dismiss(params: Params$Resource$Turnbasedmatches$Dismiss, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
dismiss(params: Params$Resource$Turnbasedmatches$Dismiss, callback: BodyResponseCallback<void>): void;
dismiss(callback: BodyResponseCallback<void>): void;
/**
* games.turnBasedMatches.finish
* @desc Finish a turn-based match. Each player should make this call once, after all results are in. Only the player whose turn it is may make the first call to Finish, and can pass in the final match state.
* @alias games.turnBasedMatches.finish
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.language The preferred language to use for strings returned by this method.
* @param {string} params.matchId The ID of the match.
* @param {().TurnBasedMatchResults} 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
*/
finish(params?: Params$Resource$Turnbasedmatches$Finish, options?: MethodOptions): GaxiosPromise<Schema$TurnBasedMatch>;
finish(params: Params$Resource$Turnbasedmatches$Finish, options: MethodOptions | BodyResponseCallback<Schema$TurnBasedMatch>, callback: BodyResponseCallback<Schema$TurnBasedMatch>): void;
finish(params: Params$Resource$Turnbasedmatches$Finish, callback: BodyResponseCallback<Schema$TurnBasedMatch>): void;
finish(callback: BodyResponseCallback<Schema$TurnBasedMatch>): void;
/**
* games.turnBasedMatches.get
* @desc Get the data for a turn-based match.
* @alias games.turnBasedMatches.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.includeMatchData Get match data along with metadata.
* @param {string=} params.language The preferred language to use for strings returned by this method.
* @param {string} params.matchId The ID of the match.
* @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$Turnbasedmatches$Get, options?: MethodOptions): GaxiosPromise<Schema$TurnBasedMatch>;
get(params: Params$Resource$Turnbasedmatches$Get, options: MethodOptions | BodyResponseCallback<Schema$TurnBasedMatch>, callback: BodyResponseCallback<Schema$TurnBasedMatch>): void;
get(params: Params$Resource$Turnbasedmatches$Get, callback: BodyResponseCallback<Schema$TurnBasedMatch>): void;
get(callback: BodyResponseCallback<Schema$TurnBasedMatch>): void;
/**
* games.turnBasedMatches.join
* @desc Join a turn-based match.
* @alias games.turnBasedMatches.join
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.language The preferred language to use for strings returned by this method.
* @param {string} params.matchId The ID of the match.
* @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
*/
join(params?: Params$Resource$Turnbasedmatches$Join, options?: MethodOptions): GaxiosPromise<Schema$TurnBasedMatch>;
join(params: Params$Resource$Turnbasedmatches$Join, options: MethodOptions | BodyResponseCallback<Schema$TurnBasedMatch>, callback: BodyResponseCallback<Schema$TurnBasedMatch>): void;
join(params: Params$Resource$Turnbasedmatches$Join, callback: BodyResponseCallback<Schema$TurnBasedMatch>): void;
join(callback: BodyResponseCallback<Schema$TurnBasedMatch>): void;
/**
* games.turnBasedMatches.leave
* @desc Leave a turn-based match when it is not the current player's turn, without canceling the match.
* @alias games.turnBasedMatches.leave
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.language The preferred language to use for strings returned by this method.
* @param {string} params.matchId The ID of the match.
* @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
*/
leave(params?: Params$Resource$Turnbasedmatches$Leave, options?: MethodOptions): GaxiosPromise<Schema$TurnBasedMatch>;
leave(params: Params$Resource$Turnbasedmatches$Leave, options: MethodOptions | BodyResponseCallback<Schema$TurnBasedMatch>, callback: BodyResponseCallback<Schema$TurnBasedMatch>): void;
leave(params: Params$Resource$Turnbasedmatches$Leave, callback: BodyResponseCallback<Schema$TurnBasedMatch>): void;
leave(callback: BodyResponseCallback<Schema$TurnBasedMatch>): void;
/**
* games.turnBasedMatches.leaveTurn
* @desc Leave a turn-based match during the current player's turn, without canceling the match.
* @alias games.turnBasedMatches.leaveTurn
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.language The preferred language to use for strings returned by this method.
* @param {string} params.matchId The ID of the match.
* @param {integer} params.matchVersion The version of the match being updated.
* @param {string=} params.pendingParticipantId The ID of another participant who should take their turn next. If not set, the match will wait for other player(s) to join via automatching; this is only valid if automatch criteria is set on the match with remaining slots for automatched players.
* @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
*/
leaveTurn(params?: Params$Resource$Turnbasedmatches$Leaveturn, options?: MethodOptions): GaxiosPromise<Schema$TurnBasedMatch>;
leaveTurn(params: Params$Resource$Turnbasedmatches$Leaveturn, options: MethodOptions | BodyResponseCallback<Schema$TurnBasedMatch>, callback: BodyResponseCallback<Schema$TurnBasedMatch>): void;
leaveTurn(params: Params$Resource$Turnbasedmatches$Leaveturn, callback: BodyResponseCallback<Schema$TurnBasedMatch>): void;
leaveTurn(callback: BodyResponseCallback<Schema$TurnBasedMatch>): void;
/**
* games.turnBasedMatches.list
* @desc Returns turn-based matches the player is or was involved in.
* @alias games.turnBasedMatches.list
* @memberOf! ()
*
* @param {object=} params Parameters for request
* @param {boolean=} params.includeMatchData True if match data should be returned in the response. Note that not all data will necessarily be returned if include_match_data is true; the server may decide to only return data for some of the matches to limit download size for the client. The remainder of the data for these matches will be retrievable on request.
* @param {string=} params.language The preferred language to use for strings returned by this method.
* @param {integer=} params.maxCompletedMatches The maximum number of completed or canceled matches to return in the response. If not set, all matches returned could be completed or canceled.
* @param {integer=} params.maxResults The maximum number of matches to return in the response, used for paging. For any response, the actual number of matches to return may be less than the specified maxResults.
* @param {string=} params.pageToken The token returned by the previous 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
*/
list(params?: Params$Resource$Turnbasedmatches$List, options?: MethodOptions): GaxiosPromise<Schema$TurnBasedMatchList>;
list(params: Params$Resource$Turnbasedmatches$List, options: MethodOptions | BodyResponseCallback<Schema$TurnBasedMatchList>, callback: BodyResponseCallback<Schema$TurnBasedMatchList>): void;
list(params: Params$Resource$Turnbasedmatches$List, callback: BodyResponseCallback<Schema$TurnBasedMatchList>): void;
list(callback: BodyResponseCallback<Schema$TurnBasedMatchList>): void;
/**
* games.turnBasedMatches.rematch
* @desc Create a rematch of a match that was previously completed, with the same participants. This can be called by only one player on a match still in their list; the player must have called Finish first. Returns the newly created match; it will be the caller's turn.
* @alias games.turnBasedMatches.rematch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.language The preferred language to use for strings returned by this method.
* @param {string} params.matchId The ID of the match.
* @param {string=} params.requestId A randomly generated numeric ID for each request specified by the caller. This number is used at the server to ensure that the request is handled correctly across retries.
* @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
*/
rematch(params?: Params$Resource$Turnbasedmatches$Rematch, options?: MethodOptions): GaxiosPromise<Schema$TurnBasedMatchRematch>;
rematch(params: Params$Resource$Turnbasedmatches$Rematch, options: MethodOptions | BodyResponseCallback<Schema$TurnBasedMatchRematch>, callback: BodyResponseCallback<Schema$TurnBasedMatchRematch>): void;
rematch(params: Params$Resource$Turnbasedmatches$Rematch, callback: BodyResponseCallback<Schema$TurnBasedMatchRematch>): void;
rematch(callback: BodyResponseCallback<Schema$TurnBasedMatchRematch>): void;
/**
* games.turnBasedMatches.sync
* @desc Returns turn-based matches the player is or was involved in that changed since the last sync call, with the least recent changes coming first. Matches that should be removed from the local cache will have a status of MATCH_DELETED.
* @alias games.turnBasedMatches.sync
* @memberOf! ()
*
* @param {object=} params Parameters for request
* @param {boolean=} params.includeMatchData True if match data should be returned in the response. Note that not all data will necessarily be returned if include_match_data is true; the server may decide to only return data for some of the matches to limit download size for the client. The remainder of the data for these matches will be retrievable on request.
* @param {string=} params.language The preferred language to use for strings returned by this method.
* @param {integer=} params.maxCompletedMatches The maximum number of completed or canceled matches to return in the response. If not set, all matches returned could be completed or canceled.
* @param {integer=} params.maxResults The maximum number of matches to return in the response, used for paging. For any response, the actual number of matches to return may be less than the specified maxResults.
* @param {string=} params.pageToken The token returned by the previous 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
*/
sync(params?: Params$Resource$Turnbasedmatches$Sync, options?: MethodOptions): GaxiosPromise<Schema$TurnBasedMatchSync>;
sync(params: Params$Resource$Turnbasedmatches$Sync, options: MethodOptions | BodyResponseCallback<Schema$TurnBasedMatchSync>, callback: BodyResponseCallback<Schema$TurnBasedMatchSync>): void;
sync(params: Params$Resource$Turnbasedmatches$Sync, callback: BodyResponseCallback<Schema$TurnBasedMatchSync>): void;
sync(callback: BodyResponseCallback<Schema$TurnBasedMatchSync>): void;
/**
* games.turnBasedMatches.takeTurn
* @desc Commit the results of a player turn.
* @alias games.turnBasedMatches.takeTurn
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.language The preferred language to use for strings returned by this method.
* @param {string} params.matchId The ID of the match.
* @param {().TurnBasedMatchTurn} 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
*/
takeTurn(params?: Params$Resource$Turnbasedmatches$Taketurn, options?: MethodOptions): GaxiosPromise<Schema$TurnBasedMatch>;
takeTurn(params: Params$Resource$Turnbasedmatches$Taketurn, options: MethodOptions | BodyResponseCallback<Schema$TurnBasedMatch>, callback: BodyResponseCallback<Schema$TurnBasedMatch>): void;
takeTurn(params: Params$Resource$Turnbasedmatches$Taketurn, callback: BodyResponseCallback<Schema$TurnBasedMatch>): void;
takeTurn(callback: BodyResponseCallback<Schema$TurnBasedMatch>): void;
}
export interface Params$Resource$Turnbasedmatches$Cancel extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the match.
*/
matchId?: string;
}
export interface Params$Resource$Turnbasedmatches$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The preferred language to use for strings returned by this method.
*/
language?: string;
/**
* Request body metadata
*/
requestBody?: Schema$TurnBasedMatchCreateRequest;
}
export interface Params$Resource$Turnbasedmatches$Decline extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The preferred language to use for strings returned by this method.
*/
language?: string;
/**
* The ID of the match.
*/
matchId?: string;
}
export interface Params$Resource$Turnbasedmatches$Dismiss extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the match.
*/
matchId?: string;
}
export interface Params$Resource$Turnbasedmatches$Finish extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The preferred language to use for strings returned by this method.
*/
language?: string;
/**
* The ID of the match.
*/
matchId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$TurnBasedMatchResults;
}
export interface Params$Resource$Turnbasedmatches$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Get match data along with metadata.
*/
includeMatchData?: boolean;
/**
* The preferred language to use for strings returned by this method.
*/
language?: string;
/**
* The ID of the match.
*/
matchId?: string;
}
export interface Params$Resource$Turnbasedmatches$Join extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The preferred language to use for strings returned by this method.
*/
language?: string;
/**
* The ID of the match.
*/
matchId?: string;
}
export interface Params$Resource$Turnbasedmatches$Leave extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The preferred language to use for strings returned by this method.
*/
language?: string;
/**
* The ID of the match.
*/
matchId?: string;
}
export interface Params$Resource$Turnbasedmatches$Leaveturn extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The preferred language to use for strings returned by this method.
*/
language?: string;
/**
* The ID of the match.
*/
matchId?: string;
/**
* The version of the match being updated.
*/
matchVersion?: number;
/**
* The ID of another participant who should take their turn next. If not set, the match will wait for other player(s) to join via automatching; this is only valid if automatch criteria is set on the match with remaining slots for automatched players.
*/
pendingParticipantId?: string;
}
export interface Params$Resource$Turnbasedmatches$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* True if match data should be returned in the response. Note that not all data will necessarily be returned if include_match_data is true; the server may decide to only return data for some of the matches to limit download size for the client. The remainder of the data for these matches will be retrievable on request.
*/
includeMatchData?: boolean;
/**
* The preferred language to use for strings returned by this method.
*/
language?: string;
/**
* The maximum number of completed or canceled matches to return in the response. If not set, all matches returned could be completed or canceled.
*/
maxCompletedMatches?: number;
/**
* The maximum number of matches to return in the response, used for paging. For any response, the actual number of matches to return may be less than the specified maxResults.
*/
maxResults?: number;
/**
* The token returned by the previous request.
*/
pageToken?: string;
}
export interface Params$Resource$Turnbasedmatches$Rematch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The preferred language to use for strings returned by this method.
*/
language?: string;
/**
* The ID of the match.
*/
matchId?: string;
/**
* A randomly generated numeric ID for each request specified by the caller. This number is used at the server to ensure that the request is handled correctly across retries.
*/
requestId?: string;
}
export interface Params$Resource$Turnbasedmatches$Sync extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* True if match data should be returned in the response. Note that not all data will necessarily be returned if include_match_data is true; the server may decide to only return data for some of the matches to limit download size for the client. The remainder of the data for these matches will be retrievable on request.
*/
includeMatchData?: boolean;
/**
* The preferred language to use for strings returned by this method.
*/
language?: string;
/**
* The maximum number of completed or canceled matches to return in the response. If not set, all matches returned could be completed or canceled.
*/
maxCompletedMatches?: number;
/**
* The maximum number of matches to return in the response, used for paging. For any response, the actual number of matches to return may be less than the specified maxResults.
*/
maxResults?: number;
/**
* The token returned by the previous request.
*/
pageToken?: string;
}
export interface Params$Resource$Turnbasedmatches$Taketurn extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The preferred language to use for strings returned by this method.
*/
language?: string;
/**
* The ID of the match.
*/
matchId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$TurnBasedMatchTurn;
}
export {};
}