v1.d.ts
200 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
/// <reference types="node" />
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosPromise, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace realtimebidding_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Real-time Bidding API
*
* Allows external bidders to manage their RTB integration with Google. This includes managing bidder endpoints, QPS quotas, configuring what ad inventory to receive via pretargeting, submitting creatives for verification, and accessing creative metadata such as approval status.
*
* @example
* ```js
* const {google} = require('googleapis');
* const realtimebidding = google.realtimebidding('v1');
* ```
*/
export class Realtimebidding {
context: APIRequestContext;
bidders: Resource$Bidders;
buyers: Resource$Buyers;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* A request to activate a pretargeting configuration. Sets the configuration's state to ACTIVE.
*/
export interface Schema$ActivatePretargetingConfigRequest {
}
/**
* A request to start targeting the provided app IDs in a specific pretargeting configuration. The pretargeting configuration itself specifies how these apps are targeted. in PretargetingConfig.appTargeting.mobileAppTargeting.
*/
export interface Schema$AddTargetedAppsRequest {
/**
* A list of app IDs to target in the pretargeting configuration. These values will be added to the list of targeted app IDs in PretargetingConfig.appTargeting.mobileAppTargeting.values.
*/
appIds?: string[] | null;
/**
* Required. The targeting mode that should be applied to the list of app IDs. If there are existing targeted app IDs, must be equal to the existing PretargetingConfig.appTargeting.mobileAppTargeting.targetingMode or a 400 bad request error will be returned.
*/
targetingMode?: string | null;
}
/**
* A request to start targeting the provided publishers in a specific pretargeting configuration. The pretargeting configuration itself specifies how these publishers are targeted in PretargetingConfig.publisherTargeting.
*/
export interface Schema$AddTargetedPublishersRequest {
/**
* A list of publisher IDs to target in the pretargeting configuration. These values will be added to the list of targeted publisher IDs in PretargetingConfig.publisherTargeting.values. Publishers are identified by their publisher ID from ads.txt / app-ads.txt. See https://iabtechlab.com/ads-txt/ and https://iabtechlab.com/app-ads-txt/ for more details.
*/
publisherIds?: string[] | null;
/**
* Required. The targeting mode that should be applied to the list of publisher IDs. If are existing publisher IDs, must be equal to the existing PretargetingConfig.publisherTargeting.targetingMode or a 400 bad request error will be returned.
*/
targetingMode?: string | null;
}
/**
* A request to start targeting the provided sites in a specific pretargeting configuration. The pretargeting configuration itself specifies how these sites are targeted in PretargetingConfig.webTargeting.
*/
export interface Schema$AddTargetedSitesRequest {
/**
* A list of site URLs to target in the pretargeting configuration. These values will be added to the list of targeted URLs in PretargetingConfig.webTargeting.values.
*/
sites?: string[] | null;
/**
* Required. The targeting mode that should be applied to the list of site URLs. If there are existing targeted sites, must be equal to the existing PretargetingConfig.webTargeting.targetingMode or a 400 bad request error will be returned.
*/
targetingMode?: string | null;
}
/**
* The list of detected Ad Technology Providers for this creative. Bids placed for inventory that will serve to EEA or UK users are expected to comply with GDPR requirements. You must ensure that the creatives used in such bids should contain only user consented ad technology providers as indicated in the bid request. Google reserves the right to filter non-compliant bids. User consented ad technology providers can be found in the [Google Protocol](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) with the `BidRequest.adslot.consented_providers_settings` field, and can be found as an [OpenRTB extension](https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto) with the `BidRequest.user.ext.consented_providers_settings` and `BidRequest.user.ext.consent` fields. See https://support.google.com/authorizedbuyers/answer/9789378 for additional information about the Google TCF v2 integration.
*/
export interface Schema$AdTechnologyProviders {
/**
* The detected IAB Global Vendor List (GVL) IDs for this creative. See the IAB Global Vendor List at https://vendorlist.consensu.org/v2/vendor-list.json for details about the vendors.
*/
detectedGvlIds?: string[] | null;
/**
* The detected [Google Ad Tech Providers (ATP)](https://support.google.com/admanager/answer/9012903) 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.
*/
detectedProviderIds?: string[] | null;
/**
* Domains of detected unidentified ad technology providers (if any). You must ensure that the creatives used in bids placed for inventory that will serve to EEA or UK users does not contain unidentified ad technology providers. Google reserves the right to filter non-compliant bids.
*/
unidentifiedProviderDomains?: string[] | null;
}
/**
* Detected advertiser and brand information.
*/
export interface Schema$AdvertiserAndBrand {
/**
* See https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt for the list of possible values. Can be used to filter the response of the creatives.list method.
*/
advertiserId?: string | null;
/**
* Advertiser name. Can be used to filter the response of the creatives.list method.
*/
advertiserName?: string | null;
/**
* Detected brand ID or zero if no brand has been detected. See https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt for the list of possible values. Can be used to filter the response of the creatives.list method.
*/
brandId?: string | null;
/**
* Brand name. Can be used to filter the response of the creatives.list method.
*/
brandName?: string | null;
}
/**
* A subset of app inventory to target. Bid requests that match criteria in at least one of the specified dimensions will be sent.
*/
export interface Schema$AppTargeting {
/**
* Lists of included and excluded mobile app categories as defined in https://developers.google.com/adwords/api/docs/appendix/mobileappcategories.csv.
*/
mobileAppCategoryTargeting?: Schema$NumericTargetingDimension;
/**
* Targeted app IDs. App IDs can refer to those found in an app store or ones that are not published in an app store. A maximum of 30,000 app IDs can be targeted.
*/
mobileAppTargeting?: Schema$StringTargetingDimension;
}
/**
* Bidder settings.
*/
export interface Schema$Bidder {
/**
* Output only. A flag to bypass pretargeting for private auctions and preferred deals. When true, bid requests from these nonguaranteed deals will always be sent. When false, bid requests will be subject to regular pretargeting configurations. Programmatic Guaranteed deals will always be sent to the bidder, regardless of the value for this flag. Auction packages are not impacted by this value and are subject to the regular pretargeting configurations.
*/
bypassNonguaranteedDealsPretargeting?: boolean | null;
/**
* Output only. The buyer's network ID used for cookie matching. This ID corresponds to the `google_nid` parameter in the URL used in cookie match requests. Refer to https://developers.google.com/authorized-buyers/rtb/cookie-guide for further information.
*/
cookieMatchingNetworkId?: string | null;
/**
* Output only. The base URL used in cookie match requests. Refer to https://developers.google.com/authorized-buyers/rtb/cookie-guide for further information.
*/
cookieMatchingUrl?: string | null;
/**
* Output only. The billing ID for the deals pretargeting config. This billing ID is sent on the bid request for guaranteed and nonguaranteed deals matched in pretargeting.
*/
dealsBillingId?: string | null;
/**
* Output only. Name of the bidder resource that must follow the pattern `bidders/{bidderAccountId\}`, where `{bidderAccountId\}` is the account ID of the bidder whose information is to be received. One can get their account ID on the Authorized Buyers or Open Bidding UI, or by contacting their Google account manager.
*/
name?: string | null;
}
/**
* RTB Buyer account information.
*/
export interface Schema$Buyer {
/**
* Output only. The number of creatives that this buyer submitted via the API or bid with in the last 30 days. This is counted against the maximum number of active creatives.
*/
activeCreativeCount?: string | null;
/**
* Output only. The name of the bidder resource that is responsible for receiving bidding traffic for this account. The bidder name must follow the pattern `bidders/{bidderAccountId\}`, where `{bidderAccountId\}` is the account ID of the bidder receiving traffic for this buyer.
*/
bidder?: string | null;
/**
* Output only. A list of billing IDs associated with this account. These IDs appear on: 1. A bid request, to signal which buyers are eligible to bid on a given opportunity, and which pretargeting configurations were matched for each eligible buyer. 2. The bid response, to attribute a winning impression to a specific account for billing, reporting, policy and publisher block enforcement.
*/
billingIds?: string[] | null;
/**
* Output only. The diplay name associated with this buyer account, as visible to sellers.
*/
displayName?: string | null;
/**
* Output only. The maximum number of active creatives that this buyer can have.
*/
maximumActiveCreativeCount?: string | null;
/**
* Output only. Name of the buyer resource that must follow the pattern `buyers/{buyerAccountId\}`, where `{buyerAccountId\}` is the account ID of the buyer account whose information is to be received. One can get their account ID on the Authorized Buyers or Open Bidding UI, or by contacting their Google account manager.
*/
name?: string | null;
}
/**
* A request to close a specified user list.
*/
export interface Schema$CloseUserListRequest {
}
/**
* A creative and its classification data.
*/
export interface Schema$Creative {
/**
* Output only. ID of the buyer account that this creative is owned by. Can be used to filter the response of the creatives.list method with equality and inequality check.
*/
accountId?: string | null;
/**
* The link to AdChoices destination page. This is only supported for native ads.
*/
adChoicesDestinationUrl?: string | null;
/**
* The name of the company being advertised in the creative. Can be used to filter the response of the creatives.list method.
*/
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;
/**
* Output only. The format of this creative. Can be used to filter the response of the creatives.list method.
*/
creativeFormat?: string | null;
/**
* Buyer-specific creative ID that references this creative in bid responses. This field is Ignored in update operations. Can be used to filter the response of the creatives.list method. The maximum length of the creative ID is 128 bytes.
*/
creativeId?: string | null;
/**
* Output only. Top level status and detected attributes of a creative (for example domain, language, advertiser, product category, etc.) that affect whether (status) and where (context) a creative will be allowed to serve.
*/
creativeServingDecision?: Schema$CreativeServingDecision;
/**
* Output only. IDs of all of the deals with which this creative has been used in bidding. Can be used to filter the response of the creatives.list method.
*/
dealIds?: string[] | null;
/**
* All declared attributes for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method. If the `excluded_attribute` field of a [bid request](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto") contains one of the attributes that were declared or detected for a given creative, and a bid is submitted with that creative, the bid will be filtered before the auction.
*/
declaredAttributes?: string[] | null;
/**
* The set of declared destination URLs for the creative. Can be used to filter the response of the creatives.list method.
*/
declaredClickThroughUrls?: string[] | null;
/**
* All declared restricted categories for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method.
*/
declaredRestrictedCategories?: string[] | null;
/**
* IDs for the declared ad technology vendors that may be used by this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for possible values. Can be used to filter the response of the creatives.list method.
*/
declaredVendorIds?: number[] | null;
/**
* An HTML creative.
*/
html?: Schema$HtmlContent;
/**
* The set of URLs to be called to record an impression.
*/
impressionTrackingUrls?: string[] | null;
/**
* Output only. Name of the creative. Follows the pattern `buyers/{buyer\}/creatives/{creative\}`, where `{buyer\}` represents the account ID of the buyer who owns the creative, and `{creative\}` is the buyer-specific creative ID that references this creative in the bid response.
*/
name?: string | null;
/**
* A native creative.
*/
native?: Schema$NativeContent;
/**
* All restricted categories for the ads that may be shown from this creative.
*/
restrictedCategories?: string[] | null;
/**
* Output only. The version of this creative. Version for a new creative is 1 and it increments during subsequent creative updates.
*/
version?: number | null;
/**
* A video creative.
*/
video?: Schema$VideoContent;
}
/**
* The dimensions of a creative. This applies to only HTML and Native creatives.
*/
export interface Schema$CreativeDimensions {
/**
* The height of the creative in pixels.
*/
height?: string | null;
/**
* The width of the creative in pixels.
*/
width?: string | null;
}
/**
* Top level status and detected attributes of a creative.
*/
export interface Schema$CreativeServingDecision {
/**
* The detected ad technology providers.
*/
adTechnologyProviders?: Schema$AdTechnologyProviders;
/**
* The policy compliance of this creative in China. When approved or disapproved, this applies to both deals and open auction in China. When pending review, this creative is allowed to serve for deals but not for open auction.
*/
chinaPolicyCompliance?: Schema$PolicyCompliance;
/**
* Policy compliance of this creative when bidding on Programmatic Guaranteed and Preferred Deals (outside of Russia and China).
*/
dealsPolicyCompliance?: Schema$PolicyCompliance;
/**
* Detected advertisers and brands.
*/
detectedAdvertisers?: Schema$AdvertiserAndBrand[];
/**
* Publisher-excludable attributes that were detected for this creative. Can be used to filter the response of the creatives.list method. If the `excluded_attribute` field of a [bid request](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) contains one of the attributes that were declared or detected for a given creative, and a bid is submitted with that creative, the bid will be filtered before the auction.
*/
detectedAttributes?: string[] | null;
/**
* The set of detected destination URLs for the creative. Can be used to filter the response of the creatives.list method.
*/
detectedClickThroughUrls?: string[] | null;
/**
* The detected domains for this creative.
*/
detectedDomains?: string[] | null;
/**
* 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. Can be used to filter the response of the creatives.list method.
*/
detectedLanguages?: string[] | null;
/**
* Detected product categories, if any. See the ad-product-categories.txt file in the technical documentation for a list of IDs. Can be used to filter the response of the creatives.list method.
*/
detectedProductCategories?: number[] | null;
/**
* Detected sensitive categories, if any. Can be used to filter the response of the creatives.list method. 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;
/**
* IDs of the ad technology vendors that were detected to be used by this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for possible values. Can be used to filter the response of the creatives.list method. If the `allowed_vendor_type` field of a [bid request](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) does not contain one of the vendor type IDs that were declared or detected for a given creative, and a bid is submitted with that creative, the bid will be filtered before the auction.
*/
detectedVendorIds?: number[] | null;
/**
* The last time the creative status was updated. Can be used to filter the response of the creatives.list method.
*/
lastStatusUpdate?: string | null;
/**
* Policy compliance of this creative when bidding in open auction, private auction, or auction packages (outside of Russia and China).
*/
networkPolicyCompliance?: Schema$PolicyCompliance;
/**
* Policy compliance of this creative when bidding in Open Bidding (outside of Russia and China). For the list of platform policies, see: https://support.google.com/platformspolicy/answer/3013851.
*/
platformPolicyCompliance?: Schema$PolicyCompliance;
/**
* The policy compliance of this creative in Russia. When approved or disapproved, this applies to both deals and open auction in Russia. When pending review, this creative is allowed to serve for deals but not for open auction.
*/
russiaPolicyCompliance?: Schema$PolicyCompliance;
}
/**
* Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
*/
export interface Schema$Date {
/**
* Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
*/
day?: number | null;
/**
* Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
*/
month?: number | null;
/**
* Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
*/
year?: number | null;
}
/**
* Evidence that the creative's destination URL was not crawlable by Google.
*/
export interface Schema$DestinationNotCrawlableEvidence {
/**
* Destination URL that was attempted to be crawled.
*/
crawledUrl?: string | null;
/**
* Approximate time of the crawl.
*/
crawlTime?: string | null;
/**
* Reason of destination not crawlable.
*/
reason?: string | null;
}
/**
* Evidence of the creative's destination URL not functioning properly or having been incorrectly set up.
*/
export interface Schema$DestinationNotWorkingEvidence {
/**
* DNS lookup errors.
*/
dnsError?: string | null;
/**
* The full non-working URL.
*/
expandedUrl?: string | null;
/**
* HTTP error code (e.g. 404 or 5xx)
*/
httpError?: number | null;
/**
* Page was crawled successfully, but was detected as either a page with no content or an error page.
*/
invalidPage?: string | null;
/**
* Approximate time when the ad destination was last checked.
*/
lastCheckTime?: string | null;
/**
* Platform of the non-working URL.
*/
platform?: string | null;
/**
* HTTP redirect chain error.
*/
redirectionError?: string | null;
/**
* Rejected because of malformed URLs or invalid requests.
*/
urlRejected?: string | null;
}
/**
* The full landing page URL of the destination.
*/
export interface Schema$DestinationUrlEvidence {
/**
* The full landing page URL of the destination.
*/
destinationUrl?: string | null;
}
/**
* Number of HTTP calls made by a creative, broken down by domain.
*/
export interface Schema$DomainCallEvidence {
/**
* Breakdown of the most frequent domains called via HTTP by the creative.
*/
topHttpCallDomains?: Schema$DomainCalls[];
/**
* The total number of HTTP calls made by the creative, including but not limited to the number of calls in the top_http_call_domains.
*/
totalHttpCallCount?: number | null;
}
/**
* The number of HTTP calls made to the given domain.
*/
export interface Schema$DomainCalls {
/**
* The domain name.
*/
domain?: string | null;
/**
* Number of HTTP calls made to the domain.
*/
httpCallCount?: number | null;
}
/**
* Total download size and URL-level download size breakdown for resources in a creative.
*/
export interface Schema$DownloadSizeEvidence {
/**
* Download size broken down by URLs with the top download size.
*/
topUrlDownloadSizeBreakdowns?: Schema$UrlDownloadSize[];
/**
* Total download size (in kilobytes) for all the resources in the creative.
*/
totalDownloadSizeKb?: number | null;
}
/**
* A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \} The JSON representation for `Empty` is empty JSON object `{\}`.
*/
export interface Schema$Empty {
}
/**
* Bidder endpoint that receives bid requests.
*/
export interface Schema$Endpoint {
/**
* The protocol that the bidder endpoint is using.
*/
bidProtocol?: string | null;
/**
* The maximum number of queries per second allowed to be sent to this server.
*/
maximumQps?: string | null;
/**
* Output only. Name of the endpoint resource that must follow the pattern `bidders/{bidderAccountId\}/endpoints/{endpointId\}`, where {bidderAccountId\} is the account ID of the bidder who operates this endpoint, and {endpointId\} is a unique ID assigned by the server.
*/
name?: string | null;
/**
* The trading location that bid requests should be sent from. See https://developers.google.com/authorized-buyers/rtb/peer-guide#trading-locations for further information.
*/
tradingLocation?: string | null;
/**
* Output only. The URL that bid requests should be sent to.
*/
url?: string | null;
}
/**
* Response for a request to get remarketing tag.
*/
export interface Schema$GetRemarketingTagResponse {
/**
* A HTML tag that can be placed on the advertiser's page to add users to a user list. For more information and code samples on using snippet on your website refer to [Tag your site for remarketing]( https://support.google.com/google-ads/answer/2476688).
*/
snippet?: string | null;
}
/**
* HTML content for a creative.
*/
export interface Schema$HtmlContent {
/**
* The height of the HTML snippet in pixels. Can be used to filter the response of the creatives.list method.
*/
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. Can be used to filter the response of the creatives.list method.
*/
width?: number | null;
}
/**
* HTTP calls made by a creative that resulted in policy violations.
*/
export interface Schema$HttpCallEvidence {
/**
* URLs of HTTP calls made by the creative.
*/
urls?: string[] | null;
}
/**
* Evidence for HTTP cookie-related policy violations.
*/
export interface Schema$HttpCookieEvidence {
/**
* Names of cookies that violate Google policies. For TOO_MANY_COOKIES policy, this will be the cookie names of top domains with the largest number of cookies. For other policies, this will be all the cookie names that violate the policy.
*/
cookieNames?: string[] | null;
/**
* The largest number of cookies set by a creative. If this field is set, cookie_names above will be set to the cookie names of top domains with the largest number of cookies. This field will only be set for TOO_MANY_COOKIES policy.
*/
maxCookieCount?: 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;
}
/**
* A response containing bidders.
*/
export interface Schema$ListBiddersResponse {
/**
* List of bidders.
*/
bidders?: Schema$Bidder[];
/**
* A token which can be passed to a subsequent call to the `ListBidders` method to retrieve the next page of results in ListBiddersRequest.pageToken.
*/
nextPageToken?: string | null;
}
/**
* A response containing buyer account information.
*/
export interface Schema$ListBuyersResponse {
/**
* List of buyers.
*/
buyers?: Schema$Buyer[];
/**
* A token which can be passed to a subsequent call to the `ListBuyers` method to retrieve the next page of results in ListBuyersRequest.pageToken.
*/
nextPageToken?: string | null;
}
/**
* 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.pageToken field in the subsequent call to the `ListCreatives` method to retrieve the next page of results.
*/
nextPageToken?: string | null;
}
/**
* A response containing bidder endpoints.
*/
export interface Schema$ListEndpointsResponse {
/**
* List of bidder endpoints.
*/
endpoints?: Schema$Endpoint[];
/**
* A token which can be passed to a subsequent call to the `ListEndpoints` method to retrieve the next page of results in ListEndpointsRequest.pageToken.
*/
nextPageToken?: string | null;
}
/**
* A response containing pretargeting configurations.
*/
export interface Schema$ListPretargetingConfigsResponse {
/**
* A token which can be passed to a subsequent call to the `ListPretargetingConfigs` method to retrieve the next page of results in ListPretargetingConfigsRequest.pageToken.
*/
nextPageToken?: string | null;
/**
* List of pretargeting configurations.
*/
pretargetingConfigs?: Schema$PretargetingConfig[];
}
/**
* The list user list response.
*/
export interface Schema$ListUserListsResponse {
/**
* The continuation page token to send back to the server in a subsequent request. Due to a currently known issue, it is recommended that the caller keep invoking the list method till the time a next page token is not returned (even if the result set is empty).
*/
nextPageToken?: string | null;
/**
* List of user lists from the search.
*/
userLists?: Schema$UserList[];
}
/**
* Information about each media file in the VAST.
*/
export interface Schema$MediaFile {
/**
* Bitrate of the video file, in Kbps. Can be used to filter the response of the creatives.list method.
*/
bitrate?: string | null;
/**
* The MIME type of this media file. Can be used to filter the response of the creatives.list method.
*/
mimeType?: 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 fetch a native video ad.
*/
videoUrl?: string | null;
}
/**
* Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting.
*/
export interface Schema$NumericTargetingDimension {
/**
* The IDs excluded in a configuration.
*/
excludedIds?: string[] | null;
/**
* The IDs included in a configuration.
*/
includedIds?: string[] | null;
}
/**
* A request to open a specified user list.
*/
export interface Schema$OpenUserListRequest {
}
/**
* Policy compliance of the creative for a transaction type or a region.
*/
export interface Schema$PolicyCompliance {
/**
* Serving status for the given transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Can be used to filter the response of the creatives.list method.
*/
status?: string | null;
/**
* Topics related to the policy compliance for this transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Topics may be present only if status is DISAPPROVED.
*/
topics?: Schema$PolicyTopicEntry[];
}
/**
* Each policy topic entry will represent a violation of a policy topic for a creative, with the policy topic information and optional evidence for the policy violation.
*/
export interface Schema$PolicyTopicEntry {
/**
* Pieces of evidence associated with this policy topic entry.
*/
evidences?: Schema$PolicyTopicEvidence[];
/**
* URL of the help center article describing this policy topic.
*/
helpCenterUrl?: string | null;
/**
* Policy topic this entry refers to. For example, "ALCOHOL", "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible policy topics is not fixed for a particular API version and may change at any time. Can be used to filter the response of the creatives.list method
*/
policyTopic?: string | null;
}
/**
* Evidence associated with a policy topic entry.
*/
export interface Schema$PolicyTopicEvidence {
/**
* The creative's destination URL was not crawlable by Google.
*/
destinationNotCrawlable?: Schema$DestinationNotCrawlableEvidence;
/**
* The creative's destination URL did not function properly or was incorrectly set up.
*/
destinationNotWorking?: Schema$DestinationNotWorkingEvidence;
/**
* URL of the actual landing page.
*/
destinationUrl?: Schema$DestinationUrlEvidence;
/**
* Number of HTTP calls made by the creative, broken down by domain.
*/
domainCall?: Schema$DomainCallEvidence;
/**
* Total download size and URL-level download size breakdown for resources in a creative.
*/
downloadSize?: Schema$DownloadSizeEvidence;
/**
* HTTP calls made by the creative that resulted in policy violations.
*/
httpCall?: Schema$HttpCallEvidence;
/**
* Evidence for HTTP cookie-related policy violations.
*/
httpCookie?: Schema$HttpCookieEvidence;
}
/**
* Pretargeting configuration: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for.
*/
export interface Schema$PretargetingConfig {
/**
* Targeting modes included by this configuration. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow.
*/
allowedUserTargetingModes?: string[] | null;
/**
* Targeting on a subset of app inventory. If APP is listed in targeted_environments, the specified targeting is applied. A maximum of 30,000 app IDs can be targeted. An unset value for targeting allows all app-based bid requests to be sent. Apps can either be targeting positively (bid requests will be sent only if the destination app is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination app is not listed in the targeting dimension).
*/
appTargeting?: Schema$AppTargeting;
/**
* Output only. The identifier that corresponds to this pretargeting configuration that helps buyers track and attribute their spend across their own arbitrary divisions. If a bid request matches more than one configuration, the buyer chooses which billing_id to attribute each of their bids.
*/
billingId?: string | null;
/**
* The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has.
*/
displayName?: string | null;
/**
* The sensitive content category label IDs excluded in this configuration. Bid requests for inventory with any of the specified content label IDs will not be sent. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
*/
excludedContentLabelIds?: string[] | null;
/**
* The geos included or excluded in this configuration defined in https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv
*/
geoTargeting?: Schema$NumericTargetingDimension;
/**
* Creative dimensions included by this configuration. Only bid requests eligible for at least one of the specified creative dimensions will be sent. An unset value allows all bid requests to be sent, regardless of creative dimension.
*/
includedCreativeDimensions?: Schema$CreativeDimensions[];
/**
* Environments that are being included. Bid requests will not be sent for a given environment if it is not included. Further restrictions can be applied to included environments to target only a subset of its inventory. An unset value includes all environments.
*/
includedEnvironments?: string[] | null;
/**
* Creative formats included by this configuration. Only bid requests eligible for at least one of the specified creative formats will be sent. An unset value will allow all bid requests to be sent, regardless of format.
*/
includedFormats?: string[] | null;
/**
* The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes.
*/
includedLanguages?: string[] | null;
/**
* The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv
*/
includedMobileOperatingSystemIds?: string[] | null;
/**
* The platforms included by this configration. Bid requests for devices with the specified platform types will be sent. An unset value allows all bid requests to be sent, regardless of platform.
*/
includedPlatforms?: string[] | null;
/**
* User identifier types included in this configuration. At least one of the user identifier types specified in this list must be available for the bid request to be sent.
*/
includedUserIdTypes?: string[] | null;
/**
* The interstitial targeting specified for this configuration. The unset value will allow bid requests to be sent regardless of whether they are for interstitials or not.
*/
interstitialTargeting?: string | null;
/**
* Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions.
*/
invalidGeoIds?: string[] | null;
/**
* The maximum QPS threshold for this configuration. The bidder should receive no more than this number of bid requests matching this configuration per second across all their bidding endpoints among all trading locations. Further information available at https://developers.google.com/authorized-buyers/rtb/peer-guide
*/
maximumQps?: string | null;
/**
* The targeted minimum viewability decile, ranging in values [0, 10]. A value of 5 means that the configuration will only match adslots for which we predict at least 50% viewability. Values \> 10 will be rounded down to 10. An unset value or a value of 0 indicates that bid requests will be sent regardless of viewability.
*/
minimumViewabilityDecile?: number | null;
/**
* Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id\}/pretargetingConfigs/{config_id\}`
*/
name?: string | null;
/**
* Targeting on a subset of publisher inventory. Publishers can either be targeted positively (bid requests will be sent only if the publisher is listed in the targeting dimension) or negatively (bid requests will be sent only if the publisher is not listed in the targeting dimension). A maximum of 10,000 publisher IDs can be targeted. Publisher IDs are found in [ads.txt](https://iabtechlab.com/ads-txt/) / [app-ads.txt](https://iabtechlab.com/app-ads-txt/) and in bid requests in the `BidRequest.publisher_id` field on the [Google RTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) or the `BidRequest.site.publisher.id` / `BidRequest.app.publisher.id` field on the [OpenRTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto).
*/
publisherTargeting?: Schema$StringTargetingDimension;
/**
* Output only. The state of this pretargeting configuration.
*/
state?: string | null;
/**
* The remarketing lists included or excluded in this configuration as defined in UserList.
*/
userListTargeting?: Schema$NumericTargetingDimension;
/**
* The verticals included or excluded in this configuration as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
*/
verticalTargeting?: Schema$NumericTargetingDimension;
/**
* Targeting on a subset of site inventory. If WEB is listed in included_environments, the specified targeting is applied. A maximum of 50,000 site URLs can be targeted. An unset value for targeting allows all web-based bid requests to be sent. Sites can either be targeting positively (bid requests will be sent only if the destination site is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination site is not listed in the pretargeting configuration).
*/
webTargeting?: Schema$StringTargetingDimension;
}
/**
* A request to stop targeting the provided apps in a specific pretargeting configuration. The pretargeting configuration itself specifies how these apps are targeted. in PretargetingConfig.appTargeting.mobileAppTargeting.
*/
export interface Schema$RemoveTargetedAppsRequest {
/**
* A list of app IDs to stop targeting in the pretargeting configuration. These values will be removed from the list of targeted app IDs in PretargetingConfig.appTargeting.mobileAppTargeting.values.
*/
appIds?: string[] | null;
}
/**
* A request to stop targeting publishers in a specific configuration. The pretargeting configuration itself specifies how these publishers are targeted in PretargetingConfig.publisherTargeting.
*/
export interface Schema$RemoveTargetedPublishersRequest {
/**
* A list of publisher IDs to stop targeting in the pretargeting configuration. These values will be removed from the list of targeted publisher IDs in PretargetingConfig.publisherTargeting.values. Publishers are identified by their publisher ID from ads.txt / app-ads.txt. See https://iabtechlab.com/ads-txt/ and https://iabtechlab.com/app-ads-txt/ for more details.
*/
publisherIds?: string[] | null;
}
/**
* A request to stop targeting sites in a specific pretargeting configuration. The pretargeting configuration itself specifies how these sites are targeted in PretargetingConfig.webTargeting.
*/
export interface Schema$RemoveTargetedSitesRequest {
/**
* A list of site URLs to stop targeting in the pretargeting configuration. These values will be removed from the list of targeted URLs in PretargetingConfig.webTargeting.values.
*/
sites?: string[] | null;
}
/**
* Generic targeting with string values used in app, website and publisher targeting.
*/
export interface Schema$StringTargetingDimension {
/**
* How the items in this list should be targeted.
*/
targetingMode?: string | null;
/**
* The values specified.
*/
values?: string[] | null;
}
/**
* A request to suspend a pretargeting configuration. Sets the configuration's state to SUSPENDED.
*/
export interface Schema$SuspendPretargetingConfigRequest {
}
/**
* The URL-level breakdown for the download size.
*/
export interface Schema$UrlDownloadSize {
/**
* Download size of the URL in kilobytes.
*/
downloadSizeKb?: number | null;
/**
* The normalized URL with query parameters and fragment removed.
*/
normalizedUrl?: string | null;
}
/**
* Represents the URL restriction (for the URL captured by the pixel callback) for a user list.
*/
export interface Schema$UrlRestriction {
/**
* End date (if specified) of the URL restriction. End date should be later than the start date for the date range to be valid.
*/
endDate?: Schema$Date;
/**
* The restriction type for the specified URL.
*/
restrictionType?: string | null;
/**
* Start date (if specified) of the URL restriction.
*/
startDate?: Schema$Date;
/**
* Required. The URL to use for applying the restriction on the user list.
*/
url?: string | null;
}
/**
* Represents an Authorized Buyers user list. Authorized Buyers can create/update/list user lists. Once a user list is created in the system, Authorized Buyers can add users to the user list using the bulk uploader API. Alternatively, users can be added by hosting a tag on the advertiser's page.
*/
export interface Schema$UserList {
/**
* The description for the user list.
*/
description?: string | null;
/**
* Required. Display name of the user list. This must be unique across all user lists for a given account.
*/
displayName?: string | null;
/**
* Required. The number of days a user's cookie stays on the user list. The field must be between 0 and 540 inclusive.
*/
membershipDurationDays?: string | null;
/**
* Output only. Name of the user list that must follow the pattern `buyers/{buyer\}/userLists/{user_list\}`, where `{buyer\}` represents the account ID of the buyer who owns the user list. For a bidder accessing user lists on behalf of a child seat buyer, `{buyer\}` represents the account ID of the child seat buyer. `{user_list\}` is an int64 identifier assigned by Google to uniquely identify a user list.
*/
name?: string | null;
/**
* Output only. The status of the user list. A new user list starts out as open.
*/
status?: string | null;
/**
* Required. The URL restriction for the user list.
*/
urlRestriction?: Schema$UrlRestriction;
}
/**
* Video content for a creative.
*/
export interface Schema$VideoContent {
/**
* Output only. Video metadata.
*/
videoMetadata?: Schema$VideoMetadata;
/**
* 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;
}
/**
* Video metadata for a creative.
*/
export interface Schema$VideoMetadata {
/**
* The duration of the ad. Can be used to filter the response of the creatives.list method.
*/
duration?: string | null;
/**
* Is this a valid VAST ad? Can be used to filter the response of the creatives.list method.
*/
isValidVast?: boolean | null;
/**
* Is this a VPAID ad? Can be used to filter the response of the creatives.list method.
*/
isVpaid?: boolean | null;
/**
* The list of all media files declared in the VAST. If there are multiple VASTs in a wrapper chain, this includes the media files from the deepest one in the chain.
*/
mediaFiles?: Schema$MediaFile[];
/**
* The minimum duration that the user has to watch before being able to skip this ad. If the field is not set, the ad is not skippable. If the field is set, the ad is skippable. Can be used to filter the response of the creatives.list method.
*/
skipOffset?: string | null;
/**
* The maximum VAST version across all wrapped VAST documents. Can be used to filter the response of the creatives.list method.
*/
vastVersion?: string | null;
}
/**
* A request to receive push notifications when any of the creatives belonging to the bidder changes status.
*/
export interface Schema$WatchCreativesRequest {
}
/**
* A response for the request to receive push notification when a bidder's creatives change status.
*/
export interface Schema$WatchCreativesResponse {
/**
* The Pub/Sub subscription that can be used to pull creative status notifications. This would be of the format `projects/{project_id\}/subscriptions/{subscription_id\}`. Subscription is created with pull delivery. All service accounts belonging to the bidder will have read access to this subscription. Subscriptions that are inactive for more than 90 days will be disabled. Please use watchCreatives to re-enable the subscription.
*/
subscription?: string | null;
/**
* The Pub/Sub topic that will be used to publish creative serving status notifications. This would be of the format `projects/{project_id\}/topics/{topic_id\}`.
*/
topic?: string | null;
}
export class Resource$Bidders {
context: APIRequestContext;
creatives: Resource$Bidders$Creatives;
endpoints: Resource$Bidders$Endpoints;
pretargetingConfigs: Resource$Bidders$Pretargetingconfigs;
constructor(context: APIRequestContext);
/**
* Gets a bidder account by its name.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/realtimebidding.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const realtimebidding = google.realtimebidding('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/realtime-bidding'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await realtimebidding.bidders.get({
* // Required. Name of the bidder to get. Format: `bidders/{bidderAccountId\}`
* name: 'bidders/my-bidder',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "bypassNonguaranteedDealsPretargeting": false,
* // "cookieMatchingNetworkId": "my_cookieMatchingNetworkId",
* // "cookieMatchingUrl": "my_cookieMatchingUrl",
* // "dealsBillingId": "my_dealsBillingId",
* // "name": "my_name"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Bidders$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Bidders$Get, options?: MethodOptions): GaxiosPromise<Schema$Bidder>;
get(params: Params$Resource$Bidders$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Bidders$Get, options: MethodOptions | BodyResponseCallback<Schema$Bidder>, callback: BodyResponseCallback<Schema$Bidder>): void;
get(params: Params$Resource$Bidders$Get, callback: BodyResponseCallback<Schema$Bidder>): void;
get(callback: BodyResponseCallback<Schema$Bidder>): void;
/**
* Lists all the bidder accounts that belong to the caller.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/realtimebidding.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const realtimebidding = google.realtimebidding('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/realtime-bidding'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await realtimebidding.bidders.list({
* // The maximum number of bidders to return. If unspecified, at most 100 bidders will be returned. The maximum value is 500; values above 500 will be coerced to 500.
* pageSize: 'placeholder-value',
* // A token identifying a page of results the server should return. This value is received from a previous `ListBidders` call in ListBiddersResponse.nextPageToken.
* pageToken: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "bidders": [],
* // "nextPageToken": "my_nextPageToken"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Bidders$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Bidders$List, options?: MethodOptions): GaxiosPromise<Schema$ListBiddersResponse>;
list(params: Params$Resource$Bidders$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Bidders$List, options: MethodOptions | BodyResponseCallback<Schema$ListBiddersResponse>, callback: BodyResponseCallback<Schema$ListBiddersResponse>): void;
list(params: Params$Resource$Bidders$List, callback: BodyResponseCallback<Schema$ListBiddersResponse>): void;
list(callback: BodyResponseCallback<Schema$ListBiddersResponse>): void;
}
export interface Params$Resource$Bidders$Get extends StandardParameters {
/**
* Required. Name of the bidder to get. Format: `bidders/{bidderAccountId\}`
*/
name?: string;
}
export interface Params$Resource$Bidders$List extends StandardParameters {
/**
* The maximum number of bidders to return. If unspecified, at most 100 bidders will be returned. The maximum value is 500; values above 500 will be coerced to 500.
*/
pageSize?: number;
/**
* A token identifying a page of results the server should return. This value is received from a previous `ListBidders` call in ListBiddersResponse.nextPageToken.
*/
pageToken?: string;
}
export class Resource$Bidders$Creatives {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Lists creatives.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/realtimebidding.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const realtimebidding = google.realtimebidding('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/realtime-bidding'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await realtimebidding.bidders.creatives.list({
* // Query string to filter creatives. If no filter is specified, all active creatives will be returned. Example: 'accountId=12345 AND (dealsStatus:DISAPPROVED AND disapprovalReason:UNACCEPTABLE_CONTENT) OR declaredAttributes:IS_COOKIE_TARGETED'
* filter: 'placeholder-value',
* // 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: 'placeholder-value',
* // A token identifying a page of results the server should return. Typically, this is the value of ListCreativesResponse.nextPageToken returned from the previous call to the 'ListCreatives' method.
* pageToken: 'placeholder-value',
* // Required. Name of the parent buyer that owns the creatives. The pattern for this resource is either `buyers/{buyerAccountId\}` or `bidders/{bidderAccountId\}`. For `buyers/{buyerAccountId\}`, the `buyerAccountId` can be one of the following: 1. The ID of the buyer that is accessing their own creatives. 2. The ID of the child seat buyer under a bidder account. So for listing creatives pertaining to the child seat buyer (`456`) under bidder account (`123`), you would use the pattern: `buyers/456`. 3. The ID of the bidder itself. So for listing creatives pertaining to bidder (`123`), you would use `buyers/123`. If you want to access all creatives pertaining to both the bidder and all of its child seat accounts, you would use `bidders/{bidderAccountId\}`, e.g., for all creatives pertaining to bidder (`123`), use `bidders/123`.
* parent: 'bidders/my-bidder',
* // Controls the amount of information included in the response. By default only creativeServingDecision is included. To retrieve the entire creative resource (including the declared fields and the creative content) specify the view as "FULL".
* view: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "creatives": [],
* // "nextPageToken": "my_nextPageToken"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Bidders$Creatives$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Bidders$Creatives$List, options?: MethodOptions): GaxiosPromise<Schema$ListCreativesResponse>;
list(params: Params$Resource$Bidders$Creatives$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Bidders$Creatives$List, options: MethodOptions | BodyResponseCallback<Schema$ListCreativesResponse>, callback: BodyResponseCallback<Schema$ListCreativesResponse>): void;
list(params: Params$Resource$Bidders$Creatives$List, callback: BodyResponseCallback<Schema$ListCreativesResponse>): void;
list(callback: BodyResponseCallback<Schema$ListCreativesResponse>): void;
/**
* Watches all creatives pertaining to a bidder. It is sufficient to invoke this endpoint once per bidder. A Pub/Sub topic will be created and notifications will be pushed to the topic when any of the bidder's creatives change status. All of the bidder's service accounts will have access to read from the topic. Subsequent invocations of this method will return the existing Pub/Sub configuration.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/realtimebidding.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const realtimebidding = google.realtimebidding('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/realtime-bidding'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await realtimebidding.bidders.creatives.watch({
* // Required. To watch all creatives pertaining to the bidder and all its child seat accounts, the bidder must follow the pattern `bidders/{bidderAccountId\}`.
* parent: 'bidders/my-bidder',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {}
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "subscription": "my_subscription",
* // "topic": "my_topic"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
watch(params: Params$Resource$Bidders$Creatives$Watch, options: StreamMethodOptions): GaxiosPromise<Readable>;
watch(params?: Params$Resource$Bidders$Creatives$Watch, options?: MethodOptions): GaxiosPromise<Schema$WatchCreativesResponse>;
watch(params: Params$Resource$Bidders$Creatives$Watch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
watch(params: Params$Resource$Bidders$Creatives$Watch, options: MethodOptions | BodyResponseCallback<Schema$WatchCreativesResponse>, callback: BodyResponseCallback<Schema$WatchCreativesResponse>): void;
watch(params: Params$Resource$Bidders$Creatives$Watch, callback: BodyResponseCallback<Schema$WatchCreativesResponse>): void;
watch(callback: BodyResponseCallback<Schema$WatchCreativesResponse>): void;
}
export interface Params$Resource$Bidders$Creatives$List extends StandardParameters {
/**
* Query string to filter creatives. If no filter is specified, all active creatives will be returned. Example: 'accountId=12345 AND (dealsStatus:DISAPPROVED AND disapprovalReason:UNACCEPTABLE_CONTENT) OR declaredAttributes:IS_COOKIE_TARGETED'
*/
filter?: 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.nextPageToken returned from the previous call to the 'ListCreatives' method.
*/
pageToken?: string;
/**
* Required. Name of the parent buyer that owns the creatives. The pattern for this resource is either `buyers/{buyerAccountId\}` or `bidders/{bidderAccountId\}`. For `buyers/{buyerAccountId\}`, the `buyerAccountId` can be one of the following: 1. The ID of the buyer that is accessing their own creatives. 2. The ID of the child seat buyer under a bidder account. So for listing creatives pertaining to the child seat buyer (`456`) under bidder account (`123`), you would use the pattern: `buyers/456`. 3. The ID of the bidder itself. So for listing creatives pertaining to bidder (`123`), you would use `buyers/123`. If you want to access all creatives pertaining to both the bidder and all of its child seat accounts, you would use `bidders/{bidderAccountId\}`, e.g., for all creatives pertaining to bidder (`123`), use `bidders/123`.
*/
parent?: string;
/**
* Controls the amount of information included in the response. By default only creativeServingDecision is included. To retrieve the entire creative resource (including the declared fields and the creative content) specify the view as "FULL".
*/
view?: string;
}
export interface Params$Resource$Bidders$Creatives$Watch extends StandardParameters {
/**
* Required. To watch all creatives pertaining to the bidder and all its child seat accounts, the bidder must follow the pattern `bidders/{bidderAccountId\}`.
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$WatchCreativesRequest;
}
export class Resource$Bidders$Endpoints {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Gets a bidder endpoint by its name.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/realtimebidding.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const realtimebidding = google.realtimebidding('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/realtime-bidding'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await realtimebidding.bidders.endpoints.get({
* // Required. Name of the bidder endpoint to get. Format: `bidders/{bidderAccountId\}/endpoints/{endpointId\}`
* name: 'bidders/my-bidder/endpoints/my-endpoint',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "bidProtocol": "my_bidProtocol",
* // "maximumQps": "my_maximumQps",
* // "name": "my_name",
* // "tradingLocation": "my_tradingLocation",
* // "url": "my_url"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Bidders$Endpoints$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Bidders$Endpoints$Get, options?: MethodOptions): GaxiosPromise<Schema$Endpoint>;
get(params: Params$Resource$Bidders$Endpoints$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Bidders$Endpoints$Get, options: MethodOptions | BodyResponseCallback<Schema$Endpoint>, callback: BodyResponseCallback<Schema$Endpoint>): void;
get(params: Params$Resource$Bidders$Endpoints$Get, callback: BodyResponseCallback<Schema$Endpoint>): void;
get(callback: BodyResponseCallback<Schema$Endpoint>): void;
/**
* Lists all the bidder's endpoints.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/realtimebidding.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const realtimebidding = google.realtimebidding('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/realtime-bidding'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await realtimebidding.bidders.endpoints.list({
* // The maximum number of endpoints to return. If unspecified, at most 100 endpoints will be returned. The maximum value is 500; values above 500 will be coerced to 500.
* pageSize: 'placeholder-value',
* // A token identifying a page of results the server should return. This value is received from a previous `ListEndpoints` call in ListEndpointsResponse.nextPageToken.
* pageToken: 'placeholder-value',
* // Required. Name of the bidder whose endpoints will be listed. Format: `bidders/{bidderAccountId\}`
* parent: 'bidders/my-bidder',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "endpoints": [],
* // "nextPageToken": "my_nextPageToken"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Bidders$Endpoints$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Bidders$Endpoints$List, options?: MethodOptions): GaxiosPromise<Schema$ListEndpointsResponse>;
list(params: Params$Resource$Bidders$Endpoints$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Bidders$Endpoints$List, options: MethodOptions | BodyResponseCallback<Schema$ListEndpointsResponse>, callback: BodyResponseCallback<Schema$ListEndpointsResponse>): void;
list(params: Params$Resource$Bidders$Endpoints$List, callback: BodyResponseCallback<Schema$ListEndpointsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListEndpointsResponse>): void;
}
export interface Params$Resource$Bidders$Endpoints$Get extends StandardParameters {
/**
* Required. Name of the bidder endpoint to get. Format: `bidders/{bidderAccountId\}/endpoints/{endpointId\}`
*/
name?: string;
}
export interface Params$Resource$Bidders$Endpoints$List extends StandardParameters {
/**
* The maximum number of endpoints to return. If unspecified, at most 100 endpoints will be returned. The maximum value is 500; values above 500 will be coerced to 500.
*/
pageSize?: number;
/**
* A token identifying a page of results the server should return. This value is received from a previous `ListEndpoints` call in ListEndpointsResponse.nextPageToken.
*/
pageToken?: string;
/**
* Required. Name of the bidder whose endpoints will be listed. Format: `bidders/{bidderAccountId\}`
*/
parent?: string;
}
export class Resource$Bidders$Pretargetingconfigs {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Activates a pretargeting configuration.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/realtimebidding.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const realtimebidding = google.realtimebidding('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/realtime-bidding'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await realtimebidding.bidders.pretargetingConfigs.activate({
* // Required. The name of the pretargeting configuration. Format: bidders/{bidderAccountId\}/pretargetingConfig/{configId\}
* name: 'bidders/my-bidder/pretargetingConfigs/my-pretargetingConfig',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {}
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "allowedUserTargetingModes": [],
* // "appTargeting": {},
* // "billingId": "my_billingId",
* // "displayName": "my_displayName",
* // "excludedContentLabelIds": [],
* // "geoTargeting": {},
* // "includedCreativeDimensions": [],
* // "includedEnvironments": [],
* // "includedFormats": [],
* // "includedLanguages": [],
* // "includedMobileOperatingSystemIds": [],
* // "includedPlatforms": [],
* // "includedUserIdTypes": [],
* // "interstitialTargeting": "my_interstitialTargeting",
* // "invalidGeoIds": [],
* // "maximumQps": "my_maximumQps",
* // "minimumViewabilityDecile": 0,
* // "name": "my_name",
* // "publisherTargeting": {},
* // "state": "my_state",
* // "userListTargeting": {},
* // "verticalTargeting": {},
* // "webTargeting": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
activate(params: Params$Resource$Bidders$Pretargetingconfigs$Activate, options: StreamMethodOptions): GaxiosPromise<Readable>;
activate(params?: Params$Resource$Bidders$Pretargetingconfigs$Activate, options?: MethodOptions): GaxiosPromise<Schema$PretargetingConfig>;
activate(params: Params$Resource$Bidders$Pretargetingconfigs$Activate, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
activate(params: Params$Resource$Bidders$Pretargetingconfigs$Activate, options: MethodOptions | BodyResponseCallback<Schema$PretargetingConfig>, callback: BodyResponseCallback<Schema$PretargetingConfig>): void;
activate(params: Params$Resource$Bidders$Pretargetingconfigs$Activate, callback: BodyResponseCallback<Schema$PretargetingConfig>): void;
activate(callback: BodyResponseCallback<Schema$PretargetingConfig>): void;
/**
* Adds targeted apps to the pretargeting configuration.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/realtimebidding.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const realtimebidding = google.realtimebidding('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/realtime-bidding'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await realtimebidding.bidders.pretargetingConfigs.addTargetedApps(
* {
* // Required. The name of the pretargeting configuration. Format: bidders/{bidderAccountId\}/pretargetingConfig/{configId\}
* pretargetingConfig:
* 'bidders/my-bidder/pretargetingConfigs/my-pretargetingConfig',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "appIds": [],
* // "targetingMode": "my_targetingMode"
* // }
* },
* }
* );
* console.log(res.data);
*
* // Example response
* // {
* // "allowedUserTargetingModes": [],
* // "appTargeting": {},
* // "billingId": "my_billingId",
* // "displayName": "my_displayName",
* // "excludedContentLabelIds": [],
* // "geoTargeting": {},
* // "includedCreativeDimensions": [],
* // "includedEnvironments": [],
* // "includedFormats": [],
* // "includedLanguages": [],
* // "includedMobileOperatingSystemIds": [],
* // "includedPlatforms": [],
* // "includedUserIdTypes": [],
* // "interstitialTargeting": "my_interstitialTargeting",
* // "invalidGeoIds": [],
* // "maximumQps": "my_maximumQps",
* // "minimumViewabilityDecile": 0,
* // "name": "my_name",
* // "publisherTargeting": {},
* // "state": "my_state",
* // "userListTargeting": {},
* // "verticalTargeting": {},
* // "webTargeting": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
addTargetedApps(params: Params$Resource$Bidders$Pretargetingconfigs$Addtargetedapps, options: StreamMethodOptions): GaxiosPromise<Readable>;
addTargetedApps(params?: Params$Resource$Bidders$Pretargetingconfigs$Addtargetedapps, options?: MethodOptions): GaxiosPromise<Schema$PretargetingConfig>;
addTargetedApps(params: Params$Resource$Bidders$Pretargetingconfigs$Addtargetedapps, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
addTargetedApps(params: Params$Resource$Bidders$Pretargetingconfigs$Addtargetedapps, options: MethodOptions | BodyResponseCallback<Schema$PretargetingConfig>, callback: BodyResponseCallback<Schema$PretargetingConfig>): void;
addTargetedApps(params: Params$Resource$Bidders$Pretargetingconfigs$Addtargetedapps, callback: BodyResponseCallback<Schema$PretargetingConfig>): void;
addTargetedApps(callback: BodyResponseCallback<Schema$PretargetingConfig>): void;
/**
* Adds targeted publishers to the pretargeting config.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/realtimebidding.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const realtimebidding = google.realtimebidding('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/realtime-bidding'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res =
* await realtimebidding.bidders.pretargetingConfigs.addTargetedPublishers({
* // Required. The name of the pretargeting configuration. Format: bidders/{bidderAccountId\}/pretargetingConfig/{configId\}
* pretargetingConfig:
* 'bidders/my-bidder/pretargetingConfigs/my-pretargetingConfig',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "publisherIds": [],
* // "targetingMode": "my_targetingMode"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "allowedUserTargetingModes": [],
* // "appTargeting": {},
* // "billingId": "my_billingId",
* // "displayName": "my_displayName",
* // "excludedContentLabelIds": [],
* // "geoTargeting": {},
* // "includedCreativeDimensions": [],
* // "includedEnvironments": [],
* // "includedFormats": [],
* // "includedLanguages": [],
* // "includedMobileOperatingSystemIds": [],
* // "includedPlatforms": [],
* // "includedUserIdTypes": [],
* // "interstitialTargeting": "my_interstitialTargeting",
* // "invalidGeoIds": [],
* // "maximumQps": "my_maximumQps",
* // "minimumViewabilityDecile": 0,
* // "name": "my_name",
* // "publisherTargeting": {},
* // "state": "my_state",
* // "userListTargeting": {},
* // "verticalTargeting": {},
* // "webTargeting": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
addTargetedPublishers(params: Params$Resource$Bidders$Pretargetingconfigs$Addtargetedpublishers, options: StreamMethodOptions): GaxiosPromise<Readable>;
addTargetedPublishers(params?: Params$Resource$Bidders$Pretargetingconfigs$Addtargetedpublishers, options?: MethodOptions): GaxiosPromise<Schema$PretargetingConfig>;
addTargetedPublishers(params: Params$Resource$Bidders$Pretargetingconfigs$Addtargetedpublishers, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
addTargetedPublishers(params: Params$Resource$Bidders$Pretargetingconfigs$Addtargetedpublishers, options: MethodOptions | BodyResponseCallback<Schema$PretargetingConfig>, callback: BodyResponseCallback<Schema$PretargetingConfig>): void;
addTargetedPublishers(params: Params$Resource$Bidders$Pretargetingconfigs$Addtargetedpublishers, callback: BodyResponseCallback<Schema$PretargetingConfig>): void;
addTargetedPublishers(callback: BodyResponseCallback<Schema$PretargetingConfig>): void;
/**
* Adds targeted sites to the pretargeting configuration.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/realtimebidding.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const realtimebidding = google.realtimebidding('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/realtime-bidding'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res =
* await realtimebidding.bidders.pretargetingConfigs.addTargetedSites({
* // Required. The name of the pretargeting configuration. Format: bidders/{bidderAccountId\}/pretargetingConfig/{configId\}
* pretargetingConfig:
* 'bidders/my-bidder/pretargetingConfigs/my-pretargetingConfig',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "sites": [],
* // "targetingMode": "my_targetingMode"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "allowedUserTargetingModes": [],
* // "appTargeting": {},
* // "billingId": "my_billingId",
* // "displayName": "my_displayName",
* // "excludedContentLabelIds": [],
* // "geoTargeting": {},
* // "includedCreativeDimensions": [],
* // "includedEnvironments": [],
* // "includedFormats": [],
* // "includedLanguages": [],
* // "includedMobileOperatingSystemIds": [],
* // "includedPlatforms": [],
* // "includedUserIdTypes": [],
* // "interstitialTargeting": "my_interstitialTargeting",
* // "invalidGeoIds": [],
* // "maximumQps": "my_maximumQps",
* // "minimumViewabilityDecile": 0,
* // "name": "my_name",
* // "publisherTargeting": {},
* // "state": "my_state",
* // "userListTargeting": {},
* // "verticalTargeting": {},
* // "webTargeting": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
addTargetedSites(params: Params$Resource$Bidders$Pretargetingconfigs$Addtargetedsites, options: StreamMethodOptions): GaxiosPromise<Readable>;
addTargetedSites(params?: Params$Resource$Bidders$Pretargetingconfigs$Addtargetedsites, options?: MethodOptions): GaxiosPromise<Schema$PretargetingConfig>;
addTargetedSites(params: Params$Resource$Bidders$Pretargetingconfigs$Addtargetedsites, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
addTargetedSites(params: Params$Resource$Bidders$Pretargetingconfigs$Addtargetedsites, options: MethodOptions | BodyResponseCallback<Schema$PretargetingConfig>, callback: BodyResponseCallback<Schema$PretargetingConfig>): void;
addTargetedSites(params: Params$Resource$Bidders$Pretargetingconfigs$Addtargetedsites, callback: BodyResponseCallback<Schema$PretargetingConfig>): void;
addTargetedSites(callback: BodyResponseCallback<Schema$PretargetingConfig>): void;
/**
* Creates a pretargeting configuration. A pretargeting configuration's state (PretargetingConfig.state) is active upon creation, and it will start to affect traffic shortly after. A bidder may create a maximum of 10 pretargeting configurations. Attempts to exceed this maximum results in a 400 bad request error.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/realtimebidding.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const realtimebidding = google.realtimebidding('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/realtime-bidding'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await realtimebidding.bidders.pretargetingConfigs.create({
* // Required. Name of the bidder to create the pretargeting configuration for. Format: bidders/{bidderAccountId\}
* parent: 'bidders/my-bidder',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "allowedUserTargetingModes": [],
* // "appTargeting": {},
* // "billingId": "my_billingId",
* // "displayName": "my_displayName",
* // "excludedContentLabelIds": [],
* // "geoTargeting": {},
* // "includedCreativeDimensions": [],
* // "includedEnvironments": [],
* // "includedFormats": [],
* // "includedLanguages": [],
* // "includedMobileOperatingSystemIds": [],
* // "includedPlatforms": [],
* // "includedUserIdTypes": [],
* // "interstitialTargeting": "my_interstitialTargeting",
* // "invalidGeoIds": [],
* // "maximumQps": "my_maximumQps",
* // "minimumViewabilityDecile": 0,
* // "name": "my_name",
* // "publisherTargeting": {},
* // "state": "my_state",
* // "userListTargeting": {},
* // "verticalTargeting": {},
* // "webTargeting": {}
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "allowedUserTargetingModes": [],
* // "appTargeting": {},
* // "billingId": "my_billingId",
* // "displayName": "my_displayName",
* // "excludedContentLabelIds": [],
* // "geoTargeting": {},
* // "includedCreativeDimensions": [],
* // "includedEnvironments": [],
* // "includedFormats": [],
* // "includedLanguages": [],
* // "includedMobileOperatingSystemIds": [],
* // "includedPlatforms": [],
* // "includedUserIdTypes": [],
* // "interstitialTargeting": "my_interstitialTargeting",
* // "invalidGeoIds": [],
* // "maximumQps": "my_maximumQps",
* // "minimumViewabilityDecile": 0,
* // "name": "my_name",
* // "publisherTargeting": {},
* // "state": "my_state",
* // "userListTargeting": {},
* // "verticalTargeting": {},
* // "webTargeting": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
create(params: Params$Resource$Bidders$Pretargetingconfigs$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
create(params?: Params$Resource$Bidders$Pretargetingconfigs$Create, options?: MethodOptions): GaxiosPromise<Schema$PretargetingConfig>;
create(params: Params$Resource$Bidders$Pretargetingconfigs$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
create(params: Params$Resource$Bidders$Pretargetingconfigs$Create, options: MethodOptions | BodyResponseCallback<Schema$PretargetingConfig>, callback: BodyResponseCallback<Schema$PretargetingConfig>): void;
create(params: Params$Resource$Bidders$Pretargetingconfigs$Create, callback: BodyResponseCallback<Schema$PretargetingConfig>): void;
create(callback: BodyResponseCallback<Schema$PretargetingConfig>): void;
/**
* Deletes a pretargeting configuration.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/realtimebidding.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const realtimebidding = google.realtimebidding('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/realtime-bidding'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await realtimebidding.bidders.pretargetingConfigs.delete({
* // Required. The name of the pretargeting configuration to delete. Format: bidders/{bidderAccountId\}/pretargetingConfig/{configId\}
* name: 'bidders/my-bidder/pretargetingConfigs/my-pretargetingConfig',
* });
* console.log(res.data);
*
* // Example response
* // {}
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
delete(params: Params$Resource$Bidders$Pretargetingconfigs$Delete, options: StreamMethodOptions): GaxiosPromise<Readable>;
delete(params?: Params$Resource$Bidders$Pretargetingconfigs$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Bidders$Pretargetingconfigs$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
delete(params: Params$Resource$Bidders$Pretargetingconfigs$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Bidders$Pretargetingconfigs$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* Gets a pretargeting configuration.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/realtimebidding.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const realtimebidding = google.realtimebidding('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/realtime-bidding'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await realtimebidding.bidders.pretargetingConfigs.get({
* // Required. Name of the pretargeting configuration to get. Format: bidders/{bidderAccountId\}/pretargetingConfig/{configId\}
* name: 'bidders/my-bidder/pretargetingConfigs/my-pretargetingConfig',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "allowedUserTargetingModes": [],
* // "appTargeting": {},
* // "billingId": "my_billingId",
* // "displayName": "my_displayName",
* // "excludedContentLabelIds": [],
* // "geoTargeting": {},
* // "includedCreativeDimensions": [],
* // "includedEnvironments": [],
* // "includedFormats": [],
* // "includedLanguages": [],
* // "includedMobileOperatingSystemIds": [],
* // "includedPlatforms": [],
* // "includedUserIdTypes": [],
* // "interstitialTargeting": "my_interstitialTargeting",
* // "invalidGeoIds": [],
* // "maximumQps": "my_maximumQps",
* // "minimumViewabilityDecile": 0,
* // "name": "my_name",
* // "publisherTargeting": {},
* // "state": "my_state",
* // "userListTargeting": {},
* // "verticalTargeting": {},
* // "webTargeting": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Bidders$Pretargetingconfigs$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Bidders$Pretargetingconfigs$Get, options?: MethodOptions): GaxiosPromise<Schema$PretargetingConfig>;
get(params: Params$Resource$Bidders$Pretargetingconfigs$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Bidders$Pretargetingconfigs$Get, options: MethodOptions | BodyResponseCallback<Schema$PretargetingConfig>, callback: BodyResponseCallback<Schema$PretargetingConfig>): void;
get(params: Params$Resource$Bidders$Pretargetingconfigs$Get, callback: BodyResponseCallback<Schema$PretargetingConfig>): void;
get(callback: BodyResponseCallback<Schema$PretargetingConfig>): void;
/**
* Lists all pretargeting configurations for a single bidder.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/realtimebidding.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const realtimebidding = google.realtimebidding('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/realtime-bidding'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await realtimebidding.bidders.pretargetingConfigs.list({
* // The maximum number of pretargeting configurations to return. If unspecified, at most 10 pretargeting configurations will be returned. The maximum value is 100; values above 100 will be coerced to 100.
* pageSize: 'placeholder-value',
* // A token identifying a page of results the server should return. This value is received from a previous `ListPretargetingConfigs` call in ListPretargetingConfigsResponse.nextPageToken.
* pageToken: 'placeholder-value',
* // Required. Name of the bidder whose pretargeting configurations will be listed. Format: bidders/{bidderAccountId\}
* parent: 'bidders/my-bidder',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "nextPageToken": "my_nextPageToken",
* // "pretargetingConfigs": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Bidders$Pretargetingconfigs$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Bidders$Pretargetingconfigs$List, options?: MethodOptions): GaxiosPromise<Schema$ListPretargetingConfigsResponse>;
list(params: Params$Resource$Bidders$Pretargetingconfigs$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Bidders$Pretargetingconfigs$List, options: MethodOptions | BodyResponseCallback<Schema$ListPretargetingConfigsResponse>, callback: BodyResponseCallback<Schema$ListPretargetingConfigsResponse>): void;
list(params: Params$Resource$Bidders$Pretargetingconfigs$List, callback: BodyResponseCallback<Schema$ListPretargetingConfigsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListPretargetingConfigsResponse>): void;
/**
* Updates a pretargeting configuration.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/realtimebidding.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const realtimebidding = google.realtimebidding('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/realtime-bidding'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await realtimebidding.bidders.pretargetingConfigs.patch({
* // Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id\}/pretargetingConfigs/{config_id\}`
* name: 'bidders/my-bidder/pretargetingConfigs/my-pretargetingConfig',
* // Field mask to use for partial in-place updates.
* updateMask: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "allowedUserTargetingModes": [],
* // "appTargeting": {},
* // "billingId": "my_billingId",
* // "displayName": "my_displayName",
* // "excludedContentLabelIds": [],
* // "geoTargeting": {},
* // "includedCreativeDimensions": [],
* // "includedEnvironments": [],
* // "includedFormats": [],
* // "includedLanguages": [],
* // "includedMobileOperatingSystemIds": [],
* // "includedPlatforms": [],
* // "includedUserIdTypes": [],
* // "interstitialTargeting": "my_interstitialTargeting",
* // "invalidGeoIds": [],
* // "maximumQps": "my_maximumQps",
* // "minimumViewabilityDecile": 0,
* // "name": "my_name",
* // "publisherTargeting": {},
* // "state": "my_state",
* // "userListTargeting": {},
* // "verticalTargeting": {},
* // "webTargeting": {}
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "allowedUserTargetingModes": [],
* // "appTargeting": {},
* // "billingId": "my_billingId",
* // "displayName": "my_displayName",
* // "excludedContentLabelIds": [],
* // "geoTargeting": {},
* // "includedCreativeDimensions": [],
* // "includedEnvironments": [],
* // "includedFormats": [],
* // "includedLanguages": [],
* // "includedMobileOperatingSystemIds": [],
* // "includedPlatforms": [],
* // "includedUserIdTypes": [],
* // "interstitialTargeting": "my_interstitialTargeting",
* // "invalidGeoIds": [],
* // "maximumQps": "my_maximumQps",
* // "minimumViewabilityDecile": 0,
* // "name": "my_name",
* // "publisherTargeting": {},
* // "state": "my_state",
* // "userListTargeting": {},
* // "verticalTargeting": {},
* // "webTargeting": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
patch(params: Params$Resource$Bidders$Pretargetingconfigs$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
patch(params?: Params$Resource$Bidders$Pretargetingconfigs$Patch, options?: MethodOptions): GaxiosPromise<Schema$PretargetingConfig>;
patch(params: Params$Resource$Bidders$Pretargetingconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
patch(params: Params$Resource$Bidders$Pretargetingconfigs$Patch, options: MethodOptions | BodyResponseCallback<Schema$PretargetingConfig>, callback: BodyResponseCallback<Schema$PretargetingConfig>): void;
patch(params: Params$Resource$Bidders$Pretargetingconfigs$Patch, callback: BodyResponseCallback<Schema$PretargetingConfig>): void;
patch(callback: BodyResponseCallback<Schema$PretargetingConfig>): void;
/**
* Removes targeted apps from the pretargeting configuration.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/realtimebidding.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const realtimebidding = google.realtimebidding('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/realtime-bidding'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res =
* await realtimebidding.bidders.pretargetingConfigs.removeTargetedApps({
* // Required. The name of the pretargeting configuration. Format: bidders/{bidderAccountId\}/pretargetingConfig/{configId\}
* pretargetingConfig:
* 'bidders/my-bidder/pretargetingConfigs/my-pretargetingConfig',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "appIds": []
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "allowedUserTargetingModes": [],
* // "appTargeting": {},
* // "billingId": "my_billingId",
* // "displayName": "my_displayName",
* // "excludedContentLabelIds": [],
* // "geoTargeting": {},
* // "includedCreativeDimensions": [],
* // "includedEnvironments": [],
* // "includedFormats": [],
* // "includedLanguages": [],
* // "includedMobileOperatingSystemIds": [],
* // "includedPlatforms": [],
* // "includedUserIdTypes": [],
* // "interstitialTargeting": "my_interstitialTargeting",
* // "invalidGeoIds": [],
* // "maximumQps": "my_maximumQps",
* // "minimumViewabilityDecile": 0,
* // "name": "my_name",
* // "publisherTargeting": {},
* // "state": "my_state",
* // "userListTargeting": {},
* // "verticalTargeting": {},
* // "webTargeting": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
removeTargetedApps(params: Params$Resource$Bidders$Pretargetingconfigs$Removetargetedapps, options: StreamMethodOptions): GaxiosPromise<Readable>;
removeTargetedApps(params?: Params$Resource$Bidders$Pretargetingconfigs$Removetargetedapps, options?: MethodOptions): GaxiosPromise<Schema$PretargetingConfig>;
removeTargetedApps(params: Params$Resource$Bidders$Pretargetingconfigs$Removetargetedapps, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
removeTargetedApps(params: Params$Resource$Bidders$Pretargetingconfigs$Removetargetedapps, options: MethodOptions | BodyResponseCallback<Schema$PretargetingConfig>, callback: BodyResponseCallback<Schema$PretargetingConfig>): void;
removeTargetedApps(params: Params$Resource$Bidders$Pretargetingconfigs$Removetargetedapps, callback: BodyResponseCallback<Schema$PretargetingConfig>): void;
removeTargetedApps(callback: BodyResponseCallback<Schema$PretargetingConfig>): void;
/**
* Removes targeted publishers from the pretargeting config.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/realtimebidding.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const realtimebidding = google.realtimebidding('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/realtime-bidding'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res =
* await realtimebidding.bidders.pretargetingConfigs.removeTargetedPublishers({
* // Required. The name of the pretargeting configuration. Format: bidders/{bidderAccountId\}/pretargetingConfig/{configId\}
* pretargetingConfig:
* 'bidders/my-bidder/pretargetingConfigs/my-pretargetingConfig',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "publisherIds": []
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "allowedUserTargetingModes": [],
* // "appTargeting": {},
* // "billingId": "my_billingId",
* // "displayName": "my_displayName",
* // "excludedContentLabelIds": [],
* // "geoTargeting": {},
* // "includedCreativeDimensions": [],
* // "includedEnvironments": [],
* // "includedFormats": [],
* // "includedLanguages": [],
* // "includedMobileOperatingSystemIds": [],
* // "includedPlatforms": [],
* // "includedUserIdTypes": [],
* // "interstitialTargeting": "my_interstitialTargeting",
* // "invalidGeoIds": [],
* // "maximumQps": "my_maximumQps",
* // "minimumViewabilityDecile": 0,
* // "name": "my_name",
* // "publisherTargeting": {},
* // "state": "my_state",
* // "userListTargeting": {},
* // "verticalTargeting": {},
* // "webTargeting": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
removeTargetedPublishers(params: Params$Resource$Bidders$Pretargetingconfigs$Removetargetedpublishers, options: StreamMethodOptions): GaxiosPromise<Readable>;
removeTargetedPublishers(params?: Params$Resource$Bidders$Pretargetingconfigs$Removetargetedpublishers, options?: MethodOptions): GaxiosPromise<Schema$PretargetingConfig>;
removeTargetedPublishers(params: Params$Resource$Bidders$Pretargetingconfigs$Removetargetedpublishers, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
removeTargetedPublishers(params: Params$Resource$Bidders$Pretargetingconfigs$Removetargetedpublishers, options: MethodOptions | BodyResponseCallback<Schema$PretargetingConfig>, callback: BodyResponseCallback<Schema$PretargetingConfig>): void;
removeTargetedPublishers(params: Params$Resource$Bidders$Pretargetingconfigs$Removetargetedpublishers, callback: BodyResponseCallback<Schema$PretargetingConfig>): void;
removeTargetedPublishers(callback: BodyResponseCallback<Schema$PretargetingConfig>): void;
/**
* Removes targeted sites from the pretargeting configuration.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/realtimebidding.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const realtimebidding = google.realtimebidding('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/realtime-bidding'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res =
* await realtimebidding.bidders.pretargetingConfigs.removeTargetedSites({
* // Required. The name of the pretargeting configuration. Format: bidders/{bidderAccountId\}/pretargetingConfig/{configId\}
* pretargetingConfig:
* 'bidders/my-bidder/pretargetingConfigs/my-pretargetingConfig',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "sites": []
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "allowedUserTargetingModes": [],
* // "appTargeting": {},
* // "billingId": "my_billingId",
* // "displayName": "my_displayName",
* // "excludedContentLabelIds": [],
* // "geoTargeting": {},
* // "includedCreativeDimensions": [],
* // "includedEnvironments": [],
* // "includedFormats": [],
* // "includedLanguages": [],
* // "includedMobileOperatingSystemIds": [],
* // "includedPlatforms": [],
* // "includedUserIdTypes": [],
* // "interstitialTargeting": "my_interstitialTargeting",
* // "invalidGeoIds": [],
* // "maximumQps": "my_maximumQps",
* // "minimumViewabilityDecile": 0,
* // "name": "my_name",
* // "publisherTargeting": {},
* // "state": "my_state",
* // "userListTargeting": {},
* // "verticalTargeting": {},
* // "webTargeting": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
removeTargetedSites(params: Params$Resource$Bidders$Pretargetingconfigs$Removetargetedsites, options: StreamMethodOptions): GaxiosPromise<Readable>;
removeTargetedSites(params?: Params$Resource$Bidders$Pretargetingconfigs$Removetargetedsites, options?: MethodOptions): GaxiosPromise<Schema$PretargetingConfig>;
removeTargetedSites(params: Params$Resource$Bidders$Pretargetingconfigs$Removetargetedsites, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
removeTargetedSites(params: Params$Resource$Bidders$Pretargetingconfigs$Removetargetedsites, options: MethodOptions | BodyResponseCallback<Schema$PretargetingConfig>, callback: BodyResponseCallback<Schema$PretargetingConfig>): void;
removeTargetedSites(params: Params$Resource$Bidders$Pretargetingconfigs$Removetargetedsites, callback: BodyResponseCallback<Schema$PretargetingConfig>): void;
removeTargetedSites(callback: BodyResponseCallback<Schema$PretargetingConfig>): void;
/**
* Suspends a pretargeting configuration.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/realtimebidding.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const realtimebidding = google.realtimebidding('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/realtime-bidding'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await realtimebidding.bidders.pretargetingConfigs.suspend({
* // Required. The name of the pretargeting configuration. Format: bidders/{bidderAccountId\}/pretargetingConfig/{configId\}
* name: 'bidders/my-bidder/pretargetingConfigs/my-pretargetingConfig',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {}
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "allowedUserTargetingModes": [],
* // "appTargeting": {},
* // "billingId": "my_billingId",
* // "displayName": "my_displayName",
* // "excludedContentLabelIds": [],
* // "geoTargeting": {},
* // "includedCreativeDimensions": [],
* // "includedEnvironments": [],
* // "includedFormats": [],
* // "includedLanguages": [],
* // "includedMobileOperatingSystemIds": [],
* // "includedPlatforms": [],
* // "includedUserIdTypes": [],
* // "interstitialTargeting": "my_interstitialTargeting",
* // "invalidGeoIds": [],
* // "maximumQps": "my_maximumQps",
* // "minimumViewabilityDecile": 0,
* // "name": "my_name",
* // "publisherTargeting": {},
* // "state": "my_state",
* // "userListTargeting": {},
* // "verticalTargeting": {},
* // "webTargeting": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
suspend(params: Params$Resource$Bidders$Pretargetingconfigs$Suspend, options: StreamMethodOptions): GaxiosPromise<Readable>;
suspend(params?: Params$Resource$Bidders$Pretargetingconfigs$Suspend, options?: MethodOptions): GaxiosPromise<Schema$PretargetingConfig>;
suspend(params: Params$Resource$Bidders$Pretargetingconfigs$Suspend, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
suspend(params: Params$Resource$Bidders$Pretargetingconfigs$Suspend, options: MethodOptions | BodyResponseCallback<Schema$PretargetingConfig>, callback: BodyResponseCallback<Schema$PretargetingConfig>): void;
suspend(params: Params$Resource$Bidders$Pretargetingconfigs$Suspend, callback: BodyResponseCallback<Schema$PretargetingConfig>): void;
suspend(callback: BodyResponseCallback<Schema$PretargetingConfig>): void;
}
export interface Params$Resource$Bidders$Pretargetingconfigs$Activate extends StandardParameters {
/**
* Required. The name of the pretargeting configuration. Format: bidders/{bidderAccountId\}/pretargetingConfig/{configId\}
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$ActivatePretargetingConfigRequest;
}
export interface Params$Resource$Bidders$Pretargetingconfigs$Addtargetedapps extends StandardParameters {
/**
* Required. The name of the pretargeting configuration. Format: bidders/{bidderAccountId\}/pretargetingConfig/{configId\}
*/
pretargetingConfig?: string;
/**
* Request body metadata
*/
requestBody?: Schema$AddTargetedAppsRequest;
}
export interface Params$Resource$Bidders$Pretargetingconfigs$Addtargetedpublishers extends StandardParameters {
/**
* Required. The name of the pretargeting configuration. Format: bidders/{bidderAccountId\}/pretargetingConfig/{configId\}
*/
pretargetingConfig?: string;
/**
* Request body metadata
*/
requestBody?: Schema$AddTargetedPublishersRequest;
}
export interface Params$Resource$Bidders$Pretargetingconfigs$Addtargetedsites extends StandardParameters {
/**
* Required. The name of the pretargeting configuration. Format: bidders/{bidderAccountId\}/pretargetingConfig/{configId\}
*/
pretargetingConfig?: string;
/**
* Request body metadata
*/
requestBody?: Schema$AddTargetedSitesRequest;
}
export interface Params$Resource$Bidders$Pretargetingconfigs$Create extends StandardParameters {
/**
* Required. Name of the bidder to create the pretargeting configuration for. Format: bidders/{bidderAccountId\}
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$PretargetingConfig;
}
export interface Params$Resource$Bidders$Pretargetingconfigs$Delete extends StandardParameters {
/**
* Required. The name of the pretargeting configuration to delete. Format: bidders/{bidderAccountId\}/pretargetingConfig/{configId\}
*/
name?: string;
}
export interface Params$Resource$Bidders$Pretargetingconfigs$Get extends StandardParameters {
/**
* Required. Name of the pretargeting configuration to get. Format: bidders/{bidderAccountId\}/pretargetingConfig/{configId\}
*/
name?: string;
}
export interface Params$Resource$Bidders$Pretargetingconfigs$List extends StandardParameters {
/**
* The maximum number of pretargeting configurations to return. If unspecified, at most 10 pretargeting configurations will be returned. The maximum value is 100; values above 100 will be coerced to 100.
*/
pageSize?: number;
/**
* A token identifying a page of results the server should return. This value is received from a previous `ListPretargetingConfigs` call in ListPretargetingConfigsResponse.nextPageToken.
*/
pageToken?: string;
/**
* Required. Name of the bidder whose pretargeting configurations will be listed. Format: bidders/{bidderAccountId\}
*/
parent?: string;
}
export interface Params$Resource$Bidders$Pretargetingconfigs$Patch extends StandardParameters {
/**
* Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id\}/pretargetingConfigs/{config_id\}`
*/
name?: string;
/**
* Field mask to use for partial in-place updates.
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$PretargetingConfig;
}
export interface Params$Resource$Bidders$Pretargetingconfigs$Removetargetedapps extends StandardParameters {
/**
* Required. The name of the pretargeting configuration. Format: bidders/{bidderAccountId\}/pretargetingConfig/{configId\}
*/
pretargetingConfig?: string;
/**
* Request body metadata
*/
requestBody?: Schema$RemoveTargetedAppsRequest;
}
export interface Params$Resource$Bidders$Pretargetingconfigs$Removetargetedpublishers extends StandardParameters {
/**
* Required. The name of the pretargeting configuration. Format: bidders/{bidderAccountId\}/pretargetingConfig/{configId\}
*/
pretargetingConfig?: string;
/**
* Request body metadata
*/
requestBody?: Schema$RemoveTargetedPublishersRequest;
}
export interface Params$Resource$Bidders$Pretargetingconfigs$Removetargetedsites extends StandardParameters {
/**
* Required. The name of the pretargeting configuration. Format: bidders/{bidderAccountId\}/pretargetingConfig/{configId\}
*/
pretargetingConfig?: string;
/**
* Request body metadata
*/
requestBody?: Schema$RemoveTargetedSitesRequest;
}
export interface Params$Resource$Bidders$Pretargetingconfigs$Suspend extends StandardParameters {
/**
* Required. The name of the pretargeting configuration. Format: bidders/{bidderAccountId\}/pretargetingConfig/{configId\}
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$SuspendPretargetingConfigRequest;
}
export class Resource$Buyers {
context: APIRequestContext;
creatives: Resource$Buyers$Creatives;
userLists: Resource$Buyers$Userlists;
constructor(context: APIRequestContext);
/**
* Gets a buyer account by its name.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/realtimebidding.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const realtimebidding = google.realtimebidding('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/realtime-bidding'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await realtimebidding.buyers.get({
* // Required. Name of the buyer to get. Format: `buyers/{buyerId\}`
* name: 'buyers/my-buyer',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "activeCreativeCount": "my_activeCreativeCount",
* // "bidder": "my_bidder",
* // "billingIds": [],
* // "displayName": "my_displayName",
* // "maximumActiveCreativeCount": "my_maximumActiveCreativeCount",
* // "name": "my_name"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Buyers$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Buyers$Get, options?: MethodOptions): GaxiosPromise<Schema$Buyer>;
get(params: Params$Resource$Buyers$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Buyers$Get, options: MethodOptions | BodyResponseCallback<Schema$Buyer>, callback: BodyResponseCallback<Schema$Buyer>): void;
get(params: Params$Resource$Buyers$Get, callback: BodyResponseCallback<Schema$Buyer>): void;
get(callback: BodyResponseCallback<Schema$Buyer>): void;
/**
* Gets remarketing tag for a buyer. A remarketing tag is a piece of JavaScript code that can be placed on a web page. When a user visits a page containing a remarketing tag, Google adds the user to a user list.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/realtimebidding.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const realtimebidding = google.realtimebidding('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/realtime-bidding'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await realtimebidding.buyers.getRemarketingTag({
* // Required. To fetch remarketing tag for an account, name must follow the pattern `buyers/{accountId\}` where `{accountId\}` represents ID of a buyer that owns the remarketing tag. For a bidder accessing remarketing tag on behalf of a child seat buyer, `{accountId\}` should represent the ID of the child seat buyer. To fetch remarketing tag for a specific user list, name must follow the pattern `buyers/{accountId\}/userLists/{userListId\}`. See UserList.name.
* name: 'buyers/my-buyer',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "snippet": "my_snippet"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
getRemarketingTag(params: Params$Resource$Buyers$Getremarketingtag, options: StreamMethodOptions): GaxiosPromise<Readable>;
getRemarketingTag(params?: Params$Resource$Buyers$Getremarketingtag, options?: MethodOptions): GaxiosPromise<Schema$GetRemarketingTagResponse>;
getRemarketingTag(params: Params$Resource$Buyers$Getremarketingtag, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
getRemarketingTag(params: Params$Resource$Buyers$Getremarketingtag, options: MethodOptions | BodyResponseCallback<Schema$GetRemarketingTagResponse>, callback: BodyResponseCallback<Schema$GetRemarketingTagResponse>): void;
getRemarketingTag(params: Params$Resource$Buyers$Getremarketingtag, callback: BodyResponseCallback<Schema$GetRemarketingTagResponse>): void;
getRemarketingTag(callback: BodyResponseCallback<Schema$GetRemarketingTagResponse>): void;
/**
* Lists all buyer account information the calling buyer user or service account is permissioned to manage.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/realtimebidding.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const realtimebidding = google.realtimebidding('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/realtime-bidding'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await realtimebidding.buyers.list({
* // The maximum number of buyers to return. If unspecified, at most 100 buyers will be returned. The maximum value is 500; values above 500 will be coerced to 500.
* pageSize: 'placeholder-value',
* // A token identifying a page of results the server should return. This value is received from a previous `ListBuyers` call in ListBuyersResponse.nextPageToken.
* pageToken: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "buyers": [],
* // "nextPageToken": "my_nextPageToken"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Buyers$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Buyers$List, options?: MethodOptions): GaxiosPromise<Schema$ListBuyersResponse>;
list(params: Params$Resource$Buyers$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Buyers$List, options: MethodOptions | BodyResponseCallback<Schema$ListBuyersResponse>, callback: BodyResponseCallback<Schema$ListBuyersResponse>): void;
list(params: Params$Resource$Buyers$List, callback: BodyResponseCallback<Schema$ListBuyersResponse>): void;
list(callback: BodyResponseCallback<Schema$ListBuyersResponse>): void;
}
export interface Params$Resource$Buyers$Get extends StandardParameters {
/**
* Required. Name of the buyer to get. Format: `buyers/{buyerId\}`
*/
name?: string;
}
export interface Params$Resource$Buyers$Getremarketingtag extends StandardParameters {
/**
* Required. To fetch remarketing tag for an account, name must follow the pattern `buyers/{accountId\}` where `{accountId\}` represents ID of a buyer that owns the remarketing tag. For a bidder accessing remarketing tag on behalf of a child seat buyer, `{accountId\}` should represent the ID of the child seat buyer. To fetch remarketing tag for a specific user list, name must follow the pattern `buyers/{accountId\}/userLists/{userListId\}`. See UserList.name.
*/
name?: string;
}
export interface Params$Resource$Buyers$List extends StandardParameters {
/**
* The maximum number of buyers to return. If unspecified, at most 100 buyers will be returned. The maximum value is 500; values above 500 will be coerced to 500.
*/
pageSize?: number;
/**
* A token identifying a page of results the server should return. This value is received from a previous `ListBuyers` call in ListBuyersResponse.nextPageToken.
*/
pageToken?: string;
}
export class Resource$Buyers$Creatives {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Creates a creative.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/realtimebidding.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const realtimebidding = google.realtimebidding('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/realtime-bidding'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await realtimebidding.buyers.creatives.create({
* // Required. The name of the parent buyer that the new creative belongs to that must follow the pattern `buyers/{buyerAccountId\}`, where `{buyerAccountId\}` represents the account ID of the buyer who owns a creative. For a bidder accessing creatives on behalf of a child seat buyer, `{buyerAccountId\}` should represent the account ID of the child seat buyer.
* parent: 'buyers/my-buyer',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "accountId": "my_accountId",
* // "adChoicesDestinationUrl": "my_adChoicesDestinationUrl",
* // "advertiserName": "my_advertiserName",
* // "agencyId": "my_agencyId",
* // "apiUpdateTime": "my_apiUpdateTime",
* // "creativeFormat": "my_creativeFormat",
* // "creativeId": "my_creativeId",
* // "creativeServingDecision": {},
* // "dealIds": [],
* // "declaredAttributes": [],
* // "declaredClickThroughUrls": [],
* // "declaredRestrictedCategories": [],
* // "declaredVendorIds": [],
* // "html": {},
* // "impressionTrackingUrls": [],
* // "name": "my_name",
* // "native": {},
* // "restrictedCategories": [],
* // "version": 0,
* // "video": {}
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "accountId": "my_accountId",
* // "adChoicesDestinationUrl": "my_adChoicesDestinationUrl",
* // "advertiserName": "my_advertiserName",
* // "agencyId": "my_agencyId",
* // "apiUpdateTime": "my_apiUpdateTime",
* // "creativeFormat": "my_creativeFormat",
* // "creativeId": "my_creativeId",
* // "creativeServingDecision": {},
* // "dealIds": [],
* // "declaredAttributes": [],
* // "declaredClickThroughUrls": [],
* // "declaredRestrictedCategories": [],
* // "declaredVendorIds": [],
* // "html": {},
* // "impressionTrackingUrls": [],
* // "name": "my_name",
* // "native": {},
* // "restrictedCategories": [],
* // "version": 0,
* // "video": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
create(params: Params$Resource$Buyers$Creatives$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
create(params?: Params$Resource$Buyers$Creatives$Create, options?: MethodOptions): GaxiosPromise<Schema$Creative>;
create(params: Params$Resource$Buyers$Creatives$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
create(params: Params$Resource$Buyers$Creatives$Create, options: MethodOptions | BodyResponseCallback<Schema$Creative>, callback: BodyResponseCallback<Schema$Creative>): void;
create(params: Params$Resource$Buyers$Creatives$Create, callback: BodyResponseCallback<Schema$Creative>): void;
create(callback: BodyResponseCallback<Schema$Creative>): void;
/**
* Gets a creative.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/realtimebidding.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const realtimebidding = google.realtimebidding('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/realtime-bidding'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await realtimebidding.buyers.creatives.get({
* // Required. Name of the creative to retrieve. See creative.name.
* name: 'buyers/my-buyer/creatives/my-creative',
* // Controls the amount of information included in the response. By default only creativeServingDecision is included. To retrieve the entire creative resource (including the declared fields and the creative content) specify the view as "FULL".
* view: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "accountId": "my_accountId",
* // "adChoicesDestinationUrl": "my_adChoicesDestinationUrl",
* // "advertiserName": "my_advertiserName",
* // "agencyId": "my_agencyId",
* // "apiUpdateTime": "my_apiUpdateTime",
* // "creativeFormat": "my_creativeFormat",
* // "creativeId": "my_creativeId",
* // "creativeServingDecision": {},
* // "dealIds": [],
* // "declaredAttributes": [],
* // "declaredClickThroughUrls": [],
* // "declaredRestrictedCategories": [],
* // "declaredVendorIds": [],
* // "html": {},
* // "impressionTrackingUrls": [],
* // "name": "my_name",
* // "native": {},
* // "restrictedCategories": [],
* // "version": 0,
* // "video": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Buyers$Creatives$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Buyers$Creatives$Get, options?: MethodOptions): GaxiosPromise<Schema$Creative>;
get(params: Params$Resource$Buyers$Creatives$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Buyers$Creatives$Get, options: MethodOptions | BodyResponseCallback<Schema$Creative>, callback: BodyResponseCallback<Schema$Creative>): void;
get(params: Params$Resource$Buyers$Creatives$Get, callback: BodyResponseCallback<Schema$Creative>): void;
get(callback: BodyResponseCallback<Schema$Creative>): void;
/**
* Lists creatives.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/realtimebidding.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const realtimebidding = google.realtimebidding('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/realtime-bidding'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await realtimebidding.buyers.creatives.list({
* // Query string to filter creatives. If no filter is specified, all active creatives will be returned. Example: 'accountId=12345 AND (dealsStatus:DISAPPROVED AND disapprovalReason:UNACCEPTABLE_CONTENT) OR declaredAttributes:IS_COOKIE_TARGETED'
* filter: 'placeholder-value',
* // 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: 'placeholder-value',
* // A token identifying a page of results the server should return. Typically, this is the value of ListCreativesResponse.nextPageToken returned from the previous call to the 'ListCreatives' method.
* pageToken: 'placeholder-value',
* // Required. Name of the parent buyer that owns the creatives. The pattern for this resource is either `buyers/{buyerAccountId\}` or `bidders/{bidderAccountId\}`. For `buyers/{buyerAccountId\}`, the `buyerAccountId` can be one of the following: 1. The ID of the buyer that is accessing their own creatives. 2. The ID of the child seat buyer under a bidder account. So for listing creatives pertaining to the child seat buyer (`456`) under bidder account (`123`), you would use the pattern: `buyers/456`. 3. The ID of the bidder itself. So for listing creatives pertaining to bidder (`123`), you would use `buyers/123`. If you want to access all creatives pertaining to both the bidder and all of its child seat accounts, you would use `bidders/{bidderAccountId\}`, e.g., for all creatives pertaining to bidder (`123`), use `bidders/123`.
* parent: 'buyers/my-buyer',
* // Controls the amount of information included in the response. By default only creativeServingDecision is included. To retrieve the entire creative resource (including the declared fields and the creative content) specify the view as "FULL".
* view: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "creatives": [],
* // "nextPageToken": "my_nextPageToken"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Buyers$Creatives$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Buyers$Creatives$List, options?: MethodOptions): GaxiosPromise<Schema$ListCreativesResponse>;
list(params: Params$Resource$Buyers$Creatives$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Buyers$Creatives$List, options: MethodOptions | BodyResponseCallback<Schema$ListCreativesResponse>, callback: BodyResponseCallback<Schema$ListCreativesResponse>): void;
list(params: Params$Resource$Buyers$Creatives$List, callback: BodyResponseCallback<Schema$ListCreativesResponse>): void;
list(callback: BodyResponseCallback<Schema$ListCreativesResponse>): void;
/**
* Updates a creative.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/realtimebidding.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const realtimebidding = google.realtimebidding('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/realtime-bidding'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await realtimebidding.buyers.creatives.patch({
* // Output only. Name of the creative. Follows the pattern `buyers/{buyer\}/creatives/{creative\}`, where `{buyer\}` represents the account ID of the buyer who owns the creative, and `{creative\}` is the buyer-specific creative ID that references this creative in the bid response.
* name: 'buyers/my-buyer/creatives/my-creative',
* // Field mask to use for partial in-place updates.
* updateMask: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "accountId": "my_accountId",
* // "adChoicesDestinationUrl": "my_adChoicesDestinationUrl",
* // "advertiserName": "my_advertiserName",
* // "agencyId": "my_agencyId",
* // "apiUpdateTime": "my_apiUpdateTime",
* // "creativeFormat": "my_creativeFormat",
* // "creativeId": "my_creativeId",
* // "creativeServingDecision": {},
* // "dealIds": [],
* // "declaredAttributes": [],
* // "declaredClickThroughUrls": [],
* // "declaredRestrictedCategories": [],
* // "declaredVendorIds": [],
* // "html": {},
* // "impressionTrackingUrls": [],
* // "name": "my_name",
* // "native": {},
* // "restrictedCategories": [],
* // "version": 0,
* // "video": {}
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "accountId": "my_accountId",
* // "adChoicesDestinationUrl": "my_adChoicesDestinationUrl",
* // "advertiserName": "my_advertiserName",
* // "agencyId": "my_agencyId",
* // "apiUpdateTime": "my_apiUpdateTime",
* // "creativeFormat": "my_creativeFormat",
* // "creativeId": "my_creativeId",
* // "creativeServingDecision": {},
* // "dealIds": [],
* // "declaredAttributes": [],
* // "declaredClickThroughUrls": [],
* // "declaredRestrictedCategories": [],
* // "declaredVendorIds": [],
* // "html": {},
* // "impressionTrackingUrls": [],
* // "name": "my_name",
* // "native": {},
* // "restrictedCategories": [],
* // "version": 0,
* // "video": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
patch(params: Params$Resource$Buyers$Creatives$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
patch(params?: Params$Resource$Buyers$Creatives$Patch, options?: MethodOptions): GaxiosPromise<Schema$Creative>;
patch(params: Params$Resource$Buyers$Creatives$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
patch(params: Params$Resource$Buyers$Creatives$Patch, options: MethodOptions | BodyResponseCallback<Schema$Creative>, callback: BodyResponseCallback<Schema$Creative>): void;
patch(params: Params$Resource$Buyers$Creatives$Patch, callback: BodyResponseCallback<Schema$Creative>): void;
patch(callback: BodyResponseCallback<Schema$Creative>): void;
}
export interface Params$Resource$Buyers$Creatives$Create extends StandardParameters {
/**
* Required. The name of the parent buyer that the new creative belongs to that must follow the pattern `buyers/{buyerAccountId\}`, where `{buyerAccountId\}` represents the account ID of the buyer who owns a creative. For a bidder accessing creatives on behalf of a child seat buyer, `{buyerAccountId\}` should represent the account ID of the child seat buyer.
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Creative;
}
export interface Params$Resource$Buyers$Creatives$Get extends StandardParameters {
/**
* Required. Name of the creative to retrieve. See creative.name.
*/
name?: string;
/**
* Controls the amount of information included in the response. By default only creativeServingDecision is included. To retrieve the entire creative resource (including the declared fields and the creative content) specify the view as "FULL".
*/
view?: string;
}
export interface Params$Resource$Buyers$Creatives$List extends StandardParameters {
/**
* Query string to filter creatives. If no filter is specified, all active creatives will be returned. Example: 'accountId=12345 AND (dealsStatus:DISAPPROVED AND disapprovalReason:UNACCEPTABLE_CONTENT) OR declaredAttributes:IS_COOKIE_TARGETED'
*/
filter?: 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.nextPageToken returned from the previous call to the 'ListCreatives' method.
*/
pageToken?: string;
/**
* Required. Name of the parent buyer that owns the creatives. The pattern for this resource is either `buyers/{buyerAccountId\}` or `bidders/{bidderAccountId\}`. For `buyers/{buyerAccountId\}`, the `buyerAccountId` can be one of the following: 1. The ID of the buyer that is accessing their own creatives. 2. The ID of the child seat buyer under a bidder account. So for listing creatives pertaining to the child seat buyer (`456`) under bidder account (`123`), you would use the pattern: `buyers/456`. 3. The ID of the bidder itself. So for listing creatives pertaining to bidder (`123`), you would use `buyers/123`. If you want to access all creatives pertaining to both the bidder and all of its child seat accounts, you would use `bidders/{bidderAccountId\}`, e.g., for all creatives pertaining to bidder (`123`), use `bidders/123`.
*/
parent?: string;
/**
* Controls the amount of information included in the response. By default only creativeServingDecision is included. To retrieve the entire creative resource (including the declared fields and the creative content) specify the view as "FULL".
*/
view?: string;
}
export interface Params$Resource$Buyers$Creatives$Patch extends StandardParameters {
/**
* Output only. Name of the creative. Follows the pattern `buyers/{buyer\}/creatives/{creative\}`, where `{buyer\}` represents the account ID of the buyer who owns the creative, and `{creative\}` is the buyer-specific creative ID that references this creative in the bid response.
*/
name?: string;
/**
* Field mask to use for partial in-place updates.
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Creative;
}
export class Resource$Buyers$Userlists {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Change the status of a user list to CLOSED. This prevents new users from being added to the user list.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/realtimebidding.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const realtimebidding = google.realtimebidding('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/realtime-bidding'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await realtimebidding.buyers.userLists.close({
* // Required. The name of the user list to close. See UserList.name
* name: 'buyers/my-buyer/userLists/my-userList',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {}
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "description": "my_description",
* // "displayName": "my_displayName",
* // "membershipDurationDays": "my_membershipDurationDays",
* // "name": "my_name",
* // "status": "my_status",
* // "urlRestriction": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
close(params: Params$Resource$Buyers$Userlists$Close, options: StreamMethodOptions): GaxiosPromise<Readable>;
close(params?: Params$Resource$Buyers$Userlists$Close, options?: MethodOptions): GaxiosPromise<Schema$UserList>;
close(params: Params$Resource$Buyers$Userlists$Close, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
close(params: Params$Resource$Buyers$Userlists$Close, options: MethodOptions | BodyResponseCallback<Schema$UserList>, callback: BodyResponseCallback<Schema$UserList>): void;
close(params: Params$Resource$Buyers$Userlists$Close, callback: BodyResponseCallback<Schema$UserList>): void;
close(callback: BodyResponseCallback<Schema$UserList>): void;
/**
* Create a new user list.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/realtimebidding.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const realtimebidding = google.realtimebidding('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/realtime-bidding'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await realtimebidding.buyers.userLists.create({
* // Required. The name of the parent buyer of the user list to be retrieved that must follow the pattern `buyers/{buyerAccountId\}`, where `{buyerAccountId\}` represents the account ID of the buyer who owns user lists. For a bidder accessing user lists on behalf of a child seat buyer , `{buyerAccountId\}` should represent the account ID of the child seat buyer.
* parent: 'buyers/my-buyer',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "description": "my_description",
* // "displayName": "my_displayName",
* // "membershipDurationDays": "my_membershipDurationDays",
* // "name": "my_name",
* // "status": "my_status",
* // "urlRestriction": {}
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "description": "my_description",
* // "displayName": "my_displayName",
* // "membershipDurationDays": "my_membershipDurationDays",
* // "name": "my_name",
* // "status": "my_status",
* // "urlRestriction": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
create(params: Params$Resource$Buyers$Userlists$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
create(params?: Params$Resource$Buyers$Userlists$Create, options?: MethodOptions): GaxiosPromise<Schema$UserList>;
create(params: Params$Resource$Buyers$Userlists$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
create(params: Params$Resource$Buyers$Userlists$Create, options: MethodOptions | BodyResponseCallback<Schema$UserList>, callback: BodyResponseCallback<Schema$UserList>): void;
create(params: Params$Resource$Buyers$Userlists$Create, callback: BodyResponseCallback<Schema$UserList>): void;
create(callback: BodyResponseCallback<Schema$UserList>): void;
/**
* Gets a user list by its name.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/realtimebidding.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const realtimebidding = google.realtimebidding('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/realtime-bidding'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await realtimebidding.buyers.userLists.get({
* // Required. The name of the user list to be retrieved. See UserList.name.
* name: 'buyers/my-buyer/userLists/my-userList',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "description": "my_description",
* // "displayName": "my_displayName",
* // "membershipDurationDays": "my_membershipDurationDays",
* // "name": "my_name",
* // "status": "my_status",
* // "urlRestriction": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Buyers$Userlists$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Buyers$Userlists$Get, options?: MethodOptions): GaxiosPromise<Schema$UserList>;
get(params: Params$Resource$Buyers$Userlists$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Buyers$Userlists$Get, options: MethodOptions | BodyResponseCallback<Schema$UserList>, callback: BodyResponseCallback<Schema$UserList>): void;
get(params: Params$Resource$Buyers$Userlists$Get, callback: BodyResponseCallback<Schema$UserList>): void;
get(callback: BodyResponseCallback<Schema$UserList>): void;
/**
* Gets remarketing tag for a buyer. A remarketing tag is a piece of JavaScript code that can be placed on a web page. When a user visits a page containing a remarketing tag, Google adds the user to a user list.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/realtimebidding.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const realtimebidding = google.realtimebidding('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/realtime-bidding'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await realtimebidding.buyers.userLists.getRemarketingTag({
* // Required. To fetch remarketing tag for an account, name must follow the pattern `buyers/{accountId\}` where `{accountId\}` represents ID of a buyer that owns the remarketing tag. For a bidder accessing remarketing tag on behalf of a child seat buyer, `{accountId\}` should represent the ID of the child seat buyer. To fetch remarketing tag for a specific user list, name must follow the pattern `buyers/{accountId\}/userLists/{userListId\}`. See UserList.name.
* name: 'buyers/my-buyer/userLists/my-userList',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "snippet": "my_snippet"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
getRemarketingTag(params: Params$Resource$Buyers$Userlists$Getremarketingtag, options: StreamMethodOptions): GaxiosPromise<Readable>;
getRemarketingTag(params?: Params$Resource$Buyers$Userlists$Getremarketingtag, options?: MethodOptions): GaxiosPromise<Schema$GetRemarketingTagResponse>;
getRemarketingTag(params: Params$Resource$Buyers$Userlists$Getremarketingtag, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
getRemarketingTag(params: Params$Resource$Buyers$Userlists$Getremarketingtag, options: MethodOptions | BodyResponseCallback<Schema$GetRemarketingTagResponse>, callback: BodyResponseCallback<Schema$GetRemarketingTagResponse>): void;
getRemarketingTag(params: Params$Resource$Buyers$Userlists$Getremarketingtag, callback: BodyResponseCallback<Schema$GetRemarketingTagResponse>): void;
getRemarketingTag(callback: BodyResponseCallback<Schema$GetRemarketingTagResponse>): void;
/**
* Lists the user lists visible to the current user.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/realtimebidding.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const realtimebidding = google.realtimebidding('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/realtime-bidding'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await realtimebidding.buyers.userLists.list({
* // The number of results to return per page.
* pageSize: 'placeholder-value',
* // Continuation page token (as received from a previous response).
* pageToken: 'placeholder-value',
* // Required. The name of the parent buyer for the user lists to be returned that must follow the pattern `buyers/{buyerAccountId\}`, where `{buyerAccountId\}` represents the account ID of the buyer who owns user lists. For a bidder accessing user lists on behalf of a child seat buyer , `{buyerAccountId\}` should represent the account ID of the child seat buyer.
* parent: 'buyers/my-buyer',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "nextPageToken": "my_nextPageToken",
* // "userLists": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Buyers$Userlists$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Buyers$Userlists$List, options?: MethodOptions): GaxiosPromise<Schema$ListUserListsResponse>;
list(params: Params$Resource$Buyers$Userlists$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Buyers$Userlists$List, options: MethodOptions | BodyResponseCallback<Schema$ListUserListsResponse>, callback: BodyResponseCallback<Schema$ListUserListsResponse>): void;
list(params: Params$Resource$Buyers$Userlists$List, callback: BodyResponseCallback<Schema$ListUserListsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListUserListsResponse>): void;
/**
* Change the status of a user list to OPEN. This allows new users to be added to the user list.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/realtimebidding.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const realtimebidding = google.realtimebidding('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/realtime-bidding'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await realtimebidding.buyers.userLists.open({
* // Required. The name of the user list to open. See UserList.name
* name: 'buyers/my-buyer/userLists/my-userList',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {}
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "description": "my_description",
* // "displayName": "my_displayName",
* // "membershipDurationDays": "my_membershipDurationDays",
* // "name": "my_name",
* // "status": "my_status",
* // "urlRestriction": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
open(params: Params$Resource$Buyers$Userlists$Open, options: StreamMethodOptions): GaxiosPromise<Readable>;
open(params?: Params$Resource$Buyers$Userlists$Open, options?: MethodOptions): GaxiosPromise<Schema$UserList>;
open(params: Params$Resource$Buyers$Userlists$Open, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
open(params: Params$Resource$Buyers$Userlists$Open, options: MethodOptions | BodyResponseCallback<Schema$UserList>, callback: BodyResponseCallback<Schema$UserList>): void;
open(params: Params$Resource$Buyers$Userlists$Open, callback: BodyResponseCallback<Schema$UserList>): void;
open(callback: BodyResponseCallback<Schema$UserList>): void;
/**
* Update the given user list. Only user lists with URLRestrictions can be updated.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/realtimebidding.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const realtimebidding = google.realtimebidding('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/realtime-bidding'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await realtimebidding.buyers.userLists.update({
* // Output only. Name of the user list that must follow the pattern `buyers/{buyer\}/userLists/{user_list\}`, where `{buyer\}` represents the account ID of the buyer who owns the user list. For a bidder accessing user lists on behalf of a child seat buyer, `{buyer\}` represents the account ID of the child seat buyer. `{user_list\}` is an int64 identifier assigned by Google to uniquely identify a user list.
* name: 'buyers/my-buyer/userLists/my-userList',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "description": "my_description",
* // "displayName": "my_displayName",
* // "membershipDurationDays": "my_membershipDurationDays",
* // "name": "my_name",
* // "status": "my_status",
* // "urlRestriction": {}
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "description": "my_description",
* // "displayName": "my_displayName",
* // "membershipDurationDays": "my_membershipDurationDays",
* // "name": "my_name",
* // "status": "my_status",
* // "urlRestriction": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
update(params: Params$Resource$Buyers$Userlists$Update, options: StreamMethodOptions): GaxiosPromise<Readable>;
update(params?: Params$Resource$Buyers$Userlists$Update, options?: MethodOptions): GaxiosPromise<Schema$UserList>;
update(params: Params$Resource$Buyers$Userlists$Update, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
update(params: Params$Resource$Buyers$Userlists$Update, options: MethodOptions | BodyResponseCallback<Schema$UserList>, callback: BodyResponseCallback<Schema$UserList>): void;
update(params: Params$Resource$Buyers$Userlists$Update, callback: BodyResponseCallback<Schema$UserList>): void;
update(callback: BodyResponseCallback<Schema$UserList>): void;
}
export interface Params$Resource$Buyers$Userlists$Close extends StandardParameters {
/**
* Required. The name of the user list to close. See UserList.name
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CloseUserListRequest;
}
export interface Params$Resource$Buyers$Userlists$Create extends StandardParameters {
/**
* Required. The name of the parent buyer of the user list to be retrieved that must follow the pattern `buyers/{buyerAccountId\}`, where `{buyerAccountId\}` represents the account ID of the buyer who owns user lists. For a bidder accessing user lists on behalf of a child seat buyer , `{buyerAccountId\}` should represent the account ID of the child seat buyer.
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$UserList;
}
export interface Params$Resource$Buyers$Userlists$Get extends StandardParameters {
/**
* Required. The name of the user list to be retrieved. See UserList.name.
*/
name?: string;
}
export interface Params$Resource$Buyers$Userlists$Getremarketingtag extends StandardParameters {
/**
* Required. To fetch remarketing tag for an account, name must follow the pattern `buyers/{accountId\}` where `{accountId\}` represents ID of a buyer that owns the remarketing tag. For a bidder accessing remarketing tag on behalf of a child seat buyer, `{accountId\}` should represent the ID of the child seat buyer. To fetch remarketing tag for a specific user list, name must follow the pattern `buyers/{accountId\}/userLists/{userListId\}`. See UserList.name.
*/
name?: string;
}
export interface Params$Resource$Buyers$Userlists$List extends StandardParameters {
/**
* The number of results to return per page.
*/
pageSize?: number;
/**
* Continuation page token (as received from a previous response).
*/
pageToken?: string;
/**
* Required. The name of the parent buyer for the user lists to be returned that must follow the pattern `buyers/{buyerAccountId\}`, where `{buyerAccountId\}` represents the account ID of the buyer who owns user lists. For a bidder accessing user lists on behalf of a child seat buyer , `{buyerAccountId\}` should represent the account ID of the child seat buyer.
*/
parent?: string;
}
export interface Params$Resource$Buyers$Userlists$Open extends StandardParameters {
/**
* Required. The name of the user list to open. See UserList.name
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$OpenUserListRequest;
}
export interface Params$Resource$Buyers$Userlists$Update extends StandardParameters {
/**
* Output only. Name of the user list that must follow the pattern `buyers/{buyer\}/userLists/{user_list\}`, where `{buyer\}` represents the account ID of the buyer who owns the user list. For a bidder accessing user lists on behalf of a child seat buyer, `{buyer\}` represents the account ID of the child seat buyer. `{user_list\}` is an int64 identifier assigned by Google to uniquely identify a user list.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$UserList;
}
export {};
}