v4.1.d.ts
64.5 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
/**
* Copyright 2019 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { OAuth2Client, JWT, Compute, UserRefreshClient } from 'google-auth-library';
import { GoogleConfigurable, MethodOptions, GlobalOptions, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { GaxiosPromise } from 'gaxios';
export declare namespace adsensehost_v4_1 {
export interface Options extends GlobalOptions {
version: 'v4.1';
}
interface StandardParameters {
/**
* Data format for the response.
*/
alt?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
*/
quotaUser?: string;
/**
* Deprecated. Please use quotaUser instead.
*/
userIp?: string;
}
/**
* AdSense Host API
*
* Generates performance reports, generates ad codes, and provides publisher management capabilities for AdSense Hosts.
*
* @example
* const {google} = require('googleapis');
* const adsensehost = google.adsensehost('v4.1');
*
* @namespace adsensehost
* @type {Function}
* @version v4.1
* @variation v4.1
* @param {object=} options Options for Adsensehost
*/
export class Adsensehost {
context: APIRequestContext;
accounts: Resource$Accounts;
adclients: Resource$Adclients;
associationsessions: Resource$Associationsessions;
customchannels: Resource$Customchannels;
reports: Resource$Reports;
urlchannels: Resource$Urlchannels;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
export interface Schema$Account {
/**
* Unique identifier of this account.
*/
id?: string | null;
/**
* Kind of resource this is, in this case adsensehost#account.
*/
kind?: string | null;
/**
* Name of this account.
*/
name?: string | null;
/**
* Approval status of this account. One of: PENDING, APPROVED, DISABLED.
*/
status?: string | null;
}
export interface Schema$Accounts {
/**
* ETag of this response for caching purposes.
*/
etag?: string | null;
/**
* The accounts returned in this list response.
*/
items?: Schema$Account[];
/**
* Kind of list this is, in this case adsensehost#accounts.
*/
kind?: string | null;
}
export interface Schema$AdClient {
/**
* Whether this ad client is opted in to ARC.
*/
arcOptIn?: boolean | null;
/**
* Unique identifier of this ad client.
*/
id?: string | null;
/**
* Kind of resource this is, in this case adsensehost#adClient.
*/
kind?: string | null;
/**
* This ad client's product code, which corresponds to the PRODUCT_CODE report dimension.
*/
productCode?: string | null;
/**
* Whether this ad client supports being reported on.
*/
supportsReporting?: boolean | null;
}
export interface Schema$AdClients {
/**
* ETag of this response for caching purposes.
*/
etag?: string | null;
/**
* The ad clients returned in this list response.
*/
items?: Schema$AdClient[];
/**
* Kind of list this is, in this case adsensehost#adClients.
*/
kind?: string | null;
/**
* Continuation token used to page through ad clients. To retrieve the next page of results, set the next request's "pageToken" value to this.
*/
nextPageToken?: string | null;
}
export interface Schema$AdCode {
/**
* The ad code snippet.
*/
adCode?: string | null;
/**
* Kind this is, in this case adsensehost#adCode.
*/
kind?: string | null;
}
export interface Schema$AdStyle {
/**
* The colors included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
*/
colors?: {
background?: string;
border?: string;
text?: string;
title?: string;
url?: string;
} | null;
/**
* The style of the corners in the ad (deprecated: never populated, ignored).
*/
corners?: string | null;
/**
* The font which is included in the style.
*/
font?: {
family?: string;
size?: string;
} | null;
/**
* Kind this is, in this case adsensehost#adStyle.
*/
kind?: string | null;
}
export interface Schema$AdUnit {
/**
* Identity code of this ad unit, not necessarily unique across ad clients.
*/
code?: string | null;
/**
* Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated).
*/
contentAdsSettings?: {
backupOption?: {
color?: string;
type?: string;
url?: string;
};
size?: string;
type?: string;
} | null;
/**
* Custom style information specific to this ad unit.
*/
customStyle?: Schema$AdStyle;
/**
* Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
*/
id?: string | null;
/**
* Kind of resource this is, in this case adsensehost#adUnit.
*/
kind?: string | null;
/**
* Settings specific to WAP mobile content ads (AFMC - deprecated).
*/
mobileContentAdsSettings?: {
markupLanguage?: string;
scriptingLanguage?: string;
size?: string;
type?: string;
} | null;
/**
* Name of this ad unit.
*/
name?: string | null;
/**
* Status of this ad unit. Possible values are: NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it. ACTIVE: Indicates that there has been activity on this ad unit in the last seven days. INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
*/
status?: string | null;
}
export interface Schema$AdUnits {
/**
* ETag of this response for caching purposes.
*/
etag?: string | null;
/**
* The ad units returned in this list response.
*/
items?: Schema$AdUnit[];
/**
* Kind of list this is, in this case adsensehost#adUnits.
*/
kind?: string | null;
/**
* Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this.
*/
nextPageToken?: string | null;
}
export interface Schema$AssociationSession {
/**
* Hosted account id of the associated publisher after association. Present if status is ACCEPTED.
*/
accountId?: string | null;
/**
* Unique identifier of this association session.
*/
id?: string | null;
/**
* Kind of resource this is, in this case adsensehost#associationSession.
*/
kind?: string | null;
/**
* The products to associate with the user. Options: AFC, AFG, AFV, AFS (deprecated), AFMC (deprecated)
*/
productCodes?: string[] | null;
/**
* Redirect URL of this association session. Used to redirect users into the AdSense association flow.
*/
redirectUrl?: string | null;
/**
* Status of the completed association, available once the association callback token has been verified. One of ACCEPTED, REJECTED, or ERROR.
*/
status?: string | null;
/**
* The preferred locale of the user themselves when going through the AdSense association flow.
*/
userLocale?: string | null;
/**
* The locale of the user's hosted website.
*/
websiteLocale?: string | null;
/**
* The URL of the user's hosted website.
*/
websiteUrl?: string | null;
}
export interface Schema$CustomChannel {
/**
* Code of this custom channel, not necessarily unique across ad clients.
*/
code?: string | null;
/**
* Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
*/
id?: string | null;
/**
* Kind of resource this is, in this case adsensehost#customChannel.
*/
kind?: string | null;
/**
* Name of this custom channel.
*/
name?: string | null;
}
export interface Schema$CustomChannels {
/**
* ETag of this response for caching purposes.
*/
etag?: string | null;
/**
* The custom channels returned in this list response.
*/
items?: Schema$CustomChannel[];
/**
* Kind of list this is, in this case adsensehost#customChannels.
*/
kind?: string | null;
/**
* Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
*/
nextPageToken?: string | null;
}
export interface Schema$Report {
/**
* 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?: string[] | null;
/**
* The header information of the columns requested in the report. This is a list of headers; one for each dimension in the request, followed by one for each metric in the request.
*/
headers?: Array<{
currency?: string;
name?: string;
type?: string;
}> | null;
/**
* Kind this is, in this case adsensehost#report.
*/
kind?: string | null;
/**
* 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. The dimension cells contain strings, and the metric cells contain numbers.
*/
rows?: string[][] | null;
/**
* The total number of rows matched by the report request. Fewer rows may be returned in the response due to being limited by the row count requested or the report row limit.
*/
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?: string[] | null;
/**
* Any warnings associated with generation of the report.
*/
warnings?: string[] | null;
}
export interface Schema$UrlChannel {
/**
* Unique identifier of this URL channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
*/
id?: string | null;
/**
* Kind of resource this is, in this case adsensehost#urlChannel.
*/
kind?: string | null;
/**
* URL Pattern of this URL channel. Does not include "http://" or "https://". Example: www.example.com/home
*/
urlPattern?: string | null;
}
export interface Schema$UrlChannels {
/**
* ETag of this response for caching purposes.
*/
etag?: string | null;
/**
* The URL channels returned in this list response.
*/
items?: Schema$UrlChannel[];
/**
* Kind of list this is, in this case adsensehost#urlChannels.
*/
kind?: string | null;
/**
* Continuation token used to page through URL channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
*/
nextPageToken?: string | null;
}
export class Resource$Accounts {
context: APIRequestContext;
adclients: Resource$Accounts$Adclients;
adunits: Resource$Accounts$Adunits;
reports: Resource$Accounts$Reports;
constructor(context: APIRequestContext);
/**
* adsensehost.accounts.get
* @desc Get information about the selected associated AdSense account.
* @alias adsensehost.accounts.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountId Account to get information about.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Accounts$Get, options?: MethodOptions): GaxiosPromise<Schema$Account>;
get(params: Params$Resource$Accounts$Get, options: MethodOptions | BodyResponseCallback<Schema$Account>, callback: BodyResponseCallback<Schema$Account>): void;
get(params: Params$Resource$Accounts$Get, callback: BodyResponseCallback<Schema$Account>): void;
get(callback: BodyResponseCallback<Schema$Account>): void;
/**
* adsensehost.accounts.list
* @desc List hosted accounts associated with this AdSense account by ad client id.
* @alias adsensehost.accounts.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.filterAdClientId Ad clients to list accounts for.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Accounts$List, options?: MethodOptions): GaxiosPromise<Schema$Accounts>;
list(params: Params$Resource$Accounts$List, options: MethodOptions | BodyResponseCallback<Schema$Accounts>, callback: BodyResponseCallback<Schema$Accounts>): void;
list(params: Params$Resource$Accounts$List, callback: BodyResponseCallback<Schema$Accounts>): void;
list(callback: BodyResponseCallback<Schema$Accounts>): void;
}
export interface Params$Resource$Accounts$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Account to get information about.
*/
accountId?: string;
}
export interface Params$Resource$Accounts$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Ad clients to list accounts for.
*/
filterAdClientId?: string[];
}
export class Resource$Accounts$Adclients {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* adsensehost.accounts.adclients.get
* @desc Get information about one of the ad clients in the specified publisher's AdSense account.
* @alias adsensehost.accounts.adclients.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountId Account which contains the ad client.
* @param {string} params.adClientId Ad client to get.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Accounts$Adclients$Get, options?: MethodOptions): GaxiosPromise<Schema$AdClient>;
get(params: Params$Resource$Accounts$Adclients$Get, options: MethodOptions | BodyResponseCallback<Schema$AdClient>, callback: BodyResponseCallback<Schema$AdClient>): void;
get(params: Params$Resource$Accounts$Adclients$Get, callback: BodyResponseCallback<Schema$AdClient>): void;
get(callback: BodyResponseCallback<Schema$AdClient>): void;
/**
* adsensehost.accounts.adclients.list
* @desc List all hosted ad clients in the specified hosted account.
* @alias adsensehost.accounts.adclients.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountId Account for which to list ad clients.
* @param {integer=} params.maxResults The maximum number of ad clients to include in the response, used for paging.
* @param {string=} params.pageToken A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Accounts$Adclients$List, options?: MethodOptions): GaxiosPromise<Schema$AdClients>;
list(params: Params$Resource$Accounts$Adclients$List, options: MethodOptions | BodyResponseCallback<Schema$AdClients>, callback: BodyResponseCallback<Schema$AdClients>): void;
list(params: Params$Resource$Accounts$Adclients$List, callback: BodyResponseCallback<Schema$AdClients>): void;
list(callback: BodyResponseCallback<Schema$AdClients>): void;
}
export interface Params$Resource$Accounts$Adclients$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Account which contains the ad client.
*/
accountId?: string;
/**
* Ad client to get.
*/
adClientId?: string;
}
export interface Params$Resource$Accounts$Adclients$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Account for which to list ad clients.
*/
accountId?: string;
/**
* The maximum number of ad clients to include in the response, used for paging.
*/
maxResults?: number;
/**
* A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
*/
pageToken?: string;
}
export class Resource$Accounts$Adunits {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* adsensehost.accounts.adunits.delete
* @desc Delete the specified ad unit from the specified publisher AdSense account.
* @alias adsensehost.accounts.adunits.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountId Account which contains the ad unit.
* @param {string} params.adClientId Ad client for which to get ad unit.
* @param {string} params.adUnitId Ad unit to delete.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Accounts$Adunits$Delete, options?: MethodOptions): GaxiosPromise<Schema$AdUnit>;
delete(params: Params$Resource$Accounts$Adunits$Delete, options: MethodOptions | BodyResponseCallback<Schema$AdUnit>, callback: BodyResponseCallback<Schema$AdUnit>): void;
delete(params: Params$Resource$Accounts$Adunits$Delete, callback: BodyResponseCallback<Schema$AdUnit>): void;
delete(callback: BodyResponseCallback<Schema$AdUnit>): void;
/**
* adsensehost.accounts.adunits.get
* @desc Get the specified host ad unit in this AdSense account.
* @alias adsensehost.accounts.adunits.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountId Account which contains the ad unit.
* @param {string} params.adClientId Ad client for which to get ad unit.
* @param {string} params.adUnitId Ad unit to get.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Accounts$Adunits$Get, options?: MethodOptions): GaxiosPromise<Schema$AdUnit>;
get(params: Params$Resource$Accounts$Adunits$Get, options: MethodOptions | BodyResponseCallback<Schema$AdUnit>, callback: BodyResponseCallback<Schema$AdUnit>): void;
get(params: Params$Resource$Accounts$Adunits$Get, callback: BodyResponseCallback<Schema$AdUnit>): void;
get(callback: BodyResponseCallback<Schema$AdUnit>): void;
/**
* adsensehost.accounts.adunits.getAdCode
* @desc Get ad code for the specified ad unit, attaching the specified host custom channels.
* @alias adsensehost.accounts.adunits.getAdCode
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountId Account which contains the ad client.
* @param {string} params.adClientId Ad client with contains the ad unit.
* @param {string} params.adUnitId Ad unit to get the code for.
* @param {string=} params.hostCustomChannelId Host custom channel to attach to the ad code.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
getAdCode(params?: Params$Resource$Accounts$Adunits$Getadcode, options?: MethodOptions): GaxiosPromise<Schema$AdCode>;
getAdCode(params: Params$Resource$Accounts$Adunits$Getadcode, options: MethodOptions | BodyResponseCallback<Schema$AdCode>, callback: BodyResponseCallback<Schema$AdCode>): void;
getAdCode(params: Params$Resource$Accounts$Adunits$Getadcode, callback: BodyResponseCallback<Schema$AdCode>): void;
getAdCode(callback: BodyResponseCallback<Schema$AdCode>): void;
/**
* adsensehost.accounts.adunits.insert
* @desc Insert the supplied ad unit into the specified publisher AdSense account.
* @alias adsensehost.accounts.adunits.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountId Account which will contain the ad unit.
* @param {string} params.adClientId Ad client into which to insert the ad unit.
* @param {().AdUnit} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
insert(params?: Params$Resource$Accounts$Adunits$Insert, options?: MethodOptions): GaxiosPromise<Schema$AdUnit>;
insert(params: Params$Resource$Accounts$Adunits$Insert, options: MethodOptions | BodyResponseCallback<Schema$AdUnit>, callback: BodyResponseCallback<Schema$AdUnit>): void;
insert(params: Params$Resource$Accounts$Adunits$Insert, callback: BodyResponseCallback<Schema$AdUnit>): void;
insert(callback: BodyResponseCallback<Schema$AdUnit>): void;
/**
* adsensehost.accounts.adunits.list
* @desc List all ad units in the specified publisher's AdSense account.
* @alias adsensehost.accounts.adunits.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountId Account which contains the ad client.
* @param {string} params.adClientId Ad client for which to list ad units.
* @param {boolean=} params.includeInactive Whether to include inactive ad units. Default: true.
* @param {integer=} params.maxResults The maximum number of ad units to include in the response, used for paging.
* @param {string=} params.pageToken A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Accounts$Adunits$List, options?: MethodOptions): GaxiosPromise<Schema$AdUnits>;
list(params: Params$Resource$Accounts$Adunits$List, options: MethodOptions | BodyResponseCallback<Schema$AdUnits>, callback: BodyResponseCallback<Schema$AdUnits>): void;
list(params: Params$Resource$Accounts$Adunits$List, callback: BodyResponseCallback<Schema$AdUnits>): void;
list(callback: BodyResponseCallback<Schema$AdUnits>): void;
/**
* adsensehost.accounts.adunits.patch
* @desc Update the supplied ad unit in the specified publisher AdSense account. This method supports patch semantics.
* @alias adsensehost.accounts.adunits.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountId Account which contains the ad client.
* @param {string} params.adClientId Ad client which contains the ad unit.
* @param {string} params.adUnitId Ad unit to get.
* @param {().AdUnit} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Accounts$Adunits$Patch, options?: MethodOptions): GaxiosPromise<Schema$AdUnit>;
patch(params: Params$Resource$Accounts$Adunits$Patch, options: MethodOptions | BodyResponseCallback<Schema$AdUnit>, callback: BodyResponseCallback<Schema$AdUnit>): void;
patch(params: Params$Resource$Accounts$Adunits$Patch, callback: BodyResponseCallback<Schema$AdUnit>): void;
patch(callback: BodyResponseCallback<Schema$AdUnit>): void;
/**
* adsensehost.accounts.adunits.update
* @desc Update the supplied ad unit in the specified publisher AdSense account.
* @alias adsensehost.accounts.adunits.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountId Account which contains the ad client.
* @param {string} params.adClientId Ad client which contains the ad unit.
* @param {().AdUnit} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update(params?: Params$Resource$Accounts$Adunits$Update, options?: MethodOptions): GaxiosPromise<Schema$AdUnit>;
update(params: Params$Resource$Accounts$Adunits$Update, options: MethodOptions | BodyResponseCallback<Schema$AdUnit>, callback: BodyResponseCallback<Schema$AdUnit>): void;
update(params: Params$Resource$Accounts$Adunits$Update, callback: BodyResponseCallback<Schema$AdUnit>): void;
update(callback: BodyResponseCallback<Schema$AdUnit>): void;
}
export interface Params$Resource$Accounts$Adunits$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Account which contains the ad unit.
*/
accountId?: string;
/**
* Ad client for which to get ad unit.
*/
adClientId?: string;
/**
* Ad unit to delete.
*/
adUnitId?: string;
}
export interface Params$Resource$Accounts$Adunits$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Account which contains the ad unit.
*/
accountId?: string;
/**
* Ad client for which to get ad unit.
*/
adClientId?: string;
/**
* Ad unit to get.
*/
adUnitId?: string;
}
export interface Params$Resource$Accounts$Adunits$Getadcode extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Account which contains the ad client.
*/
accountId?: string;
/**
* Ad client with contains the ad unit.
*/
adClientId?: string;
/**
* Ad unit to get the code for.
*/
adUnitId?: string;
/**
* Host custom channel to attach to the ad code.
*/
hostCustomChannelId?: string[];
}
export interface Params$Resource$Accounts$Adunits$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Account which will contain the ad unit.
*/
accountId?: string;
/**
* Ad client into which to insert the ad unit.
*/
adClientId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$AdUnit;
}
export interface Params$Resource$Accounts$Adunits$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Account which contains the ad client.
*/
accountId?: string;
/**
* Ad client for which to list ad units.
*/
adClientId?: string;
/**
* Whether to include inactive ad units. Default: true.
*/
includeInactive?: boolean;
/**
* The maximum number of ad units to include in the response, used for paging.
*/
maxResults?: number;
/**
* A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
*/
pageToken?: string;
}
export interface Params$Resource$Accounts$Adunits$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Account which contains the ad client.
*/
accountId?: string;
/**
* Ad client which contains the ad unit.
*/
adClientId?: string;
/**
* Ad unit to get.
*/
adUnitId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$AdUnit;
}
export interface Params$Resource$Accounts$Adunits$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Account which contains the ad client.
*/
accountId?: string;
/**
* Ad client which contains the ad unit.
*/
adClientId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$AdUnit;
}
export class Resource$Accounts$Reports {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* adsensehost.accounts.reports.generate
* @desc Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter.
* @alias adsensehost.accounts.reports.generate
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountId Hosted account upon which to report.
* @param {string=} params.dimension Dimensions to base the report on.
* @param {string} params.endDate End of the date range to report on in "YYYY-MM-DD" format, inclusive.
* @param {string=} params.filter Filters to be run on the report.
* @param {string=} params.locale Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.
* @param {integer=} params.maxResults The maximum number of rows of report data to return.
* @param {string=} params.metric Numeric columns to include in the report.
* @param {string=} params.sort The name of a dimension or metric to sort the resulting report on, optionally prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending.
* @param {string} params.startDate Start of the date range to report on in "YYYY-MM-DD" format, inclusive.
* @param {integer=} params.startIndex Index of the first row of report data to return.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
generate(params?: Params$Resource$Accounts$Reports$Generate, options?: MethodOptions): GaxiosPromise<Schema$Report>;
generate(params: Params$Resource$Accounts$Reports$Generate, options: MethodOptions | BodyResponseCallback<Schema$Report>, callback: BodyResponseCallback<Schema$Report>): void;
generate(params: Params$Resource$Accounts$Reports$Generate, callback: BodyResponseCallback<Schema$Report>): void;
generate(callback: BodyResponseCallback<Schema$Report>): void;
}
export interface Params$Resource$Accounts$Reports$Generate extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Hosted account upon which to report.
*/
accountId?: string;
/**
* Dimensions to base the report on.
*/
dimension?: string[];
/**
* End of the date range to report on in "YYYY-MM-DD" format, inclusive.
*/
endDate?: string;
/**
* Filters to be run on the report.
*/
filter?: string[];
/**
* Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.
*/
locale?: string;
/**
* The maximum number of rows of report data to return.
*/
maxResults?: number;
/**
* Numeric columns to include in the report.
*/
metric?: string[];
/**
* The name of a dimension or metric to sort the resulting report on, optionally prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending.
*/
sort?: string[];
/**
* Start of the date range to report on in "YYYY-MM-DD" format, inclusive.
*/
startDate?: string;
/**
* Index of the first row of report data to return.
*/
startIndex?: number;
}
export class Resource$Adclients {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* adsensehost.adclients.get
* @desc Get information about one of the ad clients in the Host AdSense account.
* @alias adsensehost.adclients.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.adClientId Ad client to get.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Adclients$Get, options?: MethodOptions): GaxiosPromise<Schema$AdClient>;
get(params: Params$Resource$Adclients$Get, options: MethodOptions | BodyResponseCallback<Schema$AdClient>, callback: BodyResponseCallback<Schema$AdClient>): void;
get(params: Params$Resource$Adclients$Get, callback: BodyResponseCallback<Schema$AdClient>): void;
get(callback: BodyResponseCallback<Schema$AdClient>): void;
/**
* adsensehost.adclients.list
* @desc List all host ad clients in this AdSense account.
* @alias adsensehost.adclients.list
* @memberOf! ()
*
* @param {object=} params Parameters for request
* @param {integer=} params.maxResults The maximum number of ad clients to include in the response, used for paging.
* @param {string=} params.pageToken A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Adclients$List, options?: MethodOptions): GaxiosPromise<Schema$AdClients>;
list(params: Params$Resource$Adclients$List, options: MethodOptions | BodyResponseCallback<Schema$AdClients>, callback: BodyResponseCallback<Schema$AdClients>): void;
list(params: Params$Resource$Adclients$List, callback: BodyResponseCallback<Schema$AdClients>): void;
list(callback: BodyResponseCallback<Schema$AdClients>): void;
}
export interface Params$Resource$Adclients$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Ad client to get.
*/
adClientId?: string;
}
export interface Params$Resource$Adclients$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The maximum number of ad clients to include in the response, used for paging.
*/
maxResults?: number;
/**
* A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
*/
pageToken?: string;
}
export class Resource$Associationsessions {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* adsensehost.associationsessions.start
* @desc Create an association session for initiating an association with an AdSense user.
* @alias adsensehost.associationsessions.start
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.productCode Products to associate with the user.
* @param {string=} params.userLocale The preferred locale of the user.
* @param {string=} params.websiteLocale The locale of the user's hosted website.
* @param {string} params.websiteUrl The URL of the user's hosted website.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
start(params?: Params$Resource$Associationsessions$Start, options?: MethodOptions): GaxiosPromise<Schema$AssociationSession>;
start(params: Params$Resource$Associationsessions$Start, options: MethodOptions | BodyResponseCallback<Schema$AssociationSession>, callback: BodyResponseCallback<Schema$AssociationSession>): void;
start(params: Params$Resource$Associationsessions$Start, callback: BodyResponseCallback<Schema$AssociationSession>): void;
start(callback: BodyResponseCallback<Schema$AssociationSession>): void;
/**
* adsensehost.associationsessions.verify
* @desc Verify an association session after the association callback returns from AdSense signup.
* @alias adsensehost.associationsessions.verify
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.token The token returned to the association callback URL.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
verify(params?: Params$Resource$Associationsessions$Verify, options?: MethodOptions): GaxiosPromise<Schema$AssociationSession>;
verify(params: Params$Resource$Associationsessions$Verify, options: MethodOptions | BodyResponseCallback<Schema$AssociationSession>, callback: BodyResponseCallback<Schema$AssociationSession>): void;
verify(params: Params$Resource$Associationsessions$Verify, callback: BodyResponseCallback<Schema$AssociationSession>): void;
verify(callback: BodyResponseCallback<Schema$AssociationSession>): void;
}
export interface Params$Resource$Associationsessions$Start extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Products to associate with the user.
*/
productCode?: string[];
/**
* The preferred locale of the user.
*/
userLocale?: string;
/**
* The locale of the user's hosted website.
*/
websiteLocale?: string;
/**
* The URL of the user's hosted website.
*/
websiteUrl?: string;
}
export interface Params$Resource$Associationsessions$Verify extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The token returned to the association callback URL.
*/
token?: string;
}
export class Resource$Customchannels {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* adsensehost.customchannels.delete
* @desc Delete a specific custom channel from the host AdSense account.
* @alias adsensehost.customchannels.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.adClientId Ad client from which to delete the custom channel.
* @param {string} params.customChannelId Custom channel to delete.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Customchannels$Delete, options?: MethodOptions): GaxiosPromise<Schema$CustomChannel>;
delete(params: Params$Resource$Customchannels$Delete, options: MethodOptions | BodyResponseCallback<Schema$CustomChannel>, callback: BodyResponseCallback<Schema$CustomChannel>): void;
delete(params: Params$Resource$Customchannels$Delete, callback: BodyResponseCallback<Schema$CustomChannel>): void;
delete(callback: BodyResponseCallback<Schema$CustomChannel>): void;
/**
* adsensehost.customchannels.get
* @desc Get a specific custom channel from the host AdSense account.
* @alias adsensehost.customchannels.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.adClientId Ad client from which to get the custom channel.
* @param {string} params.customChannelId Custom channel to get.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Customchannels$Get, options?: MethodOptions): GaxiosPromise<Schema$CustomChannel>;
get(params: Params$Resource$Customchannels$Get, options: MethodOptions | BodyResponseCallback<Schema$CustomChannel>, callback: BodyResponseCallback<Schema$CustomChannel>): void;
get(params: Params$Resource$Customchannels$Get, callback: BodyResponseCallback<Schema$CustomChannel>): void;
get(callback: BodyResponseCallback<Schema$CustomChannel>): void;
/**
* adsensehost.customchannels.insert
* @desc Add a new custom channel to the host AdSense account.
* @alias adsensehost.customchannels.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.adClientId Ad client to which the new custom channel will be added.
* @param {().CustomChannel} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
insert(params?: Params$Resource$Customchannels$Insert, options?: MethodOptions): GaxiosPromise<Schema$CustomChannel>;
insert(params: Params$Resource$Customchannels$Insert, options: MethodOptions | BodyResponseCallback<Schema$CustomChannel>, callback: BodyResponseCallback<Schema$CustomChannel>): void;
insert(params: Params$Resource$Customchannels$Insert, callback: BodyResponseCallback<Schema$CustomChannel>): void;
insert(callback: BodyResponseCallback<Schema$CustomChannel>): void;
/**
* adsensehost.customchannels.list
* @desc List all host custom channels in this AdSense account.
* @alias adsensehost.customchannels.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.adClientId Ad client for which to list custom channels.
* @param {integer=} params.maxResults The maximum number of custom channels to include in the response, used for paging.
* @param {string=} params.pageToken A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Customchannels$List, options?: MethodOptions): GaxiosPromise<Schema$CustomChannels>;
list(params: Params$Resource$Customchannels$List, options: MethodOptions | BodyResponseCallback<Schema$CustomChannels>, callback: BodyResponseCallback<Schema$CustomChannels>): void;
list(params: Params$Resource$Customchannels$List, callback: BodyResponseCallback<Schema$CustomChannels>): void;
list(callback: BodyResponseCallback<Schema$CustomChannels>): void;
/**
* adsensehost.customchannels.patch
* @desc Update a custom channel in the host AdSense account. This method supports patch semantics.
* @alias adsensehost.customchannels.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.adClientId Ad client in which the custom channel will be updated.
* @param {string} params.customChannelId Custom channel to get.
* @param {().CustomChannel} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Customchannels$Patch, options?: MethodOptions): GaxiosPromise<Schema$CustomChannel>;
patch(params: Params$Resource$Customchannels$Patch, options: MethodOptions | BodyResponseCallback<Schema$CustomChannel>, callback: BodyResponseCallback<Schema$CustomChannel>): void;
patch(params: Params$Resource$Customchannels$Patch, callback: BodyResponseCallback<Schema$CustomChannel>): void;
patch(callback: BodyResponseCallback<Schema$CustomChannel>): void;
/**
* adsensehost.customchannels.update
* @desc Update a custom channel in the host AdSense account.
* @alias adsensehost.customchannels.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.adClientId Ad client in which the custom channel will be updated.
* @param {().CustomChannel} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update(params?: Params$Resource$Customchannels$Update, options?: MethodOptions): GaxiosPromise<Schema$CustomChannel>;
update(params: Params$Resource$Customchannels$Update, options: MethodOptions | BodyResponseCallback<Schema$CustomChannel>, callback: BodyResponseCallback<Schema$CustomChannel>): void;
update(params: Params$Resource$Customchannels$Update, callback: BodyResponseCallback<Schema$CustomChannel>): void;
update(callback: BodyResponseCallback<Schema$CustomChannel>): void;
}
export interface Params$Resource$Customchannels$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Ad client from which to delete the custom channel.
*/
adClientId?: string;
/**
* Custom channel to delete.
*/
customChannelId?: string;
}
export interface Params$Resource$Customchannels$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Ad client from which to get the custom channel.
*/
adClientId?: string;
/**
* Custom channel to get.
*/
customChannelId?: string;
}
export interface Params$Resource$Customchannels$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Ad client to which the new custom channel will be added.
*/
adClientId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CustomChannel;
}
export interface Params$Resource$Customchannels$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Ad client for which to list custom channels.
*/
adClientId?: string;
/**
* The maximum number of custom channels to include in the response, used for paging.
*/
maxResults?: number;
/**
* A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
*/
pageToken?: string;
}
export interface Params$Resource$Customchannels$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Ad client in which the custom channel will be updated.
*/
adClientId?: string;
/**
* Custom channel to get.
*/
customChannelId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CustomChannel;
}
export interface Params$Resource$Customchannels$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Ad client in which the custom channel will be updated.
*/
adClientId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CustomChannel;
}
export class Resource$Reports {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* adsensehost.reports.generate
* @desc Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter.
* @alias adsensehost.reports.generate
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.dimension Dimensions to base the report on.
* @param {string} params.endDate End of the date range to report on in "YYYY-MM-DD" format, inclusive.
* @param {string=} params.filter Filters to be run on the report.
* @param {string=} params.locale Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.
* @param {integer=} params.maxResults The maximum number of rows of report data to return.
* @param {string=} params.metric Numeric columns to include in the report.
* @param {string=} params.sort The name of a dimension or metric to sort the resulting report on, optionally prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending.
* @param {string} params.startDate Start of the date range to report on in "YYYY-MM-DD" format, inclusive.
* @param {integer=} params.startIndex Index of the first row of report data to return.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
generate(params?: Params$Resource$Reports$Generate, options?: MethodOptions): GaxiosPromise<Schema$Report>;
generate(params: Params$Resource$Reports$Generate, options: MethodOptions | BodyResponseCallback<Schema$Report>, callback: BodyResponseCallback<Schema$Report>): void;
generate(params: Params$Resource$Reports$Generate, callback: BodyResponseCallback<Schema$Report>): void;
generate(callback: BodyResponseCallback<Schema$Report>): void;
}
export interface Params$Resource$Reports$Generate extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Dimensions to base the report on.
*/
dimension?: string[];
/**
* End of the date range to report on in "YYYY-MM-DD" format, inclusive.
*/
endDate?: string;
/**
* Filters to be run on the report.
*/
filter?: string[];
/**
* Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.
*/
locale?: string;
/**
* The maximum number of rows of report data to return.
*/
maxResults?: number;
/**
* Numeric columns to include in the report.
*/
metric?: string[];
/**
* The name of a dimension or metric to sort the resulting report on, optionally prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending.
*/
sort?: string[];
/**
* Start of the date range to report on in "YYYY-MM-DD" format, inclusive.
*/
startDate?: string;
/**
* Index of the first row of report data to return.
*/
startIndex?: number;
}
export class Resource$Urlchannels {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* adsensehost.urlchannels.delete
* @desc Delete a URL channel from the host AdSense account.
* @alias adsensehost.urlchannels.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.adClientId Ad client from which to delete the URL channel.
* @param {string} params.urlChannelId URL channel to delete.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Urlchannels$Delete, options?: MethodOptions): GaxiosPromise<Schema$UrlChannel>;
delete(params: Params$Resource$Urlchannels$Delete, options: MethodOptions | BodyResponseCallback<Schema$UrlChannel>, callback: BodyResponseCallback<Schema$UrlChannel>): void;
delete(params: Params$Resource$Urlchannels$Delete, callback: BodyResponseCallback<Schema$UrlChannel>): void;
delete(callback: BodyResponseCallback<Schema$UrlChannel>): void;
/**
* adsensehost.urlchannels.insert
* @desc Add a new URL channel to the host AdSense account.
* @alias adsensehost.urlchannels.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.adClientId Ad client to which the new URL channel will be added.
* @param {().UrlChannel} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
insert(params?: Params$Resource$Urlchannels$Insert, options?: MethodOptions): GaxiosPromise<Schema$UrlChannel>;
insert(params: Params$Resource$Urlchannels$Insert, options: MethodOptions | BodyResponseCallback<Schema$UrlChannel>, callback: BodyResponseCallback<Schema$UrlChannel>): void;
insert(params: Params$Resource$Urlchannels$Insert, callback: BodyResponseCallback<Schema$UrlChannel>): void;
insert(callback: BodyResponseCallback<Schema$UrlChannel>): void;
/**
* adsensehost.urlchannels.list
* @desc List all host URL channels in the host AdSense account.
* @alias adsensehost.urlchannels.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.adClientId Ad client for which to list URL channels.
* @param {integer=} params.maxResults The maximum number of URL channels to include in the response, used for paging.
* @param {string=} params.pageToken A continuation token, used to page through URL channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Urlchannels$List, options?: MethodOptions): GaxiosPromise<Schema$UrlChannels>;
list(params: Params$Resource$Urlchannels$List, options: MethodOptions | BodyResponseCallback<Schema$UrlChannels>, callback: BodyResponseCallback<Schema$UrlChannels>): void;
list(params: Params$Resource$Urlchannels$List, callback: BodyResponseCallback<Schema$UrlChannels>): void;
list(callback: BodyResponseCallback<Schema$UrlChannels>): void;
}
export interface Params$Resource$Urlchannels$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Ad client from which to delete the URL channel.
*/
adClientId?: string;
/**
* URL channel to delete.
*/
urlChannelId?: string;
}
export interface Params$Resource$Urlchannels$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Ad client to which the new URL channel will be added.
*/
adClientId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$UrlChannel;
}
export interface Params$Resource$Urlchannels$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Ad client for which to list URL channels.
*/
adClientId?: string;
/**
* The maximum number of URL channels to include in the response, used for paging.
*/
maxResults?: number;
/**
* A continuation token, used to page through URL channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
*/
pageToken?: string;
}
export {};
}