/
v1.2.ts
839 lines (777 loc) · 27.2 KB
/
v1.2.ts
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
/**
* Copyright 2015 Google Inc. All Rights Reserved.
*
* 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 {AxiosPromise} from 'axios';
import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library';
import {BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from 'googleapis-common';
// tslint:disable: no-any
// tslint:disable: class-name
// tslint:disable: variable-name
// tslint:disable: jsdoc-format
// tslint:disable: no-namespace
export namespace adexchangebuyer_v1_2 {
export interface Options extends GlobalOptions {
version: 'v1_2';
}
/**
* 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.2');
*
* @namespace adexchangebuyer
* @type {Function}
* @version v1.2
* @variation v1.2
* @param {object=} options Options for Adexchangebuyer
*/
export class Adexchangebuyer {
_options: GlobalOptions;
google?: GoogleConfigurable;
root = this;
accounts: Resource$Accounts;
creatives: Resource$Creatives;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
this._options = options || {};
this.google = google;
this.getRoot.bind(this);
this.accounts = new Resource$Accounts(this);
this.creatives = new Resource$Creatives(this);
}
getRoot() {
return this.root;
}
}
/**
* Configuration data for an Ad Exchange buyer account.
*/
export interface Schema$Account {
/**
* Your bidder locations that have distinct URLs.
*/
bidderLocation?: any[];
/**
* 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.
*/
export interface Schema$AccountsList {
/**
* A list of accounts.
*/
items?: Schema$Account[];
/**
* Resource type.
*/
kind?: string;
}
/**
* A creative and its classification data.
*/
export 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?: any[];
/**
* 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?: any[];
/**
* The filtering reasons for the creative. Read-only. This field should not
* be set in requests.
*/
filteringReasons?: any;
/**
* 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;
/**
* 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 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.
*/
export 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;
}
export class Resource$Accounts {
root: Adexchangebuyer;
constructor(root: Adexchangebuyer) {
this.root = root;
this.getRoot.bind(this);
}
getRoot() {
return this.root;
}
/**
* 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): AxiosPromise<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;
get(paramsOrCallback?: Params$Resource$Accounts$Get|
BodyResponseCallback<Schema$Account>,
optionsOrCallback?: MethodOptions|BodyResponseCallback<Schema$Account>,
callback?: BodyResponseCallback<Schema$Account>):
void|AxiosPromise<Schema$Account> {
let params = (paramsOrCallback || {}) as Params$Resource$Accounts$Get;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Accounts$Get;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/adexchangebuyer/v1.2/accounts/{id}')
.replace(/([^:]\/)\/+/g, '$1'),
method: 'GET'
},
options),
params,
requiredParams: ['id'],
pathParams: ['id'],
context: this.getRoot()
};
if (callback) {
createAPIRequest<Schema$Account>(parameters, callback);
} else {
return createAPIRequest<Schema$Account>(parameters);
}
}
/**
* 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):
AxiosPromise<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;
list(
paramsOrCallback?: Params$Resource$Accounts$List|
BodyResponseCallback<Schema$AccountsList>,
optionsOrCallback?: MethodOptions|
BodyResponseCallback<Schema$AccountsList>,
callback?: BodyResponseCallback<Schema$AccountsList>):
void|AxiosPromise<Schema$AccountsList> {
let params = (paramsOrCallback || {}) as Params$Resource$Accounts$List;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Accounts$List;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/adexchangebuyer/v1.2/accounts')
.replace(/([^:]\/)\/+/g, '$1'),
method: 'GET'
},
options),
params,
requiredParams: [],
pathParams: [],
context: this.getRoot()
};
if (callback) {
createAPIRequest<Schema$AccountsList>(parameters, callback);
} else {
return createAPIRequest<Schema$AccountsList>(parameters);
}
}
/**
* 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):
AxiosPromise<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;
patch(
paramsOrCallback?: Params$Resource$Accounts$Patch|
BodyResponseCallback<Schema$Account>,
optionsOrCallback?: MethodOptions|BodyResponseCallback<Schema$Account>,
callback?: BodyResponseCallback<Schema$Account>):
void|AxiosPromise<Schema$Account> {
let params = (paramsOrCallback || {}) as Params$Resource$Accounts$Patch;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Accounts$Patch;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/adexchangebuyer/v1.2/accounts/{id}')
.replace(/([^:]\/)\/+/g, '$1'),
method: 'PATCH'
},
options),
params,
requiredParams: ['id'],
pathParams: ['id'],
context: this.getRoot()
};
if (callback) {
createAPIRequest<Schema$Account>(parameters, callback);
} else {
return createAPIRequest<Schema$Account>(parameters);
}
}
/**
* 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):
AxiosPromise<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;
update(
paramsOrCallback?: Params$Resource$Accounts$Update|
BodyResponseCallback<Schema$Account>,
optionsOrCallback?: MethodOptions|BodyResponseCallback<Schema$Account>,
callback?: BodyResponseCallback<Schema$Account>):
void|AxiosPromise<Schema$Account> {
let params = (paramsOrCallback || {}) as Params$Resource$Accounts$Update;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Accounts$Update;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/adexchangebuyer/v1.2/accounts/{id}')
.replace(/([^:]\/)\/+/g, '$1'),
method: 'PUT'
},
options),
params,
requiredParams: ['id'],
pathParams: ['id'],
context: this.getRoot()
};
if (callback) {
createAPIRequest<Schema$Account>(parameters, callback);
} else {
return createAPIRequest<Schema$Account>(parameters);
}
}
}
export interface Params$Resource$Accounts$Get {
/**
* Auth client or API Key for the request
*/
auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient;
/**
* The account id
*/
id?: number;
}
export interface Params$Resource$Accounts$List {
/**
* Auth client or API Key for the request
*/
auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient;
}
export interface Params$Resource$Accounts$Patch {
/**
* 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;
}
export interface Params$Resource$Accounts$Update {
/**
* 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;
}
export class Resource$Creatives {
root: Adexchangebuyer;
constructor(root: Adexchangebuyer) {
this.root = root;
this.getRoot.bind(this);
}
getRoot() {
return this.root;
}
/**
* 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): AxiosPromise<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;
get(paramsOrCallback?: Params$Resource$Creatives$Get|
BodyResponseCallback<Schema$Creative>,
optionsOrCallback?: MethodOptions|BodyResponseCallback<Schema$Creative>,
callback?: BodyResponseCallback<Schema$Creative>):
void|AxiosPromise<Schema$Creative> {
let params = (paramsOrCallback || {}) as Params$Resource$Creatives$Get;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Creatives$Get;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign(
{
url:
(rootUrl +
'/adexchangebuyer/v1.2/creatives/{accountId}/{buyerCreativeId}')
.replace(/([^:]\/)\/+/g, '$1'),
method: 'GET'
},
options),
params,
requiredParams: ['accountId', 'buyerCreativeId'],
pathParams: ['accountId', 'buyerCreativeId'],
context: this.getRoot()
};
if (callback) {
createAPIRequest<Schema$Creative>(parameters, callback);
} else {
return createAPIRequest<Schema$Creative>(parameters);
}
}
/**
* 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):
AxiosPromise<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;
insert(
paramsOrCallback?: Params$Resource$Creatives$Insert|
BodyResponseCallback<Schema$Creative>,
optionsOrCallback?: MethodOptions|BodyResponseCallback<Schema$Creative>,
callback?: BodyResponseCallback<Schema$Creative>):
void|AxiosPromise<Schema$Creative> {
let params = (paramsOrCallback || {}) as Params$Resource$Creatives$Insert;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Creatives$Insert;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/adexchangebuyer/v1.2/creatives')
.replace(/([^:]\/)\/+/g, '$1'),
method: 'POST'
},
options),
params,
requiredParams: [],
pathParams: [],
context: this.getRoot()
};
if (callback) {
createAPIRequest<Schema$Creative>(parameters, callback);
} else {
return createAPIRequest<Schema$Creative>(parameters);
}
}
/**
* 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.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):
AxiosPromise<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;
list(
paramsOrCallback?: Params$Resource$Creatives$List|
BodyResponseCallback<Schema$CreativesList>,
optionsOrCallback?: MethodOptions|
BodyResponseCallback<Schema$CreativesList>,
callback?: BodyResponseCallback<Schema$CreativesList>):
void|AxiosPromise<Schema$CreativesList> {
let params = (paramsOrCallback || {}) as Params$Resource$Creatives$List;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Creatives$List;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/adexchangebuyer/v1.2/creatives')
.replace(/([^:]\/)\/+/g, '$1'),
method: 'GET'
},
options),
params,
requiredParams: [],
pathParams: [],
context: this.getRoot()
};
if (callback) {
createAPIRequest<Schema$CreativesList>(parameters, callback);
} else {
return createAPIRequest<Schema$CreativesList>(parameters);
}
}
}
export interface Params$Resource$Creatives$Get {
/**
* 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;
}
export interface Params$Resource$Creatives$Insert {
/**
* Auth client or API Key for the request
*/
auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient;
/**
* Request body metadata
*/
requestBody?: Schema$Creative;
}
export interface Params$Resource$Creatives$List {
/**
* Auth client or API Key for the request
*/
auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient;
/**
* 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;
}
}