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
|
<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="displayvideo_v4.html">Display & Video 360 API</a> . <a href="displayvideo_v4.inventorySources.html">inventorySources</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="#create">create(advertiserId=None, body=None, partnerId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new inventory source. Returns the newly created inventory source if successful.</p>
<p class="toc_element">
<code><a href="#editInventorySourceReadWriteAccessors">editInventorySourceReadWriteAccessors(inventorySourceId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Edits read/write accessors of an inventory source. Returns the updated read_write_accessors for the inventory source.</p>
<p class="toc_element">
<code><a href="#get">get(inventorySourceId, advertiserId=None, partnerId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets an inventory source.</p>
<p class="toc_element">
<code><a href="#list">list(advertiserId=None, filter=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists inventory sources that are accessible to the current user. The order is defined by the order_by parameter. If a filter by entity_status is not specified, inventory sources with entity status `ENTITY_STATUS_ARCHIVED` will not be included in the results.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(inventorySourceId, advertiserId=None, body=None, partnerId=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing inventory source. Returns the updated inventory source if successful.</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="create">create(advertiserId=None, body=None, partnerId=None, x__xgafv=None)</code>
<pre>Creates a new inventory source. Returns the newly created inventory source if successful.
Args:
body: object, The request body.
The object takes the form of:
{ # An inventory source.
"commitment": "A String", # Whether the inventory source has a guaranteed or non-guaranteed delivery.
"creativeConfigs": [ # The creative requirements of the inventory source. Not applicable for auction packages.
{ # Creative requirements configuration for the inventory source.
"creativeType": "A String", # The type of creative that can be assigned to the inventory source. Only the following types are supported: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_VIDEO`
"displayCreativeConfig": { # The configuration for display creatives. # The configuration for display creatives. Applicable when creative_type is `CREATIVE_TYPE_STANDARD`.
"creativeSize": { # Dimensions. # The size requirements for display creatives that can be assigned to the inventory source.
"heightPixels": 42, # The height in pixels.
"widthPixels": 42, # The width in pixels.
},
},
"videoCreativeConfig": { # The configuration for video creatives. # The configuration for video creatives. Applicable when creative_type is `CREATIVE_TYPE_VIDEO`.
"duration": "A String", # The duration requirements for the video creatives that can be assigned to the inventory source.
},
},
],
"dealId": "A String", # The ID in the exchange space that uniquely identifies the inventory source. Must be unique across buyers within each exchange but not necessarily unique across exchanges.
"deliveryMethod": "A String", # The delivery method of the inventory source. * For non-guaranteed inventory sources, the only acceptable value is `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`. * For guaranteed inventory sources, acceptable values are `INVENTORY_SOURCE_DELIVERY_METHOD_TAG` and `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`.
"displayName": "A String", # The display name of the inventory source. Must be UTF-8 encoded with a maximum size of 240 bytes.
"exchange": "A String", # The exchange to which the inventory source belongs.
"guaranteedOrderId": "A String", # Immutable. The ID of the guaranteed order that this inventory source belongs to. Only applicable when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`.
"inventorySourceId": "A String", # Output only. The unique ID of the inventory source. Assigned by the system.
"inventorySourceProductType": "A String", # Output only. The product type of the inventory source, denoting the way through which it sells inventory.
"inventorySourceType": "A String", # Denotes the type of the inventory source.
"name": "A String", # Output only. The resource name of the inventory source.
"publisherName": "A String", # The publisher/seller name of the inventory source.
"rateDetails": { # The rate related settings of the inventory source. # Required. The rate details of the inventory source.
"inventorySourceRateType": "A String", # The rate type. Acceptable values are `INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED`, `INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR`, and `INVENTORY_SOURCE_RATE_TYPE_CPD`.
"minimumSpend": { # Represents an amount of money with its currency type. # Output only. The amount that the buyer has committed to spending on the inventory source up front. Only applicable for guaranteed inventory sources.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"rate": { # Represents an amount of money with its currency type. # The rate for the inventory source.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"unitsPurchased": "A String", # Required for guaranteed inventory sources. The number of impressions guaranteed by the seller.
},
"readAdvertiserIds": [ # Output only. The IDs of advertisers with read-only access to the inventory source.
"A String",
],
"readPartnerIds": [ # Output only. The IDs of partners with read-only access to the inventory source. All advertisers of partners in this field inherit read-only access to the inventory source.
"A String",
],
"readWriteAccessors": { # The partner or advertisers with access to the inventory source. # The partner or advertisers that have read/write access to the inventory source. Output only when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`, in which case the read/write accessors are inherited from the parent guaranteed order. Required when commitment is `INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED`. If commitment is `INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED` and a partner is set in this field, all advertisers under this partner will automatically have read-only access to the inventory source. These advertisers will not be included in read_advertiser_ids.
"advertisers": { # The advertisers with access to the inventory source. # The advertisers with access to the inventory source. All advertisers must belong to the same partner.
"advertiserIds": [ # The IDs of the advertisers.
"A String",
],
},
"partner": { # The partner with access to the inventory source. # The partner with access to the inventory source.
"partnerId": "A String", # The ID of the partner.
},
},
"status": { # The status related settings of the inventory source. # The status settings of the inventory source.
"configStatus": "A String", # Output only. The configuration status of the inventory source. Only applicable for guaranteed inventory sources. Acceptable values are `INVENTORY_SOURCE_CONFIG_STATUS_PENDING` and `INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED`. An inventory source must be configured (fill in the required fields, choose creatives, and select a default campaign) before it can serve.
"entityPauseReason": "A String", # The user-provided reason for pausing this inventory source. Must not exceed 100 characters. Only applicable when entity_status is set to `ENTITY_STATUS_PAUSED`.
"entityStatus": "A String", # Whether or not the inventory source is servable. Acceptable values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. Default value is `ENTITY_STATUS_ACTIVE`.
"sellerPauseReason": "A String", # Output only. The seller-provided reason for pausing this inventory source. Only applicable for inventory sources synced directly from the publishers and when seller_status is set to `ENTITY_STATUS_PAUSED`.
"sellerStatus": "A String", # Output only. The status set by the seller for the inventory source. Only applicable for inventory sources synced directly from the publishers. Acceptable values are `ENTITY_STATUS_ACTIVE` and `ENTITY_STATUS_PAUSED`.
},
"timeRange": { # A time range. # The time range when this inventory source starts and stops serving.
"endTime": "A String", # Required. The upper bound of a time range, inclusive.
"startTime": "A String", # Required. The lower bound of a time range, inclusive.
},
"updateTime": "A String", # Output only. The timestamp when the inventory source was last updated. Assigned by the system.
}
advertiserId: string, The ID of the advertiser that the request is being made within.
partnerId: string, The ID of the partner that the request is being made within.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An inventory source.
"commitment": "A String", # Whether the inventory source has a guaranteed or non-guaranteed delivery.
"creativeConfigs": [ # The creative requirements of the inventory source. Not applicable for auction packages.
{ # Creative requirements configuration for the inventory source.
"creativeType": "A String", # The type of creative that can be assigned to the inventory source. Only the following types are supported: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_VIDEO`
"displayCreativeConfig": { # The configuration for display creatives. # The configuration for display creatives. Applicable when creative_type is `CREATIVE_TYPE_STANDARD`.
"creativeSize": { # Dimensions. # The size requirements for display creatives that can be assigned to the inventory source.
"heightPixels": 42, # The height in pixels.
"widthPixels": 42, # The width in pixels.
},
},
"videoCreativeConfig": { # The configuration for video creatives. # The configuration for video creatives. Applicable when creative_type is `CREATIVE_TYPE_VIDEO`.
"duration": "A String", # The duration requirements for the video creatives that can be assigned to the inventory source.
},
},
],
"dealId": "A String", # The ID in the exchange space that uniquely identifies the inventory source. Must be unique across buyers within each exchange but not necessarily unique across exchanges.
"deliveryMethod": "A String", # The delivery method of the inventory source. * For non-guaranteed inventory sources, the only acceptable value is `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`. * For guaranteed inventory sources, acceptable values are `INVENTORY_SOURCE_DELIVERY_METHOD_TAG` and `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`.
"displayName": "A String", # The display name of the inventory source. Must be UTF-8 encoded with a maximum size of 240 bytes.
"exchange": "A String", # The exchange to which the inventory source belongs.
"guaranteedOrderId": "A String", # Immutable. The ID of the guaranteed order that this inventory source belongs to. Only applicable when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`.
"inventorySourceId": "A String", # Output only. The unique ID of the inventory source. Assigned by the system.
"inventorySourceProductType": "A String", # Output only. The product type of the inventory source, denoting the way through which it sells inventory.
"inventorySourceType": "A String", # Denotes the type of the inventory source.
"name": "A String", # Output only. The resource name of the inventory source.
"publisherName": "A String", # The publisher/seller name of the inventory source.
"rateDetails": { # The rate related settings of the inventory source. # Required. The rate details of the inventory source.
"inventorySourceRateType": "A String", # The rate type. Acceptable values are `INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED`, `INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR`, and `INVENTORY_SOURCE_RATE_TYPE_CPD`.
"minimumSpend": { # Represents an amount of money with its currency type. # Output only. The amount that the buyer has committed to spending on the inventory source up front. Only applicable for guaranteed inventory sources.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"rate": { # Represents an amount of money with its currency type. # The rate for the inventory source.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"unitsPurchased": "A String", # Required for guaranteed inventory sources. The number of impressions guaranteed by the seller.
},
"readAdvertiserIds": [ # Output only. The IDs of advertisers with read-only access to the inventory source.
"A String",
],
"readPartnerIds": [ # Output only. The IDs of partners with read-only access to the inventory source. All advertisers of partners in this field inherit read-only access to the inventory source.
"A String",
],
"readWriteAccessors": { # The partner or advertisers with access to the inventory source. # The partner or advertisers that have read/write access to the inventory source. Output only when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`, in which case the read/write accessors are inherited from the parent guaranteed order. Required when commitment is `INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED`. If commitment is `INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED` and a partner is set in this field, all advertisers under this partner will automatically have read-only access to the inventory source. These advertisers will not be included in read_advertiser_ids.
"advertisers": { # The advertisers with access to the inventory source. # The advertisers with access to the inventory source. All advertisers must belong to the same partner.
"advertiserIds": [ # The IDs of the advertisers.
"A String",
],
},
"partner": { # The partner with access to the inventory source. # The partner with access to the inventory source.
"partnerId": "A String", # The ID of the partner.
},
},
"status": { # The status related settings of the inventory source. # The status settings of the inventory source.
"configStatus": "A String", # Output only. The configuration status of the inventory source. Only applicable for guaranteed inventory sources. Acceptable values are `INVENTORY_SOURCE_CONFIG_STATUS_PENDING` and `INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED`. An inventory source must be configured (fill in the required fields, choose creatives, and select a default campaign) before it can serve.
"entityPauseReason": "A String", # The user-provided reason for pausing this inventory source. Must not exceed 100 characters. Only applicable when entity_status is set to `ENTITY_STATUS_PAUSED`.
"entityStatus": "A String", # Whether or not the inventory source is servable. Acceptable values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. Default value is `ENTITY_STATUS_ACTIVE`.
"sellerPauseReason": "A String", # Output only. The seller-provided reason for pausing this inventory source. Only applicable for inventory sources synced directly from the publishers and when seller_status is set to `ENTITY_STATUS_PAUSED`.
"sellerStatus": "A String", # Output only. The status set by the seller for the inventory source. Only applicable for inventory sources synced directly from the publishers. Acceptable values are `ENTITY_STATUS_ACTIVE` and `ENTITY_STATUS_PAUSED`.
},
"timeRange": { # A time range. # The time range when this inventory source starts and stops serving.
"endTime": "A String", # Required. The upper bound of a time range, inclusive.
"startTime": "A String", # Required. The lower bound of a time range, inclusive.
},
"updateTime": "A String", # Output only. The timestamp when the inventory source was last updated. Assigned by the system.
}</pre>
</div>
<div class="method">
<code class="details" id="editInventorySourceReadWriteAccessors">editInventorySourceReadWriteAccessors(inventorySourceId, body=None, x__xgafv=None)</code>
<pre>Edits read/write accessors of an inventory source. Returns the updated read_write_accessors for the inventory source.
Args:
inventorySourceId: string, Required. The ID of inventory source to update. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for InventorySourceService.EditInventorySourceReadWriteAccessors.
"advertisersUpdate": { # Update to the list of advertisers with read/write access to the inventory source. # The advertisers to add or remove from the list of advertisers that have read/write access to the inventory source. This change will remove an existing partner read/write accessor.
"addedAdvertisers": [ # The advertisers to add.
"A String",
],
"removedAdvertisers": [ # The advertisers to remove.
"A String",
],
},
"assignPartner": True or False, # Set the partner context as read/write accessor of the inventory source. This will remove all other current read/write advertiser accessors.
"partnerId": "A String", # Required. The partner context by which the accessors change is being made.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The partner or advertisers with access to the inventory source.
"advertisers": { # The advertisers with access to the inventory source. # The advertisers with access to the inventory source. All advertisers must belong to the same partner.
"advertiserIds": [ # The IDs of the advertisers.
"A String",
],
},
"partner": { # The partner with access to the inventory source. # The partner with access to the inventory source.
"partnerId": "A String", # The ID of the partner.
},
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(inventorySourceId, advertiserId=None, partnerId=None, x__xgafv=None)</code>
<pre>Gets an inventory source.
Args:
inventorySourceId: string, Required. The ID of the inventory source to fetch. (required)
advertiserId: string, Optional. The ID of the DV360 advertiser to which the fetched inventory source is permissioned. If the user only has access to the advertiser and not the parent partner, use this field to specify the relevant advertiser.
partnerId: string, Required. The ID of the DV360 partner to which the fetched inventory source is permissioned.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An inventory source.
"commitment": "A String", # Whether the inventory source has a guaranteed or non-guaranteed delivery.
"creativeConfigs": [ # The creative requirements of the inventory source. Not applicable for auction packages.
{ # Creative requirements configuration for the inventory source.
"creativeType": "A String", # The type of creative that can be assigned to the inventory source. Only the following types are supported: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_VIDEO`
"displayCreativeConfig": { # The configuration for display creatives. # The configuration for display creatives. Applicable when creative_type is `CREATIVE_TYPE_STANDARD`.
"creativeSize": { # Dimensions. # The size requirements for display creatives that can be assigned to the inventory source.
"heightPixels": 42, # The height in pixels.
"widthPixels": 42, # The width in pixels.
},
},
"videoCreativeConfig": { # The configuration for video creatives. # The configuration for video creatives. Applicable when creative_type is `CREATIVE_TYPE_VIDEO`.
"duration": "A String", # The duration requirements for the video creatives that can be assigned to the inventory source.
},
},
],
"dealId": "A String", # The ID in the exchange space that uniquely identifies the inventory source. Must be unique across buyers within each exchange but not necessarily unique across exchanges.
"deliveryMethod": "A String", # The delivery method of the inventory source. * For non-guaranteed inventory sources, the only acceptable value is `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`. * For guaranteed inventory sources, acceptable values are `INVENTORY_SOURCE_DELIVERY_METHOD_TAG` and `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`.
"displayName": "A String", # The display name of the inventory source. Must be UTF-8 encoded with a maximum size of 240 bytes.
"exchange": "A String", # The exchange to which the inventory source belongs.
"guaranteedOrderId": "A String", # Immutable. The ID of the guaranteed order that this inventory source belongs to. Only applicable when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`.
"inventorySourceId": "A String", # Output only. The unique ID of the inventory source. Assigned by the system.
"inventorySourceProductType": "A String", # Output only. The product type of the inventory source, denoting the way through which it sells inventory.
"inventorySourceType": "A String", # Denotes the type of the inventory source.
"name": "A String", # Output only. The resource name of the inventory source.
"publisherName": "A String", # The publisher/seller name of the inventory source.
"rateDetails": { # The rate related settings of the inventory source. # Required. The rate details of the inventory source.
"inventorySourceRateType": "A String", # The rate type. Acceptable values are `INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED`, `INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR`, and `INVENTORY_SOURCE_RATE_TYPE_CPD`.
"minimumSpend": { # Represents an amount of money with its currency type. # Output only. The amount that the buyer has committed to spending on the inventory source up front. Only applicable for guaranteed inventory sources.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"rate": { # Represents an amount of money with its currency type. # The rate for the inventory source.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"unitsPurchased": "A String", # Required for guaranteed inventory sources. The number of impressions guaranteed by the seller.
},
"readAdvertiserIds": [ # Output only. The IDs of advertisers with read-only access to the inventory source.
"A String",
],
"readPartnerIds": [ # Output only. The IDs of partners with read-only access to the inventory source. All advertisers of partners in this field inherit read-only access to the inventory source.
"A String",
],
"readWriteAccessors": { # The partner or advertisers with access to the inventory source. # The partner or advertisers that have read/write access to the inventory source. Output only when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`, in which case the read/write accessors are inherited from the parent guaranteed order. Required when commitment is `INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED`. If commitment is `INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED` and a partner is set in this field, all advertisers under this partner will automatically have read-only access to the inventory source. These advertisers will not be included in read_advertiser_ids.
"advertisers": { # The advertisers with access to the inventory source. # The advertisers with access to the inventory source. All advertisers must belong to the same partner.
"advertiserIds": [ # The IDs of the advertisers.
"A String",
],
},
"partner": { # The partner with access to the inventory source. # The partner with access to the inventory source.
"partnerId": "A String", # The ID of the partner.
},
},
"status": { # The status related settings of the inventory source. # The status settings of the inventory source.
"configStatus": "A String", # Output only. The configuration status of the inventory source. Only applicable for guaranteed inventory sources. Acceptable values are `INVENTORY_SOURCE_CONFIG_STATUS_PENDING` and `INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED`. An inventory source must be configured (fill in the required fields, choose creatives, and select a default campaign) before it can serve.
"entityPauseReason": "A String", # The user-provided reason for pausing this inventory source. Must not exceed 100 characters. Only applicable when entity_status is set to `ENTITY_STATUS_PAUSED`.
"entityStatus": "A String", # Whether or not the inventory source is servable. Acceptable values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. Default value is `ENTITY_STATUS_ACTIVE`.
"sellerPauseReason": "A String", # Output only. The seller-provided reason for pausing this inventory source. Only applicable for inventory sources synced directly from the publishers and when seller_status is set to `ENTITY_STATUS_PAUSED`.
"sellerStatus": "A String", # Output only. The status set by the seller for the inventory source. Only applicable for inventory sources synced directly from the publishers. Acceptable values are `ENTITY_STATUS_ACTIVE` and `ENTITY_STATUS_PAUSED`.
},
"timeRange": { # A time range. # The time range when this inventory source starts and stops serving.
"endTime": "A String", # Required. The upper bound of a time range, inclusive.
"startTime": "A String", # Required. The lower bound of a time range, inclusive.
},
"updateTime": "A String", # Output only. The timestamp when the inventory source was last updated. Assigned by the system.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(advertiserId=None, filter=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None)</code>
<pre>Lists inventory sources that are accessible to the current user. The order is defined by the order_by parameter. If a filter by entity_status is not specified, inventory sources with entity status `ENTITY_STATUS_ARCHIVED` will not be included in the results.
Args:
advertiserId: string, The ID of the advertiser that has access to the inventory source.
filter: string, Allows filtering by inventory source fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `status.entityStatus` * `commitment` * `deliveryMethod` * `rateDetails.rateType` * `exchange` Examples: * All active inventory sources: `status.entityStatus="ENTITY_STATUS_ACTIVE"` * Inventory sources belonging to Google Ad Manager or Rubicon exchanges: `exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
orderBy: string, Field by which to sort the list. Acceptable values are: * `displayName` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`.
pageSize: integer, Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInventorySources` method. If not specified, the first page of results will be returned.
partnerId: string, The ID of the partner that has access to the inventory source.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"inventorySources": [ # The list of inventory sources. This list will be absent if empty.
{ # An inventory source.
"commitment": "A String", # Whether the inventory source has a guaranteed or non-guaranteed delivery.
"creativeConfigs": [ # The creative requirements of the inventory source. Not applicable for auction packages.
{ # Creative requirements configuration for the inventory source.
"creativeType": "A String", # The type of creative that can be assigned to the inventory source. Only the following types are supported: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_VIDEO`
"displayCreativeConfig": { # The configuration for display creatives. # The configuration for display creatives. Applicable when creative_type is `CREATIVE_TYPE_STANDARD`.
"creativeSize": { # Dimensions. # The size requirements for display creatives that can be assigned to the inventory source.
"heightPixels": 42, # The height in pixels.
"widthPixels": 42, # The width in pixels.
},
},
"videoCreativeConfig": { # The configuration for video creatives. # The configuration for video creatives. Applicable when creative_type is `CREATIVE_TYPE_VIDEO`.
"duration": "A String", # The duration requirements for the video creatives that can be assigned to the inventory source.
},
},
],
"dealId": "A String", # The ID in the exchange space that uniquely identifies the inventory source. Must be unique across buyers within each exchange but not necessarily unique across exchanges.
"deliveryMethod": "A String", # The delivery method of the inventory source. * For non-guaranteed inventory sources, the only acceptable value is `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`. * For guaranteed inventory sources, acceptable values are `INVENTORY_SOURCE_DELIVERY_METHOD_TAG` and `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`.
"displayName": "A String", # The display name of the inventory source. Must be UTF-8 encoded with a maximum size of 240 bytes.
"exchange": "A String", # The exchange to which the inventory source belongs.
"guaranteedOrderId": "A String", # Immutable. The ID of the guaranteed order that this inventory source belongs to. Only applicable when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`.
"inventorySourceId": "A String", # Output only. The unique ID of the inventory source. Assigned by the system.
"inventorySourceProductType": "A String", # Output only. The product type of the inventory source, denoting the way through which it sells inventory.
"inventorySourceType": "A String", # Denotes the type of the inventory source.
"name": "A String", # Output only. The resource name of the inventory source.
"publisherName": "A String", # The publisher/seller name of the inventory source.
"rateDetails": { # The rate related settings of the inventory source. # Required. The rate details of the inventory source.
"inventorySourceRateType": "A String", # The rate type. Acceptable values are `INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED`, `INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR`, and `INVENTORY_SOURCE_RATE_TYPE_CPD`.
"minimumSpend": { # Represents an amount of money with its currency type. # Output only. The amount that the buyer has committed to spending on the inventory source up front. Only applicable for guaranteed inventory sources.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"rate": { # Represents an amount of money with its currency type. # The rate for the inventory source.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"unitsPurchased": "A String", # Required for guaranteed inventory sources. The number of impressions guaranteed by the seller.
},
"readAdvertiserIds": [ # Output only. The IDs of advertisers with read-only access to the inventory source.
"A String",
],
"readPartnerIds": [ # Output only. The IDs of partners with read-only access to the inventory source. All advertisers of partners in this field inherit read-only access to the inventory source.
"A String",
],
"readWriteAccessors": { # The partner or advertisers with access to the inventory source. # The partner or advertisers that have read/write access to the inventory source. Output only when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`, in which case the read/write accessors are inherited from the parent guaranteed order. Required when commitment is `INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED`. If commitment is `INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED` and a partner is set in this field, all advertisers under this partner will automatically have read-only access to the inventory source. These advertisers will not be included in read_advertiser_ids.
"advertisers": { # The advertisers with access to the inventory source. # The advertisers with access to the inventory source. All advertisers must belong to the same partner.
"advertiserIds": [ # The IDs of the advertisers.
"A String",
],
},
"partner": { # The partner with access to the inventory source. # The partner with access to the inventory source.
"partnerId": "A String", # The ID of the partner.
},
},
"status": { # The status related settings of the inventory source. # The status settings of the inventory source.
"configStatus": "A String", # Output only. The configuration status of the inventory source. Only applicable for guaranteed inventory sources. Acceptable values are `INVENTORY_SOURCE_CONFIG_STATUS_PENDING` and `INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED`. An inventory source must be configured (fill in the required fields, choose creatives, and select a default campaign) before it can serve.
"entityPauseReason": "A String", # The user-provided reason for pausing this inventory source. Must not exceed 100 characters. Only applicable when entity_status is set to `ENTITY_STATUS_PAUSED`.
"entityStatus": "A String", # Whether or not the inventory source is servable. Acceptable values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. Default value is `ENTITY_STATUS_ACTIVE`.
"sellerPauseReason": "A String", # Output only. The seller-provided reason for pausing this inventory source. Only applicable for inventory sources synced directly from the publishers and when seller_status is set to `ENTITY_STATUS_PAUSED`.
"sellerStatus": "A String", # Output only. The status set by the seller for the inventory source. Only applicable for inventory sources synced directly from the publishers. Acceptable values are `ENTITY_STATUS_ACTIVE` and `ENTITY_STATUS_PAUSED`.
},
"timeRange": { # A time range. # The time range when this inventory source starts and stops serving.
"endTime": "A String", # Required. The upper bound of a time range, inclusive.
"startTime": "A String", # Required. The lower bound of a time range, inclusive.
},
"updateTime": "A String", # Output only. The timestamp when the inventory source was last updated. Assigned by the system.
},
],
"nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListInventorySources` method to retrieve the next page of results.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(inventorySourceId, advertiserId=None, body=None, partnerId=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates an existing inventory source. Returns the updated inventory source if successful.
Args:
inventorySourceId: string, Output only. The unique ID of the inventory source. Assigned by the system. (required)
body: object, The request body.
The object takes the form of:
{ # An inventory source.
"commitment": "A String", # Whether the inventory source has a guaranteed or non-guaranteed delivery.
"creativeConfigs": [ # The creative requirements of the inventory source. Not applicable for auction packages.
{ # Creative requirements configuration for the inventory source.
"creativeType": "A String", # The type of creative that can be assigned to the inventory source. Only the following types are supported: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_VIDEO`
"displayCreativeConfig": { # The configuration for display creatives. # The configuration for display creatives. Applicable when creative_type is `CREATIVE_TYPE_STANDARD`.
"creativeSize": { # Dimensions. # The size requirements for display creatives that can be assigned to the inventory source.
"heightPixels": 42, # The height in pixels.
"widthPixels": 42, # The width in pixels.
},
},
"videoCreativeConfig": { # The configuration for video creatives. # The configuration for video creatives. Applicable when creative_type is `CREATIVE_TYPE_VIDEO`.
"duration": "A String", # The duration requirements for the video creatives that can be assigned to the inventory source.
},
},
],
"dealId": "A String", # The ID in the exchange space that uniquely identifies the inventory source. Must be unique across buyers within each exchange but not necessarily unique across exchanges.
"deliveryMethod": "A String", # The delivery method of the inventory source. * For non-guaranteed inventory sources, the only acceptable value is `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`. * For guaranteed inventory sources, acceptable values are `INVENTORY_SOURCE_DELIVERY_METHOD_TAG` and `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`.
"displayName": "A String", # The display name of the inventory source. Must be UTF-8 encoded with a maximum size of 240 bytes.
"exchange": "A String", # The exchange to which the inventory source belongs.
"guaranteedOrderId": "A String", # Immutable. The ID of the guaranteed order that this inventory source belongs to. Only applicable when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`.
"inventorySourceId": "A String", # Output only. The unique ID of the inventory source. Assigned by the system.
"inventorySourceProductType": "A String", # Output only. The product type of the inventory source, denoting the way through which it sells inventory.
"inventorySourceType": "A String", # Denotes the type of the inventory source.
"name": "A String", # Output only. The resource name of the inventory source.
"publisherName": "A String", # The publisher/seller name of the inventory source.
"rateDetails": { # The rate related settings of the inventory source. # Required. The rate details of the inventory source.
"inventorySourceRateType": "A String", # The rate type. Acceptable values are `INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED`, `INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR`, and `INVENTORY_SOURCE_RATE_TYPE_CPD`.
"minimumSpend": { # Represents an amount of money with its currency type. # Output only. The amount that the buyer has committed to spending on the inventory source up front. Only applicable for guaranteed inventory sources.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"rate": { # Represents an amount of money with its currency type. # The rate for the inventory source.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"unitsPurchased": "A String", # Required for guaranteed inventory sources. The number of impressions guaranteed by the seller.
},
"readAdvertiserIds": [ # Output only. The IDs of advertisers with read-only access to the inventory source.
"A String",
],
"readPartnerIds": [ # Output only. The IDs of partners with read-only access to the inventory source. All advertisers of partners in this field inherit read-only access to the inventory source.
"A String",
],
"readWriteAccessors": { # The partner or advertisers with access to the inventory source. # The partner or advertisers that have read/write access to the inventory source. Output only when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`, in which case the read/write accessors are inherited from the parent guaranteed order. Required when commitment is `INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED`. If commitment is `INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED` and a partner is set in this field, all advertisers under this partner will automatically have read-only access to the inventory source. These advertisers will not be included in read_advertiser_ids.
"advertisers": { # The advertisers with access to the inventory source. # The advertisers with access to the inventory source. All advertisers must belong to the same partner.
"advertiserIds": [ # The IDs of the advertisers.
"A String",
],
},
"partner": { # The partner with access to the inventory source. # The partner with access to the inventory source.
"partnerId": "A String", # The ID of the partner.
},
},
"status": { # The status related settings of the inventory source. # The status settings of the inventory source.
"configStatus": "A String", # Output only. The configuration status of the inventory source. Only applicable for guaranteed inventory sources. Acceptable values are `INVENTORY_SOURCE_CONFIG_STATUS_PENDING` and `INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED`. An inventory source must be configured (fill in the required fields, choose creatives, and select a default campaign) before it can serve.
"entityPauseReason": "A String", # The user-provided reason for pausing this inventory source. Must not exceed 100 characters. Only applicable when entity_status is set to `ENTITY_STATUS_PAUSED`.
"entityStatus": "A String", # Whether or not the inventory source is servable. Acceptable values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. Default value is `ENTITY_STATUS_ACTIVE`.
"sellerPauseReason": "A String", # Output only. The seller-provided reason for pausing this inventory source. Only applicable for inventory sources synced directly from the publishers and when seller_status is set to `ENTITY_STATUS_PAUSED`.
"sellerStatus": "A String", # Output only. The status set by the seller for the inventory source. Only applicable for inventory sources synced directly from the publishers. Acceptable values are `ENTITY_STATUS_ACTIVE` and `ENTITY_STATUS_PAUSED`.
},
"timeRange": { # A time range. # The time range when this inventory source starts and stops serving.
"endTime": "A String", # Required. The upper bound of a time range, inclusive.
"startTime": "A String", # Required. The lower bound of a time range, inclusive.
},
"updateTime": "A String", # Output only. The timestamp when the inventory source was last updated. Assigned by the system.
}
advertiserId: string, The ID of the advertiser that the request is being made within.
partnerId: string, The ID of the partner that the request is being made within.
updateMask: string, Required. The mask to control which fields to update.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An inventory source.
"commitment": "A String", # Whether the inventory source has a guaranteed or non-guaranteed delivery.
"creativeConfigs": [ # The creative requirements of the inventory source. Not applicable for auction packages.
{ # Creative requirements configuration for the inventory source.
"creativeType": "A String", # The type of creative that can be assigned to the inventory source. Only the following types are supported: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_VIDEO`
"displayCreativeConfig": { # The configuration for display creatives. # The configuration for display creatives. Applicable when creative_type is `CREATIVE_TYPE_STANDARD`.
"creativeSize": { # Dimensions. # The size requirements for display creatives that can be assigned to the inventory source.
"heightPixels": 42, # The height in pixels.
"widthPixels": 42, # The width in pixels.
},
},
"videoCreativeConfig": { # The configuration for video creatives. # The configuration for video creatives. Applicable when creative_type is `CREATIVE_TYPE_VIDEO`.
"duration": "A String", # The duration requirements for the video creatives that can be assigned to the inventory source.
},
},
],
"dealId": "A String", # The ID in the exchange space that uniquely identifies the inventory source. Must be unique across buyers within each exchange but not necessarily unique across exchanges.
"deliveryMethod": "A String", # The delivery method of the inventory source. * For non-guaranteed inventory sources, the only acceptable value is `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`. * For guaranteed inventory sources, acceptable values are `INVENTORY_SOURCE_DELIVERY_METHOD_TAG` and `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`.
"displayName": "A String", # The display name of the inventory source. Must be UTF-8 encoded with a maximum size of 240 bytes.
"exchange": "A String", # The exchange to which the inventory source belongs.
"guaranteedOrderId": "A String", # Immutable. The ID of the guaranteed order that this inventory source belongs to. Only applicable when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`.
"inventorySourceId": "A String", # Output only. The unique ID of the inventory source. Assigned by the system.
"inventorySourceProductType": "A String", # Output only. The product type of the inventory source, denoting the way through which it sells inventory.
"inventorySourceType": "A String", # Denotes the type of the inventory source.
"name": "A String", # Output only. The resource name of the inventory source.
"publisherName": "A String", # The publisher/seller name of the inventory source.
"rateDetails": { # The rate related settings of the inventory source. # Required. The rate details of the inventory source.
"inventorySourceRateType": "A String", # The rate type. Acceptable values are `INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED`, `INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR`, and `INVENTORY_SOURCE_RATE_TYPE_CPD`.
"minimumSpend": { # Represents an amount of money with its currency type. # Output only. The amount that the buyer has committed to spending on the inventory source up front. Only applicable for guaranteed inventory sources.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"rate": { # Represents an amount of money with its currency type. # The rate for the inventory source.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"unitsPurchased": "A String", # Required for guaranteed inventory sources. The number of impressions guaranteed by the seller.
},
"readAdvertiserIds": [ # Output only. The IDs of advertisers with read-only access to the inventory source.
"A String",
],
"readPartnerIds": [ # Output only. The IDs of partners with read-only access to the inventory source. All advertisers of partners in this field inherit read-only access to the inventory source.
"A String",
],
"readWriteAccessors": { # The partner or advertisers with access to the inventory source. # The partner or advertisers that have read/write access to the inventory source. Output only when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`, in which case the read/write accessors are inherited from the parent guaranteed order. Required when commitment is `INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED`. If commitment is `INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED` and a partner is set in this field, all advertisers under this partner will automatically have read-only access to the inventory source. These advertisers will not be included in read_advertiser_ids.
"advertisers": { # The advertisers with access to the inventory source. # The advertisers with access to the inventory source. All advertisers must belong to the same partner.
"advertiserIds": [ # The IDs of the advertisers.
"A String",
],
},
"partner": { # The partner with access to the inventory source. # The partner with access to the inventory source.
"partnerId": "A String", # The ID of the partner.
},
},
"status": { # The status related settings of the inventory source. # The status settings of the inventory source.
"configStatus": "A String", # Output only. The configuration status of the inventory source. Only applicable for guaranteed inventory sources. Acceptable values are `INVENTORY_SOURCE_CONFIG_STATUS_PENDING` and `INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED`. An inventory source must be configured (fill in the required fields, choose creatives, and select a default campaign) before it can serve.
"entityPauseReason": "A String", # The user-provided reason for pausing this inventory source. Must not exceed 100 characters. Only applicable when entity_status is set to `ENTITY_STATUS_PAUSED`.
"entityStatus": "A String", # Whether or not the inventory source is servable. Acceptable values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. Default value is `ENTITY_STATUS_ACTIVE`.
"sellerPauseReason": "A String", # Output only. The seller-provided reason for pausing this inventory source. Only applicable for inventory sources synced directly from the publishers and when seller_status is set to `ENTITY_STATUS_PAUSED`.
"sellerStatus": "A String", # Output only. The status set by the seller for the inventory source. Only applicable for inventory sources synced directly from the publishers. Acceptable values are `ENTITY_STATUS_ACTIVE` and `ENTITY_STATUS_PAUSED`.
},
"timeRange": { # A time range. # The time range when this inventory source starts and stops serving.
"endTime": "A String", # Required. The upper bound of a time range, inclusive.
"startTime": "A String", # Required. The lower bound of a time range, inclusive.
},
"updateTime": "A String", # Output only. The timestamp when the inventory source was last updated. Assigned by the system.
}</pre>
</div>
</body></html>
|
