v2.d.ts
127 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
/// <reference types="node" />
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosPromise, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace adsense_v2 {
export interface Options extends GlobalOptions {
version: 'v2';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* AdSense Management API
*
* The AdSense Management API allows publishers to access their inventory and run earnings and performance reports.
*
* @example
* ```js
* const {google} = require('googleapis');
* const adsense = google.adsense('v2');
* ```
*/
export class Adsense {
context: APIRequestContext;
accounts: Resource$Accounts;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Representation of an account.
*/
export interface Schema$Account {
/**
* Output only. Creation time of the account.
*/
createTime?: string | null;
/**
* Output only. Display name of this account.
*/
displayName?: string | null;
/**
* Resource name of the account. Format: accounts/pub-[0-9]+
*/
name?: string | null;
/**
* Output only. Outstanding tasks that need to be completed as part of the sign-up process for a new account. e.g. "billing-profile-creation", "phone-pin-verification".
*/
pendingTasks?: string[] | null;
/**
* Output only. Whether this account is premium.
*/
premium?: boolean | null;
/**
* The account time zone, as used by reporting. For more information, see [changing the time zone of your reports](https://support.google.com/adsense/answer/9830725).
*/
timeZone?: Schema$TimeZone;
}
/**
* Representation of an ad client. An ad client represents a user's subscription with a specific AdSense product.
*/
export interface Schema$AdClient {
/**
* Resource name of the ad client. Format: accounts/{account\}/adclient/{adclient\}
*/
name?: string | null;
/**
* Output only. Product code of the ad client. For example, "AFC" for AdSense for Content.
*/
productCode?: string | null;
/**
* Output only. Unique ID of the ad client as used in the `AD_CLIENT_ID` reporting dimension. Present only if the ad client supports reporting.
*/
reportingDimensionId?: string | null;
}
/**
* Representation of the AdSense code for a given ad client. For more information, see [About the AdSense code](https://support.google.com/adsense/answer/9274634).
*/
export interface Schema$AdClientAdCode {
/**
* Output only. The AdSense code snippet to add to the head of an HTML page.
*/
adCode?: string | null;
/**
* Output only. The AdSense code snippet to add to the body of an AMP page.
*/
ampBody?: string | null;
/**
* Output only. The AdSense code snippet to add to the head of an AMP page.
*/
ampHead?: string | null;
}
/**
* Representation of an ad unit. An ad unit represents a saved ad unit with a specific set of ad settings that have been customized within an account.
*/
export interface Schema$AdUnit {
/**
* Settings specific to content ads (AFC).
*/
contentAdsSettings?: Schema$ContentAdsSettings;
/**
* Display name of the ad unit, as provided when the ad unit was created.
*/
displayName?: string | null;
/**
* Resource name of the ad unit. Format: accounts/{account\}/adclient/{adclient\}/adunits/{adunit\}
*/
name?: string | null;
/**
* Output only. Unique ID of the ad unit as used in the `AD_UNIT_ID` reporting dimension.
*/
reportingDimensionId?: string | null;
/**
* State of the ad unit.
*/
state?: string | null;
}
/**
* Representation of the AdSense code for a given ad unit.
*/
export interface Schema$AdUnitAdCode {
/**
* Output only. The AdSense code snippet to add to the body of an HTML page.
*/
adCode?: string | null;
}
/**
* Representation of an alert.
*/
export interface Schema$Alert {
/**
* Output only. The localized alert message. This may contain HTML markup, such as phrase elements or links.
*/
message?: string | null;
/**
* Resource name of the alert. Format: accounts/{account\}/alerts/{alert\}
*/
name?: string | null;
/**
* Output only. Severity of this alert.
*/
severity?: string | null;
/**
* Output only. Type of alert. This identifies the broad type of this alert, and provides a stable machine-readable identifier that will not be translated. For example, "payment-hold".
*/
type?: string | null;
}
/**
* Cell representation.
*/
export interface Schema$Cell {
/**
* Value in the cell. The dimension cells contain strings, and the metric cells contain numbers.
*/
value?: string | null;
}
/**
* Settings specific to content ads (AFC).
*/
export interface Schema$ContentAdsSettings {
/**
* Size of the ad unit. e.g. "728x90", "1x3" (for responsive ad units).
*/
size?: string | null;
/**
* Type of the ad unit.
*/
type?: string | null;
}
/**
* Representation of a custom channel.
*/
export interface Schema$CustomChannel {
/**
* Display name of the custom channel.
*/
displayName?: string | null;
/**
* Resource name of the custom channel. Format: accounts/{account\}/adclients/{adclient\}/customchannels/{customchannel\}
*/
name?: string | null;
/**
* Output only. Unique ID of the custom channel as used in the `CUSTOM_CHANNEL_ID` reporting dimension.
*/
reportingDimensionId?: string | null;
}
/**
* Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
*/
export interface Schema$Date {
/**
* Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
*/
day?: number | null;
/**
* Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
*/
month?: number | null;
/**
* Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
*/
year?: number | null;
}
/**
* The header information of the columns requested in the report.
*/
export interface Schema$Header {
/**
* The [ISO-4217 currency code](https://en.wikipedia.org/wiki/ISO_4217) of this column. Only present if the header type is METRIC_CURRENCY.
*/
currencyCode?: string | null;
/**
* Required. Name of the header.
*/
name?: string | null;
/**
* Required. Type of the header.
*/
type?: string | null;
}
/**
* Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; \} service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); \} Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); \} Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
*/
export interface Schema$HttpBody {
/**
* The HTTP Content-Type header value specifying the content type of the body.
*/
contentType?: string | null;
/**
* The HTTP request/response body as raw binary.
*/
data?: string | null;
/**
* Application specific response metadata. Must be set in the first response for streaming APIs.
*/
extensions?: Array<{
[key: string]: any;
}> | null;
}
/**
* Response definition for the account list rpc.
*/
export interface Schema$ListAccountsResponse {
/**
* The accounts returned in this list response.
*/
accounts?: Schema$Account[];
/**
* Continuation token used to page through accounts. To retrieve the next page of the results, set the next request's "page_token" value to this.
*/
nextPageToken?: string | null;
}
/**
* Response definition for the ad client list rpc.
*/
export interface Schema$ListAdClientsResponse {
/**
* The ad clients returned in this list response.
*/
adClients?: Schema$AdClient[];
/**
* Continuation token used to page through ad clients. To retrieve the next page of the results, set the next request's "page_token" value to this.
*/
nextPageToken?: string | null;
}
/**
* Response definition for the adunit list rpc.
*/
export interface Schema$ListAdUnitsResponse {
/**
* The ad units returned in the list response.
*/
adUnits?: Schema$AdUnit[];
/**
* Continuation token used to page through ad units. To retrieve the next page of the results, set the next request's "page_token" value to this.
*/
nextPageToken?: string | null;
}
/**
* Response definition for the alerts list rpc.
*/
export interface Schema$ListAlertsResponse {
/**
* The alerts returned in this list response.
*/
alerts?: Schema$Alert[];
}
/**
* Response definition for the child account list rpc.
*/
export interface Schema$ListChildAccountsResponse {
/**
* The accounts returned in this list response.
*/
accounts?: Schema$Account[];
/**
* Continuation token used to page through accounts. To retrieve the next page of the results, set the next request's "page_token" value to this.
*/
nextPageToken?: string | null;
}
/**
* Response definition for the custom channel list rpc.
*/
export interface Schema$ListCustomChannelsResponse {
/**
* The custom channels returned in this list response.
*/
customChannels?: Schema$CustomChannel[];
/**
* Continuation token used to page through alerts. To retrieve the next page of the results, set the next request's "page_token" value to this.
*/
nextPageToken?: string | null;
}
/**
* Response definition for the ad units linked to a custom channel list rpc.
*/
export interface Schema$ListLinkedAdUnitsResponse {
/**
* The ad units returned in the list response.
*/
adUnits?: Schema$AdUnit[];
/**
* Continuation token used to page through ad units. To retrieve the next page of the results, set the next request's "page_token" value to this.
*/
nextPageToken?: string | null;
}
/**
* Response definition for the custom channels linked to an adunit list rpc.
*/
export interface Schema$ListLinkedCustomChannelsResponse {
/**
* The custom channels returned in this list response.
*/
customChannels?: Schema$CustomChannel[];
/**
* Continuation token used to page through alerts. To retrieve the next page of the results, set the next request's "page_token" value to this.
*/
nextPageToken?: string | null;
}
/**
* Response definition for the payments list rpc.
*/
export interface Schema$ListPaymentsResponse {
/**
* The payments returned in this list response.
*/
payments?: Schema$Payment[];
}
/**
* Response definition for the saved reports list rpc.
*/
export interface Schema$ListSavedReportsResponse {
/**
* Continuation token used to page through reports. To retrieve the next page of the results, set the next request's "page_token" value to this.
*/
nextPageToken?: string | null;
/**
* The reports returned in this list response.
*/
savedReports?: Schema$SavedReport[];
}
/**
* Response definition for the sites list rpc.
*/
export interface Schema$ListSitesResponse {
/**
* Continuation token used to page through sites. To retrieve the next page of the results, set the next request's "page_token" value to this.
*/
nextPageToken?: string | null;
/**
* The sites returned in this list response.
*/
sites?: Schema$Site[];
}
/**
* Response definition for the url channels list rpc.
*/
export interface Schema$ListUrlChannelsResponse {
/**
* Continuation token used to page through url channels. To retrieve the next page of the results, set the next request's "page_token" value to this.
*/
nextPageToken?: string | null;
/**
* The url channels returned in this list response.
*/
urlChannels?: Schema$UrlChannel[];
}
/**
* Representation of an unpaid or paid payment. See [Payment timelines for AdSense](https://support.google.com/adsense/answer/7164703) for more information about payments.
*/
export interface Schema$Payment {
/**
* Output only. The amount of unpaid or paid earnings, as a formatted string, including the currency. E.g. "¥1,235 JPY", "$1,234.57", "£87.65".
*/
amount?: string | null;
/**
* Output only. For paid earnings, the date that the payment was credited. For unpaid earnings, this field is empty. Payment dates are always returned in the billing timezone (America/Los_Angeles).
*/
date?: Schema$Date;
/**
* Resource name of the payment. Format: accounts/{account\}/payments/unpaid for unpaid (current) earnings. accounts/{account\}/payments/yyyy-MM-dd for paid earnings.
*/
name?: string | null;
}
/**
* Result of a generated report.
*/
export interface Schema$ReportResult {
/**
* The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
*/
averages?: Schema$Row;
/**
* Required. End date of the range (inclusive).
*/
endDate?: Schema$Date;
/**
* The header information; one for each dimension in the request, followed by one for each metric in the request.
*/
headers?: Schema$Header[];
/**
* The output rows of the report. Each row is a list of cells; one for each dimension in the request, followed by one for each metric in the request.
*/
rows?: Schema$Row[];
/**
* Required. Start date of the range (inclusive).
*/
startDate?: Schema$Date;
/**
* The total number of rows matched by the report request.
*/
totalMatchedRows?: string | null;
/**
* The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
*/
totals?: Schema$Row;
/**
* Any warnings associated with generation of the report. These warnings are always returned in English.
*/
warnings?: string[] | null;
}
/**
* Row representation.
*/
export interface Schema$Row {
/**
* Cells in the row.
*/
cells?: Schema$Cell[];
}
/**
* Representation of a saved report.
*/
export interface Schema$SavedReport {
/**
* Resource name of the report. Format: accounts/{account\}/reports/{report\}
*/
name?: string | null;
/**
* Report title as specified by publisher.
*/
title?: string | null;
}
/**
* Representation of a Site.
*/
export interface Schema$Site {
/**
* Whether auto ads is turned on for the site.
*/
autoAdsEnabled?: boolean | null;
/**
* Domain (or subdomain) of the site, e.g. "example.com" or "www.example.com". This is used in the `OWNED_SITE_DOMAIN_NAME` reporting dimension.
*/
domain?: string | null;
/**
* Resource name of a site. Format: accounts/{account\}/sites/{site\}
*/
name?: string | null;
/**
* Output only. Unique ID of the site as used in the `OWNED_SITE_ID` reporting dimension.
*/
reportingDimensionId?: string | null;
/**
* Output only. State of a site.
*/
state?: string | null;
}
/**
* Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones).
*/
export interface Schema$TimeZone {
/**
* IANA Time Zone Database time zone, e.g. "America/New_York".
*/
id?: string | null;
/**
* Optional. IANA Time Zone Database version number, e.g. "2019a".
*/
version?: string | null;
}
/**
* Representation of a URL channel. URL channels allow you to track the performance of particular pages in your site; see [URL channels](https://support.google.com/adsense/answer/2923836) for more information.
*/
export interface Schema$UrlChannel {
/**
* Resource name of the URL channel. Format: accounts/{account\}/adclient/{adclient\}/urlchannels/{urlchannel\}
*/
name?: string | null;
/**
* Output only. Unique ID of the custom channel as used in the `URL_CHANNEL_ID` reporting dimension.
*/
reportingDimensionId?: string | null;
/**
* URI pattern of the channel. Does not include "http://" or "https://". Example: www.example.com/home
*/
uriPattern?: string | null;
}
export class Resource$Accounts {
context: APIRequestContext;
adclients: Resource$Accounts$Adclients;
alerts: Resource$Accounts$Alerts;
payments: Resource$Accounts$Payments;
reports: Resource$Accounts$Reports;
sites: Resource$Accounts$Sites;
constructor(context: APIRequestContext);
/**
* Gets information about the selected AdSense account.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/adsense.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const adsense = google.adsense('v2');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/adsense',
* 'https://www.googleapis.com/auth/adsense.readonly',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await adsense.accounts.get({
* // Required. Account to get information about. Format: accounts/{account_id\}
* name: 'accounts/my-account',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "createTime": "my_createTime",
* // "displayName": "my_displayName",
* // "name": "my_name",
* // "pendingTasks": [],
* // "premium": false,
* // "timeZone": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Accounts$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Accounts$Get, options?: MethodOptions): GaxiosPromise<Schema$Account>;
get(params: Params$Resource$Accounts$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
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;
/**
* Lists all accounts available to this user.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/adsense.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const adsense = google.adsense('v2');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/adsense',
* 'https://www.googleapis.com/auth/adsense.readonly',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await adsense.accounts.list({
* // The maximum number of accounts to include in the response, used for paging. If unspecified, at most 10000 accounts will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
* pageSize: 'placeholder-value',
* // A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token.
* pageToken: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "accounts": [],
* // "nextPageToken": "my_nextPageToken"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Accounts$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Accounts$List, options?: MethodOptions): GaxiosPromise<Schema$ListAccountsResponse>;
list(params: Params$Resource$Accounts$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Accounts$List, options: MethodOptions | BodyResponseCallback<Schema$ListAccountsResponse>, callback: BodyResponseCallback<Schema$ListAccountsResponse>): void;
list(params: Params$Resource$Accounts$List, callback: BodyResponseCallback<Schema$ListAccountsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListAccountsResponse>): void;
/**
* Lists all accounts directly managed by the given AdSense account.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/adsense.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const adsense = google.adsense('v2');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/adsense',
* 'https://www.googleapis.com/auth/adsense.readonly',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await adsense.accounts.listChildAccounts({
* // The maximum number of accounts to include in the response, used for paging. If unspecified, at most 10000 accounts will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
* pageSize: 'placeholder-value',
* // A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token.
* pageToken: 'placeholder-value',
* // Required. The parent account, which owns the child accounts. Format: accounts/{account\}
* parent: 'accounts/my-account',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "accounts": [],
* // "nextPageToken": "my_nextPageToken"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
listChildAccounts(params: Params$Resource$Accounts$Listchildaccounts, options: StreamMethodOptions): GaxiosPromise<Readable>;
listChildAccounts(params?: Params$Resource$Accounts$Listchildaccounts, options?: MethodOptions): GaxiosPromise<Schema$ListChildAccountsResponse>;
listChildAccounts(params: Params$Resource$Accounts$Listchildaccounts, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
listChildAccounts(params: Params$Resource$Accounts$Listchildaccounts, options: MethodOptions | BodyResponseCallback<Schema$ListChildAccountsResponse>, callback: BodyResponseCallback<Schema$ListChildAccountsResponse>): void;
listChildAccounts(params: Params$Resource$Accounts$Listchildaccounts, callback: BodyResponseCallback<Schema$ListChildAccountsResponse>): void;
listChildAccounts(callback: BodyResponseCallback<Schema$ListChildAccountsResponse>): void;
}
export interface Params$Resource$Accounts$Get extends StandardParameters {
/**
* Required. Account to get information about. Format: accounts/{account_id\}
*/
name?: string;
}
export interface Params$Resource$Accounts$List extends StandardParameters {
/**
* The maximum number of accounts to include in the response, used for paging. If unspecified, at most 10000 accounts will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
*/
pageSize?: number;
/**
* A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token.
*/
pageToken?: string;
}
export interface Params$Resource$Accounts$Listchildaccounts extends StandardParameters {
/**
* The maximum number of accounts to include in the response, used for paging. If unspecified, at most 10000 accounts will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
*/
pageSize?: number;
/**
* A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token.
*/
pageToken?: string;
/**
* Required. The parent account, which owns the child accounts. Format: accounts/{account\}
*/
parent?: string;
}
export class Resource$Accounts$Adclients {
context: APIRequestContext;
adunits: Resource$Accounts$Adclients$Adunits;
customchannels: Resource$Accounts$Adclients$Customchannels;
urlchannels: Resource$Accounts$Adclients$Urlchannels;
constructor(context: APIRequestContext);
/**
* Gets the AdSense code for a given ad client. This returns what was previously known as the 'auto ad code'. This is only supported for ad clients with a product_code of AFC. For more information, see [About the AdSense code](https://support.google.com/adsense/answer/9274634).
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/adsense.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const adsense = google.adsense('v2');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/adsense',
* 'https://www.googleapis.com/auth/adsense.readonly',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await adsense.accounts.adclients.getAdcode({
* // Required. Name of the ad client for which to get the adcode. Format: accounts/{account\}/adclients/{adclient\}
* name: 'accounts/my-account/adclients/my-adclient',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "adCode": "my_adCode",
* // "ampBody": "my_ampBody",
* // "ampHead": "my_ampHead"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
getAdcode(params: Params$Resource$Accounts$Adclients$Getadcode, options: StreamMethodOptions): GaxiosPromise<Readable>;
getAdcode(params?: Params$Resource$Accounts$Adclients$Getadcode, options?: MethodOptions): GaxiosPromise<Schema$AdClientAdCode>;
getAdcode(params: Params$Resource$Accounts$Adclients$Getadcode, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
getAdcode(params: Params$Resource$Accounts$Adclients$Getadcode, options: MethodOptions | BodyResponseCallback<Schema$AdClientAdCode>, callback: BodyResponseCallback<Schema$AdClientAdCode>): void;
getAdcode(params: Params$Resource$Accounts$Adclients$Getadcode, callback: BodyResponseCallback<Schema$AdClientAdCode>): void;
getAdcode(callback: BodyResponseCallback<Schema$AdClientAdCode>): void;
/**
* Lists all the ad clients available in an account.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/adsense.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const adsense = google.adsense('v2');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/adsense',
* 'https://www.googleapis.com/auth/adsense.readonly',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await adsense.accounts.adclients.list({
* // The maximum number of ad clients to include in the response, used for paging. If unspecified, at most 10000 ad clients will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
* pageSize: 'placeholder-value',
* // A page token, received from a previous `ListAdClients` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAdClients` must match the call that provided the page token.
* pageToken: 'placeholder-value',
* // Required. The account which owns the collection of ad clients. Format: accounts/{account\}
* parent: 'accounts/my-account',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "adClients": [],
* // "nextPageToken": "my_nextPageToken"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Accounts$Adclients$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Accounts$Adclients$List, options?: MethodOptions): GaxiosPromise<Schema$ListAdClientsResponse>;
list(params: Params$Resource$Accounts$Adclients$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Accounts$Adclients$List, options: MethodOptions | BodyResponseCallback<Schema$ListAdClientsResponse>, callback: BodyResponseCallback<Schema$ListAdClientsResponse>): void;
list(params: Params$Resource$Accounts$Adclients$List, callback: BodyResponseCallback<Schema$ListAdClientsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListAdClientsResponse>): void;
}
export interface Params$Resource$Accounts$Adclients$Getadcode extends StandardParameters {
/**
* Required. Name of the ad client for which to get the adcode. Format: accounts/{account\}/adclients/{adclient\}
*/
name?: string;
}
export interface Params$Resource$Accounts$Adclients$List extends StandardParameters {
/**
* The maximum number of ad clients to include in the response, used for paging. If unspecified, at most 10000 ad clients will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
*/
pageSize?: number;
/**
* A page token, received from a previous `ListAdClients` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAdClients` must match the call that provided the page token.
*/
pageToken?: string;
/**
* Required. The account which owns the collection of ad clients. Format: accounts/{account\}
*/
parent?: string;
}
export class Resource$Accounts$Adclients$Adunits {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Gets an ad unit from a specified account and ad client.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/adsense.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const adsense = google.adsense('v2');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/adsense',
* 'https://www.googleapis.com/auth/adsense.readonly',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await adsense.accounts.adclients.adunits.get({
* // Required. AdUnit to get information about. Format: accounts/{account_id\}/adclient/{adclient_id\}/adunit/{adunit_id\}
* name: 'accounts/my-account/adclients/my-adclient/adunits/my-adunit',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "contentAdsSettings": {},
* // "displayName": "my_displayName",
* // "name": "my_name",
* // "reportingDimensionId": "my_reportingDimensionId",
* // "state": "my_state"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Accounts$Adclients$Adunits$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Accounts$Adclients$Adunits$Get, options?: MethodOptions): GaxiosPromise<Schema$AdUnit>;
get(params: Params$Resource$Accounts$Adclients$Adunits$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Accounts$Adclients$Adunits$Get, options: MethodOptions | BodyResponseCallback<Schema$AdUnit>, callback: BodyResponseCallback<Schema$AdUnit>): void;
get(params: Params$Resource$Accounts$Adclients$Adunits$Get, callback: BodyResponseCallback<Schema$AdUnit>): void;
get(callback: BodyResponseCallback<Schema$AdUnit>): void;
/**
* Gets the AdSense code for a given ad unit.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/adsense.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const adsense = google.adsense('v2');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/adsense',
* 'https://www.googleapis.com/auth/adsense.readonly',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await adsense.accounts.adclients.adunits.getAdcode({
* // Required. Name of the adunit for which to get the adcode. Format: accounts/{account\}/adclients/{adclient\}/adunits/{adunit\}
* name: 'accounts/my-account/adclients/my-adclient/adunits/my-adunit',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "adCode": "my_adCode"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
getAdcode(params: Params$Resource$Accounts$Adclients$Adunits$Getadcode, options: StreamMethodOptions): GaxiosPromise<Readable>;
getAdcode(params?: Params$Resource$Accounts$Adclients$Adunits$Getadcode, options?: MethodOptions): GaxiosPromise<Schema$AdUnitAdCode>;
getAdcode(params: Params$Resource$Accounts$Adclients$Adunits$Getadcode, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
getAdcode(params: Params$Resource$Accounts$Adclients$Adunits$Getadcode, options: MethodOptions | BodyResponseCallback<Schema$AdUnitAdCode>, callback: BodyResponseCallback<Schema$AdUnitAdCode>): void;
getAdcode(params: Params$Resource$Accounts$Adclients$Adunits$Getadcode, callback: BodyResponseCallback<Schema$AdUnitAdCode>): void;
getAdcode(callback: BodyResponseCallback<Schema$AdUnitAdCode>): void;
/**
* Lists all ad units under a specified account and ad client.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/adsense.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const adsense = google.adsense('v2');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/adsense',
* 'https://www.googleapis.com/auth/adsense.readonly',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await adsense.accounts.adclients.adunits.list({
* // The maximum number of ad units to include in the response, used for paging. If unspecified, at most 10000 ad units will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
* pageSize: 'placeholder-value',
* // A page token, received from a previous `ListAdUnits` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAdUnits` must match the call that provided the page token.
* pageToken: 'placeholder-value',
* // Required. The ad client which owns the collection of ad units. Format: accounts/{account\}/adclients/{adclient\}
* parent: 'accounts/my-account/adclients/my-adclient',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "adUnits": [],
* // "nextPageToken": "my_nextPageToken"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Accounts$Adclients$Adunits$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Accounts$Adclients$Adunits$List, options?: MethodOptions): GaxiosPromise<Schema$ListAdUnitsResponse>;
list(params: Params$Resource$Accounts$Adclients$Adunits$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Accounts$Adclients$Adunits$List, options: MethodOptions | BodyResponseCallback<Schema$ListAdUnitsResponse>, callback: BodyResponseCallback<Schema$ListAdUnitsResponse>): void;
list(params: Params$Resource$Accounts$Adclients$Adunits$List, callback: BodyResponseCallback<Schema$ListAdUnitsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListAdUnitsResponse>): void;
/**
* Lists all the custom channels available for an ad unit.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/adsense.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const adsense = google.adsense('v2');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/adsense',
* 'https://www.googleapis.com/auth/adsense.readonly',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await adsense.accounts.adclients.adunits.listLinkedCustomChannels(
* {
* // The maximum number of custom channels to include in the response, used for paging. If unspecified, at most 10000 custom channels will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
* pageSize: 'placeholder-value',
* // A page token, received from a previous `ListLinkedCustomChannels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListLinkedCustomChannels` must match the call that provided the page token.
* pageToken: 'placeholder-value',
* // Required. The ad unit which owns the collection of custom channels. Format: accounts/{account\}/adclients/{adclient\}/adunits/{adunit\}
* parent: 'accounts/my-account/adclients/my-adclient/adunits/my-adunit',
* }
* );
* console.log(res.data);
*
* // Example response
* // {
* // "customChannels": [],
* // "nextPageToken": "my_nextPageToken"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
listLinkedCustomChannels(params: Params$Resource$Accounts$Adclients$Adunits$Listlinkedcustomchannels, options: StreamMethodOptions): GaxiosPromise<Readable>;
listLinkedCustomChannels(params?: Params$Resource$Accounts$Adclients$Adunits$Listlinkedcustomchannels, options?: MethodOptions): GaxiosPromise<Schema$ListLinkedCustomChannelsResponse>;
listLinkedCustomChannels(params: Params$Resource$Accounts$Adclients$Adunits$Listlinkedcustomchannels, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
listLinkedCustomChannels(params: Params$Resource$Accounts$Adclients$Adunits$Listlinkedcustomchannels, options: MethodOptions | BodyResponseCallback<Schema$ListLinkedCustomChannelsResponse>, callback: BodyResponseCallback<Schema$ListLinkedCustomChannelsResponse>): void;
listLinkedCustomChannels(params: Params$Resource$Accounts$Adclients$Adunits$Listlinkedcustomchannels, callback: BodyResponseCallback<Schema$ListLinkedCustomChannelsResponse>): void;
listLinkedCustomChannels(callback: BodyResponseCallback<Schema$ListLinkedCustomChannelsResponse>): void;
}
export interface Params$Resource$Accounts$Adclients$Adunits$Get extends StandardParameters {
/**
* Required. AdUnit to get information about. Format: accounts/{account_id\}/adclient/{adclient_id\}/adunit/{adunit_id\}
*/
name?: string;
}
export interface Params$Resource$Accounts$Adclients$Adunits$Getadcode extends StandardParameters {
/**
* Required. Name of the adunit for which to get the adcode. Format: accounts/{account\}/adclients/{adclient\}/adunits/{adunit\}
*/
name?: string;
}
export interface Params$Resource$Accounts$Adclients$Adunits$List extends StandardParameters {
/**
* The maximum number of ad units to include in the response, used for paging. If unspecified, at most 10000 ad units will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
*/
pageSize?: number;
/**
* A page token, received from a previous `ListAdUnits` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAdUnits` must match the call that provided the page token.
*/
pageToken?: string;
/**
* Required. The ad client which owns the collection of ad units. Format: accounts/{account\}/adclients/{adclient\}
*/
parent?: string;
}
export interface Params$Resource$Accounts$Adclients$Adunits$Listlinkedcustomchannels extends StandardParameters {
/**
* The maximum number of custom channels to include in the response, used for paging. If unspecified, at most 10000 custom channels will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
*/
pageSize?: number;
/**
* A page token, received from a previous `ListLinkedCustomChannels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListLinkedCustomChannels` must match the call that provided the page token.
*/
pageToken?: string;
/**
* Required. The ad unit which owns the collection of custom channels. Format: accounts/{account\}/adclients/{adclient\}/adunits/{adunit\}
*/
parent?: string;
}
export class Resource$Accounts$Adclients$Customchannels {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Gets information about the selected custom channel.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/adsense.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const adsense = google.adsense('v2');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/adsense',
* 'https://www.googleapis.com/auth/adsense.readonly',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await adsense.accounts.adclients.customchannels.get({
* // Required. Name of the custom channel. Format: accounts/{account\}/adclients/{adclient\}/customchannels/{customchannel\}
* name: 'accounts/my-account/adclients/my-adclient/customchannels/my-customchannel',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "displayName": "my_displayName",
* // "name": "my_name",
* // "reportingDimensionId": "my_reportingDimensionId"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Accounts$Adclients$Customchannels$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Accounts$Adclients$Customchannels$Get, options?: MethodOptions): GaxiosPromise<Schema$CustomChannel>;
get(params: Params$Resource$Accounts$Adclients$Customchannels$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Accounts$Adclients$Customchannels$Get, options: MethodOptions | BodyResponseCallback<Schema$CustomChannel>, callback: BodyResponseCallback<Schema$CustomChannel>): void;
get(params: Params$Resource$Accounts$Adclients$Customchannels$Get, callback: BodyResponseCallback<Schema$CustomChannel>): void;
get(callback: BodyResponseCallback<Schema$CustomChannel>): void;
/**
* Lists all the custom channels available in an ad client.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/adsense.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const adsense = google.adsense('v2');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/adsense',
* 'https://www.googleapis.com/auth/adsense.readonly',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await adsense.accounts.adclients.customchannels.list({
* // The maximum number of custom channels to include in the response, used for paging. If unspecified, at most 10000 custom channels will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
* pageSize: 'placeholder-value',
* // A page token, received from a previous `ListCustomChannels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCustomChannels` must match the call that provided the page token.
* pageToken: 'placeholder-value',
* // Required. The ad client which owns the collection of custom channels. Format: accounts/{account\}/adclients/{adclient\}
* parent: 'accounts/my-account/adclients/my-adclient',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "customChannels": [],
* // "nextPageToken": "my_nextPageToken"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Accounts$Adclients$Customchannels$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Accounts$Adclients$Customchannels$List, options?: MethodOptions): GaxiosPromise<Schema$ListCustomChannelsResponse>;
list(params: Params$Resource$Accounts$Adclients$Customchannels$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Accounts$Adclients$Customchannels$List, options: MethodOptions | BodyResponseCallback<Schema$ListCustomChannelsResponse>, callback: BodyResponseCallback<Schema$ListCustomChannelsResponse>): void;
list(params: Params$Resource$Accounts$Adclients$Customchannels$List, callback: BodyResponseCallback<Schema$ListCustomChannelsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListCustomChannelsResponse>): void;
/**
* Lists all the ad units available for a custom channel.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/adsense.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const adsense = google.adsense('v2');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/adsense',
* 'https://www.googleapis.com/auth/adsense.readonly',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await adsense.accounts.adclients.customchannels.listLinkedAdUnits(
* {
* // The maximum number of ad units to include in the response, used for paging. If unspecified, at most 10000 ad units will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
* pageSize: 'placeholder-value',
* // A page token, received from a previous `ListLinkedAdUnits` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListLinkedAdUnits` must match the call that provided the page token.
* pageToken: 'placeholder-value',
* // Required. The custom channel which owns the collection of ad units. Format: accounts/{account\}/adclients/{adclient\}/customchannels/{customchannel\}
* parent:
* 'accounts/my-account/adclients/my-adclient/customchannels/my-customchannel',
* }
* );
* console.log(res.data);
*
* // Example response
* // {
* // "adUnits": [],
* // "nextPageToken": "my_nextPageToken"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
listLinkedAdUnits(params: Params$Resource$Accounts$Adclients$Customchannels$Listlinkedadunits, options: StreamMethodOptions): GaxiosPromise<Readable>;
listLinkedAdUnits(params?: Params$Resource$Accounts$Adclients$Customchannels$Listlinkedadunits, options?: MethodOptions): GaxiosPromise<Schema$ListLinkedAdUnitsResponse>;
listLinkedAdUnits(params: Params$Resource$Accounts$Adclients$Customchannels$Listlinkedadunits, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
listLinkedAdUnits(params: Params$Resource$Accounts$Adclients$Customchannels$Listlinkedadunits, options: MethodOptions | BodyResponseCallback<Schema$ListLinkedAdUnitsResponse>, callback: BodyResponseCallback<Schema$ListLinkedAdUnitsResponse>): void;
listLinkedAdUnits(params: Params$Resource$Accounts$Adclients$Customchannels$Listlinkedadunits, callback: BodyResponseCallback<Schema$ListLinkedAdUnitsResponse>): void;
listLinkedAdUnits(callback: BodyResponseCallback<Schema$ListLinkedAdUnitsResponse>): void;
}
export interface Params$Resource$Accounts$Adclients$Customchannels$Get extends StandardParameters {
/**
* Required. Name of the custom channel. Format: accounts/{account\}/adclients/{adclient\}/customchannels/{customchannel\}
*/
name?: string;
}
export interface Params$Resource$Accounts$Adclients$Customchannels$List extends StandardParameters {
/**
* The maximum number of custom channels to include in the response, used for paging. If unspecified, at most 10000 custom channels will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
*/
pageSize?: number;
/**
* A page token, received from a previous `ListCustomChannels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCustomChannels` must match the call that provided the page token.
*/
pageToken?: string;
/**
* Required. The ad client which owns the collection of custom channels. Format: accounts/{account\}/adclients/{adclient\}
*/
parent?: string;
}
export interface Params$Resource$Accounts$Adclients$Customchannels$Listlinkedadunits extends StandardParameters {
/**
* The maximum number of ad units to include in the response, used for paging. If unspecified, at most 10000 ad units will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
*/
pageSize?: number;
/**
* A page token, received from a previous `ListLinkedAdUnits` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListLinkedAdUnits` must match the call that provided the page token.
*/
pageToken?: string;
/**
* Required. The custom channel which owns the collection of ad units. Format: accounts/{account\}/adclients/{adclient\}/customchannels/{customchannel\}
*/
parent?: string;
}
export class Resource$Accounts$Adclients$Urlchannels {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Lists active url channels.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/adsense.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const adsense = google.adsense('v2');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/adsense',
* 'https://www.googleapis.com/auth/adsense.readonly',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await adsense.accounts.adclients.urlchannels.list({
* // The maximum number of url channels to include in the response, used for paging. If unspecified, at most 10000 url channels will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
* pageSize: 'placeholder-value',
* // A page token, received from a previous `ListUrlChannels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUrlChannels` must match the call that provided the page token.
* pageToken: 'placeholder-value',
* // Required. The ad client which owns the collection of url channels. Format: accounts/{account\}/adclients/{adclient\}
* parent: 'accounts/my-account/adclients/my-adclient',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "nextPageToken": "my_nextPageToken",
* // "urlChannels": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Accounts$Adclients$Urlchannels$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Accounts$Adclients$Urlchannels$List, options?: MethodOptions): GaxiosPromise<Schema$ListUrlChannelsResponse>;
list(params: Params$Resource$Accounts$Adclients$Urlchannels$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Accounts$Adclients$Urlchannels$List, options: MethodOptions | BodyResponseCallback<Schema$ListUrlChannelsResponse>, callback: BodyResponseCallback<Schema$ListUrlChannelsResponse>): void;
list(params: Params$Resource$Accounts$Adclients$Urlchannels$List, callback: BodyResponseCallback<Schema$ListUrlChannelsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListUrlChannelsResponse>): void;
}
export interface Params$Resource$Accounts$Adclients$Urlchannels$List extends StandardParameters {
/**
* The maximum number of url channels to include in the response, used for paging. If unspecified, at most 10000 url channels will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
*/
pageSize?: number;
/**
* A page token, received from a previous `ListUrlChannels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUrlChannels` must match the call that provided the page token.
*/
pageToken?: string;
/**
* Required. The ad client which owns the collection of url channels. Format: accounts/{account\}/adclients/{adclient\}
*/
parent?: string;
}
export class Resource$Accounts$Alerts {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Lists all the alerts available in an account.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/adsense.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const adsense = google.adsense('v2');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/adsense',
* 'https://www.googleapis.com/auth/adsense.readonly',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await adsense.accounts.alerts.list({
* // The language to use for translating alert messages. If unspecified, this defaults to the user's display language. If the given language is not supported, alerts will be returned in English. The language is specified as an [IETF BCP-47 language code](https://en.wikipedia.org/wiki/IETF_language_tag).
* languageCode: 'placeholder-value',
* // Required. The account which owns the collection of alerts. Format: accounts/{account\}
* parent: 'accounts/my-account',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "alerts": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Accounts$Alerts$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Accounts$Alerts$List, options?: MethodOptions): GaxiosPromise<Schema$ListAlertsResponse>;
list(params: Params$Resource$Accounts$Alerts$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Accounts$Alerts$List, options: MethodOptions | BodyResponseCallback<Schema$ListAlertsResponse>, callback: BodyResponseCallback<Schema$ListAlertsResponse>): void;
list(params: Params$Resource$Accounts$Alerts$List, callback: BodyResponseCallback<Schema$ListAlertsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListAlertsResponse>): void;
}
export interface Params$Resource$Accounts$Alerts$List extends StandardParameters {
/**
* The language to use for translating alert messages. If unspecified, this defaults to the user's display language. If the given language is not supported, alerts will be returned in English. The language is specified as an [IETF BCP-47 language code](https://en.wikipedia.org/wiki/IETF_language_tag).
*/
languageCode?: string;
/**
* Required. The account which owns the collection of alerts. Format: accounts/{account\}
*/
parent?: string;
}
export class Resource$Accounts$Payments {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Lists all the payments available for an account.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/adsense.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const adsense = google.adsense('v2');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/adsense',
* 'https://www.googleapis.com/auth/adsense.readonly',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await adsense.accounts.payments.list({
* // Required. The account which owns the collection of payments. Format: accounts/{account\}
* parent: 'accounts/my-account',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "payments": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Accounts$Payments$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Accounts$Payments$List, options?: MethodOptions): GaxiosPromise<Schema$ListPaymentsResponse>;
list(params: Params$Resource$Accounts$Payments$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Accounts$Payments$List, options: MethodOptions | BodyResponseCallback<Schema$ListPaymentsResponse>, callback: BodyResponseCallback<Schema$ListPaymentsResponse>): void;
list(params: Params$Resource$Accounts$Payments$List, callback: BodyResponseCallback<Schema$ListPaymentsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListPaymentsResponse>): void;
}
export interface Params$Resource$Accounts$Payments$List extends StandardParameters {
/**
* Required. The account which owns the collection of payments. Format: accounts/{account\}
*/
parent?: string;
}
export class Resource$Accounts$Reports {
context: APIRequestContext;
saved: Resource$Accounts$Reports$Saved;
constructor(context: APIRequestContext);
/**
* Generates an ad hoc report.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/adsense.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const adsense = google.adsense('v2');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/adsense',
* 'https://www.googleapis.com/auth/adsense.readonly',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await adsense.accounts.reports.generate({
* // Required. The account which owns the collection of reports. Format: accounts/{account\}
* account: 'accounts/my-account',
* // The [ISO-4217 currency code](https://en.wikipedia.org/wiki/ISO_4217) to use when reporting on monetary metrics. Defaults to the account's currency if not set.
* currencyCode: 'placeholder-value',
* // Date range of the report, if unset the range will be considered CUSTOM.
* dateRange: 'placeholder-value',
* // Dimensions to base the report on.
* dimensions: 'placeholder-value',
* // Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
* 'endDate.day': 'placeholder-value',
* // Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
* 'endDate.month': 'placeholder-value',
* // Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
* 'endDate.year': 'placeholder-value',
* // Filters to be run on the report.
* filters: 'placeholder-value',
* // The language to use for translating report output. If unspecified, this defaults to English ("en"). If the given language is not supported, report output will be returned in English. The language is specified as an [IETF BCP-47 language code](https://en.wikipedia.org/wiki/IETF_language_tag).
* languageCode: 'placeholder-value',
* // The maximum number of rows of report data to return. Reports producing more rows than the requested limit will be truncated. If unset, this defaults to 100,000 rows for `Reports.GenerateReport` and 1,000,000 rows for `Reports.GenerateCsvReport`, which are also the maximum values permitted here. Report truncation can be identified (for `Reports.GenerateReport` only) by comparing the number of rows returned to the value returned in `total_matched_rows`.
* limit: 'placeholder-value',
* // Required. Reporting metrics.
* metrics: 'placeholder-value',
* // The name of a dimension or metric to sort the resulting report on, can be prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending.
* orderBy: 'placeholder-value',
* // Timezone in which to generate the report. If unspecified, this defaults to the account timezone. For more information, see [changing the time zone of your reports](https://support.google.com/adsense/answer/9830725).
* reportingTimeZone: 'placeholder-value',
* // Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
* 'startDate.day': 'placeholder-value',
* // Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
* 'startDate.month': 'placeholder-value',
* // Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
* 'startDate.year': 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "averages": {},
* // "endDate": {},
* // "headers": [],
* // "rows": [],
* // "startDate": {},
* // "totalMatchedRows": "my_totalMatchedRows",
* // "totals": {},
* // "warnings": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
generate(params: Params$Resource$Accounts$Reports$Generate, options: StreamMethodOptions): GaxiosPromise<Readable>;
generate(params?: Params$Resource$Accounts$Reports$Generate, options?: MethodOptions): GaxiosPromise<Schema$ReportResult>;
generate(params: Params$Resource$Accounts$Reports$Generate, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
generate(params: Params$Resource$Accounts$Reports$Generate, options: MethodOptions | BodyResponseCallback<Schema$ReportResult>, callback: BodyResponseCallback<Schema$ReportResult>): void;
generate(params: Params$Resource$Accounts$Reports$Generate, callback: BodyResponseCallback<Schema$ReportResult>): void;
generate(callback: BodyResponseCallback<Schema$ReportResult>): void;
/**
* Generates a csv formatted ad hoc report.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/adsense.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const adsense = google.adsense('v2');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/adsense',
* 'https://www.googleapis.com/auth/adsense.readonly',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await adsense.accounts.reports.generateCsv({
* // Required. The account which owns the collection of reports. Format: accounts/{account\}
* account: 'accounts/my-account',
* // The [ISO-4217 currency code](https://en.wikipedia.org/wiki/ISO_4217) to use when reporting on monetary metrics. Defaults to the account's currency if not set.
* currencyCode: 'placeholder-value',
* // Date range of the report, if unset the range will be considered CUSTOM.
* dateRange: 'placeholder-value',
* // Dimensions to base the report on.
* dimensions: 'placeholder-value',
* // Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
* 'endDate.day': 'placeholder-value',
* // Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
* 'endDate.month': 'placeholder-value',
* // Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
* 'endDate.year': 'placeholder-value',
* // Filters to be run on the report.
* filters: 'placeholder-value',
* // The language to use for translating report output. If unspecified, this defaults to English ("en"). If the given language is not supported, report output will be returned in English. The language is specified as an [IETF BCP-47 language code](https://en.wikipedia.org/wiki/IETF_language_tag).
* languageCode: 'placeholder-value',
* // The maximum number of rows of report data to return. Reports producing more rows than the requested limit will be truncated. If unset, this defaults to 100,000 rows for `Reports.GenerateReport` and 1,000,000 rows for `Reports.GenerateCsvReport`, which are also the maximum values permitted here. Report truncation can be identified (for `Reports.GenerateReport` only) by comparing the number of rows returned to the value returned in `total_matched_rows`.
* limit: 'placeholder-value',
* // Required. Reporting metrics.
* metrics: 'placeholder-value',
* // The name of a dimension or metric to sort the resulting report on, can be prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending.
* orderBy: 'placeholder-value',
* // Timezone in which to generate the report. If unspecified, this defaults to the account timezone. For more information, see [changing the time zone of your reports](https://support.google.com/adsense/answer/9830725).
* reportingTimeZone: 'placeholder-value',
* // Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
* 'startDate.day': 'placeholder-value',
* // Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
* 'startDate.month': 'placeholder-value',
* // Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
* 'startDate.year': 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "contentType": "my_contentType",
* // "data": "my_data",
* // "extensions": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
generateCsv(params: Params$Resource$Accounts$Reports$Generatecsv, options: StreamMethodOptions): GaxiosPromise<Readable>;
generateCsv(params?: Params$Resource$Accounts$Reports$Generatecsv, options?: MethodOptions): GaxiosPromise<Schema$HttpBody>;
generateCsv(params: Params$Resource$Accounts$Reports$Generatecsv, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
generateCsv(params: Params$Resource$Accounts$Reports$Generatecsv, options: MethodOptions | BodyResponseCallback<Schema$HttpBody>, callback: BodyResponseCallback<Schema$HttpBody>): void;
generateCsv(params: Params$Resource$Accounts$Reports$Generatecsv, callback: BodyResponseCallback<Schema$HttpBody>): void;
generateCsv(callback: BodyResponseCallback<Schema$HttpBody>): void;
}
export interface Params$Resource$Accounts$Reports$Generate extends StandardParameters {
/**
* Required. The account which owns the collection of reports. Format: accounts/{account\}
*/
account?: string;
/**
* The [ISO-4217 currency code](https://en.wikipedia.org/wiki/ISO_4217) to use when reporting on monetary metrics. Defaults to the account's currency if not set.
*/
currencyCode?: string;
/**
* Date range of the report, if unset the range will be considered CUSTOM.
*/
dateRange?: string;
/**
* Dimensions to base the report on.
*/
dimensions?: string[];
/**
* Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
*/
'endDate.day'?: number;
/**
* Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
*/
'endDate.month'?: number;
/**
* Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
*/
'endDate.year'?: number;
/**
* Filters to be run on the report.
*/
filters?: string[];
/**
* The language to use for translating report output. If unspecified, this defaults to English ("en"). If the given language is not supported, report output will be returned in English. The language is specified as an [IETF BCP-47 language code](https://en.wikipedia.org/wiki/IETF_language_tag).
*/
languageCode?: string;
/**
* The maximum number of rows of report data to return. Reports producing more rows than the requested limit will be truncated. If unset, this defaults to 100,000 rows for `Reports.GenerateReport` and 1,000,000 rows for `Reports.GenerateCsvReport`, which are also the maximum values permitted here. Report truncation can be identified (for `Reports.GenerateReport` only) by comparing the number of rows returned to the value returned in `total_matched_rows`.
*/
limit?: number;
/**
* Required. Reporting metrics.
*/
metrics?: string[];
/**
* The name of a dimension or metric to sort the resulting report on, can be prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending.
*/
orderBy?: string[];
/**
* Timezone in which to generate the report. If unspecified, this defaults to the account timezone. For more information, see [changing the time zone of your reports](https://support.google.com/adsense/answer/9830725).
*/
reportingTimeZone?: string;
/**
* Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
*/
'startDate.day'?: number;
/**
* Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
*/
'startDate.month'?: number;
/**
* Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
*/
'startDate.year'?: number;
}
export interface Params$Resource$Accounts$Reports$Generatecsv extends StandardParameters {
/**
* Required. The account which owns the collection of reports. Format: accounts/{account\}
*/
account?: string;
/**
* The [ISO-4217 currency code](https://en.wikipedia.org/wiki/ISO_4217) to use when reporting on monetary metrics. Defaults to the account's currency if not set.
*/
currencyCode?: string;
/**
* Date range of the report, if unset the range will be considered CUSTOM.
*/
dateRange?: string;
/**
* Dimensions to base the report on.
*/
dimensions?: string[];
/**
* Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
*/
'endDate.day'?: number;
/**
* Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
*/
'endDate.month'?: number;
/**
* Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
*/
'endDate.year'?: number;
/**
* Filters to be run on the report.
*/
filters?: string[];
/**
* The language to use for translating report output. If unspecified, this defaults to English ("en"). If the given language is not supported, report output will be returned in English. The language is specified as an [IETF BCP-47 language code](https://en.wikipedia.org/wiki/IETF_language_tag).
*/
languageCode?: string;
/**
* The maximum number of rows of report data to return. Reports producing more rows than the requested limit will be truncated. If unset, this defaults to 100,000 rows for `Reports.GenerateReport` and 1,000,000 rows for `Reports.GenerateCsvReport`, which are also the maximum values permitted here. Report truncation can be identified (for `Reports.GenerateReport` only) by comparing the number of rows returned to the value returned in `total_matched_rows`.
*/
limit?: number;
/**
* Required. Reporting metrics.
*/
metrics?: string[];
/**
* The name of a dimension or metric to sort the resulting report on, can be prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending.
*/
orderBy?: string[];
/**
* Timezone in which to generate the report. If unspecified, this defaults to the account timezone. For more information, see [changing the time zone of your reports](https://support.google.com/adsense/answer/9830725).
*/
reportingTimeZone?: string;
/**
* Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
*/
'startDate.day'?: number;
/**
* Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
*/
'startDate.month'?: number;
/**
* Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
*/
'startDate.year'?: number;
}
export class Resource$Accounts$Reports$Saved {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Generates a saved report.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/adsense.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const adsense = google.adsense('v2');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/adsense',
* 'https://www.googleapis.com/auth/adsense.readonly',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await adsense.accounts.reports.saved.generate({
* // The [ISO-4217 currency code](https://en.wikipedia.org/wiki/ISO_4217) to use when reporting on monetary metrics. Defaults to the account's currency if not set.
* currencyCode: 'placeholder-value',
* // Date range of the report, if unset the range will be considered CUSTOM.
* dateRange: 'placeholder-value',
* // Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
* 'endDate.day': 'placeholder-value',
* // Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
* 'endDate.month': 'placeholder-value',
* // Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
* 'endDate.year': 'placeholder-value',
* // The language to use for translating report output. If unspecified, this defaults to English ("en"). If the given language is not supported, report output will be returned in English. The language is specified as an [IETF BCP-47 language code](https://en.wikipedia.org/wiki/IETF_language_tag).
* languageCode: 'placeholder-value',
* // Required. Name of the saved report. Format: accounts/{account\}/reports/{report\}
* name: 'accounts/my-account/reports/my-report',
* // Timezone in which to generate the report. If unspecified, this defaults to the account timezone. For more information, see [changing the time zone of your reports](https://support.google.com/adsense/answer/9830725).
* reportingTimeZone: 'placeholder-value',
* // Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
* 'startDate.day': 'placeholder-value',
* // Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
* 'startDate.month': 'placeholder-value',
* // Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
* 'startDate.year': 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "averages": {},
* // "endDate": {},
* // "headers": [],
* // "rows": [],
* // "startDate": {},
* // "totalMatchedRows": "my_totalMatchedRows",
* // "totals": {},
* // "warnings": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
generate(params: Params$Resource$Accounts$Reports$Saved$Generate, options: StreamMethodOptions): GaxiosPromise<Readable>;
generate(params?: Params$Resource$Accounts$Reports$Saved$Generate, options?: MethodOptions): GaxiosPromise<Schema$ReportResult>;
generate(params: Params$Resource$Accounts$Reports$Saved$Generate, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
generate(params: Params$Resource$Accounts$Reports$Saved$Generate, options: MethodOptions | BodyResponseCallback<Schema$ReportResult>, callback: BodyResponseCallback<Schema$ReportResult>): void;
generate(params: Params$Resource$Accounts$Reports$Saved$Generate, callback: BodyResponseCallback<Schema$ReportResult>): void;
generate(callback: BodyResponseCallback<Schema$ReportResult>): void;
/**
* Generates a csv formatted saved report.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/adsense.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const adsense = google.adsense('v2');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/adsense',
* 'https://www.googleapis.com/auth/adsense.readonly',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await adsense.accounts.reports.saved.generateCsv({
* // The [ISO-4217 currency code](https://en.wikipedia.org/wiki/ISO_4217) to use when reporting on monetary metrics. Defaults to the account's currency if not set.
* currencyCode: 'placeholder-value',
* // Date range of the report, if unset the range will be considered CUSTOM.
* dateRange: 'placeholder-value',
* // Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
* 'endDate.day': 'placeholder-value',
* // Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
* 'endDate.month': 'placeholder-value',
* // Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
* 'endDate.year': 'placeholder-value',
* // The language to use for translating report output. If unspecified, this defaults to English ("en"). If the given language is not supported, report output will be returned in English. The language is specified as an [IETF BCP-47 language code](https://en.wikipedia.org/wiki/IETF_language_tag).
* languageCode: 'placeholder-value',
* // Required. Name of the saved report. Format: accounts/{account\}/reports/{report\}
* name: 'accounts/my-account/reports/my-report',
* // Timezone in which to generate the report. If unspecified, this defaults to the account timezone. For more information, see [changing the time zone of your reports](https://support.google.com/adsense/answer/9830725).
* reportingTimeZone: 'placeholder-value',
* // Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
* 'startDate.day': 'placeholder-value',
* // Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
* 'startDate.month': 'placeholder-value',
* // Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
* 'startDate.year': 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "contentType": "my_contentType",
* // "data": "my_data",
* // "extensions": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
generateCsv(params: Params$Resource$Accounts$Reports$Saved$Generatecsv, options: StreamMethodOptions): GaxiosPromise<Readable>;
generateCsv(params?: Params$Resource$Accounts$Reports$Saved$Generatecsv, options?: MethodOptions): GaxiosPromise<Schema$HttpBody>;
generateCsv(params: Params$Resource$Accounts$Reports$Saved$Generatecsv, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
generateCsv(params: Params$Resource$Accounts$Reports$Saved$Generatecsv, options: MethodOptions | BodyResponseCallback<Schema$HttpBody>, callback: BodyResponseCallback<Schema$HttpBody>): void;
generateCsv(params: Params$Resource$Accounts$Reports$Saved$Generatecsv, callback: BodyResponseCallback<Schema$HttpBody>): void;
generateCsv(callback: BodyResponseCallback<Schema$HttpBody>): void;
/**
* Lists saved reports.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/adsense.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const adsense = google.adsense('v2');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/adsense',
* 'https://www.googleapis.com/auth/adsense.readonly',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await adsense.accounts.reports.saved.list({
* // The maximum number of reports to include in the response, used for paging. If unspecified, at most 10000 reports will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
* pageSize: 'placeholder-value',
* // A page token, received from a previous `ListPayments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPayments` must match the call that provided the page token.
* pageToken: 'placeholder-value',
* // Required. The account which owns the collection of reports. Format: accounts/{account\}
* parent: 'accounts/my-account',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "nextPageToken": "my_nextPageToken",
* // "savedReports": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Accounts$Reports$Saved$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Accounts$Reports$Saved$List, options?: MethodOptions): GaxiosPromise<Schema$ListSavedReportsResponse>;
list(params: Params$Resource$Accounts$Reports$Saved$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Accounts$Reports$Saved$List, options: MethodOptions | BodyResponseCallback<Schema$ListSavedReportsResponse>, callback: BodyResponseCallback<Schema$ListSavedReportsResponse>): void;
list(params: Params$Resource$Accounts$Reports$Saved$List, callback: BodyResponseCallback<Schema$ListSavedReportsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListSavedReportsResponse>): void;
}
export interface Params$Resource$Accounts$Reports$Saved$Generate extends StandardParameters {
/**
* The [ISO-4217 currency code](https://en.wikipedia.org/wiki/ISO_4217) to use when reporting on monetary metrics. Defaults to the account's currency if not set.
*/
currencyCode?: string;
/**
* Date range of the report, if unset the range will be considered CUSTOM.
*/
dateRange?: string;
/**
* Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
*/
'endDate.day'?: number;
/**
* Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
*/
'endDate.month'?: number;
/**
* Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
*/
'endDate.year'?: number;
/**
* The language to use for translating report output. If unspecified, this defaults to English ("en"). If the given language is not supported, report output will be returned in English. The language is specified as an [IETF BCP-47 language code](https://en.wikipedia.org/wiki/IETF_language_tag).
*/
languageCode?: string;
/**
* Required. Name of the saved report. Format: accounts/{account\}/reports/{report\}
*/
name?: string;
/**
* Timezone in which to generate the report. If unspecified, this defaults to the account timezone. For more information, see [changing the time zone of your reports](https://support.google.com/adsense/answer/9830725).
*/
reportingTimeZone?: string;
/**
* Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
*/
'startDate.day'?: number;
/**
* Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
*/
'startDate.month'?: number;
/**
* Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
*/
'startDate.year'?: number;
}
export interface Params$Resource$Accounts$Reports$Saved$Generatecsv extends StandardParameters {
/**
* The [ISO-4217 currency code](https://en.wikipedia.org/wiki/ISO_4217) to use when reporting on monetary metrics. Defaults to the account's currency if not set.
*/
currencyCode?: string;
/**
* Date range of the report, if unset the range will be considered CUSTOM.
*/
dateRange?: string;
/**
* Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
*/
'endDate.day'?: number;
/**
* Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
*/
'endDate.month'?: number;
/**
* Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
*/
'endDate.year'?: number;
/**
* The language to use for translating report output. If unspecified, this defaults to English ("en"). If the given language is not supported, report output will be returned in English. The language is specified as an [IETF BCP-47 language code](https://en.wikipedia.org/wiki/IETF_language_tag).
*/
languageCode?: string;
/**
* Required. Name of the saved report. Format: accounts/{account\}/reports/{report\}
*/
name?: string;
/**
* Timezone in which to generate the report. If unspecified, this defaults to the account timezone. For more information, see [changing the time zone of your reports](https://support.google.com/adsense/answer/9830725).
*/
reportingTimeZone?: string;
/**
* Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
*/
'startDate.day'?: number;
/**
* Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
*/
'startDate.month'?: number;
/**
* Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
*/
'startDate.year'?: number;
}
export interface Params$Resource$Accounts$Reports$Saved$List extends StandardParameters {
/**
* The maximum number of reports to include in the response, used for paging. If unspecified, at most 10000 reports will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
*/
pageSize?: number;
/**
* A page token, received from a previous `ListPayments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPayments` must match the call that provided the page token.
*/
pageToken?: string;
/**
* Required. The account which owns the collection of reports. Format: accounts/{account\}
*/
parent?: string;
}
export class Resource$Accounts$Sites {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Gets information about the selected site.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/adsense.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const adsense = google.adsense('v2');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/adsense',
* 'https://www.googleapis.com/auth/adsense.readonly',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await adsense.accounts.sites.get({
* // Required. Name of the site. Format: accounts/{account\}/sites/{site\}
* name: 'accounts/my-account/sites/my-site',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "autoAdsEnabled": false,
* // "domain": "my_domain",
* // "name": "my_name",
* // "reportingDimensionId": "my_reportingDimensionId",
* // "state": "my_state"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Accounts$Sites$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Accounts$Sites$Get, options?: MethodOptions): GaxiosPromise<Schema$Site>;
get(params: Params$Resource$Accounts$Sites$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Accounts$Sites$Get, options: MethodOptions | BodyResponseCallback<Schema$Site>, callback: BodyResponseCallback<Schema$Site>): void;
get(params: Params$Resource$Accounts$Sites$Get, callback: BodyResponseCallback<Schema$Site>): void;
get(callback: BodyResponseCallback<Schema$Site>): void;
/**
* Lists all the sites available in an account.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/adsense.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const adsense = google.adsense('v2');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/adsense',
* 'https://www.googleapis.com/auth/adsense.readonly',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await adsense.accounts.sites.list({
* // The maximum number of sites to include in the response, used for paging. If unspecified, at most 10000 sites will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
* pageSize: 'placeholder-value',
* // A page token, received from a previous `ListSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSites` must match the call that provided the page token.
* pageToken: 'placeholder-value',
* // Required. The account which owns the collection of sites. Format: accounts/{account\}
* parent: 'accounts/my-account',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "nextPageToken": "my_nextPageToken",
* // "sites": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Accounts$Sites$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Accounts$Sites$List, options?: MethodOptions): GaxiosPromise<Schema$ListSitesResponse>;
list(params: Params$Resource$Accounts$Sites$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Accounts$Sites$List, options: MethodOptions | BodyResponseCallback<Schema$ListSitesResponse>, callback: BodyResponseCallback<Schema$ListSitesResponse>): void;
list(params: Params$Resource$Accounts$Sites$List, callback: BodyResponseCallback<Schema$ListSitesResponse>): void;
list(callback: BodyResponseCallback<Schema$ListSitesResponse>): void;
}
export interface Params$Resource$Accounts$Sites$Get extends StandardParameters {
/**
* Required. Name of the site. Format: accounts/{account\}/sites/{site\}
*/
name?: string;
}
export interface Params$Resource$Accounts$Sites$List extends StandardParameters {
/**
* The maximum number of sites to include in the response, used for paging. If unspecified, at most 10000 sites will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
*/
pageSize?: number;
/**
* A page token, received from a previous `ListSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSites` must match the call that provided the page token.
*/
pageToken?: string;
/**
* Required. The account which owns the collection of sites. Format: accounts/{account\}
*/
parent?: string;
}
export {};
}