v3.3.d.ts
696 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
7780
7781
7782
7783
7784
7785
7786
7787
7788
7789
7790
7791
7792
7793
7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
7841
7842
7843
7844
7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
7860
7861
7862
7863
7864
7865
7866
7867
7868
7869
7870
7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
7900
7901
7902
7903
7904
7905
7906
7907
7908
7909
7910
7911
7912
7913
7914
7915
7916
7917
7918
7919
7920
7921
7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
7966
7967
7968
7969
7970
7971
7972
7973
7974
7975
7976
7977
7978
7979
7980
7981
7982
7983
7984
7985
7986
7987
7988
7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
8000
8001
8002
8003
8004
8005
8006
8007
8008
8009
8010
8011
8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
8024
8025
8026
8027
8028
8029
8030
8031
8032
8033
8034
8035
8036
8037
8038
8039
8040
8041
8042
8043
8044
8045
8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
8100
8101
8102
8103
8104
8105
8106
8107
8108
8109
8110
8111
8112
8113
8114
8115
8116
8117
8118
8119
8120
8121
8122
8123
8124
8125
8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
8176
8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
8195
8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
8213
8214
8215
8216
8217
8218
8219
8220
8221
8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
8234
8235
8236
8237
8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
8260
8261
8262
8263
8264
8265
8266
8267
8268
8269
8270
8271
8272
8273
8274
8275
8276
8277
8278
8279
8280
8281
8282
8283
8284
8285
8286
8287
8288
8289
8290
8291
8292
8293
8294
8295
8296
8297
8298
8299
8300
8301
8302
8303
8304
8305
8306
8307
8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
8321
8322
8323
8324
8325
8326
8327
8328
8329
8330
8331
8332
8333
8334
8335
8336
8337
8338
8339
8340
8341
8342
8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
8377
8378
8379
8380
8381
8382
8383
8384
8385
8386
8387
8388
8389
8390
8391
8392
8393
8394
8395
8396
8397
8398
8399
8400
8401
8402
8403
8404
8405
8406
8407
8408
8409
8410
8411
8412
8413
8414
8415
8416
8417
8418
8419
8420
8421
8422
8423
8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
8435
8436
8437
8438
8439
8440
8441
8442
8443
8444
8445
8446
8447
8448
8449
8450
8451
8452
8453
8454
8455
8456
8457
8458
8459
8460
8461
8462
8463
8464
8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
8484
8485
8486
8487
8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
8503
8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
8522
8523
8524
8525
8526
8527
8528
8529
8530
8531
8532
8533
8534
8535
8536
8537
8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
8548
8549
8550
8551
8552
8553
8554
8555
8556
8557
8558
8559
8560
8561
8562
8563
8564
8565
8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
8605
8606
8607
8608
8609
8610
8611
8612
8613
8614
8615
8616
8617
8618
8619
8620
8621
8622
8623
8624
8625
8626
8627
8628
8629
8630
8631
8632
8633
8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
8655
8656
8657
8658
8659
8660
8661
8662
8663
8664
8665
8666
8667
8668
8669
8670
8671
8672
8673
8674
8675
8676
8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
8696
8697
8698
8699
8700
8701
8702
8703
8704
8705
8706
8707
8708
8709
8710
8711
8712
8713
8714
8715
8716
8717
8718
8719
8720
8721
8722
8723
8724
8725
8726
8727
8728
8729
8730
8731
8732
8733
8734
8735
8736
8737
8738
8739
8740
8741
8742
8743
8744
8745
8746
8747
8748
8749
8750
8751
8752
8753
8754
8755
8756
8757
8758
8759
8760
8761
8762
8763
8764
8765
8766
8767
8768
8769
8770
8771
8772
8773
8774
8775
8776
8777
8778
8779
8780
8781
8782
8783
8784
8785
8786
8787
8788
8789
8790
8791
8792
8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
8804
8805
8806
8807
8808
8809
8810
8811
8812
8813
8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
8827
8828
8829
8830
8831
8832
8833
8834
8835
8836
8837
8838
8839
8840
8841
8842
8843
8844
8845
8846
8847
8848
8849
8850
8851
8852
8853
8854
8855
8856
8857
8858
8859
8860
8861
8862
8863
8864
8865
8866
8867
8868
8869
8870
8871
8872
8873
8874
8875
8876
8877
8878
8879
8880
8881
8882
8883
8884
8885
8886
8887
8888
8889
8890
8891
8892
8893
8894
8895
8896
8897
8898
8899
8900
8901
8902
8903
8904
8905
8906
8907
8908
8909
8910
8911
8912
8913
8914
8915
8916
8917
8918
8919
8920
8921
8922
8923
8924
8925
8926
8927
8928
8929
8930
8931
8932
8933
8934
8935
8936
8937
8938
8939
8940
8941
8942
8943
8944
8945
8946
8947
8948
8949
8950
8951
8952
8953
8954
8955
8956
8957
8958
8959
8960
8961
8962
8963
8964
8965
8966
8967
8968
8969
8970
8971
8972
8973
8974
8975
8976
8977
8978
8979
8980
8981
8982
8983
8984
8985
8986
8987
8988
8989
8990
8991
8992
8993
8994
8995
8996
8997
8998
8999
9000
9001
9002
9003
9004
9005
9006
9007
9008
9009
9010
9011
9012
9013
9014
9015
9016
9017
9018
9019
9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
9050
9051
9052
9053
9054
9055
9056
9057
9058
9059
9060
9061
9062
9063
9064
9065
9066
9067
9068
9069
9070
9071
9072
9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
9083
9084
9085
9086
9087
9088
9089
9090
9091
9092
9093
9094
9095
9096
9097
9098
9099
9100
9101
9102
9103
9104
9105
9106
9107
9108
9109
9110
9111
9112
9113
9114
9115
9116
9117
9118
9119
9120
9121
9122
9123
9124
9125
9126
9127
9128
9129
9130
9131
9132
9133
9134
9135
9136
9137
9138
9139
9140
9141
9142
9143
9144
9145
9146
9147
9148
9149
9150
9151
9152
9153
9154
9155
9156
9157
9158
9159
9160
9161
9162
9163
9164
9165
9166
9167
9168
9169
9170
9171
9172
9173
9174
9175
9176
9177
9178
9179
9180
9181
9182
9183
9184
9185
9186
9187
9188
9189
9190
9191
9192
9193
9194
9195
9196
9197
9198
9199
9200
9201
9202
9203
9204
9205
9206
9207
9208
9209
9210
9211
9212
9213
9214
9215
9216
9217
9218
9219
9220
9221
9222
9223
9224
9225
9226
9227
9228
9229
9230
9231
9232
9233
9234
9235
9236
9237
9238
9239
9240
9241
9242
9243
9244
9245
9246
9247
9248
9249
9250
9251
9252
9253
9254
9255
9256
9257
9258
9259
9260
9261
9262
9263
9264
9265
9266
9267
9268
9269
9270
9271
9272
9273
9274
9275
9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
9289
9290
9291
9292
9293
9294
9295
9296
9297
9298
9299
9300
9301
9302
9303
9304
9305
9306
9307
9308
9309
9310
9311
9312
9313
9314
9315
9316
9317
9318
9319
9320
9321
9322
9323
9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
9371
9372
9373
9374
9375
9376
9377
9378
9379
9380
9381
9382
9383
9384
9385
9386
9387
9388
9389
9390
9391
9392
9393
9394
9395
9396
9397
9398
9399
9400
9401
9402
9403
9404
9405
9406
9407
9408
9409
9410
9411
9412
9413
9414
9415
9416
9417
9418
9419
9420
9421
9422
9423
9424
9425
9426
9427
9428
9429
9430
9431
9432
9433
9434
9435
9436
9437
9438
9439
9440
9441
9442
9443
9444
9445
9446
9447
9448
9449
9450
9451
9452
9453
9454
9455
9456
9457
9458
9459
9460
9461
9462
9463
9464
9465
9466
9467
9468
9469
9470
9471
9472
9473
9474
9475
9476
9477
9478
9479
9480
9481
9482
9483
9484
9485
9486
9487
9488
9489
9490
9491
9492
9493
9494
9495
9496
9497
9498
9499
9500
9501
9502
9503
9504
9505
9506
9507
9508
9509
9510
9511
9512
9513
9514
9515
9516
9517
9518
9519
9520
9521
9522
9523
9524
9525
9526
9527
9528
9529
9530
9531
9532
9533
9534
9535
9536
9537
9538
9539
9540
9541
9542
9543
9544
9545
9546
9547
9548
9549
9550
9551
9552
9553
9554
9555
9556
9557
9558
9559
9560
9561
9562
9563
9564
9565
9566
9567
9568
9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
9580
9581
9582
9583
9584
9585
9586
9587
9588
9589
9590
9591
9592
9593
9594
9595
9596
9597
9598
9599
9600
9601
9602
9603
9604
9605
9606
9607
9608
9609
9610
9611
9612
9613
9614
9615
9616
9617
9618
9619
9620
9621
9622
9623
9624
9625
9626
9627
9628
9629
9630
9631
9632
9633
9634
9635
9636
9637
9638
9639
9640
9641
9642
9643
9644
9645
9646
9647
9648
9649
9650
9651
9652
9653
9654
9655
9656
9657
9658
9659
9660
9661
9662
9663
9664
9665
9666
9667
9668
9669
9670
9671
9672
9673
9674
9675
9676
9677
9678
9679
9680
9681
9682
9683
9684
9685
9686
9687
9688
9689
9690
9691
9692
9693
9694
9695
9696
9697
9698
9699
9700
9701
9702
9703
9704
9705
9706
9707
9708
9709
9710
9711
9712
9713
9714
9715
9716
9717
9718
9719
9720
9721
9722
9723
9724
9725
9726
9727
9728
9729
9730
9731
9732
9733
9734
9735
9736
9737
9738
9739
9740
9741
9742
9743
9744
9745
9746
9747
9748
9749
9750
9751
9752
9753
9754
9755
9756
9757
9758
9759
9760
9761
9762
9763
9764
9765
9766
9767
9768
9769
9770
9771
9772
9773
9774
9775
9776
9777
9778
9779
9780
9781
9782
9783
9784
9785
9786
9787
9788
9789
9790
9791
9792
9793
9794
9795
9796
9797
9798
9799
9800
9801
9802
9803
9804
9805
9806
9807
9808
9809
9810
9811
9812
9813
9814
9815
9816
9817
9818
9819
9820
9821
9822
9823
9824
9825
9826
9827
9828
9829
9830
9831
9832
9833
9834
9835
9836
9837
9838
9839
9840
9841
9842
9843
9844
9845
9846
9847
9848
9849
9850
9851
9852
9853
9854
9855
9856
9857
9858
9859
9860
9861
9862
9863
9864
9865
9866
9867
9868
9869
9870
9871
9872
9873
9874
9875
9876
9877
9878
9879
9880
9881
9882
9883
9884
9885
9886
9887
9888
9889
9890
9891
9892
9893
9894
9895
9896
9897
9898
9899
9900
9901
9902
9903
9904
9905
9906
9907
9908
9909
9910
9911
9912
9913
9914
9915
9916
9917
9918
9919
9920
9921
9922
9923
9924
9925
9926
9927
9928
9929
9930
9931
9932
9933
9934
9935
9936
9937
9938
9939
9940
9941
9942
9943
9944
9945
9946
9947
9948
9949
9950
9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
9974
9975
9976
9977
9978
9979
9980
9981
9982
9983
9984
9985
9986
9987
9988
9989
9990
9991
9992
9993
9994
9995
9996
9997
9998
9999
10000
10001
10002
10003
10004
10005
10006
10007
10008
10009
10010
10011
10012
10013
10014
10015
10016
10017
10018
10019
10020
10021
10022
10023
10024
10025
10026
10027
10028
10029
10030
10031
10032
10033
10034
10035
10036
10037
10038
10039
10040
10041
10042
10043
10044
10045
10046
10047
10048
10049
10050
10051
10052
10053
10054
10055
10056
10057
10058
10059
10060
10061
10062
10063
10064
10065
10066
10067
10068
10069
10070
10071
10072
10073
10074
10075
10076
10077
10078
10079
10080
10081
10082
10083
10084
10085
10086
10087
10088
10089
10090
10091
10092
10093
10094
10095
10096
10097
10098
10099
10100
10101
10102
10103
10104
10105
10106
10107
10108
10109
10110
10111
10112
10113
10114
10115
10116
10117
10118
10119
10120
10121
10122
10123
10124
10125
10126
10127
10128
10129
10130
10131
10132
10133
10134
10135
10136
10137
10138
10139
10140
10141
10142
10143
10144
10145
10146
10147
10148
10149
10150
10151
10152
10153
10154
10155
10156
10157
10158
10159
10160
10161
10162
10163
10164
10165
10166
10167
10168
10169
10170
10171
10172
10173
10174
10175
10176
10177
10178
10179
10180
10181
10182
10183
10184
10185
10186
10187
10188
10189
10190
10191
10192
10193
10194
10195
10196
10197
10198
10199
10200
10201
10202
10203
10204
10205
10206
10207
10208
10209
10210
10211
10212
10213
10214
10215
10216
10217
10218
10219
10220
10221
10222
10223
10224
10225
10226
10227
10228
10229
10230
10231
10232
10233
10234
10235
10236
10237
10238
10239
10240
10241
10242
10243
10244
10245
10246
10247
10248
10249
10250
10251
10252
10253
10254
10255
10256
10257
10258
10259
10260
10261
10262
10263
10264
10265
10266
10267
10268
10269
10270
10271
10272
10273
10274
10275
10276
10277
10278
10279
10280
10281
10282
10283
10284
10285
10286
10287
10288
10289
10290
10291
10292
10293
10294
10295
10296
10297
10298
10299
10300
10301
10302
10303
10304
10305
10306
10307
10308
10309
10310
10311
10312
10313
10314
10315
10316
10317
10318
10319
10320
10321
10322
10323
10324
10325
10326
10327
10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
10367
10368
10369
10370
10371
10372
10373
10374
10375
10376
10377
10378
10379
10380
10381
10382
10383
10384
10385
10386
10387
10388
10389
10390
10391
10392
10393
10394
10395
10396
10397
10398
10399
10400
10401
10402
10403
10404
10405
10406
10407
10408
10409
10410
10411
10412
10413
10414
10415
10416
10417
10418
10419
10420
10421
10422
10423
10424
10425
10426
10427
10428
10429
10430
10431
10432
10433
10434
10435
10436
10437
10438
10439
10440
10441
10442
10443
10444
10445
10446
10447
10448
10449
10450
10451
10452
10453
10454
10455
10456
10457
10458
10459
10460
10461
10462
10463
10464
10465
10466
10467
10468
10469
10470
10471
10472
10473
10474
10475
10476
10477
10478
10479
10480
10481
10482
10483
10484
10485
10486
10487
10488
10489
10490
10491
10492
10493
10494
10495
10496
10497
10498
10499
10500
10501
10502
10503
10504
10505
10506
10507
10508
10509
10510
10511
10512
10513
10514
10515
10516
10517
10518
10519
10520
10521
10522
10523
10524
10525
10526
10527
10528
10529
10530
10531
10532
10533
10534
10535
10536
10537
10538
10539
10540
10541
10542
10543
10544
10545
10546
10547
10548
10549
10550
10551
10552
10553
10554
10555
10556
10557
10558
10559
10560
10561
10562
10563
10564
10565
10566
10567
10568
10569
10570
10571
10572
10573
10574
10575
10576
10577
10578
10579
10580
10581
10582
10583
10584
10585
10586
10587
10588
10589
10590
10591
10592
10593
10594
10595
10596
10597
10598
10599
10600
10601
10602
10603
10604
10605
10606
10607
10608
10609
10610
10611
10612
10613
10614
10615
10616
10617
10618
10619
10620
10621
10622
10623
10624
10625
10626
10627
10628
10629
10630
10631
10632
10633
10634
10635
10636
10637
10638
10639
10640
10641
10642
10643
10644
10645
10646
10647
10648
10649
10650
10651
10652
10653
10654
10655
10656
10657
10658
10659
10660
10661
10662
10663
10664
10665
10666
10667
10668
10669
10670
10671
10672
10673
10674
10675
10676
10677
10678
10679
10680
10681
10682
10683
10684
10685
10686
10687
10688
10689
10690
10691
10692
10693
10694
10695
10696
10697
10698
10699
10700
10701
10702
10703
10704
10705
10706
10707
10708
10709
10710
10711
10712
10713
10714
10715
10716
10717
10718
10719
10720
10721
10722
10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
10736
10737
10738
10739
10740
10741
10742
10743
10744
10745
10746
10747
10748
10749
10750
10751
10752
10753
10754
10755
10756
10757
10758
10759
10760
10761
10762
10763
10764
10765
10766
10767
10768
10769
10770
10771
10772
10773
10774
10775
10776
10777
10778
10779
10780
10781
10782
10783
10784
10785
10786
10787
10788
10789
10790
10791
10792
10793
10794
10795
10796
10797
10798
10799
10800
10801
10802
10803
10804
10805
10806
10807
10808
10809
10810
10811
10812
10813
10814
10815
10816
10817
10818
10819
10820
10821
10822
10823
10824
10825
10826
10827
10828
10829
10830
10831
10832
10833
10834
10835
10836
10837
10838
10839
10840
10841
10842
10843
10844
10845
10846
10847
10848
10849
10850
10851
10852
10853
10854
10855
10856
10857
10858
10859
10860
10861
10862
10863
10864
10865
10866
10867
10868
10869
10870
10871
10872
10873
10874
10875
10876
10877
10878
10879
10880
10881
10882
10883
10884
10885
10886
10887
10888
10889
10890
10891
10892
10893
10894
10895
10896
10897
10898
10899
10900
10901
10902
10903
10904
10905
10906
10907
10908
10909
10910
10911
10912
10913
10914
10915
10916
10917
10918
10919
10920
10921
10922
10923
10924
10925
10926
10927
10928
10929
10930
10931
10932
10933
10934
10935
10936
10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
10988
10989
10990
10991
10992
10993
10994
10995
10996
10997
10998
10999
11000
11001
11002
11003
11004
11005
11006
11007
11008
11009
11010
11011
11012
11013
11014
11015
11016
11017
11018
11019
11020
11021
11022
11023
11024
11025
11026
11027
11028
11029
11030
11031
11032
11033
11034
11035
11036
11037
11038
11039
11040
11041
11042
11043
11044
11045
11046
11047
11048
11049
11050
11051
11052
11053
11054
11055
11056
11057
11058
11059
11060
11061
11062
11063
11064
11065
11066
11067
11068
11069
11070
11071
11072
11073
11074
11075
11076
11077
11078
11079
11080
11081
11082
11083
11084
11085
11086
11087
11088
11089
11090
11091
11092
11093
11094
11095
11096
11097
11098
11099
11100
11101
11102
11103
11104
11105
11106
11107
11108
11109
11110
11111
11112
11113
11114
11115
11116
11117
11118
11119
11120
11121
11122
11123
11124
11125
11126
11127
11128
11129
11130
11131
11132
11133
11134
11135
11136
11137
11138
11139
11140
11141
11142
11143
11144
11145
11146
11147
11148
11149
11150
11151
11152
11153
11154
11155
11156
11157
11158
11159
11160
11161
11162
11163
11164
11165
11166
11167
11168
11169
11170
11171
11172
11173
11174
11175
11176
11177
11178
11179
11180
11181
11182
11183
11184
11185
11186
11187
11188
11189
11190
11191
11192
11193
11194
11195
11196
11197
11198
11199
11200
11201
11202
11203
11204
11205
11206
11207
11208
11209
11210
11211
11212
11213
11214
11215
11216
11217
11218
11219
11220
11221
11222
11223
11224
11225
11226
11227
11228
11229
11230
11231
11232
11233
11234
11235
11236
11237
11238
11239
11240
11241
11242
11243
11244
11245
11246
11247
11248
11249
11250
11251
11252
11253
11254
11255
11256
11257
11258
11259
11260
11261
11262
11263
11264
11265
11266
11267
11268
11269
11270
11271
11272
11273
11274
11275
11276
11277
11278
11279
11280
11281
11282
11283
11284
11285
11286
11287
11288
11289
11290
11291
11292
11293
11294
11295
11296
11297
11298
11299
11300
11301
11302
11303
11304
11305
11306
11307
11308
11309
11310
11311
11312
11313
11314
11315
11316
11317
11318
11319
11320
11321
11322
11323
11324
11325
11326
11327
11328
11329
11330
11331
11332
11333
11334
11335
11336
11337
11338
11339
11340
11341
11342
11343
11344
11345
11346
11347
11348
11349
11350
11351
11352
11353
11354
11355
11356
11357
11358
11359
11360
11361
11362
11363
11364
11365
11366
11367
11368
11369
11370
11371
11372
11373
11374
11375
11376
11377
11378
11379
11380
11381
11382
11383
11384
11385
11386
11387
11388
11389
11390
11391
11392
11393
11394
11395
11396
11397
11398
11399
11400
11401
11402
11403
11404
11405
11406
11407
11408
11409
11410
11411
11412
11413
11414
11415
11416
11417
11418
11419
11420
11421
11422
11423
11424
11425
11426
11427
11428
11429
11430
11431
11432
11433
11434
11435
11436
11437
11438
11439
11440
11441
11442
11443
11444
11445
11446
11447
11448
11449
11450
11451
11452
11453
11454
11455
11456
11457
11458
11459
11460
11461
11462
11463
11464
11465
11466
11467
11468
11469
11470
11471
11472
11473
11474
11475
11476
11477
11478
11479
11480
11481
11482
11483
11484
11485
11486
11487
11488
11489
11490
11491
11492
11493
11494
11495
11496
11497
11498
11499
11500
11501
11502
11503
11504
11505
11506
11507
11508
11509
11510
11511
11512
11513
11514
11515
11516
11517
11518
11519
11520
11521
11522
11523
11524
11525
11526
11527
11528
11529
11530
11531
11532
11533
11534
11535
11536
11537
11538
11539
11540
11541
11542
11543
11544
11545
11546
11547
11548
11549
11550
11551
11552
11553
11554
11555
11556
11557
11558
11559
11560
11561
11562
11563
11564
11565
11566
11567
11568
11569
11570
11571
11572
11573
11574
11575
11576
11577
11578
11579
11580
11581
11582
11583
11584
11585
11586
11587
11588
11589
11590
11591
11592
11593
11594
11595
11596
11597
11598
11599
11600
11601
11602
11603
11604
11605
11606
11607
11608
11609
11610
11611
11612
11613
11614
11615
11616
11617
11618
11619
11620
11621
11622
11623
11624
11625
11626
11627
11628
11629
11630
11631
11632
11633
11634
11635
11636
11637
11638
11639
11640
11641
11642
11643
11644
11645
11646
11647
11648
11649
11650
11651
11652
11653
11654
11655
11656
11657
11658
11659
11660
11661
11662
11663
11664
11665
11666
11667
11668
11669
11670
11671
11672
11673
11674
11675
11676
11677
11678
11679
11680
11681
11682
11683
11684
11685
11686
11687
11688
11689
11690
11691
11692
11693
11694
11695
11696
11697
11698
11699
11700
11701
11702
11703
11704
11705
11706
11707
11708
11709
11710
11711
11712
11713
11714
11715
11716
11717
11718
11719
11720
11721
11722
11723
11724
11725
11726
11727
11728
11729
11730
11731
11732
11733
11734
11735
11736
11737
11738
11739
11740
11741
11742
11743
11744
11745
11746
11747
11748
11749
11750
11751
11752
11753
11754
11755
11756
11757
11758
11759
11760
11761
11762
11763
11764
11765
11766
11767
11768
11769
11770
11771
11772
11773
11774
11775
11776
11777
11778
11779
11780
11781
11782
11783
11784
11785
11786
11787
11788
11789
11790
11791
11792
11793
11794
11795
11796
11797
11798
11799
11800
11801
11802
11803
11804
11805
11806
11807
11808
11809
11810
11811
11812
11813
11814
11815
11816
11817
11818
11819
11820
11821
11822
11823
11824
11825
11826
11827
11828
11829
11830
11831
11832
11833
11834
11835
11836
11837
11838
11839
11840
11841
11842
11843
11844
11845
11846
11847
11848
11849
11850
11851
11852
11853
11854
11855
11856
11857
11858
11859
11860
11861
11862
11863
11864
11865
11866
11867
11868
11869
11870
11871
11872
11873
11874
11875
11876
11877
11878
11879
11880
11881
11882
11883
11884
11885
11886
11887
11888
11889
11890
11891
11892
11893
11894
11895
11896
11897
11898
11899
11900
11901
11902
11903
11904
11905
11906
11907
11908
11909
11910
11911
11912
11913
11914
11915
11916
11917
11918
11919
11920
11921
11922
11923
11924
11925
11926
11927
11928
11929
11930
11931
11932
11933
11934
11935
11936
11937
11938
11939
11940
11941
11942
11943
11944
11945
11946
11947
11948
11949
11950
11951
11952
11953
11954
11955
11956
11957
11958
11959
11960
11961
11962
11963
11964
11965
11966
11967
11968
11969
11970
11971
11972
11973
11974
11975
11976
11977
11978
11979
11980
11981
11982
11983
11984
11985
11986
11987
11988
11989
11990
11991
11992
11993
11994
11995
11996
11997
11998
11999
12000
12001
12002
12003
12004
12005
12006
12007
12008
12009
12010
12011
12012
12013
12014
12015
12016
12017
12018
12019
12020
12021
12022
12023
12024
12025
12026
12027
12028
12029
12030
12031
12032
12033
12034
12035
12036
12037
12038
12039
12040
12041
12042
12043
12044
12045
12046
12047
12048
12049
12050
12051
12052
12053
12054
12055
12056
12057
12058
12059
12060
12061
12062
12063
12064
12065
12066
12067
12068
12069
12070
12071
12072
12073
12074
12075
12076
12077
12078
12079
12080
12081
12082
12083
12084
12085
12086
12087
12088
12089
12090
12091
12092
12093
12094
12095
12096
12097
12098
12099
12100
12101
12102
12103
12104
12105
12106
12107
12108
12109
12110
12111
12112
12113
12114
12115
12116
12117
12118
12119
12120
12121
12122
12123
12124
12125
12126
12127
12128
12129
12130
12131
12132
12133
12134
12135
12136
12137
12138
12139
12140
12141
12142
12143
12144
12145
12146
12147
12148
12149
12150
12151
12152
12153
12154
12155
12156
12157
12158
12159
12160
12161
12162
12163
12164
12165
12166
12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
12178
12179
12180
12181
12182
12183
12184
12185
12186
12187
12188
12189
12190
12191
12192
12193
12194
12195
12196
12197
12198
12199
12200
12201
12202
12203
12204
12205
12206
12207
12208
12209
12210
12211
12212
12213
12214
12215
12216
12217
12218
12219
12220
12221
12222
12223
12224
12225
12226
12227
12228
12229
12230
12231
12232
12233
12234
12235
12236
12237
12238
12239
12240
12241
12242
12243
12244
12245
12246
12247
12248
12249
12250
12251
12252
12253
12254
12255
12256
12257
12258
12259
12260
12261
12262
12263
12264
12265
12266
12267
12268
12269
12270
12271
12272
12273
12274
12275
12276
12277
12278
12279
12280
12281
12282
12283
12284
12285
12286
12287
12288
12289
12290
12291
12292
12293
12294
12295
12296
12297
12298
12299
12300
12301
12302
12303
12304
12305
12306
12307
12308
12309
12310
12311
12312
12313
12314
12315
12316
12317
12318
12319
12320
12321
12322
12323
12324
12325
12326
12327
12328
12329
12330
12331
12332
12333
12334
12335
12336
12337
12338
12339
12340
12341
12342
12343
12344
12345
12346
12347
12348
12349
12350
12351
12352
12353
12354
12355
12356
12357
12358
12359
12360
12361
12362
12363
12364
12365
12366
12367
12368
12369
12370
12371
12372
12373
12374
12375
12376
12377
12378
12379
12380
12381
12382
12383
12384
12385
12386
12387
12388
12389
12390
12391
12392
12393
12394
12395
12396
12397
12398
12399
12400
12401
12402
12403
12404
12405
12406
12407
12408
12409
12410
12411
12412
12413
12414
12415
12416
12417
12418
12419
12420
12421
12422
12423
12424
12425
12426
12427
12428
12429
12430
12431
12432
12433
12434
12435
12436
12437
12438
12439
12440
12441
12442
12443
12444
12445
12446
12447
12448
12449
12450
12451
12452
12453
12454
12455
12456
12457
12458
12459
12460
12461
12462
12463
12464
12465
12466
12467
12468
12469
12470
12471
12472
12473
12474
12475
12476
12477
12478
12479
12480
12481
12482
12483
12484
12485
12486
12487
12488
12489
12490
12491
12492
12493
12494
12495
12496
12497
12498
12499
12500
12501
12502
12503
12504
12505
12506
12507
12508
12509
12510
12511
12512
12513
12514
12515
12516
12517
12518
12519
12520
12521
12522
12523
12524
12525
12526
12527
12528
12529
12530
12531
12532
12533
12534
12535
12536
12537
12538
12539
12540
12541
12542
12543
12544
12545
12546
12547
12548
12549
12550
12551
12552
12553
12554
12555
12556
12557
12558
12559
12560
12561
12562
12563
12564
12565
12566
12567
12568
12569
12570
12571
12572
12573
12574
12575
12576
12577
12578
12579
12580
12581
12582
12583
12584
12585
12586
12587
12588
12589
12590
12591
12592
12593
12594
12595
12596
12597
12598
12599
12600
12601
12602
12603
12604
12605
12606
12607
12608
12609
12610
12611
12612
12613
12614
12615
12616
12617
12618
12619
12620
12621
12622
12623
12624
12625
12626
12627
12628
12629
12630
12631
12632
12633
12634
12635
12636
12637
12638
12639
12640
12641
12642
12643
12644
12645
12646
12647
12648
12649
12650
12651
12652
12653
12654
12655
12656
12657
12658
12659
12660
12661
12662
12663
12664
12665
12666
12667
12668
12669
12670
12671
12672
12673
12674
12675
12676
12677
12678
12679
12680
12681
12682
12683
12684
12685
12686
12687
12688
12689
12690
12691
12692
12693
12694
12695
12696
12697
12698
12699
12700
12701
12702
12703
12704
12705
12706
12707
12708
12709
12710
12711
12712
12713
12714
12715
12716
12717
12718
12719
12720
12721
12722
12723
12724
12725
12726
12727
12728
12729
12730
12731
12732
12733
12734
12735
12736
12737
12738
12739
12740
12741
12742
12743
12744
12745
12746
12747
12748
12749
12750
12751
12752
12753
12754
12755
12756
12757
12758
12759
12760
12761
12762
12763
12764
12765
12766
12767
12768
12769
12770
12771
12772
12773
12774
12775
12776
12777
12778
12779
12780
12781
12782
12783
12784
12785
12786
12787
12788
12789
12790
12791
12792
12793
12794
12795
12796
12797
12798
12799
12800
12801
12802
12803
12804
12805
12806
12807
12808
12809
12810
12811
12812
12813
12814
12815
12816
12817
12818
12819
12820
12821
12822
12823
12824
12825
12826
12827
12828
12829
12830
12831
12832
12833
12834
12835
12836
12837
12838
12839
12840
12841
12842
12843
12844
12845
12846
12847
12848
12849
12850
12851
12852
12853
12854
12855
12856
12857
12858
12859
12860
12861
12862
12863
12864
12865
12866
12867
12868
12869
12870
12871
12872
12873
12874
12875
12876
12877
12878
12879
12880
12881
12882
12883
12884
12885
12886
12887
12888
12889
12890
12891
12892
12893
12894
12895
12896
12897
12898
12899
12900
12901
12902
12903
12904
12905
12906
12907
12908
12909
12910
12911
12912
12913
12914
12915
12916
12917
12918
12919
12920
12921
12922
12923
12924
12925
12926
12927
12928
12929
12930
12931
12932
12933
12934
12935
12936
12937
12938
12939
12940
12941
12942
12943
12944
12945
12946
12947
12948
12949
12950
12951
12952
12953
12954
12955
12956
12957
12958
12959
12960
12961
12962
12963
12964
12965
12966
12967
12968
12969
12970
12971
12972
12973
12974
12975
12976
12977
12978
12979
12980
12981
12982
12983
12984
12985
12986
12987
12988
12989
12990
12991
12992
12993
12994
12995
12996
12997
12998
12999
13000
13001
13002
13003
13004
13005
13006
13007
13008
13009
13010
13011
13012
13013
13014
13015
13016
13017
13018
13019
13020
13021
13022
13023
13024
13025
13026
13027
13028
13029
13030
13031
13032
13033
13034
13035
13036
13037
13038
13039
13040
13041
13042
13043
13044
13045
13046
13047
13048
13049
13050
13051
13052
13053
13054
13055
13056
13057
13058
13059
13060
13061
13062
13063
13064
13065
13066
13067
13068
13069
13070
13071
13072
13073
13074
13075
13076
13077
13078
13079
13080
13081
13082
13083
13084
13085
13086
13087
13088
13089
13090
13091
13092
13093
13094
13095
13096
13097
13098
13099
13100
13101
13102
13103
13104
13105
13106
13107
13108
13109
13110
13111
13112
13113
13114
13115
13116
13117
13118
13119
13120
13121
13122
13123
13124
13125
13126
13127
13128
13129
13130
13131
13132
13133
13134
13135
13136
13137
13138
13139
13140
13141
13142
13143
13144
13145
13146
13147
13148
13149
13150
13151
13152
13153
13154
13155
13156
13157
13158
13159
13160
13161
13162
13163
13164
13165
13166
13167
13168
13169
13170
13171
13172
13173
13174
13175
13176
13177
13178
13179
13180
13181
13182
13183
13184
13185
13186
13187
13188
13189
13190
13191
13192
13193
13194
13195
13196
13197
13198
13199
13200
13201
13202
13203
13204
13205
13206
13207
13208
13209
13210
13211
13212
13213
13214
13215
13216
13217
13218
13219
13220
13221
13222
13223
13224
13225
13226
13227
13228
13229
13230
13231
13232
13233
13234
13235
13236
13237
13238
13239
13240
13241
13242
13243
13244
13245
13246
13247
13248
13249
13250
13251
13252
13253
13254
13255
13256
13257
13258
13259
13260
13261
13262
13263
13264
13265
13266
13267
13268
13269
13270
13271
13272
13273
13274
13275
13276
13277
13278
13279
13280
13281
13282
13283
13284
13285
13286
13287
13288
13289
13290
13291
13292
13293
13294
13295
13296
13297
13298
13299
13300
13301
13302
13303
13304
13305
13306
13307
13308
13309
13310
13311
13312
13313
13314
13315
13316
13317
13318
13319
13320
13321
13322
13323
13324
13325
13326
13327
13328
13329
13330
13331
13332
13333
13334
13335
13336
13337
13338
13339
13340
13341
13342
13343
13344
13345
13346
13347
13348
13349
13350
13351
13352
13353
13354
13355
13356
13357
13358
13359
13360
13361
13362
13363
13364
13365
13366
13367
13368
13369
13370
13371
13372
13373
13374
13375
13376
13377
13378
13379
13380
13381
13382
13383
13384
13385
13386
13387
13388
13389
13390
13391
13392
13393
13394
13395
13396
13397
13398
13399
13400
13401
13402
13403
13404
13405
13406
13407
13408
13409
13410
13411
13412
13413
13414
13415
13416
13417
13418
13419
13420
13421
13422
13423
13424
13425
13426
13427
13428
13429
13430
13431
13432
13433
13434
13435
13436
13437
13438
13439
13440
13441
13442
13443
13444
13445
13446
13447
13448
13449
13450
13451
13452
13453
13454
13455
13456
13457
13458
13459
13460
13461
13462
13463
13464
13465
13466
13467
13468
13469
13470
13471
13472
13473
13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
13553
13554
13555
13556
13557
13558
13559
13560
13561
13562
13563
13564
13565
13566
13567
13568
13569
13570
13571
13572
13573
13574
13575
13576
13577
13578
13579
13580
13581
13582
13583
13584
13585
13586
13587
13588
13589
13590
13591
13592
13593
13594
13595
13596
13597
13598
13599
13600
13601
13602
13603
13604
13605
13606
13607
13608
13609
13610
13611
13612
13613
13614
13615
13616
13617
13618
13619
13620
13621
13622
13623
13624
13625
13626
13627
13628
13629
13630
13631
13632
13633
13634
13635
13636
13637
13638
13639
13640
13641
13642
13643
13644
13645
13646
13647
13648
13649
13650
13651
13652
13653
13654
13655
13656
13657
13658
13659
13660
13661
13662
13663
13664
13665
13666
13667
13668
13669
13670
13671
13672
13673
13674
13675
13676
13677
13678
13679
13680
13681
13682
13683
13684
13685
13686
13687
13688
13689
13690
13691
13692
13693
13694
13695
13696
13697
13698
13699
13700
13701
13702
13703
13704
13705
13706
13707
13708
13709
13710
13711
13712
13713
13714
13715
13716
13717
13718
13719
13720
13721
13722
13723
13724
13725
13726
13727
13728
13729
13730
13731
13732
13733
13734
13735
13736
13737
13738
13739
13740
13741
13742
13743
13744
13745
13746
13747
13748
13749
13750
13751
13752
13753
13754
13755
13756
13757
13758
13759
13760
13761
13762
13763
13764
13765
13766
13767
13768
13769
13770
13771
13772
13773
13774
13775
13776
13777
13778
13779
13780
13781
13782
13783
13784
13785
13786
13787
13788
13789
13790
13791
13792
13793
13794
13795
13796
13797
13798
13799
13800
13801
13802
13803
13804
13805
13806
13807
13808
13809
13810
13811
13812
13813
13814
13815
13816
13817
13818
13819
13820
13821
13822
13823
13824
13825
13826
13827
13828
13829
13830
13831
13832
13833
13834
13835
13836
13837
13838
13839
13840
13841
13842
13843
13844
13845
13846
13847
13848
13849
13850
13851
13852
13853
13854
13855
13856
13857
13858
13859
13860
13861
13862
13863
13864
13865
13866
13867
13868
13869
13870
13871
13872
13873
13874
13875
13876
13877
13878
13879
13880
13881
13882
13883
13884
13885
13886
13887
13888
13889
13890
13891
13892
13893
13894
13895
13896
13897
13898
13899
13900
13901
13902
13903
13904
13905
13906
13907
13908
13909
13910
13911
13912
13913
13914
13915
13916
13917
13918
13919
13920
13921
13922
13923
13924
13925
13926
13927
13928
13929
13930
13931
13932
13933
13934
13935
13936
13937
13938
13939
13940
13941
13942
13943
13944
13945
13946
13947
13948
13949
13950
13951
13952
13953
13954
13955
13956
13957
13958
13959
13960
13961
13962
13963
13964
13965
13966
13967
13968
13969
13970
13971
13972
13973
13974
13975
13976
13977
13978
13979
13980
13981
13982
13983
13984
13985
13986
13987
13988
13989
13990
13991
13992
13993
13994
13995
13996
13997
13998
13999
14000
14001
14002
14003
14004
14005
14006
14007
14008
14009
14010
14011
14012
14013
14014
14015
14016
14017
14018
14019
14020
14021
14022
14023
14024
14025
14026
14027
14028
14029
14030
14031
14032
14033
14034
14035
14036
14037
14038
14039
14040
14041
14042
14043
14044
14045
14046
14047
14048
14049
14050
14051
14052
14053
14054
14055
14056
14057
14058
14059
14060
14061
14062
14063
14064
14065
14066
14067
14068
14069
14070
14071
14072
14073
14074
14075
14076
14077
14078
14079
14080
14081
14082
14083
14084
14085
14086
14087
14088
14089
14090
14091
14092
14093
14094
14095
14096
14097
14098
14099
14100
14101
14102
14103
14104
14105
14106
14107
14108
14109
14110
14111
14112
14113
14114
14115
14116
14117
14118
14119
14120
14121
14122
14123
14124
14125
14126
14127
14128
14129
14130
14131
14132
14133
14134
14135
14136
14137
14138
14139
14140
14141
14142
14143
14144
14145
14146
14147
14148
14149
14150
14151
14152
14153
14154
14155
14156
14157
14158
14159
14160
14161
14162
14163
14164
14165
14166
14167
14168
14169
14170
14171
14172
14173
14174
14175
14176
14177
14178
14179
14180
14181
14182
14183
14184
14185
14186
14187
14188
14189
14190
14191
14192
14193
14194
14195
14196
14197
14198
14199
14200
14201
14202
14203
14204
14205
14206
14207
14208
14209
14210
14211
14212
14213
14214
14215
14216
14217
14218
14219
14220
14221
14222
14223
14224
14225
14226
14227
14228
14229
14230
14231
14232
14233
14234
14235
14236
14237
14238
14239
14240
14241
14242
14243
14244
14245
14246
14247
14248
14249
14250
14251
14252
14253
14254
14255
14256
14257
14258
14259
14260
14261
14262
14263
14264
14265
14266
14267
14268
14269
14270
14271
14272
14273
14274
14275
14276
14277
14278
14279
14280
14281
14282
14283
14284
14285
14286
14287
14288
14289
14290
14291
14292
14293
14294
14295
14296
14297
14298
14299
14300
14301
14302
14303
14304
14305
14306
14307
14308
14309
14310
14311
14312
14313
14314
14315
14316
14317
14318
14319
14320
14321
14322
14323
14324
14325
14326
14327
14328
14329
14330
14331
14332
14333
14334
14335
14336
14337
14338
14339
14340
14341
14342
14343
14344
14345
14346
14347
14348
14349
14350
14351
14352
14353
14354
14355
14356
14357
14358
14359
14360
14361
14362
14363
14364
14365
14366
14367
14368
14369
14370
14371
14372
14373
14374
14375
14376
14377
14378
14379
14380
14381
14382
14383
14384
14385
14386
14387
14388
14389
14390
14391
14392
14393
14394
14395
14396
14397
14398
14399
14400
14401
14402
14403
14404
14405
14406
14407
14408
14409
14410
14411
14412
14413
14414
14415
14416
14417
14418
14419
14420
14421
14422
14423
14424
14425
14426
14427
14428
14429
14430
14431
14432
14433
14434
14435
14436
14437
14438
14439
14440
14441
14442
14443
14444
14445
14446
14447
14448
14449
14450
14451
14452
14453
14454
14455
14456
14457
14458
14459
14460
14461
14462
14463
14464
14465
14466
14467
14468
14469
14470
14471
14472
14473
14474
14475
14476
14477
14478
14479
14480
14481
14482
14483
14484
14485
14486
14487
14488
14489
14490
14491
14492
14493
14494
14495
14496
14497
14498
14499
14500
14501
14502
14503
14504
14505
14506
14507
14508
14509
14510
14511
14512
14513
14514
14515
14516
14517
14518
14519
14520
14521
14522
14523
14524
14525
14526
14527
14528
14529
14530
14531
14532
14533
14534
14535
14536
14537
14538
14539
14540
14541
14542
14543
14544
14545
14546
14547
14548
14549
14550
14551
14552
14553
14554
14555
14556
14557
14558
14559
14560
14561
14562
14563
14564
14565
14566
14567
14568
14569
14570
14571
14572
14573
14574
14575
14576
14577
14578
14579
14580
14581
14582
14583
14584
14585
14586
14587
14588
14589
14590
14591
14592
14593
14594
14595
14596
14597
14598
14599
14600
14601
14602
14603
14604
14605
14606
14607
14608
14609
14610
14611
14612
14613
14614
14615
14616
14617
14618
14619
14620
14621
14622
14623
14624
14625
14626
14627
14628
14629
14630
14631
14632
14633
14634
14635
14636
14637
14638
/**
* Copyright 2019 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { OAuth2Client, JWT, Compute, UserRefreshClient } from 'google-auth-library';
import { GoogleConfigurable, MethodOptions, GlobalOptions, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { GaxiosPromise } from 'gaxios';
export declare namespace dfareporting_v3_3 {
export interface Options extends GlobalOptions {
version: 'v3.3';
}
interface StandardParameters {
/**
* Data format for the response.
*/
alt?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
*/
quotaUser?: string;
/**
* Deprecated. Please use quotaUser instead.
*/
userIp?: string;
}
/**
* DCM/DFA Reporting And Trafficking API
*
* Manages your DoubleClick Campaign Manager ad campaigns and reports.
*
* @example
* const {google} = require('googleapis');
* const dfareporting = google.dfareporting('v3.3');
*
* @namespace dfareporting
* @type {Function}
* @version v3.3
* @variation v3.3
* @param {object=} options Options for Dfareporting
*/
export class Dfareporting {
context: APIRequestContext;
accountActiveAdSummaries: Resource$Accountactiveadsummaries;
accountPermissionGroups: Resource$Accountpermissiongroups;
accountPermissions: Resource$Accountpermissions;
accounts: Resource$Accounts;
accountUserProfiles: Resource$Accountuserprofiles;
ads: Resource$Ads;
advertiserGroups: Resource$Advertisergroups;
advertiserLandingPages: Resource$Advertiserlandingpages;
advertisers: Resource$Advertisers;
browsers: Resource$Browsers;
campaignCreativeAssociations: Resource$Campaigncreativeassociations;
campaigns: Resource$Campaigns;
changeLogs: Resource$Changelogs;
cities: Resource$Cities;
connectionTypes: Resource$Connectiontypes;
contentCategories: Resource$Contentcategories;
conversions: Resource$Conversions;
countries: Resource$Countries;
creativeAssets: Resource$Creativeassets;
creativeFields: Resource$Creativefields;
creativeFieldValues: Resource$Creativefieldvalues;
creativeGroups: Resource$Creativegroups;
creatives: Resource$Creatives;
dimensionValues: Resource$Dimensionvalues;
directorySites: Resource$Directorysites;
dynamicTargetingKeys: Resource$Dynamictargetingkeys;
eventTags: Resource$Eventtags;
files: Resource$Files;
floodlightActivities: Resource$Floodlightactivities;
floodlightActivityGroups: Resource$Floodlightactivitygroups;
floodlightConfigurations: Resource$Floodlightconfigurations;
inventoryItems: Resource$Inventoryitems;
languages: Resource$Languages;
metros: Resource$Metros;
mobileApps: Resource$Mobileapps;
mobileCarriers: Resource$Mobilecarriers;
operatingSystems: Resource$Operatingsystems;
operatingSystemVersions: Resource$Operatingsystemversions;
orderDocuments: Resource$Orderdocuments;
orders: Resource$Orders;
placementGroups: Resource$Placementgroups;
placements: Resource$Placements;
placementStrategies: Resource$Placementstrategies;
platformTypes: Resource$Platformtypes;
postalCodes: Resource$Postalcodes;
projects: Resource$Projects;
regions: Resource$Regions;
remarketingLists: Resource$Remarketinglists;
remarketingListShares: Resource$Remarketinglistshares;
reports: Resource$Reports;
sites: Resource$Sites;
sizes: Resource$Sizes;
subaccounts: Resource$Subaccounts;
targetableRemarketingLists: Resource$Targetableremarketinglists;
targetingTemplates: Resource$Targetingtemplates;
userProfiles: Resource$Userprofiles;
userRolePermissionGroups: Resource$Userrolepermissiongroups;
userRolePermissions: Resource$Userrolepermissions;
userRoles: Resource$Userroles;
videoFormats: Resource$Videoformats;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Contains properties of a Campaign Manager account.
*/
export interface Schema$Account {
/**
* Account permissions assigned to this account.
*/
accountPermissionIds?: string[] | null;
/**
* Profile for this account. This is a read-only field that can be left blank.
*/
accountProfile?: string | null;
/**
* Whether this account is active.
*/
active?: boolean | null;
/**
* Maximum number of active ads allowed for this account.
*/
activeAdsLimitTier?: string | null;
/**
* Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.
*/
activeViewOptOut?: boolean | null;
/**
* User role permissions available to the user roles of this account.
*/
availablePermissionIds?: string[] | null;
/**
* ID of the country associated with this account.
*/
countryId?: string | null;
/**
* ID of currency associated with this account. This is a required field. Acceptable values are: - "1" for USD - "2" for GBP - "3" for ESP - "4" for SEK - "5" for CAD - "6" for JPY - "7" for DEM - "8" for AUD - "9" for FRF - "10" for ITL - "11" for DKK - "12" for NOK - "13" for FIM - "14" for ZAR - "15" for IEP - "16" for NLG - "17" for EUR - "18" for KRW - "19" for TWD - "20" for SGD - "21" for CNY - "22" for HKD - "23" for NZD - "24" for MYR - "25" for BRL - "26" for PTE - "27" for MXP - "28" for CLP - "29" for TRY - "30" for ARS - "31" for PEN - "32" for ILS - "33" for CHF - "34" for VEF - "35" for COP - "36" for GTQ - "37" for PLN - "39" for INR - "40" for THB - "41" for IDR - "42" for CZK - "43" for RON - "44" for HUF - "45" for RUB - "46" for AED - "47" for BGN - "48" for HRK - "49" for MXN - "50" for NGN
*/
currencyId?: string | null;
/**
* Default placement dimensions for this account.
*/
defaultCreativeSizeId?: string | null;
/**
* Description of this account.
*/
description?: string | null;
/**
* ID of this account. This is a read-only, auto-generated field.
*/
id?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#account".
*/
kind?: string | null;
/**
* Locale of this account. Acceptable values are: - "cs" (Czech) - "de" (German) - "en" (English) - "en-GB" (English United Kingdom) - "es" (Spanish) - "fr" (French) - "it" (Italian) - "ja" (Japanese) - "ko" (Korean) - "pl" (Polish) - "pt-BR" (Portuguese Brazil) - "ru" (Russian) - "sv" (Swedish) - "tr" (Turkish) - "zh-CN" (Chinese Simplified) - "zh-TW" (Chinese Traditional)
*/
locale?: string | null;
/**
* Maximum image size allowed for this account, in kilobytes. Value must be greater than or equal to 1.
*/
maximumImageSize?: string | null;
/**
* Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.
*/
name?: string | null;
/**
* Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.
*/
nielsenOcrEnabled?: boolean | null;
/**
* Reporting configuration of this account.
*/
reportsConfiguration?: Schema$ReportsConfiguration;
/**
* Share Path to Conversion reports with Twitter.
*/
shareReportsWithTwitter?: boolean | null;
/**
* File size limit in kilobytes of Rich Media teaser creatives. Acceptable values are 1 to 10240, inclusive.
*/
teaserSizeLimit?: string | null;
}
/**
* Gets a summary of active ads in an account.
*/
export interface Schema$AccountActiveAdSummary {
/**
* ID of the account.
*/
accountId?: string | null;
/**
* Ads that have been activated for the account
*/
activeAds?: string | null;
/**
* Maximum number of active ads allowed for the account.
*/
activeAdsLimitTier?: string | null;
/**
* Ads that can be activated for the account.
*/
availableAds?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountActiveAdSummary".
*/
kind?: string | null;
}
/**
* AccountPermissions contains information about a particular account permission. Some features of Campaign Manager require an account permission to be present in the account.
*/
export interface Schema$AccountPermission {
/**
* Account profiles associated with this account permission. Possible values are: - "ACCOUNT_PROFILE_BASIC" - "ACCOUNT_PROFILE_STANDARD"
*/
accountProfiles?: string[] | null;
/**
* ID of this account permission.
*/
id?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermission".
*/
kind?: string | null;
/**
* Administrative level required to enable this account permission.
*/
level?: string | null;
/**
* Name of this account permission.
*/
name?: string | null;
/**
* Permission group of this account permission.
*/
permissionGroupId?: string | null;
}
/**
* AccountPermissionGroups contains a mapping of permission group IDs to names. A permission group is a grouping of account permissions.
*/
export interface Schema$AccountPermissionGroup {
/**
* ID of this account permission group.
*/
id?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionGroup".
*/
kind?: string | null;
/**
* Name of this account permission group.
*/
name?: string | null;
}
/**
* Account Permission Group List Response
*/
export interface Schema$AccountPermissionGroupsListResponse {
/**
* Account permission group collection.
*/
accountPermissionGroups?: Schema$AccountPermissionGroup[];
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionGroupsListResponse".
*/
kind?: string | null;
}
/**
* Account Permission List Response
*/
export interface Schema$AccountPermissionsListResponse {
/**
* Account permission collection.
*/
accountPermissions?: Schema$AccountPermission[];
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionsListResponse".
*/
kind?: string | null;
}
/**
* Account List Response
*/
export interface Schema$AccountsListResponse {
/**
* Account collection.
*/
accounts?: Schema$Account[];
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountsListResponse".
*/
kind?: string | null;
/**
* Pagination token to be used for the next list operation.
*/
nextPageToken?: string | null;
}
/**
* AccountUserProfiles contains properties of a Campaign Manager user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
*/
export interface Schema$AccountUserProfile {
/**
* Account ID of the user profile. This is a read-only field that can be left blank.
*/
accountId?: string | null;
/**
* Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
*/
active?: boolean | null;
/**
* Filter that describes which advertisers are visible to the user profile.
*/
advertiserFilter?: Schema$ObjectFilter;
/**
* Filter that describes which campaigns are visible to the user profile.
*/
campaignFilter?: Schema$ObjectFilter;
/**
* Comments for this user profile.
*/
comments?: string | null;
/**
* Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
*/
email?: string | null;
/**
* ID of the user profile. This is a read-only, auto-generated field.
*/
id?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
*/
kind?: string | null;
/**
* Locale of the user profile. This is a required field. Acceptable values are: - "cs" (Czech) - "de" (German) - "en" (English) - "en-GB" (English United Kingdom) - "es" (Spanish) - "fr" (French) - "it" (Italian) - "ja" (Japanese) - "ko" (Korean) - "pl" (Polish) - "pt-BR" (Portuguese Brazil) - "ru" (Russian) - "sv" (Swedish) - "tr" (Turkish) - "zh-CN" (Chinese Simplified) - "zh-TW" (Chinese Traditional)
*/
locale?: string | null;
/**
* Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;"#%,".
*/
name?: string | null;
/**
* Filter that describes which sites are visible to the user profile.
*/
siteFilter?: Schema$ObjectFilter;
/**
* Subaccount ID of the user profile. This is a read-only field that can be left blank.
*/
subaccountId?: string | null;
/**
* Trafficker type of this user profile. This is a read-only field.
*/
traffickerType?: string | null;
/**
* User type of the user profile. This is a read-only field that can be left blank.
*/
userAccessType?: string | null;
/**
* Filter that describes which user roles are visible to the user profile.
*/
userRoleFilter?: Schema$ObjectFilter;
/**
* User role ID of the user profile. This is a required field.
*/
userRoleId?: string | null;
}
/**
* Account User Profile List Response
*/
export interface Schema$AccountUserProfilesListResponse {
/**
* Account user profile collection.
*/
accountUserProfiles?: Schema$AccountUserProfile[];
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfilesListResponse".
*/
kind?: string | null;
/**
* Pagination token to be used for the next list operation.
*/
nextPageToken?: string | null;
}
/**
* Represents an activity group.
*/
export interface Schema$Activities {
/**
* List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
*/
filters?: Schema$DimensionValue[];
/**
* The kind of resource this is, in this case dfareporting#activities.
*/
kind?: string | null;
/**
* List of names of floodlight activity metrics.
*/
metricNames?: string[] | null;
}
/**
* Contains properties of a Campaign Manager ad.
*/
export interface Schema$Ad {
/**
* Account ID of this ad. This is a read-only field that can be left blank.
*/
accountId?: string | null;
/**
* Whether this ad is active. When true, archived must be false.
*/
active?: boolean | null;
/**
* Advertiser ID of this ad. This is a required field on insertion.
*/
advertiserId?: string | null;
/**
* Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
*/
advertiserIdDimensionValue?: Schema$DimensionValue;
/**
* Whether this ad is archived. When true, active must be false.
*/
archived?: boolean | null;
/**
* Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
*/
audienceSegmentId?: string | null;
/**
* Campaign ID of this ad. This is a required field on insertion.
*/
campaignId?: string | null;
/**
* Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
*/
campaignIdDimensionValue?: Schema$DimensionValue;
/**
* Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
*/
clickThroughUrl?: Schema$ClickThroughUrl;
/**
* Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
*/
clickThroughUrlSuffixProperties?: Schema$ClickThroughUrlSuffixProperties;
/**
* Comments for this ad.
*/
comments?: string | null;
/**
* Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
*/
compatibility?: string | null;
/**
* Information about the creation of this ad. This is a read-only field.
*/
createInfo?: Schema$LastModifiedInfo;
/**
* Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.
*/
creativeGroupAssignments?: Schema$CreativeGroupAssignment[];
/**
* Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment.
*/
creativeRotation?: Schema$CreativeRotation;
/**
* Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
*/
dayPartTargeting?: Schema$DayPartTargeting;
/**
* Default click-through event tag properties for this ad.
*/
defaultClickThroughEventTagProperties?: Schema$DefaultClickThroughEventTagProperties;
/**
* Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.
*/
deliverySchedule?: Schema$DeliverySchedule;
/**
* Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.
*/
dynamicClickTracker?: boolean | null;
/**
* Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
*/
endTime?: string | null;
/**
* Event tag overrides for this ad.
*/
eventTagOverrides?: Schema$EventTagOverride[];
/**
* Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
*/
geoTargeting?: Schema$GeoTargeting;
/**
* ID of this ad. This is a read-only, auto-generated field.
*/
id?: string | null;
/**
* Dimension value for the ID of this ad. This is a read-only, auto-generated field.
*/
idDimensionValue?: Schema$DimensionValue;
/**
* Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
*/
keyValueTargetingExpression?: Schema$KeyValueTargetingExpression;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
*/
kind?: string | null;
/**
* Language targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
*/
languageTargeting?: Schema$LanguageTargeting;
/**
* Information about the most recent modification of this ad. This is a read-only field.
*/
lastModifiedInfo?: Schema$LastModifiedInfo;
/**
* Name of this ad. This is a required field and must be less than 256 characters long.
*/
name?: string | null;
/**
* Placement assignments for this ad.
*/
placementAssignments?: Schema$PlacementAssignment[];
/**
* Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
*/
remarketingListExpression?: Schema$ListTargetingExpression;
/**
* Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
*/
size?: Schema$Size;
/**
* Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
*/
sslCompliant?: boolean | null;
/**
* Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
*/
sslRequired?: boolean | null;
/**
* Date and time that this ad should start serving. If creating an ad, this field must be a time in the future. This is a required field on insertion.
*/
startTime?: string | null;
/**
* Subaccount ID of this ad. This is a read-only field that can be left blank.
*/
subaccountId?: string | null;
/**
* Targeting template ID, used to apply preconfigured targeting information to this ad. This cannot be set while any of dayPartTargeting, geoTargeting, keyValueTargetingExpression, languageTargeting, remarketingListExpression, or technologyTargeting are set. Applicable when type is AD_SERVING_STANDARD_AD.
*/
targetingTemplateId?: string | null;
/**
* Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
*/
technologyTargeting?: Schema$TechnologyTargeting;
/**
* Type of ad. This is a required field on insertion. Note that default ads (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
*/
type?: string | null;
}
/**
* Campaign ad blocking settings.
*/
export interface Schema$AdBlockingConfiguration {
/**
* Click-through URL used by brand-neutral ads. This is a required field when overrideClickThroughUrl is set to true.
*/
clickThroughUrl?: string | null;
/**
* ID of a creative bundle to use for this campaign. If set, brand-neutral ads will select creatives from this bundle. Otherwise, a default transparent pixel will be used.
*/
creativeBundleId?: string | null;
/**
* Whether this campaign has enabled ad blocking. When true, ad blocking is enabled for placements in the campaign, but this may be overridden by site and placement settings. When false, ad blocking is disabled for all placements under the campaign, regardless of site and placement settings.
*/
enabled?: boolean | null;
/**
* Whether the brand-neutral ad's click-through URL comes from the campaign's creative bundle or the override URL. Must be set to true if ad blocking is enabled and no creative bundle is configured.
*/
overrideClickThroughUrl?: boolean | null;
}
/**
* Ad List Response
*/
export interface Schema$AdsListResponse {
/**
* Ad collection.
*/
ads?: Schema$Ad[];
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#adsListResponse".
*/
kind?: string | null;
/**
* Pagination token to be used for the next list operation.
*/
nextPageToken?: string | null;
}
/**
* Ad Slot
*/
export interface Schema$AdSlot {
/**
* Comment for this ad slot.
*/
comment?: string | null;
/**
* Ad slot compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop, mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard.
*/
compatibility?: string | null;
/**
* Height of this ad slot.
*/
height?: string | null;
/**
* ID of the placement from an external platform that is linked to this ad slot.
*/
linkedPlacementId?: string | null;
/**
* Name of this ad slot.
*/
name?: string | null;
/**
* Payment source type of this ad slot.
*/
paymentSourceType?: string | null;
/**
* Primary ad slot of a roadblock inventory item.
*/
primary?: boolean | null;
/**
* Width of this ad slot.
*/
width?: string | null;
}
/**
* Contains properties of a Campaign Manager advertiser.
*/
export interface Schema$Advertiser {
/**
* Account ID of this advertiser.This is a read-only field that can be left blank.
*/
accountId?: string | null;
/**
* ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.
*/
advertiserGroupId?: string | null;
/**
* Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
*/
clickThroughUrlSuffix?: string | null;
/**
* ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
*/
defaultClickThroughEventTagId?: string | null;
/**
* Default email address used in sender field for tag emails.
*/
defaultEmail?: string | null;
/**
* Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as: - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups. - This advertiser's original floodlight configuration is not already shared with another advertiser.
*/
floodlightConfigurationId?: string | null;
/**
* Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
*/
floodlightConfigurationIdDimensionValue?: Schema$DimensionValue;
/**
* ID of this advertiser. This is a read-only, auto-generated field.
*/
id?: string | null;
/**
* Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
*/
idDimensionValue?: Schema$DimensionValue;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
*/
kind?: string | null;
/**
* Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
*/
name?: string | null;
/**
* Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.
*/
originalFloodlightConfigurationId?: string | null;
/**
* Status of this advertiser.
*/
status?: string | null;
/**
* Subaccount ID of this advertiser.This is a read-only field that can be left blank.
*/
subaccountId?: string | null;
/**
* Suspension status of this advertiser.
*/
suspended?: boolean | null;
}
/**
* Groups advertisers together so that reports can be generated for the entire group at once.
*/
export interface Schema$AdvertiserGroup {
/**
* Account ID of this advertiser group. This is a read-only field that can be left blank.
*/
accountId?: string | null;
/**
* ID of this advertiser group. This is a read-only, auto-generated field.
*/
id?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
*/
kind?: string | null;
/**
* Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
*/
name?: string | null;
}
/**
* Advertiser Group List Response
*/
export interface Schema$AdvertiserGroupsListResponse {
/**
* Advertiser group collection.
*/
advertiserGroups?: Schema$AdvertiserGroup[];
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroupsListResponse".
*/
kind?: string | null;
/**
* Pagination token to be used for the next list operation.
*/
nextPageToken?: string | null;
}
/**
* Landing Page List Response
*/
export interface Schema$AdvertiserLandingPagesListResponse {
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserLandingPagesListResponse".
*/
kind?: string | null;
/**
* Landing page collection
*/
landingPages?: Schema$LandingPage[];
/**
* Pagination token to be used for the next list operation.
*/
nextPageToken?: string | null;
}
/**
* Advertiser List Response
*/
export interface Schema$AdvertisersListResponse {
/**
* Advertiser collection.
*/
advertisers?: Schema$Advertiser[];
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertisersListResponse".
*/
kind?: string | null;
/**
* Pagination token to be used for the next list operation.
*/
nextPageToken?: string | null;
}
/**
* Audience Segment.
*/
export interface Schema$AudienceSegment {
/**
* Weight allocated to this segment. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group. Acceptable values are 1 to 1000, inclusive.
*/
allocation?: number | null;
/**
* ID of this audience segment. This is a read-only, auto-generated field.
*/
id?: string | null;
/**
* Name of this audience segment. This is a required field and must be less than 65 characters long.
*/
name?: string | null;
}
/**
* Audience Segment Group.
*/
export interface Schema$AudienceSegmentGroup {
/**
* Audience segments assigned to this group. The number of segments must be between 2 and 100.
*/
audienceSegments?: Schema$AudienceSegment[];
/**
* ID of this audience segment group. This is a read-only, auto-generated field.
*/
id?: string | null;
/**
* Name of this audience segment group. This is a required field and must be less than 65 characters long.
*/
name?: string | null;
}
/**
* Contains information about a browser that can be targeted by ads.
*/
export interface Schema$Browser {
/**
* ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
*/
browserVersionId?: string | null;
/**
* DART ID of this browser. This is the ID used when generating reports.
*/
dartId?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
*/
kind?: string | null;
/**
* Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
*/
majorVersion?: string | null;
/**
* Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
*/
minorVersion?: string | null;
/**
* Name of this browser.
*/
name?: string | null;
}
/**
* Browser List Response
*/
export interface Schema$BrowsersListResponse {
/**
* Browser collection.
*/
browsers?: Schema$Browser[];
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#browsersListResponse".
*/
kind?: string | null;
}
/**
* Contains properties of a Campaign Manager campaign.
*/
export interface Schema$Campaign {
/**
* Account ID of this campaign. This is a read-only field that can be left blank.
*/
accountId?: string | null;
/**
* Ad blocking settings for this campaign.
*/
adBlockingConfiguration?: Schema$AdBlockingConfiguration;
/**
* Additional creative optimization configurations for the campaign.
*/
additionalCreativeOptimizationConfigurations?: Schema$CreativeOptimizationConfiguration[];
/**
* Advertiser group ID of the associated advertiser.
*/
advertiserGroupId?: string | null;
/**
* Advertiser ID of this campaign. This is a required field.
*/
advertiserId?: string | null;
/**
* Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
*/
advertiserIdDimensionValue?: Schema$DimensionValue;
/**
* Whether this campaign has been archived.
*/
archived?: boolean | null;
/**
* Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
*/
audienceSegmentGroups?: Schema$AudienceSegmentGroup[];
/**
* Billing invoice code included in the Campaign Manager client billing invoices associated with the campaign.
*/
billingInvoiceCode?: string | null;
/**
* Click-through URL suffix override properties for this campaign.
*/
clickThroughUrlSuffixProperties?: Schema$ClickThroughUrlSuffixProperties;
/**
* Arbitrary comments about this campaign. Must be less than 256 characters long.
*/
comment?: string | null;
/**
* Information about the creation of this campaign. This is a read-only field.
*/
createInfo?: Schema$LastModifiedInfo;
/**
* List of creative group IDs that are assigned to the campaign.
*/
creativeGroupIds?: string[] | null;
/**
* Creative optimization configuration for the campaign.
*/
creativeOptimizationConfiguration?: Schema$CreativeOptimizationConfiguration;
/**
* Click-through event tag ID override properties for this campaign.
*/
defaultClickThroughEventTagProperties?: Schema$DefaultClickThroughEventTagProperties;
/**
* The default landing page ID for this campaign.
*/
defaultLandingPageId?: string | null;
/**
* Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field.
*/
endDate?: string | null;
/**
* Overrides that can be used to activate or deactivate advertiser event tags.
*/
eventTagOverrides?: Schema$EventTagOverride[];
/**
* External ID for this campaign.
*/
externalId?: string | null;
/**
* ID of this campaign. This is a read-only auto-generated field.
*/
id?: string | null;
/**
* Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
*/
idDimensionValue?: Schema$DimensionValue;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
*/
kind?: string | null;
/**
* Information about the most recent modification of this campaign. This is a read-only field.
*/
lastModifiedInfo?: Schema$LastModifiedInfo;
/**
* Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
*/
name?: string | null;
/**
* Whether Nielsen reports are enabled for this campaign.
*/
nielsenOcrEnabled?: boolean | null;
/**
* Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field.
*/
startDate?: string | null;
/**
* Subaccount ID of this campaign. This is a read-only field that can be left blank.
*/
subaccountId?: string | null;
/**
* Campaign trafficker contact emails.
*/
traffickerEmails?: string[] | null;
}
/**
* Identifies a creative which has been associated with a given campaign.
*/
export interface Schema$CampaignCreativeAssociation {
/**
* ID of the creative associated with the campaign. This is a required field.
*/
creativeId?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociation".
*/
kind?: string | null;
}
/**
* Campaign Creative Association List Response
*/
export interface Schema$CampaignCreativeAssociationsListResponse {
/**
* Campaign creative association collection
*/
campaignCreativeAssociations?: Schema$CampaignCreativeAssociation[];
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociationsListResponse".
*/
kind?: string | null;
/**
* Pagination token to be used for the next list operation.
*/
nextPageToken?: string | null;
}
/**
* Campaign List Response
*/
export interface Schema$CampaignsListResponse {
/**
* Campaign collection.
*/
campaigns?: Schema$Campaign[];
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignsListResponse".
*/
kind?: string | null;
/**
* Pagination token to be used for the next list operation.
*/
nextPageToken?: string | null;
}
/**
* Describes a change that a user has made to a resource.
*/
export interface Schema$ChangeLog {
/**
* Account ID of the modified object.
*/
accountId?: string | null;
/**
* Action which caused the change.
*/
action?: string | null;
/**
* Time when the object was modified.
*/
changeTime?: string | null;
/**
* Field name of the object which changed.
*/
fieldName?: string | null;
/**
* ID of this change log.
*/
id?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#changeLog".
*/
kind?: string | null;
/**
* New value of the object field.
*/
newValue?: string | null;
/**
* ID of the object of this change log. The object could be a campaign, placement, ad, or other type.
*/
objectId?: string | null;
/**
* Object type of the change log.
*/
objectType?: string | null;
/**
* Old value of the object field.
*/
oldValue?: string | null;
/**
* Subaccount ID of the modified object.
*/
subaccountId?: string | null;
/**
* Transaction ID of this change log. When a single API call results in many changes, each change will have a separate ID in the change log but will share the same transactionId.
*/
transactionId?: string | null;
/**
* ID of the user who modified the object.
*/
userProfileId?: string | null;
/**
* User profile name of the user who modified the object.
*/
userProfileName?: string | null;
}
/**
* Change Log List Response
*/
export interface Schema$ChangeLogsListResponse {
/**
* Change log collection.
*/
changeLogs?: Schema$ChangeLog[];
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#changeLogsListResponse".
*/
kind?: string | null;
/**
* Pagination token to be used for the next list operation.
*/
nextPageToken?: string | null;
}
/**
* City List Response
*/
export interface Schema$CitiesListResponse {
/**
* City collection.
*/
cities?: Schema$City[];
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#citiesListResponse".
*/
kind?: string | null;
}
/**
* Contains information about a city that can be targeted by ads.
*/
export interface Schema$City {
/**
* Country code of the country to which this city belongs.
*/
countryCode?: string | null;
/**
* DART ID of the country to which this city belongs.
*/
countryDartId?: string | null;
/**
* DART ID of this city. This is the ID used for targeting and generating reports.
*/
dartId?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
*/
kind?: string | null;
/**
* Metro region code of the metro region (DMA) to which this city belongs.
*/
metroCode?: string | null;
/**
* ID of the metro region (DMA) to which this city belongs.
*/
metroDmaId?: string | null;
/**
* Name of this city.
*/
name?: string | null;
/**
* Region code of the region to which this city belongs.
*/
regionCode?: string | null;
/**
* DART ID of the region to which this city belongs.
*/
regionDartId?: string | null;
}
/**
* Creative Click Tag.
*/
export interface Schema$ClickTag {
/**
* Parameter value for the specified click tag. This field contains a click-through url.
*/
clickThroughUrl?: Schema$CreativeClickThroughUrl;
/**
* Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
*/
eventName?: string | null;
/**
* Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
*/
name?: string | null;
}
/**
* Click-through URL
*/
export interface Schema$ClickThroughUrl {
/**
* Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
*/
computedClickThroughUrl?: string | null;
/**
* Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
*/
customClickThroughUrl?: string | null;
/**
* Whether the campaign default landing page is used.
*/
defaultLandingPage?: boolean | null;
/**
* ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
*/
landingPageId?: string | null;
}
/**
* Click Through URL Suffix settings.
*/
export interface Schema$ClickThroughUrlSuffixProperties {
/**
* Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
*/
clickThroughUrlSuffix?: string | null;
/**
* Whether this entity should override the inherited click-through URL suffix with its own defined value.
*/
overrideInheritedSuffix?: boolean | null;
}
/**
* Companion Click-through override.
*/
export interface Schema$CompanionClickThroughOverride {
/**
* Click-through URL of this companion click-through override.
*/
clickThroughUrl?: Schema$ClickThroughUrl;
/**
* ID of the creative for this companion click-through override.
*/
creativeId?: string | null;
}
/**
* Companion Settings
*/
export interface Schema$CompanionSetting {
/**
* Whether companions are disabled for this placement.
*/
companionsDisabled?: boolean | null;
/**
* Whitelist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes.
*/
enabledSizes?: Schema$Size[];
/**
* Whether to serve only static images as companions.
*/
imageOnly?: boolean | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#companionSetting".
*/
kind?: string | null;
}
/**
* Represents a response to the queryCompatibleFields method.
*/
export interface Schema$CompatibleFields {
/**
* Contains items that are compatible to be selected for a report of type "CROSS_DIMENSION_REACH".
*/
crossDimensionReachReportCompatibleFields?: Schema$CrossDimensionReachReportCompatibleFields;
/**
* Contains items that are compatible to be selected for a report of type "FLOODLIGHT".
*/
floodlightReportCompatibleFields?: Schema$FloodlightReportCompatibleFields;
/**
* The kind of resource this is, in this case dfareporting#compatibleFields.
*/
kind?: string | null;
/**
* Contains items that are compatible to be selected for a report of type "PATH_TO_CONVERSION".
*/
pathToConversionReportCompatibleFields?: Schema$PathToConversionReportCompatibleFields;
/**
* Contains items that are compatible to be selected for a report of type "REACH".
*/
reachReportCompatibleFields?: Schema$ReachReportCompatibleFields;
/**
* Contains items that are compatible to be selected for a report of type "STANDARD".
*/
reportCompatibleFields?: Schema$ReportCompatibleFields;
}
/**
* Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
*/
export interface Schema$ConnectionType {
/**
* ID of this connection type.
*/
id?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
*/
kind?: string | null;
/**
* Name of this connection type.
*/
name?: string | null;
}
/**
* Connection Type List Response
*/
export interface Schema$ConnectionTypesListResponse {
/**
* Collection of connection types such as broadband and mobile.
*/
connectionTypes?: Schema$ConnectionType[];
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionTypesListResponse".
*/
kind?: string | null;
}
/**
* Content Category List Response
*/
export interface Schema$ContentCategoriesListResponse {
/**
* Content category collection.
*/
contentCategories?: Schema$ContentCategory[];
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategoriesListResponse".
*/
kind?: string | null;
/**
* Pagination token to be used for the next list operation.
*/
nextPageToken?: string | null;
}
/**
* Organizes placements according to the contents of their associated webpages.
*/
export interface Schema$ContentCategory {
/**
* Account ID of this content category. This is a read-only field that can be left blank.
*/
accountId?: string | null;
/**
* ID of this content category. This is a read-only, auto-generated field.
*/
id?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
*/
kind?: string | null;
/**
* Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
*/
name?: string | null;
}
/**
* A Conversion represents when a user successfully performs a desired action after seeing an ad.
*/
export interface Schema$Conversion {
/**
* Whether this particular request may come from a user under the age of 13, under COPPA compliance.
*/
childDirectedTreatment?: boolean | null;
/**
* Custom floodlight variables.
*/
customVariables?: Schema$CustomFloodlightVariable[];
/**
* The alphanumeric encrypted user ID. When set, encryptionInfo should also be specified. This field is mutually exclusive with encryptedUserIdCandidates[], matchId, mobileDeviceId and gclid. This or encryptedUserIdCandidates[] or matchId or mobileDeviceId or gclid is a required field.
*/
encryptedUserId?: string | null;
/**
* A list of the alphanumeric encrypted user IDs. Any user ID with exposure prior to the conversion timestamp will be used in the inserted conversion. If no such user ID is found then the conversion will be rejected with NO_COOKIE_MATCH_FOUND error. When set, encryptionInfo should also be specified. This field may only be used when calling batchinsert; it is not supported by batchupdate. This field is mutually exclusive with encryptedUserId, matchId, mobileDeviceId and gclid. This or encryptedUserId or matchId or mobileDeviceId or gclid is a required field.
*/
encryptedUserIdCandidates?: string[] | null;
/**
* Floodlight Activity ID of this conversion. This is a required field.
*/
floodlightActivityId?: string | null;
/**
* Floodlight Configuration ID of this conversion. This is a required field.
*/
floodlightConfigurationId?: string | null;
/**
* The Google click ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId and mobileDeviceId. This or encryptedUserId or encryptedUserIdCandidates[] or matchId or mobileDeviceId is a required field.
*/
gclid?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversion".
*/
kind?: string | null;
/**
* Whether Limit Ad Tracking is enabled. When set to true, the conversion will be used for reporting but not targeting. This will prevent remarketing.
*/
limitAdTracking?: boolean | null;
/**
* The match ID field. A match ID is your own first-party identifier that has been synced with Google using the match ID feature in Floodlight. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[],mobileDeviceId and gclid. This or encryptedUserId or encryptedUserIdCandidates[] or mobileDeviceId or gclid is a required field.
*/
matchId?: string | null;
/**
* The mobile device ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId and gclid. This or encryptedUserId or encryptedUserIdCandidates[] or matchId or gclid is a required field.
*/
mobileDeviceId?: string | null;
/**
* Whether the conversion was for a non personalized ad.
*/
nonPersonalizedAd?: boolean | null;
/**
* The ordinal of the conversion. Use this field to control how conversions of the same user and day are de-duplicated. This is a required field.
*/
ordinal?: string | null;
/**
* The quantity of the conversion.
*/
quantity?: string | null;
/**
* The timestamp of conversion, in Unix epoch micros. This is a required field.
*/
timestampMicros?: string | null;
/**
* Whether this particular request may come from a user under the age of 16 (may differ by country), under compliance with the European Union's General Data Protection Regulation (GDPR).
*/
treatmentForUnderage?: boolean | null;
/**
* The value of the conversion.
*/
value?: number | null;
}
/**
* The error code and description for a conversion that failed to insert or update.
*/
export interface Schema$ConversionError {
/**
* The error code.
*/
code?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionError".
*/
kind?: string | null;
/**
* A description of the error.
*/
message?: string | null;
}
/**
* Insert Conversions Request.
*/
export interface Schema$ConversionsBatchInsertRequest {
/**
* The set of conversions to insert.
*/
conversions?: Schema$Conversion[];
/**
* Describes how encryptedUserId or encryptedUserIdCandidates[] is encrypted. This is a required field if encryptedUserId or encryptedUserIdCandidates[] is used.
*/
encryptionInfo?: Schema$EncryptionInfo;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchInsertRequest".
*/
kind?: string | null;
}
/**
* Insert Conversions Response.
*/
export interface Schema$ConversionsBatchInsertResponse {
/**
* Indicates that some or all conversions failed to insert.
*/
hasFailures?: boolean | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchInsertResponse".
*/
kind?: string | null;
/**
* The insert status of each conversion. Statuses are returned in the same order that conversions are inserted.
*/
status?: Schema$ConversionStatus[];
}
/**
* Update Conversions Request.
*/
export interface Schema$ConversionsBatchUpdateRequest {
/**
* The set of conversions to update.
*/
conversions?: Schema$Conversion[];
/**
* Describes how encryptedUserId is encrypted. This is a required field if encryptedUserId is used.
*/
encryptionInfo?: Schema$EncryptionInfo;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchUpdateRequest".
*/
kind?: string | null;
}
/**
* Update Conversions Response.
*/
export interface Schema$ConversionsBatchUpdateResponse {
/**
* Indicates that some or all conversions failed to update.
*/
hasFailures?: boolean | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchUpdateResponse".
*/
kind?: string | null;
/**
* The update status of each conversion. Statuses are returned in the same order that conversions are updated.
*/
status?: Schema$ConversionStatus[];
}
/**
* The original conversion that was inserted or updated and whether there were any errors.
*/
export interface Schema$ConversionStatus {
/**
* The original conversion that was inserted or updated.
*/
conversion?: Schema$Conversion;
/**
* A list of errors related to this conversion.
*/
errors?: Schema$ConversionError[];
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionStatus".
*/
kind?: string | null;
}
/**
* Country List Response
*/
export interface Schema$CountriesListResponse {
/**
* Country collection.
*/
countries?: Schema$Country[];
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#countriesListResponse".
*/
kind?: string | null;
}
/**
* Contains information about a country that can be targeted by ads.
*/
export interface Schema$Country {
/**
* Country code.
*/
countryCode?: string | null;
/**
* DART ID of this country. This is the ID used for targeting and generating reports.
*/
dartId?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
*/
kind?: string | null;
/**
* Name of this country.
*/
name?: string | null;
/**
* Whether ad serving supports secure servers in this country.
*/
sslEnabled?: boolean | null;
}
/**
* Contains properties of a Creative.
*/
export interface Schema$Creative {
/**
* Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
*/
accountId?: string | null;
/**
* Whether the creative is active. Applicable to all creative types.
*/
active?: boolean | null;
/**
* Additional sizes associated with a responsive creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. Applicable to DISPLAY creatives when the primary asset type is HTML_IMAGE.
*/
additionalSizes?: Schema$Size[];
/**
* Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
*/
adParameters?: string | null;
/**
* Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
*/
adTagKeys?: string[] | null;
/**
* Advertiser ID of this creative. This is a required field. Applicable to all creative types.
*/
advertiserId?: string | null;
/**
* Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
*/
allowScriptAccess?: boolean | null;
/**
* Whether the creative is archived. Applicable to all creative types.
*/
archived?: boolean | null;
/**
* Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
*/
artworkType?: string | null;
/**
* Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
*/
authoringSource?: string | null;
/**
* Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
*/
authoringTool?: string | null;
/**
* Whether images are automatically advanced for image gallery creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY.
*/
autoAdvanceImages?: boolean | null;
/**
* The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.
*/
backgroundColor?: string | null;
/**
* Click-through URL for backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
*/
backupImageClickThroughUrl?: Schema$CreativeClickThroughUrl;
/**
* List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by Campaign Manager for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
*/
backupImageFeatures?: string[] | null;
/**
* Reporting label used for HTML5 banner backup image. Applicable to the following creative types: DISPLAY when the primary asset type is not HTML_IMAGE.
*/
backupImageReportingLabel?: string | null;
/**
* Target window for backup image. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
*/
backupImageTargetWindow?: Schema$TargetWindow;
/**
* Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For DISPLAY_IMAGE_GALLERY creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
*/
clickTags?: Schema$ClickTag[];
/**
* Industry standard ID assigned to creative for reach and frequency. Applicable to INSTREAM_VIDEO_REDIRECT creatives.
*/
commercialId?: string | null;
/**
* List of companion creatives assigned to an in-Stream video creative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all VPAID, all INSTREAM_AUDIO and all INSTREAM_VIDEO with dynamicAssetSelection set to false.
*/
companionCreatives?: string[] | null;
/**
* Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. IN_STREAM_AUDIO refers to rendering in in-stream audio ads developed with the VAST standard. Applicable to all creative types. Acceptable values are: - "APP" - "APP_INTERSTITIAL" - "IN_STREAM_VIDEO" - "IN_STREAM_AUDIO" - "DISPLAY" - "DISPLAY_INTERSTITIAL"
*/
compatibility?: string[] | null;
/**
* Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
*/
convertFlashToHtml5?: boolean | null;
/**
* List of counter events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID.
*/
counterCustomEvents?: Schema$CreativeCustomEvent[];
/**
* Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
*/
creativeAssets?: Schema$CreativeAsset[];
/**
* Required if dynamicAssetSelection is true.
*/
creativeAssetSelection?: Schema$CreativeAssetSelection;
/**
* Creative field assignments for this creative. Applicable to all creative types.
*/
creativeFieldAssignments?: Schema$CreativeFieldAssignment[];
/**
* Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
*/
customKeyValues?: string[] | null;
/**
* Set this to true to enable the use of rules to target individual assets in this creative. When set to true creativeAssetSelection must be set. This also controls asset-level companions. When this is true, companion creatives should be assigned to creative assets. Learn more. Applicable to INSTREAM_VIDEO creatives.
*/
dynamicAssetSelection?: boolean | null;
/**
* List of exit events configured for the creative. For DISPLAY and DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags, For DISPLAY, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
*/
exitCustomEvents?: Schema$CreativeCustomEvent[];
/**
* OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE.
*/
fsCommand?: Schema$FsCommand;
/**
* HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is true. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
*/
htmlCode?: string | null;
/**
* Whether HTML code is generated by Campaign Manager or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
*/
htmlCodeLocked?: boolean | null;
/**
* ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
*/
id?: string | null;
/**
* Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
*/
idDimensionValue?: Schema$DimensionValue;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
*/
kind?: string | null;
/**
* Creative last modification information. This is a read-only field. Applicable to all creative types.
*/
lastModifiedInfo?: Schema$LastModifiedInfo;
/**
* Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
*/
latestTraffickedCreativeId?: string | null;
/**
* Description of the audio or video ad. Applicable to the following creative types: all INSTREAM_VIDEO, INSTREAM_AUDIO, and all VPAID.
*/
mediaDescription?: string | null;
/**
* Creative audio or video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, INSTREAM_AUDIO, all RICH_MEDIA, and all VPAID.
*/
mediaDuration?: number | null;
/**
* Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
*/
name?: string | null;
/**
* Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
*/
overrideCss?: string | null;
/**
* Amount of time to play the video before counting a view. Applicable to the following creative types: all INSTREAM_VIDEO.
*/
progressOffset?: Schema$VideoOffset;
/**
* URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: DISPLAY_REDIRECT, INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO_REDIRECT
*/
redirectUrl?: string | null;
/**
* ID of current rendering version. This is a read-only field. Applicable to all creative types.
*/
renderingId?: string | null;
/**
* Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
*/
renderingIdDimensionValue?: Schema$DimensionValue;
/**
* The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
*/
requiredFlashPluginVersion?: string | null;
/**
* The internal Flash version for this creative as calculated by Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
*/
requiredFlashVersion?: number | null;
/**
* Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE, FLASH_INPAGE creatives, and for DISPLAY creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: DISPLAY, DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
*/
size?: Schema$Size;
/**
* Amount of time to play the video before the skip button appears. Applicable to the following creative types: all INSTREAM_VIDEO.
*/
skipOffset?: Schema$VideoOffset;
/**
* Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
*/
skippable?: boolean | null;
/**
* Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
*/
sslCompliant?: boolean | null;
/**
* Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.
*/
sslOverride?: boolean | null;
/**
* Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
*/
studioAdvertiserId?: string | null;
/**
* Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
*/
studioCreativeId?: string | null;
/**
* Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
*/
studioTraffickedCreativeId?: string | null;
/**
* Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
*/
subaccountId?: string | null;
/**
* Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.
*/
thirdPartyBackupImageImpressionsUrl?: string | null;
/**
* Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.
*/
thirdPartyRichMediaImpressionsUrl?: string | null;
/**
* Third-party URLs for tracking in-stream creative events. Applicable to the following creative types: all INSTREAM_VIDEO, all INSTREAM_AUDIO, and all VPAID.
*/
thirdPartyUrls?: Schema$ThirdPartyTrackingUrl[];
/**
* List of timer events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset is not HTML_IMAGE.
*/
timerCustomEvents?: Schema$CreativeCustomEvent[];
/**
* Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
*/
totalFileSize?: string | null;
/**
* Type of this creative. This is a required field. Applicable to all creative types. Note: FLASH_INPAGE, HTML5_BANNER, and IMAGE are only used for existing creatives. New creatives should use DISPLAY as a replacement for these types.
*/
type?: string | null;
/**
* A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types: INSTREAM_AUDIO and INSTREAM_VIDEO and VPAID.
*/
universalAdId?: Schema$UniversalAdId;
/**
* The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
*/
version?: number | null;
}
/**
* Creative Asset.
*/
export interface Schema$CreativeAsset {
/**
* Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
*/
actionScript3?: boolean | null;
/**
* Whether the video or audio asset is active. This is a read-only field for VPAID_NON_LINEAR_VIDEO assets. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
*/
active?: boolean | null;
/**
* Additional sizes associated with this creative asset. HTML5 asset generated by compatible software such as GWD will be able to support more sizes this creative asset can render.
*/
additionalSizes?: Schema$Size[];
/**
* Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL.
*/
alignment?: string | null;
/**
* Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
*/
artworkType?: string | null;
/**
* Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
*/
assetIdentifier?: Schema$CreativeAssetId;
/**
* Audio stream bit rate in kbps. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
*/
audioBitRate?: number | null;
/**
* Audio sample bit rate in hertz. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
*/
audioSampleRate?: number | null;
/**
* Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
*/
backupImageExit?: Schema$CreativeCustomEvent;
/**
* Detected bit-rate for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
*/
bitRate?: number | null;
/**
* Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
*/
childAssetType?: string | null;
/**
* Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
*/
collapsedSize?: Schema$Size;
/**
* List of companion creatives assigned to an in-stream video creative asset. Acceptable values include IDs of existing flash and image creatives. Applicable to INSTREAM_VIDEO creative type with dynamicAssetSelection set to true.
*/
companionCreativeIds?: string[] | null;
/**
* Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA. Value must be greater than or equal to 0.
*/
customStartTimeValue?: number | null;
/**
* List of feature dependencies for the creative asset that are detected by Campaign Manager. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
*/
detectedFeatures?: string[] | null;
/**
* Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
*/
displayType?: string | null;
/**
* Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID_LINEAR_VIDEO. Value must be greater than or equal to 1.
*/
duration?: number | null;
/**
* Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
*/
durationType?: string | null;
/**
* Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
*/
expandedDimension?: Schema$Size;
/**
* File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
*/
fileSize?: string | null;
/**
* Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
*/
flashVersion?: number | null;
/**
* Video frame rate for video asset in frames per second. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
*/
frameRate?: number | null;
/**
* Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
*/
hideFlashObjects?: boolean | null;
/**
* Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
*/
hideSelectionBoxes?: boolean | null;
/**
* Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
*/
horizontallyLocked?: boolean | null;
/**
* Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
*/
id?: string | null;
/**
* Dimension value for the ID of the asset. This is a read-only, auto-generated field.
*/
idDimensionValue?: Schema$DimensionValue;
/**
* Detected duration for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
*/
mediaDuration?: number | null;
/**
* Detected MIME type for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
*/
mimeType?: string | null;
/**
* Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
*/
offset?: Schema$OffsetPosition;
/**
* Orientation of video asset. This is a read-only, auto-generated field.
*/
orientation?: string | null;
/**
* Whether the backup asset is original or changed by the user in Campaign Manager. Applicable to the following creative types: all RICH_MEDIA.
*/
originalBackup?: boolean | null;
/**
* Whether this asset is used as a polite load asset.
*/
politeLoad?: boolean | null;
/**
* Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
*/
position?: Schema$OffsetPosition;
/**
* Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
*/
positionLeftUnit?: string | null;
/**
* Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
*/
positionTopUnit?: string | null;
/**
* Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
*/
progressiveServingUrl?: string | null;
/**
* Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
*/
pushdown?: boolean | null;
/**
* Pushdown duration in seconds for an asset. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height. Acceptable values are 0 to 9.99, inclusive.
*/
pushdownDuration?: number | null;
/**
* Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field. PRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, IMAGE, DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives. BACKUP_IMAGE applies to FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives. OTHER refers to assets from sources other than Campaign Manager, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives. PARENT_VIDEO refers to videos uploaded by the user in Campaign Manager and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. TRANSCODED_VIDEO refers to videos transcoded by Campaign Manager from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. ALTERNATE_VIDEO refers to the Campaign Manager representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within Campaign Manager. For VPAID_LINEAR_VIDEO creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR_VIDEO creative. PARENT_AUDIO refers to audios uploaded by the user in Campaign Manager and is applicable to INSTREAM_AUDIO creatives. TRANSCODED_AUDIO refers to audios transcoded by Campaign Manager from PARENT_AUDIO assets and is applicable to INSTREAM_AUDIO creatives.
*/
role?: string | null;
/**
* Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE, creatives if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
*/
size?: Schema$Size;
/**
* Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
*/
sslCompliant?: boolean | null;
/**
* Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
*/
startTimeType?: string | null;
/**
* Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
*/
streamingServingUrl?: string | null;
/**
* Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
*/
transparency?: boolean | null;
/**
* Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
*/
verticallyLocked?: boolean | null;
/**
* Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_DISPLAY_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_DISPLAY_BANNER, and RICH_MEDIA_INPAGE_FLOATING.
*/
windowMode?: string | null;
/**
* zIndex value of an asset. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY. Acceptable values are -999999999 to 999999999, inclusive.
*/
zIndex?: number | null;
/**
* File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
*/
zipFilename?: string | null;
/**
* Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
*/
zipFilesize?: string | null;
}
/**
* Creative Asset ID.
*/
export interface Schema$CreativeAssetId {
/**
* Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
*/
name?: string | null;
/**
* Type of asset to upload. This is a required field. FLASH and IMAGE are no longer supported for new uploads. All image assets should use HTML_IMAGE.
*/
type?: string | null;
}
/**
* CreativeAssets contains properties of a creative asset file which will be uploaded or has already been uploaded. Refer to the creative sample code for how to upload assets and insert a creative.
*/
export interface Schema$CreativeAssetMetadata {
/**
* ID of the creative asset. This is a required field.
*/
assetIdentifier?: Schema$CreativeAssetId;
/**
* List of detected click tags for assets. This is a read-only auto-generated field.
*/
clickTags?: Schema$ClickTag[];
/**
* List of feature dependencies for the creative asset that are detected by Campaign Manager. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field.
*/
detectedFeatures?: string[] | null;
/**
* Numeric ID of the asset. This is a read-only, auto-generated field.
*/
id?: string | null;
/**
* Dimension value for the numeric ID of the asset. This is a read-only, auto-generated field.
*/
idDimensionValue?: Schema$DimensionValue;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeAssetMetadata".
*/
kind?: string | null;
/**
* Rules validated during code generation that generated a warning. This is a read-only, auto-generated field. Possible values are: - "ADMOB_REFERENCED" - "ASSET_FORMAT_UNSUPPORTED_DCM" - "ASSET_INVALID" - "CLICK_TAG_HARD_CODED" - "CLICK_TAG_INVALID" - "CLICK_TAG_IN_GWD" - "CLICK_TAG_MISSING" - "CLICK_TAG_MORE_THAN_ONE" - "CLICK_TAG_NON_TOP_LEVEL" - "COMPONENT_UNSUPPORTED_DCM" - "ENABLER_UNSUPPORTED_METHOD_DCM" - "EXTERNAL_FILE_REFERENCED" - "FILE_DETAIL_EMPTY" - "FILE_TYPE_INVALID" - "GWD_PROPERTIES_INVALID" - "HTML5_FEATURE_UNSUPPORTED" - "LINKED_FILE_NOT_FOUND" - "MAX_FLASH_VERSION_11" - "MRAID_REFERENCED" - "NOT_SSL_COMPLIANT" - "ORPHANED_ASSET" - "PRIMARY_HTML_MISSING" - "SVG_INVALID" - "ZIP_INVALID"
*/
warnedValidationRules?: string[] | null;
}
/**
* Encapsulates the list of rules for asset selection and a default asset in case none of the rules match. Applicable to INSTREAM_VIDEO creatives.
*/
export interface Schema$CreativeAssetSelection {
/**
* A creativeAssets[].id. This should refer to one of the parent assets in this creative, and will be served if none of the rules match. This is a required field.
*/
defaultAssetId?: string | null;
/**
* Rules determine which asset will be served to a viewer. Rules will be evaluated in the order in which they are stored in this list. This list must contain at least one rule. Applicable to INSTREAM_VIDEO creatives.
*/
rules?: Schema$Rule[];
}
/**
* Creative Assignment.
*/
export interface Schema$CreativeAssignment {
/**
* Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
*/
active?: boolean | null;
/**
* Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.
*/
applyEventTags?: boolean | null;
/**
* Click-through URL of the creative assignment.
*/
clickThroughUrl?: Schema$ClickThroughUrl;
/**
* Companion creative overrides for this creative assignment. Applicable to video ads.
*/
companionCreativeOverrides?: Schema$CompanionClickThroughOverride[];
/**
* Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
*/
creativeGroupAssignments?: Schema$CreativeGroupAssignment[];
/**
* ID of the creative to be assigned. This is a required field.
*/
creativeId?: string | null;
/**
* Dimension value for the ID of the creative. This is a read-only, auto-generated field.
*/
creativeIdDimensionValue?: Schema$DimensionValue;
/**
* Date and time that the assigned creative should stop serving. Must be later than the start time.
*/
endTime?: string | null;
/**
* Rich media exit overrides for this creative assignment. Applicable when the creative type is any of the following: - DISPLAY - RICH_MEDIA_INPAGE - RICH_MEDIA_INPAGE_FLOATING - RICH_MEDIA_IM_EXPAND - RICH_MEDIA_EXPANDING - RICH_MEDIA_INTERSTITIAL_FLOAT - RICH_MEDIA_MOBILE_IN_APP - RICH_MEDIA_MULTI_FLOATING - RICH_MEDIA_PEEL_DOWN - VPAID_LINEAR - VPAID_NON_LINEAR
*/
richMediaExitOverrides?: Schema$RichMediaExitOverride[];
/**
* Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL. Acceptable values are 1 to 65535, inclusive.
*/
sequence?: number | null;
/**
* Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
*/
sslCompliant?: boolean | null;
/**
* Date and time that the assigned creative should start serving.
*/
startTime?: string | null;
/**
* Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM. Value must be greater than or equal to 1.
*/
weight?: number | null;
}
/**
* Click-through URL
*/
export interface Schema$CreativeClickThroughUrl {
/**
* Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field.
*/
computedClickThroughUrl?: string | null;
/**
* Custom click-through URL. Applicable if the landingPageId field is left unset.
*/
customClickThroughUrl?: string | null;
/**
* ID of the landing page for the click-through URL.
*/
landingPageId?: string | null;
}
/**
* Creative Custom Event.
*/
export interface Schema$CreativeCustomEvent {
/**
* Unique ID of this event used by Reporting and Data Transfer. This is a read-only field.
*/
advertiserCustomEventId?: string | null;
/**
* User-entered name for the event.
*/
advertiserCustomEventName?: string | null;
/**
* Type of the event. This is a read-only field.
*/
advertiserCustomEventType?: string | null;
/**
* Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion.
*/
artworkLabel?: string | null;
/**
* Artwork type used by the creative.This is a read-only field.
*/
artworkType?: string | null;
/**
* Exit click-through URL for the event. This field is used only for exit events.
*/
exitClickThroughUrl?: Schema$CreativeClickThroughUrl;
/**
* ID of this event. This is a required field and should not be modified after insertion.
*/
id?: string | null;
/**
* Properties for rich media popup windows. This field is used only for exit events.
*/
popupWindowProperties?: Schema$PopupWindowProperties;
/**
* Target type used by the event.
*/
targetType?: string | null;
/**
* Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
*/
videoReportingId?: string | null;
}
/**
* Contains properties of a creative field.
*/
export interface Schema$CreativeField {
/**
* Account ID of this creative field. This is a read-only field that can be left blank.
*/
accountId?: string | null;
/**
* Advertiser ID of this creative field. This is a required field on insertion.
*/
advertiserId?: string | null;
/**
* Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
*/
advertiserIdDimensionValue?: Schema$DimensionValue;
/**
* ID of this creative field. This is a read-only, auto-generated field.
*/
id?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
*/
kind?: string | null;
/**
* Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
*/
name?: string | null;
/**
* Subaccount ID of this creative field. This is a read-only field that can be left blank.
*/
subaccountId?: string | null;
}
/**
* Creative Field Assignment.
*/
export interface Schema$CreativeFieldAssignment {
/**
* ID of the creative field.
*/
creativeFieldId?: string | null;
/**
* ID of the creative field value.
*/
creativeFieldValueId?: string | null;
}
/**
* Creative Field List Response
*/
export interface Schema$CreativeFieldsListResponse {
/**
* Creative field collection.
*/
creativeFields?: Schema$CreativeField[];
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldsListResponse".
*/
kind?: string | null;
/**
* Pagination token to be used for the next list operation.
*/
nextPageToken?: string | null;
}
/**
* Contains properties of a creative field value.
*/
export interface Schema$CreativeFieldValue {
/**
* ID of this creative field value. This is a read-only, auto-generated field.
*/
id?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
*/
kind?: string | null;
/**
* Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
*/
value?: string | null;
}
/**
* Creative Field Value List Response
*/
export interface Schema$CreativeFieldValuesListResponse {
/**
* Creative field value collection.
*/
creativeFieldValues?: Schema$CreativeFieldValue[];
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValuesListResponse".
*/
kind?: string | null;
/**
* Pagination token to be used for the next list operation.
*/
nextPageToken?: string | null;
}
/**
* Contains properties of a creative group.
*/
export interface Schema$CreativeGroup {
/**
* Account ID of this creative group. This is a read-only field that can be left blank.
*/
accountId?: string | null;
/**
* Advertiser ID of this creative group. This is a required field on insertion.
*/
advertiserId?: string | null;
/**
* Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
*/
advertiserIdDimensionValue?: Schema$DimensionValue;
/**
* Subgroup of the creative group. Assign your creative groups to a subgroup in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion. Acceptable values are 1 to 2, inclusive.
*/
groupNumber?: number | null;
/**
* ID of this creative group. This is a read-only, auto-generated field.
*/
id?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
*/
kind?: string | null;
/**
* Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
*/
name?: string | null;
/**
* Subaccount ID of this creative group. This is a read-only field that can be left blank.
*/
subaccountId?: string | null;
}
/**
* Creative Group Assignment.
*/
export interface Schema$CreativeGroupAssignment {
/**
* ID of the creative group to be assigned.
*/
creativeGroupId?: string | null;
/**
* Creative group number of the creative group assignment.
*/
creativeGroupNumber?: string | null;
}
/**
* Creative Group List Response
*/
export interface Schema$CreativeGroupsListResponse {
/**
* Creative group collection.
*/
creativeGroups?: Schema$CreativeGroup[];
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroupsListResponse".
*/
kind?: string | null;
/**
* Pagination token to be used for the next list operation.
*/
nextPageToken?: string | null;
}
/**
* Creative optimization settings.
*/
export interface Schema$CreativeOptimizationConfiguration {
/**
* ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
*/
id?: string | null;
/**
* Name of this creative optimization config. This is a required field and must be less than 129 characters long.
*/
name?: string | null;
/**
* List of optimization activities associated with this configuration.
*/
optimizationActivitys?: Schema$OptimizationActivity[];
/**
* Optimization model for this configuration.
*/
optimizationModel?: string | null;
}
/**
* Creative Rotation.
*/
export interface Schema$CreativeRotation {
/**
* Creative assignments in this creative rotation.
*/
creativeAssignments?: Schema$CreativeAssignment[];
/**
* Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.
*/
creativeOptimizationConfigurationId?: string | null;
/**
* Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
*/
type?: string | null;
/**
* Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
*/
weightCalculationStrategy?: string | null;
}
/**
* Creative List Response
*/
export interface Schema$CreativesListResponse {
/**
* Creative collection.
*/
creatives?: Schema$Creative[];
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativesListResponse".
*/
kind?: string | null;
/**
* Pagination token to be used for the next list operation.
*/
nextPageToken?: string | null;
}
/**
* Represents fields that are compatible to be selected for a report of type "CROSS_DIMENSION_REACH".
*/
export interface Schema$CrossDimensionReachReportCompatibleFields {
/**
* Dimensions which are compatible to be selected in the "breakdown" section of the report.
*/
breakdown?: Schema$Dimension[];
/**
* Dimensions which are compatible to be selected in the "dimensionFilters" section of the report.
*/
dimensionFilters?: Schema$Dimension[];
/**
* The kind of resource this is, in this case dfareporting#crossDimensionReachReportCompatibleFields.
*/
kind?: string | null;
/**
* Metrics which are compatible to be selected in the "metricNames" section of the report.
*/
metrics?: Schema$Metric[];
/**
* Metrics which are compatible to be selected in the "overlapMetricNames" section of the report.
*/
overlapMetrics?: Schema$Metric[];
}
/**
* A custom floodlight variable.
*/
export interface Schema$CustomFloodlightVariable {
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#customFloodlightVariable".
*/
kind?: string | null;
/**
* The type of custom floodlight variable to supply a value for. These map to the "u[1-20]=" in the tags.
*/
type?: string | null;
/**
* The value of the custom floodlight variable. The length of string must not exceed 50 characters.
*/
value?: string | null;
}
/**
* Represents a Custom Rich Media Events group.
*/
export interface Schema$CustomRichMediaEvents {
/**
* List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
*/
filteredEventIds?: Schema$DimensionValue[];
/**
* The kind of resource this is, in this case dfareporting#customRichMediaEvents.
*/
kind?: string | null;
}
/**
* Custom Viewability Metric
*/
export interface Schema$CustomViewabilityMetric {
/**
* Configuration of the custom viewability metric.
*/
configuration?: Schema$CustomViewabilityMetricConfiguration;
/**
* ID of the custom viewability metric.
*/
id?: string | null;
/**
* Name of the custom viewability metric.
*/
name?: string | null;
}
/**
* The attributes, like playtime and percent onscreen, that define the Custom Viewability Metric.
*/
export interface Schema$CustomViewabilityMetricConfiguration {
/**
* Whether the video must be audible to count an impression.
*/
audible?: boolean | null;
/**
* The time in milliseconds the video must play for the Custom Viewability Metric to count an impression. If both this and timePercent are specified, the earlier of the two will be used.
*/
timeMillis?: number | null;
/**
* The percentage of video that must play for the Custom Viewability Metric to count an impression. If both this and timeMillis are specified, the earlier of the two will be used.
*/
timePercent?: number | null;
/**
* The percentage of video that must be on screen for the Custom Viewability Metric to count an impression.
*/
viewabilityPercent?: number | null;
}
/**
* Represents a date range.
*/
export interface Schema$DateRange {
/**
* The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
*/
endDate?: string | null;
/**
* The kind of resource this is, in this case dfareporting#dateRange.
*/
kind?: string | null;
/**
* The date range relative to the date of when the report is run.
*/
relativeDateRange?: string | null;
/**
* The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
*/
startDate?: string | null;
}
/**
* Day Part Targeting.
*/
export interface Schema$DayPartTargeting {
/**
* Days of the week when the ad will serve. Acceptable values are: - "SUNDAY" - "MONDAY" - "TUESDAY" - "WEDNESDAY" - "THURSDAY" - "FRIDAY" - "SATURDAY"
*/
daysOfWeek?: string[] | null;
/**
* Hours of the day when the ad will serve, where 0 is midnight to 1 AM and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm. Acceptable values are 0 to 23, inclusive.
*/
hoursOfDay?: number[] | null;
/**
* Whether or not to use the user's local time. If false, the America/New York time zone applies.
*/
userLocalTime?: boolean | null;
}
/**
* Contains information about a landing page deep link.
*/
export interface Schema$DeepLink {
/**
* The URL of the mobile app being linked to.
*/
appUrl?: string | null;
/**
* The fallback URL. This URL will be served to users who do not have the mobile app installed.
*/
fallbackUrl?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#deepLink".
*/
kind?: string | null;
/**
* The mobile app targeted by this deep link.
*/
mobileApp?: Schema$MobileApp;
/**
* Ads served to users on these remarketing lists will use this deep link. Applicable when mobileApp.directory is APPLE_APP_STORE.
*/
remarketingListIds?: string[] | null;
}
/**
* Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further.
*/
export interface Schema$DefaultClickThroughEventTagProperties {
/**
* ID of the click-through event tag to apply to all ads in this entity's scope.
*/
defaultClickThroughEventTagId?: string | null;
/**
* Whether this entity should override the inherited default click-through event tag with its own defined value.
*/
overrideInheritedEventTag?: boolean | null;
}
/**
* Delivery Schedule.
*/
export interface Schema$DeliverySchedule {
/**
* Limit on the number of times an individual user can be served the ad within a specified period of time.
*/
frequencyCap?: Schema$FrequencyCap;
/**
* Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.
*/
hardCutoff?: boolean | null;
/**
* Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then Campaign Manager will serve ad B three times as often as ad A. Acceptable values are 1 to 10, inclusive.
*/
impressionRatio?: string | null;
/**
* Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
*/
priority?: string | null;
}
/**
* Google Ad Manager Settings
*/
export interface Schema$DfpSettings {
/**
* Ad Manager network code for this directory site.
*/
dfpNetworkCode?: string | null;
/**
* Ad Manager network name for this directory site.
*/
dfpNetworkName?: string | null;
/**
* Whether this directory site accepts programmatic placements.
*/
programmaticPlacementAccepted?: boolean | null;
/**
* Whether this directory site is available only via Publisher Portal.
*/
publisherPortalOnly?: boolean | null;
/**
* Whether this directory site accepts publisher-paid tags.
*/
pubPaidPlacementAccepted?: boolean | null;
}
/**
* Represents a dimension.
*/
export interface Schema$Dimension {
/**
* The kind of resource this is, in this case dfareporting#dimension.
*/
kind?: string | null;
/**
* The dimension name, e.g. dfa:advertiser
*/
name?: string | null;
}
/**
* Represents a dimension filter.
*/
export interface Schema$DimensionFilter {
/**
* The name of the dimension to filter.
*/
dimensionName?: string | null;
/**
* The kind of resource this is, in this case dfareporting#dimensionFilter.
*/
kind?: string | null;
/**
* The value of the dimension to filter.
*/
value?: string | null;
}
/**
* Represents a DimensionValue resource.
*/
export interface Schema$DimensionValue {
/**
* The name of the dimension.
*/
dimensionName?: string | null;
/**
* The eTag of this response for caching purposes.
*/
etag?: string | null;
/**
* The ID associated with the value if available.
*/
id?: string | null;
/**
* The kind of resource this is, in this case dfareporting#dimensionValue.
*/
kind?: string | null;
/**
* Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
*/
matchType?: string | null;
/**
* The value of the dimension.
*/
value?: string | null;
}
/**
* Represents the list of DimensionValue resources.
*/
export interface Schema$DimensionValueList {
/**
* The eTag of this response for caching purposes.
*/
etag?: string | null;
/**
* The dimension values returned in this response.
*/
items?: Schema$DimensionValue[];
/**
* The kind of list this is, in this case dfareporting#dimensionValueList.
*/
kind?: string | null;
/**
* Continuation token used to page through dimension values. To retrieve the next page of results, set the next request's "pageToken" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted.
*/
nextPageToken?: string | null;
}
/**
* Represents a DimensionValuesRequest.
*/
export interface Schema$DimensionValueRequest {
/**
* The name of the dimension for which values should be requested.
*/
dimensionName?: string | null;
/**
* The end date of the date range for which to retrieve dimension values. A string of the format "yyyy-MM-dd".
*/
endDate?: string | null;
/**
* The list of filters by which to filter values. The filters are ANDed.
*/
filters?: Schema$DimensionFilter[];
/**
* The kind of request this is, in this case dfareporting#dimensionValueRequest.
*/
kind?: string | null;
/**
* The start date of the date range for which to retrieve dimension values. A string of the format "yyyy-MM-dd".
*/
startDate?: string | null;
}
/**
* DirectorySites contains properties of a website from the Site Directory. Sites need to be added to an account via the Sites resource before they can be assigned to a placement.
*/
export interface Schema$DirectorySite {
/**
* Whether this directory site is active.
*/
active?: boolean | null;
/**
* ID of this directory site. This is a read-only, auto-generated field.
*/
id?: string | null;
/**
* Dimension value for the ID of this directory site. This is a read-only, auto-generated field.
*/
idDimensionValue?: Schema$DimensionValue;
/**
* Tag types for regular placements. Acceptable values are: - "STANDARD" - "IFRAME_JAVASCRIPT_INPAGE" - "INTERNAL_REDIRECT_INPAGE" - "JAVASCRIPT_INPAGE"
*/
inpageTagFormats?: string[] | null;
/**
* Tag types for interstitial placements. Acceptable values are: - "IFRAME_JAVASCRIPT_INTERSTITIAL" - "INTERNAL_REDIRECT_INTERSTITIAL" - "JAVASCRIPT_INTERSTITIAL"
*/
interstitialTagFormats?: string[] | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite".
*/
kind?: string | null;
/**
* Name of this directory site.
*/
name?: string | null;
/**
* Directory site settings.
*/
settings?: Schema$DirectorySiteSettings;
/**
* URL of this directory site.
*/
url?: string | null;
}
/**
* Directory Site Settings
*/
export interface Schema$DirectorySiteSettings {
/**
* Whether this directory site has disabled active view creatives.
*/
activeViewOptOut?: boolean | null;
/**
* Directory site Ad Manager settings.
*/
dfpSettings?: Schema$DfpSettings;
/**
* Whether this site accepts in-stream video ads.
*/
instreamVideoPlacementAccepted?: boolean | null;
/**
* Whether this site accepts interstitial ads.
*/
interstitialPlacementAccepted?: boolean | null;
}
/**
* Directory Site List Response
*/
export interface Schema$DirectorySitesListResponse {
/**
* Directory site collection.
*/
directorySites?: Schema$DirectorySite[];
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySitesListResponse".
*/
kind?: string | null;
/**
* Pagination token to be used for the next list operation.
*/
nextPageToken?: string | null;
}
/**
* Contains properties of a dynamic targeting key. Dynamic targeting keys are unique, user-friendly labels, created at the advertiser level in DCM, that can be assigned to ads, creatives, and placements and used for targeting with Studio dynamic creatives. Use these labels instead of numeric Campaign Manager IDs (such as placement IDs) to save time and avoid errors in your dynamic feeds.
*/
export interface Schema$DynamicTargetingKey {
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicTargetingKey".
*/
kind?: string | null;
/**
* Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase.
*/
name?: string | null;
/**
* ID of the object of this dynamic targeting key. This is a required field.
*/
objectId?: string | null;
/**
* Type of the object of this dynamic targeting key. This is a required field.
*/
objectType?: string | null;
}
/**
* Dynamic Targeting Key List Response
*/
export interface Schema$DynamicTargetingKeysListResponse {
/**
* Dynamic targeting key collection.
*/
dynamicTargetingKeys?: Schema$DynamicTargetingKey[];
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicTargetingKeysListResponse".
*/
kind?: string | null;
}
/**
* A description of how user IDs are encrypted.
*/
export interface Schema$EncryptionInfo {
/**
* The encryption entity ID. This should match the encryption configuration for ad serving or Data Transfer.
*/
encryptionEntityId?: string | null;
/**
* The encryption entity type. This should match the encryption configuration for ad serving or Data Transfer.
*/
encryptionEntityType?: string | null;
/**
* Describes whether the encrypted cookie was received from ad serving (the %m macro) or from Data Transfer.
*/
encryptionSource?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#encryptionInfo".
*/
kind?: string | null;
}
/**
* Contains properties of an event tag.
*/
export interface Schema$EventTag {
/**
* Account ID of this event tag. This is a read-only field that can be left blank.
*/
accountId?: string | null;
/**
* Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
*/
advertiserId?: string | null;
/**
* Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
*/
advertiserIdDimensionValue?: Schema$DimensionValue;
/**
* Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
*/
campaignId?: string | null;
/**
* Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
*/
campaignIdDimensionValue?: Schema$DimensionValue;
/**
* Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
*/
enabledByDefault?: boolean | null;
/**
* Whether to remove this event tag from ads that are trafficked through Display & Video 360 to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.
*/
excludeFromAdxRequests?: boolean | null;
/**
* ID of this event tag. This is a read-only, auto-generated field.
*/
id?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
*/
kind?: string | null;
/**
* Name of this event tag. This is a required field and must be less than 256 characters long.
*/
name?: string | null;
/**
* Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
*/
siteFilterType?: string | null;
/**
* Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.
*/
siteIds?: string[] | null;
/**
* Whether this tag is SSL-compliant or not. This is a read-only field.
*/
sslCompliant?: boolean | null;
/**
* Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
*/
status?: string | null;
/**
* Subaccount ID of this event tag. This is a read-only field that can be left blank.
*/
subaccountId?: string | null;
/**
* Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
*/
type?: string | null;
/**
* Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
*/
url?: string | null;
/**
* Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
*/
urlEscapeLevels?: number | null;
}
/**
* Event tag override information.
*/
export interface Schema$EventTagOverride {
/**
* Whether this override is enabled.
*/
enabled?: boolean | null;
/**
* ID of this event tag override. This is a read-only, auto-generated field.
*/
id?: string | null;
}
/**
* Event Tag List Response
*/
export interface Schema$EventTagsListResponse {
/**
* Event tag collection.
*/
eventTags?: Schema$EventTag[];
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTagsListResponse".
*/
kind?: string | null;
}
/**
* Represents a File resource. A file contains the metadata for a report run. It shows the status of the run and holds the URLs to the generated report data if the run is finished and the status is "REPORT_AVAILABLE".
*/
export interface Schema$File {
/**
* The date range for which the file has report data. The date range will always be the absolute date range for which the report is run.
*/
dateRange?: Schema$DateRange;
/**
* The eTag of this response for caching purposes.
*/
etag?: string | null;
/**
* The filename of the file.
*/
fileName?: string | null;
/**
* The output format of the report. Only available once the file is available.
*/
format?: string | null;
/**
* The unique ID of this report file.
*/
id?: string | null;
/**
* The kind of resource this is, in this case dfareporting#file.
*/
kind?: string | null;
/**
* The timestamp in milliseconds since epoch when this file was last modified.
*/
lastModifiedTime?: string | null;
/**
* The ID of the report this file was generated from.
*/
reportId?: string | null;
/**
* The status of the report file.
*/
status?: string | null;
/**
* The URLs where the completed report file can be downloaded.
*/
urls?: {
apiUrl?: string;
browserUrl?: string;
} | null;
}
/**
* Represents the list of File resources.
*/
export interface Schema$FileList {
/**
* The eTag of this response for caching purposes.
*/
etag?: string | null;
/**
* The files returned in this response.
*/
items?: Schema$File[];
/**
* The kind of list this is, in this case dfareporting#fileList.
*/
kind?: string | null;
/**
* Continuation token used to page through files. To retrieve the next page of results, set the next request's "pageToken" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted.
*/
nextPageToken?: string | null;
}
/**
* Flight
*/
export interface Schema$Flight {
/**
* Inventory item flight end date.
*/
endDate?: string | null;
/**
* Rate or cost of this flight.
*/
rateOrCost?: string | null;
/**
* Inventory item flight start date.
*/
startDate?: string | null;
/**
* Units of this flight.
*/
units?: string | null;
}
/**
* Floodlight Activity GenerateTag Response
*/
export interface Schema$FloodlightActivitiesGenerateTagResponse {
/**
* Generated tag for this Floodlight activity. For global site tags, this is the event snippet.
*/
floodlightActivityTag?: string | null;
/**
* The global snippet section of a global site tag. The global site tag sets new cookies on your domain, which will store a unique identifier for a user or the ad click that brought the user to your site. Learn more.
*/
globalSiteTagGlobalSnippet?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivitiesGenerateTagResponse".
*/
kind?: string | null;
}
/**
* Floodlight Activity List Response
*/
export interface Schema$FloodlightActivitiesListResponse {
/**
* Floodlight activity collection.
*/
floodlightActivities?: Schema$FloodlightActivity[];
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivitiesListResponse".
*/
kind?: string | null;
/**
* Pagination token to be used for the next list operation.
*/
nextPageToken?: string | null;
}
/**
* Contains properties of a Floodlight activity.
*/
export interface Schema$FloodlightActivity {
/**
* Account ID of this floodlight activity. This is a read-only field that can be left blank.
*/
accountId?: string | null;
/**
* Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
*/
advertiserId?: string | null;
/**
* Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
*/
advertiserIdDimensionValue?: Schema$DimensionValue;
/**
* Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING.
*/
cacheBustingType?: string | null;
/**
* Counting method for conversions for this floodlight activity. This is a required field.
*/
countingMethod?: string | null;
/**
* Dynamic floodlight tags.
*/
defaultTags?: Schema$FloodlightActivityDynamicTag[];
/**
* URL where this tag will be deployed. If specified, must be less than 256 characters long.
*/
expectedUrl?: string | null;
/**
* Floodlight activity group ID of this floodlight activity. This is a required field.
*/
floodlightActivityGroupId?: string | null;
/**
* Name of the associated floodlight activity group. This is a read-only field.
*/
floodlightActivityGroupName?: string | null;
/**
* Tag string of the associated floodlight activity group. This is a read-only field.
*/
floodlightActivityGroupTagString?: string | null;
/**
* Type of the associated floodlight activity group. This is a read-only field.
*/
floodlightActivityGroupType?: string | null;
/**
* Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
*/
floodlightConfigurationId?: string | null;
/**
* Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
*/
floodlightConfigurationIdDimensionValue?: Schema$DimensionValue;
/**
* The type of Floodlight tag this activity will generate. This is a required field.
*/
floodlightTagType?: string | null;
/**
* Whether this activity is archived.
*/
hidden?: boolean | null;
/**
* ID of this floodlight activity. This is a read-only, auto-generated field.
*/
id?: string | null;
/**
* Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
*/
idDimensionValue?: Schema$DimensionValue;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
*/
kind?: string | null;
/**
* Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
*/
name?: string | null;
/**
* General notes or implementation instructions for the tag.
*/
notes?: string | null;
/**
* Publisher dynamic floodlight tags.
*/
publisherTags?: Schema$FloodlightActivityPublisherDynamicTag[];
/**
* Whether this tag should use SSL.
*/
secure?: boolean | null;
/**
* Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
*/
sslCompliant?: boolean | null;
/**
* Whether this floodlight activity must be SSL-compliant.
*/
sslRequired?: boolean | null;
/**
* Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
*/
subaccountId?: string | null;
/**
* Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
*/
tagFormat?: string | null;
/**
* Value of the cat= parameter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
*/
tagString?: string | null;
/**
* List of the user-defined variables used by this conversion tag. These map to the "u[1-100]=" in the tags. Each of these can have a user defined type. Acceptable values are U1 to U100, inclusive.
*/
userDefinedVariableTypes?: string[] | null;
}
/**
* Dynamic Tag
*/
export interface Schema$FloodlightActivityDynamicTag {
/**
* ID of this dynamic tag. This is a read-only, auto-generated field.
*/
id?: string | null;
/**
* Name of this tag.
*/
name?: string | null;
/**
* Tag code.
*/
tag?: string | null;
}
/**
* Contains properties of a Floodlight activity group.
*/
export interface Schema$FloodlightActivityGroup {
/**
* Account ID of this floodlight activity group. This is a read-only field that can be left blank.
*/
accountId?: string | null;
/**
* Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.
*/
advertiserId?: string | null;
/**
* Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
*/
advertiserIdDimensionValue?: Schema$DimensionValue;
/**
* Floodlight configuration ID of this floodlight activity group. This is a required field.
*/
floodlightConfigurationId?: string | null;
/**
* Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
*/
floodlightConfigurationIdDimensionValue?: Schema$DimensionValue;
/**
* ID of this floodlight activity group. This is a read-only, auto-generated field.
*/
id?: string | null;
/**
* Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
*/
idDimensionValue?: Schema$DimensionValue;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
*/
kind?: string | null;
/**
* Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
*/
name?: string | null;
/**
* Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
*/
subaccountId?: string | null;
/**
* Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
*/
tagString?: string | null;
/**
* Type of the floodlight activity group. This is a required field that is read-only after insertion.
*/
type?: string | null;
}
/**
* Floodlight Activity Group List Response
*/
export interface Schema$FloodlightActivityGroupsListResponse {
/**
* Floodlight activity group collection.
*/
floodlightActivityGroups?: Schema$FloodlightActivityGroup[];
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroupsListResponse".
*/
kind?: string | null;
/**
* Pagination token to be used for the next list operation.
*/
nextPageToken?: string | null;
}
/**
* Publisher Dynamic Tag
*/
export interface Schema$FloodlightActivityPublisherDynamicTag {
/**
* Whether this tag is applicable only for click-throughs.
*/
clickThrough?: boolean | null;
/**
* Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
*/
directorySiteId?: string | null;
/**
* Dynamic floodlight tag.
*/
dynamicTag?: Schema$FloodlightActivityDynamicTag;
/**
* Site ID of this dynamic tag.
*/
siteId?: string | null;
/**
* Dimension value for the ID of the site. This is a read-only, auto-generated field.
*/
siteIdDimensionValue?: Schema$DimensionValue;
/**
* Whether this tag is applicable only for view-throughs.
*/
viewThrough?: boolean | null;
}
/**
* Contains properties of a Floodlight configuration.
*/
export interface Schema$FloodlightConfiguration {
/**
* Account ID of this floodlight configuration. This is a read-only field that can be left blank.
*/
accountId?: string | null;
/**
* Advertiser ID of the parent advertiser of this floodlight configuration.
*/
advertiserId?: string | null;
/**
* Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
*/
advertiserIdDimensionValue?: Schema$DimensionValue;
/**
* Whether advertiser data is shared with Google Analytics.
*/
analyticsDataSharingEnabled?: boolean | null;
/**
* Custom Viewability metric for the floodlight configuration.
*/
customViewabilityMetric?: Schema$CustomViewabilityMetric;
/**
* Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
*/
exposureToConversionEnabled?: boolean | null;
/**
* Day that will be counted as the first day of the week in reports. This is a required field.
*/
firstDayOfWeek?: string | null;
/**
* ID of this floodlight configuration. This is a read-only, auto-generated field.
*/
id?: string | null;
/**
* Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field.
*/
idDimensionValue?: Schema$DimensionValue;
/**
* Whether in-app attribution tracking is enabled.
*/
inAppAttributionTrackingEnabled?: boolean | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
*/
kind?: string | null;
/**
* Lookback window settings for this floodlight configuration.
*/
lookbackConfiguration?: Schema$LookbackConfiguration;
/**
* Types of attribution options for natural search conversions.
*/
naturalSearchConversionAttributionOption?: string | null;
/**
* Settings for Campaign Manager Omniture integration.
*/
omnitureSettings?: Schema$OmnitureSettings;
/**
* Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.
*/
subaccountId?: string | null;
/**
* Configuration settings for dynamic and image floodlight tags.
*/
tagSettings?: Schema$TagSettings;
/**
* List of third-party authentication tokens enabled for this configuration.
*/
thirdPartyAuthenticationTokens?: Schema$ThirdPartyAuthenticationToken[];
/**
* List of user defined variables enabled for this configuration.
*/
userDefinedVariableConfigurations?: Schema$UserDefinedVariableConfiguration[];
}
/**
* Floodlight Configuration List Response
*/
export interface Schema$FloodlightConfigurationsListResponse {
/**
* Floodlight configuration collection.
*/
floodlightConfigurations?: Schema$FloodlightConfiguration[];
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfigurationsListResponse".
*/
kind?: string | null;
}
/**
* Represents fields that are compatible to be selected for a report of type "FlOODLIGHT".
*/
export interface Schema$FloodlightReportCompatibleFields {
/**
* Dimensions which are compatible to be selected in the "dimensionFilters" section of the report.
*/
dimensionFilters?: Schema$Dimension[];
/**
* Dimensions which are compatible to be selected in the "dimensions" section of the report.
*/
dimensions?: Schema$Dimension[];
/**
* The kind of resource this is, in this case dfareporting#floodlightReportCompatibleFields.
*/
kind?: string | null;
/**
* Metrics which are compatible to be selected in the "metricNames" section of the report.
*/
metrics?: Schema$Metric[];
}
/**
* Frequency Cap.
*/
export interface Schema$FrequencyCap {
/**
* Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days. Acceptable values are 1 to 7776000, inclusive.
*/
duration?: string | null;
/**
* Number of times an individual user can be served the ad within the specified duration. Acceptable values are 1 to 15, inclusive.
*/
impressions?: string | null;
}
/**
* FsCommand.
*/
export interface Schema$FsCommand {
/**
* Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
*/
left?: number | null;
/**
* Position in the browser where the window will open.
*/
positionOption?: string | null;
/**
* Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
*/
top?: number | null;
/**
* Height of the window.
*/
windowHeight?: number | null;
/**
* Width of the window.
*/
windowWidth?: number | null;
}
/**
* Geographical Targeting.
*/
export interface Schema$GeoTargeting {
/**
* Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
*/
cities?: Schema$City[];
/**
* Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
*/
countries?: Schema$Country[];
/**
* Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
*/
excludeCountries?: boolean | null;
/**
* Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
*/
metros?: Schema$Metro[];
/**
* Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
*/
postalCodes?: Schema$PostalCode[];
/**
* Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
*/
regions?: Schema$Region[];
}
/**
* Represents a buy from the Planning inventory store.
*/
export interface Schema$InventoryItem {
/**
* Account ID of this inventory item.
*/
accountId?: string | null;
/**
* Ad slots of this inventory item. If this inventory item represents a standalone placement, there will be exactly one ad slot. If this inventory item represents a placement group, there will be more than one ad slot, each representing one child placement in that placement group.
*/
adSlots?: Schema$AdSlot[];
/**
* Advertiser ID of this inventory item.
*/
advertiserId?: string | null;
/**
* Content category ID of this inventory item.
*/
contentCategoryId?: string | null;
/**
* Estimated click-through rate of this inventory item.
*/
estimatedClickThroughRate?: string | null;
/**
* Estimated conversion rate of this inventory item.
*/
estimatedConversionRate?: string | null;
/**
* ID of this inventory item.
*/
id?: string | null;
/**
* Whether this inventory item is in plan.
*/
inPlan?: boolean | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#inventoryItem".
*/
kind?: string | null;
/**
* Information about the most recent modification of this inventory item.
*/
lastModifiedInfo?: Schema$LastModifiedInfo;
/**
* Name of this inventory item. For standalone inventory items, this is the same name as that of its only ad slot. For group inventory items, this can differ from the name of any of its ad slots.
*/
name?: string | null;
/**
* Negotiation channel ID of this inventory item.
*/
negotiationChannelId?: string | null;
/**
* Order ID of this inventory item.
*/
orderId?: string | null;
/**
* Placement strategy ID of this inventory item.
*/
placementStrategyId?: string | null;
/**
* Pricing of this inventory item.
*/
pricing?: Schema$Pricing;
/**
* Project ID of this inventory item.
*/
projectId?: string | null;
/**
* RFP ID of this inventory item.
*/
rfpId?: string | null;
/**
* ID of the site this inventory item is associated with.
*/
siteId?: string | null;
/**
* Subaccount ID of this inventory item.
*/
subaccountId?: string | null;
/**
* Type of inventory item.
*/
type?: string | null;
}
/**
* Inventory item List Response
*/
export interface Schema$InventoryItemsListResponse {
/**
* Inventory item collection
*/
inventoryItems?: Schema$InventoryItem[];
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#inventoryItemsListResponse".
*/
kind?: string | null;
/**
* Pagination token to be used for the next list operation.
*/
nextPageToken?: string | null;
}
/**
* Key Value Targeting Expression.
*/
export interface Schema$KeyValueTargetingExpression {
/**
* Keyword expression being targeted by the ad.
*/
expression?: string | null;
}
/**
* Contains information about where a user's browser is taken after the user clicks an ad.
*/
export interface Schema$LandingPage {
/**
* Advertiser ID of this landing page. This is a required field.
*/
advertiserId?: string | null;
/**
* Whether this landing page has been archived.
*/
archived?: boolean | null;
/**
* Links that will direct the user to a mobile app, if installed.
*/
deepLinks?: Schema$DeepLink[];
/**
* ID of this landing page. This is a read-only, auto-generated field.
*/
id?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
*/
kind?: string | null;
/**
* Name of this landing page. This is a required field. It must be less than 256 characters long.
*/
name?: string | null;
/**
* URL of this landing page. This is a required field.
*/
url?: string | null;
}
/**
* Contains information about a language that can be targeted by ads.
*/
export interface Schema$Language {
/**
* Language ID of this language. This is the ID used for targeting and generating reports.
*/
id?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#language".
*/
kind?: string | null;
/**
* Format of language code is an ISO 639 two-letter language code optionally followed by an underscore followed by an ISO 3166 code. Examples are "en" for English or "zh_CN" for Simplified Chinese.
*/
languageCode?: string | null;
/**
* Name of this language.
*/
name?: string | null;
}
/**
* Language List Response
*/
export interface Schema$LanguagesListResponse {
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#languagesListResponse".
*/
kind?: string | null;
/**
* Language collection.
*/
languages?: Schema$Language[];
}
/**
* Language Targeting.
*/
export interface Schema$LanguageTargeting {
/**
* Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated.
*/
languages?: Schema$Language[];
}
/**
* Modification timestamp.
*/
export interface Schema$LastModifiedInfo {
/**
* Timestamp of the last change in milliseconds since epoch.
*/
time?: string | null;
}
/**
* A group clause made up of list population terms representing constraints joined by ORs.
*/
export interface Schema$ListPopulationClause {
/**
* Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
*/
terms?: Schema$ListPopulationTerm[];
}
/**
* Remarketing List Population Rule.
*/
export interface Schema$ListPopulationRule {
/**
* Floodlight activity ID associated with this rule. This field can be left blank.
*/
floodlightActivityId?: string | null;
/**
* Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
*/
floodlightActivityName?: string | null;
/**
* Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.
*/
listPopulationClauses?: Schema$ListPopulationClause[];
}
/**
* Remarketing List Population Rule Term.
*/
export interface Schema$ListPopulationTerm {
/**
* Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.
*/
contains?: boolean | null;
/**
* Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
*/
negation?: boolean | null;
/**
* Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
*/
operator?: string | null;
/**
* ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
*/
remarketingListId?: string | null;
/**
* List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.
*/
type?: string | null;
/**
* Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
*/
value?: string | null;
/**
* Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.
*/
variableFriendlyName?: string | null;
/**
* Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.
*/
variableName?: string | null;
}
/**
* Remarketing List Targeting Expression.
*/
export interface Schema$ListTargetingExpression {
/**
* Expression describing which lists are being targeted by the ad.
*/
expression?: string | null;
}
/**
* Lookback configuration settings.
*/
export interface Schema$LookbackConfiguration {
/**
* Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
*/
clickDuration?: number | null;
/**
* Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
*/
postImpressionActivitiesDuration?: number | null;
}
/**
* Represents a metric.
*/
export interface Schema$Metric {
/**
* The kind of resource this is, in this case dfareporting#metric.
*/
kind?: string | null;
/**
* The metric name, e.g. dfa:impressions
*/
name?: string | null;
}
/**
* Contains information about a metro region that can be targeted by ads.
*/
export interface Schema$Metro {
/**
* Country code of the country to which this metro region belongs.
*/
countryCode?: string | null;
/**
* DART ID of the country to which this metro region belongs.
*/
countryDartId?: string | null;
/**
* DART ID of this metro region.
*/
dartId?: string | null;
/**
* DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
*/
dmaId?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
*/
kind?: string | null;
/**
* Metro code of this metro region. This is equivalent to dma_id.
*/
metroCode?: string | null;
/**
* Name of this metro region.
*/
name?: string | null;
}
/**
* Metro List Response
*/
export interface Schema$MetrosListResponse {
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#metrosListResponse".
*/
kind?: string | null;
/**
* Metro collection.
*/
metros?: Schema$Metro[];
}
/**
* Contains information about a mobile app. Used as a landing page deep link.
*/
export interface Schema$MobileApp {
/**
* Mobile app directory.
*/
directory?: string | null;
/**
* ID of this mobile app.
*/
id?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileApp".
*/
kind?: string | null;
/**
* Publisher name.
*/
publisherName?: string | null;
/**
* Title of this mobile app.
*/
title?: string | null;
}
/**
* Mobile app List Response
*/
export interface Schema$MobileAppsListResponse {
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileAppsListResponse".
*/
kind?: string | null;
/**
* Mobile apps collection.
*/
mobileApps?: Schema$MobileApp[];
/**
* Pagination token to be used for the next list operation.
*/
nextPageToken?: string | null;
}
/**
* Contains information about a mobile carrier that can be targeted by ads.
*/
export interface Schema$MobileCarrier {
/**
* Country code of the country to which this mobile carrier belongs.
*/
countryCode?: string | null;
/**
* DART ID of the country to which this mobile carrier belongs.
*/
countryDartId?: string | null;
/**
* ID of this mobile carrier.
*/
id?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
*/
kind?: string | null;
/**
* Name of this mobile carrier.
*/
name?: string | null;
}
/**
* Mobile Carrier List Response
*/
export interface Schema$MobileCarriersListResponse {
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarriersListResponse".
*/
kind?: string | null;
/**
* Mobile carrier collection.
*/
mobileCarriers?: Schema$MobileCarrier[];
}
/**
* Object Filter.
*/
export interface Schema$ObjectFilter {
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
*/
kind?: string | null;
/**
* Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
*/
objectIds?: string[] | null;
/**
* Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
*/
status?: string | null;
}
/**
* Offset Position.
*/
export interface Schema$OffsetPosition {
/**
* Offset distance from left side of an asset or a window.
*/
left?: number | null;
/**
* Offset distance from top side of an asset or a window.
*/
top?: number | null;
}
/**
* Omniture Integration Settings.
*/
export interface Schema$OmnitureSettings {
/**
* Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.
*/
omnitureCostDataEnabled?: boolean | null;
/**
* Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled.
*/
omnitureIntegrationEnabled?: boolean | null;
}
/**
* Contains information about an operating system that can be targeted by ads.
*/
export interface Schema$OperatingSystem {
/**
* DART ID of this operating system. This is the ID used for targeting.
*/
dartId?: string | null;
/**
* Whether this operating system is for desktop.
*/
desktop?: boolean | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
*/
kind?: string | null;
/**
* Whether this operating system is for mobile.
*/
mobile?: boolean | null;
/**
* Name of this operating system.
*/
name?: string | null;
}
/**
* Operating System List Response
*/
export interface Schema$OperatingSystemsListResponse {
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemsListResponse".
*/
kind?: string | null;
/**
* Operating system collection.
*/
operatingSystems?: Schema$OperatingSystem[];
}
/**
* Contains information about a particular version of an operating system that can be targeted by ads.
*/
export interface Schema$OperatingSystemVersion {
/**
* ID of this operating system version.
*/
id?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
*/
kind?: string | null;
/**
* Major version (leftmost number) of this operating system version.
*/
majorVersion?: string | null;
/**
* Minor version (number after the first dot) of this operating system version.
*/
minorVersion?: string | null;
/**
* Name of this operating system version.
*/
name?: string | null;
/**
* Operating system of this operating system version.
*/
operatingSystem?: Schema$OperatingSystem;
}
/**
* Operating System Version List Response
*/
export interface Schema$OperatingSystemVersionsListResponse {
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersionsListResponse".
*/
kind?: string | null;
/**
* Operating system version collection.
*/
operatingSystemVersions?: Schema$OperatingSystemVersion[];
}
/**
* Creative optimization activity.
*/
export interface Schema$OptimizationActivity {
/**
* Floodlight activity ID of this optimization activity. This is a required field.
*/
floodlightActivityId?: string | null;
/**
* Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
*/
floodlightActivityIdDimensionValue?: Schema$DimensionValue;
/**
* Weight associated with this optimization. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities. Value must be greater than or equal to 1.
*/
weight?: number | null;
}
/**
* Describes properties of a Planning order.
*/
export interface Schema$Order {
/**
* Account ID of this order.
*/
accountId?: string | null;
/**
* Advertiser ID of this order.
*/
advertiserId?: string | null;
/**
* IDs for users that have to approve documents created for this order.
*/
approverUserProfileIds?: string[] | null;
/**
* Buyer invoice ID associated with this order.
*/
buyerInvoiceId?: string | null;
/**
* Name of the buyer organization.
*/
buyerOrganizationName?: string | null;
/**
* Comments in this order.
*/
comments?: string | null;
/**
* Contacts for this order.
*/
contacts?: Schema$OrderContact[];
/**
* ID of this order. This is a read-only, auto-generated field.
*/
id?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#order".
*/
kind?: string | null;
/**
* Information about the most recent modification of this order.
*/
lastModifiedInfo?: Schema$LastModifiedInfo;
/**
* Name of this order.
*/
name?: string | null;
/**
* Notes of this order.
*/
notes?: string | null;
/**
* ID of the terms and conditions template used in this order.
*/
planningTermId?: string | null;
/**
* Project ID of this order.
*/
projectId?: string | null;
/**
* Seller order ID associated with this order.
*/
sellerOrderId?: string | null;
/**
* Name of the seller organization.
*/
sellerOrganizationName?: string | null;
/**
* Site IDs this order is associated with.
*/
siteId?: string[] | null;
/**
* Free-form site names this order is associated with.
*/
siteNames?: string[] | null;
/**
* Subaccount ID of this order.
*/
subaccountId?: string | null;
/**
* Terms and conditions of this order.
*/
termsAndConditions?: string | null;
}
/**
* Contact of an order.
*/
export interface Schema$OrderContact {
/**
* Free-form information about this contact. It could be any information related to this contact in addition to type, title, name, and signature user profile ID.
*/
contactInfo?: string | null;
/**
* Name of this contact.
*/
contactName?: string | null;
/**
* Title of this contact.
*/
contactTitle?: string | null;
/**
* Type of this contact.
*/
contactType?: string | null;
/**
* ID of the user profile containing the signature that will be embedded into order documents.
*/
signatureUserProfileId?: string | null;
}
/**
* Contains properties of a Planning order document.
*/
export interface Schema$OrderDocument {
/**
* Account ID of this order document.
*/
accountId?: string | null;
/**
* Advertiser ID of this order document.
*/
advertiserId?: string | null;
/**
* The amended order document ID of this order document. An order document can be created by optionally amending another order document so that the change history can be preserved.
*/
amendedOrderDocumentId?: string | null;
/**
* IDs of users who have approved this order document.
*/
approvedByUserProfileIds?: string[] | null;
/**
* Whether this order document is cancelled.
*/
cancelled?: boolean | null;
/**
* Information about the creation of this order document.
*/
createdInfo?: Schema$LastModifiedInfo;
/**
* Effective date of this order document.
*/
effectiveDate?: string | null;
/**
* ID of this order document.
*/
id?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#orderDocument".
*/
kind?: string | null;
/**
* List of email addresses that received the last sent document.
*/
lastSentRecipients?: string[] | null;
/**
* Timestamp of the last email sent with this order document.
*/
lastSentTime?: string | null;
/**
* ID of the order from which this order document is created.
*/
orderId?: string | null;
/**
* Project ID of this order document.
*/
projectId?: string | null;
/**
* Whether this order document has been signed.
*/
signed?: boolean | null;
/**
* Subaccount ID of this order document.
*/
subaccountId?: string | null;
/**
* Title of this order document.
*/
title?: string | null;
/**
* Type of this order document
*/
type?: string | null;
}
/**
* Order document List Response
*/
export interface Schema$OrderDocumentsListResponse {
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#orderDocumentsListResponse".
*/
kind?: string | null;
/**
* Pagination token to be used for the next list operation.
*/
nextPageToken?: string | null;
/**
* Order document collection
*/
orderDocuments?: Schema$OrderDocument[];
}
/**
* Order List Response
*/
export interface Schema$OrdersListResponse {
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#ordersListResponse".
*/
kind?: string | null;
/**
* Pagination token to be used for the next list operation.
*/
nextPageToken?: string | null;
/**
* Order collection.
*/
orders?: Schema$Order[];
}
/**
* Represents fields that are compatible to be selected for a report of type "PATH_TO_CONVERSION".
*/
export interface Schema$PathToConversionReportCompatibleFields {
/**
* Conversion dimensions which are compatible to be selected in the "conversionDimensions" section of the report.
*/
conversionDimensions?: Schema$Dimension[];
/**
* Custom floodlight variables which are compatible to be selected in the "customFloodlightVariables" section of the report.
*/
customFloodlightVariables?: Schema$Dimension[];
/**
* The kind of resource this is, in this case dfareporting#pathToConversionReportCompatibleFields.
*/
kind?: string | null;
/**
* Metrics which are compatible to be selected in the "metricNames" section of the report.
*/
metrics?: Schema$Metric[];
/**
* Per-interaction dimensions which are compatible to be selected in the "perInteractionDimensions" section of the report.
*/
perInteractionDimensions?: Schema$Dimension[];
}
/**
* Contains properties of a placement.
*/
export interface Schema$Placement {
/**
* Account ID of this placement. This field can be left blank.
*/
accountId?: string | null;
/**
* Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect.
*/
adBlockingOptOut?: boolean | null;
/**
* Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used.
*/
additionalSizes?: Schema$Size[];
/**
* Advertiser ID of this placement. This field can be left blank.
*/
advertiserId?: string | null;
/**
* Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
*/
advertiserIdDimensionValue?: Schema$DimensionValue;
/**
* Whether this placement is archived.
*/
archived?: boolean | null;
/**
* Campaign ID of this placement. This field is a required field on insertion.
*/
campaignId?: string | null;
/**
* Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
*/
campaignIdDimensionValue?: Schema$DimensionValue;
/**
* Comments for this placement.
*/
comment?: string | null;
/**
* Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
*/
compatibility?: string | null;
/**
* ID of the content category assigned to this placement.
*/
contentCategoryId?: string | null;
/**
* Information about the creation of this placement. This is a read-only field.
*/
createInfo?: Schema$LastModifiedInfo;
/**
* Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
*/
directorySiteId?: string | null;
/**
* Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
*/
directorySiteIdDimensionValue?: Schema$DimensionValue;
/**
* External ID for this placement.
*/
externalId?: string | null;
/**
* ID of this placement. This is a read-only, auto-generated field.
*/
id?: string | null;
/**
* Dimension value for the ID of this placement. This is a read-only, auto-generated field.
*/
idDimensionValue?: Schema$DimensionValue;
/**
* Key name of this placement. This is a read-only, auto-generated field.
*/
keyName?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
*/
kind?: string | null;
/**
* Information about the most recent modification of this placement. This is a read-only field.
*/
lastModifiedInfo?: Schema$LastModifiedInfo;
/**
* Lookback window settings for this placement.
*/
lookbackConfiguration?: Schema$LookbackConfiguration;
/**
* Name of this placement.This is a required field and must be less than 256 characters long.
*/
name?: string | null;
/**
* Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
*/
paymentApproved?: boolean | null;
/**
* Payment source for this placement. This is a required field that is read-only after insertion.
*/
paymentSource?: string | null;
/**
* ID of this placement's group, if applicable.
*/
placementGroupId?: string | null;
/**
* Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
*/
placementGroupIdDimensionValue?: Schema$DimensionValue;
/**
* ID of the placement strategy assigned to this placement.
*/
placementStrategyId?: string | null;
/**
* Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
*/
pricingSchedule?: Schema$PricingSchedule;
/**
* Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.
*/
primary?: boolean | null;
/**
* Information about the last publisher update. This is a read-only field.
*/
publisherUpdateInfo?: Schema$LastModifiedInfo;
/**
* Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
*/
siteId?: string | null;
/**
* Dimension value for the ID of the site. This is a read-only, auto-generated field.
*/
siteIdDimensionValue?: Schema$DimensionValue;
/**
* Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
*/
size?: Schema$Size;
/**
* Whether creatives assigned to this placement must be SSL-compliant.
*/
sslRequired?: boolean | null;
/**
* Third-party placement status.
*/
status?: string | null;
/**
* Subaccount ID of this placement. This field can be left blank.
*/
subaccountId?: string | null;
/**
* Tag formats to generate for this placement. This field is required on insertion. Acceptable values are: - "PLACEMENT_TAG_STANDARD" - "PLACEMENT_TAG_IFRAME_JAVASCRIPT" - "PLACEMENT_TAG_IFRAME_ILAYER" - "PLACEMENT_TAG_INTERNAL_REDIRECT" - "PLACEMENT_TAG_JAVASCRIPT" - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT" - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT" - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT" - "PLACEMENT_TAG_CLICK_COMMANDS" - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH" - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3" - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4" - "PLACEMENT_TAG_TRACKING" - "PLACEMENT_TAG_TRACKING_IFRAME" - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
*/
tagFormats?: string[] | null;
/**
* Tag settings for this placement.
*/
tagSetting?: Schema$TagSetting;
/**
* Whether Verification and ActiveView are disabled for in-stream video creatives for this placement. The same setting videoActiveViewOptOut exists on the site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.
*/
videoActiveViewOptOut?: boolean | null;
/**
* A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility.
*/
videoSettings?: Schema$VideoSettings;
/**
* VPAID adapter setting for this placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to this placement. Note: Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH.
*/
vpaidAdapterChoice?: string | null;
}
/**
* Placement Assignment.
*/
export interface Schema$PlacementAssignment {
/**
* Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
*/
active?: boolean | null;
/**
* ID of the placement to be assigned. This is a required field.
*/
placementId?: string | null;
/**
* Dimension value for the ID of the placement. This is a read-only, auto-generated field.
*/
placementIdDimensionValue?: Schema$DimensionValue;
/**
* Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.
*/
sslRequired?: boolean | null;
}
/**
* Contains properties of a package or roadblock.
*/
export interface Schema$PlacementGroup {
/**
* Account ID of this placement group. This is a read-only field that can be left blank.
*/
accountId?: string | null;
/**
* Advertiser ID of this placement group. This is a required field on insertion.
*/
advertiserId?: string | null;
/**
* Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
*/
advertiserIdDimensionValue?: Schema$DimensionValue;
/**
* Whether this placement group is archived.
*/
archived?: boolean | null;
/**
* Campaign ID of this placement group. This field is required on insertion.
*/
campaignId?: string | null;
/**
* Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
*/
campaignIdDimensionValue?: Schema$DimensionValue;
/**
* IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
*/
childPlacementIds?: string[] | null;
/**
* Comments for this placement group.
*/
comment?: string | null;
/**
* ID of the content category assigned to this placement group.
*/
contentCategoryId?: string | null;
/**
* Information about the creation of this placement group. This is a read-only field.
*/
createInfo?: Schema$LastModifiedInfo;
/**
* Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
*/
directorySiteId?: string | null;
/**
* Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
*/
directorySiteIdDimensionValue?: Schema$DimensionValue;
/**
* External ID for this placement.
*/
externalId?: string | null;
/**
* ID of this placement group. This is a read-only, auto-generated field.
*/
id?: string | null;
/**
* Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
*/
idDimensionValue?: Schema$DimensionValue;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
*/
kind?: string | null;
/**
* Information about the most recent modification of this placement group. This is a read-only field.
*/
lastModifiedInfo?: Schema$LastModifiedInfo;
/**
* Name of this placement group. This is a required field and must be less than 256 characters long.
*/
name?: string | null;
/**
* Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
*/
placementGroupType?: string | null;
/**
* ID of the placement strategy assigned to this placement group.
*/
placementStrategyId?: string | null;
/**
* Pricing schedule of this placement group. This field is required on insertion.
*/
pricingSchedule?: Schema$PricingSchedule;
/**
* ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
*/
primaryPlacementId?: string | null;
/**
* Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
*/
primaryPlacementIdDimensionValue?: Schema$DimensionValue;
/**
* Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
*/
siteId?: string | null;
/**
* Dimension value for the ID of the site. This is a read-only, auto-generated field.
*/
siteIdDimensionValue?: Schema$DimensionValue;
/**
* Subaccount ID of this placement group. This is a read-only field that can be left blank.
*/
subaccountId?: string | null;
}
/**
* Placement Group List Response
*/
export interface Schema$PlacementGroupsListResponse {
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroupsListResponse".
*/
kind?: string | null;
/**
* Pagination token to be used for the next list operation.
*/
nextPageToken?: string | null;
/**
* Placement group collection.
*/
placementGroups?: Schema$PlacementGroup[];
}
/**
* Placement GenerateTags Response
*/
export interface Schema$PlacementsGenerateTagsResponse {
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementsGenerateTagsResponse".
*/
kind?: string | null;
/**
* Set of generated tags for the specified placements.
*/
placementTags?: Schema$PlacementTag[];
}
/**
* Placement List Response
*/
export interface Schema$PlacementsListResponse {
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementsListResponse".
*/
kind?: string | null;
/**
* Pagination token to be used for the next list operation.
*/
nextPageToken?: string | null;
/**
* Placement collection.
*/
placements?: Schema$Placement[];
}
/**
* Placement Strategy List Response
*/
export interface Schema$PlacementStrategiesListResponse {
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategiesListResponse".
*/
kind?: string | null;
/**
* Pagination token to be used for the next list operation.
*/
nextPageToken?: string | null;
/**
* Placement strategy collection.
*/
placementStrategies?: Schema$PlacementStrategy[];
}
/**
* Contains properties of a placement strategy.
*/
export interface Schema$PlacementStrategy {
/**
* Account ID of this placement strategy.This is a read-only field that can be left blank.
*/
accountId?: string | null;
/**
* ID of this placement strategy. This is a read-only, auto-generated field.
*/
id?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
*/
kind?: string | null;
/**
* Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.
*/
name?: string | null;
}
/**
* Placement Tag
*/
export interface Schema$PlacementTag {
/**
* Placement ID
*/
placementId?: string | null;
/**
* Tags generated for this placement.
*/
tagDatas?: Schema$TagData[];
}
/**
* Contains information about a platform type that can be targeted by ads.
*/
export interface Schema$PlatformType {
/**
* ID of this platform type.
*/
id?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
*/
kind?: string | null;
/**
* Name of this platform type.
*/
name?: string | null;
}
/**
* Platform Type List Response
*/
export interface Schema$PlatformTypesListResponse {
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformTypesListResponse".
*/
kind?: string | null;
/**
* Platform type collection.
*/
platformTypes?: Schema$PlatformType[];
}
/**
* Popup Window Properties.
*/
export interface Schema$PopupWindowProperties {
/**
* Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
*/
dimension?: Schema$Size;
/**
* Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
*/
offset?: Schema$OffsetPosition;
/**
* Popup window position either centered or at specific coordinate.
*/
positionType?: string | null;
/**
* Whether to display the browser address bar.
*/
showAddressBar?: boolean | null;
/**
* Whether to display the browser menu bar.
*/
showMenuBar?: boolean | null;
/**
* Whether to display the browser scroll bar.
*/
showScrollBar?: boolean | null;
/**
* Whether to display the browser status bar.
*/
showStatusBar?: boolean | null;
/**
* Whether to display the browser tool bar.
*/
showToolBar?: boolean | null;
/**
* Title of popup window.
*/
title?: string | null;
}
/**
* Contains information about a postal code that can be targeted by ads.
*/
export interface Schema$PostalCode {
/**
* Postal code. This is equivalent to the id field.
*/
code?: string | null;
/**
* Country code of the country to which this postal code belongs.
*/
countryCode?: string | null;
/**
* DART ID of the country to which this postal code belongs.
*/
countryDartId?: string | null;
/**
* ID of this postal code.
*/
id?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
*/
kind?: string | null;
}
/**
* Postal Code List Response
*/
export interface Schema$PostalCodesListResponse {
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCodesListResponse".
*/
kind?: string | null;
/**
* Postal code collection.
*/
postalCodes?: Schema$PostalCode[];
}
/**
* Pricing Information
*/
export interface Schema$Pricing {
/**
* Cap cost type of this inventory item.
*/
capCostType?: string | null;
/**
* End date of this inventory item.
*/
endDate?: string | null;
/**
* Flights of this inventory item. A flight (a.k.a. pricing period) represents the inventory item pricing information for a specific period of time.
*/
flights?: Schema$Flight[];
/**
* Group type of this inventory item if it represents a placement group. Is null otherwise. There are two type of placement groups: PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE is a simple group of inventory items that acts as a single pricing point for a group of tags. PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK is a group of inventory items that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned inventory items to be marked as primary.
*/
groupType?: string | null;
/**
* Pricing type of this inventory item.
*/
pricingType?: string | null;
/**
* Start date of this inventory item.
*/
startDate?: string | null;
}
/**
* Pricing Schedule
*/
export interface Schema$PricingSchedule {
/**
* Placement cap cost option.
*/
capCostOption?: string | null;
/**
* Whether cap costs are ignored by ad serving.
*/
disregardOverdelivery?: boolean | null;
/**
* Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion.
*/
endDate?: string | null;
/**
* Whether this placement is flighted. If true, pricing periods will be computed automatically.
*/
flighted?: boolean | null;
/**
* Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
*/
floodlightActivityId?: string | null;
/**
* Pricing periods for this placement.
*/
pricingPeriods?: Schema$PricingSchedulePricingPeriod[];
/**
* Placement pricing type. This field is required on insertion.
*/
pricingType?: string | null;
/**
* Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion.
*/
startDate?: string | null;
/**
* Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
*/
testingStartDate?: string | null;
}
/**
* Pricing Period
*/
export interface Schema$PricingSchedulePricingPeriod {
/**
* Pricing period end date. This date must be later than, or the same day as, the pricing period start date, but not later than the placement end date. The period end date can be the same date as the period start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective pricing period date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error.
*/
endDate?: string | null;
/**
* Comments for this pricing period.
*/
pricingComment?: string | null;
/**
* Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.
*/
rateOrCostNanos?: string | null;
/**
* Pricing period start date. This date must be later than, or the same day as, the placement start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error.
*/
startDate?: string | null;
/**
* Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.
*/
units?: string | null;
}
/**
* Contains properties of a Planning project.
*/
export interface Schema$Project {
/**
* Account ID of this project.
*/
accountId?: string | null;
/**
* Advertiser ID of this project.
*/
advertiserId?: string | null;
/**
* Audience age group of this project.
*/
audienceAgeGroup?: string | null;
/**
* Audience gender of this project.
*/
audienceGender?: string | null;
/**
* Budget of this project in the currency specified by the current account. The value stored in this field represents only the non-fractional amount. For example, for USD, the smallest value that can be represented by this field is 1 US dollar.
*/
budget?: string | null;
/**
* Client billing code of this project.
*/
clientBillingCode?: string | null;
/**
* Name of the project client.
*/
clientName?: string | null;
/**
* End date of the project.
*/
endDate?: string | null;
/**
* ID of this project. This is a read-only, auto-generated field.
*/
id?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#project".
*/
kind?: string | null;
/**
* Information about the most recent modification of this project.
*/
lastModifiedInfo?: Schema$LastModifiedInfo;
/**
* Name of this project.
*/
name?: string | null;
/**
* Overview of this project.
*/
overview?: string | null;
/**
* Start date of the project.
*/
startDate?: string | null;
/**
* Subaccount ID of this project.
*/
subaccountId?: string | null;
/**
* Number of clicks that the advertiser is targeting.
*/
targetClicks?: string | null;
/**
* Number of conversions that the advertiser is targeting.
*/
targetConversions?: string | null;
/**
* CPA that the advertiser is targeting.
*/
targetCpaNanos?: string | null;
/**
* CPC that the advertiser is targeting.
*/
targetCpcNanos?: string | null;
/**
* vCPM from Active View that the advertiser is targeting.
*/
targetCpmActiveViewNanos?: string | null;
/**
* CPM that the advertiser is targeting.
*/
targetCpmNanos?: string | null;
/**
* Number of impressions that the advertiser is targeting.
*/
targetImpressions?: string | null;
}
/**
* Project List Response
*/
export interface Schema$ProjectsListResponse {
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#projectsListResponse".
*/
kind?: string | null;
/**
* Pagination token to be used for the next list operation.
*/
nextPageToken?: string | null;
/**
* Project collection.
*/
projects?: Schema$Project[];
}
/**
* Represents fields that are compatible to be selected for a report of type "REACH".
*/
export interface Schema$ReachReportCompatibleFields {
/**
* Dimensions which are compatible to be selected in the "dimensionFilters" section of the report.
*/
dimensionFilters?: Schema$Dimension[];
/**
* Dimensions which are compatible to be selected in the "dimensions" section of the report.
*/
dimensions?: Schema$Dimension[];
/**
* The kind of resource this is, in this case dfareporting#reachReportCompatibleFields.
*/
kind?: string | null;
/**
* Metrics which are compatible to be selected in the "metricNames" section of the report.
*/
metrics?: Schema$Metric[];
/**
* Metrics which are compatible to be selected as activity metrics to pivot on in the "activities" section of the report.
*/
pivotedActivityMetrics?: Schema$Metric[];
/**
* Metrics which are compatible to be selected in the "reachByFrequencyMetricNames" section of the report.
*/
reachByFrequencyMetrics?: Schema$Metric[];
}
/**
* Represents a recipient.
*/
export interface Schema$Recipient {
/**
* The delivery type for the recipient.
*/
deliveryType?: string | null;
/**
* The email address of the recipient.
*/
email?: string | null;
/**
* The kind of resource this is, in this case dfareporting#recipient.
*/
kind?: string | null;
}
/**
* Contains information about a region that can be targeted by ads.
*/
export interface Schema$Region {
/**
* Country code of the country to which this region belongs.
*/
countryCode?: string | null;
/**
* DART ID of the country to which this region belongs.
*/
countryDartId?: string | null;
/**
* DART ID of this region.
*/
dartId?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
*/
kind?: string | null;
/**
* Name of this region.
*/
name?: string | null;
/**
* Region code.
*/
regionCode?: string | null;
}
/**
* Region List Response
*/
export interface Schema$RegionsListResponse {
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#regionsListResponse".
*/
kind?: string | null;
/**
* Region collection.
*/
regions?: Schema$Region[];
}
/**
* Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.
*/
export interface Schema$RemarketingList {
/**
* Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
*/
accountId?: string | null;
/**
* Whether this remarketing list is active.
*/
active?: boolean | null;
/**
* Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
*/
advertiserId?: string | null;
/**
* Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
*/
advertiserIdDimensionValue?: Schema$DimensionValue;
/**
* Remarketing list description.
*/
description?: string | null;
/**
* Remarketing list ID. This is a read-only, auto-generated field.
*/
id?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
*/
kind?: string | null;
/**
* Number of days that a user should remain in the remarketing list without an impression. Acceptable values are 1 to 540, inclusive.
*/
lifeSpan?: string | null;
/**
* Rule used to populate the remarketing list with users.
*/
listPopulationRule?: Schema$ListPopulationRule;
/**
* Number of users currently in the list. This is a read-only field.
*/
listSize?: string | null;
/**
* Product from which this remarketing list was originated.
*/
listSource?: string | null;
/**
* Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
*/
name?: string | null;
/**
* Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
*/
subaccountId?: string | null;
}
/**
* Contains properties of a remarketing list's sharing information. Sharing allows other accounts or advertisers to target to your remarketing lists. This resource can be used to manage remarketing list sharing to other accounts and advertisers.
*/
export interface Schema$RemarketingListShare {
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListShare".
*/
kind?: string | null;
/**
* Remarketing list ID. This is a read-only, auto-generated field.
*/
remarketingListId?: string | null;
/**
* Accounts that the remarketing list is shared with.
*/
sharedAccountIds?: string[] | null;
/**
* Advertisers that the remarketing list is shared with.
*/
sharedAdvertiserIds?: string[] | null;
}
/**
* Remarketing list response
*/
export interface Schema$RemarketingListsListResponse {
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListsListResponse".
*/
kind?: string | null;
/**
* Pagination token to be used for the next list operation.
*/
nextPageToken?: string | null;
/**
* Remarketing list collection.
*/
remarketingLists?: Schema$RemarketingList[];
}
/**
* Represents a Report resource.
*/
export interface Schema$Report {
/**
* The account ID to which this report belongs.
*/
accountId?: string | null;
/**
* The report criteria for a report of type "STANDARD".
*/
criteria?: {
activities?: Schema$Activities;
customRichMediaEvents?: Schema$CustomRichMediaEvents;
dateRange?: Schema$DateRange;
dimensionFilters?: Schema$DimensionValue[];
dimensions?: Schema$SortedDimension[];
metricNames?: string[];
} | null;
/**
* The report criteria for a report of type "CROSS_DIMENSION_REACH".
*/
crossDimensionReachCriteria?: {
breakdown?: Schema$SortedDimension[];
dateRange?: Schema$DateRange;
dimension?: string;
dimensionFilters?: Schema$DimensionValue[];
metricNames?: string[];
overlapMetricNames?: string[];
pivoted?: boolean;
} | null;
/**
* The report's email delivery settings.
*/
delivery?: {
emailOwner?: boolean;
emailOwnerDeliveryType?: string;
message?: string;
recipients?: Schema$Recipient[];
} | null;
/**
* The eTag of this response for caching purposes.
*/
etag?: string | null;
/**
* The filename used when generating report files for this report.
*/
fileName?: string | null;
/**
* The report criteria for a report of type "FLOODLIGHT".
*/
floodlightCriteria?: {
customRichMediaEvents?: Schema$DimensionValue[];
dateRange?: Schema$DateRange;
dimensionFilters?: Schema$DimensionValue[];
dimensions?: Schema$SortedDimension[];
floodlightConfigId?: Schema$DimensionValue;
metricNames?: string[];
reportProperties?: {
includeAttributedIPConversions?: boolean;
includeUnattributedCookieConversions?: boolean;
includeUnattributedIPConversions?: boolean;
};
} | null;
/**
* The output format of the report. If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.
*/
format?: string | null;
/**
* The unique ID identifying this report resource.
*/
id?: string | null;
/**
* The kind of resource this is, in this case dfareporting#report.
*/
kind?: string | null;
/**
* The timestamp (in milliseconds since epoch) of when this report was last modified.
*/
lastModifiedTime?: string | null;
/**
* The name of the report.
*/
name?: string | null;
/**
* The user profile id of the owner of this report.
*/
ownerProfileId?: string | null;
/**
* The report criteria for a report of type "PATH_TO_CONVERSION".
*/
pathToConversionCriteria?: {
activityFilters?: Schema$DimensionValue[];
conversionDimensions?: Schema$SortedDimension[];
customFloodlightVariables?: Schema$SortedDimension[];
customRichMediaEvents?: Schema$DimensionValue[];
dateRange?: Schema$DateRange;
floodlightConfigId?: Schema$DimensionValue;
metricNames?: string[];
perInteractionDimensions?: Schema$SortedDimension[];
reportProperties?: {
clicksLookbackWindow?: number;
impressionsLookbackWindow?: number;
includeAttributedIPConversions?: boolean;
includeUnattributedCookieConversions?: boolean;
includeUnattributedIPConversions?: boolean;
maximumClickInteractions?: number;
maximumImpressionInteractions?: number;
maximumInteractionGap?: number;
pivotOnInteractionPath?: boolean;
};
} | null;
/**
* The report criteria for a report of type "REACH".
*/
reachCriteria?: {
activities?: Schema$Activities;
customRichMediaEvents?: Schema$CustomRichMediaEvents;
dateRange?: Schema$DateRange;
dimensionFilters?: Schema$DimensionValue[];
dimensions?: Schema$SortedDimension[];
enableAllDimensionCombinations?: boolean;
metricNames?: string[];
reachByFrequencyMetricNames?: string[];
} | null;
/**
* The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".
*/
schedule?: {
active?: boolean;
every?: number;
expirationDate?: string;
repeats?: string;
repeatsOnWeekDays?: string[];
runsOnDayOfMonth?: string;
startDate?: string;
} | null;
/**
* The subaccount ID to which this report belongs if applicable.
*/
subAccountId?: string | null;
/**
* The type of the report.
*/
type?: string | null;
}
/**
* Represents fields that are compatible to be selected for a report of type "STANDARD".
*/
export interface Schema$ReportCompatibleFields {
/**
* Dimensions which are compatible to be selected in the "dimensionFilters" section of the report.
*/
dimensionFilters?: Schema$Dimension[];
/**
* Dimensions which are compatible to be selected in the "dimensions" section of the report.
*/
dimensions?: Schema$Dimension[];
/**
* The kind of resource this is, in this case dfareporting#reportCompatibleFields.
*/
kind?: string | null;
/**
* Metrics which are compatible to be selected in the "metricNames" section of the report.
*/
metrics?: Schema$Metric[];
/**
* Metrics which are compatible to be selected as activity metrics to pivot on in the "activities" section of the report.
*/
pivotedActivityMetrics?: Schema$Metric[];
}
/**
* Represents the list of reports.
*/
export interface Schema$ReportList {
/**
* The eTag of this response for caching purposes.
*/
etag?: string | null;
/**
* The reports returned in this response.
*/
items?: Schema$Report[];
/**
* The kind of list this is, in this case dfareporting#reportList.
*/
kind?: string | null;
/**
* Continuation token used to page through reports. To retrieve the next page of results, set the next request's "pageToken" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted.
*/
nextPageToken?: string | null;
}
/**
* Reporting Configuration
*/
export interface Schema$ReportsConfiguration {
/**
* Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
*/
exposureToConversionEnabled?: boolean | null;
/**
* Default lookback windows for new advertisers in this account.
*/
lookbackConfiguration?: Schema$LookbackConfiguration;
/**
* Report generation time zone ID of this account. This is a required field that can only be changed by a superuser. Acceptable values are: - "1" for "America/New_York" - "2" for "Europe/London" - "3" for "Europe/Paris" - "4" for "Africa/Johannesburg" - "5" for "Asia/Jerusalem" - "6" for "Asia/Shanghai" - "7" for "Asia/Hong_Kong" - "8" for "Asia/Tokyo" - "9" for "Australia/Sydney" - "10" for "Asia/Dubai" - "11" for "America/Los_Angeles" - "12" for "Pacific/Auckland" - "13" for "America/Sao_Paulo"
*/
reportGenerationTimeZoneId?: string | null;
}
/**
* Rich Media Exit Override.
*/
export interface Schema$RichMediaExitOverride {
/**
* Click-through URL of this rich media exit override. Applicable if the enabled field is set to true.
*/
clickThroughUrl?: Schema$ClickThroughUrl;
/**
* Whether to use the clickThroughUrl. If false, the creative-level exit will be used.
*/
enabled?: boolean | null;
/**
* ID for the override to refer to a specific exit in the creative.
*/
exitId?: string | null;
}
/**
* A rule associates an asset with a targeting template for asset-level targeting. Applicable to INSTREAM_VIDEO creatives.
*/
export interface Schema$Rule {
/**
* A creativeAssets[].id. This should refer to one of the parent assets in this creative. This is a required field.
*/
assetId?: string | null;
/**
* A user-friendly name for this rule. This is a required field.
*/
name?: string | null;
/**
* A targeting template ID. The targeting from the targeting template will be used to determine whether this asset should be served. This is a required field.
*/
targetingTemplateId?: string | null;
}
/**
* Contains properties of a site.
*/
export interface Schema$Site {
/**
* Account ID of this site. This is a read-only field that can be left blank.
*/
accountId?: string | null;
/**
* Whether this site is approved.
*/
approved?: boolean | null;
/**
* Directory site associated with this site. This is a required field that is read-only after insertion.
*/
directorySiteId?: string | null;
/**
* Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
*/
directorySiteIdDimensionValue?: Schema$DimensionValue;
/**
* ID of this site. This is a read-only, auto-generated field.
*/
id?: string | null;
/**
* Dimension value for the ID of this site. This is a read-only, auto-generated field.
*/
idDimensionValue?: Schema$DimensionValue;
/**
* Key name of this site. This is a read-only, auto-generated field.
*/
keyName?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
*/
kind?: string | null;
/**
* Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
*/
name?: string | null;
/**
* Site contacts.
*/
siteContacts?: Schema$SiteContact[];
/**
* Site-wide settings.
*/
siteSettings?: Schema$SiteSettings;
/**
* Subaccount ID of this site. This is a read-only field that can be left blank.
*/
subaccountId?: string | null;
/**
* Default video settings for new placements created under this site. This value will be used to populate the placements.videoSettings field, when no value is specified for the new placement.
*/
videoSettings?: Schema$SiteVideoSettings;
}
/**
* Companion Settings
*/
export interface Schema$SiteCompanionSetting {
/**
* Whether companions are disabled for this site template.
*/
companionsDisabled?: boolean | null;
/**
* Whitelist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes.
*/
enabledSizes?: Schema$Size[];
/**
* Whether to serve only static images as companions.
*/
imageOnly?: boolean | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteCompanionSetting".
*/
kind?: string | null;
}
/**
* Site Contact
*/
export interface Schema$SiteContact {
/**
* Address of this site contact.
*/
address?: string | null;
/**
* Site contact type.
*/
contactType?: string | null;
/**
* Email address of this site contact. This is a required field.
*/
email?: string | null;
/**
* First name of this site contact.
*/
firstName?: string | null;
/**
* ID of this site contact. This is a read-only, auto-generated field.
*/
id?: string | null;
/**
* Last name of this site contact.
*/
lastName?: string | null;
/**
* Primary phone number of this site contact.
*/
phone?: string | null;
/**
* Title or designation of this site contact.
*/
title?: string | null;
}
/**
* Site Settings
*/
export interface Schema$SiteSettings {
/**
* Whether active view creatives are disabled for this site.
*/
activeViewOptOut?: boolean | null;
/**
* Whether this site opts out of ad blocking. When true, ad blocking is disabled for all placements under the site, regardless of the individual placement settings. When false, the campaign and placement settings take effect.
*/
adBlockingOptOut?: boolean | null;
/**
* Whether new cookies are disabled for this site.
*/
disableNewCookie?: boolean | null;
/**
* Configuration settings for dynamic and image floodlight tags.
*/
tagSetting?: Schema$TagSetting;
/**
* Whether Verification and ActiveView for in-stream video creatives are disabled by default for new placements created under this site. This value will be used to populate the placement.videoActiveViewOptOut field, when no value is specified for the new placement.
*/
videoActiveViewOptOutTemplate?: boolean | null;
/**
* Default VPAID adapter setting for new placements created under this site. This value will be used to populate the placements.vpaidAdapterChoice field, when no value is specified for the new placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to the placement. The publisher's specifications will typically determine this setting. For VPAID creatives, the adapter format will match the VPAID format (HTML5 VPAID creatives use the HTML5 adapter). Note: Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH.
*/
vpaidAdapterChoiceTemplate?: string | null;
}
/**
* Skippable Settings
*/
export interface Schema$SiteSkippableSetting {
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting".
*/
kind?: string | null;
/**
* Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true.
*/
progressOffset?: Schema$VideoOffset;
/**
* Amount of time to play videos served to this site before the skip button should appear. Applicable when skippable is true.
*/
skipOffset?: Schema$VideoOffset;
/**
* Whether the user can skip creatives served to this site. This will act as default for new placements created under this site.
*/
skippable?: boolean | null;
}
/**
* Site List Response
*/
export interface Schema$SitesListResponse {
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#sitesListResponse".
*/
kind?: string | null;
/**
* Pagination token to be used for the next list operation.
*/
nextPageToken?: string | null;
/**
* Site collection.
*/
sites?: Schema$Site[];
}
/**
* Transcode Settings
*/
export interface Schema$SiteTranscodeSetting {
/**
* Whitelist of video formats to be served to this site template. Set this list to null or empty to serve all video formats.
*/
enabledVideoFormats?: number[] | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteTranscodeSetting".
*/
kind?: string | null;
}
/**
* Video Settings
*/
export interface Schema$SiteVideoSettings {
/**
* Settings for the companion creatives of video creatives served to this site.
*/
companionSettings?: Schema$SiteCompanionSetting;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteVideoSettings".
*/
kind?: string | null;
/**
* Orientation of a site template used for video. This will act as default for new placements created under this site.
*/
orientation?: string | null;
/**
* Settings for the skippability of video creatives served to this site. This will act as default for new placements created under this site.
*/
skippableSettings?: Schema$SiteSkippableSetting;
/**
* Settings for the transcodes of video creatives served to this site. This will act as default for new placements created under this site.
*/
transcodeSettings?: Schema$SiteTranscodeSetting;
}
/**
* Represents the dimensions of ads, placements, creatives, or creative assets.
*/
export interface Schema$Size {
/**
* Height of this size. Acceptable values are 0 to 32767, inclusive.
*/
height?: number | null;
/**
* IAB standard size. This is a read-only, auto-generated field.
*/
iab?: boolean | null;
/**
* ID of this size. This is a read-only, auto-generated field.
*/
id?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
*/
kind?: string | null;
/**
* Width of this size. Acceptable values are 0 to 32767, inclusive.
*/
width?: number | null;
}
/**
* Size List Response
*/
export interface Schema$SizesListResponse {
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#sizesListResponse".
*/
kind?: string | null;
/**
* Size collection.
*/
sizes?: Schema$Size[];
}
/**
* Skippable Settings
*/
export interface Schema$SkippableSetting {
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#skippableSetting".
*/
kind?: string | null;
/**
* Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true.
*/
progressOffset?: Schema$VideoOffset;
/**
* Amount of time to play videos served to this placement before the skip button should appear. Applicable when skippable is true.
*/
skipOffset?: Schema$VideoOffset;
/**
* Whether the user can skip creatives served to this placement.
*/
skippable?: boolean | null;
}
/**
* Represents a sorted dimension.
*/
export interface Schema$SortedDimension {
/**
* The kind of resource this is, in this case dfareporting#sortedDimension.
*/
kind?: string | null;
/**
* The name of the dimension.
*/
name?: string | null;
/**
* An optional sort order for the dimension column.
*/
sortOrder?: string | null;
}
/**
* Contains properties of a Campaign Manager subaccount.
*/
export interface Schema$Subaccount {
/**
* ID of the account that contains this subaccount. This is a read-only field that can be left blank.
*/
accountId?: string | null;
/**
* IDs of the available user role permissions for this subaccount.
*/
availablePermissionIds?: string[] | null;
/**
* ID of this subaccount. This is a read-only, auto-generated field.
*/
id?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
*/
kind?: string | null;
/**
* Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
*/
name?: string | null;
}
/**
* Subaccount List Response
*/
export interface Schema$SubaccountsListResponse {
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccountsListResponse".
*/
kind?: string | null;
/**
* Pagination token to be used for the next list operation.
*/
nextPageToken?: string | null;
/**
* Subaccount collection.
*/
subaccounts?: Schema$Subaccount[];
}
/**
* Placement Tag Data
*/
export interface Schema$TagData {
/**
* Ad associated with this placement tag. Applicable only when format is PLACEMENT_TAG_TRACKING.
*/
adId?: string | null;
/**
* Tag string to record a click.
*/
clickTag?: string | null;
/**
* Creative associated with this placement tag. Applicable only when format is PLACEMENT_TAG_TRACKING.
*/
creativeId?: string | null;
/**
* TagData tag format of this tag.
*/
format?: string | null;
/**
* Tag string for serving an ad.
*/
impressionTag?: string | null;
}
/**
* Tag Settings
*/
export interface Schema$TagSetting {
/**
* Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
*/
additionalKeyValues?: string | null;
/**
* Whether static landing page URLs should be included in the tags. This setting applies only to placements.
*/
includeClickThroughUrls?: boolean | null;
/**
* Whether click-tracking string should be included in the tags.
*/
includeClickTracking?: boolean | null;
/**
* Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
*/
keywordOption?: string | null;
}
/**
* Dynamic and Image Tag Settings.
*/
export interface Schema$TagSettings {
/**
* Whether dynamic floodlight tags are enabled.
*/
dynamicTagEnabled?: boolean | null;
/**
* Whether image tags are enabled.
*/
imageTagEnabled?: boolean | null;
}
/**
* Contains properties of a targetable remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource is a read-only view of a remarketing list to be used to faciliate targeting ads to specific lists. Remarketing lists that are owned by your advertisers and those that are shared to your advertisers or account are accessible via this resource. To manage remarketing lists that are owned by your advertisers, use the RemarketingLists resource.
*/
export interface Schema$TargetableRemarketingList {
/**
* Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
*/
accountId?: string | null;
/**
* Whether this targetable remarketing list is active.
*/
active?: boolean | null;
/**
* Dimension value for the advertiser ID that owns this targetable remarketing list.
*/
advertiserId?: string | null;
/**
* Dimension value for the ID of the advertiser.
*/
advertiserIdDimensionValue?: Schema$DimensionValue;
/**
* Targetable remarketing list description.
*/
description?: string | null;
/**
* Targetable remarketing list ID.
*/
id?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetableRemarketingList".
*/
kind?: string | null;
/**
* Number of days that a user should remain in the targetable remarketing list without an impression.
*/
lifeSpan?: string | null;
/**
* Number of users currently in the list. This is a read-only field.
*/
listSize?: string | null;
/**
* Product from which this targetable remarketing list was originated.
*/
listSource?: string | null;
/**
* Name of the targetable remarketing list. Is no greater than 128 characters long.
*/
name?: string | null;
/**
* Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
*/
subaccountId?: string | null;
}
/**
* Targetable remarketing list response
*/
export interface Schema$TargetableRemarketingListsListResponse {
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetableRemarketingListsListResponse".
*/
kind?: string | null;
/**
* Pagination token to be used for the next list operation.
*/
nextPageToken?: string | null;
/**
* Targetable remarketing list collection.
*/
targetableRemarketingLists?: Schema$TargetableRemarketingList[];
}
/**
* Contains properties of a targeting template. A targeting template encapsulates targeting information which can be reused across multiple ads.
*/
export interface Schema$TargetingTemplate {
/**
* Account ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert.
*/
accountId?: string | null;
/**
* Advertiser ID of this targeting template. This is a required field on insert and is read-only after insert.
*/
advertiserId?: string | null;
/**
* Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
*/
advertiserIdDimensionValue?: Schema$DimensionValue;
/**
* Time and day targeting criteria.
*/
dayPartTargeting?: Schema$DayPartTargeting;
/**
* Geographical targeting criteria.
*/
geoTargeting?: Schema$GeoTargeting;
/**
* ID of this targeting template. This is a read-only, auto-generated field.
*/
id?: string | null;
/**
* Key-value targeting criteria.
*/
keyValueTargetingExpression?: Schema$KeyValueTargetingExpression;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplate".
*/
kind?: string | null;
/**
* Language targeting criteria.
*/
languageTargeting?: Schema$LanguageTargeting;
/**
* Remarketing list targeting criteria.
*/
listTargetingExpression?: Schema$ListTargetingExpression;
/**
* Name of this targeting template. This field is required. It must be less than 256 characters long and unique within an advertiser.
*/
name?: string | null;
/**
* Subaccount ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert.
*/
subaccountId?: string | null;
/**
* Technology platform targeting criteria.
*/
technologyTargeting?: Schema$TechnologyTargeting;
}
/**
* Targeting Template List Response
*/
export interface Schema$TargetingTemplatesListResponse {
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplatesListResponse".
*/
kind?: string | null;
/**
* Pagination token to be used for the next list operation.
*/
nextPageToken?: string | null;
/**
* Targeting template collection.
*/
targetingTemplates?: Schema$TargetingTemplate[];
}
/**
* Target Window.
*/
export interface Schema$TargetWindow {
/**
* User-entered value.
*/
customHtml?: string | null;
/**
* Type of browser window for which the backup image of the flash creative can be displayed.
*/
targetWindowOption?: string | null;
}
/**
* Technology Targeting.
*/
export interface Schema$TechnologyTargeting {
/**
* Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
*/
browsers?: Schema$Browser[];
/**
* Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
*/
connectionTypes?: Schema$ConnectionType[];
/**
* Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
*/
mobileCarriers?: Schema$MobileCarrier[];
/**
* Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
*/
operatingSystems?: Schema$OperatingSystem[];
/**
* Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
*/
operatingSystemVersions?: Schema$OperatingSystemVersion[];
/**
* Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
*/
platformTypes?: Schema$PlatformType[];
}
/**
* Third Party Authentication Token
*/
export interface Schema$ThirdPartyAuthenticationToken {
/**
* Name of the third-party authentication token.
*/
name?: string | null;
/**
* Value of the third-party authentication token. This is a read-only, auto-generated field.
*/
value?: string | null;
}
/**
* Third-party Tracking URL.
*/
export interface Schema$ThirdPartyTrackingUrl {
/**
* Third-party URL type for in-stream video and in-stream audio creatives.
*/
thirdPartyUrlType?: string | null;
/**
* URL for the specified third-party URL type.
*/
url?: string | null;
}
/**
* Transcode Settings
*/
export interface Schema$TranscodeSetting {
/**
* Whitelist of video formats to be served to this placement. Set this list to null or empty to serve all video formats.
*/
enabledVideoFormats?: number[] | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#transcodeSetting".
*/
kind?: string | null;
}
/**
* A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID.
*/
export interface Schema$UniversalAdId {
/**
* Registry used for the Ad ID value.
*/
registry?: string | null;
/**
* ID value for this creative. Only alphanumeric characters and the following symbols are valid: "_/\-". Maximum length is 64 characters. Read only when registry is DCM.
*/
value?: string | null;
}
/**
* User Defined Variable configuration.
*/
export interface Schema$UserDefinedVariableConfiguration {
/**
* Data type for the variable. This is a required field.
*/
dataType?: string | null;
/**
* User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
*/
reportName?: string | null;
/**
* Variable name in the tag. This is a required field.
*/
variableType?: string | null;
}
/**
* Represents a UserProfile resource.
*/
export interface Schema$UserProfile {
/**
* The account ID to which this profile belongs.
*/
accountId?: string | null;
/**
* The account name this profile belongs to.
*/
accountName?: string | null;
/**
* The eTag of this response for caching purposes.
*/
etag?: string | null;
/**
* The kind of resource this is, in this case dfareporting#userProfile.
*/
kind?: string | null;
/**
* The unique ID of the user profile.
*/
profileId?: string | null;
/**
* The sub account ID this profile belongs to if applicable.
*/
subAccountId?: string | null;
/**
* The sub account name this profile belongs to if applicable.
*/
subAccountName?: string | null;
/**
* The user name.
*/
userName?: string | null;
}
/**
* Represents the list of user profiles.
*/
export interface Schema$UserProfileList {
/**
* The eTag of this response for caching purposes.
*/
etag?: string | null;
/**
* The user profiles returned in this response.
*/
items?: Schema$UserProfile[];
/**
* The kind of list this is, in this case dfareporting#userProfileList.
*/
kind?: string | null;
}
/**
* Contains properties of auser role, which is used to manage user access.
*/
export interface Schema$UserRole {
/**
* Account ID of this user role. This is a read-only field that can be left blank.
*/
accountId?: string | null;
/**
* Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
*/
defaultUserRole?: boolean | null;
/**
* ID of this user role. This is a read-only, auto-generated field.
*/
id?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
*/
kind?: string | null;
/**
* Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
*/
name?: string | null;
/**
* ID of the user role that this user role is based on or copied from. This is a required field.
*/
parentUserRoleId?: string | null;
/**
* List of permissions associated with this user role.
*/
permissions?: Schema$UserRolePermission[];
/**
* Subaccount ID of this user role. This is a read-only field that can be left blank.
*/
subaccountId?: string | null;
}
/**
* Contains properties of a user role permission.
*/
export interface Schema$UserRolePermission {
/**
* Levels of availability for a user role permission.
*/
availability?: string | null;
/**
* ID of this user role permission.
*/
id?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
*/
kind?: string | null;
/**
* Name of this user role permission.
*/
name?: string | null;
/**
* ID of the permission group that this user role permission belongs to.
*/
permissionGroupId?: string | null;
}
/**
* Represents a grouping of related user role permissions.
*/
export interface Schema$UserRolePermissionGroup {
/**
* ID of this user role permission.
*/
id?: string | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionGroup".
*/
kind?: string | null;
/**
* Name of this user role permission group.
*/
name?: string | null;
}
/**
* User Role Permission Group List Response
*/
export interface Schema$UserRolePermissionGroupsListResponse {
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionGroupsListResponse".
*/
kind?: string | null;
/**
* User role permission group collection.
*/
userRolePermissionGroups?: Schema$UserRolePermissionGroup[];
}
/**
* User Role Permission List Response
*/
export interface Schema$UserRolePermissionsListResponse {
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionsListResponse".
*/
kind?: string | null;
/**
* User role permission collection.
*/
userRolePermissions?: Schema$UserRolePermission[];
}
/**
* User Role List Response
*/
export interface Schema$UserRolesListResponse {
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolesListResponse".
*/
kind?: string | null;
/**
* Pagination token to be used for the next list operation.
*/
nextPageToken?: string | null;
/**
* User role collection.
*/
userRoles?: Schema$UserRole[];
}
/**
* Contains information about supported video formats.
*/
export interface Schema$VideoFormat {
/**
* File type of the video format.
*/
fileType?: string | null;
/**
* ID of the video format.
*/
id?: number | null;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoFormat".
*/
kind?: string | null;
/**
* The resolution of this video format.
*/
resolution?: Schema$Size;
/**
* The target bit rate of this video format.
*/
targetBitRate?: number | null;
}
/**
* Video Format List Response
*/
export interface Schema$VideoFormatsListResponse {
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoFormatsListResponse".
*/
kind?: string | null;
/**
* Video format collection.
*/
videoFormats?: Schema$VideoFormat[];
}
/**
* Video Offset
*/
export interface Schema$VideoOffset {
/**
* Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
*/
offsetPercentage?: number | null;
/**
* Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
*/
offsetSeconds?: number | null;
}
/**
* Video Settings
*/
export interface Schema$VideoSettings {
/**
* Settings for the companion creatives of video creatives served to this placement.
*/
companionSettings?: Schema$CompanionSetting;
/**
* Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoSettings".
*/
kind?: string | null;
/**
* Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation.
*/
orientation?: string | null;
/**
* Settings for the skippability of video creatives served to this placement. If this object is provided, the creative-level skippable settings will be overridden.
*/
skippableSettings?: Schema$SkippableSetting;
/**
* Settings for the transcodes of video creatives served to this placement. If this object is provided, the creative-level transcode settings will be overridden.
*/
transcodeSettings?: Schema$TranscodeSetting;
}
export class Resource$Accountactiveadsummaries {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.accountActiveAdSummaries.get
* @desc Gets the account's active ad summary by account ID.
* @alias dfareporting.accountActiveAdSummaries.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {string} params.summaryAccountId Account ID.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Accountactiveadsummaries$Get, options?: MethodOptions): GaxiosPromise<Schema$AccountActiveAdSummary>;
get(params: Params$Resource$Accountactiveadsummaries$Get, options: MethodOptions | BodyResponseCallback<Schema$AccountActiveAdSummary>, callback: BodyResponseCallback<Schema$AccountActiveAdSummary>): void;
get(params: Params$Resource$Accountactiveadsummaries$Get, callback: BodyResponseCallback<Schema$AccountActiveAdSummary>): void;
get(callback: BodyResponseCallback<Schema$AccountActiveAdSummary>): void;
}
export interface Params$Resource$Accountactiveadsummaries$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Account ID.
*/
summaryAccountId?: string;
}
export class Resource$Accountpermissiongroups {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.accountPermissionGroups.get
* @desc Gets one account permission group by ID.
* @alias dfareporting.accountPermissionGroups.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Account permission group ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Accountpermissiongroups$Get, options?: MethodOptions): GaxiosPromise<Schema$AccountPermissionGroup>;
get(params: Params$Resource$Accountpermissiongroups$Get, options: MethodOptions | BodyResponseCallback<Schema$AccountPermissionGroup>, callback: BodyResponseCallback<Schema$AccountPermissionGroup>): void;
get(params: Params$Resource$Accountpermissiongroups$Get, callback: BodyResponseCallback<Schema$AccountPermissionGroup>): void;
get(callback: BodyResponseCallback<Schema$AccountPermissionGroup>): void;
/**
* dfareporting.accountPermissionGroups.list
* @desc Retrieves the list of account permission groups.
* @alias dfareporting.accountPermissionGroups.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Accountpermissiongroups$List, options?: MethodOptions): GaxiosPromise<Schema$AccountPermissionGroupsListResponse>;
list(params: Params$Resource$Accountpermissiongroups$List, options: MethodOptions | BodyResponseCallback<Schema$AccountPermissionGroupsListResponse>, callback: BodyResponseCallback<Schema$AccountPermissionGroupsListResponse>): void;
list(params: Params$Resource$Accountpermissiongroups$List, callback: BodyResponseCallback<Schema$AccountPermissionGroupsListResponse>): void;
list(callback: BodyResponseCallback<Schema$AccountPermissionGroupsListResponse>): void;
}
export interface Params$Resource$Accountpermissiongroups$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Account permission group ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export interface Params$Resource$Accountpermissiongroups$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export class Resource$Accountpermissions {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.accountPermissions.get
* @desc Gets one account permission by ID.
* @alias dfareporting.accountPermissions.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Account permission ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Accountpermissions$Get, options?: MethodOptions): GaxiosPromise<Schema$AccountPermission>;
get(params: Params$Resource$Accountpermissions$Get, options: MethodOptions | BodyResponseCallback<Schema$AccountPermission>, callback: BodyResponseCallback<Schema$AccountPermission>): void;
get(params: Params$Resource$Accountpermissions$Get, callback: BodyResponseCallback<Schema$AccountPermission>): void;
get(callback: BodyResponseCallback<Schema$AccountPermission>): void;
/**
* dfareporting.accountPermissions.list
* @desc Retrieves the list of account permissions.
* @alias dfareporting.accountPermissions.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Accountpermissions$List, options?: MethodOptions): GaxiosPromise<Schema$AccountPermissionsListResponse>;
list(params: Params$Resource$Accountpermissions$List, options: MethodOptions | BodyResponseCallback<Schema$AccountPermissionsListResponse>, callback: BodyResponseCallback<Schema$AccountPermissionsListResponse>): void;
list(params: Params$Resource$Accountpermissions$List, callback: BodyResponseCallback<Schema$AccountPermissionsListResponse>): void;
list(callback: BodyResponseCallback<Schema$AccountPermissionsListResponse>): void;
}
export interface Params$Resource$Accountpermissions$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Account permission ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export interface Params$Resource$Accountpermissions$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export class Resource$Accounts {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.accounts.get
* @desc Gets one account by ID.
* @alias dfareporting.accounts.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Account ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Accounts$Get, options?: MethodOptions): GaxiosPromise<Schema$Account>;
get(params: Params$Resource$Accounts$Get, options: MethodOptions | BodyResponseCallback<Schema$Account>, callback: BodyResponseCallback<Schema$Account>): void;
get(params: Params$Resource$Accounts$Get, callback: BodyResponseCallback<Schema$Account>): void;
get(callback: BodyResponseCallback<Schema$Account>): void;
/**
* dfareporting.accounts.list
* @desc Retrieves the list of accounts, possibly filtered. This method supports paging.
* @alias dfareporting.accounts.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.active Select only active accounts. Don't set this field to select both active and non-active accounts.
* @param {string=} params.ids Select only accounts with these IDs.
* @param {integer=} params.maxResults Maximum number of results to return.
* @param {string=} params.pageToken Value of the nextPageToken from the previous result page.
* @param {string} params.profileId User profile ID associated with this request.
* @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "account*2015" will return objects with names like "account June 2015", "account April 2015", or simply "account 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "account" will match objects with name "my account", "account 2015", or simply "account".
* @param {string=} params.sortField Field by which to sort the list.
* @param {string=} params.sortOrder Order of sorted results.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Accounts$List, options?: MethodOptions): GaxiosPromise<Schema$AccountsListResponse>;
list(params: Params$Resource$Accounts$List, options: MethodOptions | BodyResponseCallback<Schema$AccountsListResponse>, callback: BodyResponseCallback<Schema$AccountsListResponse>): void;
list(params: Params$Resource$Accounts$List, callback: BodyResponseCallback<Schema$AccountsListResponse>): void;
list(callback: BodyResponseCallback<Schema$AccountsListResponse>): void;
/**
* dfareporting.accounts.patch
* @desc Updates an existing account. This method supports patch semantics.
* @alias dfareporting.accounts.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Account ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {().Account} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Accounts$Patch, options?: MethodOptions): GaxiosPromise<Schema$Account>;
patch(params: Params$Resource$Accounts$Patch, options: MethodOptions | BodyResponseCallback<Schema$Account>, callback: BodyResponseCallback<Schema$Account>): void;
patch(params: Params$Resource$Accounts$Patch, callback: BodyResponseCallback<Schema$Account>): void;
patch(callback: BodyResponseCallback<Schema$Account>): void;
/**
* dfareporting.accounts.update
* @desc Updates an existing account.
* @alias dfareporting.accounts.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {().Account} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update(params?: Params$Resource$Accounts$Update, options?: MethodOptions): GaxiosPromise<Schema$Account>;
update(params: Params$Resource$Accounts$Update, options: MethodOptions | BodyResponseCallback<Schema$Account>, callback: BodyResponseCallback<Schema$Account>): void;
update(params: Params$Resource$Accounts$Update, callback: BodyResponseCallback<Schema$Account>): void;
update(callback: BodyResponseCallback<Schema$Account>): void;
}
export interface Params$Resource$Accounts$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Account ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export interface Params$Resource$Accounts$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Select only active accounts. Don't set this field to select both active and non-active accounts.
*/
active?: boolean;
/**
* Select only accounts with these IDs.
*/
ids?: string[];
/**
* Maximum number of results to return.
*/
maxResults?: number;
/**
* Value of the nextPageToken from the previous result page.
*/
pageToken?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "account*2015" will return objects with names like "account June 2015", "account April 2015", or simply "account 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "account" will match objects with name "my account", "account 2015", or simply "account".
*/
searchString?: string;
/**
* Field by which to sort the list.
*/
sortField?: string;
/**
* Order of sorted results.
*/
sortOrder?: string;
}
export interface Params$Resource$Accounts$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Account ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Account;
}
export interface Params$Resource$Accounts$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Account;
}
export class Resource$Accountuserprofiles {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.accountUserProfiles.get
* @desc Gets one account user profile by ID.
* @alias dfareporting.accountUserProfiles.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id User profile ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Accountuserprofiles$Get, options?: MethodOptions): GaxiosPromise<Schema$AccountUserProfile>;
get(params: Params$Resource$Accountuserprofiles$Get, options: MethodOptions | BodyResponseCallback<Schema$AccountUserProfile>, callback: BodyResponseCallback<Schema$AccountUserProfile>): void;
get(params: Params$Resource$Accountuserprofiles$Get, callback: BodyResponseCallback<Schema$AccountUserProfile>): void;
get(callback: BodyResponseCallback<Schema$AccountUserProfile>): void;
/**
* dfareporting.accountUserProfiles.insert
* @desc Inserts a new account user profile.
* @alias dfareporting.accountUserProfiles.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {().AccountUserProfile} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
insert(params?: Params$Resource$Accountuserprofiles$Insert, options?: MethodOptions): GaxiosPromise<Schema$AccountUserProfile>;
insert(params: Params$Resource$Accountuserprofiles$Insert, options: MethodOptions | BodyResponseCallback<Schema$AccountUserProfile>, callback: BodyResponseCallback<Schema$AccountUserProfile>): void;
insert(params: Params$Resource$Accountuserprofiles$Insert, callback: BodyResponseCallback<Schema$AccountUserProfile>): void;
insert(callback: BodyResponseCallback<Schema$AccountUserProfile>): void;
/**
* dfareporting.accountUserProfiles.list
* @desc Retrieves a list of account user profiles, possibly filtered. This method supports paging.
* @alias dfareporting.accountUserProfiles.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.active Select only active user profiles.
* @param {string=} params.ids Select only user profiles with these IDs.
* @param {integer=} params.maxResults Maximum number of results to return.
* @param {string=} params.pageToken Value of the nextPageToken from the previous result page.
* @param {string} params.profileId User profile ID associated with this request.
* @param {string=} params.searchString Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, "user profile*2015" will return objects with names like "user profile June 2015", "user profile April 2015", or simply "user profile 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "user profile" will match objects with name "my user profile", "user profile 2015", or simply "user profile".
* @param {string=} params.sortField Field by which to sort the list.
* @param {string=} params.sortOrder Order of sorted results.
* @param {string=} params.subaccountId Select only user profiles with the specified subaccount ID.
* @param {string=} params.userRoleId Select only user profiles with the specified user role ID.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Accountuserprofiles$List, options?: MethodOptions): GaxiosPromise<Schema$AccountUserProfilesListResponse>;
list(params: Params$Resource$Accountuserprofiles$List, options: MethodOptions | BodyResponseCallback<Schema$AccountUserProfilesListResponse>, callback: BodyResponseCallback<Schema$AccountUserProfilesListResponse>): void;
list(params: Params$Resource$Accountuserprofiles$List, callback: BodyResponseCallback<Schema$AccountUserProfilesListResponse>): void;
list(callback: BodyResponseCallback<Schema$AccountUserProfilesListResponse>): void;
/**
* dfareporting.accountUserProfiles.patch
* @desc Updates an existing account user profile. This method supports patch semantics.
* @alias dfareporting.accountUserProfiles.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id User profile ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {().AccountUserProfile} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Accountuserprofiles$Patch, options?: MethodOptions): GaxiosPromise<Schema$AccountUserProfile>;
patch(params: Params$Resource$Accountuserprofiles$Patch, options: MethodOptions | BodyResponseCallback<Schema$AccountUserProfile>, callback: BodyResponseCallback<Schema$AccountUserProfile>): void;
patch(params: Params$Resource$Accountuserprofiles$Patch, callback: BodyResponseCallback<Schema$AccountUserProfile>): void;
patch(callback: BodyResponseCallback<Schema$AccountUserProfile>): void;
/**
* dfareporting.accountUserProfiles.update
* @desc Updates an existing account user profile.
* @alias dfareporting.accountUserProfiles.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {().AccountUserProfile} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update(params?: Params$Resource$Accountuserprofiles$Update, options?: MethodOptions): GaxiosPromise<Schema$AccountUserProfile>;
update(params: Params$Resource$Accountuserprofiles$Update, options: MethodOptions | BodyResponseCallback<Schema$AccountUserProfile>, callback: BodyResponseCallback<Schema$AccountUserProfile>): void;
update(params: Params$Resource$Accountuserprofiles$Update, callback: BodyResponseCallback<Schema$AccountUserProfile>): void;
update(callback: BodyResponseCallback<Schema$AccountUserProfile>): void;
}
export interface Params$Resource$Accountuserprofiles$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export interface Params$Resource$Accountuserprofiles$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$AccountUserProfile;
}
export interface Params$Resource$Accountuserprofiles$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Select only active user profiles.
*/
active?: boolean;
/**
* Select only user profiles with these IDs.
*/
ids?: string[];
/**
* Maximum number of results to return.
*/
maxResults?: number;
/**
* Value of the nextPageToken from the previous result page.
*/
pageToken?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, "user profile*2015" will return objects with names like "user profile June 2015", "user profile April 2015", or simply "user profile 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "user profile" will match objects with name "my user profile", "user profile 2015", or simply "user profile".
*/
searchString?: string;
/**
* Field by which to sort the list.
*/
sortField?: string;
/**
* Order of sorted results.
*/
sortOrder?: string;
/**
* Select only user profiles with the specified subaccount ID.
*/
subaccountId?: string;
/**
* Select only user profiles with the specified user role ID.
*/
userRoleId?: string;
}
export interface Params$Resource$Accountuserprofiles$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$AccountUserProfile;
}
export interface Params$Resource$Accountuserprofiles$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$AccountUserProfile;
}
export class Resource$Ads {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.ads.get
* @desc Gets one ad by ID.
* @alias dfareporting.ads.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Ad ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Ads$Get, options?: MethodOptions): GaxiosPromise<Schema$Ad>;
get(params: Params$Resource$Ads$Get, options: MethodOptions | BodyResponseCallback<Schema$Ad>, callback: BodyResponseCallback<Schema$Ad>): void;
get(params: Params$Resource$Ads$Get, callback: BodyResponseCallback<Schema$Ad>): void;
get(callback: BodyResponseCallback<Schema$Ad>): void;
/**
* dfareporting.ads.insert
* @desc Inserts a new ad.
* @alias dfareporting.ads.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {().Ad} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
insert(params?: Params$Resource$Ads$Insert, options?: MethodOptions): GaxiosPromise<Schema$Ad>;
insert(params: Params$Resource$Ads$Insert, options: MethodOptions | BodyResponseCallback<Schema$Ad>, callback: BodyResponseCallback<Schema$Ad>): void;
insert(params: Params$Resource$Ads$Insert, callback: BodyResponseCallback<Schema$Ad>): void;
insert(callback: BodyResponseCallback<Schema$Ad>): void;
/**
* dfareporting.ads.list
* @desc Retrieves a list of ads, possibly filtered. This method supports paging.
* @alias dfareporting.ads.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.active Select only active ads.
* @param {string=} params.advertiserId Select only ads with this advertiser ID.
* @param {boolean=} params.archived Select only archived ads.
* @param {string=} params.audienceSegmentIds Select only ads with these audience segment IDs.
* @param {string=} params.campaignIds Select only ads with these campaign IDs.
* @param {string=} params.compatibility Select default ads with the specified compatibility. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.
* @param {string=} params.creativeIds Select only ads with these creative IDs assigned.
* @param {string=} params.creativeOptimizationConfigurationIds Select only ads with these creative optimization configuration IDs.
* @param {boolean=} params.dynamicClickTracker Select only dynamic click trackers. Applicable when type is AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If false, select static click trackers. Leave unset to select both.
* @param {string=} params.ids Select only ads with these IDs.
* @param {string=} params.landingPageIds Select only ads with these landing page IDs.
* @param {integer=} params.maxResults Maximum number of results to return.
* @param {string=} params.overriddenEventTagId Select only ads with this event tag override ID.
* @param {string=} params.pageToken Value of the nextPageToken from the previous result page.
* @param {string=} params.placementIds Select only ads with these placement IDs assigned.
* @param {string} params.profileId User profile ID associated with this request.
* @param {string=} params.remarketingListIds Select only ads whose list targeting expression use these remarketing list IDs.
* @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "ad*2015" will return objects with names like "ad June 2015", "ad April 2015", or simply "ad 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "ad" will match objects with name "my ad", "ad 2015", or simply "ad".
* @param {string=} params.sizeIds Select only ads with these size IDs.
* @param {string=} params.sortField Field by which to sort the list.
* @param {string=} params.sortOrder Order of sorted results.
* @param {boolean=} params.sslCompliant Select only ads that are SSL-compliant.
* @param {boolean=} params.sslRequired Select only ads that require SSL.
* @param {string=} params.type Select only ads with these types.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Ads$List, options?: MethodOptions): GaxiosPromise<Schema$AdsListResponse>;
list(params: Params$Resource$Ads$List, options: MethodOptions | BodyResponseCallback<Schema$AdsListResponse>, callback: BodyResponseCallback<Schema$AdsListResponse>): void;
list(params: Params$Resource$Ads$List, callback: BodyResponseCallback<Schema$AdsListResponse>): void;
list(callback: BodyResponseCallback<Schema$AdsListResponse>): void;
/**
* dfareporting.ads.patch
* @desc Updates an existing ad. This method supports patch semantics.
* @alias dfareporting.ads.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Ad ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {().Ad} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Ads$Patch, options?: MethodOptions): GaxiosPromise<Schema$Ad>;
patch(params: Params$Resource$Ads$Patch, options: MethodOptions | BodyResponseCallback<Schema$Ad>, callback: BodyResponseCallback<Schema$Ad>): void;
patch(params: Params$Resource$Ads$Patch, callback: BodyResponseCallback<Schema$Ad>): void;
patch(callback: BodyResponseCallback<Schema$Ad>): void;
/**
* dfareporting.ads.update
* @desc Updates an existing ad.
* @alias dfareporting.ads.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {().Ad} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update(params?: Params$Resource$Ads$Update, options?: MethodOptions): GaxiosPromise<Schema$Ad>;
update(params: Params$Resource$Ads$Update, options: MethodOptions | BodyResponseCallback<Schema$Ad>, callback: BodyResponseCallback<Schema$Ad>): void;
update(params: Params$Resource$Ads$Update, callback: BodyResponseCallback<Schema$Ad>): void;
update(callback: BodyResponseCallback<Schema$Ad>): void;
}
export interface Params$Resource$Ads$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Ad ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export interface Params$Resource$Ads$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Ad;
}
export interface Params$Resource$Ads$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Select only active ads.
*/
active?: boolean;
/**
* Select only ads with this advertiser ID.
*/
advertiserId?: string;
/**
* Select only archived ads.
*/
archived?: boolean;
/**
* Select only ads with these audience segment IDs.
*/
audienceSegmentIds?: string[];
/**
* Select only ads with these campaign IDs.
*/
campaignIds?: string[];
/**
* Select default ads with the specified compatibility. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.
*/
compatibility?: string;
/**
* Select only ads with these creative IDs assigned.
*/
creativeIds?: string[];
/**
* Select only ads with these creative optimization configuration IDs.
*/
creativeOptimizationConfigurationIds?: string[];
/**
* Select only dynamic click trackers. Applicable when type is AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If false, select static click trackers. Leave unset to select both.
*/
dynamicClickTracker?: boolean;
/**
* Select only ads with these IDs.
*/
ids?: string[];
/**
* Select only ads with these landing page IDs.
*/
landingPageIds?: string[];
/**
* Maximum number of results to return.
*/
maxResults?: number;
/**
* Select only ads with this event tag override ID.
*/
overriddenEventTagId?: string;
/**
* Value of the nextPageToken from the previous result page.
*/
pageToken?: string;
/**
* Select only ads with these placement IDs assigned.
*/
placementIds?: string[];
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Select only ads whose list targeting expression use these remarketing list IDs.
*/
remarketingListIds?: string[];
/**
* Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "ad*2015" will return objects with names like "ad June 2015", "ad April 2015", or simply "ad 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "ad" will match objects with name "my ad", "ad 2015", or simply "ad".
*/
searchString?: string;
/**
* Select only ads with these size IDs.
*/
sizeIds?: string[];
/**
* Field by which to sort the list.
*/
sortField?: string;
/**
* Order of sorted results.
*/
sortOrder?: string;
/**
* Select only ads that are SSL-compliant.
*/
sslCompliant?: boolean;
/**
* Select only ads that require SSL.
*/
sslRequired?: boolean;
/**
* Select only ads with these types.
*/
type?: string[];
}
export interface Params$Resource$Ads$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Ad ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Ad;
}
export interface Params$Resource$Ads$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Ad;
}
export class Resource$Advertisergroups {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.advertiserGroups.delete
* @desc Deletes an existing advertiser group.
* @alias dfareporting.advertiserGroups.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Advertiser group ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Advertisergroups$Delete, options?: MethodOptions): GaxiosPromise<void>;
delete(params: Params$Resource$Advertisergroups$Delete, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
delete(params: Params$Resource$Advertisergroups$Delete, callback: BodyResponseCallback<void>): void;
delete(callback: BodyResponseCallback<void>): void;
/**
* dfareporting.advertiserGroups.get
* @desc Gets one advertiser group by ID.
* @alias dfareporting.advertiserGroups.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Advertiser group ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Advertisergroups$Get, options?: MethodOptions): GaxiosPromise<Schema$AdvertiserGroup>;
get(params: Params$Resource$Advertisergroups$Get, options: MethodOptions | BodyResponseCallback<Schema$AdvertiserGroup>, callback: BodyResponseCallback<Schema$AdvertiserGroup>): void;
get(params: Params$Resource$Advertisergroups$Get, callback: BodyResponseCallback<Schema$AdvertiserGroup>): void;
get(callback: BodyResponseCallback<Schema$AdvertiserGroup>): void;
/**
* dfareporting.advertiserGroups.insert
* @desc Inserts a new advertiser group.
* @alias dfareporting.advertiserGroups.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {().AdvertiserGroup} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
insert(params?: Params$Resource$Advertisergroups$Insert, options?: MethodOptions): GaxiosPromise<Schema$AdvertiserGroup>;
insert(params: Params$Resource$Advertisergroups$Insert, options: MethodOptions | BodyResponseCallback<Schema$AdvertiserGroup>, callback: BodyResponseCallback<Schema$AdvertiserGroup>): void;
insert(params: Params$Resource$Advertisergroups$Insert, callback: BodyResponseCallback<Schema$AdvertiserGroup>): void;
insert(callback: BodyResponseCallback<Schema$AdvertiserGroup>): void;
/**
* dfareporting.advertiserGroups.list
* @desc Retrieves a list of advertiser groups, possibly filtered. This method supports paging.
* @alias dfareporting.advertiserGroups.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.ids Select only advertiser groups with these IDs.
* @param {integer=} params.maxResults Maximum number of results to return.
* @param {string=} params.pageToken Value of the nextPageToken from the previous result page.
* @param {string} params.profileId User profile ID associated with this request.
* @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "advertiser*2015" will return objects with names like "advertiser group June 2015", "advertiser group April 2015", or simply "advertiser group 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "advertisergroup" will match objects with name "my advertisergroup", "advertisergroup 2015", or simply "advertisergroup".
* @param {string=} params.sortField Field by which to sort the list.
* @param {string=} params.sortOrder Order of sorted results.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Advertisergroups$List, options?: MethodOptions): GaxiosPromise<Schema$AdvertiserGroupsListResponse>;
list(params: Params$Resource$Advertisergroups$List, options: MethodOptions | BodyResponseCallback<Schema$AdvertiserGroupsListResponse>, callback: BodyResponseCallback<Schema$AdvertiserGroupsListResponse>): void;
list(params: Params$Resource$Advertisergroups$List, callback: BodyResponseCallback<Schema$AdvertiserGroupsListResponse>): void;
list(callback: BodyResponseCallback<Schema$AdvertiserGroupsListResponse>): void;
/**
* dfareporting.advertiserGroups.patch
* @desc Updates an existing advertiser group. This method supports patch semantics.
* @alias dfareporting.advertiserGroups.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Advertiser group ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {().AdvertiserGroup} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Advertisergroups$Patch, options?: MethodOptions): GaxiosPromise<Schema$AdvertiserGroup>;
patch(params: Params$Resource$Advertisergroups$Patch, options: MethodOptions | BodyResponseCallback<Schema$AdvertiserGroup>, callback: BodyResponseCallback<Schema$AdvertiserGroup>): void;
patch(params: Params$Resource$Advertisergroups$Patch, callback: BodyResponseCallback<Schema$AdvertiserGroup>): void;
patch(callback: BodyResponseCallback<Schema$AdvertiserGroup>): void;
/**
* dfareporting.advertiserGroups.update
* @desc Updates an existing advertiser group.
* @alias dfareporting.advertiserGroups.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {().AdvertiserGroup} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update(params?: Params$Resource$Advertisergroups$Update, options?: MethodOptions): GaxiosPromise<Schema$AdvertiserGroup>;
update(params: Params$Resource$Advertisergroups$Update, options: MethodOptions | BodyResponseCallback<Schema$AdvertiserGroup>, callback: BodyResponseCallback<Schema$AdvertiserGroup>): void;
update(params: Params$Resource$Advertisergroups$Update, callback: BodyResponseCallback<Schema$AdvertiserGroup>): void;
update(callback: BodyResponseCallback<Schema$AdvertiserGroup>): void;
}
export interface Params$Resource$Advertisergroups$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Advertiser group ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export interface Params$Resource$Advertisergroups$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Advertiser group ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export interface Params$Resource$Advertisergroups$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$AdvertiserGroup;
}
export interface Params$Resource$Advertisergroups$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Select only advertiser groups with these IDs.
*/
ids?: string[];
/**
* Maximum number of results to return.
*/
maxResults?: number;
/**
* Value of the nextPageToken from the previous result page.
*/
pageToken?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "advertiser*2015" will return objects with names like "advertiser group June 2015", "advertiser group April 2015", or simply "advertiser group 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "advertisergroup" will match objects with name "my advertisergroup", "advertisergroup 2015", or simply "advertisergroup".
*/
searchString?: string;
/**
* Field by which to sort the list.
*/
sortField?: string;
/**
* Order of sorted results.
*/
sortOrder?: string;
}
export interface Params$Resource$Advertisergroups$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Advertiser group ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$AdvertiserGroup;
}
export interface Params$Resource$Advertisergroups$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$AdvertiserGroup;
}
export class Resource$Advertiserlandingpages {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.advertiserLandingPages.get
* @desc Gets one landing page by ID.
* @alias dfareporting.advertiserLandingPages.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Landing page ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Advertiserlandingpages$Get, options?: MethodOptions): GaxiosPromise<Schema$LandingPage>;
get(params: Params$Resource$Advertiserlandingpages$Get, options: MethodOptions | BodyResponseCallback<Schema$LandingPage>, callback: BodyResponseCallback<Schema$LandingPage>): void;
get(params: Params$Resource$Advertiserlandingpages$Get, callback: BodyResponseCallback<Schema$LandingPage>): void;
get(callback: BodyResponseCallback<Schema$LandingPage>): void;
/**
* dfareporting.advertiserLandingPages.insert
* @desc Inserts a new landing page.
* @alias dfareporting.advertiserLandingPages.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {().LandingPage} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
insert(params?: Params$Resource$Advertiserlandingpages$Insert, options?: MethodOptions): GaxiosPromise<Schema$LandingPage>;
insert(params: Params$Resource$Advertiserlandingpages$Insert, options: MethodOptions | BodyResponseCallback<Schema$LandingPage>, callback: BodyResponseCallback<Schema$LandingPage>): void;
insert(params: Params$Resource$Advertiserlandingpages$Insert, callback: BodyResponseCallback<Schema$LandingPage>): void;
insert(callback: BodyResponseCallback<Schema$LandingPage>): void;
/**
* dfareporting.advertiserLandingPages.list
* @desc Retrieves a list of landing pages.
* @alias dfareporting.advertiserLandingPages.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.advertiserIds Select only landing pages that belong to these advertisers.
* @param {boolean=} params.archived Select only archived landing pages. Don't set this field to select both archived and non-archived landing pages.
* @param {string=} params.campaignIds Select only landing pages that are associated with these campaigns.
* @param {string=} params.ids Select only landing pages with these IDs.
* @param {integer=} params.maxResults Maximum number of results to return.
* @param {string=} params.pageToken Value of the nextPageToken from the previous result page.
* @param {string} params.profileId User profile ID associated with this request.
* @param {string=} params.searchString Allows searching for landing pages by name or ID. Wildcards (*) are allowed. For example, "landingpage*2017" will return landing pages with names like "landingpage July 2017", "landingpage March 2017", or simply "landingpage 2017". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "landingpage" will match campaigns with name "my landingpage", "landingpage 2015", or simply "landingpage".
* @param {string=} params.sortField Field by which to sort the list.
* @param {string=} params.sortOrder Order of sorted results.
* @param {string=} params.subaccountId Select only landing pages that belong to this subaccount.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Advertiserlandingpages$List, options?: MethodOptions): GaxiosPromise<Schema$AdvertiserLandingPagesListResponse>;
list(params: Params$Resource$Advertiserlandingpages$List, options: MethodOptions | BodyResponseCallback<Schema$AdvertiserLandingPagesListResponse>, callback: BodyResponseCallback<Schema$AdvertiserLandingPagesListResponse>): void;
list(params: Params$Resource$Advertiserlandingpages$List, callback: BodyResponseCallback<Schema$AdvertiserLandingPagesListResponse>): void;
list(callback: BodyResponseCallback<Schema$AdvertiserLandingPagesListResponse>): void;
/**
* dfareporting.advertiserLandingPages.patch
* @desc Updates an existing landing page. This method supports patch semantics.
* @alias dfareporting.advertiserLandingPages.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Landing page ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {().LandingPage} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Advertiserlandingpages$Patch, options?: MethodOptions): GaxiosPromise<Schema$LandingPage>;
patch(params: Params$Resource$Advertiserlandingpages$Patch, options: MethodOptions | BodyResponseCallback<Schema$LandingPage>, callback: BodyResponseCallback<Schema$LandingPage>): void;
patch(params: Params$Resource$Advertiserlandingpages$Patch, callback: BodyResponseCallback<Schema$LandingPage>): void;
patch(callback: BodyResponseCallback<Schema$LandingPage>): void;
/**
* dfareporting.advertiserLandingPages.update
* @desc Updates an existing landing page.
* @alias dfareporting.advertiserLandingPages.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {().LandingPage} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update(params?: Params$Resource$Advertiserlandingpages$Update, options?: MethodOptions): GaxiosPromise<Schema$LandingPage>;
update(params: Params$Resource$Advertiserlandingpages$Update, options: MethodOptions | BodyResponseCallback<Schema$LandingPage>, callback: BodyResponseCallback<Schema$LandingPage>): void;
update(params: Params$Resource$Advertiserlandingpages$Update, callback: BodyResponseCallback<Schema$LandingPage>): void;
update(callback: BodyResponseCallback<Schema$LandingPage>): void;
}
export interface Params$Resource$Advertiserlandingpages$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Landing page ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export interface Params$Resource$Advertiserlandingpages$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$LandingPage;
}
export interface Params$Resource$Advertiserlandingpages$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Select only landing pages that belong to these advertisers.
*/
advertiserIds?: string[];
/**
* Select only archived landing pages. Don't set this field to select both archived and non-archived landing pages.
*/
archived?: boolean;
/**
* Select only landing pages that are associated with these campaigns.
*/
campaignIds?: string[];
/**
* Select only landing pages with these IDs.
*/
ids?: string[];
/**
* Maximum number of results to return.
*/
maxResults?: number;
/**
* Value of the nextPageToken from the previous result page.
*/
pageToken?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Allows searching for landing pages by name or ID. Wildcards (*) are allowed. For example, "landingpage*2017" will return landing pages with names like "landingpage July 2017", "landingpage March 2017", or simply "landingpage 2017". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "landingpage" will match campaigns with name "my landingpage", "landingpage 2015", or simply "landingpage".
*/
searchString?: string;
/**
* Field by which to sort the list.
*/
sortField?: string;
/**
* Order of sorted results.
*/
sortOrder?: string;
/**
* Select only landing pages that belong to this subaccount.
*/
subaccountId?: string;
}
export interface Params$Resource$Advertiserlandingpages$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Landing page ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$LandingPage;
}
export interface Params$Resource$Advertiserlandingpages$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$LandingPage;
}
export class Resource$Advertisers {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.advertisers.get
* @desc Gets one advertiser by ID.
* @alias dfareporting.advertisers.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Advertiser ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Advertisers$Get, options?: MethodOptions): GaxiosPromise<Schema$Advertiser>;
get(params: Params$Resource$Advertisers$Get, options: MethodOptions | BodyResponseCallback<Schema$Advertiser>, callback: BodyResponseCallback<Schema$Advertiser>): void;
get(params: Params$Resource$Advertisers$Get, callback: BodyResponseCallback<Schema$Advertiser>): void;
get(callback: BodyResponseCallback<Schema$Advertiser>): void;
/**
* dfareporting.advertisers.insert
* @desc Inserts a new advertiser.
* @alias dfareporting.advertisers.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {().Advertiser} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
insert(params?: Params$Resource$Advertisers$Insert, options?: MethodOptions): GaxiosPromise<Schema$Advertiser>;
insert(params: Params$Resource$Advertisers$Insert, options: MethodOptions | BodyResponseCallback<Schema$Advertiser>, callback: BodyResponseCallback<Schema$Advertiser>): void;
insert(params: Params$Resource$Advertisers$Insert, callback: BodyResponseCallback<Schema$Advertiser>): void;
insert(callback: BodyResponseCallback<Schema$Advertiser>): void;
/**
* dfareporting.advertisers.list
* @desc Retrieves a list of advertisers, possibly filtered. This method supports paging.
* @alias dfareporting.advertisers.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.advertiserGroupIds Select only advertisers with these advertiser group IDs.
* @param {string=} params.floodlightConfigurationIds Select only advertisers with these floodlight configuration IDs.
* @param {string=} params.ids Select only advertisers with these IDs.
* @param {boolean=} params.includeAdvertisersWithoutGroupsOnly Select only advertisers which do not belong to any advertiser group.
* @param {integer=} params.maxResults Maximum number of results to return.
* @param {boolean=} params.onlyParent Select only advertisers which use another advertiser's floodlight configuration.
* @param {string=} params.pageToken Value of the nextPageToken from the previous result page.
* @param {string} params.profileId User profile ID associated with this request.
* @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "advertiser*2015" will return objects with names like "advertiser June 2015", "advertiser April 2015", or simply "advertiser 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "advertiser" will match objects with name "my advertiser", "advertiser 2015", or simply "advertiser".
* @param {string=} params.sortField Field by which to sort the list.
* @param {string=} params.sortOrder Order of sorted results.
* @param {string=} params.status Select only advertisers with the specified status.
* @param {string=} params.subaccountId Select only advertisers with these subaccount IDs.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Advertisers$List, options?: MethodOptions): GaxiosPromise<Schema$AdvertisersListResponse>;
list(params: Params$Resource$Advertisers$List, options: MethodOptions | BodyResponseCallback<Schema$AdvertisersListResponse>, callback: BodyResponseCallback<Schema$AdvertisersListResponse>): void;
list(params: Params$Resource$Advertisers$List, callback: BodyResponseCallback<Schema$AdvertisersListResponse>): void;
list(callback: BodyResponseCallback<Schema$AdvertisersListResponse>): void;
/**
* dfareporting.advertisers.patch
* @desc Updates an existing advertiser. This method supports patch semantics.
* @alias dfareporting.advertisers.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Advertiser ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {().Advertiser} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Advertisers$Patch, options?: MethodOptions): GaxiosPromise<Schema$Advertiser>;
patch(params: Params$Resource$Advertisers$Patch, options: MethodOptions | BodyResponseCallback<Schema$Advertiser>, callback: BodyResponseCallback<Schema$Advertiser>): void;
patch(params: Params$Resource$Advertisers$Patch, callback: BodyResponseCallback<Schema$Advertiser>): void;
patch(callback: BodyResponseCallback<Schema$Advertiser>): void;
/**
* dfareporting.advertisers.update
* @desc Updates an existing advertiser.
* @alias dfareporting.advertisers.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {().Advertiser} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update(params?: Params$Resource$Advertisers$Update, options?: MethodOptions): GaxiosPromise<Schema$Advertiser>;
update(params: Params$Resource$Advertisers$Update, options: MethodOptions | BodyResponseCallback<Schema$Advertiser>, callback: BodyResponseCallback<Schema$Advertiser>): void;
update(params: Params$Resource$Advertisers$Update, callback: BodyResponseCallback<Schema$Advertiser>): void;
update(callback: BodyResponseCallback<Schema$Advertiser>): void;
}
export interface Params$Resource$Advertisers$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Advertiser ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export interface Params$Resource$Advertisers$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Advertiser;
}
export interface Params$Resource$Advertisers$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Select only advertisers with these advertiser group IDs.
*/
advertiserGroupIds?: string[];
/**
* Select only advertisers with these floodlight configuration IDs.
*/
floodlightConfigurationIds?: string[];
/**
* Select only advertisers with these IDs.
*/
ids?: string[];
/**
* Select only advertisers which do not belong to any advertiser group.
*/
includeAdvertisersWithoutGroupsOnly?: boolean;
/**
* Maximum number of results to return.
*/
maxResults?: number;
/**
* Select only advertisers which use another advertiser's floodlight configuration.
*/
onlyParent?: boolean;
/**
* Value of the nextPageToken from the previous result page.
*/
pageToken?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "advertiser*2015" will return objects with names like "advertiser June 2015", "advertiser April 2015", or simply "advertiser 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "advertiser" will match objects with name "my advertiser", "advertiser 2015", or simply "advertiser".
*/
searchString?: string;
/**
* Field by which to sort the list.
*/
sortField?: string;
/**
* Order of sorted results.
*/
sortOrder?: string;
/**
* Select only advertisers with the specified status.
*/
status?: string;
/**
* Select only advertisers with these subaccount IDs.
*/
subaccountId?: string;
}
export interface Params$Resource$Advertisers$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Advertiser ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Advertiser;
}
export interface Params$Resource$Advertisers$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Advertiser;
}
export class Resource$Browsers {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.browsers.list
* @desc Retrieves a list of browsers.
* @alias dfareporting.browsers.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Browsers$List, options?: MethodOptions): GaxiosPromise<Schema$BrowsersListResponse>;
list(params: Params$Resource$Browsers$List, options: MethodOptions | BodyResponseCallback<Schema$BrowsersListResponse>, callback: BodyResponseCallback<Schema$BrowsersListResponse>): void;
list(params: Params$Resource$Browsers$List, callback: BodyResponseCallback<Schema$BrowsersListResponse>): void;
list(callback: BodyResponseCallback<Schema$BrowsersListResponse>): void;
}
export interface Params$Resource$Browsers$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export class Resource$Campaigncreativeassociations {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.campaignCreativeAssociations.insert
* @desc Associates a creative with the specified campaign. This method creates a default ad with dimensions matching the creative in the campaign if such a default ad does not exist already.
* @alias dfareporting.campaignCreativeAssociations.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.campaignId Campaign ID in this association.
* @param {string} params.profileId User profile ID associated with this request.
* @param {().CampaignCreativeAssociation} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
insert(params?: Params$Resource$Campaigncreativeassociations$Insert, options?: MethodOptions): GaxiosPromise<Schema$CampaignCreativeAssociation>;
insert(params: Params$Resource$Campaigncreativeassociations$Insert, options: MethodOptions | BodyResponseCallback<Schema$CampaignCreativeAssociation>, callback: BodyResponseCallback<Schema$CampaignCreativeAssociation>): void;
insert(params: Params$Resource$Campaigncreativeassociations$Insert, callback: BodyResponseCallback<Schema$CampaignCreativeAssociation>): void;
insert(callback: BodyResponseCallback<Schema$CampaignCreativeAssociation>): void;
/**
* dfareporting.campaignCreativeAssociations.list
* @desc Retrieves the list of creative IDs associated with the specified campaign. This method supports paging.
* @alias dfareporting.campaignCreativeAssociations.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.campaignId Campaign ID in this association.
* @param {integer=} params.maxResults Maximum number of results to return.
* @param {string=} params.pageToken Value of the nextPageToken from the previous result page.
* @param {string} params.profileId User profile ID associated with this request.
* @param {string=} params.sortOrder Order of sorted results.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Campaigncreativeassociations$List, options?: MethodOptions): GaxiosPromise<Schema$CampaignCreativeAssociationsListResponse>;
list(params: Params$Resource$Campaigncreativeassociations$List, options: MethodOptions | BodyResponseCallback<Schema$CampaignCreativeAssociationsListResponse>, callback: BodyResponseCallback<Schema$CampaignCreativeAssociationsListResponse>): void;
list(params: Params$Resource$Campaigncreativeassociations$List, callback: BodyResponseCallback<Schema$CampaignCreativeAssociationsListResponse>): void;
list(callback: BodyResponseCallback<Schema$CampaignCreativeAssociationsListResponse>): void;
}
export interface Params$Resource$Campaigncreativeassociations$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Campaign ID in this association.
*/
campaignId?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CampaignCreativeAssociation;
}
export interface Params$Resource$Campaigncreativeassociations$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Campaign ID in this association.
*/
campaignId?: string;
/**
* Maximum number of results to return.
*/
maxResults?: number;
/**
* Value of the nextPageToken from the previous result page.
*/
pageToken?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Order of sorted results.
*/
sortOrder?: string;
}
export class Resource$Campaigns {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.campaigns.get
* @desc Gets one campaign by ID.
* @alias dfareporting.campaigns.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Campaign ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Campaigns$Get, options?: MethodOptions): GaxiosPromise<Schema$Campaign>;
get(params: Params$Resource$Campaigns$Get, options: MethodOptions | BodyResponseCallback<Schema$Campaign>, callback: BodyResponseCallback<Schema$Campaign>): void;
get(params: Params$Resource$Campaigns$Get, callback: BodyResponseCallback<Schema$Campaign>): void;
get(callback: BodyResponseCallback<Schema$Campaign>): void;
/**
* dfareporting.campaigns.insert
* @desc Inserts a new campaign.
* @alias dfareporting.campaigns.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {().Campaign} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
insert(params?: Params$Resource$Campaigns$Insert, options?: MethodOptions): GaxiosPromise<Schema$Campaign>;
insert(params: Params$Resource$Campaigns$Insert, options: MethodOptions | BodyResponseCallback<Schema$Campaign>, callback: BodyResponseCallback<Schema$Campaign>): void;
insert(params: Params$Resource$Campaigns$Insert, callback: BodyResponseCallback<Schema$Campaign>): void;
insert(callback: BodyResponseCallback<Schema$Campaign>): void;
/**
* dfareporting.campaigns.list
* @desc Retrieves a list of campaigns, possibly filtered. This method supports paging.
* @alias dfareporting.campaigns.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.advertiserGroupIds Select only campaigns whose advertisers belong to these advertiser groups.
* @param {string=} params.advertiserIds Select only campaigns that belong to these advertisers.
* @param {boolean=} params.archived Select only archived campaigns. Don't set this field to select both archived and non-archived campaigns.
* @param {boolean=} params.atLeastOneOptimizationActivity Select only campaigns that have at least one optimization activity.
* @param {string=} params.excludedIds Exclude campaigns with these IDs.
* @param {string=} params.ids Select only campaigns with these IDs.
* @param {integer=} params.maxResults Maximum number of results to return.
* @param {string=} params.overriddenEventTagId Select only campaigns that have overridden this event tag ID.
* @param {string=} params.pageToken Value of the nextPageToken from the previous result page.
* @param {string} params.profileId User profile ID associated with this request.
* @param {string=} params.searchString Allows searching for campaigns by name or ID. Wildcards (*) are allowed. For example, "campaign*2015" will return campaigns with names like "campaign June 2015", "campaign April 2015", or simply "campaign 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "campaign" will match campaigns with name "my campaign", "campaign 2015", or simply "campaign".
* @param {string=} params.sortField Field by which to sort the list.
* @param {string=} params.sortOrder Order of sorted results.
* @param {string=} params.subaccountId Select only campaigns that belong to this subaccount.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Campaigns$List, options?: MethodOptions): GaxiosPromise<Schema$CampaignsListResponse>;
list(params: Params$Resource$Campaigns$List, options: MethodOptions | BodyResponseCallback<Schema$CampaignsListResponse>, callback: BodyResponseCallback<Schema$CampaignsListResponse>): void;
list(params: Params$Resource$Campaigns$List, callback: BodyResponseCallback<Schema$CampaignsListResponse>): void;
list(callback: BodyResponseCallback<Schema$CampaignsListResponse>): void;
/**
* dfareporting.campaigns.patch
* @desc Updates an existing campaign. This method supports patch semantics.
* @alias dfareporting.campaigns.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Campaign ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {().Campaign} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Campaigns$Patch, options?: MethodOptions): GaxiosPromise<Schema$Campaign>;
patch(params: Params$Resource$Campaigns$Patch, options: MethodOptions | BodyResponseCallback<Schema$Campaign>, callback: BodyResponseCallback<Schema$Campaign>): void;
patch(params: Params$Resource$Campaigns$Patch, callback: BodyResponseCallback<Schema$Campaign>): void;
patch(callback: BodyResponseCallback<Schema$Campaign>): void;
/**
* dfareporting.campaigns.update
* @desc Updates an existing campaign.
* @alias dfareporting.campaigns.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {().Campaign} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update(params?: Params$Resource$Campaigns$Update, options?: MethodOptions): GaxiosPromise<Schema$Campaign>;
update(params: Params$Resource$Campaigns$Update, options: MethodOptions | BodyResponseCallback<Schema$Campaign>, callback: BodyResponseCallback<Schema$Campaign>): void;
update(params: Params$Resource$Campaigns$Update, callback: BodyResponseCallback<Schema$Campaign>): void;
update(callback: BodyResponseCallback<Schema$Campaign>): void;
}
export interface Params$Resource$Campaigns$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Campaign ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export interface Params$Resource$Campaigns$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Campaign;
}
export interface Params$Resource$Campaigns$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Select only campaigns whose advertisers belong to these advertiser groups.
*/
advertiserGroupIds?: string[];
/**
* Select only campaigns that belong to these advertisers.
*/
advertiserIds?: string[];
/**
* Select only archived campaigns. Don't set this field to select both archived and non-archived campaigns.
*/
archived?: boolean;
/**
* Select only campaigns that have at least one optimization activity.
*/
atLeastOneOptimizationActivity?: boolean;
/**
* Exclude campaigns with these IDs.
*/
excludedIds?: string[];
/**
* Select only campaigns with these IDs.
*/
ids?: string[];
/**
* Maximum number of results to return.
*/
maxResults?: number;
/**
* Select only campaigns that have overridden this event tag ID.
*/
overriddenEventTagId?: string;
/**
* Value of the nextPageToken from the previous result page.
*/
pageToken?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Allows searching for campaigns by name or ID. Wildcards (*) are allowed. For example, "campaign*2015" will return campaigns with names like "campaign June 2015", "campaign April 2015", or simply "campaign 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "campaign" will match campaigns with name "my campaign", "campaign 2015", or simply "campaign".
*/
searchString?: string;
/**
* Field by which to sort the list.
*/
sortField?: string;
/**
* Order of sorted results.
*/
sortOrder?: string;
/**
* Select only campaigns that belong to this subaccount.
*/
subaccountId?: string;
}
export interface Params$Resource$Campaigns$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Campaign ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Campaign;
}
export interface Params$Resource$Campaigns$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Campaign;
}
export class Resource$Changelogs {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.changeLogs.get
* @desc Gets one change log by ID.
* @alias dfareporting.changeLogs.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Change log ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Changelogs$Get, options?: MethodOptions): GaxiosPromise<Schema$ChangeLog>;
get(params: Params$Resource$Changelogs$Get, options: MethodOptions | BodyResponseCallback<Schema$ChangeLog>, callback: BodyResponseCallback<Schema$ChangeLog>): void;
get(params: Params$Resource$Changelogs$Get, callback: BodyResponseCallback<Schema$ChangeLog>): void;
get(callback: BodyResponseCallback<Schema$ChangeLog>): void;
/**
* dfareporting.changeLogs.list
* @desc Retrieves a list of change logs. This method supports paging.
* @alias dfareporting.changeLogs.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.action Select only change logs with the specified action.
* @param {string=} params.ids Select only change logs with these IDs.
* @param {string=} params.maxChangeTime Select only change logs whose change time is before the specified maxChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset.
* @param {integer=} params.maxResults Maximum number of results to return.
* @param {string=} params.minChangeTime Select only change logs whose change time is before the specified minChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset.
* @param {string=} params.objectIds Select only change logs with these object IDs.
* @param {string=} params.objectType Select only change logs with the specified object type.
* @param {string=} params.pageToken Value of the nextPageToken from the previous result page.
* @param {string} params.profileId User profile ID associated with this request.
* @param {string=} params.searchString Select only change logs whose object ID, user name, old or new values match the search string.
* @param {string=} params.userProfileIds Select only change logs with these user profile IDs.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Changelogs$List, options?: MethodOptions): GaxiosPromise<Schema$ChangeLogsListResponse>;
list(params: Params$Resource$Changelogs$List, options: MethodOptions | BodyResponseCallback<Schema$ChangeLogsListResponse>, callback: BodyResponseCallback<Schema$ChangeLogsListResponse>): void;
list(params: Params$Resource$Changelogs$List, callback: BodyResponseCallback<Schema$ChangeLogsListResponse>): void;
list(callback: BodyResponseCallback<Schema$ChangeLogsListResponse>): void;
}
export interface Params$Resource$Changelogs$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Change log ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export interface Params$Resource$Changelogs$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Select only change logs with the specified action.
*/
action?: string;
/**
* Select only change logs with these IDs.
*/
ids?: string[];
/**
* Select only change logs whose change time is before the specified maxChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset.
*/
maxChangeTime?: string;
/**
* Maximum number of results to return.
*/
maxResults?: number;
/**
* Select only change logs whose change time is before the specified minChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset.
*/
minChangeTime?: string;
/**
* Select only change logs with these object IDs.
*/
objectIds?: string[];
/**
* Select only change logs with the specified object type.
*/
objectType?: string;
/**
* Value of the nextPageToken from the previous result page.
*/
pageToken?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Select only change logs whose object ID, user name, old or new values match the search string.
*/
searchString?: string;
/**
* Select only change logs with these user profile IDs.
*/
userProfileIds?: string[];
}
export class Resource$Cities {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.cities.list
* @desc Retrieves a list of cities, possibly filtered.
* @alias dfareporting.cities.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.countryDartIds Select only cities from these countries.
* @param {string=} params.dartIds Select only cities with these DART IDs.
* @param {string=} params.namePrefix Select only cities with names starting with this prefix.
* @param {string} params.profileId User profile ID associated with this request.
* @param {string=} params.regionDartIds Select only cities from these regions.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Cities$List, options?: MethodOptions): GaxiosPromise<Schema$CitiesListResponse>;
list(params: Params$Resource$Cities$List, options: MethodOptions | BodyResponseCallback<Schema$CitiesListResponse>, callback: BodyResponseCallback<Schema$CitiesListResponse>): void;
list(params: Params$Resource$Cities$List, callback: BodyResponseCallback<Schema$CitiesListResponse>): void;
list(callback: BodyResponseCallback<Schema$CitiesListResponse>): void;
}
export interface Params$Resource$Cities$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Select only cities from these countries.
*/
countryDartIds?: string[];
/**
* Select only cities with these DART IDs.
*/
dartIds?: string[];
/**
* Select only cities with names starting with this prefix.
*/
namePrefix?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Select only cities from these regions.
*/
regionDartIds?: string[];
}
export class Resource$Connectiontypes {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.connectionTypes.get
* @desc Gets one connection type by ID.
* @alias dfareporting.connectionTypes.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Connection type ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Connectiontypes$Get, options?: MethodOptions): GaxiosPromise<Schema$ConnectionType>;
get(params: Params$Resource$Connectiontypes$Get, options: MethodOptions | BodyResponseCallback<Schema$ConnectionType>, callback: BodyResponseCallback<Schema$ConnectionType>): void;
get(params: Params$Resource$Connectiontypes$Get, callback: BodyResponseCallback<Schema$ConnectionType>): void;
get(callback: BodyResponseCallback<Schema$ConnectionType>): void;
/**
* dfareporting.connectionTypes.list
* @desc Retrieves a list of connection types.
* @alias dfareporting.connectionTypes.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Connectiontypes$List, options?: MethodOptions): GaxiosPromise<Schema$ConnectionTypesListResponse>;
list(params: Params$Resource$Connectiontypes$List, options: MethodOptions | BodyResponseCallback<Schema$ConnectionTypesListResponse>, callback: BodyResponseCallback<Schema$ConnectionTypesListResponse>): void;
list(params: Params$Resource$Connectiontypes$List, callback: BodyResponseCallback<Schema$ConnectionTypesListResponse>): void;
list(callback: BodyResponseCallback<Schema$ConnectionTypesListResponse>): void;
}
export interface Params$Resource$Connectiontypes$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Connection type ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export interface Params$Resource$Connectiontypes$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export class Resource$Contentcategories {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.contentCategories.delete
* @desc Deletes an existing content category.
* @alias dfareporting.contentCategories.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Content category ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Contentcategories$Delete, options?: MethodOptions): GaxiosPromise<void>;
delete(params: Params$Resource$Contentcategories$Delete, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
delete(params: Params$Resource$Contentcategories$Delete, callback: BodyResponseCallback<void>): void;
delete(callback: BodyResponseCallback<void>): void;
/**
* dfareporting.contentCategories.get
* @desc Gets one content category by ID.
* @alias dfareporting.contentCategories.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Content category ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Contentcategories$Get, options?: MethodOptions): GaxiosPromise<Schema$ContentCategory>;
get(params: Params$Resource$Contentcategories$Get, options: MethodOptions | BodyResponseCallback<Schema$ContentCategory>, callback: BodyResponseCallback<Schema$ContentCategory>): void;
get(params: Params$Resource$Contentcategories$Get, callback: BodyResponseCallback<Schema$ContentCategory>): void;
get(callback: BodyResponseCallback<Schema$ContentCategory>): void;
/**
* dfareporting.contentCategories.insert
* @desc Inserts a new content category.
* @alias dfareporting.contentCategories.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {().ContentCategory} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
insert(params?: Params$Resource$Contentcategories$Insert, options?: MethodOptions): GaxiosPromise<Schema$ContentCategory>;
insert(params: Params$Resource$Contentcategories$Insert, options: MethodOptions | BodyResponseCallback<Schema$ContentCategory>, callback: BodyResponseCallback<Schema$ContentCategory>): void;
insert(params: Params$Resource$Contentcategories$Insert, callback: BodyResponseCallback<Schema$ContentCategory>): void;
insert(callback: BodyResponseCallback<Schema$ContentCategory>): void;
/**
* dfareporting.contentCategories.list
* @desc Retrieves a list of content categories, possibly filtered. This method supports paging.
* @alias dfareporting.contentCategories.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.ids Select only content categories with these IDs.
* @param {integer=} params.maxResults Maximum number of results to return.
* @param {string=} params.pageToken Value of the nextPageToken from the previous result page.
* @param {string} params.profileId User profile ID associated with this request.
* @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "contentcategory*2015" will return objects with names like "contentcategory June 2015", "contentcategory April 2015", or simply "contentcategory 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "contentcategory" will match objects with name "my contentcategory", "contentcategory 2015", or simply "contentcategory".
* @param {string=} params.sortField Field by which to sort the list.
* @param {string=} params.sortOrder Order of sorted results.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Contentcategories$List, options?: MethodOptions): GaxiosPromise<Schema$ContentCategoriesListResponse>;
list(params: Params$Resource$Contentcategories$List, options: MethodOptions | BodyResponseCallback<Schema$ContentCategoriesListResponse>, callback: BodyResponseCallback<Schema$ContentCategoriesListResponse>): void;
list(params: Params$Resource$Contentcategories$List, callback: BodyResponseCallback<Schema$ContentCategoriesListResponse>): void;
list(callback: BodyResponseCallback<Schema$ContentCategoriesListResponse>): void;
/**
* dfareporting.contentCategories.patch
* @desc Updates an existing content category. This method supports patch semantics.
* @alias dfareporting.contentCategories.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Content category ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {().ContentCategory} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Contentcategories$Patch, options?: MethodOptions): GaxiosPromise<Schema$ContentCategory>;
patch(params: Params$Resource$Contentcategories$Patch, options: MethodOptions | BodyResponseCallback<Schema$ContentCategory>, callback: BodyResponseCallback<Schema$ContentCategory>): void;
patch(params: Params$Resource$Contentcategories$Patch, callback: BodyResponseCallback<Schema$ContentCategory>): void;
patch(callback: BodyResponseCallback<Schema$ContentCategory>): void;
/**
* dfareporting.contentCategories.update
* @desc Updates an existing content category.
* @alias dfareporting.contentCategories.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {().ContentCategory} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update(params?: Params$Resource$Contentcategories$Update, options?: MethodOptions): GaxiosPromise<Schema$ContentCategory>;
update(params: Params$Resource$Contentcategories$Update, options: MethodOptions | BodyResponseCallback<Schema$ContentCategory>, callback: BodyResponseCallback<Schema$ContentCategory>): void;
update(params: Params$Resource$Contentcategories$Update, callback: BodyResponseCallback<Schema$ContentCategory>): void;
update(callback: BodyResponseCallback<Schema$ContentCategory>): void;
}
export interface Params$Resource$Contentcategories$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Content category ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export interface Params$Resource$Contentcategories$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Content category ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export interface Params$Resource$Contentcategories$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$ContentCategory;
}
export interface Params$Resource$Contentcategories$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Select only content categories with these IDs.
*/
ids?: string[];
/**
* Maximum number of results to return.
*/
maxResults?: number;
/**
* Value of the nextPageToken from the previous result page.
*/
pageToken?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "contentcategory*2015" will return objects with names like "contentcategory June 2015", "contentcategory April 2015", or simply "contentcategory 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "contentcategory" will match objects with name "my contentcategory", "contentcategory 2015", or simply "contentcategory".
*/
searchString?: string;
/**
* Field by which to sort the list.
*/
sortField?: string;
/**
* Order of sorted results.
*/
sortOrder?: string;
}
export interface Params$Resource$Contentcategories$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Content category ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$ContentCategory;
}
export interface Params$Resource$Contentcategories$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$ContentCategory;
}
export class Resource$Conversions {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.conversions.batchinsert
* @desc Inserts conversions.
* @alias dfareporting.conversions.batchinsert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {().ConversionsBatchInsertRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
batchinsert(params?: Params$Resource$Conversions$Batchinsert, options?: MethodOptions): GaxiosPromise<Schema$ConversionsBatchInsertResponse>;
batchinsert(params: Params$Resource$Conversions$Batchinsert, options: MethodOptions | BodyResponseCallback<Schema$ConversionsBatchInsertResponse>, callback: BodyResponseCallback<Schema$ConversionsBatchInsertResponse>): void;
batchinsert(params: Params$Resource$Conversions$Batchinsert, callback: BodyResponseCallback<Schema$ConversionsBatchInsertResponse>): void;
batchinsert(callback: BodyResponseCallback<Schema$ConversionsBatchInsertResponse>): void;
/**
* dfareporting.conversions.batchupdate
* @desc Updates existing conversions.
* @alias dfareporting.conversions.batchupdate
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {().ConversionsBatchUpdateRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
batchupdate(params?: Params$Resource$Conversions$Batchupdate, options?: MethodOptions): GaxiosPromise<Schema$ConversionsBatchUpdateResponse>;
batchupdate(params: Params$Resource$Conversions$Batchupdate, options: MethodOptions | BodyResponseCallback<Schema$ConversionsBatchUpdateResponse>, callback: BodyResponseCallback<Schema$ConversionsBatchUpdateResponse>): void;
batchupdate(params: Params$Resource$Conversions$Batchupdate, callback: BodyResponseCallback<Schema$ConversionsBatchUpdateResponse>): void;
batchupdate(callback: BodyResponseCallback<Schema$ConversionsBatchUpdateResponse>): void;
}
export interface Params$Resource$Conversions$Batchinsert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$ConversionsBatchInsertRequest;
}
export interface Params$Resource$Conversions$Batchupdate extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$ConversionsBatchUpdateRequest;
}
export class Resource$Countries {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.countries.get
* @desc Gets one country by ID.
* @alias dfareporting.countries.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.dartId Country DART ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Countries$Get, options?: MethodOptions): GaxiosPromise<Schema$Country>;
get(params: Params$Resource$Countries$Get, options: MethodOptions | BodyResponseCallback<Schema$Country>, callback: BodyResponseCallback<Schema$Country>): void;
get(params: Params$Resource$Countries$Get, callback: BodyResponseCallback<Schema$Country>): void;
get(callback: BodyResponseCallback<Schema$Country>): void;
/**
* dfareporting.countries.list
* @desc Retrieves a list of countries.
* @alias dfareporting.countries.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Countries$List, options?: MethodOptions): GaxiosPromise<Schema$CountriesListResponse>;
list(params: Params$Resource$Countries$List, options: MethodOptions | BodyResponseCallback<Schema$CountriesListResponse>, callback: BodyResponseCallback<Schema$CountriesListResponse>): void;
list(params: Params$Resource$Countries$List, callback: BodyResponseCallback<Schema$CountriesListResponse>): void;
list(callback: BodyResponseCallback<Schema$CountriesListResponse>): void;
}
export interface Params$Resource$Countries$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Country DART ID.
*/
dartId?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export interface Params$Resource$Countries$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export class Resource$Creativeassets {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.creativeAssets.insert
* @desc Inserts a new creative asset.
* @alias dfareporting.creativeAssets.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.advertiserId Advertiser ID of this creative. This is a required field.
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} params.resource Media resource metadata
* @param {object} params.media Media object
* @param {string} params.media.mimeType Media mime-type
* @param {string|object} params.media.body Media body contents
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
insert(params?: Params$Resource$Creativeassets$Insert, options?: MethodOptions): GaxiosPromise<Schema$CreativeAssetMetadata>;
insert(params: Params$Resource$Creativeassets$Insert, options: MethodOptions | BodyResponseCallback<Schema$CreativeAssetMetadata>, callback: BodyResponseCallback<Schema$CreativeAssetMetadata>): void;
insert(params: Params$Resource$Creativeassets$Insert, callback: BodyResponseCallback<Schema$CreativeAssetMetadata>): void;
insert(callback: BodyResponseCallback<Schema$CreativeAssetMetadata>): void;
}
export interface Params$Resource$Creativeassets$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Advertiser ID of this creative. This is a required field.
*/
advertiserId?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CreativeAssetMetadata;
/**
* Media metadata
*/
media?: {
/**
* Media mime-type
*/
mimeType?: string;
/**
* Media body contents
*/
body?: any;
};
}
export class Resource$Creativefields {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.creativeFields.delete
* @desc Deletes an existing creative field.
* @alias dfareporting.creativeFields.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Creative Field ID
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Creativefields$Delete, options?: MethodOptions): GaxiosPromise<void>;
delete(params: Params$Resource$Creativefields$Delete, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
delete(params: Params$Resource$Creativefields$Delete, callback: BodyResponseCallback<void>): void;
delete(callback: BodyResponseCallback<void>): void;
/**
* dfareporting.creativeFields.get
* @desc Gets one creative field by ID.
* @alias dfareporting.creativeFields.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Creative Field ID
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Creativefields$Get, options?: MethodOptions): GaxiosPromise<Schema$CreativeField>;
get(params: Params$Resource$Creativefields$Get, options: MethodOptions | BodyResponseCallback<Schema$CreativeField>, callback: BodyResponseCallback<Schema$CreativeField>): void;
get(params: Params$Resource$Creativefields$Get, callback: BodyResponseCallback<Schema$CreativeField>): void;
get(callback: BodyResponseCallback<Schema$CreativeField>): void;
/**
* dfareporting.creativeFields.insert
* @desc Inserts a new creative field.
* @alias dfareporting.creativeFields.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {().CreativeField} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
insert(params?: Params$Resource$Creativefields$Insert, options?: MethodOptions): GaxiosPromise<Schema$CreativeField>;
insert(params: Params$Resource$Creativefields$Insert, options: MethodOptions | BodyResponseCallback<Schema$CreativeField>, callback: BodyResponseCallback<Schema$CreativeField>): void;
insert(params: Params$Resource$Creativefields$Insert, callback: BodyResponseCallback<Schema$CreativeField>): void;
insert(callback: BodyResponseCallback<Schema$CreativeField>): void;
/**
* dfareporting.creativeFields.list
* @desc Retrieves a list of creative fields, possibly filtered. This method supports paging.
* @alias dfareporting.creativeFields.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.advertiserIds Select only creative fields that belong to these advertisers.
* @param {string=} params.ids Select only creative fields with these IDs.
* @param {integer=} params.maxResults Maximum number of results to return.
* @param {string=} params.pageToken Value of the nextPageToken from the previous result page.
* @param {string} params.profileId User profile ID associated with this request.
* @param {string=} params.searchString Allows searching for creative fields by name or ID. Wildcards (*) are allowed. For example, "creativefield*2015" will return creative fields with names like "creativefield June 2015", "creativefield April 2015", or simply "creativefield 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativefield" will match creative fields with the name "my creativefield", "creativefield 2015", or simply "creativefield".
* @param {string=} params.sortField Field by which to sort the list.
* @param {string=} params.sortOrder Order of sorted results.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Creativefields$List, options?: MethodOptions): GaxiosPromise<Schema$CreativeFieldsListResponse>;
list(params: Params$Resource$Creativefields$List, options: MethodOptions | BodyResponseCallback<Schema$CreativeFieldsListResponse>, callback: BodyResponseCallback<Schema$CreativeFieldsListResponse>): void;
list(params: Params$Resource$Creativefields$List, callback: BodyResponseCallback<Schema$CreativeFieldsListResponse>): void;
list(callback: BodyResponseCallback<Schema$CreativeFieldsListResponse>): void;
/**
* dfareporting.creativeFields.patch
* @desc Updates an existing creative field. This method supports patch semantics.
* @alias dfareporting.creativeFields.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Creative Field ID
* @param {string} params.profileId User profile ID associated with this request.
* @param {().CreativeField} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Creativefields$Patch, options?: MethodOptions): GaxiosPromise<Schema$CreativeField>;
patch(params: Params$Resource$Creativefields$Patch, options: MethodOptions | BodyResponseCallback<Schema$CreativeField>, callback: BodyResponseCallback<Schema$CreativeField>): void;
patch(params: Params$Resource$Creativefields$Patch, callback: BodyResponseCallback<Schema$CreativeField>): void;
patch(callback: BodyResponseCallback<Schema$CreativeField>): void;
/**
* dfareporting.creativeFields.update
* @desc Updates an existing creative field.
* @alias dfareporting.creativeFields.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {().CreativeField} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update(params?: Params$Resource$Creativefields$Update, options?: MethodOptions): GaxiosPromise<Schema$CreativeField>;
update(params: Params$Resource$Creativefields$Update, options: MethodOptions | BodyResponseCallback<Schema$CreativeField>, callback: BodyResponseCallback<Schema$CreativeField>): void;
update(params: Params$Resource$Creativefields$Update, callback: BodyResponseCallback<Schema$CreativeField>): void;
update(callback: BodyResponseCallback<Schema$CreativeField>): void;
}
export interface Params$Resource$Creativefields$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Creative Field ID
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export interface Params$Resource$Creativefields$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Creative Field ID
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export interface Params$Resource$Creativefields$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CreativeField;
}
export interface Params$Resource$Creativefields$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Select only creative fields that belong to these advertisers.
*/
advertiserIds?: string[];
/**
* Select only creative fields with these IDs.
*/
ids?: string[];
/**
* Maximum number of results to return.
*/
maxResults?: number;
/**
* Value of the nextPageToken from the previous result page.
*/
pageToken?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Allows searching for creative fields by name or ID. Wildcards (*) are allowed. For example, "creativefield*2015" will return creative fields with names like "creativefield June 2015", "creativefield April 2015", or simply "creativefield 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativefield" will match creative fields with the name "my creativefield", "creativefield 2015", or simply "creativefield".
*/
searchString?: string;
/**
* Field by which to sort the list.
*/
sortField?: string;
/**
* Order of sorted results.
*/
sortOrder?: string;
}
export interface Params$Resource$Creativefields$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Creative Field ID
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CreativeField;
}
export interface Params$Resource$Creativefields$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CreativeField;
}
export class Resource$Creativefieldvalues {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.creativeFieldValues.delete
* @desc Deletes an existing creative field value.
* @alias dfareporting.creativeFieldValues.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.creativeFieldId Creative field ID for this creative field value.
* @param {string} params.id Creative Field Value ID
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Creativefieldvalues$Delete, options?: MethodOptions): GaxiosPromise<void>;
delete(params: Params$Resource$Creativefieldvalues$Delete, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
delete(params: Params$Resource$Creativefieldvalues$Delete, callback: BodyResponseCallback<void>): void;
delete(callback: BodyResponseCallback<void>): void;
/**
* dfareporting.creativeFieldValues.get
* @desc Gets one creative field value by ID.
* @alias dfareporting.creativeFieldValues.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.creativeFieldId Creative field ID for this creative field value.
* @param {string} params.id Creative Field Value ID
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Creativefieldvalues$Get, options?: MethodOptions): GaxiosPromise<Schema$CreativeFieldValue>;
get(params: Params$Resource$Creativefieldvalues$Get, options: MethodOptions | BodyResponseCallback<Schema$CreativeFieldValue>, callback: BodyResponseCallback<Schema$CreativeFieldValue>): void;
get(params: Params$Resource$Creativefieldvalues$Get, callback: BodyResponseCallback<Schema$CreativeFieldValue>): void;
get(callback: BodyResponseCallback<Schema$CreativeFieldValue>): void;
/**
* dfareporting.creativeFieldValues.insert
* @desc Inserts a new creative field value.
* @alias dfareporting.creativeFieldValues.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.creativeFieldId Creative field ID for this creative field value.
* @param {string} params.profileId User profile ID associated with this request.
* @param {().CreativeFieldValue} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
insert(params?: Params$Resource$Creativefieldvalues$Insert, options?: MethodOptions): GaxiosPromise<Schema$CreativeFieldValue>;
insert(params: Params$Resource$Creativefieldvalues$Insert, options: MethodOptions | BodyResponseCallback<Schema$CreativeFieldValue>, callback: BodyResponseCallback<Schema$CreativeFieldValue>): void;
insert(params: Params$Resource$Creativefieldvalues$Insert, callback: BodyResponseCallback<Schema$CreativeFieldValue>): void;
insert(callback: BodyResponseCallback<Schema$CreativeFieldValue>): void;
/**
* dfareporting.creativeFieldValues.list
* @desc Retrieves a list of creative field values, possibly filtered. This method supports paging.
* @alias dfareporting.creativeFieldValues.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.creativeFieldId Creative field ID for this creative field value.
* @param {string=} params.ids Select only creative field values with these IDs.
* @param {integer=} params.maxResults Maximum number of results to return.
* @param {string=} params.pageToken Value of the nextPageToken from the previous result page.
* @param {string} params.profileId User profile ID associated with this request.
* @param {string=} params.searchString Allows searching for creative field values by their values. Wildcards (e.g. *) are not allowed.
* @param {string=} params.sortField Field by which to sort the list.
* @param {string=} params.sortOrder Order of sorted results.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Creativefieldvalues$List, options?: MethodOptions): GaxiosPromise<Schema$CreativeFieldValuesListResponse>;
list(params: Params$Resource$Creativefieldvalues$List, options: MethodOptions | BodyResponseCallback<Schema$CreativeFieldValuesListResponse>, callback: BodyResponseCallback<Schema$CreativeFieldValuesListResponse>): void;
list(params: Params$Resource$Creativefieldvalues$List, callback: BodyResponseCallback<Schema$CreativeFieldValuesListResponse>): void;
list(callback: BodyResponseCallback<Schema$CreativeFieldValuesListResponse>): void;
/**
* dfareporting.creativeFieldValues.patch
* @desc Updates an existing creative field value. This method supports patch semantics.
* @alias dfareporting.creativeFieldValues.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.creativeFieldId Creative field ID for this creative field value.
* @param {string} params.id Creative Field Value ID
* @param {string} params.profileId User profile ID associated with this request.
* @param {().CreativeFieldValue} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Creativefieldvalues$Patch, options?: MethodOptions): GaxiosPromise<Schema$CreativeFieldValue>;
patch(params: Params$Resource$Creativefieldvalues$Patch, options: MethodOptions | BodyResponseCallback<Schema$CreativeFieldValue>, callback: BodyResponseCallback<Schema$CreativeFieldValue>): void;
patch(params: Params$Resource$Creativefieldvalues$Patch, callback: BodyResponseCallback<Schema$CreativeFieldValue>): void;
patch(callback: BodyResponseCallback<Schema$CreativeFieldValue>): void;
/**
* dfareporting.creativeFieldValues.update
* @desc Updates an existing creative field value.
* @alias dfareporting.creativeFieldValues.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.creativeFieldId Creative field ID for this creative field value.
* @param {string} params.profileId User profile ID associated with this request.
* @param {().CreativeFieldValue} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update(params?: Params$Resource$Creativefieldvalues$Update, options?: MethodOptions): GaxiosPromise<Schema$CreativeFieldValue>;
update(params: Params$Resource$Creativefieldvalues$Update, options: MethodOptions | BodyResponseCallback<Schema$CreativeFieldValue>, callback: BodyResponseCallback<Schema$CreativeFieldValue>): void;
update(params: Params$Resource$Creativefieldvalues$Update, callback: BodyResponseCallback<Schema$CreativeFieldValue>): void;
update(callback: BodyResponseCallback<Schema$CreativeFieldValue>): void;
}
export interface Params$Resource$Creativefieldvalues$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Creative field ID for this creative field value.
*/
creativeFieldId?: string;
/**
* Creative Field Value ID
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export interface Params$Resource$Creativefieldvalues$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Creative field ID for this creative field value.
*/
creativeFieldId?: string;
/**
* Creative Field Value ID
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export interface Params$Resource$Creativefieldvalues$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Creative field ID for this creative field value.
*/
creativeFieldId?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CreativeFieldValue;
}
export interface Params$Resource$Creativefieldvalues$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Creative field ID for this creative field value.
*/
creativeFieldId?: string;
/**
* Select only creative field values with these IDs.
*/
ids?: string[];
/**
* Maximum number of results to return.
*/
maxResults?: number;
/**
* Value of the nextPageToken from the previous result page.
*/
pageToken?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Allows searching for creative field values by their values. Wildcards (e.g. *) are not allowed.
*/
searchString?: string;
/**
* Field by which to sort the list.
*/
sortField?: string;
/**
* Order of sorted results.
*/
sortOrder?: string;
}
export interface Params$Resource$Creativefieldvalues$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Creative field ID for this creative field value.
*/
creativeFieldId?: string;
/**
* Creative Field Value ID
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CreativeFieldValue;
}
export interface Params$Resource$Creativefieldvalues$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Creative field ID for this creative field value.
*/
creativeFieldId?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CreativeFieldValue;
}
export class Resource$Creativegroups {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.creativeGroups.get
* @desc Gets one creative group by ID.
* @alias dfareporting.creativeGroups.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Creative group ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Creativegroups$Get, options?: MethodOptions): GaxiosPromise<Schema$CreativeGroup>;
get(params: Params$Resource$Creativegroups$Get, options: MethodOptions | BodyResponseCallback<Schema$CreativeGroup>, callback: BodyResponseCallback<Schema$CreativeGroup>): void;
get(params: Params$Resource$Creativegroups$Get, callback: BodyResponseCallback<Schema$CreativeGroup>): void;
get(callback: BodyResponseCallback<Schema$CreativeGroup>): void;
/**
* dfareporting.creativeGroups.insert
* @desc Inserts a new creative group.
* @alias dfareporting.creativeGroups.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {().CreativeGroup} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
insert(params?: Params$Resource$Creativegroups$Insert, options?: MethodOptions): GaxiosPromise<Schema$CreativeGroup>;
insert(params: Params$Resource$Creativegroups$Insert, options: MethodOptions | BodyResponseCallback<Schema$CreativeGroup>, callback: BodyResponseCallback<Schema$CreativeGroup>): void;
insert(params: Params$Resource$Creativegroups$Insert, callback: BodyResponseCallback<Schema$CreativeGroup>): void;
insert(callback: BodyResponseCallback<Schema$CreativeGroup>): void;
/**
* dfareporting.creativeGroups.list
* @desc Retrieves a list of creative groups, possibly filtered. This method supports paging.
* @alias dfareporting.creativeGroups.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.advertiserIds Select only creative groups that belong to these advertisers.
* @param {integer=} params.groupNumber Select only creative groups that belong to this subgroup.
* @param {string=} params.ids Select only creative groups with these IDs.
* @param {integer=} params.maxResults Maximum number of results to return.
* @param {string=} params.pageToken Value of the nextPageToken from the previous result page.
* @param {string} params.profileId User profile ID associated with this request.
* @param {string=} params.searchString Allows searching for creative groups by name or ID. Wildcards (*) are allowed. For example, "creativegroup*2015" will return creative groups with names like "creativegroup June 2015", "creativegroup April 2015", or simply "creativegroup 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativegroup" will match creative groups with the name "my creativegroup", "creativegroup 2015", or simply "creativegroup".
* @param {string=} params.sortField Field by which to sort the list.
* @param {string=} params.sortOrder Order of sorted results.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Creativegroups$List, options?: MethodOptions): GaxiosPromise<Schema$CreativeGroupsListResponse>;
list(params: Params$Resource$Creativegroups$List, options: MethodOptions | BodyResponseCallback<Schema$CreativeGroupsListResponse>, callback: BodyResponseCallback<Schema$CreativeGroupsListResponse>): void;
list(params: Params$Resource$Creativegroups$List, callback: BodyResponseCallback<Schema$CreativeGroupsListResponse>): void;
list(callback: BodyResponseCallback<Schema$CreativeGroupsListResponse>): void;
/**
* dfareporting.creativeGroups.patch
* @desc Updates an existing creative group. This method supports patch semantics.
* @alias dfareporting.creativeGroups.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Creative group ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {().CreativeGroup} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Creativegroups$Patch, options?: MethodOptions): GaxiosPromise<Schema$CreativeGroup>;
patch(params: Params$Resource$Creativegroups$Patch, options: MethodOptions | BodyResponseCallback<Schema$CreativeGroup>, callback: BodyResponseCallback<Schema$CreativeGroup>): void;
patch(params: Params$Resource$Creativegroups$Patch, callback: BodyResponseCallback<Schema$CreativeGroup>): void;
patch(callback: BodyResponseCallback<Schema$CreativeGroup>): void;
/**
* dfareporting.creativeGroups.update
* @desc Updates an existing creative group.
* @alias dfareporting.creativeGroups.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {().CreativeGroup} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update(params?: Params$Resource$Creativegroups$Update, options?: MethodOptions): GaxiosPromise<Schema$CreativeGroup>;
update(params: Params$Resource$Creativegroups$Update, options: MethodOptions | BodyResponseCallback<Schema$CreativeGroup>, callback: BodyResponseCallback<Schema$CreativeGroup>): void;
update(params: Params$Resource$Creativegroups$Update, callback: BodyResponseCallback<Schema$CreativeGroup>): void;
update(callback: BodyResponseCallback<Schema$CreativeGroup>): void;
}
export interface Params$Resource$Creativegroups$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Creative group ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export interface Params$Resource$Creativegroups$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CreativeGroup;
}
export interface Params$Resource$Creativegroups$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Select only creative groups that belong to these advertisers.
*/
advertiserIds?: string[];
/**
* Select only creative groups that belong to this subgroup.
*/
groupNumber?: number;
/**
* Select only creative groups with these IDs.
*/
ids?: string[];
/**
* Maximum number of results to return.
*/
maxResults?: number;
/**
* Value of the nextPageToken from the previous result page.
*/
pageToken?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Allows searching for creative groups by name or ID. Wildcards (*) are allowed. For example, "creativegroup*2015" will return creative groups with names like "creativegroup June 2015", "creativegroup April 2015", or simply "creativegroup 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativegroup" will match creative groups with the name "my creativegroup", "creativegroup 2015", or simply "creativegroup".
*/
searchString?: string;
/**
* Field by which to sort the list.
*/
sortField?: string;
/**
* Order of sorted results.
*/
sortOrder?: string;
}
export interface Params$Resource$Creativegroups$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Creative group ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CreativeGroup;
}
export interface Params$Resource$Creativegroups$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CreativeGroup;
}
export class Resource$Creatives {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.creatives.get
* @desc Gets one creative by ID.
* @alias dfareporting.creatives.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Creative ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Creatives$Get, options?: MethodOptions): GaxiosPromise<Schema$Creative>;
get(params: Params$Resource$Creatives$Get, options: MethodOptions | BodyResponseCallback<Schema$Creative>, callback: BodyResponseCallback<Schema$Creative>): void;
get(params: Params$Resource$Creatives$Get, callback: BodyResponseCallback<Schema$Creative>): void;
get(callback: BodyResponseCallback<Schema$Creative>): void;
/**
* dfareporting.creatives.insert
* @desc Inserts a new creative.
* @alias dfareporting.creatives.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {().Creative} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
insert(params?: Params$Resource$Creatives$Insert, options?: MethodOptions): GaxiosPromise<Schema$Creative>;
insert(params: Params$Resource$Creatives$Insert, options: MethodOptions | BodyResponseCallback<Schema$Creative>, callback: BodyResponseCallback<Schema$Creative>): void;
insert(params: Params$Resource$Creatives$Insert, callback: BodyResponseCallback<Schema$Creative>): void;
insert(callback: BodyResponseCallback<Schema$Creative>): void;
/**
* dfareporting.creatives.list
* @desc Retrieves a list of creatives, possibly filtered. This method supports paging.
* @alias dfareporting.creatives.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.active Select only active creatives. Leave blank to select active and inactive creatives.
* @param {string=} params.advertiserId Select only creatives with this advertiser ID.
* @param {boolean=} params.archived Select only archived creatives. Leave blank to select archived and unarchived creatives.
* @param {string=} params.campaignId Select only creatives with this campaign ID.
* @param {string=} params.companionCreativeIds Select only in-stream video creatives with these companion IDs.
* @param {string=} params.creativeFieldIds Select only creatives with these creative field IDs.
* @param {string=} params.ids Select only creatives with these IDs.
* @param {integer=} params.maxResults Maximum number of results to return.
* @param {string=} params.pageToken Value of the nextPageToken from the previous result page.
* @param {string} params.profileId User profile ID associated with this request.
* @param {string=} params.renderingIds Select only creatives with these rendering IDs.
* @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "creative*2015" will return objects with names like "creative June 2015", "creative April 2015", or simply "creative 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "creative" will match objects with name "my creative", "creative 2015", or simply "creative".
* @param {string=} params.sizeIds Select only creatives with these size IDs.
* @param {string=} params.sortField Field by which to sort the list.
* @param {string=} params.sortOrder Order of sorted results.
* @param {string=} params.studioCreativeId Select only creatives corresponding to this Studio creative ID.
* @param {string=} params.types Select only creatives with these creative types.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Creatives$List, options?: MethodOptions): GaxiosPromise<Schema$CreativesListResponse>;
list(params: Params$Resource$Creatives$List, options: MethodOptions | BodyResponseCallback<Schema$CreativesListResponse>, callback: BodyResponseCallback<Schema$CreativesListResponse>): void;
list(params: Params$Resource$Creatives$List, callback: BodyResponseCallback<Schema$CreativesListResponse>): void;
list(callback: BodyResponseCallback<Schema$CreativesListResponse>): void;
/**
* dfareporting.creatives.patch
* @desc Updates an existing creative. This method supports patch semantics.
* @alias dfareporting.creatives.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Creative ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {().Creative} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Creatives$Patch, options?: MethodOptions): GaxiosPromise<Schema$Creative>;
patch(params: Params$Resource$Creatives$Patch, options: MethodOptions | BodyResponseCallback<Schema$Creative>, callback: BodyResponseCallback<Schema$Creative>): void;
patch(params: Params$Resource$Creatives$Patch, callback: BodyResponseCallback<Schema$Creative>): void;
patch(callback: BodyResponseCallback<Schema$Creative>): void;
/**
* dfareporting.creatives.update
* @desc Updates an existing creative.
* @alias dfareporting.creatives.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {().Creative} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update(params?: Params$Resource$Creatives$Update, options?: MethodOptions): GaxiosPromise<Schema$Creative>;
update(params: Params$Resource$Creatives$Update, options: MethodOptions | BodyResponseCallback<Schema$Creative>, callback: BodyResponseCallback<Schema$Creative>): void;
update(params: Params$Resource$Creatives$Update, callback: BodyResponseCallback<Schema$Creative>): void;
update(callback: BodyResponseCallback<Schema$Creative>): void;
}
export interface Params$Resource$Creatives$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Creative ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export interface Params$Resource$Creatives$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Creative;
}
export interface Params$Resource$Creatives$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Select only active creatives. Leave blank to select active and inactive creatives.
*/
active?: boolean;
/**
* Select only creatives with this advertiser ID.
*/
advertiserId?: string;
/**
* Select only archived creatives. Leave blank to select archived and unarchived creatives.
*/
archived?: boolean;
/**
* Select only creatives with this campaign ID.
*/
campaignId?: string;
/**
* Select only in-stream video creatives with these companion IDs.
*/
companionCreativeIds?: string[];
/**
* Select only creatives with these creative field IDs.
*/
creativeFieldIds?: string[];
/**
* Select only creatives with these IDs.
*/
ids?: string[];
/**
* Maximum number of results to return.
*/
maxResults?: number;
/**
* Value of the nextPageToken from the previous result page.
*/
pageToken?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Select only creatives with these rendering IDs.
*/
renderingIds?: string[];
/**
* Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "creative*2015" will return objects with names like "creative June 2015", "creative April 2015", or simply "creative 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "creative" will match objects with name "my creative", "creative 2015", or simply "creative".
*/
searchString?: string;
/**
* Select only creatives with these size IDs.
*/
sizeIds?: string[];
/**
* Field by which to sort the list.
*/
sortField?: string;
/**
* Order of sorted results.
*/
sortOrder?: string;
/**
* Select only creatives corresponding to this Studio creative ID.
*/
studioCreativeId?: string;
/**
* Select only creatives with these creative types.
*/
types?: string[];
}
export interface Params$Resource$Creatives$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Creative ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Creative;
}
export interface Params$Resource$Creatives$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Creative;
}
export class Resource$Dimensionvalues {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.dimensionValues.query
* @desc Retrieves list of report dimension values for a list of filters.
* @alias dfareporting.dimensionValues.query
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.maxResults Maximum number of results to return.
* @param {string=} params.pageToken The value of the nextToken from the previous result page.
* @param {string} params.profileId The DFA user profile ID.
* @param {().DimensionValueRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
query(params?: Params$Resource$Dimensionvalues$Query, options?: MethodOptions): GaxiosPromise<Schema$DimensionValueList>;
query(params: Params$Resource$Dimensionvalues$Query, options: MethodOptions | BodyResponseCallback<Schema$DimensionValueList>, callback: BodyResponseCallback<Schema$DimensionValueList>): void;
query(params: Params$Resource$Dimensionvalues$Query, callback: BodyResponseCallback<Schema$DimensionValueList>): void;
query(callback: BodyResponseCallback<Schema$DimensionValueList>): void;
}
export interface Params$Resource$Dimensionvalues$Query extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Maximum number of results to return.
*/
maxResults?: number;
/**
* The value of the nextToken from the previous result page.
*/
pageToken?: string;
/**
* The DFA user profile ID.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$DimensionValueRequest;
}
export class Resource$Directorysites {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.directorySites.get
* @desc Gets one directory site by ID.
* @alias dfareporting.directorySites.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Directory site ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Directorysites$Get, options?: MethodOptions): GaxiosPromise<Schema$DirectorySite>;
get(params: Params$Resource$Directorysites$Get, options: MethodOptions | BodyResponseCallback<Schema$DirectorySite>, callback: BodyResponseCallback<Schema$DirectorySite>): void;
get(params: Params$Resource$Directorysites$Get, callback: BodyResponseCallback<Schema$DirectorySite>): void;
get(callback: BodyResponseCallback<Schema$DirectorySite>): void;
/**
* dfareporting.directorySites.insert
* @desc Inserts a new directory site.
* @alias dfareporting.directorySites.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {().DirectorySite} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
insert(params?: Params$Resource$Directorysites$Insert, options?: MethodOptions): GaxiosPromise<Schema$DirectorySite>;
insert(params: Params$Resource$Directorysites$Insert, options: MethodOptions | BodyResponseCallback<Schema$DirectorySite>, callback: BodyResponseCallback<Schema$DirectorySite>): void;
insert(params: Params$Resource$Directorysites$Insert, callback: BodyResponseCallback<Schema$DirectorySite>): void;
insert(callback: BodyResponseCallback<Schema$DirectorySite>): void;
/**
* dfareporting.directorySites.list
* @desc Retrieves a list of directory sites, possibly filtered. This method supports paging.
* @alias dfareporting.directorySites.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.acceptsInStreamVideoPlacements This search filter is no longer supported and will have no effect on the results returned.
* @param {boolean=} params.acceptsInterstitialPlacements This search filter is no longer supported and will have no effect on the results returned.
* @param {boolean=} params.acceptsPublisherPaidPlacements Select only directory sites that accept publisher paid placements. This field can be left blank.
* @param {boolean=} params.active Select only active directory sites. Leave blank to retrieve both active and inactive directory sites.
* @param {string=} params.dfpNetworkCode Select only directory sites with this Ad Manager network code.
* @param {string=} params.ids Select only directory sites with these IDs.
* @param {integer=} params.maxResults Maximum number of results to return.
* @param {string=} params.pageToken Value of the nextPageToken from the previous result page.
* @param {string} params.profileId User profile ID associated with this request.
* @param {string=} params.searchString Allows searching for objects by name, ID or URL. Wildcards (*) are allowed. For example, "directory site*2015" will return objects with names like "directory site June 2015", "directory site April 2015", or simply "directory site 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "directory site" will match objects with name "my directory site", "directory site 2015" or simply, "directory site".
* @param {string=} params.sortField Field by which to sort the list.
* @param {string=} params.sortOrder Order of sorted results.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Directorysites$List, options?: MethodOptions): GaxiosPromise<Schema$DirectorySitesListResponse>;
list(params: Params$Resource$Directorysites$List, options: MethodOptions | BodyResponseCallback<Schema$DirectorySitesListResponse>, callback: BodyResponseCallback<Schema$DirectorySitesListResponse>): void;
list(params: Params$Resource$Directorysites$List, callback: BodyResponseCallback<Schema$DirectorySitesListResponse>): void;
list(callback: BodyResponseCallback<Schema$DirectorySitesListResponse>): void;
}
export interface Params$Resource$Directorysites$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Directory site ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export interface Params$Resource$Directorysites$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$DirectorySite;
}
export interface Params$Resource$Directorysites$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* This search filter is no longer supported and will have no effect on the results returned.
*/
acceptsInStreamVideoPlacements?: boolean;
/**
* This search filter is no longer supported and will have no effect on the results returned.
*/
acceptsInterstitialPlacements?: boolean;
/**
* Select only directory sites that accept publisher paid placements. This field can be left blank.
*/
acceptsPublisherPaidPlacements?: boolean;
/**
* Select only active directory sites. Leave blank to retrieve both active and inactive directory sites.
*/
active?: boolean;
/**
* Select only directory sites with this Ad Manager network code.
*/
dfpNetworkCode?: string;
/**
* Select only directory sites with these IDs.
*/
ids?: string[];
/**
* Maximum number of results to return.
*/
maxResults?: number;
/**
* Value of the nextPageToken from the previous result page.
*/
pageToken?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Allows searching for objects by name, ID or URL. Wildcards (*) are allowed. For example, "directory site*2015" will return objects with names like "directory site June 2015", "directory site April 2015", or simply "directory site 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "directory site" will match objects with name "my directory site", "directory site 2015" or simply, "directory site".
*/
searchString?: string;
/**
* Field by which to sort the list.
*/
sortField?: string;
/**
* Order of sorted results.
*/
sortOrder?: string;
}
export class Resource$Dynamictargetingkeys {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.dynamicTargetingKeys.delete
* @desc Deletes an existing dynamic targeting key.
* @alias dfareporting.dynamicTargetingKeys.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase.
* @param {string} params.objectId ID of the object of this dynamic targeting key. This is a required field.
* @param {string} params.objectType Type of the object of this dynamic targeting key. This is a required field.
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Dynamictargetingkeys$Delete, options?: MethodOptions): GaxiosPromise<void>;
delete(params: Params$Resource$Dynamictargetingkeys$Delete, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
delete(params: Params$Resource$Dynamictargetingkeys$Delete, callback: BodyResponseCallback<void>): void;
delete(callback: BodyResponseCallback<void>): void;
/**
* dfareporting.dynamicTargetingKeys.insert
* @desc Inserts a new dynamic targeting key. Keys must be created at the advertiser level before being assigned to the advertiser's ads, creatives, or placements. There is a maximum of 1000 keys per advertiser, out of which a maximum of 20 keys can be assigned per ad, creative, or placement.
* @alias dfareporting.dynamicTargetingKeys.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {().DynamicTargetingKey} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
insert(params?: Params$Resource$Dynamictargetingkeys$Insert, options?: MethodOptions): GaxiosPromise<Schema$DynamicTargetingKey>;
insert(params: Params$Resource$Dynamictargetingkeys$Insert, options: MethodOptions | BodyResponseCallback<Schema$DynamicTargetingKey>, callback: BodyResponseCallback<Schema$DynamicTargetingKey>): void;
insert(params: Params$Resource$Dynamictargetingkeys$Insert, callback: BodyResponseCallback<Schema$DynamicTargetingKey>): void;
insert(callback: BodyResponseCallback<Schema$DynamicTargetingKey>): void;
/**
* dfareporting.dynamicTargetingKeys.list
* @desc Retrieves a list of dynamic targeting keys.
* @alias dfareporting.dynamicTargetingKeys.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.advertiserId Select only dynamic targeting keys whose object has this advertiser ID.
* @param {string=} params.names Select only dynamic targeting keys exactly matching these names.
* @param {string=} params.objectId Select only dynamic targeting keys with this object ID.
* @param {string=} params.objectType Select only dynamic targeting keys with this object type.
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Dynamictargetingkeys$List, options?: MethodOptions): GaxiosPromise<Schema$DynamicTargetingKeysListResponse>;
list(params: Params$Resource$Dynamictargetingkeys$List, options: MethodOptions | BodyResponseCallback<Schema$DynamicTargetingKeysListResponse>, callback: BodyResponseCallback<Schema$DynamicTargetingKeysListResponse>): void;
list(params: Params$Resource$Dynamictargetingkeys$List, callback: BodyResponseCallback<Schema$DynamicTargetingKeysListResponse>): void;
list(callback: BodyResponseCallback<Schema$DynamicTargetingKeysListResponse>): void;
}
export interface Params$Resource$Dynamictargetingkeys$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase.
*/
name?: string;
/**
* ID of the object of this dynamic targeting key. This is a required field.
*/
objectId?: string;
/**
* Type of the object of this dynamic targeting key. This is a required field.
*/
objectType?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export interface Params$Resource$Dynamictargetingkeys$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$DynamicTargetingKey;
}
export interface Params$Resource$Dynamictargetingkeys$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Select only dynamic targeting keys whose object has this advertiser ID.
*/
advertiserId?: string;
/**
* Select only dynamic targeting keys exactly matching these names.
*/
names?: string[];
/**
* Select only dynamic targeting keys with this object ID.
*/
objectId?: string;
/**
* Select only dynamic targeting keys with this object type.
*/
objectType?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export class Resource$Eventtags {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.eventTags.delete
* @desc Deletes an existing event tag.
* @alias dfareporting.eventTags.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Event tag ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Eventtags$Delete, options?: MethodOptions): GaxiosPromise<void>;
delete(params: Params$Resource$Eventtags$Delete, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
delete(params: Params$Resource$Eventtags$Delete, callback: BodyResponseCallback<void>): void;
delete(callback: BodyResponseCallback<void>): void;
/**
* dfareporting.eventTags.get
* @desc Gets one event tag by ID.
* @alias dfareporting.eventTags.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Event tag ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Eventtags$Get, options?: MethodOptions): GaxiosPromise<Schema$EventTag>;
get(params: Params$Resource$Eventtags$Get, options: MethodOptions | BodyResponseCallback<Schema$EventTag>, callback: BodyResponseCallback<Schema$EventTag>): void;
get(params: Params$Resource$Eventtags$Get, callback: BodyResponseCallback<Schema$EventTag>): void;
get(callback: BodyResponseCallback<Schema$EventTag>): void;
/**
* dfareporting.eventTags.insert
* @desc Inserts a new event tag.
* @alias dfareporting.eventTags.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {().EventTag} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
insert(params?: Params$Resource$Eventtags$Insert, options?: MethodOptions): GaxiosPromise<Schema$EventTag>;
insert(params: Params$Resource$Eventtags$Insert, options: MethodOptions | BodyResponseCallback<Schema$EventTag>, callback: BodyResponseCallback<Schema$EventTag>): void;
insert(params: Params$Resource$Eventtags$Insert, callback: BodyResponseCallback<Schema$EventTag>): void;
insert(callback: BodyResponseCallback<Schema$EventTag>): void;
/**
* dfareporting.eventTags.list
* @desc Retrieves a list of event tags, possibly filtered.
* @alias dfareporting.eventTags.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.adId Select only event tags that belong to this ad.
* @param {string=} params.advertiserId Select only event tags that belong to this advertiser.
* @param {string=} params.campaignId Select only event tags that belong to this campaign.
* @param {boolean=} params.definitionsOnly Examine only the specified campaign or advertiser's event tags for matching selector criteria. When set to false, the parent advertiser and parent campaign of the specified ad or campaign is examined as well. In addition, when set to false, the status field is examined as well, along with the enabledByDefault field. This parameter can not be set to true when adId is specified as ads do not define their own even tags.
* @param {boolean=} params.enabled Select only enabled event tags. What is considered enabled or disabled depends on the definitionsOnly parameter. When definitionsOnly is set to true, only the specified advertiser or campaign's event tags' enabledByDefault field is examined. When definitionsOnly is set to false, the specified ad or specified campaign's parent advertiser's or parent campaign's event tags' enabledByDefault and status fields are examined as well.
* @param {string=} params.eventTagTypes Select only event tags with the specified event tag types. Event tag types can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking.
* @param {string=} params.ids Select only event tags with these IDs.
* @param {string} params.profileId User profile ID associated with this request.
* @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "eventtag*2015" will return objects with names like "eventtag June 2015", "eventtag April 2015", or simply "eventtag 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "eventtag" will match objects with name "my eventtag", "eventtag 2015", or simply "eventtag".
* @param {string=} params.sortField Field by which to sort the list.
* @param {string=} params.sortOrder Order of sorted results.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Eventtags$List, options?: MethodOptions): GaxiosPromise<Schema$EventTagsListResponse>;
list(params: Params$Resource$Eventtags$List, options: MethodOptions | BodyResponseCallback<Schema$EventTagsListResponse>, callback: BodyResponseCallback<Schema$EventTagsListResponse>): void;
list(params: Params$Resource$Eventtags$List, callback: BodyResponseCallback<Schema$EventTagsListResponse>): void;
list(callback: BodyResponseCallback<Schema$EventTagsListResponse>): void;
/**
* dfareporting.eventTags.patch
* @desc Updates an existing event tag. This method supports patch semantics.
* @alias dfareporting.eventTags.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Event tag ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {().EventTag} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Eventtags$Patch, options?: MethodOptions): GaxiosPromise<Schema$EventTag>;
patch(params: Params$Resource$Eventtags$Patch, options: MethodOptions | BodyResponseCallback<Schema$EventTag>, callback: BodyResponseCallback<Schema$EventTag>): void;
patch(params: Params$Resource$Eventtags$Patch, callback: BodyResponseCallback<Schema$EventTag>): void;
patch(callback: BodyResponseCallback<Schema$EventTag>): void;
/**
* dfareporting.eventTags.update
* @desc Updates an existing event tag.
* @alias dfareporting.eventTags.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {().EventTag} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update(params?: Params$Resource$Eventtags$Update, options?: MethodOptions): GaxiosPromise<Schema$EventTag>;
update(params: Params$Resource$Eventtags$Update, options: MethodOptions | BodyResponseCallback<Schema$EventTag>, callback: BodyResponseCallback<Schema$EventTag>): void;
update(params: Params$Resource$Eventtags$Update, callback: BodyResponseCallback<Schema$EventTag>): void;
update(callback: BodyResponseCallback<Schema$EventTag>): void;
}
export interface Params$Resource$Eventtags$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Event tag ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export interface Params$Resource$Eventtags$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Event tag ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export interface Params$Resource$Eventtags$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$EventTag;
}
export interface Params$Resource$Eventtags$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Select only event tags that belong to this ad.
*/
adId?: string;
/**
* Select only event tags that belong to this advertiser.
*/
advertiserId?: string;
/**
* Select only event tags that belong to this campaign.
*/
campaignId?: string;
/**
* Examine only the specified campaign or advertiser's event tags for matching selector criteria. When set to false, the parent advertiser and parent campaign of the specified ad or campaign is examined as well. In addition, when set to false, the status field is examined as well, along with the enabledByDefault field. This parameter can not be set to true when adId is specified as ads do not define their own even tags.
*/
definitionsOnly?: boolean;
/**
* Select only enabled event tags. What is considered enabled or disabled depends on the definitionsOnly parameter. When definitionsOnly is set to true, only the specified advertiser or campaign's event tags' enabledByDefault field is examined. When definitionsOnly is set to false, the specified ad or specified campaign's parent advertiser's or parent campaign's event tags' enabledByDefault and status fields are examined as well.
*/
enabled?: boolean;
/**
* Select only event tags with the specified event tag types. Event tag types can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking.
*/
eventTagTypes?: string[];
/**
* Select only event tags with these IDs.
*/
ids?: string[];
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "eventtag*2015" will return objects with names like "eventtag June 2015", "eventtag April 2015", or simply "eventtag 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "eventtag" will match objects with name "my eventtag", "eventtag 2015", or simply "eventtag".
*/
searchString?: string;
/**
* Field by which to sort the list.
*/
sortField?: string;
/**
* Order of sorted results.
*/
sortOrder?: string;
}
export interface Params$Resource$Eventtags$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Event tag ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$EventTag;
}
export interface Params$Resource$Eventtags$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$EventTag;
}
export class Resource$Files {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.files.get
* @desc Retrieves a report file by its report ID and file ID. This method supports media download.
* @alias dfareporting.files.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.fileId The ID of the report file.
* @param {string} params.reportId The ID of the report.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Files$Get, options?: MethodOptions): GaxiosPromise<Schema$File>;
get(params: Params$Resource$Files$Get, options: MethodOptions | BodyResponseCallback<Schema$File>, callback: BodyResponseCallback<Schema$File>): void;
get(params: Params$Resource$Files$Get, callback: BodyResponseCallback<Schema$File>): void;
get(callback: BodyResponseCallback<Schema$File>): void;
/**
* dfareporting.files.list
* @desc Lists files for a user profile.
* @alias dfareporting.files.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.maxResults Maximum number of results to return.
* @param {string=} params.pageToken The value of the nextToken from the previous result page.
* @param {string} params.profileId The DFA profile ID.
* @param {string=} params.scope The scope that defines which results are returned.
* @param {string=} params.sortField The field by which to sort the list.
* @param {string=} params.sortOrder Order of sorted results.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Files$List, options?: MethodOptions): GaxiosPromise<Schema$FileList>;
list(params: Params$Resource$Files$List, options: MethodOptions | BodyResponseCallback<Schema$FileList>, callback: BodyResponseCallback<Schema$FileList>): void;
list(params: Params$Resource$Files$List, callback: BodyResponseCallback<Schema$FileList>): void;
list(callback: BodyResponseCallback<Schema$FileList>): void;
}
export interface Params$Resource$Files$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the report file.
*/
fileId?: string;
/**
* The ID of the report.
*/
reportId?: string;
}
export interface Params$Resource$Files$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Maximum number of results to return.
*/
maxResults?: number;
/**
* The value of the nextToken from the previous result page.
*/
pageToken?: string;
/**
* The DFA profile ID.
*/
profileId?: string;
/**
* The scope that defines which results are returned.
*/
scope?: string;
/**
* The field by which to sort the list.
*/
sortField?: string;
/**
* Order of sorted results.
*/
sortOrder?: string;
}
export class Resource$Floodlightactivities {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.floodlightActivities.delete
* @desc Deletes an existing floodlight activity.
* @alias dfareporting.floodlightActivities.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Floodlight activity ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Floodlightactivities$Delete, options?: MethodOptions): GaxiosPromise<void>;
delete(params: Params$Resource$Floodlightactivities$Delete, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
delete(params: Params$Resource$Floodlightactivities$Delete, callback: BodyResponseCallback<void>): void;
delete(callback: BodyResponseCallback<void>): void;
/**
* dfareporting.floodlightActivities.generatetag
* @desc Generates a tag for a floodlight activity.
* @alias dfareporting.floodlightActivities.generatetag
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.floodlightActivityId Floodlight activity ID for which we want to generate a tag.
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
generatetag(params?: Params$Resource$Floodlightactivities$Generatetag, options?: MethodOptions): GaxiosPromise<Schema$FloodlightActivitiesGenerateTagResponse>;
generatetag(params: Params$Resource$Floodlightactivities$Generatetag, options: MethodOptions | BodyResponseCallback<Schema$FloodlightActivitiesGenerateTagResponse>, callback: BodyResponseCallback<Schema$FloodlightActivitiesGenerateTagResponse>): void;
generatetag(params: Params$Resource$Floodlightactivities$Generatetag, callback: BodyResponseCallback<Schema$FloodlightActivitiesGenerateTagResponse>): void;
generatetag(callback: BodyResponseCallback<Schema$FloodlightActivitiesGenerateTagResponse>): void;
/**
* dfareporting.floodlightActivities.get
* @desc Gets one floodlight activity by ID.
* @alias dfareporting.floodlightActivities.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Floodlight activity ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Floodlightactivities$Get, options?: MethodOptions): GaxiosPromise<Schema$FloodlightActivity>;
get(params: Params$Resource$Floodlightactivities$Get, options: MethodOptions | BodyResponseCallback<Schema$FloodlightActivity>, callback: BodyResponseCallback<Schema$FloodlightActivity>): void;
get(params: Params$Resource$Floodlightactivities$Get, callback: BodyResponseCallback<Schema$FloodlightActivity>): void;
get(callback: BodyResponseCallback<Schema$FloodlightActivity>): void;
/**
* dfareporting.floodlightActivities.insert
* @desc Inserts a new floodlight activity.
* @alias dfareporting.floodlightActivities.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {().FloodlightActivity} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
insert(params?: Params$Resource$Floodlightactivities$Insert, options?: MethodOptions): GaxiosPromise<Schema$FloodlightActivity>;
insert(params: Params$Resource$Floodlightactivities$Insert, options: MethodOptions | BodyResponseCallback<Schema$FloodlightActivity>, callback: BodyResponseCallback<Schema$FloodlightActivity>): void;
insert(params: Params$Resource$Floodlightactivities$Insert, callback: BodyResponseCallback<Schema$FloodlightActivity>): void;
insert(callback: BodyResponseCallback<Schema$FloodlightActivity>): void;
/**
* dfareporting.floodlightActivities.list
* @desc Retrieves a list of floodlight activities, possibly filtered. This method supports paging.
* @alias dfareporting.floodlightActivities.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.advertiserId Select only floodlight activities for the specified advertiser ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.
* @param {string=} params.floodlightActivityGroupIds Select only floodlight activities with the specified floodlight activity group IDs.
* @param {string=} params.floodlightActivityGroupName Select only floodlight activities with the specified floodlight activity group name.
* @param {string=} params.floodlightActivityGroupTagString Select only floodlight activities with the specified floodlight activity group tag string.
* @param {string=} params.floodlightActivityGroupType Select only floodlight activities with the specified floodlight activity group type.
* @param {string=} params.floodlightConfigurationId Select only floodlight activities for the specified floodlight configuration ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.
* @param {string=} params.ids Select only floodlight activities with the specified IDs. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.
* @param {integer=} params.maxResults Maximum number of results to return.
* @param {string=} params.pageToken Value of the nextPageToken from the previous result page.
* @param {string} params.profileId User profile ID associated with this request.
* @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivity*2015" will return objects with names like "floodlightactivity June 2015", "floodlightactivity April 2015", or simply "floodlightactivity 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "floodlightactivity" will match objects with name "my floodlightactivity activity", "floodlightactivity 2015", or simply "floodlightactivity".
* @param {string=} params.sortField Field by which to sort the list.
* @param {string=} params.sortOrder Order of sorted results.
* @param {string=} params.tagString Select only floodlight activities with the specified tag string.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Floodlightactivities$List, options?: MethodOptions): GaxiosPromise<Schema$FloodlightActivitiesListResponse>;
list(params: Params$Resource$Floodlightactivities$List, options: MethodOptions | BodyResponseCallback<Schema$FloodlightActivitiesListResponse>, callback: BodyResponseCallback<Schema$FloodlightActivitiesListResponse>): void;
list(params: Params$Resource$Floodlightactivities$List, callback: BodyResponseCallback<Schema$FloodlightActivitiesListResponse>): void;
list(callback: BodyResponseCallback<Schema$FloodlightActivitiesListResponse>): void;
/**
* dfareporting.floodlightActivities.patch
* @desc Updates an existing floodlight activity. This method supports patch semantics.
* @alias dfareporting.floodlightActivities.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Floodlight activity ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {().FloodlightActivity} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Floodlightactivities$Patch, options?: MethodOptions): GaxiosPromise<Schema$FloodlightActivity>;
patch(params: Params$Resource$Floodlightactivities$Patch, options: MethodOptions | BodyResponseCallback<Schema$FloodlightActivity>, callback: BodyResponseCallback<Schema$FloodlightActivity>): void;
patch(params: Params$Resource$Floodlightactivities$Patch, callback: BodyResponseCallback<Schema$FloodlightActivity>): void;
patch(callback: BodyResponseCallback<Schema$FloodlightActivity>): void;
/**
* dfareporting.floodlightActivities.update
* @desc Updates an existing floodlight activity.
* @alias dfareporting.floodlightActivities.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {().FloodlightActivity} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update(params?: Params$Resource$Floodlightactivities$Update, options?: MethodOptions): GaxiosPromise<Schema$FloodlightActivity>;
update(params: Params$Resource$Floodlightactivities$Update, options: MethodOptions | BodyResponseCallback<Schema$FloodlightActivity>, callback: BodyResponseCallback<Schema$FloodlightActivity>): void;
update(params: Params$Resource$Floodlightactivities$Update, callback: BodyResponseCallback<Schema$FloodlightActivity>): void;
update(callback: BodyResponseCallback<Schema$FloodlightActivity>): void;
}
export interface Params$Resource$Floodlightactivities$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Floodlight activity ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export interface Params$Resource$Floodlightactivities$Generatetag extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Floodlight activity ID for which we want to generate a tag.
*/
floodlightActivityId?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export interface Params$Resource$Floodlightactivities$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Floodlight activity ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export interface Params$Resource$Floodlightactivities$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$FloodlightActivity;
}
export interface Params$Resource$Floodlightactivities$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Select only floodlight activities for the specified advertiser ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.
*/
advertiserId?: string;
/**
* Select only floodlight activities with the specified floodlight activity group IDs.
*/
floodlightActivityGroupIds?: string[];
/**
* Select only floodlight activities with the specified floodlight activity group name.
*/
floodlightActivityGroupName?: string;
/**
* Select only floodlight activities with the specified floodlight activity group tag string.
*/
floodlightActivityGroupTagString?: string;
/**
* Select only floodlight activities with the specified floodlight activity group type.
*/
floodlightActivityGroupType?: string;
/**
* Select only floodlight activities for the specified floodlight configuration ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.
*/
floodlightConfigurationId?: string;
/**
* Select only floodlight activities with the specified IDs. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.
*/
ids?: string[];
/**
* Maximum number of results to return.
*/
maxResults?: number;
/**
* Value of the nextPageToken from the previous result page.
*/
pageToken?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivity*2015" will return objects with names like "floodlightactivity June 2015", "floodlightactivity April 2015", or simply "floodlightactivity 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "floodlightactivity" will match objects with name "my floodlightactivity activity", "floodlightactivity 2015", or simply "floodlightactivity".
*/
searchString?: string;
/**
* Field by which to sort the list.
*/
sortField?: string;
/**
* Order of sorted results.
*/
sortOrder?: string;
/**
* Select only floodlight activities with the specified tag string.
*/
tagString?: string;
}
export interface Params$Resource$Floodlightactivities$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Floodlight activity ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$FloodlightActivity;
}
export interface Params$Resource$Floodlightactivities$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$FloodlightActivity;
}
export class Resource$Floodlightactivitygroups {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.floodlightActivityGroups.get
* @desc Gets one floodlight activity group by ID.
* @alias dfareporting.floodlightActivityGroups.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Floodlight activity Group ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Floodlightactivitygroups$Get, options?: MethodOptions): GaxiosPromise<Schema$FloodlightActivityGroup>;
get(params: Params$Resource$Floodlightactivitygroups$Get, options: MethodOptions | BodyResponseCallback<Schema$FloodlightActivityGroup>, callback: BodyResponseCallback<Schema$FloodlightActivityGroup>): void;
get(params: Params$Resource$Floodlightactivitygroups$Get, callback: BodyResponseCallback<Schema$FloodlightActivityGroup>): void;
get(callback: BodyResponseCallback<Schema$FloodlightActivityGroup>): void;
/**
* dfareporting.floodlightActivityGroups.insert
* @desc Inserts a new floodlight activity group.
* @alias dfareporting.floodlightActivityGroups.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {().FloodlightActivityGroup} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
insert(params?: Params$Resource$Floodlightactivitygroups$Insert, options?: MethodOptions): GaxiosPromise<Schema$FloodlightActivityGroup>;
insert(params: Params$Resource$Floodlightactivitygroups$Insert, options: MethodOptions | BodyResponseCallback<Schema$FloodlightActivityGroup>, callback: BodyResponseCallback<Schema$FloodlightActivityGroup>): void;
insert(params: Params$Resource$Floodlightactivitygroups$Insert, callback: BodyResponseCallback<Schema$FloodlightActivityGroup>): void;
insert(callback: BodyResponseCallback<Schema$FloodlightActivityGroup>): void;
/**
* dfareporting.floodlightActivityGroups.list
* @desc Retrieves a list of floodlight activity groups, possibly filtered. This method supports paging.
* @alias dfareporting.floodlightActivityGroups.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.advertiserId Select only floodlight activity groups with the specified advertiser ID. Must specify either advertiserId or floodlightConfigurationId for a non-empty result.
* @param {string=} params.floodlightConfigurationId Select only floodlight activity groups with the specified floodlight configuration ID. Must specify either advertiserId, or floodlightConfigurationId for a non-empty result.
* @param {string=} params.ids Select only floodlight activity groups with the specified IDs. Must specify either advertiserId or floodlightConfigurationId for a non-empty result.
* @param {integer=} params.maxResults Maximum number of results to return.
* @param {string=} params.pageToken Value of the nextPageToken from the previous result page.
* @param {string} params.profileId User profile ID associated with this request.
* @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivitygroup*2015" will return objects with names like "floodlightactivitygroup June 2015", "floodlightactivitygroup April 2015", or simply "floodlightactivitygroup 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "floodlightactivitygroup" will match objects with name "my floodlightactivitygroup activity", "floodlightactivitygroup 2015", or simply "floodlightactivitygroup".
* @param {string=} params.sortField Field by which to sort the list.
* @param {string=} params.sortOrder Order of sorted results.
* @param {string=} params.type Select only floodlight activity groups with the specified floodlight activity group type.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Floodlightactivitygroups$List, options?: MethodOptions): GaxiosPromise<Schema$FloodlightActivityGroupsListResponse>;
list(params: Params$Resource$Floodlightactivitygroups$List, options: MethodOptions | BodyResponseCallback<Schema$FloodlightActivityGroupsListResponse>, callback: BodyResponseCallback<Schema$FloodlightActivityGroupsListResponse>): void;
list(params: Params$Resource$Floodlightactivitygroups$List, callback: BodyResponseCallback<Schema$FloodlightActivityGroupsListResponse>): void;
list(callback: BodyResponseCallback<Schema$FloodlightActivityGroupsListResponse>): void;
/**
* dfareporting.floodlightActivityGroups.patch
* @desc Updates an existing floodlight activity group. This method supports patch semantics.
* @alias dfareporting.floodlightActivityGroups.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Floodlight activity Group ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {().FloodlightActivityGroup} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Floodlightactivitygroups$Patch, options?: MethodOptions): GaxiosPromise<Schema$FloodlightActivityGroup>;
patch(params: Params$Resource$Floodlightactivitygroups$Patch, options: MethodOptions | BodyResponseCallback<Schema$FloodlightActivityGroup>, callback: BodyResponseCallback<Schema$FloodlightActivityGroup>): void;
patch(params: Params$Resource$Floodlightactivitygroups$Patch, callback: BodyResponseCallback<Schema$FloodlightActivityGroup>): void;
patch(callback: BodyResponseCallback<Schema$FloodlightActivityGroup>): void;
/**
* dfareporting.floodlightActivityGroups.update
* @desc Updates an existing floodlight activity group.
* @alias dfareporting.floodlightActivityGroups.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {().FloodlightActivityGroup} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update(params?: Params$Resource$Floodlightactivitygroups$Update, options?: MethodOptions): GaxiosPromise<Schema$FloodlightActivityGroup>;
update(params: Params$Resource$Floodlightactivitygroups$Update, options: MethodOptions | BodyResponseCallback<Schema$FloodlightActivityGroup>, callback: BodyResponseCallback<Schema$FloodlightActivityGroup>): void;
update(params: Params$Resource$Floodlightactivitygroups$Update, callback: BodyResponseCallback<Schema$FloodlightActivityGroup>): void;
update(callback: BodyResponseCallback<Schema$FloodlightActivityGroup>): void;
}
export interface Params$Resource$Floodlightactivitygroups$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Floodlight activity Group ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export interface Params$Resource$Floodlightactivitygroups$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$FloodlightActivityGroup;
}
export interface Params$Resource$Floodlightactivitygroups$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Select only floodlight activity groups with the specified advertiser ID. Must specify either advertiserId or floodlightConfigurationId for a non-empty result.
*/
advertiserId?: string;
/**
* Select only floodlight activity groups with the specified floodlight configuration ID. Must specify either advertiserId, or floodlightConfigurationId for a non-empty result.
*/
floodlightConfigurationId?: string;
/**
* Select only floodlight activity groups with the specified IDs. Must specify either advertiserId or floodlightConfigurationId for a non-empty result.
*/
ids?: string[];
/**
* Maximum number of results to return.
*/
maxResults?: number;
/**
* Value of the nextPageToken from the previous result page.
*/
pageToken?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivitygroup*2015" will return objects with names like "floodlightactivitygroup June 2015", "floodlightactivitygroup April 2015", or simply "floodlightactivitygroup 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "floodlightactivitygroup" will match objects with name "my floodlightactivitygroup activity", "floodlightactivitygroup 2015", or simply "floodlightactivitygroup".
*/
searchString?: string;
/**
* Field by which to sort the list.
*/
sortField?: string;
/**
* Order of sorted results.
*/
sortOrder?: string;
/**
* Select only floodlight activity groups with the specified floodlight activity group type.
*/
type?: string;
}
export interface Params$Resource$Floodlightactivitygroups$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Floodlight activity Group ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$FloodlightActivityGroup;
}
export interface Params$Resource$Floodlightactivitygroups$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$FloodlightActivityGroup;
}
export class Resource$Floodlightconfigurations {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.floodlightConfigurations.get
* @desc Gets one floodlight configuration by ID.
* @alias dfareporting.floodlightConfigurations.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Floodlight configuration ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Floodlightconfigurations$Get, options?: MethodOptions): GaxiosPromise<Schema$FloodlightConfiguration>;
get(params: Params$Resource$Floodlightconfigurations$Get, options: MethodOptions | BodyResponseCallback<Schema$FloodlightConfiguration>, callback: BodyResponseCallback<Schema$FloodlightConfiguration>): void;
get(params: Params$Resource$Floodlightconfigurations$Get, callback: BodyResponseCallback<Schema$FloodlightConfiguration>): void;
get(callback: BodyResponseCallback<Schema$FloodlightConfiguration>): void;
/**
* dfareporting.floodlightConfigurations.list
* @desc Retrieves a list of floodlight configurations, possibly filtered.
* @alias dfareporting.floodlightConfigurations.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.ids Set of IDs of floodlight configurations to retrieve. Required field; otherwise an empty list will be returned.
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Floodlightconfigurations$List, options?: MethodOptions): GaxiosPromise<Schema$FloodlightConfigurationsListResponse>;
list(params: Params$Resource$Floodlightconfigurations$List, options: MethodOptions | BodyResponseCallback<Schema$FloodlightConfigurationsListResponse>, callback: BodyResponseCallback<Schema$FloodlightConfigurationsListResponse>): void;
list(params: Params$Resource$Floodlightconfigurations$List, callback: BodyResponseCallback<Schema$FloodlightConfigurationsListResponse>): void;
list(callback: BodyResponseCallback<Schema$FloodlightConfigurationsListResponse>): void;
/**
* dfareporting.floodlightConfigurations.patch
* @desc Updates an existing floodlight configuration. This method supports patch semantics.
* @alias dfareporting.floodlightConfigurations.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Floodlight configuration ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {().FloodlightConfiguration} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Floodlightconfigurations$Patch, options?: MethodOptions): GaxiosPromise<Schema$FloodlightConfiguration>;
patch(params: Params$Resource$Floodlightconfigurations$Patch, options: MethodOptions | BodyResponseCallback<Schema$FloodlightConfiguration>, callback: BodyResponseCallback<Schema$FloodlightConfiguration>): void;
patch(params: Params$Resource$Floodlightconfigurations$Patch, callback: BodyResponseCallback<Schema$FloodlightConfiguration>): void;
patch(callback: BodyResponseCallback<Schema$FloodlightConfiguration>): void;
/**
* dfareporting.floodlightConfigurations.update
* @desc Updates an existing floodlight configuration.
* @alias dfareporting.floodlightConfigurations.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {().FloodlightConfiguration} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update(params?: Params$Resource$Floodlightconfigurations$Update, options?: MethodOptions): GaxiosPromise<Schema$FloodlightConfiguration>;
update(params: Params$Resource$Floodlightconfigurations$Update, options: MethodOptions | BodyResponseCallback<Schema$FloodlightConfiguration>, callback: BodyResponseCallback<Schema$FloodlightConfiguration>): void;
update(params: Params$Resource$Floodlightconfigurations$Update, callback: BodyResponseCallback<Schema$FloodlightConfiguration>): void;
update(callback: BodyResponseCallback<Schema$FloodlightConfiguration>): void;
}
export interface Params$Resource$Floodlightconfigurations$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Floodlight configuration ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export interface Params$Resource$Floodlightconfigurations$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Set of IDs of floodlight configurations to retrieve. Required field; otherwise an empty list will be returned.
*/
ids?: string[];
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export interface Params$Resource$Floodlightconfigurations$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Floodlight configuration ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$FloodlightConfiguration;
}
export interface Params$Resource$Floodlightconfigurations$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$FloodlightConfiguration;
}
export class Resource$Inventoryitems {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.inventoryItems.get
* @desc Gets one inventory item by ID.
* @alias dfareporting.inventoryItems.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Inventory item ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {string} params.projectId Project ID for order documents.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Inventoryitems$Get, options?: MethodOptions): GaxiosPromise<Schema$InventoryItem>;
get(params: Params$Resource$Inventoryitems$Get, options: MethodOptions | BodyResponseCallback<Schema$InventoryItem>, callback: BodyResponseCallback<Schema$InventoryItem>): void;
get(params: Params$Resource$Inventoryitems$Get, callback: BodyResponseCallback<Schema$InventoryItem>): void;
get(callback: BodyResponseCallback<Schema$InventoryItem>): void;
/**
* dfareporting.inventoryItems.list
* @desc Retrieves a list of inventory items, possibly filtered. This method supports paging.
* @alias dfareporting.inventoryItems.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.ids Select only inventory items with these IDs.
* @param {boolean=} params.inPlan Select only inventory items that are in plan.
* @param {integer=} params.maxResults Maximum number of results to return.
* @param {string=} params.orderId Select only inventory items that belong to specified orders.
* @param {string=} params.pageToken Value of the nextPageToken from the previous result page.
* @param {string} params.profileId User profile ID associated with this request.
* @param {string} params.projectId Project ID for order documents.
* @param {string=} params.siteId Select only inventory items that are associated with these sites.
* @param {string=} params.sortField Field by which to sort the list.
* @param {string=} params.sortOrder Order of sorted results.
* @param {string=} params.type Select only inventory items with this type.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Inventoryitems$List, options?: MethodOptions): GaxiosPromise<Schema$InventoryItemsListResponse>;
list(params: Params$Resource$Inventoryitems$List, options: MethodOptions | BodyResponseCallback<Schema$InventoryItemsListResponse>, callback: BodyResponseCallback<Schema$InventoryItemsListResponse>): void;
list(params: Params$Resource$Inventoryitems$List, callback: BodyResponseCallback<Schema$InventoryItemsListResponse>): void;
list(callback: BodyResponseCallback<Schema$InventoryItemsListResponse>): void;
}
export interface Params$Resource$Inventoryitems$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Inventory item ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Project ID for order documents.
*/
projectId?: string;
}
export interface Params$Resource$Inventoryitems$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Select only inventory items with these IDs.
*/
ids?: string[];
/**
* Select only inventory items that are in plan.
*/
inPlan?: boolean;
/**
* Maximum number of results to return.
*/
maxResults?: number;
/**
* Select only inventory items that belong to specified orders.
*/
orderId?: string[];
/**
* Value of the nextPageToken from the previous result page.
*/
pageToken?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Project ID for order documents.
*/
projectId?: string;
/**
* Select only inventory items that are associated with these sites.
*/
siteId?: string[];
/**
* Field by which to sort the list.
*/
sortField?: string;
/**
* Order of sorted results.
*/
sortOrder?: string;
/**
* Select only inventory items with this type.
*/
type?: string;
}
export class Resource$Languages {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.languages.list
* @desc Retrieves a list of languages.
* @alias dfareporting.languages.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Languages$List, options?: MethodOptions): GaxiosPromise<Schema$LanguagesListResponse>;
list(params: Params$Resource$Languages$List, options: MethodOptions | BodyResponseCallback<Schema$LanguagesListResponse>, callback: BodyResponseCallback<Schema$LanguagesListResponse>): void;
list(params: Params$Resource$Languages$List, callback: BodyResponseCallback<Schema$LanguagesListResponse>): void;
list(callback: BodyResponseCallback<Schema$LanguagesListResponse>): void;
}
export interface Params$Resource$Languages$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export class Resource$Metros {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.metros.list
* @desc Retrieves a list of metros.
* @alias dfareporting.metros.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Metros$List, options?: MethodOptions): GaxiosPromise<Schema$MetrosListResponse>;
list(params: Params$Resource$Metros$List, options: MethodOptions | BodyResponseCallback<Schema$MetrosListResponse>, callback: BodyResponseCallback<Schema$MetrosListResponse>): void;
list(params: Params$Resource$Metros$List, callback: BodyResponseCallback<Schema$MetrosListResponse>): void;
list(callback: BodyResponseCallback<Schema$MetrosListResponse>): void;
}
export interface Params$Resource$Metros$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export class Resource$Mobileapps {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.mobileApps.get
* @desc Gets one mobile app by ID.
* @alias dfareporting.mobileApps.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Mobile app ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Mobileapps$Get, options?: MethodOptions): GaxiosPromise<Schema$MobileApp>;
get(params: Params$Resource$Mobileapps$Get, options: MethodOptions | BodyResponseCallback<Schema$MobileApp>, callback: BodyResponseCallback<Schema$MobileApp>): void;
get(params: Params$Resource$Mobileapps$Get, callback: BodyResponseCallback<Schema$MobileApp>): void;
get(callback: BodyResponseCallback<Schema$MobileApp>): void;
/**
* dfareporting.mobileApps.list
* @desc Retrieves list of available mobile apps.
* @alias dfareporting.mobileApps.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.directories Select only apps from these directories.
* @param {string=} params.ids Select only apps with these IDs.
* @param {integer=} params.maxResults Maximum number of results to return.
* @param {string=} params.pageToken Value of the nextPageToken from the previous result page.
* @param {string} params.profileId User profile ID associated with this request.
* @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "app*2015" will return objects with names like "app Jan 2018", "app Jan 2018", or simply "app 2018". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "app" will match objects with name "my app", "app 2018", or simply "app".
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Mobileapps$List, options?: MethodOptions): GaxiosPromise<Schema$MobileAppsListResponse>;
list(params: Params$Resource$Mobileapps$List, options: MethodOptions | BodyResponseCallback<Schema$MobileAppsListResponse>, callback: BodyResponseCallback<Schema$MobileAppsListResponse>): void;
list(params: Params$Resource$Mobileapps$List, callback: BodyResponseCallback<Schema$MobileAppsListResponse>): void;
list(callback: BodyResponseCallback<Schema$MobileAppsListResponse>): void;
}
export interface Params$Resource$Mobileapps$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Mobile app ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export interface Params$Resource$Mobileapps$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Select only apps from these directories.
*/
directories?: string[];
/**
* Select only apps with these IDs.
*/
ids?: string[];
/**
* Maximum number of results to return.
*/
maxResults?: number;
/**
* Value of the nextPageToken from the previous result page.
*/
pageToken?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "app*2015" will return objects with names like "app Jan 2018", "app Jan 2018", or simply "app 2018". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "app" will match objects with name "my app", "app 2018", or simply "app".
*/
searchString?: string;
}
export class Resource$Mobilecarriers {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.mobileCarriers.get
* @desc Gets one mobile carrier by ID.
* @alias dfareporting.mobileCarriers.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Mobile carrier ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Mobilecarriers$Get, options?: MethodOptions): GaxiosPromise<Schema$MobileCarrier>;
get(params: Params$Resource$Mobilecarriers$Get, options: MethodOptions | BodyResponseCallback<Schema$MobileCarrier>, callback: BodyResponseCallback<Schema$MobileCarrier>): void;
get(params: Params$Resource$Mobilecarriers$Get, callback: BodyResponseCallback<Schema$MobileCarrier>): void;
get(callback: BodyResponseCallback<Schema$MobileCarrier>): void;
/**
* dfareporting.mobileCarriers.list
* @desc Retrieves a list of mobile carriers.
* @alias dfareporting.mobileCarriers.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Mobilecarriers$List, options?: MethodOptions): GaxiosPromise<Schema$MobileCarriersListResponse>;
list(params: Params$Resource$Mobilecarriers$List, options: MethodOptions | BodyResponseCallback<Schema$MobileCarriersListResponse>, callback: BodyResponseCallback<Schema$MobileCarriersListResponse>): void;
list(params: Params$Resource$Mobilecarriers$List, callback: BodyResponseCallback<Schema$MobileCarriersListResponse>): void;
list(callback: BodyResponseCallback<Schema$MobileCarriersListResponse>): void;
}
export interface Params$Resource$Mobilecarriers$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Mobile carrier ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export interface Params$Resource$Mobilecarriers$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export class Resource$Operatingsystems {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.operatingSystems.get
* @desc Gets one operating system by DART ID.
* @alias dfareporting.operatingSystems.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.dartId Operating system DART ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Operatingsystems$Get, options?: MethodOptions): GaxiosPromise<Schema$OperatingSystem>;
get(params: Params$Resource$Operatingsystems$Get, options: MethodOptions | BodyResponseCallback<Schema$OperatingSystem>, callback: BodyResponseCallback<Schema$OperatingSystem>): void;
get(params: Params$Resource$Operatingsystems$Get, callback: BodyResponseCallback<Schema$OperatingSystem>): void;
get(callback: BodyResponseCallback<Schema$OperatingSystem>): void;
/**
* dfareporting.operatingSystems.list
* @desc Retrieves a list of operating systems.
* @alias dfareporting.operatingSystems.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Operatingsystems$List, options?: MethodOptions): GaxiosPromise<Schema$OperatingSystemsListResponse>;
list(params: Params$Resource$Operatingsystems$List, options: MethodOptions | BodyResponseCallback<Schema$OperatingSystemsListResponse>, callback: BodyResponseCallback<Schema$OperatingSystemsListResponse>): void;
list(params: Params$Resource$Operatingsystems$List, callback: BodyResponseCallback<Schema$OperatingSystemsListResponse>): void;
list(callback: BodyResponseCallback<Schema$OperatingSystemsListResponse>): void;
}
export interface Params$Resource$Operatingsystems$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Operating system DART ID.
*/
dartId?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export interface Params$Resource$Operatingsystems$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export class Resource$Operatingsystemversions {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.operatingSystemVersions.get
* @desc Gets one operating system version by ID.
* @alias dfareporting.operatingSystemVersions.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Operating system version ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Operatingsystemversions$Get, options?: MethodOptions): GaxiosPromise<Schema$OperatingSystemVersion>;
get(params: Params$Resource$Operatingsystemversions$Get, options: MethodOptions | BodyResponseCallback<Schema$OperatingSystemVersion>, callback: BodyResponseCallback<Schema$OperatingSystemVersion>): void;
get(params: Params$Resource$Operatingsystemversions$Get, callback: BodyResponseCallback<Schema$OperatingSystemVersion>): void;
get(callback: BodyResponseCallback<Schema$OperatingSystemVersion>): void;
/**
* dfareporting.operatingSystemVersions.list
* @desc Retrieves a list of operating system versions.
* @alias dfareporting.operatingSystemVersions.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Operatingsystemversions$List, options?: MethodOptions): GaxiosPromise<Schema$OperatingSystemVersionsListResponse>;
list(params: Params$Resource$Operatingsystemversions$List, options: MethodOptions | BodyResponseCallback<Schema$OperatingSystemVersionsListResponse>, callback: BodyResponseCallback<Schema$OperatingSystemVersionsListResponse>): void;
list(params: Params$Resource$Operatingsystemversions$List, callback: BodyResponseCallback<Schema$OperatingSystemVersionsListResponse>): void;
list(callback: BodyResponseCallback<Schema$OperatingSystemVersionsListResponse>): void;
}
export interface Params$Resource$Operatingsystemversions$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Operating system version ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export interface Params$Resource$Operatingsystemversions$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export class Resource$Orderdocuments {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.orderDocuments.get
* @desc Gets one order document by ID.
* @alias dfareporting.orderDocuments.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Order document ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {string} params.projectId Project ID for order documents.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Orderdocuments$Get, options?: MethodOptions): GaxiosPromise<Schema$OrderDocument>;
get(params: Params$Resource$Orderdocuments$Get, options: MethodOptions | BodyResponseCallback<Schema$OrderDocument>, callback: BodyResponseCallback<Schema$OrderDocument>): void;
get(params: Params$Resource$Orderdocuments$Get, callback: BodyResponseCallback<Schema$OrderDocument>): void;
get(callback: BodyResponseCallback<Schema$OrderDocument>): void;
/**
* dfareporting.orderDocuments.list
* @desc Retrieves a list of order documents, possibly filtered. This method supports paging.
* @alias dfareporting.orderDocuments.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.approved Select only order documents that have been approved by at least one user.
* @param {string=} params.ids Select only order documents with these IDs.
* @param {integer=} params.maxResults Maximum number of results to return.
* @param {string=} params.orderId Select only order documents for specified orders.
* @param {string=} params.pageToken Value of the nextPageToken from the previous result page.
* @param {string} params.profileId User profile ID associated with this request.
* @param {string} params.projectId Project ID for order documents.
* @param {string=} params.searchString Allows searching for order documents by name or ID. Wildcards (*) are allowed. For example, "orderdocument*2015" will return order documents with names like "orderdocument June 2015", "orderdocument April 2015", or simply "orderdocument 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "orderdocument" will match order documents with name "my orderdocument", "orderdocument 2015", or simply "orderdocument".
* @param {string=} params.siteId Select only order documents that are associated with these sites.
* @param {string=} params.sortField Field by which to sort the list.
* @param {string=} params.sortOrder Order of sorted results.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Orderdocuments$List, options?: MethodOptions): GaxiosPromise<Schema$OrderDocumentsListResponse>;
list(params: Params$Resource$Orderdocuments$List, options: MethodOptions | BodyResponseCallback<Schema$OrderDocumentsListResponse>, callback: BodyResponseCallback<Schema$OrderDocumentsListResponse>): void;
list(params: Params$Resource$Orderdocuments$List, callback: BodyResponseCallback<Schema$OrderDocumentsListResponse>): void;
list(callback: BodyResponseCallback<Schema$OrderDocumentsListResponse>): void;
}
export interface Params$Resource$Orderdocuments$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Order document ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Project ID for order documents.
*/
projectId?: string;
}
export interface Params$Resource$Orderdocuments$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Select only order documents that have been approved by at least one user.
*/
approved?: boolean;
/**
* Select only order documents with these IDs.
*/
ids?: string[];
/**
* Maximum number of results to return.
*/
maxResults?: number;
/**
* Select only order documents for specified orders.
*/
orderId?: string[];
/**
* Value of the nextPageToken from the previous result page.
*/
pageToken?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Project ID for order documents.
*/
projectId?: string;
/**
* Allows searching for order documents by name or ID. Wildcards (*) are allowed. For example, "orderdocument*2015" will return order documents with names like "orderdocument June 2015", "orderdocument April 2015", or simply "orderdocument 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "orderdocument" will match order documents with name "my orderdocument", "orderdocument 2015", or simply "orderdocument".
*/
searchString?: string;
/**
* Select only order documents that are associated with these sites.
*/
siteId?: string[];
/**
* Field by which to sort the list.
*/
sortField?: string;
/**
* Order of sorted results.
*/
sortOrder?: string;
}
export class Resource$Orders {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.orders.get
* @desc Gets one order by ID.
* @alias dfareporting.orders.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Order ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {string} params.projectId Project ID for orders.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Orders$Get, options?: MethodOptions): GaxiosPromise<Schema$Order>;
get(params: Params$Resource$Orders$Get, options: MethodOptions | BodyResponseCallback<Schema$Order>, callback: BodyResponseCallback<Schema$Order>): void;
get(params: Params$Resource$Orders$Get, callback: BodyResponseCallback<Schema$Order>): void;
get(callback: BodyResponseCallback<Schema$Order>): void;
/**
* dfareporting.orders.list
* @desc Retrieves a list of orders, possibly filtered. This method supports paging.
* @alias dfareporting.orders.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.ids Select only orders with these IDs.
* @param {integer=} params.maxResults Maximum number of results to return.
* @param {string=} params.pageToken Value of the nextPageToken from the previous result page.
* @param {string} params.profileId User profile ID associated with this request.
* @param {string} params.projectId Project ID for orders.
* @param {string=} params.searchString Allows searching for orders by name or ID. Wildcards (*) are allowed. For example, "order*2015" will return orders with names like "order June 2015", "order April 2015", or simply "order 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "order" will match orders with name "my order", "order 2015", or simply "order".
* @param {string=} params.siteId Select only orders that are associated with these site IDs.
* @param {string=} params.sortField Field by which to sort the list.
* @param {string=} params.sortOrder Order of sorted results.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Orders$List, options?: MethodOptions): GaxiosPromise<Schema$OrdersListResponse>;
list(params: Params$Resource$Orders$List, options: MethodOptions | BodyResponseCallback<Schema$OrdersListResponse>, callback: BodyResponseCallback<Schema$OrdersListResponse>): void;
list(params: Params$Resource$Orders$List, callback: BodyResponseCallback<Schema$OrdersListResponse>): void;
list(callback: BodyResponseCallback<Schema$OrdersListResponse>): void;
}
export interface Params$Resource$Orders$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Order ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Project ID for orders.
*/
projectId?: string;
}
export interface Params$Resource$Orders$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Select only orders with these IDs.
*/
ids?: string[];
/**
* Maximum number of results to return.
*/
maxResults?: number;
/**
* Value of the nextPageToken from the previous result page.
*/
pageToken?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Project ID for orders.
*/
projectId?: string;
/**
* Allows searching for orders by name or ID. Wildcards (*) are allowed. For example, "order*2015" will return orders with names like "order June 2015", "order April 2015", or simply "order 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "order" will match orders with name "my order", "order 2015", or simply "order".
*/
searchString?: string;
/**
* Select only orders that are associated with these site IDs.
*/
siteId?: string[];
/**
* Field by which to sort the list.
*/
sortField?: string;
/**
* Order of sorted results.
*/
sortOrder?: string;
}
export class Resource$Placementgroups {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.placementGroups.get
* @desc Gets one placement group by ID.
* @alias dfareporting.placementGroups.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Placement group ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Placementgroups$Get, options?: MethodOptions): GaxiosPromise<Schema$PlacementGroup>;
get(params: Params$Resource$Placementgroups$Get, options: MethodOptions | BodyResponseCallback<Schema$PlacementGroup>, callback: BodyResponseCallback<Schema$PlacementGroup>): void;
get(params: Params$Resource$Placementgroups$Get, callback: BodyResponseCallback<Schema$PlacementGroup>): void;
get(callback: BodyResponseCallback<Schema$PlacementGroup>): void;
/**
* dfareporting.placementGroups.insert
* @desc Inserts a new placement group.
* @alias dfareporting.placementGroups.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {().PlacementGroup} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
insert(params?: Params$Resource$Placementgroups$Insert, options?: MethodOptions): GaxiosPromise<Schema$PlacementGroup>;
insert(params: Params$Resource$Placementgroups$Insert, options: MethodOptions | BodyResponseCallback<Schema$PlacementGroup>, callback: BodyResponseCallback<Schema$PlacementGroup>): void;
insert(params: Params$Resource$Placementgroups$Insert, callback: BodyResponseCallback<Schema$PlacementGroup>): void;
insert(callback: BodyResponseCallback<Schema$PlacementGroup>): void;
/**
* dfareporting.placementGroups.list
* @desc Retrieves a list of placement groups, possibly filtered. This method supports paging.
* @alias dfareporting.placementGroups.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.advertiserIds Select only placement groups that belong to these advertisers.
* @param {boolean=} params.archived Select only archived placements. Don't set this field to select both archived and non-archived placements.
* @param {string=} params.campaignIds Select only placement groups that belong to these campaigns.
* @param {string=} params.contentCategoryIds Select only placement groups that are associated with these content categories.
* @param {string=} params.directorySiteIds Select only placement groups that are associated with these directory sites.
* @param {string=} params.ids Select only placement groups with these IDs.
* @param {string=} params.maxEndDate Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd".
* @param {integer=} params.maxResults Maximum number of results to return.
* @param {string=} params.maxStartDate Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd".
* @param {string=} params.minEndDate Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd".
* @param {string=} params.minStartDate Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd".
* @param {string=} params.pageToken Value of the nextPageToken from the previous result page.
* @param {string=} params.placementGroupType Select only placement groups belonging with this group type. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting.
* @param {string=} params.placementStrategyIds Select only placement groups that are associated with these placement strategies.
* @param {string=} params.pricingTypes Select only placement groups with these pricing types.
* @param {string} params.profileId User profile ID associated with this request.
* @param {string=} params.searchString Allows searching for placement groups by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placement groups with names like "placement group June 2015", "placement group May 2015", or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placementgroup" will match placement groups with name "my placementgroup", "placementgroup 2015", or simply "placementgroup".
* @param {string=} params.siteIds Select only placement groups that are associated with these sites.
* @param {string=} params.sortField Field by which to sort the list.
* @param {string=} params.sortOrder Order of sorted results.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Placementgroups$List, options?: MethodOptions): GaxiosPromise<Schema$PlacementGroupsListResponse>;
list(params: Params$Resource$Placementgroups$List, options: MethodOptions | BodyResponseCallback<Schema$PlacementGroupsListResponse>, callback: BodyResponseCallback<Schema$PlacementGroupsListResponse>): void;
list(params: Params$Resource$Placementgroups$List, callback: BodyResponseCallback<Schema$PlacementGroupsListResponse>): void;
list(callback: BodyResponseCallback<Schema$PlacementGroupsListResponse>): void;
/**
* dfareporting.placementGroups.patch
* @desc Updates an existing placement group. This method supports patch semantics.
* @alias dfareporting.placementGroups.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Placement group ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {().PlacementGroup} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Placementgroups$Patch, options?: MethodOptions): GaxiosPromise<Schema$PlacementGroup>;
patch(params: Params$Resource$Placementgroups$Patch, options: MethodOptions | BodyResponseCallback<Schema$PlacementGroup>, callback: BodyResponseCallback<Schema$PlacementGroup>): void;
patch(params: Params$Resource$Placementgroups$Patch, callback: BodyResponseCallback<Schema$PlacementGroup>): void;
patch(callback: BodyResponseCallback<Schema$PlacementGroup>): void;
/**
* dfareporting.placementGroups.update
* @desc Updates an existing placement group.
* @alias dfareporting.placementGroups.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {().PlacementGroup} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update(params?: Params$Resource$Placementgroups$Update, options?: MethodOptions): GaxiosPromise<Schema$PlacementGroup>;
update(params: Params$Resource$Placementgroups$Update, options: MethodOptions | BodyResponseCallback<Schema$PlacementGroup>, callback: BodyResponseCallback<Schema$PlacementGroup>): void;
update(params: Params$Resource$Placementgroups$Update, callback: BodyResponseCallback<Schema$PlacementGroup>): void;
update(callback: BodyResponseCallback<Schema$PlacementGroup>): void;
}
export interface Params$Resource$Placementgroups$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Placement group ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export interface Params$Resource$Placementgroups$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$PlacementGroup;
}
export interface Params$Resource$Placementgroups$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Select only placement groups that belong to these advertisers.
*/
advertiserIds?: string[];
/**
* Select only archived placements. Don't set this field to select both archived and non-archived placements.
*/
archived?: boolean;
/**
* Select only placement groups that belong to these campaigns.
*/
campaignIds?: string[];
/**
* Select only placement groups that are associated with these content categories.
*/
contentCategoryIds?: string[];
/**
* Select only placement groups that are associated with these directory sites.
*/
directorySiteIds?: string[];
/**
* Select only placement groups with these IDs.
*/
ids?: string[];
/**
* Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd".
*/
maxEndDate?: string;
/**
* Maximum number of results to return.
*/
maxResults?: number;
/**
* Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd".
*/
maxStartDate?: string;
/**
* Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd".
*/
minEndDate?: string;
/**
* Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd".
*/
minStartDate?: string;
/**
* Value of the nextPageToken from the previous result page.
*/
pageToken?: string;
/**
* Select only placement groups belonging with this group type. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting.
*/
placementGroupType?: string;
/**
* Select only placement groups that are associated with these placement strategies.
*/
placementStrategyIds?: string[];
/**
* Select only placement groups with these pricing types.
*/
pricingTypes?: string[];
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Allows searching for placement groups by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placement groups with names like "placement group June 2015", "placement group May 2015", or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placementgroup" will match placement groups with name "my placementgroup", "placementgroup 2015", or simply "placementgroup".
*/
searchString?: string;
/**
* Select only placement groups that are associated with these sites.
*/
siteIds?: string[];
/**
* Field by which to sort the list.
*/
sortField?: string;
/**
* Order of sorted results.
*/
sortOrder?: string;
}
export interface Params$Resource$Placementgroups$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Placement group ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$PlacementGroup;
}
export interface Params$Resource$Placementgroups$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$PlacementGroup;
}
export class Resource$Placements {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.placements.generatetags
* @desc Generates tags for a placement.
* @alias dfareporting.placements.generatetags
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.campaignId Generate placements belonging to this campaign. This is a required field.
* @param {string=} params.placementIds Generate tags for these placements.
* @param {string} params.profileId User profile ID associated with this request.
* @param {string=} params.tagFormats Tag formats to generate for these placements. Note: PLACEMENT_TAG_STANDARD can only be generated for 1x1 placements.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
generatetags(params?: Params$Resource$Placements$Generatetags, options?: MethodOptions): GaxiosPromise<Schema$PlacementsGenerateTagsResponse>;
generatetags(params: Params$Resource$Placements$Generatetags, options: MethodOptions | BodyResponseCallback<Schema$PlacementsGenerateTagsResponse>, callback: BodyResponseCallback<Schema$PlacementsGenerateTagsResponse>): void;
generatetags(params: Params$Resource$Placements$Generatetags, callback: BodyResponseCallback<Schema$PlacementsGenerateTagsResponse>): void;
generatetags(callback: BodyResponseCallback<Schema$PlacementsGenerateTagsResponse>): void;
/**
* dfareporting.placements.get
* @desc Gets one placement by ID.
* @alias dfareporting.placements.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Placement ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Placements$Get, options?: MethodOptions): GaxiosPromise<Schema$Placement>;
get(params: Params$Resource$Placements$Get, options: MethodOptions | BodyResponseCallback<Schema$Placement>, callback: BodyResponseCallback<Schema$Placement>): void;
get(params: Params$Resource$Placements$Get, callback: BodyResponseCallback<Schema$Placement>): void;
get(callback: BodyResponseCallback<Schema$Placement>): void;
/**
* dfareporting.placements.insert
* @desc Inserts a new placement.
* @alias dfareporting.placements.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {().Placement} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
insert(params?: Params$Resource$Placements$Insert, options?: MethodOptions): GaxiosPromise<Schema$Placement>;
insert(params: Params$Resource$Placements$Insert, options: MethodOptions | BodyResponseCallback<Schema$Placement>, callback: BodyResponseCallback<Schema$Placement>): void;
insert(params: Params$Resource$Placements$Insert, callback: BodyResponseCallback<Schema$Placement>): void;
insert(callback: BodyResponseCallback<Schema$Placement>): void;
/**
* dfareporting.placements.list
* @desc Retrieves a list of placements, possibly filtered. This method supports paging.
* @alias dfareporting.placements.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.advertiserIds Select only placements that belong to these advertisers.
* @param {boolean=} params.archived Select only archived placements. Don't set this field to select both archived and non-archived placements.
* @param {string=} params.campaignIds Select only placements that belong to these campaigns.
* @param {string=} params.compatibilities Select only placements that are associated with these compatibilities. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard.
* @param {string=} params.contentCategoryIds Select only placements that are associated with these content categories.
* @param {string=} params.directorySiteIds Select only placements that are associated with these directory sites.
* @param {string=} params.groupIds Select only placements that belong to these placement groups.
* @param {string=} params.ids Select only placements with these IDs.
* @param {string=} params.maxEndDate Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd".
* @param {integer=} params.maxResults Maximum number of results to return.
* @param {string=} params.maxStartDate Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd".
* @param {string=} params.minEndDate Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd".
* @param {string=} params.minStartDate Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd".
* @param {string=} params.pageToken Value of the nextPageToken from the previous result page.
* @param {string=} params.paymentSource Select only placements with this payment source.
* @param {string=} params.placementStrategyIds Select only placements that are associated with these placement strategies.
* @param {string=} params.pricingTypes Select only placements with these pricing types.
* @param {string} params.profileId User profile ID associated with this request.
* @param {string=} params.searchString Allows searching for placements by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placements with names like "placement June 2015", "placement May 2015", or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placement" will match placements with name "my placement", "placement 2015", or simply "placement".
* @param {string=} params.siteIds Select only placements that are associated with these sites.
* @param {string=} params.sizeIds Select only placements that are associated with these sizes.
* @param {string=} params.sortField Field by which to sort the list.
* @param {string=} params.sortOrder Order of sorted results.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Placements$List, options?: MethodOptions): GaxiosPromise<Schema$PlacementsListResponse>;
list(params: Params$Resource$Placements$List, options: MethodOptions | BodyResponseCallback<Schema$PlacementsListResponse>, callback: BodyResponseCallback<Schema$PlacementsListResponse>): void;
list(params: Params$Resource$Placements$List, callback: BodyResponseCallback<Schema$PlacementsListResponse>): void;
list(callback: BodyResponseCallback<Schema$PlacementsListResponse>): void;
/**
* dfareporting.placements.patch
* @desc Updates an existing placement. This method supports patch semantics.
* @alias dfareporting.placements.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Placement ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {().Placement} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Placements$Patch, options?: MethodOptions): GaxiosPromise<Schema$Placement>;
patch(params: Params$Resource$Placements$Patch, options: MethodOptions | BodyResponseCallback<Schema$Placement>, callback: BodyResponseCallback<Schema$Placement>): void;
patch(params: Params$Resource$Placements$Patch, callback: BodyResponseCallback<Schema$Placement>): void;
patch(callback: BodyResponseCallback<Schema$Placement>): void;
/**
* dfareporting.placements.update
* @desc Updates an existing placement.
* @alias dfareporting.placements.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {().Placement} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update(params?: Params$Resource$Placements$Update, options?: MethodOptions): GaxiosPromise<Schema$Placement>;
update(params: Params$Resource$Placements$Update, options: MethodOptions | BodyResponseCallback<Schema$Placement>, callback: BodyResponseCallback<Schema$Placement>): void;
update(params: Params$Resource$Placements$Update, callback: BodyResponseCallback<Schema$Placement>): void;
update(callback: BodyResponseCallback<Schema$Placement>): void;
}
export interface Params$Resource$Placements$Generatetags extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Generate placements belonging to this campaign. This is a required field.
*/
campaignId?: string;
/**
* Generate tags for these placements.
*/
placementIds?: string[];
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Tag formats to generate for these placements. Note: PLACEMENT_TAG_STANDARD can only be generated for 1x1 placements.
*/
tagFormats?: string[];
}
export interface Params$Resource$Placements$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Placement ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export interface Params$Resource$Placements$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Placement;
}
export interface Params$Resource$Placements$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Select only placements that belong to these advertisers.
*/
advertiserIds?: string[];
/**
* Select only archived placements. Don't set this field to select both archived and non-archived placements.
*/
archived?: boolean;
/**
* Select only placements that belong to these campaigns.
*/
campaignIds?: string[];
/**
* Select only placements that are associated with these compatibilities. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard.
*/
compatibilities?: string[];
/**
* Select only placements that are associated with these content categories.
*/
contentCategoryIds?: string[];
/**
* Select only placements that are associated with these directory sites.
*/
directorySiteIds?: string[];
/**
* Select only placements that belong to these placement groups.
*/
groupIds?: string[];
/**
* Select only placements with these IDs.
*/
ids?: string[];
/**
* Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd".
*/
maxEndDate?: string;
/**
* Maximum number of results to return.
*/
maxResults?: number;
/**
* Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd".
*/
maxStartDate?: string;
/**
* Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd".
*/
minEndDate?: string;
/**
* Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd".
*/
minStartDate?: string;
/**
* Value of the nextPageToken from the previous result page.
*/
pageToken?: string;
/**
* Select only placements with this payment source.
*/
paymentSource?: string;
/**
* Select only placements that are associated with these placement strategies.
*/
placementStrategyIds?: string[];
/**
* Select only placements with these pricing types.
*/
pricingTypes?: string[];
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Allows searching for placements by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placements with names like "placement June 2015", "placement May 2015", or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placement" will match placements with name "my placement", "placement 2015", or simply "placement".
*/
searchString?: string;
/**
* Select only placements that are associated with these sites.
*/
siteIds?: string[];
/**
* Select only placements that are associated with these sizes.
*/
sizeIds?: string[];
/**
* Field by which to sort the list.
*/
sortField?: string;
/**
* Order of sorted results.
*/
sortOrder?: string;
}
export interface Params$Resource$Placements$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Placement ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Placement;
}
export interface Params$Resource$Placements$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Placement;
}
export class Resource$Placementstrategies {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.placementStrategies.delete
* @desc Deletes an existing placement strategy.
* @alias dfareporting.placementStrategies.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Placement strategy ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Placementstrategies$Delete, options?: MethodOptions): GaxiosPromise<void>;
delete(params: Params$Resource$Placementstrategies$Delete, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
delete(params: Params$Resource$Placementstrategies$Delete, callback: BodyResponseCallback<void>): void;
delete(callback: BodyResponseCallback<void>): void;
/**
* dfareporting.placementStrategies.get
* @desc Gets one placement strategy by ID.
* @alias dfareporting.placementStrategies.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Placement strategy ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Placementstrategies$Get, options?: MethodOptions): GaxiosPromise<Schema$PlacementStrategy>;
get(params: Params$Resource$Placementstrategies$Get, options: MethodOptions | BodyResponseCallback<Schema$PlacementStrategy>, callback: BodyResponseCallback<Schema$PlacementStrategy>): void;
get(params: Params$Resource$Placementstrategies$Get, callback: BodyResponseCallback<Schema$PlacementStrategy>): void;
get(callback: BodyResponseCallback<Schema$PlacementStrategy>): void;
/**
* dfareporting.placementStrategies.insert
* @desc Inserts a new placement strategy.
* @alias dfareporting.placementStrategies.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {().PlacementStrategy} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
insert(params?: Params$Resource$Placementstrategies$Insert, options?: MethodOptions): GaxiosPromise<Schema$PlacementStrategy>;
insert(params: Params$Resource$Placementstrategies$Insert, options: MethodOptions | BodyResponseCallback<Schema$PlacementStrategy>, callback: BodyResponseCallback<Schema$PlacementStrategy>): void;
insert(params: Params$Resource$Placementstrategies$Insert, callback: BodyResponseCallback<Schema$PlacementStrategy>): void;
insert(callback: BodyResponseCallback<Schema$PlacementStrategy>): void;
/**
* dfareporting.placementStrategies.list
* @desc Retrieves a list of placement strategies, possibly filtered. This method supports paging.
* @alias dfareporting.placementStrategies.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.ids Select only placement strategies with these IDs.
* @param {integer=} params.maxResults Maximum number of results to return.
* @param {string=} params.pageToken Value of the nextPageToken from the previous result page.
* @param {string} params.profileId User profile ID associated with this request.
* @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "placementstrategy*2015" will return objects with names like "placementstrategy June 2015", "placementstrategy April 2015", or simply "placementstrategy 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placementstrategy" will match objects with name "my placementstrategy", "placementstrategy 2015", or simply "placementstrategy".
* @param {string=} params.sortField Field by which to sort the list.
* @param {string=} params.sortOrder Order of sorted results.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Placementstrategies$List, options?: MethodOptions): GaxiosPromise<Schema$PlacementStrategiesListResponse>;
list(params: Params$Resource$Placementstrategies$List, options: MethodOptions | BodyResponseCallback<Schema$PlacementStrategiesListResponse>, callback: BodyResponseCallback<Schema$PlacementStrategiesListResponse>): void;
list(params: Params$Resource$Placementstrategies$List, callback: BodyResponseCallback<Schema$PlacementStrategiesListResponse>): void;
list(callback: BodyResponseCallback<Schema$PlacementStrategiesListResponse>): void;
/**
* dfareporting.placementStrategies.patch
* @desc Updates an existing placement strategy. This method supports patch semantics.
* @alias dfareporting.placementStrategies.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Placement strategy ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {().PlacementStrategy} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Placementstrategies$Patch, options?: MethodOptions): GaxiosPromise<Schema$PlacementStrategy>;
patch(params: Params$Resource$Placementstrategies$Patch, options: MethodOptions | BodyResponseCallback<Schema$PlacementStrategy>, callback: BodyResponseCallback<Schema$PlacementStrategy>): void;
patch(params: Params$Resource$Placementstrategies$Patch, callback: BodyResponseCallback<Schema$PlacementStrategy>): void;
patch(callback: BodyResponseCallback<Schema$PlacementStrategy>): void;
/**
* dfareporting.placementStrategies.update
* @desc Updates an existing placement strategy.
* @alias dfareporting.placementStrategies.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {().PlacementStrategy} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update(params?: Params$Resource$Placementstrategies$Update, options?: MethodOptions): GaxiosPromise<Schema$PlacementStrategy>;
update(params: Params$Resource$Placementstrategies$Update, options: MethodOptions | BodyResponseCallback<Schema$PlacementStrategy>, callback: BodyResponseCallback<Schema$PlacementStrategy>): void;
update(params: Params$Resource$Placementstrategies$Update, callback: BodyResponseCallback<Schema$PlacementStrategy>): void;
update(callback: BodyResponseCallback<Schema$PlacementStrategy>): void;
}
export interface Params$Resource$Placementstrategies$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Placement strategy ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export interface Params$Resource$Placementstrategies$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Placement strategy ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export interface Params$Resource$Placementstrategies$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$PlacementStrategy;
}
export interface Params$Resource$Placementstrategies$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Select only placement strategies with these IDs.
*/
ids?: string[];
/**
* Maximum number of results to return.
*/
maxResults?: number;
/**
* Value of the nextPageToken from the previous result page.
*/
pageToken?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "placementstrategy*2015" will return objects with names like "placementstrategy June 2015", "placementstrategy April 2015", or simply "placementstrategy 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placementstrategy" will match objects with name "my placementstrategy", "placementstrategy 2015", or simply "placementstrategy".
*/
searchString?: string;
/**
* Field by which to sort the list.
*/
sortField?: string;
/**
* Order of sorted results.
*/
sortOrder?: string;
}
export interface Params$Resource$Placementstrategies$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Placement strategy ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$PlacementStrategy;
}
export interface Params$Resource$Placementstrategies$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$PlacementStrategy;
}
export class Resource$Platformtypes {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.platformTypes.get
* @desc Gets one platform type by ID.
* @alias dfareporting.platformTypes.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Platform type ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Platformtypes$Get, options?: MethodOptions): GaxiosPromise<Schema$PlatformType>;
get(params: Params$Resource$Platformtypes$Get, options: MethodOptions | BodyResponseCallback<Schema$PlatformType>, callback: BodyResponseCallback<Schema$PlatformType>): void;
get(params: Params$Resource$Platformtypes$Get, callback: BodyResponseCallback<Schema$PlatformType>): void;
get(callback: BodyResponseCallback<Schema$PlatformType>): void;
/**
* dfareporting.platformTypes.list
* @desc Retrieves a list of platform types.
* @alias dfareporting.platformTypes.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Platformtypes$List, options?: MethodOptions): GaxiosPromise<Schema$PlatformTypesListResponse>;
list(params: Params$Resource$Platformtypes$List, options: MethodOptions | BodyResponseCallback<Schema$PlatformTypesListResponse>, callback: BodyResponseCallback<Schema$PlatformTypesListResponse>): void;
list(params: Params$Resource$Platformtypes$List, callback: BodyResponseCallback<Schema$PlatformTypesListResponse>): void;
list(callback: BodyResponseCallback<Schema$PlatformTypesListResponse>): void;
}
export interface Params$Resource$Platformtypes$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Platform type ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export interface Params$Resource$Platformtypes$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export class Resource$Postalcodes {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.postalCodes.get
* @desc Gets one postal code by ID.
* @alias dfareporting.postalCodes.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.code Postal code ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Postalcodes$Get, options?: MethodOptions): GaxiosPromise<Schema$PostalCode>;
get(params: Params$Resource$Postalcodes$Get, options: MethodOptions | BodyResponseCallback<Schema$PostalCode>, callback: BodyResponseCallback<Schema$PostalCode>): void;
get(params: Params$Resource$Postalcodes$Get, callback: BodyResponseCallback<Schema$PostalCode>): void;
get(callback: BodyResponseCallback<Schema$PostalCode>): void;
/**
* dfareporting.postalCodes.list
* @desc Retrieves a list of postal codes.
* @alias dfareporting.postalCodes.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Postalcodes$List, options?: MethodOptions): GaxiosPromise<Schema$PostalCodesListResponse>;
list(params: Params$Resource$Postalcodes$List, options: MethodOptions | BodyResponseCallback<Schema$PostalCodesListResponse>, callback: BodyResponseCallback<Schema$PostalCodesListResponse>): void;
list(params: Params$Resource$Postalcodes$List, callback: BodyResponseCallback<Schema$PostalCodesListResponse>): void;
list(callback: BodyResponseCallback<Schema$PostalCodesListResponse>): void;
}
export interface Params$Resource$Postalcodes$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Postal code ID.
*/
code?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export interface Params$Resource$Postalcodes$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export class Resource$Projects {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.projects.get
* @desc Gets one project by ID.
* @alias dfareporting.projects.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Project ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Projects$Get, options?: MethodOptions): GaxiosPromise<Schema$Project>;
get(params: Params$Resource$Projects$Get, options: MethodOptions | BodyResponseCallback<Schema$Project>, callback: BodyResponseCallback<Schema$Project>): void;
get(params: Params$Resource$Projects$Get, callback: BodyResponseCallback<Schema$Project>): void;
get(callback: BodyResponseCallback<Schema$Project>): void;
/**
* dfareporting.projects.list
* @desc Retrieves a list of projects, possibly filtered. This method supports paging.
* @alias dfareporting.projects.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.advertiserIds Select only projects with these advertiser IDs.
* @param {string=} params.ids Select only projects with these IDs.
* @param {integer=} params.maxResults Maximum number of results to return.
* @param {string=} params.pageToken Value of the nextPageToken from the previous result page.
* @param {string} params.profileId User profile ID associated with this request.
* @param {string=} params.searchString Allows searching for projects by name or ID. Wildcards (*) are allowed. For example, "project*2015" will return projects with names like "project June 2015", "project April 2015", or simply "project 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "project" will match projects with name "my project", "project 2015", or simply "project".
* @param {string=} params.sortField Field by which to sort the list.
* @param {string=} params.sortOrder Order of sorted results.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Projects$List, options?: MethodOptions): GaxiosPromise<Schema$ProjectsListResponse>;
list(params: Params$Resource$Projects$List, options: MethodOptions | BodyResponseCallback<Schema$ProjectsListResponse>, callback: BodyResponseCallback<Schema$ProjectsListResponse>): void;
list(params: Params$Resource$Projects$List, callback: BodyResponseCallback<Schema$ProjectsListResponse>): void;
list(callback: BodyResponseCallback<Schema$ProjectsListResponse>): void;
}
export interface Params$Resource$Projects$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Project ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export interface Params$Resource$Projects$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Select only projects with these advertiser IDs.
*/
advertiserIds?: string[];
/**
* Select only projects with these IDs.
*/
ids?: string[];
/**
* Maximum number of results to return.
*/
maxResults?: number;
/**
* Value of the nextPageToken from the previous result page.
*/
pageToken?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Allows searching for projects by name or ID. Wildcards (*) are allowed. For example, "project*2015" will return projects with names like "project June 2015", "project April 2015", or simply "project 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "project" will match projects with name "my project", "project 2015", or simply "project".
*/
searchString?: string;
/**
* Field by which to sort the list.
*/
sortField?: string;
/**
* Order of sorted results.
*/
sortOrder?: string;
}
export class Resource$Regions {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.regions.list
* @desc Retrieves a list of regions.
* @alias dfareporting.regions.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Regions$List, options?: MethodOptions): GaxiosPromise<Schema$RegionsListResponse>;
list(params: Params$Resource$Regions$List, options: MethodOptions | BodyResponseCallback<Schema$RegionsListResponse>, callback: BodyResponseCallback<Schema$RegionsListResponse>): void;
list(params: Params$Resource$Regions$List, callback: BodyResponseCallback<Schema$RegionsListResponse>): void;
list(callback: BodyResponseCallback<Schema$RegionsListResponse>): void;
}
export interface Params$Resource$Regions$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export class Resource$Remarketinglists {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.remarketingLists.get
* @desc Gets one remarketing list by ID.
* @alias dfareporting.remarketingLists.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Remarketing list ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Remarketinglists$Get, options?: MethodOptions): GaxiosPromise<Schema$RemarketingList>;
get(params: Params$Resource$Remarketinglists$Get, options: MethodOptions | BodyResponseCallback<Schema$RemarketingList>, callback: BodyResponseCallback<Schema$RemarketingList>): void;
get(params: Params$Resource$Remarketinglists$Get, callback: BodyResponseCallback<Schema$RemarketingList>): void;
get(callback: BodyResponseCallback<Schema$RemarketingList>): void;
/**
* dfareporting.remarketingLists.insert
* @desc Inserts a new remarketing list.
* @alias dfareporting.remarketingLists.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {().RemarketingList} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
insert(params?: Params$Resource$Remarketinglists$Insert, options?: MethodOptions): GaxiosPromise<Schema$RemarketingList>;
insert(params: Params$Resource$Remarketinglists$Insert, options: MethodOptions | BodyResponseCallback<Schema$RemarketingList>, callback: BodyResponseCallback<Schema$RemarketingList>): void;
insert(params: Params$Resource$Remarketinglists$Insert, callback: BodyResponseCallback<Schema$RemarketingList>): void;
insert(callback: BodyResponseCallback<Schema$RemarketingList>): void;
/**
* dfareporting.remarketingLists.list
* @desc Retrieves a list of remarketing lists, possibly filtered. This method supports paging.
* @alias dfareporting.remarketingLists.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.active Select only active or only inactive remarketing lists.
* @param {string} params.advertiserId Select only remarketing lists owned by this advertiser.
* @param {string=} params.floodlightActivityId Select only remarketing lists that have this floodlight activity ID.
* @param {integer=} params.maxResults Maximum number of results to return.
* @param {string=} params.name Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "remarketing list*2015" will return objects with names like "remarketing list June 2015", "remarketing list April 2015", or simply "remarketing list 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "remarketing list" will match objects with name "my remarketing list", "remarketing list 2015", or simply "remarketing list".
* @param {string=} params.pageToken Value of the nextPageToken from the previous result page.
* @param {string} params.profileId User profile ID associated with this request.
* @param {string=} params.sortField Field by which to sort the list.
* @param {string=} params.sortOrder Order of sorted results.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Remarketinglists$List, options?: MethodOptions): GaxiosPromise<Schema$RemarketingListsListResponse>;
list(params: Params$Resource$Remarketinglists$List, options: MethodOptions | BodyResponseCallback<Schema$RemarketingListsListResponse>, callback: BodyResponseCallback<Schema$RemarketingListsListResponse>): void;
list(params: Params$Resource$Remarketinglists$List, callback: BodyResponseCallback<Schema$RemarketingListsListResponse>): void;
list(callback: BodyResponseCallback<Schema$RemarketingListsListResponse>): void;
/**
* dfareporting.remarketingLists.patch
* @desc Updates an existing remarketing list. This method supports patch semantics.
* @alias dfareporting.remarketingLists.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Remarketing list ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {().RemarketingList} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Remarketinglists$Patch, options?: MethodOptions): GaxiosPromise<Schema$RemarketingList>;
patch(params: Params$Resource$Remarketinglists$Patch, options: MethodOptions | BodyResponseCallback<Schema$RemarketingList>, callback: BodyResponseCallback<Schema$RemarketingList>): void;
patch(params: Params$Resource$Remarketinglists$Patch, callback: BodyResponseCallback<Schema$RemarketingList>): void;
patch(callback: BodyResponseCallback<Schema$RemarketingList>): void;
/**
* dfareporting.remarketingLists.update
* @desc Updates an existing remarketing list.
* @alias dfareporting.remarketingLists.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {().RemarketingList} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update(params?: Params$Resource$Remarketinglists$Update, options?: MethodOptions): GaxiosPromise<Schema$RemarketingList>;
update(params: Params$Resource$Remarketinglists$Update, options: MethodOptions | BodyResponseCallback<Schema$RemarketingList>, callback: BodyResponseCallback<Schema$RemarketingList>): void;
update(params: Params$Resource$Remarketinglists$Update, callback: BodyResponseCallback<Schema$RemarketingList>): void;
update(callback: BodyResponseCallback<Schema$RemarketingList>): void;
}
export interface Params$Resource$Remarketinglists$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Remarketing list ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export interface Params$Resource$Remarketinglists$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$RemarketingList;
}
export interface Params$Resource$Remarketinglists$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Select only active or only inactive remarketing lists.
*/
active?: boolean;
/**
* Select only remarketing lists owned by this advertiser.
*/
advertiserId?: string;
/**
* Select only remarketing lists that have this floodlight activity ID.
*/
floodlightActivityId?: string;
/**
* Maximum number of results to return.
*/
maxResults?: number;
/**
* Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "remarketing list*2015" will return objects with names like "remarketing list June 2015", "remarketing list April 2015", or simply "remarketing list 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "remarketing list" will match objects with name "my remarketing list", "remarketing list 2015", or simply "remarketing list".
*/
name?: string;
/**
* Value of the nextPageToken from the previous result page.
*/
pageToken?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Field by which to sort the list.
*/
sortField?: string;
/**
* Order of sorted results.
*/
sortOrder?: string;
}
export interface Params$Resource$Remarketinglists$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Remarketing list ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$RemarketingList;
}
export interface Params$Resource$Remarketinglists$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$RemarketingList;
}
export class Resource$Remarketinglistshares {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.remarketingListShares.get
* @desc Gets one remarketing list share by remarketing list ID.
* @alias dfareporting.remarketingListShares.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {string} params.remarketingListId Remarketing list ID.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Remarketinglistshares$Get, options?: MethodOptions): GaxiosPromise<Schema$RemarketingListShare>;
get(params: Params$Resource$Remarketinglistshares$Get, options: MethodOptions | BodyResponseCallback<Schema$RemarketingListShare>, callback: BodyResponseCallback<Schema$RemarketingListShare>): void;
get(params: Params$Resource$Remarketinglistshares$Get, callback: BodyResponseCallback<Schema$RemarketingListShare>): void;
get(callback: BodyResponseCallback<Schema$RemarketingListShare>): void;
/**
* dfareporting.remarketingListShares.patch
* @desc Updates an existing remarketing list share. This method supports patch semantics.
* @alias dfareporting.remarketingListShares.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {string} params.remarketingListId Remarketing list ID.
* @param {().RemarketingListShare} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Remarketinglistshares$Patch, options?: MethodOptions): GaxiosPromise<Schema$RemarketingListShare>;
patch(params: Params$Resource$Remarketinglistshares$Patch, options: MethodOptions | BodyResponseCallback<Schema$RemarketingListShare>, callback: BodyResponseCallback<Schema$RemarketingListShare>): void;
patch(params: Params$Resource$Remarketinglistshares$Patch, callback: BodyResponseCallback<Schema$RemarketingListShare>): void;
patch(callback: BodyResponseCallback<Schema$RemarketingListShare>): void;
/**
* dfareporting.remarketingListShares.update
* @desc Updates an existing remarketing list share.
* @alias dfareporting.remarketingListShares.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {().RemarketingListShare} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update(params?: Params$Resource$Remarketinglistshares$Update, options?: MethodOptions): GaxiosPromise<Schema$RemarketingListShare>;
update(params: Params$Resource$Remarketinglistshares$Update, options: MethodOptions | BodyResponseCallback<Schema$RemarketingListShare>, callback: BodyResponseCallback<Schema$RemarketingListShare>): void;
update(params: Params$Resource$Remarketinglistshares$Update, callback: BodyResponseCallback<Schema$RemarketingListShare>): void;
update(callback: BodyResponseCallback<Schema$RemarketingListShare>): void;
}
export interface Params$Resource$Remarketinglistshares$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Remarketing list ID.
*/
remarketingListId?: string;
}
export interface Params$Resource$Remarketinglistshares$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Remarketing list ID.
*/
remarketingListId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$RemarketingListShare;
}
export interface Params$Resource$Remarketinglistshares$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$RemarketingListShare;
}
export class Resource$Reports {
context: APIRequestContext;
compatibleFields: Resource$Reports$Compatiblefields;
files: Resource$Reports$Files;
constructor(context: APIRequestContext);
/**
* dfareporting.reports.delete
* @desc Deletes a report by its ID.
* @alias dfareporting.reports.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId The DFA user profile ID.
* @param {string} params.reportId The ID of the report.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Reports$Delete, options?: MethodOptions): GaxiosPromise<void>;
delete(params: Params$Resource$Reports$Delete, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
delete(params: Params$Resource$Reports$Delete, callback: BodyResponseCallback<void>): void;
delete(callback: BodyResponseCallback<void>): void;
/**
* dfareporting.reports.get
* @desc Retrieves a report by its ID.
* @alias dfareporting.reports.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId The DFA user profile ID.
* @param {string} params.reportId The ID of the report.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Reports$Get, options?: MethodOptions): GaxiosPromise<Schema$Report>;
get(params: Params$Resource$Reports$Get, options: MethodOptions | BodyResponseCallback<Schema$Report>, callback: BodyResponseCallback<Schema$Report>): void;
get(params: Params$Resource$Reports$Get, callback: BodyResponseCallback<Schema$Report>): void;
get(callback: BodyResponseCallback<Schema$Report>): void;
/**
* dfareporting.reports.insert
* @desc Creates a report.
* @alias dfareporting.reports.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId The DFA user profile ID.
* @param {().Report} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
insert(params?: Params$Resource$Reports$Insert, options?: MethodOptions): GaxiosPromise<Schema$Report>;
insert(params: Params$Resource$Reports$Insert, options: MethodOptions | BodyResponseCallback<Schema$Report>, callback: BodyResponseCallback<Schema$Report>): void;
insert(params: Params$Resource$Reports$Insert, callback: BodyResponseCallback<Schema$Report>): void;
insert(callback: BodyResponseCallback<Schema$Report>): void;
/**
* dfareporting.reports.list
* @desc Retrieves list of reports.
* @alias dfareporting.reports.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.maxResults Maximum number of results to return.
* @param {string=} params.pageToken The value of the nextToken from the previous result page.
* @param {string} params.profileId The DFA user profile ID.
* @param {string=} params.scope The scope that defines which results are returned.
* @param {string=} params.sortField The field by which to sort the list.
* @param {string=} params.sortOrder Order of sorted results.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Reports$List, options?: MethodOptions): GaxiosPromise<Schema$ReportList>;
list(params: Params$Resource$Reports$List, options: MethodOptions | BodyResponseCallback<Schema$ReportList>, callback: BodyResponseCallback<Schema$ReportList>): void;
list(params: Params$Resource$Reports$List, callback: BodyResponseCallback<Schema$ReportList>): void;
list(callback: BodyResponseCallback<Schema$ReportList>): void;
/**
* dfareporting.reports.patch
* @desc Updates a report. This method supports patch semantics.
* @alias dfareporting.reports.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId The DFA user profile ID.
* @param {string} params.reportId The ID of the report.
* @param {().Report} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Reports$Patch, options?: MethodOptions): GaxiosPromise<Schema$Report>;
patch(params: Params$Resource$Reports$Patch, options: MethodOptions | BodyResponseCallback<Schema$Report>, callback: BodyResponseCallback<Schema$Report>): void;
patch(params: Params$Resource$Reports$Patch, callback: BodyResponseCallback<Schema$Report>): void;
patch(callback: BodyResponseCallback<Schema$Report>): void;
/**
* dfareporting.reports.run
* @desc Runs a report.
* @alias dfareporting.reports.run
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId The DFA profile ID.
* @param {string} params.reportId The ID of the report.
* @param {boolean=} params.synchronous If set and true, tries to run the report synchronously.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
run(params?: Params$Resource$Reports$Run, options?: MethodOptions): GaxiosPromise<Schema$File>;
run(params: Params$Resource$Reports$Run, options: MethodOptions | BodyResponseCallback<Schema$File>, callback: BodyResponseCallback<Schema$File>): void;
run(params: Params$Resource$Reports$Run, callback: BodyResponseCallback<Schema$File>): void;
run(callback: BodyResponseCallback<Schema$File>): void;
/**
* dfareporting.reports.update
* @desc Updates a report.
* @alias dfareporting.reports.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId The DFA user profile ID.
* @param {string} params.reportId The ID of the report.
* @param {().Report} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update(params?: Params$Resource$Reports$Update, options?: MethodOptions): GaxiosPromise<Schema$Report>;
update(params: Params$Resource$Reports$Update, options: MethodOptions | BodyResponseCallback<Schema$Report>, callback: BodyResponseCallback<Schema$Report>): void;
update(params: Params$Resource$Reports$Update, callback: BodyResponseCallback<Schema$Report>): void;
update(callback: BodyResponseCallback<Schema$Report>): void;
}
export interface Params$Resource$Reports$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The DFA user profile ID.
*/
profileId?: string;
/**
* The ID of the report.
*/
reportId?: string;
}
export interface Params$Resource$Reports$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The DFA user profile ID.
*/
profileId?: string;
/**
* The ID of the report.
*/
reportId?: string;
}
export interface Params$Resource$Reports$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The DFA user profile ID.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Report;
}
export interface Params$Resource$Reports$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Maximum number of results to return.
*/
maxResults?: number;
/**
* The value of the nextToken from the previous result page.
*/
pageToken?: string;
/**
* The DFA user profile ID.
*/
profileId?: string;
/**
* The scope that defines which results are returned.
*/
scope?: string;
/**
* The field by which to sort the list.
*/
sortField?: string;
/**
* Order of sorted results.
*/
sortOrder?: string;
}
export interface Params$Resource$Reports$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The DFA user profile ID.
*/
profileId?: string;
/**
* The ID of the report.
*/
reportId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Report;
}
export interface Params$Resource$Reports$Run extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The DFA profile ID.
*/
profileId?: string;
/**
* The ID of the report.
*/
reportId?: string;
/**
* If set and true, tries to run the report synchronously.
*/
synchronous?: boolean;
}
export interface Params$Resource$Reports$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The DFA user profile ID.
*/
profileId?: string;
/**
* The ID of the report.
*/
reportId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Report;
}
export class Resource$Reports$Compatiblefields {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.reports.compatibleFields.query
* @desc Returns the fields that are compatible to be selected in the respective sections of a report criteria, given the fields already selected in the input report and user permissions.
* @alias dfareporting.reports.compatibleFields.query
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId The DFA user profile ID.
* @param {().Report} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
query(params?: Params$Resource$Reports$Compatiblefields$Query, options?: MethodOptions): GaxiosPromise<Schema$CompatibleFields>;
query(params: Params$Resource$Reports$Compatiblefields$Query, options: MethodOptions | BodyResponseCallback<Schema$CompatibleFields>, callback: BodyResponseCallback<Schema$CompatibleFields>): void;
query(params: Params$Resource$Reports$Compatiblefields$Query, callback: BodyResponseCallback<Schema$CompatibleFields>): void;
query(callback: BodyResponseCallback<Schema$CompatibleFields>): void;
}
export interface Params$Resource$Reports$Compatiblefields$Query extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The DFA user profile ID.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Report;
}
export class Resource$Reports$Files {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.reports.files.get
* @desc Retrieves a report file. This method supports media download.
* @alias dfareporting.reports.files.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.fileId The ID of the report file.
* @param {string} params.profileId The DFA profile ID.
* @param {string} params.reportId The ID of the report.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Reports$Files$Get, options?: MethodOptions): GaxiosPromise<Schema$File>;
get(params: Params$Resource$Reports$Files$Get, options: MethodOptions | BodyResponseCallback<Schema$File>, callback: BodyResponseCallback<Schema$File>): void;
get(params: Params$Resource$Reports$Files$Get, callback: BodyResponseCallback<Schema$File>): void;
get(callback: BodyResponseCallback<Schema$File>): void;
/**
* dfareporting.reports.files.list
* @desc Lists files for a report.
* @alias dfareporting.reports.files.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.maxResults Maximum number of results to return.
* @param {string=} params.pageToken The value of the nextToken from the previous result page.
* @param {string} params.profileId The DFA profile ID.
* @param {string} params.reportId The ID of the parent report.
* @param {string=} params.sortField The field by which to sort the list.
* @param {string=} params.sortOrder Order of sorted results.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Reports$Files$List, options?: MethodOptions): GaxiosPromise<Schema$FileList>;
list(params: Params$Resource$Reports$Files$List, options: MethodOptions | BodyResponseCallback<Schema$FileList>, callback: BodyResponseCallback<Schema$FileList>): void;
list(params: Params$Resource$Reports$Files$List, callback: BodyResponseCallback<Schema$FileList>): void;
list(callback: BodyResponseCallback<Schema$FileList>): void;
}
export interface Params$Resource$Reports$Files$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the report file.
*/
fileId?: string;
/**
* The DFA profile ID.
*/
profileId?: string;
/**
* The ID of the report.
*/
reportId?: string;
}
export interface Params$Resource$Reports$Files$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Maximum number of results to return.
*/
maxResults?: number;
/**
* The value of the nextToken from the previous result page.
*/
pageToken?: string;
/**
* The DFA profile ID.
*/
profileId?: string;
/**
* The ID of the parent report.
*/
reportId?: string;
/**
* The field by which to sort the list.
*/
sortField?: string;
/**
* Order of sorted results.
*/
sortOrder?: string;
}
export class Resource$Sites {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.sites.get
* @desc Gets one site by ID.
* @alias dfareporting.sites.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Site ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Sites$Get, options?: MethodOptions): GaxiosPromise<Schema$Site>;
get(params: Params$Resource$Sites$Get, options: MethodOptions | BodyResponseCallback<Schema$Site>, callback: BodyResponseCallback<Schema$Site>): void;
get(params: Params$Resource$Sites$Get, callback: BodyResponseCallback<Schema$Site>): void;
get(callback: BodyResponseCallback<Schema$Site>): void;
/**
* dfareporting.sites.insert
* @desc Inserts a new site.
* @alias dfareporting.sites.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {().Site} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
insert(params?: Params$Resource$Sites$Insert, options?: MethodOptions): GaxiosPromise<Schema$Site>;
insert(params: Params$Resource$Sites$Insert, options: MethodOptions | BodyResponseCallback<Schema$Site>, callback: BodyResponseCallback<Schema$Site>): void;
insert(params: Params$Resource$Sites$Insert, callback: BodyResponseCallback<Schema$Site>): void;
insert(callback: BodyResponseCallback<Schema$Site>): void;
/**
* dfareporting.sites.list
* @desc Retrieves a list of sites, possibly filtered. This method supports paging.
* @alias dfareporting.sites.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.acceptsInStreamVideoPlacements This search filter is no longer supported and will have no effect on the results returned.
* @param {boolean=} params.acceptsInterstitialPlacements This search filter is no longer supported and will have no effect on the results returned.
* @param {boolean=} params.acceptsPublisherPaidPlacements Select only sites that accept publisher paid placements.
* @param {boolean=} params.adWordsSite Select only AdWords sites.
* @param {boolean=} params.approved Select only approved sites.
* @param {string=} params.campaignIds Select only sites with these campaign IDs.
* @param {string=} params.directorySiteIds Select only sites with these directory site IDs.
* @param {string=} params.ids Select only sites with these IDs.
* @param {integer=} params.maxResults Maximum number of results to return.
* @param {string=} params.pageToken Value of the nextPageToken from the previous result page.
* @param {string} params.profileId User profile ID associated with this request.
* @param {string=} params.searchString Allows searching for objects by name, ID or keyName. Wildcards (*) are allowed. For example, "site*2015" will return objects with names like "site June 2015", "site April 2015", or simply "site 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "site" will match objects with name "my site", "site 2015", or simply "site".
* @param {string=} params.sortField Field by which to sort the list.
* @param {string=} params.sortOrder Order of sorted results.
* @param {string=} params.subaccountId Select only sites with this subaccount ID.
* @param {boolean=} params.unmappedSite Select only sites that have not been mapped to a directory site.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Sites$List, options?: MethodOptions): GaxiosPromise<Schema$SitesListResponse>;
list(params: Params$Resource$Sites$List, options: MethodOptions | BodyResponseCallback<Schema$SitesListResponse>, callback: BodyResponseCallback<Schema$SitesListResponse>): void;
list(params: Params$Resource$Sites$List, callback: BodyResponseCallback<Schema$SitesListResponse>): void;
list(callback: BodyResponseCallback<Schema$SitesListResponse>): void;
/**
* dfareporting.sites.patch
* @desc Updates an existing site. This method supports patch semantics.
* @alias dfareporting.sites.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Site ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {().Site} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Sites$Patch, options?: MethodOptions): GaxiosPromise<Schema$Site>;
patch(params: Params$Resource$Sites$Patch, options: MethodOptions | BodyResponseCallback<Schema$Site>, callback: BodyResponseCallback<Schema$Site>): void;
patch(params: Params$Resource$Sites$Patch, callback: BodyResponseCallback<Schema$Site>): void;
patch(callback: BodyResponseCallback<Schema$Site>): void;
/**
* dfareporting.sites.update
* @desc Updates an existing site.
* @alias dfareporting.sites.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {().Site} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update(params?: Params$Resource$Sites$Update, options?: MethodOptions): GaxiosPromise<Schema$Site>;
update(params: Params$Resource$Sites$Update, options: MethodOptions | BodyResponseCallback<Schema$Site>, callback: BodyResponseCallback<Schema$Site>): void;
update(params: Params$Resource$Sites$Update, callback: BodyResponseCallback<Schema$Site>): void;
update(callback: BodyResponseCallback<Schema$Site>): void;
}
export interface Params$Resource$Sites$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Site ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export interface Params$Resource$Sites$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Site;
}
export interface Params$Resource$Sites$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* This search filter is no longer supported and will have no effect on the results returned.
*/
acceptsInStreamVideoPlacements?: boolean;
/**
* This search filter is no longer supported and will have no effect on the results returned.
*/
acceptsInterstitialPlacements?: boolean;
/**
* Select only sites that accept publisher paid placements.
*/
acceptsPublisherPaidPlacements?: boolean;
/**
* Select only AdWords sites.
*/
adWordsSite?: boolean;
/**
* Select only approved sites.
*/
approved?: boolean;
/**
* Select only sites with these campaign IDs.
*/
campaignIds?: string[];
/**
* Select only sites with these directory site IDs.
*/
directorySiteIds?: string[];
/**
* Select only sites with these IDs.
*/
ids?: string[];
/**
* Maximum number of results to return.
*/
maxResults?: number;
/**
* Value of the nextPageToken from the previous result page.
*/
pageToken?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Allows searching for objects by name, ID or keyName. Wildcards (*) are allowed. For example, "site*2015" will return objects with names like "site June 2015", "site April 2015", or simply "site 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "site" will match objects with name "my site", "site 2015", or simply "site".
*/
searchString?: string;
/**
* Field by which to sort the list.
*/
sortField?: string;
/**
* Order of sorted results.
*/
sortOrder?: string;
/**
* Select only sites with this subaccount ID.
*/
subaccountId?: string;
/**
* Select only sites that have not been mapped to a directory site.
*/
unmappedSite?: boolean;
}
export interface Params$Resource$Sites$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Site ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Site;
}
export interface Params$Resource$Sites$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Site;
}
export class Resource$Sizes {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.sizes.get
* @desc Gets one size by ID.
* @alias dfareporting.sizes.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Size ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Sizes$Get, options?: MethodOptions): GaxiosPromise<Schema$Size>;
get(params: Params$Resource$Sizes$Get, options: MethodOptions | BodyResponseCallback<Schema$Size>, callback: BodyResponseCallback<Schema$Size>): void;
get(params: Params$Resource$Sizes$Get, callback: BodyResponseCallback<Schema$Size>): void;
get(callback: BodyResponseCallback<Schema$Size>): void;
/**
* dfareporting.sizes.insert
* @desc Inserts a new size.
* @alias dfareporting.sizes.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {().Size} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
insert(params?: Params$Resource$Sizes$Insert, options?: MethodOptions): GaxiosPromise<Schema$Size>;
insert(params: Params$Resource$Sizes$Insert, options: MethodOptions | BodyResponseCallback<Schema$Size>, callback: BodyResponseCallback<Schema$Size>): void;
insert(params: Params$Resource$Sizes$Insert, callback: BodyResponseCallback<Schema$Size>): void;
insert(callback: BodyResponseCallback<Schema$Size>): void;
/**
* dfareporting.sizes.list
* @desc Retrieves a list of sizes, possibly filtered. Retrieved sizes are globally unique and may include values not currently in use by your account. Due to this, the list of sizes returned by this method may differ from the list seen in the Trafficking UI.
* @alias dfareporting.sizes.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.height Select only sizes with this height.
* @param {boolean=} params.iabStandard Select only IAB standard sizes.
* @param {string=} params.ids Select only sizes with these IDs.
* @param {string} params.profileId User profile ID associated with this request.
* @param {integer=} params.width Select only sizes with this width.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Sizes$List, options?: MethodOptions): GaxiosPromise<Schema$SizesListResponse>;
list(params: Params$Resource$Sizes$List, options: MethodOptions | BodyResponseCallback<Schema$SizesListResponse>, callback: BodyResponseCallback<Schema$SizesListResponse>): void;
list(params: Params$Resource$Sizes$List, callback: BodyResponseCallback<Schema$SizesListResponse>): void;
list(callback: BodyResponseCallback<Schema$SizesListResponse>): void;
}
export interface Params$Resource$Sizes$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Size ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export interface Params$Resource$Sizes$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Size;
}
export interface Params$Resource$Sizes$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Select only sizes with this height.
*/
height?: number;
/**
* Select only IAB standard sizes.
*/
iabStandard?: boolean;
/**
* Select only sizes with these IDs.
*/
ids?: string[];
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Select only sizes with this width.
*/
width?: number;
}
export class Resource$Subaccounts {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.subaccounts.get
* @desc Gets one subaccount by ID.
* @alias dfareporting.subaccounts.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Subaccount ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Subaccounts$Get, options?: MethodOptions): GaxiosPromise<Schema$Subaccount>;
get(params: Params$Resource$Subaccounts$Get, options: MethodOptions | BodyResponseCallback<Schema$Subaccount>, callback: BodyResponseCallback<Schema$Subaccount>): void;
get(params: Params$Resource$Subaccounts$Get, callback: BodyResponseCallback<Schema$Subaccount>): void;
get(callback: BodyResponseCallback<Schema$Subaccount>): void;
/**
* dfareporting.subaccounts.insert
* @desc Inserts a new subaccount.
* @alias dfareporting.subaccounts.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {().Subaccount} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
insert(params?: Params$Resource$Subaccounts$Insert, options?: MethodOptions): GaxiosPromise<Schema$Subaccount>;
insert(params: Params$Resource$Subaccounts$Insert, options: MethodOptions | BodyResponseCallback<Schema$Subaccount>, callback: BodyResponseCallback<Schema$Subaccount>): void;
insert(params: Params$Resource$Subaccounts$Insert, callback: BodyResponseCallback<Schema$Subaccount>): void;
insert(callback: BodyResponseCallback<Schema$Subaccount>): void;
/**
* dfareporting.subaccounts.list
* @desc Gets a list of subaccounts, possibly filtered. This method supports paging.
* @alias dfareporting.subaccounts.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.ids Select only subaccounts with these IDs.
* @param {integer=} params.maxResults Maximum number of results to return.
* @param {string=} params.pageToken Value of the nextPageToken from the previous result page.
* @param {string} params.profileId User profile ID associated with this request.
* @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "subaccount*2015" will return objects with names like "subaccount June 2015", "subaccount April 2015", or simply "subaccount 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "subaccount" will match objects with name "my subaccount", "subaccount 2015", or simply "subaccount".
* @param {string=} params.sortField Field by which to sort the list.
* @param {string=} params.sortOrder Order of sorted results.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Subaccounts$List, options?: MethodOptions): GaxiosPromise<Schema$SubaccountsListResponse>;
list(params: Params$Resource$Subaccounts$List, options: MethodOptions | BodyResponseCallback<Schema$SubaccountsListResponse>, callback: BodyResponseCallback<Schema$SubaccountsListResponse>): void;
list(params: Params$Resource$Subaccounts$List, callback: BodyResponseCallback<Schema$SubaccountsListResponse>): void;
list(callback: BodyResponseCallback<Schema$SubaccountsListResponse>): void;
/**
* dfareporting.subaccounts.patch
* @desc Updates an existing subaccount. This method supports patch semantics.
* @alias dfareporting.subaccounts.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Subaccount ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {().Subaccount} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Subaccounts$Patch, options?: MethodOptions): GaxiosPromise<Schema$Subaccount>;
patch(params: Params$Resource$Subaccounts$Patch, options: MethodOptions | BodyResponseCallback<Schema$Subaccount>, callback: BodyResponseCallback<Schema$Subaccount>): void;
patch(params: Params$Resource$Subaccounts$Patch, callback: BodyResponseCallback<Schema$Subaccount>): void;
patch(callback: BodyResponseCallback<Schema$Subaccount>): void;
/**
* dfareporting.subaccounts.update
* @desc Updates an existing subaccount.
* @alias dfareporting.subaccounts.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {().Subaccount} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update(params?: Params$Resource$Subaccounts$Update, options?: MethodOptions): GaxiosPromise<Schema$Subaccount>;
update(params: Params$Resource$Subaccounts$Update, options: MethodOptions | BodyResponseCallback<Schema$Subaccount>, callback: BodyResponseCallback<Schema$Subaccount>): void;
update(params: Params$Resource$Subaccounts$Update, callback: BodyResponseCallback<Schema$Subaccount>): void;
update(callback: BodyResponseCallback<Schema$Subaccount>): void;
}
export interface Params$Resource$Subaccounts$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Subaccount ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export interface Params$Resource$Subaccounts$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Subaccount;
}
export interface Params$Resource$Subaccounts$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Select only subaccounts with these IDs.
*/
ids?: string[];
/**
* Maximum number of results to return.
*/
maxResults?: number;
/**
* Value of the nextPageToken from the previous result page.
*/
pageToken?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "subaccount*2015" will return objects with names like "subaccount June 2015", "subaccount April 2015", or simply "subaccount 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "subaccount" will match objects with name "my subaccount", "subaccount 2015", or simply "subaccount".
*/
searchString?: string;
/**
* Field by which to sort the list.
*/
sortField?: string;
/**
* Order of sorted results.
*/
sortOrder?: string;
}
export interface Params$Resource$Subaccounts$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Subaccount ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Subaccount;
}
export interface Params$Resource$Subaccounts$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Subaccount;
}
export class Resource$Targetableremarketinglists {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.targetableRemarketingLists.get
* @desc Gets one remarketing list by ID.
* @alias dfareporting.targetableRemarketingLists.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Remarketing list ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Targetableremarketinglists$Get, options?: MethodOptions): GaxiosPromise<Schema$TargetableRemarketingList>;
get(params: Params$Resource$Targetableremarketinglists$Get, options: MethodOptions | BodyResponseCallback<Schema$TargetableRemarketingList>, callback: BodyResponseCallback<Schema$TargetableRemarketingList>): void;
get(params: Params$Resource$Targetableremarketinglists$Get, callback: BodyResponseCallback<Schema$TargetableRemarketingList>): void;
get(callback: BodyResponseCallback<Schema$TargetableRemarketingList>): void;
/**
* dfareporting.targetableRemarketingLists.list
* @desc Retrieves a list of targetable remarketing lists, possibly filtered. This method supports paging.
* @alias dfareporting.targetableRemarketingLists.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.active Select only active or only inactive targetable remarketing lists.
* @param {string} params.advertiserId Select only targetable remarketing lists targetable by these advertisers.
* @param {integer=} params.maxResults Maximum number of results to return.
* @param {string=} params.name Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "remarketing list*2015" will return objects with names like "remarketing list June 2015", "remarketing list April 2015", or simply "remarketing list 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "remarketing list" will match objects with name "my remarketing list", "remarketing list 2015", or simply "remarketing list".
* @param {string=} params.pageToken Value of the nextPageToken from the previous result page.
* @param {string} params.profileId User profile ID associated with this request.
* @param {string=} params.sortField Field by which to sort the list.
* @param {string=} params.sortOrder Order of sorted results.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Targetableremarketinglists$List, options?: MethodOptions): GaxiosPromise<Schema$TargetableRemarketingListsListResponse>;
list(params: Params$Resource$Targetableremarketinglists$List, options: MethodOptions | BodyResponseCallback<Schema$TargetableRemarketingListsListResponse>, callback: BodyResponseCallback<Schema$TargetableRemarketingListsListResponse>): void;
list(params: Params$Resource$Targetableremarketinglists$List, callback: BodyResponseCallback<Schema$TargetableRemarketingListsListResponse>): void;
list(callback: BodyResponseCallback<Schema$TargetableRemarketingListsListResponse>): void;
}
export interface Params$Resource$Targetableremarketinglists$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Remarketing list ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export interface Params$Resource$Targetableremarketinglists$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Select only active or only inactive targetable remarketing lists.
*/
active?: boolean;
/**
* Select only targetable remarketing lists targetable by these advertisers.
*/
advertiserId?: string;
/**
* Maximum number of results to return.
*/
maxResults?: number;
/**
* Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "remarketing list*2015" will return objects with names like "remarketing list June 2015", "remarketing list April 2015", or simply "remarketing list 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "remarketing list" will match objects with name "my remarketing list", "remarketing list 2015", or simply "remarketing list".
*/
name?: string;
/**
* Value of the nextPageToken from the previous result page.
*/
pageToken?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Field by which to sort the list.
*/
sortField?: string;
/**
* Order of sorted results.
*/
sortOrder?: string;
}
export class Resource$Targetingtemplates {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.targetingTemplates.get
* @desc Gets one targeting template by ID.
* @alias dfareporting.targetingTemplates.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Targeting template ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Targetingtemplates$Get, options?: MethodOptions): GaxiosPromise<Schema$TargetingTemplate>;
get(params: Params$Resource$Targetingtemplates$Get, options: MethodOptions | BodyResponseCallback<Schema$TargetingTemplate>, callback: BodyResponseCallback<Schema$TargetingTemplate>): void;
get(params: Params$Resource$Targetingtemplates$Get, callback: BodyResponseCallback<Schema$TargetingTemplate>): void;
get(callback: BodyResponseCallback<Schema$TargetingTemplate>): void;
/**
* dfareporting.targetingTemplates.insert
* @desc Inserts a new targeting template.
* @alias dfareporting.targetingTemplates.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {().TargetingTemplate} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
insert(params?: Params$Resource$Targetingtemplates$Insert, options?: MethodOptions): GaxiosPromise<Schema$TargetingTemplate>;
insert(params: Params$Resource$Targetingtemplates$Insert, options: MethodOptions | BodyResponseCallback<Schema$TargetingTemplate>, callback: BodyResponseCallback<Schema$TargetingTemplate>): void;
insert(params: Params$Resource$Targetingtemplates$Insert, callback: BodyResponseCallback<Schema$TargetingTemplate>): void;
insert(callback: BodyResponseCallback<Schema$TargetingTemplate>): void;
/**
* dfareporting.targetingTemplates.list
* @desc Retrieves a list of targeting templates, optionally filtered. This method supports paging.
* @alias dfareporting.targetingTemplates.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.advertiserId Select only targeting templates with this advertiser ID.
* @param {string=} params.ids Select only targeting templates with these IDs.
* @param {integer=} params.maxResults Maximum number of results to return.
* @param {string=} params.pageToken Value of the nextPageToken from the previous result page.
* @param {string} params.profileId User profile ID associated with this request.
* @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "template*2015" will return objects with names like "template June 2015", "template April 2015", or simply "template 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "template" will match objects with name "my template", "template 2015", or simply "template".
* @param {string=} params.sortField Field by which to sort the list.
* @param {string=} params.sortOrder Order of sorted results.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Targetingtemplates$List, options?: MethodOptions): GaxiosPromise<Schema$TargetingTemplatesListResponse>;
list(params: Params$Resource$Targetingtemplates$List, options: MethodOptions | BodyResponseCallback<Schema$TargetingTemplatesListResponse>, callback: BodyResponseCallback<Schema$TargetingTemplatesListResponse>): void;
list(params: Params$Resource$Targetingtemplates$List, callback: BodyResponseCallback<Schema$TargetingTemplatesListResponse>): void;
list(callback: BodyResponseCallback<Schema$TargetingTemplatesListResponse>): void;
/**
* dfareporting.targetingTemplates.patch
* @desc Updates an existing targeting template. This method supports patch semantics.
* @alias dfareporting.targetingTemplates.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id Targeting template ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {().TargetingTemplate} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Targetingtemplates$Patch, options?: MethodOptions): GaxiosPromise<Schema$TargetingTemplate>;
patch(params: Params$Resource$Targetingtemplates$Patch, options: MethodOptions | BodyResponseCallback<Schema$TargetingTemplate>, callback: BodyResponseCallback<Schema$TargetingTemplate>): void;
patch(params: Params$Resource$Targetingtemplates$Patch, callback: BodyResponseCallback<Schema$TargetingTemplate>): void;
patch(callback: BodyResponseCallback<Schema$TargetingTemplate>): void;
/**
* dfareporting.targetingTemplates.update
* @desc Updates an existing targeting template.
* @alias dfareporting.targetingTemplates.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {().TargetingTemplate} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update(params?: Params$Resource$Targetingtemplates$Update, options?: MethodOptions): GaxiosPromise<Schema$TargetingTemplate>;
update(params: Params$Resource$Targetingtemplates$Update, options: MethodOptions | BodyResponseCallback<Schema$TargetingTemplate>, callback: BodyResponseCallback<Schema$TargetingTemplate>): void;
update(params: Params$Resource$Targetingtemplates$Update, callback: BodyResponseCallback<Schema$TargetingTemplate>): void;
update(callback: BodyResponseCallback<Schema$TargetingTemplate>): void;
}
export interface Params$Resource$Targetingtemplates$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Targeting template ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export interface Params$Resource$Targetingtemplates$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$TargetingTemplate;
}
export interface Params$Resource$Targetingtemplates$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Select only targeting templates with this advertiser ID.
*/
advertiserId?: string;
/**
* Select only targeting templates with these IDs.
*/
ids?: string[];
/**
* Maximum number of results to return.
*/
maxResults?: number;
/**
* Value of the nextPageToken from the previous result page.
*/
pageToken?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "template*2015" will return objects with names like "template June 2015", "template April 2015", or simply "template 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "template" will match objects with name "my template", "template 2015", or simply "template".
*/
searchString?: string;
/**
* Field by which to sort the list.
*/
sortField?: string;
/**
* Order of sorted results.
*/
sortOrder?: string;
}
export interface Params$Resource$Targetingtemplates$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Targeting template ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$TargetingTemplate;
}
export interface Params$Resource$Targetingtemplates$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$TargetingTemplate;
}
export class Resource$Userprofiles {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.userProfiles.get
* @desc Gets one user profile by ID.
* @alias dfareporting.userProfiles.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId The user profile ID.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Userprofiles$Get, options?: MethodOptions): GaxiosPromise<Schema$UserProfile>;
get(params: Params$Resource$Userprofiles$Get, options: MethodOptions | BodyResponseCallback<Schema$UserProfile>, callback: BodyResponseCallback<Schema$UserProfile>): void;
get(params: Params$Resource$Userprofiles$Get, callback: BodyResponseCallback<Schema$UserProfile>): void;
get(callback: BodyResponseCallback<Schema$UserProfile>): void;
/**
* dfareporting.userProfiles.list
* @desc Retrieves list of user profiles for a user.
* @alias dfareporting.userProfiles.list
* @memberOf! ()
*
* @param {object=} params Parameters for request
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Userprofiles$List, options?: MethodOptions): GaxiosPromise<Schema$UserProfileList>;
list(params: Params$Resource$Userprofiles$List, options: MethodOptions | BodyResponseCallback<Schema$UserProfileList>, callback: BodyResponseCallback<Schema$UserProfileList>): void;
list(params: Params$Resource$Userprofiles$List, callback: BodyResponseCallback<Schema$UserProfileList>): void;
list(callback: BodyResponseCallback<Schema$UserProfileList>): void;
}
export interface Params$Resource$Userprofiles$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The user profile ID.
*/
profileId?: string;
}
export interface Params$Resource$Userprofiles$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
}
export class Resource$Userrolepermissiongroups {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.userRolePermissionGroups.get
* @desc Gets one user role permission group by ID.
* @alias dfareporting.userRolePermissionGroups.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id User role permission group ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Userrolepermissiongroups$Get, options?: MethodOptions): GaxiosPromise<Schema$UserRolePermissionGroup>;
get(params: Params$Resource$Userrolepermissiongroups$Get, options: MethodOptions | BodyResponseCallback<Schema$UserRolePermissionGroup>, callback: BodyResponseCallback<Schema$UserRolePermissionGroup>): void;
get(params: Params$Resource$Userrolepermissiongroups$Get, callback: BodyResponseCallback<Schema$UserRolePermissionGroup>): void;
get(callback: BodyResponseCallback<Schema$UserRolePermissionGroup>): void;
/**
* dfareporting.userRolePermissionGroups.list
* @desc Gets a list of all supported user role permission groups.
* @alias dfareporting.userRolePermissionGroups.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Userrolepermissiongroups$List, options?: MethodOptions): GaxiosPromise<Schema$UserRolePermissionGroupsListResponse>;
list(params: Params$Resource$Userrolepermissiongroups$List, options: MethodOptions | BodyResponseCallback<Schema$UserRolePermissionGroupsListResponse>, callback: BodyResponseCallback<Schema$UserRolePermissionGroupsListResponse>): void;
list(params: Params$Resource$Userrolepermissiongroups$List, callback: BodyResponseCallback<Schema$UserRolePermissionGroupsListResponse>): void;
list(callback: BodyResponseCallback<Schema$UserRolePermissionGroupsListResponse>): void;
}
export interface Params$Resource$Userrolepermissiongroups$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User role permission group ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export interface Params$Resource$Userrolepermissiongroups$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export class Resource$Userrolepermissions {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.userRolePermissions.get
* @desc Gets one user role permission by ID.
* @alias dfareporting.userRolePermissions.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id User role permission ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Userrolepermissions$Get, options?: MethodOptions): GaxiosPromise<Schema$UserRolePermission>;
get(params: Params$Resource$Userrolepermissions$Get, options: MethodOptions | BodyResponseCallback<Schema$UserRolePermission>, callback: BodyResponseCallback<Schema$UserRolePermission>): void;
get(params: Params$Resource$Userrolepermissions$Get, callback: BodyResponseCallback<Schema$UserRolePermission>): void;
get(callback: BodyResponseCallback<Schema$UserRolePermission>): void;
/**
* dfareporting.userRolePermissions.list
* @desc Gets a list of user role permissions, possibly filtered.
* @alias dfareporting.userRolePermissions.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.ids Select only user role permissions with these IDs.
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Userrolepermissions$List, options?: MethodOptions): GaxiosPromise<Schema$UserRolePermissionsListResponse>;
list(params: Params$Resource$Userrolepermissions$List, options: MethodOptions | BodyResponseCallback<Schema$UserRolePermissionsListResponse>, callback: BodyResponseCallback<Schema$UserRolePermissionsListResponse>): void;
list(params: Params$Resource$Userrolepermissions$List, callback: BodyResponseCallback<Schema$UserRolePermissionsListResponse>): void;
list(callback: BodyResponseCallback<Schema$UserRolePermissionsListResponse>): void;
}
export interface Params$Resource$Userrolepermissions$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User role permission ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export interface Params$Resource$Userrolepermissions$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Select only user role permissions with these IDs.
*/
ids?: string[];
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export class Resource$Userroles {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.userRoles.delete
* @desc Deletes an existing user role.
* @alias dfareporting.userRoles.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id User role ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Userroles$Delete, options?: MethodOptions): GaxiosPromise<void>;
delete(params: Params$Resource$Userroles$Delete, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
delete(params: Params$Resource$Userroles$Delete, callback: BodyResponseCallback<void>): void;
delete(callback: BodyResponseCallback<void>): void;
/**
* dfareporting.userRoles.get
* @desc Gets one user role by ID.
* @alias dfareporting.userRoles.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id User role ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Userroles$Get, options?: MethodOptions): GaxiosPromise<Schema$UserRole>;
get(params: Params$Resource$Userroles$Get, options: MethodOptions | BodyResponseCallback<Schema$UserRole>, callback: BodyResponseCallback<Schema$UserRole>): void;
get(params: Params$Resource$Userroles$Get, callback: BodyResponseCallback<Schema$UserRole>): void;
get(callback: BodyResponseCallback<Schema$UserRole>): void;
/**
* dfareporting.userRoles.insert
* @desc Inserts a new user role.
* @alias dfareporting.userRoles.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {().UserRole} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
insert(params?: Params$Resource$Userroles$Insert, options?: MethodOptions): GaxiosPromise<Schema$UserRole>;
insert(params: Params$Resource$Userroles$Insert, options: MethodOptions | BodyResponseCallback<Schema$UserRole>, callback: BodyResponseCallback<Schema$UserRole>): void;
insert(params: Params$Resource$Userroles$Insert, callback: BodyResponseCallback<Schema$UserRole>): void;
insert(callback: BodyResponseCallback<Schema$UserRole>): void;
/**
* dfareporting.userRoles.list
* @desc Retrieves a list of user roles, possibly filtered. This method supports paging.
* @alias dfareporting.userRoles.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.accountUserRoleOnly Select only account level user roles not associated with any specific subaccount.
* @param {string=} params.ids Select only user roles with the specified IDs.
* @param {integer=} params.maxResults Maximum number of results to return.
* @param {string=} params.pageToken Value of the nextPageToken from the previous result page.
* @param {string} params.profileId User profile ID associated with this request.
* @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "userrole*2015" will return objects with names like "userrole June 2015", "userrole April 2015", or simply "userrole 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "userrole" will match objects with name "my userrole", "userrole 2015", or simply "userrole".
* @param {string=} params.sortField Field by which to sort the list.
* @param {string=} params.sortOrder Order of sorted results.
* @param {string=} params.subaccountId Select only user roles that belong to this subaccount.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Userroles$List, options?: MethodOptions): GaxiosPromise<Schema$UserRolesListResponse>;
list(params: Params$Resource$Userroles$List, options: MethodOptions | BodyResponseCallback<Schema$UserRolesListResponse>, callback: BodyResponseCallback<Schema$UserRolesListResponse>): void;
list(params: Params$Resource$Userroles$List, callback: BodyResponseCallback<Schema$UserRolesListResponse>): void;
list(callback: BodyResponseCallback<Schema$UserRolesListResponse>): void;
/**
* dfareporting.userRoles.patch
* @desc Updates an existing user role. This method supports patch semantics.
* @alias dfareporting.userRoles.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id User role ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {().UserRole} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Userroles$Patch, options?: MethodOptions): GaxiosPromise<Schema$UserRole>;
patch(params: Params$Resource$Userroles$Patch, options: MethodOptions | BodyResponseCallback<Schema$UserRole>, callback: BodyResponseCallback<Schema$UserRole>): void;
patch(params: Params$Resource$Userroles$Patch, callback: BodyResponseCallback<Schema$UserRole>): void;
patch(callback: BodyResponseCallback<Schema$UserRole>): void;
/**
* dfareporting.userRoles.update
* @desc Updates an existing user role.
* @alias dfareporting.userRoles.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {().UserRole} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update(params?: Params$Resource$Userroles$Update, options?: MethodOptions): GaxiosPromise<Schema$UserRole>;
update(params: Params$Resource$Userroles$Update, options: MethodOptions | BodyResponseCallback<Schema$UserRole>, callback: BodyResponseCallback<Schema$UserRole>): void;
update(params: Params$Resource$Userroles$Update, callback: BodyResponseCallback<Schema$UserRole>): void;
update(callback: BodyResponseCallback<Schema$UserRole>): void;
}
export interface Params$Resource$Userroles$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User role ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export interface Params$Resource$Userroles$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User role ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export interface Params$Resource$Userroles$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$UserRole;
}
export interface Params$Resource$Userroles$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Select only account level user roles not associated with any specific subaccount.
*/
accountUserRoleOnly?: boolean;
/**
* Select only user roles with the specified IDs.
*/
ids?: string[];
/**
* Maximum number of results to return.
*/
maxResults?: number;
/**
* Value of the nextPageToken from the previous result page.
*/
pageToken?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "userrole*2015" will return objects with names like "userrole June 2015", "userrole April 2015", or simply "userrole 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "userrole" will match objects with name "my userrole", "userrole 2015", or simply "userrole".
*/
searchString?: string;
/**
* Field by which to sort the list.
*/
sortField?: string;
/**
* Order of sorted results.
*/
sortOrder?: string;
/**
* Select only user roles that belong to this subaccount.
*/
subaccountId?: string;
}
export interface Params$Resource$Userroles$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User role ID.
*/
id?: string;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$UserRole;
}
export interface Params$Resource$Userroles$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$UserRole;
}
export class Resource$Videoformats {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dfareporting.videoFormats.get
* @desc Gets one video format by ID.
* @alias dfareporting.videoFormats.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer} params.id Video format ID.
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Videoformats$Get, options?: MethodOptions): GaxiosPromise<Schema$VideoFormat>;
get(params: Params$Resource$Videoformats$Get, options: MethodOptions | BodyResponseCallback<Schema$VideoFormat>, callback: BodyResponseCallback<Schema$VideoFormat>): void;
get(params: Params$Resource$Videoformats$Get, callback: BodyResponseCallback<Schema$VideoFormat>): void;
get(callback: BodyResponseCallback<Schema$VideoFormat>): void;
/**
* dfareporting.videoFormats.list
* @desc Lists available video formats.
* @alias dfareporting.videoFormats.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.profileId User profile ID associated with this request.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Videoformats$List, options?: MethodOptions): GaxiosPromise<Schema$VideoFormatsListResponse>;
list(params: Params$Resource$Videoformats$List, options: MethodOptions | BodyResponseCallback<Schema$VideoFormatsListResponse>, callback: BodyResponseCallback<Schema$VideoFormatsListResponse>): void;
list(params: Params$Resource$Videoformats$List, callback: BodyResponseCallback<Schema$VideoFormatsListResponse>): void;
list(callback: BodyResponseCallback<Schema$VideoFormatsListResponse>): void;
}
export interface Params$Resource$Videoformats$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Video format ID.
*/
id?: number;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export interface Params$Resource$Videoformats$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* User profile ID associated with this request.
*/
profileId?: string;
}
export {};
}