/
v2beta1.ts
7009 lines (6590 loc) · 267 KB
/
v2beta1.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
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
/**
* 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 adexchangebuyer2_v2beta1 {
export interface Options extends GlobalOptions {
version: 'v2beta1';
}
/**
* Ad Exchange Buyer API II
*
* Accesses the latest features for managing Ad Exchange accounts, Real-Time
* Bidding configurations and auction metrics, and Marketplace programmatic
* deals.
*
* @example
* const {google} = require('googleapis');
* const adexchangebuyer2 = google.adexchangebuyer2('v2beta1');
*
* @namespace adexchangebuyer2
* @type {Function}
* @version v2beta1
* @variation v2beta1
* @param {object=} options Options for Adexchangebuyer2
*/
export class Adexchangebuyer2 {
_options: GlobalOptions;
google?: GoogleConfigurable;
root = this;
accounts: Resource$Accounts;
bidders: Resource$Bidders;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
this._options = options || {};
this.google = google;
this.getRoot.bind(this);
this.accounts = new Resource$Accounts(this);
this.bidders = new Resource$Bidders(this);
}
getRoot() {
return this.root;
}
}
/**
* An absolute date range, specified by its start date and end date. The
* supported range of dates begins 30 days before today and ends today.
* Validity checked upon filter set creation. If a filter set with an absolute
* date range is run at a later date more than 30 days after start_date, it
* will fail.
*/
export interface Schema$AbsoluteDateRange {
/**
* The end date of the range (inclusive). Must be within the 30 days leading
* up to current date, and must be equal to or after start_date.
*/
endDate?: Schema$Date;
/**
* The start date of the range (inclusive). Must be within the 30 days
* leading up to current date, and must be equal to or before end_date.
*/
startDate?: Schema$Date;
}
/**
* A request for associating a deal and a creative.
*/
export interface Schema$AddDealAssociationRequest {
/**
* The association between a creative and a deal that should be added.
*/
association?: Schema$CreativeDealAssociation;
}
/**
* @OutputOnly The app type the restriction applies to for mobile device.
*/
export interface Schema$AppContext {
/**
* The app types this restriction applies to.
*/
appTypes?: string[];
}
/**
* @OutputOnly The auction type the restriction applies to.
*/
export interface Schema$AuctionContext {
/**
* The auction types this restriction applies to.
*/
auctionTypes?: string[];
}
/**
* The set of metrics that are measured in numbers of bids, representing how
* many bids with the specified dimension values were considered eligible at
* each stage of the bidding funnel;
*/
export interface Schema$BidMetricsRow {
/**
* The number of bids that Ad Exchange received from the buyer.
*/
bids?: Schema$MetricValue;
/**
* The number of bids that were permitted to compete in the auction.
*/
bidsInAuction?: Schema$MetricValue;
/**
* The number of bids for which the buyer was billed.
*/
billedImpressions?: Schema$MetricValue;
/**
* The number of bids that won an impression.
*/
impressionsWon?: Schema$MetricValue;
/**
* The number of bids for which the corresponding impression was measurable
* for viewability (as defined by Active View).
*/
measurableImpressions?: Schema$MetricValue;
/**
* The values of all dimensions associated with metric values in this row.
*/
rowDimensions?: Schema$RowDimensions;
/**
* The number of bids for which the corresponding impression was viewable
* (as defined by Active View).
*/
viewableImpressions?: Schema$MetricValue;
}
/**
* The number of impressions with the specified dimension values that were
* considered to have no applicable bids, as described by the specified
* status.
*/
export interface Schema$BidResponseWithoutBidsStatusRow {
/**
* The number of impressions for which there was a bid response with the
* specified status.
*/
impressionCount?: Schema$MetricValue;
/**
* The values of all dimensions associated with metric values in this row.
*/
rowDimensions?: Schema$RowDimensions;
/**
* The status specifying why the bid responses were considered to have no
* applicable bids.
*/
status?: string;
}
/**
* The number of impressions with the specified dimension values where the
* corresponding bid request or bid response was not successful, as described
* by the specified callout status.
*/
export interface Schema$CalloutStatusRow {
/**
* The ID of the callout status. See
* [callout-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/callout-status-codes).
*/
calloutStatusId?: number;
/**
* The number of impressions for which there was a bid request or bid
* response with the specified callout status.
*/
impressionCount?: Schema$MetricValue;
/**
* The values of all dimensions associated with metric values in this row.
*/
rowDimensions?: Schema$RowDimensions;
}
/**
* A client resource represents a client buyer—an agency, a brand,
* or an advertiser customer of the sponsor buyer. Users associated with the
* client buyer have restricted access to the Ad Exchange Marketplace and
* certain other sections of the Ad Exchange Buyer UI based on the role
* granted to the client buyer. All fields are required unless otherwise
* specified.
*/
export interface Schema$Client {
/**
* The globally-unique numerical ID of the client. The value of this field
* is ignored in create and update operations.
*/
clientAccountId?: string;
/**
* Name used to represent this client to publishers. You may have multiple
* clients that map to the same entity, but for each client the combination
* of `clientName` and entity must be unique. You can specify this field as
* empty.
*/
clientName?: string;
/**
* Numerical identifier of the client entity. The entity can be an
* advertiser, a brand, or an agency. This identifier is unique among all
* the entities with the same type. A list of all known advertisers with
* their identifiers is available in the
* [advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt)
* file. A list of all known brands with their identifiers is available in
* the
* [brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt)
* file. A list of all known agencies with their identifiers is available
* in the
* [agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt)
* file.
*/
entityId?: string;
/**
* The name of the entity. This field is automatically fetched based on the
* type and ID. The value of this field is ignored in create and update
* operations.
*/
entityName?: string;
/**
* The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
*/
entityType?: string;
/**
* Optional arbitrary unique identifier of this client buyer from the
* standpoint of its Ad Exchange sponsor buyer. This field can be used to
* associate a client buyer with the identifier in the namespace of its
* sponsor buyer, lookup client buyers by that identifier and verify whether
* an Ad Exchange counterpart of a given client buyer already exists. If
* present, must be unique among all the client buyers for its Ad Exchange
* sponsor buyer.
*/
partnerClientId?: string;
/**
* The role which is assigned to the client buyer. Each role implies a set
* of permissions granted to the client. Must be one of
* `CLIENT_DEAL_VIEWER`, `CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.
*/
role?: string;
/**
* The status of the client buyer.
*/
status?: string;
/**
* Whether the client buyer will be visible to sellers.
*/
visibleToSeller?: boolean;
}
/**
* A client user is created under a client buyer and has restricted access to
* the Ad Exchange Marketplace and certain other sections of the Ad Exchange
* Buyer UI based on the role granted to the associated client buyer. The
* only way a new client user can be created is via accepting an email
* invitation (see the accounts.clients.invitations.create method). All
* fields are required unless otherwise specified.
*/
export interface Schema$ClientUser {
/**
* Numerical account ID of the client buyer with which the user is
* associated; the buyer must be a client of the current sponsor buyer. The
* value of this field is ignored in an update operation.
*/
clientAccountId?: string;
/**
* User's email address. The value of this field is ignored in an update
* operation.
*/
email?: string;
/**
* The status of the client user.
*/
status?: string;
/**
* The unique numerical ID of the client user that has accepted an
* invitation. The value of this field is ignored in an update operation.
*/
userId?: string;
}
/**
* An invitation for a new client user to get access to the Ad Exchange Buyer
* UI. All fields are required unless otherwise specified.
*/
export interface Schema$ClientUserInvitation {
/**
* Numerical account ID of the client buyer that the invited user is
* associated with. The value of this field is ignored in create operations.
*/
clientAccountId?: string;
/**
* The email address to which the invitation is sent. Email addresses should
* be unique among all client users under each sponsor buyer.
*/
email?: string;
/**
* The unique numerical ID of the invitation that is sent to the user. The
* value of this field is ignored in create operations.
*/
invitationId?: string;
}
/**
* @OutputOnly Shows any corrections that were applied to this creative.
*/
export interface Schema$Correction {
/**
* The contexts for the correction.
*/
contexts?: Schema$ServingContext[];
/**
* Additional details about what was corrected.
*/
details?: string[];
/**
* The type of correction that was applied to the creative.
*/
type?: string;
}
/**
* A creative and its classification data. Next ID: 38
*/
export interface Schema$Creative {
/**
* The account that this creative belongs to. Can be used to filter the
* response of the creatives.list method.
*/
accountId?: string;
/**
* The link to AdChoices destination page.
*/
adChoicesDestinationUrl?: string;
/**
* The name of the company being advertised in the creative.
*/
advertiserName?: string;
/**
* The agency ID for this creative.
*/
agencyId?: string;
/**
* @OutputOnly The last update timestamp of the creative via API.
*/
apiUpdateTime?: string;
/**
* All attributes for the ads that may be shown from this creative. Can be
* used to filter the response of the creatives.list method.
*/
attributes?: string[];
/**
* The set of destination URLs for the creative.
*/
clickThroughUrls?: string[];
/**
* @OutputOnly Shows any corrections that were applied to this creative.
*/
corrections?: Schema$Correction[];
/**
* The buyer-defined creative ID of this creative. Can be used to filter the
* response of the creatives.list method.
*/
creativeId?: string;
/**
* @OutputOnly The top-level deals status of this creative. If disapproved,
* an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in
* serving_restrictions will also exist. Note that this may be nuanced with
* other contextual restrictions, in which case, it may be preferable to
* read from serving_restrictions directly. Can be used to filter the
* response of the creatives.list method.
*/
dealsStatus?: string;
/**
* The set of declared destination URLs for the creative.
*/
declaredClickThroughUrls?: string[];
/**
* @OutputOnly Detected advertiser IDs, if any.
*/
detectedAdvertiserIds?: string[];
/**
* @OutputOnly The detected domains for this creative.
*/
detectedDomains?: string[];
/**
* @OutputOnly The detected languages for this creative. The order is
* arbitrary. The codes are 2 or 5 characters and are documented at
* https://developers.google.com/adwords/api/docs/appendix/languagecodes.
*/
detectedLanguages?: string[];
/**
* @OutputOnly Detected product categories, if any. See the
* ad-product-categories.txt file in the technical documentation for a list
* of IDs.
*/
detectedProductCategories?: number[];
/**
* @OutputOnly Detected sensitive categories, if any. See the
* ad-sensitive-categories.txt file in the technical documentation for a
* list of IDs. You should use these IDs along with the
* excluded-sensitive-category field in the bid request to filter your bids.
*/
detectedSensitiveCategories?: number[];
/**
* @OutputOnly The filtering stats for this creative.
*/
filteringStats?: Schema$FilteringStats;
/**
* An HTML creative.
*/
html?: Schema$HtmlContent;
/**
* The set of URLs to be called to record an impression.
*/
impressionTrackingUrls?: string[];
/**
* A native creative.
*/
native?: Schema$NativeContent;
/**
* @OutputOnly The top-level open auction status of this creative. If
* disapproved, an entry for 'auctionType = OPEN_AUCTION' (or
* 'ALL') in serving_restrictions will also exist. Note that this
* may be nuanced with other contextual restrictions, in which case, it may
* be preferable to read from serving_restrictions directly. Can be used to
* filter the response of the creatives.list method.
*/
openAuctionStatus?: string;
/**
* All restricted categories for the ads that may be shown from this
* creative.
*/
restrictedCategories?: string[];
/**
* @OutputOnly The granular status of this ad in specific contexts. A
* context here relates to where something ultimately serves (for example, a
* physical location, a platform, an HTTPS vs HTTP request, or the type of
* auction).
*/
servingRestrictions?: Schema$ServingRestriction[];
/**
* All vendor IDs for the ads that may be shown from this creative. See
* https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for
* possible values.
*/
vendorIds?: number[];
/**
* @OutputOnly The version of this creative.
*/
version?: number;
/**
* A video creative.
*/
video?: Schema$VideoContent;
}
/**
* The association between a creative and a deal.
*/
export interface Schema$CreativeDealAssociation {
/**
* The account the creative belongs to.
*/
accountId?: string;
/**
* The ID of the creative associated with the deal.
*/
creativeId?: string;
/**
* The externalDealId for the deal associated with the creative.
*/
dealsId?: string;
}
/**
* The number of bids with the specified dimension values that did not win the
* auction (either were filtered pre-auction or lost the auction), as
* described by the specified creative status.
*/
export interface Schema$CreativeStatusRow {
/**
* The number of bids with the specified status.
*/
bidCount?: Schema$MetricValue;
/**
* The ID of the creative status. See
* [creative-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-status-codes).
*/
creativeStatusId?: number;
/**
* The values of all dimensions associated with metric values in this row.
*/
rowDimensions?: Schema$RowDimensions;
}
/**
* Represents a whole calendar date, for example date of birth. The time of
* day and time zone are either specified elsewhere or are not significant.
* The date is relative to the Proleptic Gregorian Calendar. The day can be 0
* to represent a year and month where the day is not significant, for example
* credit card expiration date. The year can be 0 to represent a month and day
* independent of year, for example anniversary date. Related types are
* google.type.TimeOfDay and `google.protobuf.Timestamp`.
*/
export interface Schema$Date {
/**
* Day of month. Must be from 1 to 31 and valid for the year and month, or 0
* if specifying a year/month where the day is not significant.
*/
day?: number;
/**
* Month of year. Must be from 1 to 12, or 0 if specifying a date without a
* month.
*/
month?: number;
/**
* Year of date. Must be from 1 to 9999, or 0 if specifying a date without a
* year.
*/
year?: number;
}
/**
* @OutputOnly The reason and details for a disapproval.
*/
export interface Schema$Disapproval {
/**
* Additional details about the reason for disapproval.
*/
details?: string[];
/**
* The categorized reason for disapproval.
*/
reason?: string;
}
/**
* A generic empty message that you can re-use to avoid defining duplicated
* empty messages in your APIs. A typical example is to use it as the request
* or the response type of an API method. For instance: service Foo { rpc
* Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON
* representation for `Empty` is empty JSON object `{}`.
*/
export interface Schema$Empty {}
/**
* The number of filtered bids with the specified dimension values that have
* the specified creative.
*/
export interface Schema$FilteredBidCreativeRow {
/**
* The number of bids with the specified creative.
*/
bidCount?: Schema$MetricValue;
/**
* The ID of the creative.
*/
creativeId?: string;
/**
* The values of all dimensions associated with metric values in this row.
*/
rowDimensions?: Schema$RowDimensions;
}
/**
* The number of filtered bids with the specified dimension values, among
* those filtered due to the requested filtering reason (i.e. creative
* status), that have the specified detail.
*/
export interface Schema$FilteredBidDetailRow {
/**
* The number of bids with the specified detail.
*/
bidCount?: Schema$MetricValue;
/**
* The ID of the detail. The associated value can be looked up in the
* dictionary file corresponding to the DetailType in the response message.
*/
detailId?: number;
/**
* The values of all dimensions associated with metric values in this row.
*/
rowDimensions?: Schema$RowDimensions;
}
/**
* @OutputOnly Filtering reasons for this creative during a period of a single
* day (from midnight to midnight Pacific).
*/
export interface Schema$FilteringStats {
/**
* The day during which the data was collected. The data is collected from
* 00:00:00 to 23:59:59 PT. During switches from PST to PDT and back, the
* day may contain 23 or 25 hours of data instead of the usual 24.
*/
date?: Schema$Date;
/**
* The set of filtering reasons for this date.
*/
reasons?: Schema$Reason[];
}
/**
* A set of filters that is applied to a request for data. Within a filter
* set, an AND operation is performed across the filters represented by each
* field. An OR operation is performed across the filters represented by the
* multiple values of a repeated field. E.g. "format=VIDEO AND deal_id=12
* AND (seller_network_id=34 OR seller_network_id=56)"
*/
export interface Schema$FilterSet {
/**
* An absolute date range, defined by a start date and an end date.
* Interpreted relative to Pacific time zone.
*/
absoluteDateRange?: Schema$AbsoluteDateRange;
/**
* The ID of the creative on which to filter; optional. This field may be
* set only for a filter set that accesses account-level troubleshooting
* data, i.e. one whose name matches the `bidders/x/accounts/x/filterSets/x
* pattern.
*/
creativeId?: string;
/**
* The ID of the deal on which to filter; optional. This field may be set
* only for a filter set that accesses account-level troubleshooting data,
* i.e. one whose name matches the `bidders/x/accounts/x/filterSets/x
* pattern.
*/
dealId?: string;
/**
* The environment on which to filter; optional.
*/
environment?: string;
/**
* The list of formats on which to filter; may be empty. The filters
* represented by multiple formats are ORed together (i.e. if non-empty,
* results must match any one of the formats).
*/
formats?: string[];
/**
* A user-defined name of the filter set. Filter set names must be unique
* globally and match one of the patterns: - `bidders/x/filterSets/x (for
* accessing bidder-level troubleshooting data) -
* `bidders/x/accounts/x/filterSets/x (for accessing account-level
* troubleshooting data) This field is required in create operations.
*/
name?: string;
/**
* The list of platforms on which to filter; may be empty. The filters
* represented by multiple platforms are ORed together (i.e. if non-empty,
* results must match any one of the platforms).
*/
platforms?: string[];
/**
* For Exchange Bidding buyers only. The list of publisher identifiers on
* which to filter; may be empty. The filters represented by multiple
* publisher identifiers are ORed together.
*/
publisherIdentifiers?: string[];
/**
* An open-ended realtime time range, defined by the aggregation start
* timestamp.
*/
realtimeTimeRange?: Schema$RealtimeTimeRange;
/**
* A relative date range, defined by an offset from today and a duration.
* Interpreted relative to Pacific time zone.
*/
relativeDateRange?: Schema$RelativeDateRange;
/**
* For Ad Exchange buyers only. The list of IDs of the seller (publisher)
* networks on which to filter; may be empty. The filters represented by
* multiple seller network IDs are ORed together (i.e. if non-empty, results
* must match any one of the publisher networks). See
* [seller-network-ids](https://developers.google.com/ad-exchange/rtb/downloads/seller-network-ids)
* file for the set of existing seller network IDs.
*/
sellerNetworkIds?: number[];
/**
* The granularity of time intervals if a time series breakdown is desired;
* optional.
*/
timeSeriesGranularity?: string;
}
/**
* HTML content for a creative.
*/
export interface Schema$HtmlContent {
/**
* The height of the HTML snippet in pixels.
*/
height?: number;
/**
* The HTML snippet that displays the ad when inserted in the web page.
*/
snippet?: string;
/**
* The width of the HTML snippet in pixels.
*/
width?: number;
}
/**
* An image resource. You may provide a larger image than was requested, so
* long as the aspect ratio is preserved.
*/
export interface Schema$Image {
/**
* Image height in pixels.
*/
height?: number;
/**
* The URL of the image.
*/
url?: string;
/**
* Image width in pixels.
*/
width?: number;
}
/**
* The set of metrics that are measured in numbers of impressions,
* representing how many impressions with the specified dimension values were
* considered eligible at each stage of the bidding funnel.
*/
export interface Schema$ImpressionMetricsRow {
/**
* The number of impressions available to the buyer on Ad Exchange. In some
* cases this value may be unavailable.
*/
availableImpressions?: Schema$MetricValue;
/**
* The number of impressions for which Ad Exchange sent the buyer a bid
* request.
*/
bidRequests?: Schema$MetricValue;
/**
* The number of impressions that match the buyer's inventory
* pretargeting.
*/
inventoryMatches?: Schema$MetricValue;
/**
* The number of impressions for which Ad Exchange received a response from
* the buyer that contained at least one applicable bid.
*/
responsesWithBids?: Schema$MetricValue;
/**
* The values of all dimensions associated with metric values in this row.
*/
rowDimensions?: Schema$RowDimensions;
/**
* The number of impressions for which the buyer successfully sent a
* response to Ad Exchange.
*/
successfulResponses?: Schema$MetricValue;
}
/**
* Response message for listing the metrics that are measured in number of
* bids.
*/
export interface Schema$ListBidMetricsResponse {
/**
* List of rows, each containing a set of bid metrics.
*/
bidMetricsRows?: Schema$BidMetricsRow[];
/**
* A token to retrieve the next page of results. Pass this value in the
* ListBidMetricsRequest.pageToken field in the subsequent call to the
* bidMetrics.list method to retrieve the next page of results.
*/
nextPageToken?: string;
}
/**
* Response message for listing all reasons that bid responses resulted in an
* error.
*/
export interface Schema$ListBidResponseErrorsResponse {
/**
* List of rows, with counts of bid responses aggregated by callout status.
*/
calloutStatusRows?: Schema$CalloutStatusRow[];
/**
* A token to retrieve the next page of results. Pass this value in the
* ListBidResponseErrorsRequest.pageToken field in the subsequent call to
* the bidResponseErrors.list method to retrieve the next page of results.
*/
nextPageToken?: string;
}
/**
* Response message for listing all reasons that bid responses were considered
* to have no applicable bids.
*/
export interface Schema$ListBidResponsesWithoutBidsResponse {
/**
* List of rows, with counts of bid responses without bids aggregated by
* status.
*/
bidResponseWithoutBidsStatusRows?: Schema$BidResponseWithoutBidsStatusRow[];
/**
* A token to retrieve the next page of results. Pass this value in the
* ListBidResponsesWithoutBidsRequest.pageToken field in the subsequent call
* to the bidResponsesWithoutBids.list method to retrieve the next page of
* results.
*/
nextPageToken?: string;
}
export interface Schema$ListClientsResponse {
/**
* The returned list of clients.
*/
clients?: Schema$Client[];
/**
* A token to retrieve the next page of results. Pass this value in the
* ListClientsRequest.pageToken field in the subsequent call to the
* accounts.clients.list method to retrieve the next page of results.
*/
nextPageToken?: string;
}
export interface Schema$ListClientUserInvitationsResponse {
/**
* The returned list of client users.
*/
invitations?: Schema$ClientUserInvitation[];
/**
* A token to retrieve the next page of results. Pass this value in the
* ListClientUserInvitationsRequest.pageToken field in the subsequent call
* to the clients.invitations.list method to retrieve the next page of
* results.
*/
nextPageToken?: string;
}
export interface Schema$ListClientUsersResponse {
/**
* A token to retrieve the next page of results. Pass this value in the
* ListClientUsersRequest.pageToken field in the subsequent call to the
* clients.invitations.list method to retrieve the next page of results.
*/
nextPageToken?: string;
/**
* The returned list of client users.
*/
users?: Schema$ClientUser[];
}
/**
* A response for listing creatives.
*/
export interface Schema$ListCreativesResponse {
/**
* The list of creatives.
*/
creatives?: Schema$Creative[];
/**
* A token to retrieve the next page of results. Pass this value in the
* ListCreativesRequest.page_token field in the subsequent call to
* `ListCreatives` method to retrieve the next page of results.
*/
nextPageToken?: string;
}
/**
* Response message for listing all creatives associated with a given filtered
* bid reason.
*/
export interface Schema$ListCreativeStatusBreakdownByCreativeResponse {
/**
* List of rows, with counts of bids with a given creative status aggregated
* by creative.
*/
filteredBidCreativeRows?: Schema$FilteredBidCreativeRow[];
/**
* A token to retrieve the next page of results. Pass this value in the
* ListCreativeStatusBreakdownByCreativeRequest.pageToken field in the
* subsequent call to the filteredBids.creatives.list method to retrieve the
* next page of results.
*/
nextPageToken?: string;
}
/**
* Response message for listing all details associated with a given filtered
* bid reason.
*/
export interface Schema$ListCreativeStatusBreakdownByDetailResponse {
/**
* The type of detail that the detail IDs represent.
*/
detailType?: string;
/**
* List of rows, with counts of bids with a given creative status aggregated
* by detail.
*/
filteredBidDetailRows?: Schema$FilteredBidDetailRow[];
/**
* A token to retrieve the next page of results. Pass this value in the
* ListCreativeStatusBreakdownByDetailRequest.pageToken field in the
* subsequent call to the filteredBids.details.list method to retrieve the
* next page of results.
*/
nextPageToken?: string;
}
/**
* A response for listing creative and deal associations
*/
export interface Schema$ListDealAssociationsResponse {
/**
* The list of associations.
*/
associations?: Schema$CreativeDealAssociation[];
/**
* A token to retrieve the next page of results. Pass this value in the
* ListDealAssociationsRequest.page_token field in the subsequent call to
* 'ListDealAssociation' method to retrieve the next page of
* results.
*/
nextPageToken?: string;
}
/**
* Response message for listing all reasons that bid requests were filtered
* and not sent to the buyer.
*/
export interface Schema$ListFilteredBidRequestsResponse {
/**
* List of rows, with counts of filtered bid requests aggregated by callout
* status.
*/
calloutStatusRows?: Schema$CalloutStatusRow[];
/**
* A token to retrieve the next page of results. Pass this value in the
* ListFilteredBidRequestsRequest.pageToken field in the subsequent call to
* the filteredBidRequests.list method to retrieve the next page of results.
*/
nextPageToken?: string;
}
/**
* Response message for listing all reasons that bids were filtered from the
* auction.
*/
export interface Schema$ListFilteredBidsResponse {
/**
* List of rows, with counts of filtered bids aggregated by filtering reason
* (i.e. creative status).
*/
creativeStatusRows?: Schema$CreativeStatusRow[];
/**
* A token to retrieve the next page of results. Pass this value in the
* ListFilteredBidsRequest.pageToken field in the subsequent call to the
* filteredBids.list method to retrieve the next page of results.
*/
nextPageToken?: string;
}
/**
* Response message for listing filter sets.
*/
export interface Schema$ListFilterSetsResponse {
/**
* The filter sets belonging to the buyer.
*/
filterSets?: Schema$FilterSet[];
/**
* A token to retrieve the next page of results. Pass this value in the
* ListFilterSetsRequest.pageToken field in the subsequent call to the
* accounts.filterSets.list method to retrieve the next page of results.
*/
nextPageToken?: string;
}
/**
* Response message for listing the metrics that are measured in number of
* impressions.
*/
export interface Schema$ListImpressionMetricsResponse {
/**
* List of rows, each containing a set of impression metrics.
*/
impressionMetricsRows?: Schema$ImpressionMetricsRow[];
/**
* A token to retrieve the next page of results. Pass this value in the
* ListImpressionMetricsRequest.pageToken field in the subsequent call to
* the impressionMetrics.list method to retrieve the next page of results.
*/
nextPageToken?: string;
}
/**
* Response message for listing all reasons that bids lost in the auction.
*/
export interface Schema$ListLosingBidsResponse {
/**
* List of rows, with counts of losing bids aggregated by loss reason (i.e.
* creative status).
*/
creativeStatusRows?: Schema$CreativeStatusRow[];
/**
* A token to retrieve the next page of results. Pass this value in the
* ListLosingBidsRequest.pageToken field in the subsequent call to the
* losingBids.list method to retrieve the next page of results.
*/
nextPageToken?: string;
}
/**