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
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adexchangebuyer_v1_4.html">Ad Exchange Buyer API</a> . <a href="adexchangebuyer_v1_4.products.html">products</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#get">get(productId)</a></code></p>
<p class="firstline">Gets the requested product by id.</p>
<p class="toc_element">
<code><a href="#search">search(pqlQuery=None)</a></code></p>
<p class="firstline">Gets the requested product.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="get">get(productId)</code>
<pre>Gets the requested product by id.
Args:
productId: string, The id for the product to get the head revision for. (required)
Returns:
An object of the form:
{ # A product is segment of inventory that a seller wishes to sell. It is associated with certain terms and targeting information which helps buyer know more about the inventory. Each field in a product can have one of the following setting:
#
# (readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller.
"billedBuyer": { # The billed buyer corresponding to the buyer that created the offer. (readonly, except on create)
"accountId": "A String", # Adx account id of the buyer.
},
"buyer": { # The buyer that created the offer if this is a buyer initiated offer (readonly, except on create)
"accountId": "A String", # Adx account id of the buyer.
},
"creationTimeMs": "A String", # Creation time in ms. since epoch (readonly)
"creatorContacts": [ # Optional contact information for the creator of this product. (buyer-readonly)
{
"email": "A String", # Email address of the contact.
"name": "A String", # The name of the contact.
},
],
"creatorRole": "A String", # The role that created the offer. Set to BUYER for buyer initiated offers.
"deliveryControl": { # The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. This message is assigned an id of 100 since some day we would want to model this as a protobuf extension.
"creativeBlockingLevel": "A String",
"deliveryRateType": "A String",
"frequencyCaps": [
{
"maxImpressions": 42,
"numTimeUnits": 42,
"timeUnitType": "A String",
},
],
},
"flightEndTimeMs": "A String", # The proposed end time for the deal (ms since epoch) (buyer-readonly)
"flightStartTimeMs": "A String", # Inventory availability dates. (times are in ms since epoch) The granularity is generally in the order of seconds. (buyer-readonly)
"hasCreatorSignedOff": True or False, # If the creator has already signed off on the product, then the buyer can finalize the deal by accepting the product as is. When copying to a proposal, if any of the terms are changed, then auto_finalize is automatically set to false.
"inventorySource": "A String", # What exchange will provide this inventory (readonly, except on create).
"kind": "adexchangebuyer#product", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#product".
"labels": [ # Optional List of labels for the product (optional, buyer-readonly).
{
"accountId": "A String", # The accountId of the party that created the label.
"createTimeMs": "A String", # The creation time (in ms since epoch) for the label.
"deprecatedMarketplaceDealParty": { # Information about the party that created the label.
"buyer": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal-party.
"accountId": "A String", # Adx account id of the buyer.
},
"seller": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal party.
"accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product.
"subAccountId": "A String", # Optional sub-account id for the seller.
},
},
"label": "A String", # The label to use.
},
],
"lastUpdateTimeMs": "A String", # Time of last update in ms. since epoch (readonly)
"legacyOfferId": "A String", # Optional legacy offer id if this offer is a preferred deal offer.
"marketplacePublisherProfileId": "A String", # Marketplace publisher profile Id. This Id differs from the regular publisher_profile_id in that 1. This is a new id, the old Id will be deprecated in 2017. 2. This id uniquely identifies a publisher profile by itself.
"name": "A String", # The name for this product as set by the seller. (buyer-readonly)
"privateAuctionId": "A String", # Optional private auction id if this offer is a private auction offer.
"productId": "A String", # The unique id for the product (readonly)
"publisherProfileId": "A String", # Id of the publisher profile for a given seller. A (seller.account_id, publisher_profile_id) pair uniquely identifies a publisher profile. Buyers can call the PublisherProfiles::List endpoint to get a list of publisher profiles for a given seller.
"publisherProvidedForecast": { # This message carries publisher provided forecasting information. # Publisher self-provided forecast information.
"dimensions": [ # Publisher provided dimensions. E.g. geo, sizes etc...
{ # This message carries publisher provided breakdown. E.g. {dimension_type: 'COUNTRY', [{dimension_value: {id: 1, name: 'US'}}, {dimension_value: {id: 2, name: 'UK'}}]}
"dimensionType": "A String",
"dimensionValues": [
{ # Value of the dimension.
"id": 42, # Id of the dimension.
"name": "A String", # Name of the dimension mainly for debugging purposes, except for the case of CREATIVE_SIZE. For CREATIVE_SIZE, strings are used instead of ids.
"percentage": 42, # Percent of total impressions for a dimension type. e.g. {dimension_type: 'GENDER', [{dimension_value: {id: 1, name: 'MALE', percentage: 60}}]} Gender MALE is 60% of all impressions which have gender.
},
],
},
],
"weeklyImpressions": "A String", # Publisher provided weekly impressions.
"weeklyUniques": "A String", # Publisher provided weekly uniques.
},
"revisionNumber": "A String", # The revision number of the product. (readonly)
"seller": { # Information about the seller that created this product (readonly, except on create)
"accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product.
"subAccountId": "A String", # Optional sub-account id for the seller.
},
"sharedTargetings": [ # Targeting that is shared between the buyer and the seller. Each targeting criteria has a specified key and for each key there is a list of inclusion value or exclusion values. (buyer-readonly)
{
"exclusions": [ # The list of values to exclude from targeting. Each value is AND'd together.
{
"creativeSizeValue": { # Next Id: 7 # The creative size value to exclude/include.
"allowedFormats": [ # The formats allowed by the publisher.
"A String",
],
"companionSizes": [ # For video size type, the list of companion sizes.
{
"height": 42, # The height of the creative.
"width": 42, # The width of the creative.
},
],
"creativeSizeType": "A String", # The Creative size type.
"nativeTemplate": "A String", # The native template for native ad.
"size": { # For regular or video creative size type, specifies the size of the creative.
"height": 42, # The height of the creative.
"width": 42, # The width of the creative.
},
"skippableAdType": "A String", # The skippable ad type for video size.
},
"dayPartTargetingValue": { # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING.
"dayParts": [
{
"dayOfWeek": "A String",
"endHour": 42,
"endMinute": 42,
"startHour": 42,
"startMinute": 42,
},
],
"timeZoneType": "A String",
},
"demogAgeCriteriaValue": {
"demogAgeCriteriaIds": [
"A String",
],
},
"demogGenderCriteriaValue": {
"demogGenderCriteriaIds": [
"A String",
],
},
"longValue": "A String", # The long value to exclude/include.
"requestPlatformTargetingValue": {
"requestPlatforms": [
"A String",
],
},
"stringValue": "A String", # The string value to exclude/include.
},
],
"inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd together.
{
"creativeSizeValue": { # Next Id: 7 # The creative size value to exclude/include.
"allowedFormats": [ # The formats allowed by the publisher.
"A String",
],
"companionSizes": [ # For video size type, the list of companion sizes.
{
"height": 42, # The height of the creative.
"width": 42, # The width of the creative.
},
],
"creativeSizeType": "A String", # The Creative size type.
"nativeTemplate": "A String", # The native template for native ad.
"size": { # For regular or video creative size type, specifies the size of the creative.
"height": 42, # The height of the creative.
"width": 42, # The width of the creative.
},
"skippableAdType": "A String", # The skippable ad type for video size.
},
"dayPartTargetingValue": { # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING.
"dayParts": [
{
"dayOfWeek": "A String",
"endHour": 42,
"endMinute": 42,
"startHour": 42,
"startMinute": 42,
},
],
"timeZoneType": "A String",
},
"demogAgeCriteriaValue": {
"demogAgeCriteriaIds": [
"A String",
],
},
"demogGenderCriteriaValue": {
"demogGenderCriteriaIds": [
"A String",
],
},
"longValue": "A String", # The long value to exclude/include.
"requestPlatformTargetingValue": {
"requestPlatforms": [
"A String",
],
},
"stringValue": "A String", # The string value to exclude/include.
},
],
"key": "A String", # The key representing the shared targeting criterion.
},
],
"state": "A String", # The state of the product. (buyer-readonly)
"syndicationProduct": "A String", # The syndication product associated with the deal. (readonly, except on create)
"terms": { # The negotiable terms of the deal (buyer-readonly)
"brandingType": "A String", # Visibility of the URL in bid requests.
"crossListedExternalDealIdType": "A String", # Indicates that this ExternalDealId exists under at least two different AdxInventoryDeals. Currently, the only case that the same ExternalDealId will exist is programmatic cross sell case.
"description": "A String", # Description for the proposed terms of the deal.
"estimatedGrossSpend": { # Non-binding estimate of the estimated gross spend for this deal Can be set by buyer or seller.
"amountMicros": 3.14, # The price value in micros.
"currencyCode": "A String", # The currency code for the price.
"expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
"pricingType": "A String", # The pricing type for the deal/product.
},
"estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day Can be set by buyer or seller.
"guaranteedFixedPriceTerms": { # The terms for guaranteed fixed price deals.
"billingInfo": { # External billing info for this Deal. This field is relevant when external billing info such as price has a different currency code than DFP/AdX.
"currencyConversionTimeMs": "A String", # The timestamp (in ms since epoch) when the original reservation price for the deal was first converted to DFP currency. This is used to convert the contracted price into buyer's currency without discrepancy.
"dfpLineItemId": "A String", # The DFP line item id associated with this deal. For features like CPD, buyers can retrieve the DFP line item for billing reconciliation.
"originalContractedQuantity": "A String", # The original contracted quantity (# impressions) for this deal. To ensure delivery, sometimes the publisher will book the deal with a impression buffer, such that guaranteed_looks is greater than the contracted quantity. However clients are billed using the original contracted quantity.
"price": { # The original reservation price for the deal, if the currency code is different from the one used in negotiation.
"amountMicros": 3.14, # The price value in micros.
"currencyCode": "A String", # The currency code for the price.
"expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
"pricingType": "A String", # The pricing type for the deal/product.
},
},
"fixedPrices": [ # Fixed price for the specified buyer.
{ # Used to specify pricing rules for buyers. Each PricePerBuyer in a product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer we look for the most specific matching rule - we first look for a rule matching the buyer and otherwise look for a matching rule where no buyer is set.
"auctionTier": "A String", # Optional access type for this buyer.
"billedBuyer": { # Reference to the buyer that will get billed.
"accountId": "A String", # Adx account id of the buyer.
},
"buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
"accountId": "A String", # Adx account id of the buyer.
},
"price": { # The specified price
"amountMicros": 3.14, # The price value in micros.
"currencyCode": "A String", # The currency code for the price.
"expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
"pricingType": "A String", # The pricing type for the deal/product.
},
},
],
"guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy.
"guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product. For CPD deals, buyer changes to guaranteed_looks will be ignored.
"minimumDailyLooks": "A String", # Count of minimum daily looks for a CPD deal. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
},
"nonGuaranteedAuctionTerms": { # The terms for non-guaranteed auction deals.
"autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers in this private auction (buyer-readonly).
"reservePricePerBuyers": [ # Reserve price for the specified buyer.
{ # Used to specify pricing rules for buyers. Each PricePerBuyer in a product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer we look for the most specific matching rule - we first look for a rule matching the buyer and otherwise look for a matching rule where no buyer is set.
"auctionTier": "A String", # Optional access type for this buyer.
"billedBuyer": { # Reference to the buyer that will get billed.
"accountId": "A String", # Adx account id of the buyer.
},
"buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
"accountId": "A String", # Adx account id of the buyer.
},
"price": { # The specified price
"amountMicros": 3.14, # The price value in micros.
"currencyCode": "A String", # The currency code for the price.
"expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
"pricingType": "A String", # The pricing type for the deal/product.
},
},
],
},
"nonGuaranteedFixedPriceTerms": { # The terms for non-guaranteed fixed price deals.
"fixedPrices": [ # Fixed price for the specified buyer.
{ # Used to specify pricing rules for buyers. Each PricePerBuyer in a product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer we look for the most specific matching rule - we first look for a rule matching the buyer and otherwise look for a matching rule where no buyer is set.
"auctionTier": "A String", # Optional access type for this buyer.
"billedBuyer": { # Reference to the buyer that will get billed.
"accountId": "A String", # Adx account id of the buyer.
},
"buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
"accountId": "A String", # Adx account id of the buyer.
},
"price": { # The specified price
"amountMicros": 3.14, # The price value in micros.
"currencyCode": "A String", # The currency code for the price.
"expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
"pricingType": "A String", # The pricing type for the deal/product.
},
},
],
},
"rubiconNonGuaranteedTerms": { # The terms for rubicon non-guaranteed deals.
"priorityPrice": { # Optional price for Rubicon priority access in the auction.
"amountMicros": 3.14, # The price value in micros.
"currencyCode": "A String", # The currency code for the price.
"expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
"pricingType": "A String", # The pricing type for the deal/product.
},
"standardPrice": { # Optional price for Rubicon standard access in the auction.
"amountMicros": 3.14, # The price value in micros.
"currencyCode": "A String", # The currency code for the price.
"expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
"pricingType": "A String", # The pricing type for the deal/product.
},
},
"sellerTimeZone": "A String", # For deals with Cost Per Day billing, defines the timezone used to mark the boundaries of a day (buyer-readonly)
},
"webPropertyCode": "A String", # The web property code for the seller. This field is meant to be copied over as is when creating deals.
}</pre>
</div>
<div class="method">
<code class="details" id="search">search(pqlQuery=None)</code>
<pre>Gets the requested product.
Args:
pqlQuery: string, The pql query used to query for products.
Returns:
An object of the form:
{
"products": [ # The returned list of products.
{ # A product is segment of inventory that a seller wishes to sell. It is associated with certain terms and targeting information which helps buyer know more about the inventory. Each field in a product can have one of the following setting:
#
# (readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller.
"billedBuyer": { # The billed buyer corresponding to the buyer that created the offer. (readonly, except on create)
"accountId": "A String", # Adx account id of the buyer.
},
"buyer": { # The buyer that created the offer if this is a buyer initiated offer (readonly, except on create)
"accountId": "A String", # Adx account id of the buyer.
},
"creationTimeMs": "A String", # Creation time in ms. since epoch (readonly)
"creatorContacts": [ # Optional contact information for the creator of this product. (buyer-readonly)
{
"email": "A String", # Email address of the contact.
"name": "A String", # The name of the contact.
},
],
"creatorRole": "A String", # The role that created the offer. Set to BUYER for buyer initiated offers.
"deliveryControl": { # The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. This message is assigned an id of 100 since some day we would want to model this as a protobuf extension.
"creativeBlockingLevel": "A String",
"deliveryRateType": "A String",
"frequencyCaps": [
{
"maxImpressions": 42,
"numTimeUnits": 42,
"timeUnitType": "A String",
},
],
},
"flightEndTimeMs": "A String", # The proposed end time for the deal (ms since epoch) (buyer-readonly)
"flightStartTimeMs": "A String", # Inventory availability dates. (times are in ms since epoch) The granularity is generally in the order of seconds. (buyer-readonly)
"hasCreatorSignedOff": True or False, # If the creator has already signed off on the product, then the buyer can finalize the deal by accepting the product as is. When copying to a proposal, if any of the terms are changed, then auto_finalize is automatically set to false.
"inventorySource": "A String", # What exchange will provide this inventory (readonly, except on create).
"kind": "adexchangebuyer#product", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#product".
"labels": [ # Optional List of labels for the product (optional, buyer-readonly).
{
"accountId": "A String", # The accountId of the party that created the label.
"createTimeMs": "A String", # The creation time (in ms since epoch) for the label.
"deprecatedMarketplaceDealParty": { # Information about the party that created the label.
"buyer": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal-party.
"accountId": "A String", # Adx account id of the buyer.
},
"seller": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal party.
"accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product.
"subAccountId": "A String", # Optional sub-account id for the seller.
},
},
"label": "A String", # The label to use.
},
],
"lastUpdateTimeMs": "A String", # Time of last update in ms. since epoch (readonly)
"legacyOfferId": "A String", # Optional legacy offer id if this offer is a preferred deal offer.
"marketplacePublisherProfileId": "A String", # Marketplace publisher profile Id. This Id differs from the regular publisher_profile_id in that 1. This is a new id, the old Id will be deprecated in 2017. 2. This id uniquely identifies a publisher profile by itself.
"name": "A String", # The name for this product as set by the seller. (buyer-readonly)
"privateAuctionId": "A String", # Optional private auction id if this offer is a private auction offer.
"productId": "A String", # The unique id for the product (readonly)
"publisherProfileId": "A String", # Id of the publisher profile for a given seller. A (seller.account_id, publisher_profile_id) pair uniquely identifies a publisher profile. Buyers can call the PublisherProfiles::List endpoint to get a list of publisher profiles for a given seller.
"publisherProvidedForecast": { # This message carries publisher provided forecasting information. # Publisher self-provided forecast information.
"dimensions": [ # Publisher provided dimensions. E.g. geo, sizes etc...
{ # This message carries publisher provided breakdown. E.g. {dimension_type: 'COUNTRY', [{dimension_value: {id: 1, name: 'US'}}, {dimension_value: {id: 2, name: 'UK'}}]}
"dimensionType": "A String",
"dimensionValues": [
{ # Value of the dimension.
"id": 42, # Id of the dimension.
"name": "A String", # Name of the dimension mainly for debugging purposes, except for the case of CREATIVE_SIZE. For CREATIVE_SIZE, strings are used instead of ids.
"percentage": 42, # Percent of total impressions for a dimension type. e.g. {dimension_type: 'GENDER', [{dimension_value: {id: 1, name: 'MALE', percentage: 60}}]} Gender MALE is 60% of all impressions which have gender.
},
],
},
],
"weeklyImpressions": "A String", # Publisher provided weekly impressions.
"weeklyUniques": "A String", # Publisher provided weekly uniques.
},
"revisionNumber": "A String", # The revision number of the product. (readonly)
"seller": { # Information about the seller that created this product (readonly, except on create)
"accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product.
"subAccountId": "A String", # Optional sub-account id for the seller.
},
"sharedTargetings": [ # Targeting that is shared between the buyer and the seller. Each targeting criteria has a specified key and for each key there is a list of inclusion value or exclusion values. (buyer-readonly)
{
"exclusions": [ # The list of values to exclude from targeting. Each value is AND'd together.
{
"creativeSizeValue": { # Next Id: 7 # The creative size value to exclude/include.
"allowedFormats": [ # The formats allowed by the publisher.
"A String",
],
"companionSizes": [ # For video size type, the list of companion sizes.
{
"height": 42, # The height of the creative.
"width": 42, # The width of the creative.
},
],
"creativeSizeType": "A String", # The Creative size type.
"nativeTemplate": "A String", # The native template for native ad.
"size": { # For regular or video creative size type, specifies the size of the creative.
"height": 42, # The height of the creative.
"width": 42, # The width of the creative.
},
"skippableAdType": "A String", # The skippable ad type for video size.
},
"dayPartTargetingValue": { # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING.
"dayParts": [
{
"dayOfWeek": "A String",
"endHour": 42,
"endMinute": 42,
"startHour": 42,
"startMinute": 42,
},
],
"timeZoneType": "A String",
},
"demogAgeCriteriaValue": {
"demogAgeCriteriaIds": [
"A String",
],
},
"demogGenderCriteriaValue": {
"demogGenderCriteriaIds": [
"A String",
],
},
"longValue": "A String", # The long value to exclude/include.
"requestPlatformTargetingValue": {
"requestPlatforms": [
"A String",
],
},
"stringValue": "A String", # The string value to exclude/include.
},
],
"inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd together.
{
"creativeSizeValue": { # Next Id: 7 # The creative size value to exclude/include.
"allowedFormats": [ # The formats allowed by the publisher.
"A String",
],
"companionSizes": [ # For video size type, the list of companion sizes.
{
"height": 42, # The height of the creative.
"width": 42, # The width of the creative.
},
],
"creativeSizeType": "A String", # The Creative size type.
"nativeTemplate": "A String", # The native template for native ad.
"size": { # For regular or video creative size type, specifies the size of the creative.
"height": 42, # The height of the creative.
"width": 42, # The width of the creative.
},
"skippableAdType": "A String", # The skippable ad type for video size.
},
"dayPartTargetingValue": { # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING.
"dayParts": [
{
"dayOfWeek": "A String",
"endHour": 42,
"endMinute": 42,
"startHour": 42,
"startMinute": 42,
},
],
"timeZoneType": "A String",
},
"demogAgeCriteriaValue": {
"demogAgeCriteriaIds": [
"A String",
],
},
"demogGenderCriteriaValue": {
"demogGenderCriteriaIds": [
"A String",
],
},
"longValue": "A String", # The long value to exclude/include.
"requestPlatformTargetingValue": {
"requestPlatforms": [
"A String",
],
},
"stringValue": "A String", # The string value to exclude/include.
},
],
"key": "A String", # The key representing the shared targeting criterion.
},
],
"state": "A String", # The state of the product. (buyer-readonly)
"syndicationProduct": "A String", # The syndication product associated with the deal. (readonly, except on create)
"terms": { # The negotiable terms of the deal (buyer-readonly)
"brandingType": "A String", # Visibility of the URL in bid requests.
"crossListedExternalDealIdType": "A String", # Indicates that this ExternalDealId exists under at least two different AdxInventoryDeals. Currently, the only case that the same ExternalDealId will exist is programmatic cross sell case.
"description": "A String", # Description for the proposed terms of the deal.
"estimatedGrossSpend": { # Non-binding estimate of the estimated gross spend for this deal Can be set by buyer or seller.
"amountMicros": 3.14, # The price value in micros.
"currencyCode": "A String", # The currency code for the price.
"expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
"pricingType": "A String", # The pricing type for the deal/product.
},
"estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day Can be set by buyer or seller.
"guaranteedFixedPriceTerms": { # The terms for guaranteed fixed price deals.
"billingInfo": { # External billing info for this Deal. This field is relevant when external billing info such as price has a different currency code than DFP/AdX.
"currencyConversionTimeMs": "A String", # The timestamp (in ms since epoch) when the original reservation price for the deal was first converted to DFP currency. This is used to convert the contracted price into buyer's currency without discrepancy.
"dfpLineItemId": "A String", # The DFP line item id associated with this deal. For features like CPD, buyers can retrieve the DFP line item for billing reconciliation.
"originalContractedQuantity": "A String", # The original contracted quantity (# impressions) for this deal. To ensure delivery, sometimes the publisher will book the deal with a impression buffer, such that guaranteed_looks is greater than the contracted quantity. However clients are billed using the original contracted quantity.
"price": { # The original reservation price for the deal, if the currency code is different from the one used in negotiation.
"amountMicros": 3.14, # The price value in micros.
"currencyCode": "A String", # The currency code for the price.
"expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
"pricingType": "A String", # The pricing type for the deal/product.
},
},
"fixedPrices": [ # Fixed price for the specified buyer.
{ # Used to specify pricing rules for buyers. Each PricePerBuyer in a product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer we look for the most specific matching rule - we first look for a rule matching the buyer and otherwise look for a matching rule where no buyer is set.
"auctionTier": "A String", # Optional access type for this buyer.
"billedBuyer": { # Reference to the buyer that will get billed.
"accountId": "A String", # Adx account id of the buyer.
},
"buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
"accountId": "A String", # Adx account id of the buyer.
},
"price": { # The specified price
"amountMicros": 3.14, # The price value in micros.
"currencyCode": "A String", # The currency code for the price.
"expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
"pricingType": "A String", # The pricing type for the deal/product.
},
},
],
"guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy.
"guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product. For CPD deals, buyer changes to guaranteed_looks will be ignored.
"minimumDailyLooks": "A String", # Count of minimum daily looks for a CPD deal. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
},
"nonGuaranteedAuctionTerms": { # The terms for non-guaranteed auction deals.
"autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers in this private auction (buyer-readonly).
"reservePricePerBuyers": [ # Reserve price for the specified buyer.
{ # Used to specify pricing rules for buyers. Each PricePerBuyer in a product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer we look for the most specific matching rule - we first look for a rule matching the buyer and otherwise look for a matching rule where no buyer is set.
"auctionTier": "A String", # Optional access type for this buyer.
"billedBuyer": { # Reference to the buyer that will get billed.
"accountId": "A String", # Adx account id of the buyer.
},
"buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
"accountId": "A String", # Adx account id of the buyer.
},
"price": { # The specified price
"amountMicros": 3.14, # The price value in micros.
"currencyCode": "A String", # The currency code for the price.
"expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
"pricingType": "A String", # The pricing type for the deal/product.
},
},
],
},
"nonGuaranteedFixedPriceTerms": { # The terms for non-guaranteed fixed price deals.
"fixedPrices": [ # Fixed price for the specified buyer.
{ # Used to specify pricing rules for buyers. Each PricePerBuyer in a product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer we look for the most specific matching rule - we first look for a rule matching the buyer and otherwise look for a matching rule where no buyer is set.
"auctionTier": "A String", # Optional access type for this buyer.
"billedBuyer": { # Reference to the buyer that will get billed.
"accountId": "A String", # Adx account id of the buyer.
},
"buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
"accountId": "A String", # Adx account id of the buyer.
},
"price": { # The specified price
"amountMicros": 3.14, # The price value in micros.
"currencyCode": "A String", # The currency code for the price.
"expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
"pricingType": "A String", # The pricing type for the deal/product.
},
},
],
},
"rubiconNonGuaranteedTerms": { # The terms for rubicon non-guaranteed deals.
"priorityPrice": { # Optional price for Rubicon priority access in the auction.
"amountMicros": 3.14, # The price value in micros.
"currencyCode": "A String", # The currency code for the price.
"expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
"pricingType": "A String", # The pricing type for the deal/product.
},
"standardPrice": { # Optional price for Rubicon standard access in the auction.
"amountMicros": 3.14, # The price value in micros.
"currencyCode": "A String", # The currency code for the price.
"expectedCpmMicros": 3.14, # In case of CPD deals, the expected CPM in micros.
"pricingType": "A String", # The pricing type for the deal/product.
},
},
"sellerTimeZone": "A String", # For deals with Cost Per Day billing, defines the timezone used to mark the boundaries of a day (buyer-readonly)
},
"webPropertyCode": "A String", # The web property code for the seller. This field is meant to be copied over as is when creating deals.
},
],
}</pre>
</div>
</body></html>
|
