v2beta1.d.ts
260 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
/**
* 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 adexchangebuyer2_v2beta1 {
export interface Options extends GlobalOptions {
version: 'v2beta1';
}
interface StandardParameters {
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Ad Exchange Buyer API II
*
* Accesses the latest features for managing Authorized Buyers accounts, Real-Time Bidding configurations and auction metrics, and Marketplace programmatic deals.
*
* @example
* const {google} = require('googleapis');
* const adexchangebuyer2 = google.adexchangebuyer2('v2beta1');
*
* @namespace adexchangebuyer2
* @type {Function}
* @version v2beta1
* @variation v2beta1
* @param {object=} options Options for Adexchangebuyer2
*/
export class Adexchangebuyer2 {
context: APIRequestContext;
accounts: Resource$Accounts;
bidders: Resource$Bidders;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* An absolute date range, specified by its start date and end date. The supported range of dates begins 30 days before today and ends today. Validity checked upon filter set creation. If a filter set with an absolute date range is run at a later date more than 30 days after start_date, it will fail.
*/
export interface Schema$AbsoluteDateRange {
/**
* The end date of the range (inclusive). Must be within the 30 days leading up to current date, and must be equal to or after start_date.
*/
endDate?: Schema$Date;
/**
* The start date of the range (inclusive). Must be within the 30 days leading up to current date, and must be equal to or before end_date.
*/
startDate?: Schema$Date;
}
/**
* Request to accept a proposal.
*/
export interface Schema$AcceptProposalRequest {
/**
* The last known client revision number of the proposal.
*/
proposalRevision?: string | null;
}
/**
* A request for associating a deal and a creative.
*/
export interface Schema$AddDealAssociationRequest {
/**
* The association between a creative and a deal that should be added.
*/
association?: Schema$CreativeDealAssociation;
}
/**
* Request message for adding a note to a given proposal.
*/
export interface Schema$AddNoteRequest {
/**
* Details of the note to add.
*/
note?: Schema$Note;
}
/**
* Represents size of a single ad slot, or a creative.
*/
export interface Schema$AdSize {
/**
* The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
*/
height?: string | null;
/**
* The size type of the ad slot.
*/
sizeType?: string | null;
/**
* The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
*/
width?: string | null;
}
/**
* Detected ad technology provider information.
*/
export interface Schema$AdTechnologyProviders {
/**
* The detected ad technology provider IDs for this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/providers.csv for mapping of provider ID to provided name, a privacy policy URL, and a list of domains which can be attributed to the provider. If the creative contains provider IDs that are outside of those listed in the `BidRequest.adslot.consented_providers_settings.consented_providers` field on the (Google bid protocol)[https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto] and the `BidRequest.user.ext.consented_providers_settings.consented_providers` field on the (OpenRTB protocol)[https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto], and a bid is submitted with that creative for an impression that will serve to an EEA user, the bid will be filtered before the auction.
*/
detectedProviderIds?: string[] | null;
/**
* Whether the creative contains an unidentified ad technology provider. If true for a given creative, any bid submitted with that creative for an impression that will serve to an EEA user will be filtered before the auction.
*/
hasUnidentifiedProvider?: boolean | null;
}
/**
* Output only. The app type the restriction applies to for mobile device.
*/
export interface Schema$AppContext {
/**
* The app types this restriction applies to.
*/
appTypes?: string[] | null;
}
/**
* Output only. The auction type the restriction applies to.
*/
export interface Schema$AuctionContext {
/**
* The auction types this restriction applies to.
*/
auctionTypes?: string[] | null;
}
/**
* The set of metrics that are measured in numbers of bids, representing how many bids with the specified dimension values were considered eligible at each stage of the bidding funnel;
*/
export interface Schema$BidMetricsRow {
/**
* The number of bids that Ad Exchange received from the buyer.
*/
bids?: Schema$MetricValue;
/**
* The number of bids that were permitted to compete in the auction.
*/
bidsInAuction?: Schema$MetricValue;
/**
* The number of bids for which the buyer was billed.
*/
billedImpressions?: Schema$MetricValue;
/**
* The number of bids that won the auction.
*/
impressionsWon?: Schema$MetricValue;
/**
* The number of bids for which the corresponding impression was measurable for viewability (as defined by Active View).
*/
measurableImpressions?: Schema$MetricValue;
/**
* The values of all dimensions associated with metric values in this row.
*/
rowDimensions?: Schema$RowDimensions;
/**
* The number of bids for which the corresponding impression was viewable (as defined by Active View).
*/
viewableImpressions?: Schema$MetricValue;
}
/**
* The number of impressions with the specified dimension values that were considered to have no applicable bids, as described by the specified status.
*/
export interface Schema$BidResponseWithoutBidsStatusRow {
/**
* The number of impressions for which there was a bid response with the specified status.
*/
impressionCount?: Schema$MetricValue;
/**
* The values of all dimensions associated with metric values in this row.
*/
rowDimensions?: Schema$RowDimensions;
/**
* The status specifying why the bid responses were considered to have no applicable bids.
*/
status?: string | null;
}
/**
* Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID.
*/
export interface Schema$Buyer {
/**
* Authorized Buyers account ID of the buyer.
*/
accountId?: string | null;
}
/**
* The number of impressions with the specified dimension values where the corresponding bid request or bid response was not successful, as described by the specified callout status.
*/
export interface Schema$CalloutStatusRow {
/**
* The ID of the callout status. See [callout-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/callout-status-codes).
*/
calloutStatusId?: number | null;
/**
* The number of impressions for which there was a bid request or bid response with the specified callout status.
*/
impressionCount?: Schema$MetricValue;
/**
* The values of all dimensions associated with metric values in this row.
*/
rowDimensions?: Schema$RowDimensions;
}
/**
* Request to cancel an ongoing negotiation.
*/
export interface Schema$CancelNegotiationRequest {
}
/**
* A client resource represents a client buyer—an agency, a brand, or an advertiser customer of the sponsor buyer. Users associated with the client buyer have restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the client buyer. All fields are required unless otherwise specified.
*/
export interface Schema$Client {
/**
* The globally-unique numerical ID of the client. The value of this field is ignored in create and update operations.
*/
clientAccountId?: string | null;
/**
* Name used to represent this client to publishers. You may have multiple clients that map to the same entity, but for each client the combination of `clientName` and entity must be unique. You can specify this field as empty.
*/
clientName?: string | null;
/**
* Numerical identifier of the client entity. The entity can be an advertiser, a brand, or an agency. This identifier is unique among all the entities with the same type. A list of all known advertisers with their identifiers is available in the [advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt) file. A list of all known brands with their identifiers is available in the [brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt) file. A list of all known agencies with their identifiers is available in the [agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt) file.
*/
entityId?: string | null;
/**
* The name of the entity. This field is automatically fetched based on the type and ID. The value of this field is ignored in create and update operations.
*/
entityName?: string | null;
/**
* The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
*/
entityType?: string | null;
/**
* Optional arbitrary unique identifier of this client buyer from the standpoint of its Ad Exchange sponsor buyer. This field can be used to associate a client buyer with the identifier in the namespace of its sponsor buyer, lookup client buyers by that identifier and verify whether an Ad Exchange counterpart of a given client buyer already exists. If present, must be unique among all the client buyers for its Ad Exchange sponsor buyer.
*/
partnerClientId?: string | null;
/**
* The role which is assigned to the client buyer. Each role implies a set of permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`, `CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.
*/
role?: string | null;
/**
* The status of the client buyer.
*/
status?: string | null;
/**
* Whether the client buyer will be visible to sellers.
*/
visibleToSeller?: boolean | null;
}
/**
* A client user is created under a client buyer and has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client buyer. The only way a new client user can be created is via accepting an email invitation (see the accounts.clients.invitations.create method). All fields are required unless otherwise specified.
*/
export interface Schema$ClientUser {
/**
* Numerical account ID of the client buyer with which the user is associated; the buyer must be a client of the current sponsor buyer. The value of this field is ignored in an update operation.
*/
clientAccountId?: string | null;
/**
* User's email address. The value of this field is ignored in an update operation.
*/
email?: string | null;
/**
* The status of the client user.
*/
status?: string | null;
/**
* The unique numerical ID of the client user that has accepted an invitation. The value of this field is ignored in an update operation.
*/
userId?: string | null;
}
/**
* An invitation for a new client user to get access to the Authorized Buyers UI. All fields are required unless otherwise specified.
*/
export interface Schema$ClientUserInvitation {
/**
* Numerical account ID of the client buyer that the invited user is associated with. The value of this field is ignored in create operations.
*/
clientAccountId?: string | null;
/**
* The email address to which the invitation is sent. Email addresses should be unique among all client users under each sponsor buyer.
*/
email?: string | null;
/**
* The unique numerical ID of the invitation that is sent to the user. The value of this field is ignored in create operations.
*/
invitationId?: string | null;
}
/**
* Request message for indicating that the proposal's setup step is complete.
*/
export interface Schema$CompleteSetupRequest {
}
/**
* Contains information on how a buyer or seller can be reached.
*/
export interface Schema$ContactInformation {
/**
* Email address for the contact.
*/
email?: string | null;
/**
* The name of the contact.
*/
name?: string | null;
}
/**
* Output only. Shows any corrections that were applied to this creative.
*/
export interface Schema$Correction {
/**
* The contexts for the correction.
*/
contexts?: Schema$ServingContext[];
/**
* Additional details about what was corrected.
*/
details?: string[] | null;
/**
* The type of correction that was applied to the creative.
*/
type?: string | null;
}
/**
* A creative and its classification data.
*/
export interface Schema$Creative {
/**
* The account that this creative belongs to. Can be used to filter the response of the creatives.list method.
*/
accountId?: string | null;
/**
* The link to AdChoices destination page.
*/
adChoicesDestinationUrl?: string | null;
/**
* Output only. The detected ad technology providers.
*/
adTechnologyProviders?: Schema$AdTechnologyProviders;
/**
* The name of the company being advertised in the creative.
*/
advertiserName?: string | null;
/**
* The agency ID for this creative.
*/
agencyId?: string | null;
/**
* Output only. The last update timestamp of the creative via API.
*/
apiUpdateTime?: string | null;
/**
* All attributes for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method.
*/
attributes?: string[] | null;
/**
* The set of destination URLs for the creative.
*/
clickThroughUrls?: string[] | null;
/**
* Output only. Shows any corrections that were applied to this creative.
*/
corrections?: Schema$Correction[];
/**
* The buyer-defined creative ID of this creative. Can be used to filter the response of the creatives.list method.
*/
creativeId?: string | null;
/**
* Output only. The top-level deals status of this creative. If disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in serving_restrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case, it may be preferable to read from serving_restrictions directly. Can be used to filter the response of the creatives.list method.
*/
dealsStatus?: string | null;
/**
* The set of declared destination URLs for the creative.
*/
declaredClickThroughUrls?: string[] | null;
/**
* Output only. Detected advertiser IDs, if any.
*/
detectedAdvertiserIds?: string[] | null;
/**
* Output only. The detected domains for this creative.
*/
detectedDomains?: string[] | null;
/**
* Output only. The detected languages for this creative. The order is arbitrary. The codes are 2 or 5 characters and are documented at https://developers.google.com/adwords/api/docs/appendix/languagecodes.
*/
detectedLanguages?: string[] | null;
/**
* Output only. Detected product categories, if any. See the ad-product-categories.txt file in the technical documentation for a list of IDs.
*/
detectedProductCategories?: number[] | null;
/**
* Output only. Detected sensitive categories, if any. See the ad-sensitive-categories.txt file in the technical documentation for a list of IDs. You should use these IDs along with the excluded-sensitive-category field in the bid request to filter your bids.
*/
detectedSensitiveCategories?: number[] | null;
/**
* An HTML creative.
*/
html?: Schema$HtmlContent;
/**
* The set of URLs to be called to record an impression.
*/
impressionTrackingUrls?: string[] | null;
/**
* A native creative.
*/
native?: Schema$NativeContent;
/**
* Output only. The top-level open auction status of this creative. If disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in serving_restrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case, it may be preferable to read from serving_restrictions directly. Can be used to filter the response of the creatives.list method.
*/
openAuctionStatus?: string | null;
/**
* All restricted categories for the ads that may be shown from this creative.
*/
restrictedCategories?: string[] | null;
/**
* Output only. The granular status of this ad in specific contexts. A context here relates to where something ultimately serves (for example, a physical location, a platform, an HTTPS vs HTTP request, or the type of auction).
*/
servingRestrictions?: Schema$ServingRestriction[];
/**
* All vendor IDs for the ads that may be shown from this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for possible values.
*/
vendorIds?: number[] | null;
/**
* Output only. The version of this creative.
*/
version?: number | null;
/**
* A video creative.
*/
video?: Schema$VideoContent;
}
/**
* The association between a creative and a deal.
*/
export interface Schema$CreativeDealAssociation {
/**
* The account the creative belongs to.
*/
accountId?: string | null;
/**
* The ID of the creative associated with the deal.
*/
creativeId?: string | null;
/**
* The externalDealId for the deal associated with the creative.
*/
dealsId?: string | null;
}
/**
* Represents creative restrictions associated to Programmatic Guaranteed/ Preferred Deal in Ad Manager. This doesn't apply to Private Auction and AdX Preferred Deals.
*/
export interface Schema$CreativeRestrictions {
/**
* The format of the environment that the creatives will be displayed in.
*/
creativeFormat?: string | null;
creativeSpecifications?: Schema$CreativeSpecification[];
/**
* Skippable video ads allow viewers to skip ads after 5 seconds.
*/
skippableAdType?: string | null;
}
/**
* Specifies the size of the creative.
*/
export interface Schema$CreativeSize {
/**
* What formats are allowed by the publisher. If this repeated field is empty then all formats are allowed. For example, if this field contains AllowedFormatType.AUDIO then the publisher only allows an audio ad (without any video).
*/
allowedFormats?: string[] | null;
/**
* For video creatives specifies the sizes of companion ads (if present). Companion sizes may be filled in only when creative_size_type = VIDEO
*/
companionSizes?: Schema$Size[];
/**
* The creative size type.
*/
creativeSizeType?: string | null;
/**
* Output only. The native template for this creative. It will have a value only if creative_size_type = CreativeSizeType.NATIVE.
*/
nativeTemplate?: string | null;
/**
* For regular or video creative size type, specifies the size of the creative
*/
size?: Schema$Size;
/**
* The type of skippable ad for this creative. It will have a value only if creative_size_type = CreativeSizeType.VIDEO.
*/
skippableAdType?: string | null;
}
/**
* Represents information for a creative that is associated with a Programmatic Guaranteed/Preferred Deal in Ad Manager.
*/
export interface Schema$CreativeSpecification {
/**
* Companion sizes may be filled in only when this is a video creative.
*/
creativeCompanionSizes?: Schema$AdSize[];
/**
* The size of the creative.
*/
creativeSize?: Schema$AdSize;
}
/**
* The number of bids with the specified dimension values that did not win the auction (either were filtered pre-auction or lost the auction), as described by the specified creative status.
*/
export interface Schema$CreativeStatusRow {
/**
* The number of bids with the specified status.
*/
bidCount?: Schema$MetricValue;
/**
* The ID of the creative status. See [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes).
*/
creativeStatusId?: number | null;
/**
* The values of all dimensions associated with metric values in this row.
*/
rowDimensions?: Schema$RowDimensions;
}
/**
* Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs.
*/
export interface Schema$CriteriaTargeting {
/**
* A list of numeric IDs to be excluded.
*/
excludedCriteriaIds?: string[] | null;
/**
* A list of numeric IDs to be included.
*/
targetedCriteriaIds?: string[] | null;
}
/**
* Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
*/
export interface Schema$Date {
/**
* Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.
*/
day?: number | null;
/**
* Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.
*/
month?: number | null;
/**
* Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
*/
year?: number | null;
}
/**
* Daypart targeting message that specifies if the ad can be shown only during certain parts of a day/week.
*/
export interface Schema$DayPart {
/**
* The day of the week to target. If unspecified, applicable to all days.
*/
dayOfWeek?: string | null;
/**
* The ending time of the day for the ad to show (minute level granularity). The end time is exclusive. This field is not available for filtering in PQL queries.
*/
endTime?: Schema$TimeOfDay;
/**
* The starting time of day for the ad to show (minute level granularity). The start time is inclusive. This field is not available for filtering in PQL queries.
*/
startTime?: Schema$TimeOfDay;
}
/**
* Specifies the day part targeting criteria.
*/
export interface Schema$DayPartTargeting {
/**
* A list of day part targeting criterion.
*/
dayParts?: Schema$DayPart[];
/**
* The timezone to use for interpreting the day part targeting.
*/
timeZoneType?: string | null;
}
/**
* A deal represents a segment of inventory for displaying ads on. A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving.
*/
export interface Schema$Deal {
/**
* Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not required for Private Auction deals or Preferred Deals.
*/
availableEndTime?: string | null;
/**
* Optional proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (e.g., in milliseconds) will be truncated towards the start of time in seconds.
*/
availableStartTime?: string | null;
/**
* Buyer private data (hidden from seller).
*/
buyerPrivateData?: Schema$PrivateData;
/**
* The product ID from which this deal was created. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error.
*/
createProductId?: string | null;
/**
* Optional revision number of the product that the deal was created from. If present on create, and the server `product_revision` has advanced sinced the passed-in `create_product_revision`, an `ABORTED` error will be returned. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error.
*/
createProductRevision?: string | null;
/**
* Output only. The time of the deal creation.
*/
createTime?: string | null;
/**
* Output only. Specifies the creative pre-approval policy.
*/
creativePreApprovalPolicy?: string | null;
/**
* Output only. Restricitions about the creatives associated with the deal (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals in Ad Manager.
*/
creativeRestrictions?: Schema$CreativeRestrictions;
/**
* Output only. Specifies whether the creative is safeFrame compatible.
*/
creativeSafeFrameCompatibility?: string | null;
/**
* Output only. A unique deal ID for the deal (server-assigned).
*/
dealId?: string | null;
/**
* Output only. Metadata about the serving status of this deal.
*/
dealServingMetadata?: Schema$DealServingMetadata;
/**
* The negotiable terms of the deal.
*/
dealTerms?: Schema$DealTerms;
/**
* The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher.
*/
deliveryControl?: Schema$DeliveryControl;
/**
* Description for the deal terms.
*/
description?: string | null;
/**
* The name of the deal.
*/
displayName?: string | null;
/**
* Output only. The external deal ID assigned to this deal once the deal is finalized. This is the deal ID that shows up in serving/reporting etc.
*/
externalDealId?: string | null;
/**
* Output only. True, if the buyside inventory setup is complete for this deal.
*/
isSetupComplete?: boolean | null;
/**
* Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by buyer.
*/
programmaticCreativeSource?: string | null;
/**
* Output only. ID of the proposal that this deal is part of.
*/
proposalId?: string | null;
/**
* Output only. Seller contact information for the deal.
*/
sellerContacts?: Schema$ContactInformation[];
/**
* The syndication product associated with the deal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error.
*/
syndicationProduct?: string | null;
/**
* Output only. Specifies the subset of inventory targeted by the deal.
*/
targeting?: Schema$MarketplaceTargeting;
/**
* The shared targeting visible to buyers and sellers. Each shared targeting entity is AND'd together.
*/
targetingCriterion?: Schema$TargetingCriteria[];
/**
* Output only. The time when the deal was last updated.
*/
updateTime?: string | null;
/**
* The web property code for the seller copied over from the product.
*/
webPropertyCode?: string | null;
}
/**
* Tracks which parties (if any) have paused a deal. The deal is considered paused if either hasBuyerPaused or hasSellPaused is true.
*/
export interface Schema$DealPauseStatus {
/**
* The buyer's reason for pausing, if the buyer paused the deal.
*/
buyerPauseReason?: string | null;
/**
* The role of the person who first paused this deal.
*/
firstPausedBy?: string | null;
/**
* True, if the buyer has paused the deal unilaterally.
*/
hasBuyerPaused?: boolean | null;
/**
* True, if the seller has paused the deal unilaterally.
*/
hasSellerPaused?: boolean | null;
/**
* The seller's reason for pausing, if the seller paused the deal.
*/
sellerPauseReason?: string | null;
}
/**
* Message captures metadata about the serving status of a deal.
*/
export interface Schema$DealServingMetadata {
/**
* Output only. Tracks which parties (if any) have paused a deal.
*/
dealPauseStatus?: Schema$DealPauseStatus;
}
/**
* The deal terms specify the details of a Product/deal. They specify things like price per buyer, the type of pricing model (e.g., fixed price, auction) and expected impressions from the publisher.
*/
export interface Schema$DealTerms {
/**
* Visibility of the URL in bid requests. (default: BRANDED)
*/
brandingType?: string | null;
/**
* Publisher provided description for the terms.
*/
description?: string | null;
/**
* Non-binding estimate of the estimated gross spend for this deal. Can be set by buyer or seller.
*/
estimatedGrossSpend?: Schema$Price;
/**
* Non-binding estimate of the impressions served per day. Can be set by buyer or seller.
*/
estimatedImpressionsPerDay?: string | null;
/**
* The terms for guaranteed fixed price deals.
*/
guaranteedFixedPriceTerms?: Schema$GuaranteedFixedPriceTerms;
/**
* The terms for non-guaranteed auction deals.
*/
nonGuaranteedAuctionTerms?: Schema$NonGuaranteedAuctionTerms;
/**
* The terms for non-guaranteed fixed price deals.
*/
nonGuaranteedFixedPriceTerms?: Schema$NonGuaranteedFixedPriceTerms;
/**
* The time zone name. For deals with Cost Per Day billing, defines the time zone used to mark the boundaries of a day. It should be an IANA TZ name, such as "America/Los_Angeles". For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.
*/
sellerTimeZone?: string | null;
}
/**
* Message contains details about how the deals will be paced.
*/
export interface Schema$DeliveryControl {
/**
* Output only. Specified the creative blocking levels to be applied.
*/
creativeBlockingLevel?: string | null;
/**
* Output only. Specifies how the impression delivery will be paced.
*/
deliveryRateType?: string | null;
/**
* Output only. Specifies any frequency caps.
*/
frequencyCaps?: Schema$FrequencyCap[];
}
/**
* Output only. The reason and details for a disapproval.
*/
export interface Schema$Disapproval {
/**
* Additional details about the reason for disapproval.
*/
details?: string[] | null;
/**
* The categorized reason for disapproval.
*/
reason?: string | null;
}
/**
* A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
*/
export interface Schema$Empty {
}
/**
* The number of filtered bids with the specified dimension values that have the specified creative.
*/
export interface Schema$FilteredBidCreativeRow {
/**
* The number of bids with the specified creative.
*/
bidCount?: Schema$MetricValue;
/**
* The ID of the creative.
*/
creativeId?: string | null;
/**
* The values of all dimensions associated with metric values in this row.
*/
rowDimensions?: Schema$RowDimensions;
}
/**
* The number of filtered bids with the specified dimension values, among those filtered due to the requested filtering reason (i.e. creative status), that have the specified detail.
*/
export interface Schema$FilteredBidDetailRow {
/**
* The number of bids with the specified detail.
*/
bidCount?: Schema$MetricValue;
/**
* The ID of the detail. The associated value can be looked up in the dictionary file corresponding to the DetailType in the response message.
*/
detailId?: number | null;
/**
* The values of all dimensions associated with metric values in this row.
*/
rowDimensions?: Schema$RowDimensions;
}
/**
* A set of filters that is applied to a request for data. Within a filter set, an AND operation is performed across the filters represented by each field. An OR operation is performed across the filters represented by the multiple values of a repeated field, e.g., "format=VIDEO AND deal_id=12 AND (seller_network_id=34 OR seller_network_id=56)".
*/
export interface Schema$FilterSet {
/**
* An absolute date range, defined by a start date and an end date. Interpreted relative to Pacific time zone.
*/
absoluteDateRange?: Schema$AbsoluteDateRange;
/**
* The set of dimensions along which to break down the response; may be empty. If multiple dimensions are requested, the breakdown is along the Cartesian product of the requested dimensions.
*/
breakdownDimensions?: string[] | null;
/**
* The ID of the creative on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, i.e., one whose name matches the `bidders/x/accounts/x/filterSets/x pattern.
*/
creativeId?: string | null;
/**
* The ID of the deal on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, i.e., one whose name matches the `bidders/x/accounts/x/filterSets/x pattern.
*/
dealId?: string | null;
/**
* The environment on which to filter; optional.
*/
environment?: string | null;
/**
* The list of formats on which to filter; may be empty. The filters represented by multiple formats are ORed together (i.e., if non-empty, results must match any one of the formats).
*/
formats?: string[] | null;
/**
* A user-defined name of the filter set. Filter set names must be unique globally and match one of the patterns: - `bidders/x/filterSets/x (for accessing bidder-level troubleshooting data) - `bidders/x/accounts/x/filterSets/x (for accessing account-level troubleshooting data) This field is required in create operations.
*/
name?: string | null;
/**
* The list of platforms on which to filter; may be empty. The filters represented by multiple platforms are ORed together (i.e., if non-empty, results must match any one of the platforms).
*/
platforms?: string[] | null;
/**
* For Open Bidding partners only. The list of publisher identifiers on which to filter; may be empty. The filters represented by multiple publisher identifiers are ORed together.
*/
publisherIdentifiers?: string[] | null;
/**
* An open-ended realtime time range, defined by the aggregation start timestamp.
*/
realtimeTimeRange?: Schema$RealtimeTimeRange;
/**
* A relative date range, defined by an offset from today and a duration. Interpreted relative to Pacific time zone.
*/
relativeDateRange?: Schema$RelativeDateRange;
/**
* For Authorized Buyers only. The list of IDs of the seller (publisher) networks on which to filter; may be empty. The filters represented by multiple seller network IDs are ORed together (i.e., if non-empty, results must match any one of the publisher networks). See [seller-network-ids](https://developers.google.com/authorized-buyers/rtb/downloads/seller-network-ids) file for the set of existing seller network IDs.
*/
sellerNetworkIds?: number[] | null;
/**
* The granularity of time intervals if a time series breakdown is desired; optional.
*/
timeSeriesGranularity?: string | null;
}
/**
* Represents a list of targeted and excluded mobile application IDs that publishers own. Mobile application IDs are from App Store and Google Play Store. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded.
*/
export interface Schema$FirstPartyMobileApplicationTargeting {
/**
* A list of application IDs to be excluded.
*/
excludedAppIds?: string[] | null;
/**
* A list of application IDs to be included.
*/
targetedAppIds?: string[] | null;
}
/**
* Frequency cap.
*/
export interface Schema$FrequencyCap {
/**
* The maximum number of impressions that can be served to a user within the specified time period.
*/
maxImpressions?: number | null;
/**
* The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
*/
numTimeUnits?: number | null;
/**
* The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
*/
timeUnitType?: string | null;
}
/**
* Terms for Programmatic Guaranteed Deals.
*/
export interface Schema$GuaranteedFixedPriceTerms {
/**
* Fixed price for the specified buyer.
*/
fixedPrices?: Schema$PricePerBuyer[];
/**
* Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy.
*/
guaranteedImpressions?: string | null;
/**
* Count of guaranteed looks. Required for deal, optional for product.
*/
guaranteedLooks?: string | null;
/**
* Daily minimum looks for CPD deal types.
*/
minimumDailyLooks?: string | null;
}
/**
* HTML content for a creative.
*/
export interface Schema$HtmlContent {
/**
* The height of the HTML snippet in pixels.
*/
height?: number | null;
/**
* The HTML snippet that displays the ad when inserted in the web page.
*/
snippet?: string | null;
/**
* The width of the HTML snippet in pixels.
*/
width?: number | null;
}
/**
* An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved.
*/
export interface Schema$Image {
/**
* Image height in pixels.
*/
height?: number | null;
/**
* The URL of the image.
*/
url?: string | null;
/**
* Image width in pixels.
*/
width?: number | null;
}
/**
* The set of metrics that are measured in numbers of impressions, representing how many impressions with the specified dimension values were considered eligible at each stage of the bidding funnel.
*/
export interface Schema$ImpressionMetricsRow {
/**
* The number of impressions available to the buyer on Ad Exchange. In some cases this value may be unavailable.
*/
availableImpressions?: Schema$MetricValue;
/**
* The number of impressions for which Ad Exchange sent the buyer a bid request.
*/
bidRequests?: Schema$MetricValue;
/**
* The number of impressions that match the buyer's inventory pretargeting.
*/
inventoryMatches?: Schema$MetricValue;
/**
* The number of impressions for which Ad Exchange received a response from the buyer that contained at least one applicable bid.
*/
responsesWithBids?: Schema$MetricValue;
/**
* The values of all dimensions associated with metric values in this row.
*/
rowDimensions?: Schema$RowDimensions;
/**
* The number of impressions for which the buyer successfully sent a response to Ad Exchange.
*/
successfulResponses?: Schema$MetricValue;
}
/**
* Represents the size of an ad unit that can be targeted on an ad request. It only applies to Private Auction, AdX Preferred Deals and Auction Packages. This targeting does not apply to Programmatic Guaranteed and Preferred Deals in Ad Manager.
*/
export interface Schema$InventorySizeTargeting {
/**
* A list of inventory sizes to be excluded.
*/
excludedInventorySizes?: Schema$AdSize[];
/**
* A list of inventory sizes to be included.
*/
targetedInventorySizes?: Schema$AdSize[];
}
/**
* Response message for listing the metrics that are measured in number of bids.
*/
export interface Schema$ListBidMetricsResponse {
/**
* List of rows, each containing a set of bid metrics.
*/
bidMetricsRows?: Schema$BidMetricsRow[];
/**
* A token to retrieve the next page of results. Pass this value in the ListBidMetricsRequest.pageToken field in the subsequent call to the bidMetrics.list method to retrieve the next page of results.
*/
nextPageToken?: string | null;
}
/**
* Response message for listing all reasons that bid responses resulted in an error.
*/
export interface Schema$ListBidResponseErrorsResponse {
/**
* List of rows, with counts of bid responses aggregated by callout status.
*/
calloutStatusRows?: Schema$CalloutStatusRow[];
/**
* A token to retrieve the next page of results. Pass this value in the ListBidResponseErrorsRequest.pageToken field in the subsequent call to the bidResponseErrors.list method to retrieve the next page of results.
*/
nextPageToken?: string | null;
}
/**
* Response message for listing all reasons that bid responses were considered to have no applicable bids.
*/
export interface Schema$ListBidResponsesWithoutBidsResponse {
/**
* List of rows, with counts of bid responses without bids aggregated by status.
*/
bidResponseWithoutBidsStatusRows?: Schema$BidResponseWithoutBidsStatusRow[];
/**
* A token to retrieve the next page of results. Pass this value in the ListBidResponsesWithoutBidsRequest.pageToken field in the subsequent call to the bidResponsesWithoutBids.list method to retrieve the next page of results.
*/
nextPageToken?: string | null;
}
export interface Schema$ListClientsResponse {
/**
* The returned list of clients.
*/
clients?: Schema$Client[];
/**
* A token to retrieve the next page of results. Pass this value in the ListClientsRequest.pageToken field in the subsequent call to the accounts.clients.list method to retrieve the next page of results.
*/
nextPageToken?: string | null;
}
export interface Schema$ListClientUserInvitationsResponse {
/**
* The returned list of client users.
*/
invitations?: Schema$ClientUserInvitation[];
/**
* A token to retrieve the next page of results. Pass this value in the ListClientUserInvitationsRequest.pageToken field in the subsequent call to the clients.invitations.list method to retrieve the next page of results.
*/
nextPageToken?: string | null;
}
export interface Schema$ListClientUsersResponse {
/**
* A token to retrieve the next page of results. Pass this value in the ListClientUsersRequest.pageToken field in the subsequent call to the clients.invitations.list method to retrieve the next page of results.
*/
nextPageToken?: string | null;
/**
* The returned list of client users.
*/
users?: Schema$ClientUser[];
}
/**
* A response for listing creatives.
*/
export interface Schema$ListCreativesResponse {
/**
* The list of creatives.
*/
creatives?: Schema$Creative[];
/**
* A token to retrieve the next page of results. Pass this value in the ListCreativesRequest.page_token field in the subsequent call to `ListCreatives` method to retrieve the next page of results.
*/
nextPageToken?: string | null;
}
/**
* Response message for listing all creatives associated with a given filtered bid reason.
*/
export interface Schema$ListCreativeStatusBreakdownByCreativeResponse {
/**
* List of rows, with counts of bids with a given creative status aggregated by creative.
*/
filteredBidCreativeRows?: Schema$FilteredBidCreativeRow[];
/**
* A token to retrieve the next page of results. Pass this value in the ListCreativeStatusBreakdownByCreativeRequest.pageToken field in the subsequent call to the filteredBids.creatives.list method to retrieve the next page of results.
*/
nextPageToken?: string | null;
}
/**
* Response message for listing all details associated with a given filtered bid reason.
*/
export interface Schema$ListCreativeStatusBreakdownByDetailResponse {
/**
* The type of detail that the detail IDs represent.
*/
detailType?: string | null;
/**
* List of rows, with counts of bids with a given creative status aggregated by detail.
*/
filteredBidDetailRows?: Schema$FilteredBidDetailRow[];
/**
* A token to retrieve the next page of results. Pass this value in the ListCreativeStatusBreakdownByDetailRequest.pageToken field in the subsequent call to the filteredBids.details.list method to retrieve the next page of results.
*/
nextPageToken?: string | null;
}
/**
* A response for listing creative and deal associations
*/
export interface Schema$ListDealAssociationsResponse {
/**
* The list of associations.
*/
associations?: Schema$CreativeDealAssociation[];
/**
* A token to retrieve the next page of results. Pass this value in the ListDealAssociationsRequest.page_token field in the subsequent call to 'ListDealAssociation' method to retrieve the next page of results.
*/
nextPageToken?: string | null;
}
/**
* Response message for listing all reasons that bid requests were filtered and not sent to the buyer.
*/
export interface Schema$ListFilteredBidRequestsResponse {
/**
* List of rows, with counts of filtered bid requests aggregated by callout status.
*/
calloutStatusRows?: Schema$CalloutStatusRow[];
/**
* A token to retrieve the next page of results. Pass this value in the ListFilteredBidRequestsRequest.pageToken field in the subsequent call to the filteredBidRequests.list method to retrieve the next page of results.
*/
nextPageToken?: string | null;
}
/**
* Response message for listing all reasons that bids were filtered from the auction.
*/
export interface Schema$ListFilteredBidsResponse {
/**
* List of rows, with counts of filtered bids aggregated by filtering reason (i.e. creative status).
*/
creativeStatusRows?: Schema$CreativeStatusRow[];
/**
* A token to retrieve the next page of results. Pass this value in the ListFilteredBidsRequest.pageToken field in the subsequent call to the filteredBids.list method to retrieve the next page of results.
*/
nextPageToken?: string | null;
}
/**
* Response message for listing filter sets.
*/
export interface Schema$ListFilterSetsResponse {
/**
* The filter sets belonging to the buyer.
*/
filterSets?: Schema$FilterSet[];
/**
* A token to retrieve the next page of results. Pass this value in the ListFilterSetsRequest.pageToken field in the subsequent call to the accounts.filterSets.list method to retrieve the next page of results.
*/
nextPageToken?: string | null;
}
/**
* Response message for listing the metrics that are measured in number of impressions.
*/
export interface Schema$ListImpressionMetricsResponse {
/**
* List of rows, each containing a set of impression metrics.
*/
impressionMetricsRows?: Schema$ImpressionMetricsRow[];
/**
* A token to retrieve the next page of results. Pass this value in the ListImpressionMetricsRequest.pageToken field in the subsequent call to the impressionMetrics.list method to retrieve the next page of results.
*/
nextPageToken?: string | null;
}
/**
* Response message for listing all reasons that bids lost in the auction.
*/
export interface Schema$ListLosingBidsResponse {
/**
* List of rows, with counts of losing bids aggregated by loss reason (i.e. creative status).
*/
creativeStatusRows?: Schema$CreativeStatusRow[];
/**
* A token to retrieve the next page of results. Pass this value in the ListLosingBidsRequest.pageToken field in the subsequent call to the losingBids.list method to retrieve the next page of results.
*/
nextPageToken?: string | null;
}
/**
* Response message for listing all reasons for which a buyer was not billed for a winning bid.
*/
export interface Schema$ListNonBillableWinningBidsResponse {
/**
* A token to retrieve the next page of results. Pass this value in the ListNonBillableWinningBidsRequest.pageToken field in the subsequent call to the nonBillableWinningBids.list method to retrieve the next page of results.
*/
nextPageToken?: string | null;
/**
* List of rows, with counts of bids not billed aggregated by reason.
*/
nonBillableWinningBidStatusRows?: Schema$NonBillableWinningBidStatusRow[];
}
/**
* Response message for listing products visible to the buyer.
*/
export interface Schema$ListProductsResponse {
/**
* List pagination support.
*/
nextPageToken?: string | null;
/**
* The list of matching products at their head revision number.
*/
products?: Schema$Product[];
}
/**
* Response message for listing proposals.
*/
export interface Schema$ListProposalsResponse {
/**
* Continuation token for fetching the next page of results.
*/
nextPageToken?: string | null;
/**
* The list of proposals.
*/
proposals?: Schema$Proposal[];
}
/**
* Response message for profiles visible to the buyer.
*/
export interface Schema$ListPublisherProfilesResponse {
/**
* List pagination support
*/
nextPageToken?: string | null;
/**
* The list of matching publisher profiles.
*/
publisherProfiles?: Schema$PublisherProfile[];
}
/**
* Output only. The Geo criteria the restriction applies to.
*/
export interface Schema$LocationContext {
/**
* IDs representing the geo location for this context. Please refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs.
*/
geoCriteriaIds?: number[] | null;
}
/**
* Targeting represents different criteria that can be used by advertisers to target ad inventory. For example, they can choose to target ad requests only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise.
*/
export interface Schema$MarketplaceTargeting {
/**
* Geo criteria IDs to be included/excluded.
*/
geoTargeting?: Schema$CriteriaTargeting;
/**
* Inventory sizes to be included/excluded.
*/
inventorySizeTargeting?: Schema$InventorySizeTargeting;
/**
* Placement targeting information, e.g., URL, mobile applications.
*/
placementTargeting?: Schema$PlacementTargeting;
/**
* Technology targeting information, e.g., operating system, device category.
*/
technologyTargeting?: Schema$TechnologyTargeting;
/**
* Video targeting information.
*/
videoTargeting?: Schema$VideoTargeting;
}
/**
* A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (i.e. when sampled).
*/
export interface Schema$MetricValue {
/**
* The expected value of the metric.
*/
value?: string | null;
/**
* The variance (i.e. square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the desired size of the confidence interval (e.g. for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value
*/
variance?: string | null;
}
/**
* Mobile application targeting settings.
*/
export interface Schema$MobileApplicationTargeting {
/**
* Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
*/
firstPartyTargeting?: Schema$FirstPartyMobileApplicationTargeting;
}
/**
* Represents an amount of money with its currency type.
*/
export interface Schema$Money {
/**
* The 3-letter currency code defined in ISO 4217.
*/
currencyCode?: string | null;
/**
* Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
*/
nanos?: number | null;
/**
* The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
*/
units?: string | null;
}
/**
* Native content for a creative.
*/
export interface Schema$NativeContent {
/**
* The name of the advertiser or sponsor, to be displayed in the ad creative.
*/
advertiserName?: string | null;
/**
* The app icon, for app download ads.
*/
appIcon?: Schema$Image;
/**
* A long description of the ad.
*/
body?: string | null;
/**
* A label for the button that the user is supposed to click.
*/
callToAction?: string | null;
/**
* The URL that the browser/SDK will load when the user clicks the ad.
*/
clickLinkUrl?: string | null;
/**
* The URL to use for click tracking.
*/
clickTrackingUrl?: string | null;
/**
* A short title for the ad.
*/
headline?: string | null;
/**
* A large image.
*/
image?: Schema$Image;
/**
* A smaller image, for the advertiser's logo.
*/
logo?: Schema$Image;
/**
* The price of the promoted app including currency info.
*/
priceDisplayText?: string | null;
/**
* The app rating in the app store. Must be in the range [0-5].
*/
starRating?: number | null;
/**
* The URL to the app store to purchase/download the promoted app.
*/
storeUrl?: string | null;
/**
* The URL to fetch a native video ad.
*/
videoUrl?: string | null;
}
/**
* The number of winning bids with the specified dimension values for which the buyer was not billed, as described by the specified status.
*/
export interface Schema$NonBillableWinningBidStatusRow {
/**
* The number of bids with the specified status.
*/
bidCount?: Schema$MetricValue;
/**
* The values of all dimensions associated with metric values in this row.
*/
rowDimensions?: Schema$RowDimensions;
/**
* The status specifying why the winning bids were not billed.
*/
status?: string | null;
}
/**
* Terms for Private Auctions. Note that Private Auctions can be created only by the seller, but they can be returned in a get or list request.
*/
export interface Schema$NonGuaranteedAuctionTerms {
/**
* True if open auction buyers are allowed to compete with invited buyers in this private auction.
*/
autoOptimizePrivateAuction?: boolean | null;
/**
* Reserve price for the specified buyer.
*/
reservePricesPerBuyer?: Schema$PricePerBuyer[];
}
/**
* Terms for Preferred Deals. Note that Preferred Deals cannot be created via the API at this time, but can be returned in a get or list request.
*/
export interface Schema$NonGuaranteedFixedPriceTerms {
/**
* Fixed price for the specified buyer.
*/
fixedPrices?: Schema$PricePerBuyer[];
}
/**
* A proposal may be associated to several notes.
*/
export interface Schema$Note {
/**
* Output only. The timestamp for when this note was created.
*/
createTime?: string | null;
/**
* Output only. The role of the person (buyer/seller) creating the note.
*/
creatorRole?: string | null;
/**
* The actual note to attach. (max-length: 1024 unicode code units) Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error.
*/
note?: string | null;
/**
* Output only. The unique ID for the note.
*/
noteId?: string | null;
/**
* Output only. The revision number of the proposal when the note is created.
*/
proposalRevision?: string | null;
}
/**
* Represents targeting information for operating systems.
*/
export interface Schema$OperatingSystemTargeting {
/**
* IDs of operating systems to be included/excluded.
*/
operatingSystemCriteria?: Schema$CriteriaTargeting;
/**
* IDs of operating system versions to be included/excluded.
*/
operatingSystemVersionCriteria?: Schema$CriteriaTargeting;
}
/**
* Request message to pause serving for an already-finalized proposal.
*/
export interface Schema$PauseProposalRequest {
/**
* The reason why the proposal is being paused. This human readable message will be displayed in the seller's UI. (Max length: 1000 unicode code units.)
*/
reason?: string | null;
}
/**
* Represents targeting about where the ads can appear, e.g., certain sites or mobile applications. Different placement targeting types will be logically OR'ed.
*/
export interface Schema$PlacementTargeting {
/**
* Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
*/
mobileApplicationTargeting?: Schema$MobileApplicationTargeting;
/**
* URLs to be included/excluded.
*/
urlTargeting?: Schema$UrlTargeting;
}
/**
* Output only. The type of platform the restriction applies to.
*/
export interface Schema$PlatformContext {
/**
* The platforms this restriction applies to.
*/
platforms?: string[] | null;
}
/**
* Represents a price and a pricing type for a product / deal.
*/
export interface Schema$Price {
/**
* The actual price with currency specified.
*/
amount?: Schema$Money;
/**
* The pricing type for the deal/product. (default: CPM)
*/
pricingType?: string | null;
}
/**
* Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in a product can become 0 or 1 deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
*/
export interface Schema$PricePerBuyer {
/**
* The list of advertisers for this price when associated with this buyer. If empty, all advertisers with this buyer pay this price.
*/
advertiserIds?: string[] | null;
/**
* The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
*/
buyer?: Schema$Buyer;
/**
* The specified price.
*/
price?: Schema$Price;
}
/**
* Buyers are allowed to store certain types of private data in a proposal/deal.
*/
export interface Schema$PrivateData {
/**
* A buyer or seller specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units).
*/
referenceId?: string | null;
}
/**
* Note: this resource requires whitelisting for access. Please contact your account manager for access to Marketplace resources. A product is a segment of inventory that a seller wishes to sell. It is associated with certain terms and targeting information which helps the buyer know more about the inventory.
*/
export interface Schema$Product {
/**
* The proposed end time for the deal. The field will be truncated to the order of seconds during serving.
*/
availableEndTime?: string | null;
/**
* Inventory availability dates. The start time will be truncated to seconds during serving. Thus, a field specified as 3:23:34.456 (HH:mm:ss.SSS) will be truncated to 3:23:34 when serving.
*/
availableStartTime?: string | null;
/**
* Creation time.
*/
createTime?: string | null;
/**
* Optional contact information for the creator of this product.
*/
creatorContacts?: Schema$ContactInformation[];
/**
* The display name for this product as set by the seller.
*/
displayName?: string | null;
/**
* If the creator has already signed off on the product, then the buyer can finalize the deal by accepting the product as is. When copying to a proposal, if any of the terms are changed, then auto_finalize is automatically set to false.
*/
hasCreatorSignedOff?: boolean | null;
/**
* The unique ID for the product.
*/
productId?: string | null;
/**
* The revision number of the product (auto-assigned by Marketplace).
*/
productRevision?: string | null;
/**
* An ID which can be used by the Publisher Profile API to get more information about the seller that created this product.
*/
publisherProfileId?: string | null;
/**
* Information about the seller that created this product.
*/
seller?: Schema$Seller;
/**
* The syndication product associated with the deal.
*/
syndicationProduct?: string | null;
/**
* Targeting that is shared between the buyer and the seller. Each targeting criterion has a specified key and for each key there is a list of inclusion value or exclusion values.
*/
targetingCriterion?: Schema$TargetingCriteria[];
/**
* The negotiable terms of the deal.
*/
terms?: Schema$DealTerms;
/**
* Time of last update.
*/
updateTime?: string | null;
/**
* The web-property code for the seller. This needs to be copied as is when adding a new deal to a proposal.
*/
webPropertyCode?: string | null;
}
/**
* Note: this resource requires whitelisting for access. Please contact your account manager for access to Marketplace resources. Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer and contains deals which are served. Note: you can not update, create, or otherwise modify Private Auction or Preferred Deals deals through the API. Fields are updatable unless noted otherwise.
*/
export interface Schema$Proposal {
/**
* Output only. Reference to the buyer that will get billed for this proposal.
*/
billedBuyer?: Schema$Buyer;
/**
* Reference to the buyer on the proposal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error.
*/
buyer?: Schema$Buyer;
/**
* Contact information for the buyer.
*/
buyerContacts?: Schema$ContactInformation[];
/**
* Private data for buyer. (hidden from seller).
*/
buyerPrivateData?: Schema$PrivateData;
/**
* The deals associated with this proposal. For Private Auction proposals (whose deals have NonGuaranteedAuctionTerms), there will only be one deal.
*/
deals?: Schema$Deal[];
/**
* The name for the proposal.
*/
displayName?: string | null;
/**
* Output only. True if the proposal is being renegotiated.
*/
isRenegotiating?: boolean | null;
/**
* Output only. True, if the buyside inventory setup is complete for this proposal.
*/
isSetupComplete?: boolean | null;
/**
* Output only. The role of the last user that either updated the proposal or left a comment.
*/
lastUpdaterOrCommentorRole?: string | null;
/**
* Output only. The notes associated with this proposal.
*/
notes?: Schema$Note[];
/**
* Output only. Indicates whether the buyer/seller created the proposal.
*/
originatorRole?: string | null;
/**
* Output only. Private auction ID if this proposal is a private auction proposal.
*/
privateAuctionId?: string | null;
/**
* Output only. The unique ID of the proposal.
*/
proposalId?: string | null;
/**
* Output only. The revision number for the proposal. Each update to the proposal or the deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
*/
proposalRevision?: string | null;
/**
* Output only. The current state of the proposal.
*/
proposalState?: string | null;
/**
* Reference to the seller on the proposal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error.
*/
seller?: Schema$Seller;
/**
* Output only. Contact information for the seller.
*/
sellerContacts?: Schema$ContactInformation[];
/**
* Output only. The time when the proposal was last revised.
*/
updateTime?: string | null;
}
/**
* Note: this resource requires whitelisting for access. Please contact your account manager for access to Marketplace resources. Represents a publisher profile in Marketplace. All fields are read only. All string fields are free-form text entered by the publisher unless noted otherwise.
*/
export interface Schema$PublisherProfile {
/**
* Description on the publisher's audience.
*/
audienceDescription?: string | null;
/**
* Statement explaining what's unique about publisher's business, and why buyers should partner with the publisher.
*/
buyerPitchStatement?: string | null;
/**
* Contact information for direct reservation deals. This is free text entered by the publisher and may include information like names, phone numbers and email addresses.
*/
directDealsContact?: string | null;
/**
* Name of the publisher profile.
*/
displayName?: string | null;
/**
* The list of domains represented in this publisher profile. Empty if this is a parent profile. These are top private domains, meaning that these will not contain a string like "photos.google.co.uk/123", but will instead contain "google.co.uk".
*/
domains?: string[] | null;
/**
* URL to publisher's Google+ page.
*/
googlePlusUrl?: string | null;
/**
* A Google public URL to the logo for this publisher profile. The logo is stored as a PNG, JPG, or GIF image.
*/
logoUrl?: string | null;
/**
* URL to additional marketing and sales materials.
*/
mediaKitUrl?: string | null;
/**
* Overview of the publisher.
*/
overview?: string | null;
/**
* Contact information for programmatic deals. This is free text entered by the publisher and may include information like names, phone numbers and email addresses.
*/
programmaticDealsContact?: string | null;
/**
* Unique ID for publisher profile.
*/
publisherProfileId?: string | null;
/**
* URL to a publisher rate card.
*/
rateCardInfoUrl?: string | null;
/**
* URL to a sample content page.
*/
samplePageUrl?: string | null;
/**
* Seller of the publisher profile.
*/
seller?: Schema$Seller;
/**
* Up to three key metrics and rankings. Max 100 characters each. For example "#1 Mobile News Site for 20 Straight Months".
*/
topHeadlines?: string[] | null;
}
/**
* An open-ended realtime time range specified by the start timestamp. For filter sets that specify a realtime time range RTB metrics continue to be aggregated throughout the lifetime of the filter set.
*/
export interface Schema$RealtimeTimeRange {
/**
* The start timestamp of the real-time RTB metrics aggregation.
*/
startTimestamp?: string | null;
}
/**
* A relative date range, specified by an offset and a duration. The supported range of dates begins 30 days before today and ends today, i.e., the limits for these values are: offset_days >= 0 duration_days >= 1 offset_days + duration_days <= 30
*/
export interface Schema$RelativeDateRange {
/**
* The number of days in the requested date range, e.g., for a range spanning today: 1. For a range spanning the last 7 days: 7.
*/
durationDays?: number | null;
/**
* The end date of the filter set, specified as the number of days before today, e.g., for a range where the last date is today: 0.
*/
offsetDays?: number | null;
}
/**
* A request for removing the association between a deal and a creative.
*/
export interface Schema$RemoveDealAssociationRequest {
/**
* The association between a creative and a deal that should be removed.
*/
association?: Schema$CreativeDealAssociation;
}
/**
* Request message to resume (unpause) serving for an already-finalized proposal.
*/
export interface Schema$ResumeProposalRequest {
}
/**
* A response may include multiple rows, breaking down along various dimensions. Encapsulates the values of all dimensions for a given row.
*/
export interface Schema$RowDimensions {
/**
* The publisher identifier for this row, if a breakdown by [BreakdownDimension.PUBLISHER_IDENTIFIER](https://developers.google.com/authorized-buyers/apis/reference/rest/v2beta1/bidders.accounts.filterSets#FilterSet.BreakdownDimension) was requested.
*/
publisherIdentifier?: string | null;
/**
* The time interval that this row represents.
*/
timeInterval?: Schema$TimeInterval;
}
/**
* Output only. A security context.
*/
export interface Schema$SecurityContext {
/**
* The security types in this context.
*/
securities?: string[] | null;
}
/**
* Represents a seller of inventory. Each seller is identified by a unique Ad Manager account ID.
*/
export interface Schema$Seller {
/**
* The unique ID for the seller. The seller fills in this field. The seller account ID is then available to buyer in the product.
*/
accountId?: string | null;
/**
* Optional sub-account ID for the seller.
*/
subAccountId?: string | null;
}
/**
* The serving context for this restriction.
*/
export interface Schema$ServingContext {
/**
* Matches all contexts.
*/
all?: string | null;
/**
* Matches impressions for a particular app type.
*/
appType?: Schema$AppContext;
/**
* Matches impressions for a particular auction type.
*/
auctionType?: Schema$AuctionContext;
/**
* Matches impressions coming from users *or* publishers in a specific location.
*/
location?: Schema$LocationContext;
/**
* Matches impressions coming from a particular platform.
*/
platform?: Schema$PlatformContext;
/**
* Matches impressions for a particular security type.
*/
securityType?: Schema$SecurityContext;
}
/**
* Output only. A representation of the status of an ad in a specific context. A context here relates to where something ultimately serves (for example, a user or publisher geo, a platform, an HTTPS vs HTTP request, or the type of auction).
*/
export interface Schema$ServingRestriction {
/**
* The contexts for the restriction.
*/
contexts?: Schema$ServingContext[];
/**
* Disapproval bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method.
*/
disapproval?: Schema$Disapproval;
/**
* Any disapprovals bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method. Deprecated; please use disapproval field instead.
*/
disapprovalReasons?: Schema$Disapproval[];
/**
* The status of the creative in this context (for example, it has been explicitly disapproved or is pending review).
*/
status?: string | null;
}
/**
* Message depicting the size of the creative. The units of width and height depend on the type of the targeting.
*/
export interface Schema$Size {
/**
* The height of the creative.
*/
height?: number | null;
/**
* The width of the creative
*/
width?: number | null;
}
/**
* A request for stopping notifications for changes to creative Status.
*/
export interface Schema$StopWatchingCreativeRequest {
}
/**
* Advertisers can target different attributes of an ad slot. For example, they can choose to show ads only if the user is in the U.S. Such targeting criteria can be specified as part of Shared Targeting.
*/
export interface Schema$TargetingCriteria {
/**
* The list of values to exclude from targeting. Each value is AND'd together.
*/
exclusions?: Schema$TargetingValue[];
/**
* The list of value to include as part of the targeting. Each value is OR'd together.
*/
inclusions?: Schema$TargetingValue[];
/**
* The key representing the shared targeting criterion. Targeting criteria defined by Google ad servers will begin with GOOG_. Third parties may define their own keys. A list of permissible keys along with the acceptable values will be provided as part of the external documentation.
*/
key?: string | null;
}
/**
* A polymorphic targeting value used as part of Shared Targeting.
*/
export interface Schema$TargetingValue {
/**
* The creative size value to include/exclude. Filled in when key = GOOG_CREATIVE_SIZE
*/
creativeSizeValue?: Schema$CreativeSize;
/**
* The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING. The definition of this targeting is derived from the structure used by Ad Manager.
*/
dayPartTargetingValue?: Schema$DayPartTargeting;
/**
* The long value to include/exclude.
*/
longValue?: string | null;
/**
* The string value to include/exclude.
*/
stringValue?: string | null;
}
/**
* Represents targeting about various types of technology.
*/
export interface Schema$TechnologyTargeting {
/**
* IDs of device capabilities to be included/excluded.
*/
deviceCapabilityTargeting?: Schema$CriteriaTargeting;
/**
* IDs of device categories to be included/excluded.
*/
deviceCategoryTargeting?: Schema$CriteriaTargeting;
/**
* Operating system related targeting information.
*/
operatingSystemTargeting?: Schema$OperatingSystemTargeting;
}
/**
* An interval of time, with an absolute start and end.
*/
export interface Schema$TimeInterval {
/**
* The timestamp marking the end of the range (exclusive) for which data is included.
*/
endTime?: string | null;
/**
* The timestamp marking the start of the range (inclusive) for which data is included.
*/
startTime?: string | null;
}
/**
* Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.
*/
export interface Schema$TimeOfDay {
/**
* Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
*/
hours?: number | null;
/**
* Minutes of hour of day. Must be from 0 to 59.
*/
minutes?: number | null;
/**
* Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
*/
nanos?: number | null;
/**
* Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
*/
seconds?: number | null;
}
/**
* Represents a list of targeted and excluded URLs (e.g., google.com). For Private Auction and AdX Preferred Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply.
*/
export interface Schema$UrlTargeting {
/**
* A list of URLs to be excluded.
*/
excludedUrls?: string[] | null;
/**
* A list of URLs to be included.
*/
targetedUrls?: string[] | null;
}
/**
* Video content for a creative.
*/
export interface Schema$VideoContent {
/**
* The URL to fetch a video ad.
*/
videoUrl?: string | null;
/**
* The contents of a VAST document for a video ad. This document should conform to the VAST 2.0 or 3.0 standard.
*/
videoVastXml?: string | null;
}
/**
* Represents targeting information about video.
*/
export interface Schema$VideoTargeting {
/**
* A list of video positions to be excluded. Position types can either be included or excluded (XOR).
*/
excludedPositionTypes?: string[] | null;
/**
* A list of video positions to be included. When the included list is present, the excluded list must be empty. When the excluded list is present, the included list must be empty.
*/
targetedPositionTypes?: string[] | null;
}
/**
* A request for watching changes to creative Status.
*/
export interface Schema$WatchCreativeRequest {
/**
* The Pub/Sub topic to publish notifications to. This topic must already exist and must give permission to ad-exchange-buyside-reports@google.com to write to the topic. This should be the full resource name in "projects/{project_id}/topics/{topic_id}" format.
*/
topic?: string | null;
}
export class Resource$Accounts {
context: APIRequestContext;
clients: Resource$Accounts$Clients;
creatives: Resource$Accounts$Creatives;
finalizedProposals: Resource$Accounts$Finalizedproposals;
products: Resource$Accounts$Products;
proposals: Resource$Accounts$Proposals;
publisherProfiles: Resource$Accounts$Publisherprofiles;
constructor(context: APIRequestContext);
}
export class Resource$Accounts$Clients {
context: APIRequestContext;
invitations: Resource$Accounts$Clients$Invitations;
users: Resource$Accounts$Clients$Users;
constructor(context: APIRequestContext);
/**
* adexchangebuyer2.accounts.clients.create
* @desc Creates a new client buyer.
* @alias adexchangebuyer2.accounts.clients.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountId Unique numerical account ID for the buyer of which the client buyer is a customer; the sponsor buyer to create a client for. (required)
* @param {().Client} 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$Accounts$Clients$Create, options?: MethodOptions): GaxiosPromise<Schema$Client>;
create(params: Params$Resource$Accounts$Clients$Create, options: MethodOptions | BodyResponseCallback<Schema$Client>, callback: BodyResponseCallback<Schema$Client>): void;
create(params: Params$Resource$Accounts$Clients$Create, callback: BodyResponseCallback<Schema$Client>): void;
create(callback: BodyResponseCallback<Schema$Client>): void;
/**
* adexchangebuyer2.accounts.clients.get
* @desc Gets a client buyer with a given client account ID.
* @alias adexchangebuyer2.accounts.clients.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountId Numerical account ID of the client's sponsor buyer. (required)
* @param {string} params.clientAccountId Numerical account ID of the client buyer to retrieve. (required)
* @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$Accounts$Clients$Get, options?: MethodOptions): GaxiosPromise<Schema$Client>;
get(params: Params$Resource$Accounts$Clients$Get, options: MethodOptions | BodyResponseCallback<Schema$Client>, callback: BodyResponseCallback<Schema$Client>): void;
get(params: Params$Resource$Accounts$Clients$Get, callback: BodyResponseCallback<Schema$Client>): void;
get(callback: BodyResponseCallback<Schema$Client>): void;
/**
* adexchangebuyer2.accounts.clients.list
* @desc Lists all the clients for the current sponsor buyer.
* @alias adexchangebuyer2.accounts.clients.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountId Unique numerical account ID of the sponsor buyer to list the clients for.
* @param {integer=} params.pageSize Requested page size. The server may return fewer clients than requested. If unspecified, the server will pick an appropriate default.
* @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListClientsResponse.nextPageToken returned from the previous call to the accounts.clients.list method.
* @param {string=} params.partnerClientId Optional unique identifier (from the standpoint of an Ad Exchange sponsor buyer partner) of the client to return. If specified, at most one client will be returned in the response.
* @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$Accounts$Clients$List, options?: MethodOptions): GaxiosPromise<Schema$ListClientsResponse>;
list(params: Params$Resource$Accounts$Clients$List, options: MethodOptions | BodyResponseCallback<Schema$ListClientsResponse>, callback: BodyResponseCallback<Schema$ListClientsResponse>): void;
list(params: Params$Resource$Accounts$Clients$List, callback: BodyResponseCallback<Schema$ListClientsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListClientsResponse>): void;
/**
* adexchangebuyer2.accounts.clients.update
* @desc Updates an existing client buyer.
* @alias adexchangebuyer2.accounts.clients.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountId Unique numerical account ID for the buyer of which the client buyer is a customer; the sponsor buyer to update a client for. (required)
* @param {string} params.clientAccountId Unique numerical account ID of the client to update. (required)
* @param {().Client} 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$Accounts$Clients$Update, options?: MethodOptions): GaxiosPromise<Schema$Client>;
update(params: Params$Resource$Accounts$Clients$Update, options: MethodOptions | BodyResponseCallback<Schema$Client>, callback: BodyResponseCallback<Schema$Client>): void;
update(params: Params$Resource$Accounts$Clients$Update, callback: BodyResponseCallback<Schema$Client>): void;
update(callback: BodyResponseCallback<Schema$Client>): void;
}
export interface Params$Resource$Accounts$Clients$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Unique numerical account ID for the buyer of which the client buyer is a customer; the sponsor buyer to create a client for. (required)
*/
accountId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Client;
}
export interface Params$Resource$Accounts$Clients$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Numerical account ID of the client's sponsor buyer. (required)
*/
accountId?: string;
/**
* Numerical account ID of the client buyer to retrieve. (required)
*/
clientAccountId?: string;
}
export interface Params$Resource$Accounts$Clients$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Unique numerical account ID of the sponsor buyer to list the clients for.
*/
accountId?: string;
/**
* Requested page size. The server may return fewer clients than requested. If unspecified, the server will pick an appropriate default.
*/
pageSize?: number;
/**
* A token identifying a page of results the server should return. Typically, this is the value of ListClientsResponse.nextPageToken returned from the previous call to the accounts.clients.list method.
*/
pageToken?: string;
/**
* Optional unique identifier (from the standpoint of an Ad Exchange sponsor buyer partner) of the client to return. If specified, at most one client will be returned in the response.
*/
partnerClientId?: string;
}
export interface Params$Resource$Accounts$Clients$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Unique numerical account ID for the buyer of which the client buyer is a customer; the sponsor buyer to update a client for. (required)
*/
accountId?: string;
/**
* Unique numerical account ID of the client to update. (required)
*/
clientAccountId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Client;
}
export class Resource$Accounts$Clients$Invitations {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* adexchangebuyer2.accounts.clients.invitations.create
* @desc Creates and sends out an email invitation to access an Ad Exchange client buyer account.
* @alias adexchangebuyer2.accounts.clients.invitations.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountId Numerical account ID of the client's sponsor buyer. (required)
* @param {string} params.clientAccountId Numerical account ID of the client buyer that the user should be associated with. (required)
* @param {().ClientUserInvitation} 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$Accounts$Clients$Invitations$Create, options?: MethodOptions): GaxiosPromise<Schema$ClientUserInvitation>;
create(params: Params$Resource$Accounts$Clients$Invitations$Create, options: MethodOptions | BodyResponseCallback<Schema$ClientUserInvitation>, callback: BodyResponseCallback<Schema$ClientUserInvitation>): void;
create(params: Params$Resource$Accounts$Clients$Invitations$Create, callback: BodyResponseCallback<Schema$ClientUserInvitation>): void;
create(callback: BodyResponseCallback<Schema$ClientUserInvitation>): void;
/**
* adexchangebuyer2.accounts.clients.invitations.get
* @desc Retrieves an existing client user invitation.
* @alias adexchangebuyer2.accounts.clients.invitations.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountId Numerical account ID of the client's sponsor buyer. (required)
* @param {string} params.clientAccountId Numerical account ID of the client buyer that the user invitation to be retrieved is associated with. (required)
* @param {string} params.invitationId Numerical identifier of the user invitation to retrieve. (required)
* @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$Accounts$Clients$Invitations$Get, options?: MethodOptions): GaxiosPromise<Schema$ClientUserInvitation>;
get(params: Params$Resource$Accounts$Clients$Invitations$Get, options: MethodOptions | BodyResponseCallback<Schema$ClientUserInvitation>, callback: BodyResponseCallback<Schema$ClientUserInvitation>): void;
get(params: Params$Resource$Accounts$Clients$Invitations$Get, callback: BodyResponseCallback<Schema$ClientUserInvitation>): void;
get(callback: BodyResponseCallback<Schema$ClientUserInvitation>): void;
/**
* adexchangebuyer2.accounts.clients.invitations.list
* @desc Lists all the client users invitations for a client with a given account ID.
* @alias adexchangebuyer2.accounts.clients.invitations.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountId Numerical account ID of the client's sponsor buyer. (required)
* @param {string} params.clientAccountId Numerical account ID of the client buyer to list invitations for. (required) You must either specify a string representation of a numerical account identifier or the `-` character to list all the invitations for all the clients of a given sponsor buyer.
* @param {integer=} params.pageSize Requested page size. Server may return fewer clients than requested. If unspecified, server will pick an appropriate default.
* @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListClientUserInvitationsResponse.nextPageToken returned from the previous call to the clients.invitations.list 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
*/
list(params?: Params$Resource$Accounts$Clients$Invitations$List, options?: MethodOptions): GaxiosPromise<Schema$ListClientUserInvitationsResponse>;
list(params: Params$Resource$Accounts$Clients$Invitations$List, options: MethodOptions | BodyResponseCallback<Schema$ListClientUserInvitationsResponse>, callback: BodyResponseCallback<Schema$ListClientUserInvitationsResponse>): void;
list(params: Params$Resource$Accounts$Clients$Invitations$List, callback: BodyResponseCallback<Schema$ListClientUserInvitationsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListClientUserInvitationsResponse>): void;
}
export interface Params$Resource$Accounts$Clients$Invitations$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Numerical account ID of the client's sponsor buyer. (required)
*/
accountId?: string;
/**
* Numerical account ID of the client buyer that the user should be associated with. (required)
*/
clientAccountId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$ClientUserInvitation;
}
export interface Params$Resource$Accounts$Clients$Invitations$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Numerical account ID of the client's sponsor buyer. (required)
*/
accountId?: string;
/**
* Numerical account ID of the client buyer that the user invitation to be retrieved is associated with. (required)
*/
clientAccountId?: string;
/**
* Numerical identifier of the user invitation to retrieve. (required)
*/
invitationId?: string;
}
export interface Params$Resource$Accounts$Clients$Invitations$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Numerical account ID of the client's sponsor buyer. (required)
*/
accountId?: string;
/**
* Numerical account ID of the client buyer to list invitations for. (required) You must either specify a string representation of a numerical account identifier or the `-` character to list all the invitations for all the clients of a given sponsor buyer.
*/
clientAccountId?: string;
/**
* Requested page size. Server may return fewer clients than requested. If unspecified, server will pick an appropriate default.
*/
pageSize?: number;
/**
* A token identifying a page of results the server should return. Typically, this is the value of ListClientUserInvitationsResponse.nextPageToken returned from the previous call to the clients.invitations.list method.
*/
pageToken?: string;
}
export class Resource$Accounts$Clients$Users {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* adexchangebuyer2.accounts.clients.users.get
* @desc Retrieves an existing client user.
* @alias adexchangebuyer2.accounts.clients.users.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountId Numerical account ID of the client's sponsor buyer. (required)
* @param {string} params.clientAccountId Numerical account ID of the client buyer that the user to be retrieved is associated with. (required)
* @param {string} params.userId Numerical identifier of the user to retrieve. (required)
* @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$Accounts$Clients$Users$Get, options?: MethodOptions): GaxiosPromise<Schema$ClientUser>;
get(params: Params$Resource$Accounts$Clients$Users$Get, options: MethodOptions | BodyResponseCallback<Schema$ClientUser>, callback: BodyResponseCallback<Schema$ClientUser>): void;
get(params: Params$Resource$Accounts$Clients$Users$Get, callback: BodyResponseCallback<Schema$ClientUser>): void;
get(callback: BodyResponseCallback<Schema$ClientUser>): void;
/**
* adexchangebuyer2.accounts.clients.users.list
* @desc Lists all the known client users for a specified sponsor buyer account ID.
* @alias adexchangebuyer2.accounts.clients.users.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountId Numerical account ID of the sponsor buyer of the client to list users for. (required)
* @param {string} params.clientAccountId The account ID of the client buyer to list users for. (required) You must specify either a string representation of a numerical account identifier or the `-` character to list all the client users for all the clients of a given sponsor buyer.
* @param {integer=} params.pageSize Requested page size. The server may return fewer clients than requested. If unspecified, the server will pick an appropriate default.
* @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListClientUsersResponse.nextPageToken returned from the previous call to the accounts.clients.users.list 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
*/
list(params?: Params$Resource$Accounts$Clients$Users$List, options?: MethodOptions): GaxiosPromise<Schema$ListClientUsersResponse>;
list(params: Params$Resource$Accounts$Clients$Users$List, options: MethodOptions | BodyResponseCallback<Schema$ListClientUsersResponse>, callback: BodyResponseCallback<Schema$ListClientUsersResponse>): void;
list(params: Params$Resource$Accounts$Clients$Users$List, callback: BodyResponseCallback<Schema$ListClientUsersResponse>): void;
list(callback: BodyResponseCallback<Schema$ListClientUsersResponse>): void;
/**
* adexchangebuyer2.accounts.clients.users.update
* @desc Updates an existing client user. Only the user status can be changed on update.
* @alias adexchangebuyer2.accounts.clients.users.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountId Numerical account ID of the client's sponsor buyer. (required)
* @param {string} params.clientAccountId Numerical account ID of the client buyer that the user to be retrieved is associated with. (required)
* @param {string} params.userId Numerical identifier of the user to retrieve. (required)
* @param {().ClientUser} 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$Accounts$Clients$Users$Update, options?: MethodOptions): GaxiosPromise<Schema$ClientUser>;
update(params: Params$Resource$Accounts$Clients$Users$Update, options: MethodOptions | BodyResponseCallback<Schema$ClientUser>, callback: BodyResponseCallback<Schema$ClientUser>): void;
update(params: Params$Resource$Accounts$Clients$Users$Update, callback: BodyResponseCallback<Schema$ClientUser>): void;
update(callback: BodyResponseCallback<Schema$ClientUser>): void;
}
export interface Params$Resource$Accounts$Clients$Users$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Numerical account ID of the client's sponsor buyer. (required)
*/
accountId?: string;
/**
* Numerical account ID of the client buyer that the user to be retrieved is associated with. (required)
*/
clientAccountId?: string;
/**
* Numerical identifier of the user to retrieve. (required)
*/
userId?: string;
}
export interface Params$Resource$Accounts$Clients$Users$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Numerical account ID of the sponsor buyer of the client to list users for. (required)
*/
accountId?: string;
/**
* The account ID of the client buyer to list users for. (required) You must specify either a string representation of a numerical account identifier or the `-` character to list all the client users for all the clients of a given sponsor buyer.
*/
clientAccountId?: string;
/**
* Requested page size. The server may return fewer clients than requested. If unspecified, the server will pick an appropriate default.
*/
pageSize?: number;
/**
* A token identifying a page of results the server should return. Typically, this is the value of ListClientUsersResponse.nextPageToken returned from the previous call to the accounts.clients.users.list method.
*/
pageToken?: string;
}
export interface Params$Resource$Accounts$Clients$Users$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Numerical account ID of the client's sponsor buyer. (required)
*/
accountId?: string;
/**
* Numerical account ID of the client buyer that the user to be retrieved is associated with. (required)
*/
clientAccountId?: string;
/**
* Numerical identifier of the user to retrieve. (required)
*/
userId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$ClientUser;
}
export class Resource$Accounts$Creatives {
context: APIRequestContext;
dealAssociations: Resource$Accounts$Creatives$Dealassociations;
constructor(context: APIRequestContext);
/**
* adexchangebuyer2.accounts.creatives.create
* @desc Creates a creative.
* @alias adexchangebuyer2.accounts.creatives.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountId The account that this creative belongs to. Can be used to filter the response of the creatives.list method.
* @param {string=} params.duplicateIdMode Indicates if multiple creatives can share an ID or not. Default is NO_DUPLICATES (one ID per creative).
* @param {().Creative} 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$Accounts$Creatives$Create, options?: MethodOptions): GaxiosPromise<Schema$Creative>;
create(params: Params$Resource$Accounts$Creatives$Create, options: MethodOptions | BodyResponseCallback<Schema$Creative>, callback: BodyResponseCallback<Schema$Creative>): void;
create(params: Params$Resource$Accounts$Creatives$Create, callback: BodyResponseCallback<Schema$Creative>): void;
create(callback: BodyResponseCallback<Schema$Creative>): void;
/**
* adexchangebuyer2.accounts.creatives.get
* @desc Gets a creative.
* @alias adexchangebuyer2.accounts.creatives.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountId The account the creative belongs to.
* @param {string} params.creativeId The ID of the creative to retrieve.
* @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$Accounts$Creatives$Get, options?: MethodOptions): GaxiosPromise<Schema$Creative>;
get(params: Params$Resource$Accounts$Creatives$Get, options: MethodOptions | BodyResponseCallback<Schema$Creative>, callback: BodyResponseCallback<Schema$Creative>): void;
get(params: Params$Resource$Accounts$Creatives$Get, callback: BodyResponseCallback<Schema$Creative>): void;
get(callback: BodyResponseCallback<Schema$Creative>): void;
/**
* adexchangebuyer2.accounts.creatives.list
* @desc Lists creatives.
* @alias adexchangebuyer2.accounts.creatives.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountId The account to list the creatives from. Specify "-" to list all creatives the current user has access to.
* @param {integer=} params.pageSize Requested page size. The server may return fewer creatives than requested (due to timeout constraint) even if more are available via another call. If unspecified, server will pick an appropriate default. Acceptable values are 1 to 1000, inclusive.
* @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListCreativesResponse.next_page_token returned from the previous call to 'ListCreatives' method.
* @param {string=} params.query An optional query string to filter creatives. If no filter is specified, all active creatives will be returned. <p>Supported queries are: <ul> <li>accountId=<i>account_id_string</i> <li>creativeId=<i>creative_id_string</i> <li>dealsStatus: {approved, conditionally_approved, disapproved, not_checked} <li>openAuctionStatus: {approved, conditionally_approved, disapproved, not_checked} <li>attribute: {a numeric attribute from the list of attributes} <li>disapprovalReason: {a reason from DisapprovalReason} </ul> Example: 'accountId=12345 AND (dealsStatus:disapproved AND disapprovalReason:unacceptable_content) OR attribute:47'
* @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$Accounts$Creatives$List, options?: MethodOptions): GaxiosPromise<Schema$ListCreativesResponse>;
list(params: Params$Resource$Accounts$Creatives$List, options: MethodOptions | BodyResponseCallback<Schema$ListCreativesResponse>, callback: BodyResponseCallback<Schema$ListCreativesResponse>): void;
list(params: Params$Resource$Accounts$Creatives$List, callback: BodyResponseCallback<Schema$ListCreativesResponse>): void;
list(callback: BodyResponseCallback<Schema$ListCreativesResponse>): void;
/**
* adexchangebuyer2.accounts.creatives.stopWatching
* @desc Stops watching a creative. Will stop push notifications being sent to the topics when the creative changes status.
* @alias adexchangebuyer2.accounts.creatives.stopWatching
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountId The account of the creative to stop notifications for.
* @param {string} params.creativeId The creative ID of the creative to stop notifications for. Specify "-" to specify stopping account level notifications.
* @param {().StopWatchingCreativeRequest} 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
*/
stopWatching(params?: Params$Resource$Accounts$Creatives$Stopwatching, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
stopWatching(params: Params$Resource$Accounts$Creatives$Stopwatching, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
stopWatching(params: Params$Resource$Accounts$Creatives$Stopwatching, callback: BodyResponseCallback<Schema$Empty>): void;
stopWatching(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* adexchangebuyer2.accounts.creatives.update
* @desc Updates a creative.
* @alias adexchangebuyer2.accounts.creatives.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountId The account that this creative belongs to. Can be used to filter the response of the creatives.list method.
* @param {string} params.creativeId The buyer-defined creative ID of this creative. Can be used to filter the response of the creatives.list method.
* @param {().Creative} 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$Accounts$Creatives$Update, options?: MethodOptions): GaxiosPromise<Schema$Creative>;
update(params: Params$Resource$Accounts$Creatives$Update, options: MethodOptions | BodyResponseCallback<Schema$Creative>, callback: BodyResponseCallback<Schema$Creative>): void;
update(params: Params$Resource$Accounts$Creatives$Update, callback: BodyResponseCallback<Schema$Creative>): void;
update(callback: BodyResponseCallback<Schema$Creative>): void;
/**
* adexchangebuyer2.accounts.creatives.watch
* @desc Watches a creative. Will result in push notifications being sent to the topic when the creative changes status.
* @alias adexchangebuyer2.accounts.creatives.watch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountId The account of the creative to watch.
* @param {string} params.creativeId The creative ID to watch for status changes. Specify "-" to watch all creatives under the above account. If both creative-level and account-level notifications are sent, only a single notification will be sent to the creative-level notification topic.
* @param {().WatchCreativeRequest} 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
*/
watch(params?: Params$Resource$Accounts$Creatives$Watch, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
watch(params: Params$Resource$Accounts$Creatives$Watch, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
watch(params: Params$Resource$Accounts$Creatives$Watch, callback: BodyResponseCallback<Schema$Empty>): void;
watch(callback: BodyResponseCallback<Schema$Empty>): void;
}
export interface Params$Resource$Accounts$Creatives$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The account that this creative belongs to. Can be used to filter the response of the creatives.list method.
*/
accountId?: string;
/**
* Indicates if multiple creatives can share an ID or not. Default is NO_DUPLICATES (one ID per creative).
*/
duplicateIdMode?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Creative;
}
export interface Params$Resource$Accounts$Creatives$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The account the creative belongs to.
*/
accountId?: string;
/**
* The ID of the creative to retrieve.
*/
creativeId?: string;
}
export interface Params$Resource$Accounts$Creatives$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The account to list the creatives from. Specify "-" to list all creatives the current user has access to.
*/
accountId?: string;
/**
* Requested page size. The server may return fewer creatives than requested (due to timeout constraint) even if more are available via another call. If unspecified, server will pick an appropriate default. Acceptable values are 1 to 1000, inclusive.
*/
pageSize?: number;
/**
* A token identifying a page of results the server should return. Typically, this is the value of ListCreativesResponse.next_page_token returned from the previous call to 'ListCreatives' method.
*/
pageToken?: string;
/**
* An optional query string to filter creatives. If no filter is specified, all active creatives will be returned. <p>Supported queries are: <ul> <li>accountId=<i>account_id_string</i> <li>creativeId=<i>creative_id_string</i> <li>dealsStatus: {approved, conditionally_approved, disapproved, not_checked} <li>openAuctionStatus: {approved, conditionally_approved, disapproved, not_checked} <li>attribute: {a numeric attribute from the list of attributes} <li>disapprovalReason: {a reason from DisapprovalReason} </ul> Example: 'accountId=12345 AND (dealsStatus:disapproved AND disapprovalReason:unacceptable_content) OR attribute:47'
*/
query?: string;
}
export interface Params$Resource$Accounts$Creatives$Stopwatching extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The account of the creative to stop notifications for.
*/
accountId?: string;
/**
* The creative ID of the creative to stop notifications for. Specify "-" to specify stopping account level notifications.
*/
creativeId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$StopWatchingCreativeRequest;
}
export interface Params$Resource$Accounts$Creatives$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The account that this creative belongs to. Can be used to filter the response of the creatives.list method.
*/
accountId?: string;
/**
* The buyer-defined creative ID of this creative. Can be used to filter the response of the creatives.list method.
*/
creativeId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Creative;
}
export interface Params$Resource$Accounts$Creatives$Watch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The account of the creative to watch.
*/
accountId?: string;
/**
* The creative ID to watch for status changes. Specify "-" to watch all creatives under the above account. If both creative-level and account-level notifications are sent, only a single notification will be sent to the creative-level notification topic.
*/
creativeId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$WatchCreativeRequest;
}
export class Resource$Accounts$Creatives$Dealassociations {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* adexchangebuyer2.accounts.creatives.dealAssociations.add
* @desc Associate an existing deal with a creative.
* @alias adexchangebuyer2.accounts.creatives.dealAssociations.add
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountId The account the creative belongs to.
* @param {string} params.creativeId The ID of the creative associated with the deal.
* @param {().AddDealAssociationRequest} 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
*/
add(params?: Params$Resource$Accounts$Creatives$Dealassociations$Add, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
add(params: Params$Resource$Accounts$Creatives$Dealassociations$Add, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
add(params: Params$Resource$Accounts$Creatives$Dealassociations$Add, callback: BodyResponseCallback<Schema$Empty>): void;
add(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* adexchangebuyer2.accounts.creatives.dealAssociations.list
* @desc List all creative-deal associations.
* @alias adexchangebuyer2.accounts.creatives.dealAssociations.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountId The account to list the associations from. Specify "-" to list all creatives the current user has access to.
* @param {string} params.creativeId The creative ID to list the associations from. Specify "-" to list all creatives under the above account.
* @param {integer=} params.pageSize Requested page size. Server may return fewer associations than requested. If unspecified, server will pick an appropriate default.
* @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListDealAssociationsResponse.next_page_token returned from the previous call to 'ListDealAssociations' method.
* @param {string=} params.query An optional query string to filter deal associations. If no filter is specified, all associations will be returned. Supported queries are: <ul> <li>accountId=<i>account_id_string</i> <li>creativeId=<i>creative_id_string</i> <li>dealsId=<i>deals_id_string</i> <li>dealsStatus:{approved, conditionally_approved, disapproved, not_checked} <li>openAuctionStatus:{approved, conditionally_approved, disapproved, not_checked} </ul> Example: 'dealsId=12345 AND dealsStatus:disapproved'
* @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$Accounts$Creatives$Dealassociations$List, options?: MethodOptions): GaxiosPromise<Schema$ListDealAssociationsResponse>;
list(params: Params$Resource$Accounts$Creatives$Dealassociations$List, options: MethodOptions | BodyResponseCallback<Schema$ListDealAssociationsResponse>, callback: BodyResponseCallback<Schema$ListDealAssociationsResponse>): void;
list(params: Params$Resource$Accounts$Creatives$Dealassociations$List, callback: BodyResponseCallback<Schema$ListDealAssociationsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListDealAssociationsResponse>): void;
/**
* adexchangebuyer2.accounts.creatives.dealAssociations.remove
* @desc Remove the association between a deal and a creative.
* @alias adexchangebuyer2.accounts.creatives.dealAssociations.remove
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountId The account the creative belongs to.
* @param {string} params.creativeId The ID of the creative associated with the deal.
* @param {().RemoveDealAssociationRequest} 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$Accounts$Creatives$Dealassociations$Remove, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
remove(params: Params$Resource$Accounts$Creatives$Dealassociations$Remove, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
remove(params: Params$Resource$Accounts$Creatives$Dealassociations$Remove, callback: BodyResponseCallback<Schema$Empty>): void;
remove(callback: BodyResponseCallback<Schema$Empty>): void;
}
export interface Params$Resource$Accounts$Creatives$Dealassociations$Add extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The account the creative belongs to.
*/
accountId?: string;
/**
* The ID of the creative associated with the deal.
*/
creativeId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$AddDealAssociationRequest;
}
export interface Params$Resource$Accounts$Creatives$Dealassociations$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The account to list the associations from. Specify "-" to list all creatives the current user has access to.
*/
accountId?: string;
/**
* The creative ID to list the associations from. Specify "-" to list all creatives under the above account.
*/
creativeId?: string;
/**
* Requested page size. Server may return fewer associations than requested. If unspecified, server will pick an appropriate default.
*/
pageSize?: number;
/**
* A token identifying a page of results the server should return. Typically, this is the value of ListDealAssociationsResponse.next_page_token returned from the previous call to 'ListDealAssociations' method.
*/
pageToken?: string;
/**
* An optional query string to filter deal associations. If no filter is specified, all associations will be returned. Supported queries are: <ul> <li>accountId=<i>account_id_string</i> <li>creativeId=<i>creative_id_string</i> <li>dealsId=<i>deals_id_string</i> <li>dealsStatus:{approved, conditionally_approved, disapproved, not_checked} <li>openAuctionStatus:{approved, conditionally_approved, disapproved, not_checked} </ul> Example: 'dealsId=12345 AND dealsStatus:disapproved'
*/
query?: string;
}
export interface Params$Resource$Accounts$Creatives$Dealassociations$Remove extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The account the creative belongs to.
*/
accountId?: string;
/**
* The ID of the creative associated with the deal.
*/
creativeId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$RemoveDealAssociationRequest;
}
export class Resource$Accounts$Finalizedproposals {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* adexchangebuyer2.accounts.finalizedProposals.list
* @desc List finalized proposals, regardless if a proposal is being renegotiated. A filter expression (PQL query) may be specified to filter the results. The notes will not be returned.
* @alias adexchangebuyer2.accounts.finalizedProposals.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountId Account ID of the buyer.
* @param {string=} params.filter An optional PQL filter query used to query for proposals. Nested repeated fields, such as proposal.deals.targetingCriterion, cannot be filtered.
* @param {string=} params.filterSyntax Syntax the filter is written in. Current implementation defaults to PQL but in the future it will be LIST_FILTER.
* @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
* @param {string=} params.pageToken The page token as returned from ListProposalsResponse.
* @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$Accounts$Finalizedproposals$List, options?: MethodOptions): GaxiosPromise<Schema$ListProposalsResponse>;
list(params: Params$Resource$Accounts$Finalizedproposals$List, options: MethodOptions | BodyResponseCallback<Schema$ListProposalsResponse>, callback: BodyResponseCallback<Schema$ListProposalsResponse>): void;
list(params: Params$Resource$Accounts$Finalizedproposals$List, callback: BodyResponseCallback<Schema$ListProposalsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListProposalsResponse>): void;
}
export interface Params$Resource$Accounts$Finalizedproposals$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Account ID of the buyer.
*/
accountId?: string;
/**
* An optional PQL filter query used to query for proposals. Nested repeated fields, such as proposal.deals.targetingCriterion, cannot be filtered.
*/
filter?: string;
/**
* Syntax the filter is written in. Current implementation defaults to PQL but in the future it will be LIST_FILTER.
*/
filterSyntax?: string;
/**
* Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
*/
pageSize?: number;
/**
* The page token as returned from ListProposalsResponse.
*/
pageToken?: string;
}
export class Resource$Accounts$Products {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* adexchangebuyer2.accounts.products.get
* @desc Gets the requested product by ID.
* @alias adexchangebuyer2.accounts.products.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountId Account ID of the buyer.
* @param {string} params.productId The ID for the product to get the head revision for.
* @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$Accounts$Products$Get, options?: MethodOptions): GaxiosPromise<Schema$Product>;
get(params: Params$Resource$Accounts$Products$Get, options: MethodOptions | BodyResponseCallback<Schema$Product>, callback: BodyResponseCallback<Schema$Product>): void;
get(params: Params$Resource$Accounts$Products$Get, callback: BodyResponseCallback<Schema$Product>): void;
get(callback: BodyResponseCallback<Schema$Product>): void;
/**
* adexchangebuyer2.accounts.products.list
* @desc List all products visible to the buyer (optionally filtered by the specified PQL query).
* @alias adexchangebuyer2.accounts.products.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountId Account ID of the buyer.
* @param {string=} params.filter An optional PQL query used to query for products. See https://developers.google.com/ad-manager/docs/pqlreference for documentation about PQL and examples. Nested repeated fields, such as product.targetingCriterion.inclusions, cannot be filtered.
* @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
* @param {string=} params.pageToken The page token as returned from ListProductsResponse.
* @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$Accounts$Products$List, options?: MethodOptions): GaxiosPromise<Schema$ListProductsResponse>;
list(params: Params$Resource$Accounts$Products$List, options: MethodOptions | BodyResponseCallback<Schema$ListProductsResponse>, callback: BodyResponseCallback<Schema$ListProductsResponse>): void;
list(params: Params$Resource$Accounts$Products$List, callback: BodyResponseCallback<Schema$ListProductsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListProductsResponse>): void;
}
export interface Params$Resource$Accounts$Products$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Account ID of the buyer.
*/
accountId?: string;
/**
* The ID for the product to get the head revision for.
*/
productId?: string;
}
export interface Params$Resource$Accounts$Products$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Account ID of the buyer.
*/
accountId?: string;
/**
* An optional PQL query used to query for products. See https://developers.google.com/ad-manager/docs/pqlreference for documentation about PQL and examples. Nested repeated fields, such as product.targetingCriterion.inclusions, cannot be filtered.
*/
filter?: string;
/**
* Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
*/
pageSize?: number;
/**
* The page token as returned from ListProductsResponse.
*/
pageToken?: string;
}
export class Resource$Accounts$Proposals {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* adexchangebuyer2.accounts.proposals.accept
* @desc Mark the proposal as accepted at the given revision number. If the number does not match the server's revision number an `ABORTED` error message will be returned. This call updates the proposal_state from `PROPOSED` to `BUYER_ACCEPTED`, or from `SELLER_ACCEPTED` to `FINALIZED`.
* @alias adexchangebuyer2.accounts.proposals.accept
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountId Account ID of the buyer.
* @param {string} params.proposalId The ID of the proposal to accept.
* @param {().AcceptProposalRequest} 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
*/
accept(params?: Params$Resource$Accounts$Proposals$Accept, options?: MethodOptions): GaxiosPromise<Schema$Proposal>;
accept(params: Params$Resource$Accounts$Proposals$Accept, options: MethodOptions | BodyResponseCallback<Schema$Proposal>, callback: BodyResponseCallback<Schema$Proposal>): void;
accept(params: Params$Resource$Accounts$Proposals$Accept, callback: BodyResponseCallback<Schema$Proposal>): void;
accept(callback: BodyResponseCallback<Schema$Proposal>): void;
/**
* adexchangebuyer2.accounts.proposals.addNote
* @desc Create a new note and attach it to the proposal. The note is assigned a unique ID by the server. The proposal revision number will not increase when associated with a new note.
* @alias adexchangebuyer2.accounts.proposals.addNote
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountId Account ID of the buyer.
* @param {string} params.proposalId The ID of the proposal to attach the note to.
* @param {().AddNoteRequest} 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
*/
addNote(params?: Params$Resource$Accounts$Proposals$Addnote, options?: MethodOptions): GaxiosPromise<Schema$Note>;
addNote(params: Params$Resource$Accounts$Proposals$Addnote, options: MethodOptions | BodyResponseCallback<Schema$Note>, callback: BodyResponseCallback<Schema$Note>): void;
addNote(params: Params$Resource$Accounts$Proposals$Addnote, callback: BodyResponseCallback<Schema$Note>): void;
addNote(callback: BodyResponseCallback<Schema$Note>): void;
/**
* adexchangebuyer2.accounts.proposals.cancelNegotiation
* @desc Cancel an ongoing negotiation on a proposal. This does not cancel or end serving for the deals if the proposal has been finalized, but only cancels a negotiation unilaterally.
* @alias adexchangebuyer2.accounts.proposals.cancelNegotiation
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountId Account ID of the buyer.
* @param {string} params.proposalId The ID of the proposal to cancel negotiation for.
* @param {().CancelNegotiationRequest} 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
*/
cancelNegotiation(params?: Params$Resource$Accounts$Proposals$Cancelnegotiation, options?: MethodOptions): GaxiosPromise<Schema$Proposal>;
cancelNegotiation(params: Params$Resource$Accounts$Proposals$Cancelnegotiation, options: MethodOptions | BodyResponseCallback<Schema$Proposal>, callback: BodyResponseCallback<Schema$Proposal>): void;
cancelNegotiation(params: Params$Resource$Accounts$Proposals$Cancelnegotiation, callback: BodyResponseCallback<Schema$Proposal>): void;
cancelNegotiation(callback: BodyResponseCallback<Schema$Proposal>): void;
/**
* adexchangebuyer2.accounts.proposals.completeSetup
* @desc Update the given proposal to indicate that setup has been completed. This method is called by the buyer when the line items have been created on their end for a finalized proposal and all the required creatives have been uploaded using the creatives API. This call updates the `is_setup_completed` bit on the proposal and also notifies the seller. The server will advance the revision number of the most recent proposal.
* @alias adexchangebuyer2.accounts.proposals.completeSetup
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountId Account ID of the buyer.
* @param {string} params.proposalId The ID of the proposal to mark as setup completed.
* @param {().CompleteSetupRequest} 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
*/
completeSetup(params?: Params$Resource$Accounts$Proposals$Completesetup, options?: MethodOptions): GaxiosPromise<Schema$Proposal>;
completeSetup(params: Params$Resource$Accounts$Proposals$Completesetup, options: MethodOptions | BodyResponseCallback<Schema$Proposal>, callback: BodyResponseCallback<Schema$Proposal>): void;
completeSetup(params: Params$Resource$Accounts$Proposals$Completesetup, callback: BodyResponseCallback<Schema$Proposal>): void;
completeSetup(callback: BodyResponseCallback<Schema$Proposal>): void;
/**
* adexchangebuyer2.accounts.proposals.create
* @desc Create the given proposal. Each created proposal and any deals it contains are assigned a unique ID by the server.
* @alias adexchangebuyer2.accounts.proposals.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountId Account ID of the buyer.
* @param {().Proposal} 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$Accounts$Proposals$Create, options?: MethodOptions): GaxiosPromise<Schema$Proposal>;
create(params: Params$Resource$Accounts$Proposals$Create, options: MethodOptions | BodyResponseCallback<Schema$Proposal>, callback: BodyResponseCallback<Schema$Proposal>): void;
create(params: Params$Resource$Accounts$Proposals$Create, callback: BodyResponseCallback<Schema$Proposal>): void;
create(callback: BodyResponseCallback<Schema$Proposal>): void;
/**
* adexchangebuyer2.accounts.proposals.get
* @desc Gets a proposal given its ID. The proposal is returned at its head revision.
* @alias adexchangebuyer2.accounts.proposals.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountId Account ID of the buyer.
* @param {string} params.proposalId The unique ID of the proposal
* @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$Accounts$Proposals$Get, options?: MethodOptions): GaxiosPromise<Schema$Proposal>;
get(params: Params$Resource$Accounts$Proposals$Get, options: MethodOptions | BodyResponseCallback<Schema$Proposal>, callback: BodyResponseCallback<Schema$Proposal>): void;
get(params: Params$Resource$Accounts$Proposals$Get, callback: BodyResponseCallback<Schema$Proposal>): void;
get(callback: BodyResponseCallback<Schema$Proposal>): void;
/**
* adexchangebuyer2.accounts.proposals.list
* @desc List proposals. A filter expression (PQL query) may be specified to filter the results. To retrieve all finalized proposals, regardless if a proposal is being renegotiated, see the FinalizedProposals resource. Note that Bidder/ChildSeat relationships differ from the usual behavior. A Bidder account can only see its child seats' proposals by specifying the ChildSeat's accountId in the request path.
* @alias adexchangebuyer2.accounts.proposals.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountId Account ID of the buyer.
* @param {string=} params.filter An optional PQL filter query used to query for proposals. Nested repeated fields, such as proposal.deals.targetingCriterion, cannot be filtered.
* @param {string=} params.filterSyntax Syntax the filter is written in. Current implementation defaults to PQL but in the future it will be LIST_FILTER.
* @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
* @param {string=} params.pageToken The page token as returned from ListProposalsResponse.
* @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$Accounts$Proposals$List, options?: MethodOptions): GaxiosPromise<Schema$ListProposalsResponse>;
list(params: Params$Resource$Accounts$Proposals$List, options: MethodOptions | BodyResponseCallback<Schema$ListProposalsResponse>, callback: BodyResponseCallback<Schema$ListProposalsResponse>): void;
list(params: Params$Resource$Accounts$Proposals$List, callback: BodyResponseCallback<Schema$ListProposalsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListProposalsResponse>): void;
/**
* adexchangebuyer2.accounts.proposals.pause
* @desc Update the given proposal to pause serving. This method will set the `DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to true for all deals in the proposal. It is a no-op to pause an already-paused proposal. It is an error to call PauseProposal for a proposal that is not finalized or renegotiating.
* @alias adexchangebuyer2.accounts.proposals.pause
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountId Account ID of the buyer.
* @param {string} params.proposalId The ID of the proposal to pause.
* @param {().PauseProposalRequest} 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
*/
pause(params?: Params$Resource$Accounts$Proposals$Pause, options?: MethodOptions): GaxiosPromise<Schema$Proposal>;
pause(params: Params$Resource$Accounts$Proposals$Pause, options: MethodOptions | BodyResponseCallback<Schema$Proposal>, callback: BodyResponseCallback<Schema$Proposal>): void;
pause(params: Params$Resource$Accounts$Proposals$Pause, callback: BodyResponseCallback<Schema$Proposal>): void;
pause(callback: BodyResponseCallback<Schema$Proposal>): void;
/**
* adexchangebuyer2.accounts.proposals.resume
* @desc Update the given proposal to resume serving. This method will set the `DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to false for all deals in the proposal. Note that if the `has_seller_paused` bit is also set, serving will not resume until the seller also resumes. It is a no-op to resume an already-running proposal. It is an error to call ResumeProposal for a proposal that is not finalized or renegotiating.
* @alias adexchangebuyer2.accounts.proposals.resume
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountId Account ID of the buyer.
* @param {string} params.proposalId The ID of the proposal to resume.
* @param {().ResumeProposalRequest} 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
*/
resume(params?: Params$Resource$Accounts$Proposals$Resume, options?: MethodOptions): GaxiosPromise<Schema$Proposal>;
resume(params: Params$Resource$Accounts$Proposals$Resume, options: MethodOptions | BodyResponseCallback<Schema$Proposal>, callback: BodyResponseCallback<Schema$Proposal>): void;
resume(params: Params$Resource$Accounts$Proposals$Resume, callback: BodyResponseCallback<Schema$Proposal>): void;
resume(callback: BodyResponseCallback<Schema$Proposal>): void;
/**
* adexchangebuyer2.accounts.proposals.update
* @desc Update the given proposal at the client known revision number. If the server revision has advanced since the passed-in `proposal.proposal_revision`, an `ABORTED` error message will be returned. Only the buyer-modifiable fields of the proposal will be updated. Note that the deals in the proposal will be updated to match the passed-in copy. If a passed-in deal does not have a `deal_id`, the server will assign a new unique ID and create the deal. If passed-in deal has a `deal_id`, it will be updated to match the passed-in copy. Any existing deals not present in the passed-in proposal will be deleted. It is an error to pass in a deal with a `deal_id` not present at head.
* @alias adexchangebuyer2.accounts.proposals.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountId Account ID of the buyer.
* @param {string} params.proposalId The unique ID of the proposal.
* @param {().Proposal} 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$Accounts$Proposals$Update, options?: MethodOptions): GaxiosPromise<Schema$Proposal>;
update(params: Params$Resource$Accounts$Proposals$Update, options: MethodOptions | BodyResponseCallback<Schema$Proposal>, callback: BodyResponseCallback<Schema$Proposal>): void;
update(params: Params$Resource$Accounts$Proposals$Update, callback: BodyResponseCallback<Schema$Proposal>): void;
update(callback: BodyResponseCallback<Schema$Proposal>): void;
}
export interface Params$Resource$Accounts$Proposals$Accept extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Account ID of the buyer.
*/
accountId?: string;
/**
* The ID of the proposal to accept.
*/
proposalId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$AcceptProposalRequest;
}
export interface Params$Resource$Accounts$Proposals$Addnote extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Account ID of the buyer.
*/
accountId?: string;
/**
* The ID of the proposal to attach the note to.
*/
proposalId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$AddNoteRequest;
}
export interface Params$Resource$Accounts$Proposals$Cancelnegotiation extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Account ID of the buyer.
*/
accountId?: string;
/**
* The ID of the proposal to cancel negotiation for.
*/
proposalId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CancelNegotiationRequest;
}
export interface Params$Resource$Accounts$Proposals$Completesetup extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Account ID of the buyer.
*/
accountId?: string;
/**
* The ID of the proposal to mark as setup completed.
*/
proposalId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CompleteSetupRequest;
}
export interface Params$Resource$Accounts$Proposals$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Account ID of the buyer.
*/
accountId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Proposal;
}
export interface Params$Resource$Accounts$Proposals$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Account ID of the buyer.
*/
accountId?: string;
/**
* The unique ID of the proposal
*/
proposalId?: string;
}
export interface Params$Resource$Accounts$Proposals$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Account ID of the buyer.
*/
accountId?: string;
/**
* An optional PQL filter query used to query for proposals. Nested repeated fields, such as proposal.deals.targetingCriterion, cannot be filtered.
*/
filter?: string;
/**
* Syntax the filter is written in. Current implementation defaults to PQL but in the future it will be LIST_FILTER.
*/
filterSyntax?: string;
/**
* Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
*/
pageSize?: number;
/**
* The page token as returned from ListProposalsResponse.
*/
pageToken?: string;
}
export interface Params$Resource$Accounts$Proposals$Pause extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Account ID of the buyer.
*/
accountId?: string;
/**
* The ID of the proposal to pause.
*/
proposalId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$PauseProposalRequest;
}
export interface Params$Resource$Accounts$Proposals$Resume extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Account ID of the buyer.
*/
accountId?: string;
/**
* The ID of the proposal to resume.
*/
proposalId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$ResumeProposalRequest;
}
export interface Params$Resource$Accounts$Proposals$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Account ID of the buyer.
*/
accountId?: string;
/**
* The unique ID of the proposal.
*/
proposalId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Proposal;
}
export class Resource$Accounts$Publisherprofiles {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* adexchangebuyer2.accounts.publisherProfiles.get
* @desc Gets the requested publisher profile by id.
* @alias adexchangebuyer2.accounts.publisherProfiles.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountId Account ID of the buyer.
* @param {string} params.publisherProfileId The id for the publisher profile to get.
* @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$Accounts$Publisherprofiles$Get, options?: MethodOptions): GaxiosPromise<Schema$PublisherProfile>;
get(params: Params$Resource$Accounts$Publisherprofiles$Get, options: MethodOptions | BodyResponseCallback<Schema$PublisherProfile>, callback: BodyResponseCallback<Schema$PublisherProfile>): void;
get(params: Params$Resource$Accounts$Publisherprofiles$Get, callback: BodyResponseCallback<Schema$PublisherProfile>): void;
get(callback: BodyResponseCallback<Schema$PublisherProfile>): void;
/**
* adexchangebuyer2.accounts.publisherProfiles.list
* @desc List all publisher profiles visible to the buyer
* @alias adexchangebuyer2.accounts.publisherProfiles.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountId Account ID of the buyer.
* @param {integer=} params.pageSize Specify the number of results to include per page.
* @param {string=} params.pageToken The page token as return from ListPublisherProfilesResponse.
* @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$Accounts$Publisherprofiles$List, options?: MethodOptions): GaxiosPromise<Schema$ListPublisherProfilesResponse>;
list(params: Params$Resource$Accounts$Publisherprofiles$List, options: MethodOptions | BodyResponseCallback<Schema$ListPublisherProfilesResponse>, callback: BodyResponseCallback<Schema$ListPublisherProfilesResponse>): void;
list(params: Params$Resource$Accounts$Publisherprofiles$List, callback: BodyResponseCallback<Schema$ListPublisherProfilesResponse>): void;
list(callback: BodyResponseCallback<Schema$ListPublisherProfilesResponse>): void;
}
export interface Params$Resource$Accounts$Publisherprofiles$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Account ID of the buyer.
*/
accountId?: string;
/**
* The id for the publisher profile to get.
*/
publisherProfileId?: string;
}
export interface Params$Resource$Accounts$Publisherprofiles$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Account ID of the buyer.
*/
accountId?: string;
/**
* Specify the number of results to include per page.
*/
pageSize?: number;
/**
* The page token as return from ListPublisherProfilesResponse.
*/
pageToken?: string;
}
export class Resource$Bidders {
context: APIRequestContext;
accounts: Resource$Bidders$Accounts;
filterSets: Resource$Bidders$Filtersets;
constructor(context: APIRequestContext);
}
export class Resource$Bidders$Accounts {
context: APIRequestContext;
filterSets: Resource$Bidders$Accounts$Filtersets;
constructor(context: APIRequestContext);
}
export class Resource$Bidders$Accounts$Filtersets {
context: APIRequestContext;
bidMetrics: Resource$Bidders$Accounts$Filtersets$Bidmetrics;
bidResponseErrors: Resource$Bidders$Accounts$Filtersets$Bidresponseerrors;
bidResponsesWithoutBids: Resource$Bidders$Accounts$Filtersets$Bidresponseswithoutbids;
filteredBidRequests: Resource$Bidders$Accounts$Filtersets$Filteredbidrequests;
filteredBids: Resource$Bidders$Accounts$Filtersets$Filteredbids;
impressionMetrics: Resource$Bidders$Accounts$Filtersets$Impressionmetrics;
losingBids: Resource$Bidders$Accounts$Filtersets$Losingbids;
nonBillableWinningBids: Resource$Bidders$Accounts$Filtersets$Nonbillablewinningbids;
constructor(context: APIRequestContext);
/**
* adexchangebuyer2.bidders.accounts.filterSets.create
* @desc Creates the specified filter set for the account with the given account ID.
* @alias adexchangebuyer2.bidders.accounts.filterSets.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.isTransient Whether the filter set is transient, or should be persisted indefinitely. By default, filter sets are not transient. If transient, it will be available for at least 1 hour after creation.
* @param {string} params.ownerName Name of the owner (bidder or account) of the filter set to be created. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456`
* @param {().FilterSet} 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$Bidders$Accounts$Filtersets$Create, options?: MethodOptions): GaxiosPromise<Schema$FilterSet>;
create(params: Params$Resource$Bidders$Accounts$Filtersets$Create, options: MethodOptions | BodyResponseCallback<Schema$FilterSet>, callback: BodyResponseCallback<Schema$FilterSet>): void;
create(params: Params$Resource$Bidders$Accounts$Filtersets$Create, callback: BodyResponseCallback<Schema$FilterSet>): void;
create(callback: BodyResponseCallback<Schema$FilterSet>): void;
/**
* adexchangebuyer2.bidders.accounts.filterSets.delete
* @desc Deletes the requested filter set from the account with the given account ID.
* @alias adexchangebuyer2.bidders.accounts.filterSets.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Full name of the resource to delete. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
* @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
*/
delete(params?: Params$Resource$Bidders$Accounts$Filtersets$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Bidders$Accounts$Filtersets$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Bidders$Accounts$Filtersets$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* adexchangebuyer2.bidders.accounts.filterSets.get
* @desc Retrieves the requested filter set for the account with the given account ID.
* @alias adexchangebuyer2.bidders.accounts.filterSets.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Full name of the resource being requested. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
* @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$Bidders$Accounts$Filtersets$Get, options?: MethodOptions): GaxiosPromise<Schema$FilterSet>;
get(params: Params$Resource$Bidders$Accounts$Filtersets$Get, options: MethodOptions | BodyResponseCallback<Schema$FilterSet>, callback: BodyResponseCallback<Schema$FilterSet>): void;
get(params: Params$Resource$Bidders$Accounts$Filtersets$Get, callback: BodyResponseCallback<Schema$FilterSet>): void;
get(callback: BodyResponseCallback<Schema$FilterSet>): void;
/**
* adexchangebuyer2.bidders.accounts.filterSets.list
* @desc Lists all filter sets for the account with the given account ID.
* @alias adexchangebuyer2.bidders.accounts.filterSets.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.ownerName Name of the owner (bidder or account) of the filter sets to be listed. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456`
* @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
* @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListFilterSetsResponse.nextPageToken returned from the previous call to the accounts.filterSets.list 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
*/
list(params?: Params$Resource$Bidders$Accounts$Filtersets$List, options?: MethodOptions): GaxiosPromise<Schema$ListFilterSetsResponse>;
list(params: Params$Resource$Bidders$Accounts$Filtersets$List, options: MethodOptions | BodyResponseCallback<Schema$ListFilterSetsResponse>, callback: BodyResponseCallback<Schema$ListFilterSetsResponse>): void;
list(params: Params$Resource$Bidders$Accounts$Filtersets$List, callback: BodyResponseCallback<Schema$ListFilterSetsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListFilterSetsResponse>): void;
}
export interface Params$Resource$Bidders$Accounts$Filtersets$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Whether the filter set is transient, or should be persisted indefinitely. By default, filter sets are not transient. If transient, it will be available for at least 1 hour after creation.
*/
isTransient?: boolean;
/**
* Name of the owner (bidder or account) of the filter set to be created. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456`
*/
ownerName?: string;
/**
* Request body metadata
*/
requestBody?: Schema$FilterSet;
}
export interface Params$Resource$Bidders$Accounts$Filtersets$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Full name of the resource to delete. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
*/
name?: string;
}
export interface Params$Resource$Bidders$Accounts$Filtersets$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Full name of the resource being requested. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
*/
name?: string;
}
export interface Params$Resource$Bidders$Accounts$Filtersets$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Name of the owner (bidder or account) of the filter sets to be listed. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456`
*/
ownerName?: string;
/**
* Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
*/
pageSize?: number;
/**
* A token identifying a page of results the server should return. Typically, this is the value of ListFilterSetsResponse.nextPageToken returned from the previous call to the accounts.filterSets.list method.
*/
pageToken?: string;
}
export class Resource$Bidders$Accounts$Filtersets$Bidmetrics {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* adexchangebuyer2.bidders.accounts.filterSets.bidMetrics.list
* @desc Lists all metrics that are measured in terms of number of bids.
* @alias adexchangebuyer2.bidders.accounts.filterSets.bidMetrics.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
* @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
* @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListBidMetricsResponse.nextPageToken returned from the previous call to the bidMetrics.list 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
*/
list(params?: Params$Resource$Bidders$Accounts$Filtersets$Bidmetrics$List, options?: MethodOptions): GaxiosPromise<Schema$ListBidMetricsResponse>;
list(params: Params$Resource$Bidders$Accounts$Filtersets$Bidmetrics$List, options: MethodOptions | BodyResponseCallback<Schema$ListBidMetricsResponse>, callback: BodyResponseCallback<Schema$ListBidMetricsResponse>): void;
list(params: Params$Resource$Bidders$Accounts$Filtersets$Bidmetrics$List, callback: BodyResponseCallback<Schema$ListBidMetricsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListBidMetricsResponse>): void;
}
export interface Params$Resource$Bidders$Accounts$Filtersets$Bidmetrics$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
*/
filterSetName?: string;
/**
* Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
*/
pageSize?: number;
/**
* A token identifying a page of results the server should return. Typically, this is the value of ListBidMetricsResponse.nextPageToken returned from the previous call to the bidMetrics.list method.
*/
pageToken?: string;
}
export class Resource$Bidders$Accounts$Filtersets$Bidresponseerrors {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* adexchangebuyer2.bidders.accounts.filterSets.bidResponseErrors.list
* @desc List all errors that occurred in bid responses, with the number of bid responses affected for each reason.
* @alias adexchangebuyer2.bidders.accounts.filterSets.bidResponseErrors.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
* @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
* @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListBidResponseErrorsResponse.nextPageToken returned from the previous call to the bidResponseErrors.list 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
*/
list(params?: Params$Resource$Bidders$Accounts$Filtersets$Bidresponseerrors$List, options?: MethodOptions): GaxiosPromise<Schema$ListBidResponseErrorsResponse>;
list(params: Params$Resource$Bidders$Accounts$Filtersets$Bidresponseerrors$List, options: MethodOptions | BodyResponseCallback<Schema$ListBidResponseErrorsResponse>, callback: BodyResponseCallback<Schema$ListBidResponseErrorsResponse>): void;
list(params: Params$Resource$Bidders$Accounts$Filtersets$Bidresponseerrors$List, callback: BodyResponseCallback<Schema$ListBidResponseErrorsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListBidResponseErrorsResponse>): void;
}
export interface Params$Resource$Bidders$Accounts$Filtersets$Bidresponseerrors$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
*/
filterSetName?: string;
/**
* Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
*/
pageSize?: number;
/**
* A token identifying a page of results the server should return. Typically, this is the value of ListBidResponseErrorsResponse.nextPageToken returned from the previous call to the bidResponseErrors.list method.
*/
pageToken?: string;
}
export class Resource$Bidders$Accounts$Filtersets$Bidresponseswithoutbids {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* adexchangebuyer2.bidders.accounts.filterSets.bidResponsesWithoutBids.list
* @desc List all reasons for which bid responses were considered to have no applicable bids, with the number of bid responses affected for each reason.
* @alias adexchangebuyer2.bidders.accounts.filterSets.bidResponsesWithoutBids.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
* @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
* @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListBidResponsesWithoutBidsResponse.nextPageToken returned from the previous call to the bidResponsesWithoutBids.list 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
*/
list(params?: Params$Resource$Bidders$Accounts$Filtersets$Bidresponseswithoutbids$List, options?: MethodOptions): GaxiosPromise<Schema$ListBidResponsesWithoutBidsResponse>;
list(params: Params$Resource$Bidders$Accounts$Filtersets$Bidresponseswithoutbids$List, options: MethodOptions | BodyResponseCallback<Schema$ListBidResponsesWithoutBidsResponse>, callback: BodyResponseCallback<Schema$ListBidResponsesWithoutBidsResponse>): void;
list(params: Params$Resource$Bidders$Accounts$Filtersets$Bidresponseswithoutbids$List, callback: BodyResponseCallback<Schema$ListBidResponsesWithoutBidsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListBidResponsesWithoutBidsResponse>): void;
}
export interface Params$Resource$Bidders$Accounts$Filtersets$Bidresponseswithoutbids$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
*/
filterSetName?: string;
/**
* Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
*/
pageSize?: number;
/**
* A token identifying a page of results the server should return. Typically, this is the value of ListBidResponsesWithoutBidsResponse.nextPageToken returned from the previous call to the bidResponsesWithoutBids.list method.
*/
pageToken?: string;
}
export class Resource$Bidders$Accounts$Filtersets$Filteredbidrequests {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* adexchangebuyer2.bidders.accounts.filterSets.filteredBidRequests.list
* @desc List all reasons that caused a bid request not to be sent for an impression, with the number of bid requests not sent for each reason.
* @alias adexchangebuyer2.bidders.accounts.filterSets.filteredBidRequests.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
* @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
* @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListFilteredBidRequestsResponse.nextPageToken returned from the previous call to the filteredBidRequests.list 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
*/
list(params?: Params$Resource$Bidders$Accounts$Filtersets$Filteredbidrequests$List, options?: MethodOptions): GaxiosPromise<Schema$ListFilteredBidRequestsResponse>;
list(params: Params$Resource$Bidders$Accounts$Filtersets$Filteredbidrequests$List, options: MethodOptions | BodyResponseCallback<Schema$ListFilteredBidRequestsResponse>, callback: BodyResponseCallback<Schema$ListFilteredBidRequestsResponse>): void;
list(params: Params$Resource$Bidders$Accounts$Filtersets$Filteredbidrequests$List, callback: BodyResponseCallback<Schema$ListFilteredBidRequestsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListFilteredBidRequestsResponse>): void;
}
export interface Params$Resource$Bidders$Accounts$Filtersets$Filteredbidrequests$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
*/
filterSetName?: string;
/**
* Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
*/
pageSize?: number;
/**
* A token identifying a page of results the server should return. Typically, this is the value of ListFilteredBidRequestsResponse.nextPageToken returned from the previous call to the filteredBidRequests.list method.
*/
pageToken?: string;
}
export class Resource$Bidders$Accounts$Filtersets$Filteredbids {
context: APIRequestContext;
creatives: Resource$Bidders$Accounts$Filtersets$Filteredbids$Creatives;
details: Resource$Bidders$Accounts$Filtersets$Filteredbids$Details;
constructor(context: APIRequestContext);
/**
* adexchangebuyer2.bidders.accounts.filterSets.filteredBids.list
* @desc List all reasons for which bids were filtered, with the number of bids filtered for each reason.
* @alias adexchangebuyer2.bidders.accounts.filterSets.filteredBids.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
* @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
* @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListFilteredBidsResponse.nextPageToken returned from the previous call to the filteredBids.list 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
*/
list(params?: Params$Resource$Bidders$Accounts$Filtersets$Filteredbids$List, options?: MethodOptions): GaxiosPromise<Schema$ListFilteredBidsResponse>;
list(params: Params$Resource$Bidders$Accounts$Filtersets$Filteredbids$List, options: MethodOptions | BodyResponseCallback<Schema$ListFilteredBidsResponse>, callback: BodyResponseCallback<Schema$ListFilteredBidsResponse>): void;
list(params: Params$Resource$Bidders$Accounts$Filtersets$Filteredbids$List, callback: BodyResponseCallback<Schema$ListFilteredBidsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListFilteredBidsResponse>): void;
}
export interface Params$Resource$Bidders$Accounts$Filtersets$Filteredbids$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
*/
filterSetName?: string;
/**
* Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
*/
pageSize?: number;
/**
* A token identifying a page of results the server should return. Typically, this is the value of ListFilteredBidsResponse.nextPageToken returned from the previous call to the filteredBids.list method.
*/
pageToken?: string;
}
export class Resource$Bidders$Accounts$Filtersets$Filteredbids$Creatives {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* adexchangebuyer2.bidders.accounts.filterSets.filteredBids.creatives.list
* @desc List all creatives associated with a specific reason for which bids were filtered, with the number of bids filtered for each creative.
* @alias adexchangebuyer2.bidders.accounts.filterSets.filteredBids.creatives.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer} params.creativeStatusId The ID of the creative status for which to retrieve a breakdown by creative. See [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes).
* @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
* @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
* @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListCreativeStatusBreakdownByCreativeResponse.nextPageToken returned from the previous call to the filteredBids.creatives.list 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
*/
list(params?: Params$Resource$Bidders$Accounts$Filtersets$Filteredbids$Creatives$List, options?: MethodOptions): GaxiosPromise<Schema$ListCreativeStatusBreakdownByCreativeResponse>;
list(params: Params$Resource$Bidders$Accounts$Filtersets$Filteredbids$Creatives$List, options: MethodOptions | BodyResponseCallback<Schema$ListCreativeStatusBreakdownByCreativeResponse>, callback: BodyResponseCallback<Schema$ListCreativeStatusBreakdownByCreativeResponse>): void;
list(params: Params$Resource$Bidders$Accounts$Filtersets$Filteredbids$Creatives$List, callback: BodyResponseCallback<Schema$ListCreativeStatusBreakdownByCreativeResponse>): void;
list(callback: BodyResponseCallback<Schema$ListCreativeStatusBreakdownByCreativeResponse>): void;
}
export interface Params$Resource$Bidders$Accounts$Filtersets$Filteredbids$Creatives$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the creative status for which to retrieve a breakdown by creative. See [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes).
*/
creativeStatusId?: number;
/**
* Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
*/
filterSetName?: string;
/**
* Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
*/
pageSize?: number;
/**
* A token identifying a page of results the server should return. Typically, this is the value of ListCreativeStatusBreakdownByCreativeResponse.nextPageToken returned from the previous call to the filteredBids.creatives.list method.
*/
pageToken?: string;
}
export class Resource$Bidders$Accounts$Filtersets$Filteredbids$Details {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* adexchangebuyer2.bidders.accounts.filterSets.filteredBids.details.list
* @desc List all details associated with a specific reason for which bids were filtered, with the number of bids filtered for each detail.
* @alias adexchangebuyer2.bidders.accounts.filterSets.filteredBids.details.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer} params.creativeStatusId The ID of the creative status for which to retrieve a breakdown by detail. See [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes). Details are only available for statuses 10, 14, 15, 17, 18, 19, 86, and 87.
* @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
* @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
* @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListCreativeStatusBreakdownByDetailResponse.nextPageToken returned from the previous call to the filteredBids.details.list 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
*/
list(params?: Params$Resource$Bidders$Accounts$Filtersets$Filteredbids$Details$List, options?: MethodOptions): GaxiosPromise<Schema$ListCreativeStatusBreakdownByDetailResponse>;
list(params: Params$Resource$Bidders$Accounts$Filtersets$Filteredbids$Details$List, options: MethodOptions | BodyResponseCallback<Schema$ListCreativeStatusBreakdownByDetailResponse>, callback: BodyResponseCallback<Schema$ListCreativeStatusBreakdownByDetailResponse>): void;
list(params: Params$Resource$Bidders$Accounts$Filtersets$Filteredbids$Details$List, callback: BodyResponseCallback<Schema$ListCreativeStatusBreakdownByDetailResponse>): void;
list(callback: BodyResponseCallback<Schema$ListCreativeStatusBreakdownByDetailResponse>): void;
}
export interface Params$Resource$Bidders$Accounts$Filtersets$Filteredbids$Details$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the creative status for which to retrieve a breakdown by detail. See [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes). Details are only available for statuses 10, 14, 15, 17, 18, 19, 86, and 87.
*/
creativeStatusId?: number;
/**
* Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
*/
filterSetName?: string;
/**
* Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
*/
pageSize?: number;
/**
* A token identifying a page of results the server should return. Typically, this is the value of ListCreativeStatusBreakdownByDetailResponse.nextPageToken returned from the previous call to the filteredBids.details.list method.
*/
pageToken?: string;
}
export class Resource$Bidders$Accounts$Filtersets$Impressionmetrics {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* adexchangebuyer2.bidders.accounts.filterSets.impressionMetrics.list
* @desc Lists all metrics that are measured in terms of number of impressions.
* @alias adexchangebuyer2.bidders.accounts.filterSets.impressionMetrics.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
* @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
* @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListImpressionMetricsResponse.nextPageToken returned from the previous call to the impressionMetrics.list 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
*/
list(params?: Params$Resource$Bidders$Accounts$Filtersets$Impressionmetrics$List, options?: MethodOptions): GaxiosPromise<Schema$ListImpressionMetricsResponse>;
list(params: Params$Resource$Bidders$Accounts$Filtersets$Impressionmetrics$List, options: MethodOptions | BodyResponseCallback<Schema$ListImpressionMetricsResponse>, callback: BodyResponseCallback<Schema$ListImpressionMetricsResponse>): void;
list(params: Params$Resource$Bidders$Accounts$Filtersets$Impressionmetrics$List, callback: BodyResponseCallback<Schema$ListImpressionMetricsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListImpressionMetricsResponse>): void;
}
export interface Params$Resource$Bidders$Accounts$Filtersets$Impressionmetrics$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
*/
filterSetName?: string;
/**
* Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
*/
pageSize?: number;
/**
* A token identifying a page of results the server should return. Typically, this is the value of ListImpressionMetricsResponse.nextPageToken returned from the previous call to the impressionMetrics.list method.
*/
pageToken?: string;
}
export class Resource$Bidders$Accounts$Filtersets$Losingbids {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* adexchangebuyer2.bidders.accounts.filterSets.losingBids.list
* @desc List all reasons for which bids lost in the auction, with the number of bids that lost for each reason.
* @alias adexchangebuyer2.bidders.accounts.filterSets.losingBids.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
* @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
* @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListLosingBidsResponse.nextPageToken returned from the previous call to the losingBids.list 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
*/
list(params?: Params$Resource$Bidders$Accounts$Filtersets$Losingbids$List, options?: MethodOptions): GaxiosPromise<Schema$ListLosingBidsResponse>;
list(params: Params$Resource$Bidders$Accounts$Filtersets$Losingbids$List, options: MethodOptions | BodyResponseCallback<Schema$ListLosingBidsResponse>, callback: BodyResponseCallback<Schema$ListLosingBidsResponse>): void;
list(params: Params$Resource$Bidders$Accounts$Filtersets$Losingbids$List, callback: BodyResponseCallback<Schema$ListLosingBidsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListLosingBidsResponse>): void;
}
export interface Params$Resource$Bidders$Accounts$Filtersets$Losingbids$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
*/
filterSetName?: string;
/**
* Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
*/
pageSize?: number;
/**
* A token identifying a page of results the server should return. Typically, this is the value of ListLosingBidsResponse.nextPageToken returned from the previous call to the losingBids.list method.
*/
pageToken?: string;
}
export class Resource$Bidders$Accounts$Filtersets$Nonbillablewinningbids {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* adexchangebuyer2.bidders.accounts.filterSets.nonBillableWinningBids.list
* @desc List all reasons for which winning bids were not billable, with the number of bids not billed for each reason.
* @alias adexchangebuyer2.bidders.accounts.filterSets.nonBillableWinningBids.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
* @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
* @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListNonBillableWinningBidsResponse.nextPageToken returned from the previous call to the nonBillableWinningBids.list 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
*/
list(params?: Params$Resource$Bidders$Accounts$Filtersets$Nonbillablewinningbids$List, options?: MethodOptions): GaxiosPromise<Schema$ListNonBillableWinningBidsResponse>;
list(params: Params$Resource$Bidders$Accounts$Filtersets$Nonbillablewinningbids$List, options: MethodOptions | BodyResponseCallback<Schema$ListNonBillableWinningBidsResponse>, callback: BodyResponseCallback<Schema$ListNonBillableWinningBidsResponse>): void;
list(params: Params$Resource$Bidders$Accounts$Filtersets$Nonbillablewinningbids$List, callback: BodyResponseCallback<Schema$ListNonBillableWinningBidsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListNonBillableWinningBidsResponse>): void;
}
export interface Params$Resource$Bidders$Accounts$Filtersets$Nonbillablewinningbids$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
*/
filterSetName?: string;
/**
* Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
*/
pageSize?: number;
/**
* A token identifying a page of results the server should return. Typically, this is the value of ListNonBillableWinningBidsResponse.nextPageToken returned from the previous call to the nonBillableWinningBids.list method.
*/
pageToken?: string;
}
export class Resource$Bidders$Filtersets {
context: APIRequestContext;
bidMetrics: Resource$Bidders$Filtersets$Bidmetrics;
bidResponseErrors: Resource$Bidders$Filtersets$Bidresponseerrors;
bidResponsesWithoutBids: Resource$Bidders$Filtersets$Bidresponseswithoutbids;
filteredBidRequests: Resource$Bidders$Filtersets$Filteredbidrequests;
filteredBids: Resource$Bidders$Filtersets$Filteredbids;
impressionMetrics: Resource$Bidders$Filtersets$Impressionmetrics;
losingBids: Resource$Bidders$Filtersets$Losingbids;
nonBillableWinningBids: Resource$Bidders$Filtersets$Nonbillablewinningbids;
constructor(context: APIRequestContext);
/**
* adexchangebuyer2.bidders.filterSets.create
* @desc Creates the specified filter set for the account with the given account ID.
* @alias adexchangebuyer2.bidders.filterSets.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.isTransient Whether the filter set is transient, or should be persisted indefinitely. By default, filter sets are not transient. If transient, it will be available for at least 1 hour after creation.
* @param {string} params.ownerName Name of the owner (bidder or account) of the filter set to be created. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456`
* @param {().FilterSet} 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$Bidders$Filtersets$Create, options?: MethodOptions): GaxiosPromise<Schema$FilterSet>;
create(params: Params$Resource$Bidders$Filtersets$Create, options: MethodOptions | BodyResponseCallback<Schema$FilterSet>, callback: BodyResponseCallback<Schema$FilterSet>): void;
create(params: Params$Resource$Bidders$Filtersets$Create, callback: BodyResponseCallback<Schema$FilterSet>): void;
create(callback: BodyResponseCallback<Schema$FilterSet>): void;
/**
* adexchangebuyer2.bidders.filterSets.delete
* @desc Deletes the requested filter set from the account with the given account ID.
* @alias adexchangebuyer2.bidders.filterSets.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Full name of the resource to delete. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
* @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
*/
delete(params?: Params$Resource$Bidders$Filtersets$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Bidders$Filtersets$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Bidders$Filtersets$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* adexchangebuyer2.bidders.filterSets.get
* @desc Retrieves the requested filter set for the account with the given account ID.
* @alias adexchangebuyer2.bidders.filterSets.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Full name of the resource being requested. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
* @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$Bidders$Filtersets$Get, options?: MethodOptions): GaxiosPromise<Schema$FilterSet>;
get(params: Params$Resource$Bidders$Filtersets$Get, options: MethodOptions | BodyResponseCallback<Schema$FilterSet>, callback: BodyResponseCallback<Schema$FilterSet>): void;
get(params: Params$Resource$Bidders$Filtersets$Get, callback: BodyResponseCallback<Schema$FilterSet>): void;
get(callback: BodyResponseCallback<Schema$FilterSet>): void;
/**
* adexchangebuyer2.bidders.filterSets.list
* @desc Lists all filter sets for the account with the given account ID.
* @alias adexchangebuyer2.bidders.filterSets.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.ownerName Name of the owner (bidder or account) of the filter sets to be listed. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456`
* @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
* @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListFilterSetsResponse.nextPageToken returned from the previous call to the accounts.filterSets.list 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
*/
list(params?: Params$Resource$Bidders$Filtersets$List, options?: MethodOptions): GaxiosPromise<Schema$ListFilterSetsResponse>;
list(params: Params$Resource$Bidders$Filtersets$List, options: MethodOptions | BodyResponseCallback<Schema$ListFilterSetsResponse>, callback: BodyResponseCallback<Schema$ListFilterSetsResponse>): void;
list(params: Params$Resource$Bidders$Filtersets$List, callback: BodyResponseCallback<Schema$ListFilterSetsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListFilterSetsResponse>): void;
}
export interface Params$Resource$Bidders$Filtersets$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Whether the filter set is transient, or should be persisted indefinitely. By default, filter sets are not transient. If transient, it will be available for at least 1 hour after creation.
*/
isTransient?: boolean;
/**
* Name of the owner (bidder or account) of the filter set to be created. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456`
*/
ownerName?: string;
/**
* Request body metadata
*/
requestBody?: Schema$FilterSet;
}
export interface Params$Resource$Bidders$Filtersets$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Full name of the resource to delete. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
*/
name?: string;
}
export interface Params$Resource$Bidders$Filtersets$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Full name of the resource being requested. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
*/
name?: string;
}
export interface Params$Resource$Bidders$Filtersets$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Name of the owner (bidder or account) of the filter sets to be listed. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456`
*/
ownerName?: string;
/**
* Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
*/
pageSize?: number;
/**
* A token identifying a page of results the server should return. Typically, this is the value of ListFilterSetsResponse.nextPageToken returned from the previous call to the accounts.filterSets.list method.
*/
pageToken?: string;
}
export class Resource$Bidders$Filtersets$Bidmetrics {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* adexchangebuyer2.bidders.filterSets.bidMetrics.list
* @desc Lists all metrics that are measured in terms of number of bids.
* @alias adexchangebuyer2.bidders.filterSets.bidMetrics.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
* @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
* @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListBidMetricsResponse.nextPageToken returned from the previous call to the bidMetrics.list 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
*/
list(params?: Params$Resource$Bidders$Filtersets$Bidmetrics$List, options?: MethodOptions): GaxiosPromise<Schema$ListBidMetricsResponse>;
list(params: Params$Resource$Bidders$Filtersets$Bidmetrics$List, options: MethodOptions | BodyResponseCallback<Schema$ListBidMetricsResponse>, callback: BodyResponseCallback<Schema$ListBidMetricsResponse>): void;
list(params: Params$Resource$Bidders$Filtersets$Bidmetrics$List, callback: BodyResponseCallback<Schema$ListBidMetricsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListBidMetricsResponse>): void;
}
export interface Params$Resource$Bidders$Filtersets$Bidmetrics$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
*/
filterSetName?: string;
/**
* Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
*/
pageSize?: number;
/**
* A token identifying a page of results the server should return. Typically, this is the value of ListBidMetricsResponse.nextPageToken returned from the previous call to the bidMetrics.list method.
*/
pageToken?: string;
}
export class Resource$Bidders$Filtersets$Bidresponseerrors {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* adexchangebuyer2.bidders.filterSets.bidResponseErrors.list
* @desc List all errors that occurred in bid responses, with the number of bid responses affected for each reason.
* @alias adexchangebuyer2.bidders.filterSets.bidResponseErrors.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
* @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
* @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListBidResponseErrorsResponse.nextPageToken returned from the previous call to the bidResponseErrors.list 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
*/
list(params?: Params$Resource$Bidders$Filtersets$Bidresponseerrors$List, options?: MethodOptions): GaxiosPromise<Schema$ListBidResponseErrorsResponse>;
list(params: Params$Resource$Bidders$Filtersets$Bidresponseerrors$List, options: MethodOptions | BodyResponseCallback<Schema$ListBidResponseErrorsResponse>, callback: BodyResponseCallback<Schema$ListBidResponseErrorsResponse>): void;
list(params: Params$Resource$Bidders$Filtersets$Bidresponseerrors$List, callback: BodyResponseCallback<Schema$ListBidResponseErrorsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListBidResponseErrorsResponse>): void;
}
export interface Params$Resource$Bidders$Filtersets$Bidresponseerrors$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
*/
filterSetName?: string;
/**
* Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
*/
pageSize?: number;
/**
* A token identifying a page of results the server should return. Typically, this is the value of ListBidResponseErrorsResponse.nextPageToken returned from the previous call to the bidResponseErrors.list method.
*/
pageToken?: string;
}
export class Resource$Bidders$Filtersets$Bidresponseswithoutbids {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* adexchangebuyer2.bidders.filterSets.bidResponsesWithoutBids.list
* @desc List all reasons for which bid responses were considered to have no applicable bids, with the number of bid responses affected for each reason.
* @alias adexchangebuyer2.bidders.filterSets.bidResponsesWithoutBids.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
* @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
* @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListBidResponsesWithoutBidsResponse.nextPageToken returned from the previous call to the bidResponsesWithoutBids.list 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
*/
list(params?: Params$Resource$Bidders$Filtersets$Bidresponseswithoutbids$List, options?: MethodOptions): GaxiosPromise<Schema$ListBidResponsesWithoutBidsResponse>;
list(params: Params$Resource$Bidders$Filtersets$Bidresponseswithoutbids$List, options: MethodOptions | BodyResponseCallback<Schema$ListBidResponsesWithoutBidsResponse>, callback: BodyResponseCallback<Schema$ListBidResponsesWithoutBidsResponse>): void;
list(params: Params$Resource$Bidders$Filtersets$Bidresponseswithoutbids$List, callback: BodyResponseCallback<Schema$ListBidResponsesWithoutBidsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListBidResponsesWithoutBidsResponse>): void;
}
export interface Params$Resource$Bidders$Filtersets$Bidresponseswithoutbids$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
*/
filterSetName?: string;
/**
* Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
*/
pageSize?: number;
/**
* A token identifying a page of results the server should return. Typically, this is the value of ListBidResponsesWithoutBidsResponse.nextPageToken returned from the previous call to the bidResponsesWithoutBids.list method.
*/
pageToken?: string;
}
export class Resource$Bidders$Filtersets$Filteredbidrequests {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* adexchangebuyer2.bidders.filterSets.filteredBidRequests.list
* @desc List all reasons that caused a bid request not to be sent for an impression, with the number of bid requests not sent for each reason.
* @alias adexchangebuyer2.bidders.filterSets.filteredBidRequests.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
* @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
* @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListFilteredBidRequestsResponse.nextPageToken returned from the previous call to the filteredBidRequests.list 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
*/
list(params?: Params$Resource$Bidders$Filtersets$Filteredbidrequests$List, options?: MethodOptions): GaxiosPromise<Schema$ListFilteredBidRequestsResponse>;
list(params: Params$Resource$Bidders$Filtersets$Filteredbidrequests$List, options: MethodOptions | BodyResponseCallback<Schema$ListFilteredBidRequestsResponse>, callback: BodyResponseCallback<Schema$ListFilteredBidRequestsResponse>): void;
list(params: Params$Resource$Bidders$Filtersets$Filteredbidrequests$List, callback: BodyResponseCallback<Schema$ListFilteredBidRequestsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListFilteredBidRequestsResponse>): void;
}
export interface Params$Resource$Bidders$Filtersets$Filteredbidrequests$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
*/
filterSetName?: string;
/**
* Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
*/
pageSize?: number;
/**
* A token identifying a page of results the server should return. Typically, this is the value of ListFilteredBidRequestsResponse.nextPageToken returned from the previous call to the filteredBidRequests.list method.
*/
pageToken?: string;
}
export class Resource$Bidders$Filtersets$Filteredbids {
context: APIRequestContext;
creatives: Resource$Bidders$Filtersets$Filteredbids$Creatives;
details: Resource$Bidders$Filtersets$Filteredbids$Details;
constructor(context: APIRequestContext);
/**
* adexchangebuyer2.bidders.filterSets.filteredBids.list
* @desc List all reasons for which bids were filtered, with the number of bids filtered for each reason.
* @alias adexchangebuyer2.bidders.filterSets.filteredBids.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
* @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
* @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListFilteredBidsResponse.nextPageToken returned from the previous call to the filteredBids.list 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
*/
list(params?: Params$Resource$Bidders$Filtersets$Filteredbids$List, options?: MethodOptions): GaxiosPromise<Schema$ListFilteredBidsResponse>;
list(params: Params$Resource$Bidders$Filtersets$Filteredbids$List, options: MethodOptions | BodyResponseCallback<Schema$ListFilteredBidsResponse>, callback: BodyResponseCallback<Schema$ListFilteredBidsResponse>): void;
list(params: Params$Resource$Bidders$Filtersets$Filteredbids$List, callback: BodyResponseCallback<Schema$ListFilteredBidsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListFilteredBidsResponse>): void;
}
export interface Params$Resource$Bidders$Filtersets$Filteredbids$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
*/
filterSetName?: string;
/**
* Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
*/
pageSize?: number;
/**
* A token identifying a page of results the server should return. Typically, this is the value of ListFilteredBidsResponse.nextPageToken returned from the previous call to the filteredBids.list method.
*/
pageToken?: string;
}
export class Resource$Bidders$Filtersets$Filteredbids$Creatives {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* adexchangebuyer2.bidders.filterSets.filteredBids.creatives.list
* @desc List all creatives associated with a specific reason for which bids were filtered, with the number of bids filtered for each creative.
* @alias adexchangebuyer2.bidders.filterSets.filteredBids.creatives.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer} params.creativeStatusId The ID of the creative status for which to retrieve a breakdown by creative. See [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes).
* @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
* @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
* @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListCreativeStatusBreakdownByCreativeResponse.nextPageToken returned from the previous call to the filteredBids.creatives.list 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
*/
list(params?: Params$Resource$Bidders$Filtersets$Filteredbids$Creatives$List, options?: MethodOptions): GaxiosPromise<Schema$ListCreativeStatusBreakdownByCreativeResponse>;
list(params: Params$Resource$Bidders$Filtersets$Filteredbids$Creatives$List, options: MethodOptions | BodyResponseCallback<Schema$ListCreativeStatusBreakdownByCreativeResponse>, callback: BodyResponseCallback<Schema$ListCreativeStatusBreakdownByCreativeResponse>): void;
list(params: Params$Resource$Bidders$Filtersets$Filteredbids$Creatives$List, callback: BodyResponseCallback<Schema$ListCreativeStatusBreakdownByCreativeResponse>): void;
list(callback: BodyResponseCallback<Schema$ListCreativeStatusBreakdownByCreativeResponse>): void;
}
export interface Params$Resource$Bidders$Filtersets$Filteredbids$Creatives$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the creative status for which to retrieve a breakdown by creative. See [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes).
*/
creativeStatusId?: number;
/**
* Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
*/
filterSetName?: string;
/**
* Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
*/
pageSize?: number;
/**
* A token identifying a page of results the server should return. Typically, this is the value of ListCreativeStatusBreakdownByCreativeResponse.nextPageToken returned from the previous call to the filteredBids.creatives.list method.
*/
pageToken?: string;
}
export class Resource$Bidders$Filtersets$Filteredbids$Details {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* adexchangebuyer2.bidders.filterSets.filteredBids.details.list
* @desc List all details associated with a specific reason for which bids were filtered, with the number of bids filtered for each detail.
* @alias adexchangebuyer2.bidders.filterSets.filteredBids.details.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer} params.creativeStatusId The ID of the creative status for which to retrieve a breakdown by detail. See [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes). Details are only available for statuses 10, 14, 15, 17, 18, 19, 86, and 87.
* @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
* @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
* @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListCreativeStatusBreakdownByDetailResponse.nextPageToken returned from the previous call to the filteredBids.details.list 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
*/
list(params?: Params$Resource$Bidders$Filtersets$Filteredbids$Details$List, options?: MethodOptions): GaxiosPromise<Schema$ListCreativeStatusBreakdownByDetailResponse>;
list(params: Params$Resource$Bidders$Filtersets$Filteredbids$Details$List, options: MethodOptions | BodyResponseCallback<Schema$ListCreativeStatusBreakdownByDetailResponse>, callback: BodyResponseCallback<Schema$ListCreativeStatusBreakdownByDetailResponse>): void;
list(params: Params$Resource$Bidders$Filtersets$Filteredbids$Details$List, callback: BodyResponseCallback<Schema$ListCreativeStatusBreakdownByDetailResponse>): void;
list(callback: BodyResponseCallback<Schema$ListCreativeStatusBreakdownByDetailResponse>): void;
}
export interface Params$Resource$Bidders$Filtersets$Filteredbids$Details$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the creative status for which to retrieve a breakdown by detail. See [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes). Details are only available for statuses 10, 14, 15, 17, 18, 19, 86, and 87.
*/
creativeStatusId?: number;
/**
* Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
*/
filterSetName?: string;
/**
* Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
*/
pageSize?: number;
/**
* A token identifying a page of results the server should return. Typically, this is the value of ListCreativeStatusBreakdownByDetailResponse.nextPageToken returned from the previous call to the filteredBids.details.list method.
*/
pageToken?: string;
}
export class Resource$Bidders$Filtersets$Impressionmetrics {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* adexchangebuyer2.bidders.filterSets.impressionMetrics.list
* @desc Lists all metrics that are measured in terms of number of impressions.
* @alias adexchangebuyer2.bidders.filterSets.impressionMetrics.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
* @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
* @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListImpressionMetricsResponse.nextPageToken returned from the previous call to the impressionMetrics.list 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
*/
list(params?: Params$Resource$Bidders$Filtersets$Impressionmetrics$List, options?: MethodOptions): GaxiosPromise<Schema$ListImpressionMetricsResponse>;
list(params: Params$Resource$Bidders$Filtersets$Impressionmetrics$List, options: MethodOptions | BodyResponseCallback<Schema$ListImpressionMetricsResponse>, callback: BodyResponseCallback<Schema$ListImpressionMetricsResponse>): void;
list(params: Params$Resource$Bidders$Filtersets$Impressionmetrics$List, callback: BodyResponseCallback<Schema$ListImpressionMetricsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListImpressionMetricsResponse>): void;
}
export interface Params$Resource$Bidders$Filtersets$Impressionmetrics$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
*/
filterSetName?: string;
/**
* Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
*/
pageSize?: number;
/**
* A token identifying a page of results the server should return. Typically, this is the value of ListImpressionMetricsResponse.nextPageToken returned from the previous call to the impressionMetrics.list method.
*/
pageToken?: string;
}
export class Resource$Bidders$Filtersets$Losingbids {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* adexchangebuyer2.bidders.filterSets.losingBids.list
* @desc List all reasons for which bids lost in the auction, with the number of bids that lost for each reason.
* @alias adexchangebuyer2.bidders.filterSets.losingBids.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
* @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
* @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListLosingBidsResponse.nextPageToken returned from the previous call to the losingBids.list 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
*/
list(params?: Params$Resource$Bidders$Filtersets$Losingbids$List, options?: MethodOptions): GaxiosPromise<Schema$ListLosingBidsResponse>;
list(params: Params$Resource$Bidders$Filtersets$Losingbids$List, options: MethodOptions | BodyResponseCallback<Schema$ListLosingBidsResponse>, callback: BodyResponseCallback<Schema$ListLosingBidsResponse>): void;
list(params: Params$Resource$Bidders$Filtersets$Losingbids$List, callback: BodyResponseCallback<Schema$ListLosingBidsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListLosingBidsResponse>): void;
}
export interface Params$Resource$Bidders$Filtersets$Losingbids$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
*/
filterSetName?: string;
/**
* Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
*/
pageSize?: number;
/**
* A token identifying a page of results the server should return. Typically, this is the value of ListLosingBidsResponse.nextPageToken returned from the previous call to the losingBids.list method.
*/
pageToken?: string;
}
export class Resource$Bidders$Filtersets$Nonbillablewinningbids {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* adexchangebuyer2.bidders.filterSets.nonBillableWinningBids.list
* @desc List all reasons for which winning bids were not billable, with the number of bids not billed for each reason.
* @alias adexchangebuyer2.bidders.filterSets.nonBillableWinningBids.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
* @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
* @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListNonBillableWinningBidsResponse.nextPageToken returned from the previous call to the nonBillableWinningBids.list 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
*/
list(params?: Params$Resource$Bidders$Filtersets$Nonbillablewinningbids$List, options?: MethodOptions): GaxiosPromise<Schema$ListNonBillableWinningBidsResponse>;
list(params: Params$Resource$Bidders$Filtersets$Nonbillablewinningbids$List, options: MethodOptions | BodyResponseCallback<Schema$ListNonBillableWinningBidsResponse>, callback: BodyResponseCallback<Schema$ListNonBillableWinningBidsResponse>): void;
list(params: Params$Resource$Bidders$Filtersets$Nonbillablewinningbids$List, callback: BodyResponseCallback<Schema$ListNonBillableWinningBidsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListNonBillableWinningBidsResponse>): void;
}
export interface Params$Resource$Bidders$Filtersets$Nonbillablewinningbids$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`
*/
filterSetName?: string;
/**
* Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
*/
pageSize?: number;
/**
* A token identifying a page of results the server should return. Typically, this is the value of ListNonBillableWinningBidsResponse.nextPageToken returned from the previous call to the nonBillableWinningBids.list method.
*/
pageToken?: string;
}
export {};
}