v1.3.d.ts
58.4 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
/**
* 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 { GaxiosPromise } from 'gaxios';
import { Compute, JWT, OAuth2Client, UserRefreshClient } from 'google-auth-library';
import { APIRequestContext, BodyResponseCallback, GlobalOptions, GoogleConfigurable, MethodOptions } from 'googleapis-common';
export declare namespace adexchangebuyer_v1_3 {
interface Options extends GlobalOptions {
version: 'v1_3';
}
interface StandardParameters {
/**
* Data format for the response.
*/
alt?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API
* access, quota, and reports. Required unless you provide an OAuth 2.0
* token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* An opaque string that represents a user for quota purposes. Must not
* exceed 40 characters.
*/
quotaUser?: string;
/**
* Deprecated. Please use quotaUser instead.
*/
userIp?: string;
}
/**
* Ad Exchange Buyer API
*
* Accesses your bidding-account information, submits creatives for
* validation, finds available direct deals, and retrieves performance
* reports.
*
* @example
* const {google} = require('googleapis');
* const adexchangebuyer = google.adexchangebuyer('v1.3');
*
* @namespace adexchangebuyer
* @type {Function}
* @version v1.3
* @variation v1.3
* @param {object=} options Options for Adexchangebuyer
*/
class Adexchangebuyer {
context: APIRequestContext;
accounts: Resource$Accounts;
billingInfo: Resource$Billinginfo;
budget: Resource$Budget;
creatives: Resource$Creatives;
directDeals: Resource$Directdeals;
performanceReport: Resource$Performancereport;
pretargetingConfig: Resource$Pretargetingconfig;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Configuration data for an Ad Exchange buyer account.
*/
interface Schema$Account {
/**
* Your bidder locations that have distinct URLs.
*/
bidderLocation?: Array<{
maximumQps?: number;
region?: string;
url?: string;
}>;
/**
* The nid parameter value used in cookie match requests. Please contact
* your technical account manager if you need to change this.
*/
cookieMatchingNid?: string;
/**
* The base URL used in cookie match requests.
*/
cookieMatchingUrl?: string;
/**
* Account id.
*/
id?: number;
/**
* Resource type.
*/
kind?: string;
/**
* The maximum number of active creatives that an account can have, where a
* creative is active if it was inserted or bid with in the last 30 days.
* Please contact your technical account manager if you need to change this.
*/
maximumActiveCreatives?: number;
/**
* The sum of all bidderLocation.maximumQps values cannot exceed this.
* Please contact your technical account manager if you need to change this.
*/
maximumTotalQps?: number;
/**
* The number of creatives that this account inserted or bid with in the
* last 30 days.
*/
numberActiveCreatives?: number;
}
/**
* An account feed lists Ad Exchange buyer accounts that the user has access
* to. Each entry in the feed corresponds to a single buyer account.
*/
interface Schema$AccountsList {
/**
* A list of accounts.
*/
items?: Schema$Account[];
/**
* Resource type.
*/
kind?: string;
}
/**
* The configuration data for an Ad Exchange billing info.
*/
interface Schema$BillingInfo {
/**
* Account id.
*/
accountId?: number;
/**
* Account name.
*/
accountName?: string;
/**
* A list of adgroup IDs associated with this particular account. These IDs
* may show up as part of a realtime bidding BidRequest, which indicates a
* bid request for this account.
*/
billingId?: string[];
/**
* Resource type.
*/
kind?: string;
}
/**
* A billing info feed lists Billing Info the Ad Exchange buyer account has
* access to. Each entry in the feed corresponds to a single billing info.
*/
interface Schema$BillingInfoList {
/**
* A list of billing info relevant for your account.
*/
items?: Schema$BillingInfo[];
/**
* Resource type.
*/
kind?: string;
}
/**
* The configuration data for Ad Exchange RTB - Budget API.
*/
interface Schema$Budget {
/**
* The id of the account. This is required for get and update requests.
*/
accountId?: string;
/**
* The billing id to determine which adgroup to provide budget information
* for. This is required for get and update requests.
*/
billingId?: string;
/**
* The daily budget amount in unit amount of the account currency to apply
* for the billingId provided. This is required for update requests.
*/
budgetAmount?: string;
/**
* The currency code for the buyer. This cannot be altered here.
*/
currencyCode?: string;
/**
* The unique id that describes this item.
*/
id?: string;
/**
* The kind of the resource, i.e. "adexchangebuyer#budget".
*/
kind?: string;
}
/**
* A creative and its classification data.
*/
interface Schema$Creative {
/**
* Account id.
*/
accountId?: number;
/**
* Detected advertiser id, if any. Read-only. This field should not be set
* in requests.
*/
advertiserId?: string[];
/**
* The name of the company being advertised in the creative.
*/
advertiserName?: string;
/**
* The agency id for this creative.
*/
agencyId?: string;
/**
* The last upload timestamp of this creative if it was uploaded via API.
* Read-only. The value of this field is generated, and will be ignored for
* uploads. (formatted RFC 3339 timestamp).
*/
apiUploadTimestamp?: string;
/**
* All attributes for the ads that may be shown from this snippet.
*/
attribute?: number[];
/**
* A buyer-specific id identifying the creative in this ad.
*/
buyerCreativeId?: string;
/**
* The set of destination urls for the snippet.
*/
clickThroughUrl?: string[];
/**
* Shows any corrections that were applied to this creative. Read-only. This
* field should not be set in requests.
*/
corrections?: Array<{
details?: string[];
reason?: string;
}>;
/**
* The reasons for disapproval, if any. Note that not all disapproval
* reasons may be categorized, so it is possible for the creative to have a
* status of DISAPPROVED with an empty list for disapproval_reasons. In this
* case, please reach out to your TAM to help debug the issue. Read-only.
* This field should not be set in requests.
*/
disapprovalReasons?: Array<{
details?: string[];
reason?: string;
}>;
/**
* The filtering reasons for the creative. Read-only. This field should not
* be set in requests.
*/
filteringReasons?: {
date?: string;
reasons?: Array<{
filteringCount?: string;
filteringStatus?: number;
}>;
};
/**
* Ad height.
*/
height?: number;
/**
* The HTML snippet that displays the ad when inserted in the web page. If
* set, videoURL should not be set.
*/
HTMLSnippet?: string;
/**
* The set of urls to be called to record an impression.
*/
impressionTrackingUrl?: string[];
/**
* Resource type.
*/
kind?: string;
/**
* If nativeAd is set, HTMLSnippet and videoURL should not be set.
*/
nativeAd?: {
advertiser?: string;
appIcon?: {
height?: number;
url?: string;
width?: number;
};
body?: string;
callToAction?: string;
clickTrackingUrl?: string;
headline?: string;
image?: {
height?: number;
url?: string;
width?: number;
};
impressionTrackingUrl?: string[];
logo?: {
height?: number;
url?: string;
width?: number;
};
price?: string;
starRating?: number;
store?: string;
};
/**
* Detected product categories, if any. Read-only. This field should not be
* set in requests.
*/
productCategories?: number[];
/**
* All restricted categories for the ads that may be shown from this
* snippet.
*/
restrictedCategories?: number[];
/**
* Detected sensitive categories, if any. Read-only. This field should not
* be set in requests.
*/
sensitiveCategories?: number[];
/**
* Creative serving status. Read-only. This field should not be set in
* requests.
*/
status?: string;
/**
* All vendor types for the ads that may be shown from this snippet.
*/
vendorType?: number[];
/**
* The version for this creative. Read-only. This field should not be set in
* requests.
*/
version?: number;
/**
* The URL to fetch a video ad. If set, HTMLSnippet and the nativeAd should
* not be set.
*/
videoURL?: string;
/**
* Ad width.
*/
width?: number;
}
/**
* The creatives feed lists the active creatives for the Ad Exchange buyer
* accounts that the user has access to. Each entry in the feed corresponds to
* a single creative.
*/
interface Schema$CreativesList {
/**
* A list of creatives.
*/
items?: Schema$Creative[];
/**
* Resource type.
*/
kind?: string;
/**
* Continuation token used to page through creatives. To retrieve the next
* page of results, set the next request's "pageToken" value
* to this.
*/
nextPageToken?: string;
}
/**
* The configuration data for an Ad Exchange direct deal.
*/
interface Schema$DirectDeal {
/**
* The account id of the buyer this deal is for.
*/
accountId?: number;
/**
* The name of the advertiser this deal is for.
*/
advertiser?: string;
/**
* Whether the publisher for this deal is eligible for alcohol ads.
*/
allowsAlcohol?: boolean;
/**
* The account id that this deal was negotiated for. It is either the buyer
* or the client that this deal was negotiated on behalf of.
*/
buyerAccountId?: string;
/**
* The currency code that applies to the fixed_cpm value. If not set then
* assumed to be USD.
*/
currencyCode?: string;
/**
* The deal type such as programmatic reservation or fixed price and so on.
*/
dealTier?: string;
/**
* End time for when this deal stops being active. If not set then this deal
* is valid until manually disabled by the publisher. In seconds since the
* epoch.
*/
endTime?: string;
/**
* The fixed price for this direct deal. In cpm micros of currency according
* to currency_code. If set, then this deal is eligible for the fixed price
* tier of buying (highest priority, pay exactly the configured fixed
* price).
*/
fixedCpm?: string;
/**
* Deal id.
*/
id?: string;
/**
* Resource type.
*/
kind?: string;
/**
* Deal name.
*/
name?: string;
/**
* The minimum price for this direct deal. In cpm micros of currency
* according to currency_code. If set, then this deal is eligible for the
* private exchange tier of buying (below fixed price priority, run as a
* second price auction).
*/
privateExchangeMinCpm?: string;
/**
* If true, the publisher has opted to have their blocks ignored when a
* creative is bid with for this deal.
*/
publisherBlocksOverriden?: boolean;
/**
* The name of the publisher offering this direct deal.
*/
sellerNetwork?: string;
/**
* Start time for when this deal becomes active. If not set then this deal
* is active immediately upon creation. In seconds since the epoch.
*/
startTime?: string;
}
/**
* A direct deals feed lists Direct Deals the Ad Exchange buyer account has
* access to. This includes direct deals set up for the buyer account as well
* as its merged stream seats.
*/
interface Schema$DirectDealsList {
/**
* A list of direct deals relevant for your account.
*/
directDeals?: Schema$DirectDeal[];
/**
* Resource type.
*/
kind?: string;
}
/**
* The configuration data for an Ad Exchange performance report list.
*/
interface Schema$PerformanceReport {
/**
* The number of bid responses with an ad.
*/
bidRate?: number;
/**
* The number of bid requests sent to your bidder.
*/
bidRequestRate?: number;
/**
* Rate of various prefiltering statuses per match. Please refer to the
* callout-status-codes.txt file for different statuses.
*/
calloutStatusRate?: any[];
/**
* Average QPS for cookie matcher operations.
*/
cookieMatcherStatusRate?: any[];
/**
* Rate of ads with a given status. Please refer to the
* creative-status-codes.txt file for different statuses.
*/
creativeStatusRate?: any[];
/**
* The number of bid responses that were filtered due to a policy violation
* or other errors.
*/
filteredBidRate?: number;
/**
* Average QPS for hosted match operations.
*/
hostedMatchStatusRate?: any[];
/**
* The number of potential queries based on your pretargeting settings.
*/
inventoryMatchRate?: number;
/**
* Resource type.
*/
kind?: string;
/**
* The 50th percentile round trip latency(ms) as perceived from Google
* servers for the duration period covered by the report.
*/
latency50thPercentile?: number;
/**
* The 85th percentile round trip latency(ms) as perceived from Google
* servers for the duration period covered by the report.
*/
latency85thPercentile?: number;
/**
* The 95th percentile round trip latency(ms) as perceived from Google
* servers for the duration period covered by the report.
*/
latency95thPercentile?: number;
/**
* Rate of various quota account statuses per quota check.
*/
noQuotaInRegion?: number;
/**
* Rate of various quota account statuses per quota check.
*/
outOfQuota?: number;
/**
* Average QPS for pixel match requests from clients.
*/
pixelMatchRequests?: number;
/**
* Average QPS for pixel match responses from clients.
*/
pixelMatchResponses?: number;
/**
* The configured quota limits for this account.
*/
quotaConfiguredLimit?: number;
/**
* The throttled quota limits for this account.
*/
quotaThrottledLimit?: number;
/**
* The trading location of this data.
*/
region?: string;
/**
* The number of properly formed bid responses received by our servers
* within the deadline.
*/
successfulRequestRate?: number;
/**
* The unix timestamp of the starting time of this performance data.
*/
timestamp?: string;
/**
* The number of bid responses that were unsuccessful due to timeouts,
* incorrect formatting, etc.
*/
unsuccessfulRequestRate?: number;
}
/**
* The configuration data for an Ad Exchange performance report list.
*/
interface Schema$PerformanceReportList {
/**
* Resource type.
*/
kind?: string;
/**
* A list of performance reports relevant for the account.
*/
performanceReport?: Schema$PerformanceReport[];
}
interface Schema$PretargetingConfig {
/**
* The id for billing purposes, provided for reference. Leave this field
* blank for insert requests; the id will be generated automatically.
*/
billingId?: string;
/**
* The config id; generated automatically. Leave this field blank for insert
* requests.
*/
configId?: string;
/**
* The name of the config. Must be unique. Required for all requests.
*/
configName?: string;
/**
* List must contain exactly one of PRETARGETING_CREATIVE_TYPE_HTML or
* PRETARGETING_CREATIVE_TYPE_VIDEO.
*/
creativeType?: string[];
/**
* Requests which allow one of these (width, height) pairs will match. All
* pairs must be supported ad dimensions.
*/
dimensions?: Array<{
height?: string;
width?: string;
}>;
/**
* Requests with any of these content labels will not match. Values are from
* content-labels.txt in the downloadable files section.
*/
excludedContentLabels?: string[];
/**
* Requests containing any of these geo criteria ids will not match.
*/
excludedGeoCriteriaIds?: string[];
/**
* Requests containing any of these placements will not match.
*/
excludedPlacements?: Array<{
token?: string;
type?: string;
}>;
/**
* Requests containing any of these users list ids will not match.
*/
excludedUserLists?: string[];
/**
* Requests containing any of these vertical ids will not match. Values are
* from the publisher-verticals.txt file in the downloadable files section.
*/
excludedVerticals?: string[];
/**
* Requests containing any of these geo criteria ids will match.
*/
geoCriteriaIds?: string[];
/**
* Whether this config is active. Required for all requests.
*/
isActive?: boolean;
/**
* The kind of the resource, i.e.
* "adexchangebuyer#pretargetingConfig".
*/
kind?: string;
/**
* Request containing any of these language codes will match.
*/
languages?: string[];
/**
* Requests containing any of these mobile carrier ids will match. Values
* are from mobile-carriers.csv in the downloadable files section.
*/
mobileCarriers?: string[];
/**
* Requests containing any of these mobile device ids will match. Values are
* from mobile-devices.csv in the downloadable files section.
*/
mobileDevices?: string[];
/**
* Requests containing any of these mobile operating system version ids will
* match. Values are from mobile-os.csv in the downloadable files section.
*/
mobileOperatingSystemVersions?: string[];
/**
* Requests containing any of these placements will match.
*/
placements?: Array<{
token?: string;
type?: string;
}>;
/**
* Requests matching any of these platforms will match. Possible values are
* PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and
* PRETARGETING_PLATFORM_TABLET.
*/
platforms?: string[];
/**
* Creative attributes should be declared here if all creatives
* corresponding to this pretargeting configuration have that creative
* attribute. Values are from pretargetable-creative-attributes.txt in the
* downloadable files section.
*/
supportedCreativeAttributes?: string[];
/**
* Requests containing any of these user list ids will match.
*/
userLists?: string[];
/**
* Requests that allow any of these vendor ids will match. Values are from
* vendors.txt in the downloadable files section.
*/
vendorTypes?: string[];
/**
* Requests containing any of these vertical ids will match.
*/
verticals?: string[];
}
interface Schema$PretargetingConfigList {
/**
* A list of pretargeting configs
*/
items?: Schema$PretargetingConfig[];
/**
* Resource type.
*/
kind?: string;
}
class Resource$Accounts {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* adexchangebuyer.accounts.get
* @desc Gets one account by ID.
* @alias adexchangebuyer.accounts.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer} params.id The account id
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$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;
/**
* adexchangebuyer.accounts.list
* @desc Retrieves the authenticated user's list of accounts.
* @alias adexchangebuyer.accounts.list
* @memberOf! ()
*
* @param {object=} params Parameters for request
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Accounts$List, options?: MethodOptions): GaxiosPromise<Schema$AccountsList>;
list(params: Params$Resource$Accounts$List, options: MethodOptions | BodyResponseCallback<Schema$AccountsList>, callback: BodyResponseCallback<Schema$AccountsList>): void;
list(params: Params$Resource$Accounts$List, callback: BodyResponseCallback<Schema$AccountsList>): void;
list(callback: BodyResponseCallback<Schema$AccountsList>): void;
/**
* adexchangebuyer.accounts.patch
* @desc Updates an existing account. This method supports patch semantics.
* @alias adexchangebuyer.accounts.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer} params.id The account id
* @param {().Account} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Accounts$Patch, options?: MethodOptions): GaxiosPromise<Schema$Account>;
patch(params: Params$Resource$Accounts$Patch, options: MethodOptions | BodyResponseCallback<Schema$Account>, callback: BodyResponseCallback<Schema$Account>): void;
patch(params: Params$Resource$Accounts$Patch, callback: BodyResponseCallback<Schema$Account>): void;
patch(callback: BodyResponseCallback<Schema$Account>): void;
/**
* adexchangebuyer.accounts.update
* @desc Updates an existing account.
* @alias adexchangebuyer.accounts.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer} params.id The account id
* @param {().Account} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update(params?: Params$Resource$Accounts$Update, options?: MethodOptions): GaxiosPromise<Schema$Account>;
update(params: Params$Resource$Accounts$Update, options: MethodOptions | BodyResponseCallback<Schema$Account>, callback: BodyResponseCallback<Schema$Account>): void;
update(params: Params$Resource$Accounts$Update, callback: BodyResponseCallback<Schema$Account>): void;
update(callback: BodyResponseCallback<Schema$Account>): void;
}
interface Params$Resource$Accounts$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The account id
*/
id?: number;
}
interface Params$Resource$Accounts$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
}
interface Params$Resource$Accounts$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The account id
*/
id?: number;
/**
* Request body metadata
*/
requestBody?: Schema$Account;
}
interface Params$Resource$Accounts$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The account id
*/
id?: number;
/**
* Request body metadata
*/
requestBody?: Schema$Account;
}
class Resource$Billinginfo {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* adexchangebuyer.billingInfo.get
* @desc Returns the billing information for one account specified by
* account ID.
* @alias adexchangebuyer.billingInfo.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer} params.accountId The account id.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Billinginfo$Get, options?: MethodOptions): GaxiosPromise<Schema$BillingInfo>;
get(params: Params$Resource$Billinginfo$Get, options: MethodOptions | BodyResponseCallback<Schema$BillingInfo>, callback: BodyResponseCallback<Schema$BillingInfo>): void;
get(params: Params$Resource$Billinginfo$Get, callback: BodyResponseCallback<Schema$BillingInfo>): void;
get(callback: BodyResponseCallback<Schema$BillingInfo>): void;
/**
* adexchangebuyer.billingInfo.list
* @desc Retrieves a list of billing information for all accounts of the
* authenticated user.
* @alias adexchangebuyer.billingInfo.list
* @memberOf! ()
*
* @param {object=} params Parameters for request
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Billinginfo$List, options?: MethodOptions): GaxiosPromise<Schema$BillingInfoList>;
list(params: Params$Resource$Billinginfo$List, options: MethodOptions | BodyResponseCallback<Schema$BillingInfoList>, callback: BodyResponseCallback<Schema$BillingInfoList>): void;
list(params: Params$Resource$Billinginfo$List, callback: BodyResponseCallback<Schema$BillingInfoList>): void;
list(callback: BodyResponseCallback<Schema$BillingInfoList>): void;
}
interface Params$Resource$Billinginfo$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The account id.
*/
accountId?: number;
}
interface Params$Resource$Billinginfo$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
}
class Resource$Budget {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* adexchangebuyer.budget.get
* @desc Returns the budget information for the adgroup specified by the
* accountId and billingId.
* @alias adexchangebuyer.budget.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountId The account id to get the budget information for.
* @param {string} params.billingId The billing id to get the budget information for.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Budget$Get, options?: MethodOptions): GaxiosPromise<Schema$Budget>;
get(params: Params$Resource$Budget$Get, options: MethodOptions | BodyResponseCallback<Schema$Budget>, callback: BodyResponseCallback<Schema$Budget>): void;
get(params: Params$Resource$Budget$Get, callback: BodyResponseCallback<Schema$Budget>): void;
get(callback: BodyResponseCallback<Schema$Budget>): void;
/**
* adexchangebuyer.budget.patch
* @desc Updates the budget amount for the budget of the adgroup specified
* by the accountId and billingId, with the budget amount in the request.
* This method supports patch semantics.
* @alias adexchangebuyer.budget.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountId The account id associated with the budget being updated.
* @param {string} params.billingId The billing id associated with the budget being updated.
* @param {().Budget} 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$Budget$Patch, options?: MethodOptions): GaxiosPromise<Schema$Budget>;
patch(params: Params$Resource$Budget$Patch, options: MethodOptions | BodyResponseCallback<Schema$Budget>, callback: BodyResponseCallback<Schema$Budget>): void;
patch(params: Params$Resource$Budget$Patch, callback: BodyResponseCallback<Schema$Budget>): void;
patch(callback: BodyResponseCallback<Schema$Budget>): void;
/**
* adexchangebuyer.budget.update
* @desc Updates the budget amount for the budget of the adgroup specified
* by the accountId and billingId, with the budget amount in the request.
* @alias adexchangebuyer.budget.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountId The account id associated with the budget being updated.
* @param {string} params.billingId The billing id associated with the budget being updated.
* @param {().Budget} 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$Budget$Update, options?: MethodOptions): GaxiosPromise<Schema$Budget>;
update(params: Params$Resource$Budget$Update, options: MethodOptions | BodyResponseCallback<Schema$Budget>, callback: BodyResponseCallback<Schema$Budget>): void;
update(params: Params$Resource$Budget$Update, callback: BodyResponseCallback<Schema$Budget>): void;
update(callback: BodyResponseCallback<Schema$Budget>): void;
}
interface Params$Resource$Budget$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The account id to get the budget information for.
*/
accountId?: string;
/**
* The billing id to get the budget information for.
*/
billingId?: string;
}
interface Params$Resource$Budget$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The account id associated with the budget being updated.
*/
accountId?: string;
/**
* The billing id associated with the budget being updated.
*/
billingId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Budget;
}
interface Params$Resource$Budget$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The account id associated with the budget being updated.
*/
accountId?: string;
/**
* The billing id associated with the budget being updated.
*/
billingId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Budget;
}
class Resource$Creatives {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* adexchangebuyer.creatives.get
* @desc Gets the status for a single creative. A creative will be available
* 30-40 minutes after submission.
* @alias adexchangebuyer.creatives.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer} params.accountId The id for the account that will serve this creative.
* @param {string} params.buyerCreativeId The buyer-specific id for this creative.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Creatives$Get, options?: MethodOptions): GaxiosPromise<Schema$Creative>;
get(params: Params$Resource$Creatives$Get, options: MethodOptions | BodyResponseCallback<Schema$Creative>, callback: BodyResponseCallback<Schema$Creative>): void;
get(params: Params$Resource$Creatives$Get, callback: BodyResponseCallback<Schema$Creative>): void;
get(callback: BodyResponseCallback<Schema$Creative>): void;
/**
* adexchangebuyer.creatives.insert
* @desc Submit a new creative.
* @alias adexchangebuyer.creatives.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {().Creative} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
insert(params?: Params$Resource$Creatives$Insert, options?: MethodOptions): GaxiosPromise<Schema$Creative>;
insert(params: Params$Resource$Creatives$Insert, options: MethodOptions | BodyResponseCallback<Schema$Creative>, callback: BodyResponseCallback<Schema$Creative>): void;
insert(params: Params$Resource$Creatives$Insert, callback: BodyResponseCallback<Schema$Creative>): void;
insert(callback: BodyResponseCallback<Schema$Creative>): void;
/**
* adexchangebuyer.creatives.list
* @desc Retrieves a list of the authenticated user's active creatives. A
* creative will be available 30-40 minutes after submission.
* @alias adexchangebuyer.creatives.list
* @memberOf! ()
*
* @param {object=} params Parameters for request
* @param {integer=} params.accountId When specified, only creatives for the given account ids are returned.
* @param {string=} params.buyerCreativeId When specified, only creatives for the given buyer creative ids are returned.
* @param {integer=} params.maxResults Maximum number of entries returned on one result page. If not set, the default is 100. Optional.
* @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. Optional.
* @param {string=} params.statusFilter When specified, only creatives having the given status are returned.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Creatives$List, options?: MethodOptions): GaxiosPromise<Schema$CreativesList>;
list(params: Params$Resource$Creatives$List, options: MethodOptions | BodyResponseCallback<Schema$CreativesList>, callback: BodyResponseCallback<Schema$CreativesList>): void;
list(params: Params$Resource$Creatives$List, callback: BodyResponseCallback<Schema$CreativesList>): void;
list(callback: BodyResponseCallback<Schema$CreativesList>): void;
}
interface Params$Resource$Creatives$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The id for the account that will serve this creative.
*/
accountId?: number;
/**
* The buyer-specific id for this creative.
*/
buyerCreativeId?: string;
}
interface Params$Resource$Creatives$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Request body metadata
*/
requestBody?: Schema$Creative;
}
interface Params$Resource$Creatives$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* When specified, only creatives for the given account ids are returned.
*/
accountId?: number[];
/**
* When specified, only creatives for the given buyer creative ids are
* returned.
*/
buyerCreativeId?: string[];
/**
* Maximum number of entries returned on one result page. If not set, the
* default is 100. Optional.
*/
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. Optional.
*/
pageToken?: string;
/**
* When specified, only creatives having the given status are returned.
*/
statusFilter?: string;
}
class Resource$Directdeals {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* adexchangebuyer.directDeals.get
* @desc Gets one direct deal by ID.
* @alias adexchangebuyer.directDeals.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.id The direct deal id
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Directdeals$Get, options?: MethodOptions): GaxiosPromise<Schema$DirectDeal>;
get(params: Params$Resource$Directdeals$Get, options: MethodOptions | BodyResponseCallback<Schema$DirectDeal>, callback: BodyResponseCallback<Schema$DirectDeal>): void;
get(params: Params$Resource$Directdeals$Get, callback: BodyResponseCallback<Schema$DirectDeal>): void;
get(callback: BodyResponseCallback<Schema$DirectDeal>): void;
/**
* adexchangebuyer.directDeals.list
* @desc Retrieves the authenticated user's list of direct deals.
* @alias adexchangebuyer.directDeals.list
* @memberOf! ()
*
* @param {object=} params Parameters for request
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Directdeals$List, options?: MethodOptions): GaxiosPromise<Schema$DirectDealsList>;
list(params: Params$Resource$Directdeals$List, options: MethodOptions | BodyResponseCallback<Schema$DirectDealsList>, callback: BodyResponseCallback<Schema$DirectDealsList>): void;
list(params: Params$Resource$Directdeals$List, callback: BodyResponseCallback<Schema$DirectDealsList>): void;
list(callback: BodyResponseCallback<Schema$DirectDealsList>): void;
}
interface Params$Resource$Directdeals$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The direct deal id
*/
id?: string;
}
interface Params$Resource$Directdeals$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
}
class Resource$Performancereport {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* adexchangebuyer.performanceReport.list
* @desc Retrieves the authenticated user's list of performance metrics.
* @alias adexchangebuyer.performanceReport.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountId The account id to get the reports.
* @param {string} params.endDateTime The end time of the report in ISO 8601 timestamp format using UTC.
* @param {integer=} params.maxResults Maximum number of entries returned on one result page. If not set, the default is 100. Optional.
* @param {string=} params.pageToken A continuation token, used to page through performance reports. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. Optional.
* @param {string} params.startDateTime The start time of the report in ISO 8601 timestamp format using UTC.
* @param {object} [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$Performancereport$List, options?: MethodOptions): GaxiosPromise<Schema$PerformanceReportList>;
list(params: Params$Resource$Performancereport$List, options: MethodOptions | BodyResponseCallback<Schema$PerformanceReportList>, callback: BodyResponseCallback<Schema$PerformanceReportList>): void;
list(params: Params$Resource$Performancereport$List, callback: BodyResponseCallback<Schema$PerformanceReportList>): void;
list(callback: BodyResponseCallback<Schema$PerformanceReportList>): void;
}
interface Params$Resource$Performancereport$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The account id to get the reports.
*/
accountId?: string;
/**
* The end time of the report in ISO 8601 timestamp format using UTC.
*/
endDateTime?: string;
/**
* Maximum number of entries returned on one result page. If not set, the
* default is 100. Optional.
*/
maxResults?: number;
/**
* A continuation token, used to page through performance reports. To
* retrieve the next page, set this parameter to the value of
* "nextPageToken" from the previous response. Optional.
*/
pageToken?: string;
/**
* The start time of the report in ISO 8601 timestamp format using UTC.
*/
startDateTime?: string;
}
class Resource$Pretargetingconfig {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* adexchangebuyer.pretargetingConfig.delete
* @desc Deletes an existing pretargeting config.
* @alias adexchangebuyer.pretargetingConfig.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountId The account id to delete the pretargeting config for.
* @param {string} params.configId The specific id of the configuration 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$Pretargetingconfig$Delete, options?: MethodOptions): GaxiosPromise<void>;
delete(params: Params$Resource$Pretargetingconfig$Delete, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
delete(params: Params$Resource$Pretargetingconfig$Delete, callback: BodyResponseCallback<void>): void;
delete(callback: BodyResponseCallback<void>): void;
/**
* adexchangebuyer.pretargetingConfig.get
* @desc Gets a specific pretargeting configuration
* @alias adexchangebuyer.pretargetingConfig.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountId The account id to get the pretargeting config for.
* @param {string} params.configId The specific id of the configuration to retrieve.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Pretargetingconfig$Get, options?: MethodOptions): GaxiosPromise<Schema$PretargetingConfig>;
get(params: Params$Resource$Pretargetingconfig$Get, options: MethodOptions | BodyResponseCallback<Schema$PretargetingConfig>, callback: BodyResponseCallback<Schema$PretargetingConfig>): void;
get(params: Params$Resource$Pretargetingconfig$Get, callback: BodyResponseCallback<Schema$PretargetingConfig>): void;
get(callback: BodyResponseCallback<Schema$PretargetingConfig>): void;
/**
* adexchangebuyer.pretargetingConfig.insert
* @desc Inserts a new pretargeting configuration.
* @alias adexchangebuyer.pretargetingConfig.insert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountId The account id to insert the pretargeting config for.
* @param {().PretargetingConfig} 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$Pretargetingconfig$Insert, options?: MethodOptions): GaxiosPromise<Schema$PretargetingConfig>;
insert(params: Params$Resource$Pretargetingconfig$Insert, options: MethodOptions | BodyResponseCallback<Schema$PretargetingConfig>, callback: BodyResponseCallback<Schema$PretargetingConfig>): void;
insert(params: Params$Resource$Pretargetingconfig$Insert, callback: BodyResponseCallback<Schema$PretargetingConfig>): void;
insert(callback: BodyResponseCallback<Schema$PretargetingConfig>): void;
/**
* adexchangebuyer.pretargetingConfig.list
* @desc Retrieves a list of the authenticated user's pretargeting
* configurations.
* @alias adexchangebuyer.pretargetingConfig.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountId The account id to get the pretargeting configs 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$Pretargetingconfig$List, options?: MethodOptions): GaxiosPromise<Schema$PretargetingConfigList>;
list(params: Params$Resource$Pretargetingconfig$List, options: MethodOptions | BodyResponseCallback<Schema$PretargetingConfigList>, callback: BodyResponseCallback<Schema$PretargetingConfigList>): void;
list(params: Params$Resource$Pretargetingconfig$List, callback: BodyResponseCallback<Schema$PretargetingConfigList>): void;
list(callback: BodyResponseCallback<Schema$PretargetingConfigList>): void;
/**
* adexchangebuyer.pretargetingConfig.patch
* @desc Updates an existing pretargeting config. This method supports patch
* semantics.
* @alias adexchangebuyer.pretargetingConfig.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountId The account id to update the pretargeting config for.
* @param {string} params.configId The specific id of the configuration to update.
* @param {().PretargetingConfig} 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$Pretargetingconfig$Patch, options?: MethodOptions): GaxiosPromise<Schema$PretargetingConfig>;
patch(params: Params$Resource$Pretargetingconfig$Patch, options: MethodOptions | BodyResponseCallback<Schema$PretargetingConfig>, callback: BodyResponseCallback<Schema$PretargetingConfig>): void;
patch(params: Params$Resource$Pretargetingconfig$Patch, callback: BodyResponseCallback<Schema$PretargetingConfig>): void;
patch(callback: BodyResponseCallback<Schema$PretargetingConfig>): void;
/**
* adexchangebuyer.pretargetingConfig.update
* @desc Updates an existing pretargeting config.
* @alias adexchangebuyer.pretargetingConfig.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.accountId The account id to update the pretargeting config for.
* @param {string} params.configId The specific id of the configuration to update.
* @param {().PretargetingConfig} 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$Pretargetingconfig$Update, options?: MethodOptions): GaxiosPromise<Schema$PretargetingConfig>;
update(params: Params$Resource$Pretargetingconfig$Update, options: MethodOptions | BodyResponseCallback<Schema$PretargetingConfig>, callback: BodyResponseCallback<Schema$PretargetingConfig>): void;
update(params: Params$Resource$Pretargetingconfig$Update, callback: BodyResponseCallback<Schema$PretargetingConfig>): void;
update(callback: BodyResponseCallback<Schema$PretargetingConfig>): void;
}
interface Params$Resource$Pretargetingconfig$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The account id to delete the pretargeting config for.
*/
accountId?: string;
/**
* The specific id of the configuration to delete.
*/
configId?: string;
}
interface Params$Resource$Pretargetingconfig$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The account id to get the pretargeting config for.
*/
accountId?: string;
/**
* The specific id of the configuration to retrieve.
*/
configId?: string;
}
interface Params$Resource$Pretargetingconfig$Insert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The account id to insert the pretargeting config for.
*/
accountId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$PretargetingConfig;
}
interface Params$Resource$Pretargetingconfig$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The account id to get the pretargeting configs for.
*/
accountId?: string;
}
interface Params$Resource$Pretargetingconfig$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The account id to update the pretargeting config for.
*/
accountId?: string;
/**
* The specific id of the configuration to update.
*/
configId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$PretargetingConfig;
}
interface Params$Resource$Pretargetingconfig$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The account id to update the pretargeting config for.
*/
accountId?: string;
/**
* The specific id of the configuration to update.
*/
configId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$PretargetingConfig;
}
}