v1.2.d.ts
19.8 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
/**
* 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_2 {
interface Options extends GlobalOptions {
version: 'v1_2';
}
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.2');
*
* @namespace adexchangebuyer
* @type {Function}
* @version v1.2
* @variation v1.2
* @param {object=} options Options for Adexchangebuyer
*/
class Adexchangebuyer {
context: APIRequestContext;
accounts: Resource$Accounts;
creatives: Resource$Creatives;
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;
}
/**
* 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;
/**
* 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.
*/
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;
}
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$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.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;
/**
* 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;
}
}