Debian Codegraph @

docs/dyn/displayvideo_v1.inventorySources.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="displayvideo_v1.html">Display & Video 360 API</a> . <a href="displayvideo_v1.inventorySources.html">inventorySources</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#create">create(advertiserId=None, body=None, partnerId=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Creates a new inventory source. Returns the newly created inventory source if successful.</p>
83 <p class="toc_element">
84 <code><a href="#editInventorySourceReadWriteAccessors">editInventorySourceReadWriteAccessors(inventorySourceId, body=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Edits read/write accessors of an inventory source. Returns the updated read_write_accessors for the inventory source.</p>
86 <p class="toc_element">
87 <code><a href="#get">get(inventorySourceId, partnerId=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Gets an inventory source.</p>
89 <p class="toc_element">
90 <code><a href="#list">list(advertiserId=None, filter=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None)</a></code></p>
91 <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>
92 <p class="toc_element">
93 <code><a href="#list_next">list_next()</a></code></p>
94 <p class="firstline">Retrieves the next page of results.</p>
95 <p class="toc_element">
96 <code><a href="#patch">patch(inventorySourceId, advertiserId=None, body=None, partnerId=None, updateMask=None, x__xgafv=None)</a></code></p>
97 <p class="firstline">Updates an existing inventory source. Returns the updated inventory source if successful.</p>
98 <h3>Method Details</h3>
99 <div class="method">
100 <code class="details" id="close">close()</code>
101 <pre>Close httplib2 connections.</pre>
102 </div>
103
104 <div class="method">
105 <code class="details" id="create">create(advertiserId=None, body=None, partnerId=None, x__xgafv=None)</code>
106 <pre>Creates a new inventory source. Returns the newly created inventory source if successful.
107
108 Args:
109 body: object, The request body.
110 The object takes the form of:
111
112 { # An inventory source.
113 &quot;commitment&quot;: &quot;A String&quot;, # Whether the inventory source has a guaranteed or non-guaranteed delivery.
114 &quot;creativeConfigs&quot;: [ # The creative requirements of the inventory source. Not applicable for auction packages.
115 { # Creative requirements configuration for the inventory source.
116 &quot;creativeType&quot;: &quot;A String&quot;, # The type of creative that can be assigned to the inventory source. Only the following types are supported: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_VIDEO`
117 &quot;displayCreativeConfig&quot;: { # The configuration for display creatives. # The configuration for display creatives. Applicable when creative_type is `CREATIVE_TYPE_STANDARD`.
118 &quot;creativeSize&quot;: { # Dimensions. # The size requirements for display creatives that can be assigned to the inventory source.
119 &quot;heightPixels&quot;: 42, # The height in pixels.
120 &quot;widthPixels&quot;: 42, # The width in pixels.
121 },
122 },
123 &quot;videoCreativeConfig&quot;: { # The configuration for video creatives. # The configuration for video creatives. Applicable when creative_type is `CREATIVE_TYPE_VIDEO`.
124 &quot;duration&quot;: &quot;A String&quot;, # The duration requirements for the video creatives that can be assigned to the inventory source.
125 },
126 },
127 ],
128 &quot;dealId&quot;: &quot;A String&quot;, # 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.
129 &quot;deliveryMethod&quot;: &quot;A String&quot;, # 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`.
130 &quot;displayName&quot;: &quot;A String&quot;, # The display name of the inventory source. Must be UTF-8 encoded with a maximum size of 240 bytes.
131 &quot;exchange&quot;: &quot;A String&quot;, # The exchange to which the inventory source belongs.
132 &quot;guaranteedOrderId&quot;: &quot;A String&quot;, # Immutable. The ID of the guaranteed order that this inventory source belongs to. Only applicable when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`.
133 &quot;inventorySourceId&quot;: &quot;A String&quot;, # Output only. The unique ID of the inventory source. Assigned by the system.
134 &quot;inventorySourceProductType&quot;: &quot;A String&quot;, # Output only. The product type of the inventory source, denoting the way through which it sells inventory.
135 &quot;inventorySourceType&quot;: &quot;A String&quot;, # Denotes the type of the inventory source.
136 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the inventory source.
137 &quot;publisherName&quot;: &quot;A String&quot;, # The publisher/seller name of the inventory source.
138 &quot;rateDetails&quot;: { # The rate related settings of the inventory source. # Required. The rate details of the inventory source.
139 &quot;inventorySourceRateType&quot;: &quot;A String&quot;, # The rate type. Acceptable values are `INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED`, `INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR`, and `INVENTORY_SOURCE_RATE_TYPE_CPD`.
140 &quot;minimumSpend&quot;: { # 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.
141 &quot;currencyCode&quot;: &quot;A String&quot;, # The three-letter currency code defined in ISO 4217.
142 &quot;nanos&quot;: 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.
143 &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount. For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
144 },
145 &quot;rate&quot;: { # Represents an amount of money with its currency type. # The rate for the inventory source.
146 &quot;currencyCode&quot;: &quot;A String&quot;, # The three-letter currency code defined in ISO 4217.
147 &quot;nanos&quot;: 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.
148 &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount. For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
149 },
150 &quot;unitsPurchased&quot;: &quot;A String&quot;, # Required for guaranteed inventory sources. The number of impressions guaranteed by the seller.
151 },
152 &quot;readAdvertiserIds&quot;: [ # Output only. The IDs of advertisers with read-only access to the inventory source.
153 &quot;A String&quot;,
154 ],
155 &quot;readPartnerIds&quot;: [ # 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.
156 &quot;A String&quot;,
157 ],
158 &quot;readWriteAccessors&quot;: { # 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.
159 &quot;advertisers&quot;: { # The advertisers with access to the inventory source. # The advertisers with access to the inventory source. All advertisers must belong to the same partner.
160 &quot;advertiserIds&quot;: [ # The IDs of the advertisers.
161 &quot;A String&quot;,
162 ],
163 },
164 &quot;partner&quot;: { # The partner with access to the inventory source. # The partner with access to the inventory source.
165 &quot;partnerId&quot;: &quot;A String&quot;, # The ID of the partner.
166 },
167 },
168 &quot;status&quot;: { # The status related settings of the inventory source. # The status settings of the inventory source.
169 &quot;configStatus&quot;: &quot;A String&quot;, # 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.
170 &quot;entityPauseReason&quot;: &quot;A String&quot;, # 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`.
171 &quot;entityStatus&quot;: &quot;A String&quot;, # 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`.
172 &quot;sellerPauseReason&quot;: &quot;A String&quot;, # 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`.
173 &quot;sellerStatus&quot;: &quot;A String&quot;, # 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`.
174 },
175 &quot;timeRange&quot;: { # A time range. # The time range when this inventory source starts and stops serving.
176 &quot;endTime&quot;: &quot;A String&quot;, # Required. The upper bound of a time range, inclusive.
177 &quot;startTime&quot;: &quot;A String&quot;, # Required. The lower bound of a time range, inclusive.
178 },
179 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the inventory source was last updated. Assigned by the system.
180 }
181
182 advertiserId: string, The ID of the advertiser that the request is being made within.
183 partnerId: string, The ID of the partner that the request is being made within.
184 x__xgafv: string, V1 error format.
185 Allowed values
186 1 - v1 error format
187 2 - v2 error format
188
189 Returns:
190 An object of the form:
191
192 { # An inventory source.
193 &quot;commitment&quot;: &quot;A String&quot;, # Whether the inventory source has a guaranteed or non-guaranteed delivery.
194 &quot;creativeConfigs&quot;: [ # The creative requirements of the inventory source. Not applicable for auction packages.
195 { # Creative requirements configuration for the inventory source.
196 &quot;creativeType&quot;: &quot;A String&quot;, # The type of creative that can be assigned to the inventory source. Only the following types are supported: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_VIDEO`
197 &quot;displayCreativeConfig&quot;: { # The configuration for display creatives. # The configuration for display creatives. Applicable when creative_type is `CREATIVE_TYPE_STANDARD`.
198 &quot;creativeSize&quot;: { # Dimensions. # The size requirements for display creatives that can be assigned to the inventory source.
199 &quot;heightPixels&quot;: 42, # The height in pixels.
200 &quot;widthPixels&quot;: 42, # The width in pixels.
201 },
202 },
203 &quot;videoCreativeConfig&quot;: { # The configuration for video creatives. # The configuration for video creatives. Applicable when creative_type is `CREATIVE_TYPE_VIDEO`.
204 &quot;duration&quot;: &quot;A String&quot;, # The duration requirements for the video creatives that can be assigned to the inventory source.
205 },
206 },
207 ],
208 &quot;dealId&quot;: &quot;A String&quot;, # 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.
209 &quot;deliveryMethod&quot;: &quot;A String&quot;, # 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`.
210 &quot;displayName&quot;: &quot;A String&quot;, # The display name of the inventory source. Must be UTF-8 encoded with a maximum size of 240 bytes.
211 &quot;exchange&quot;: &quot;A String&quot;, # The exchange to which the inventory source belongs.
212 &quot;guaranteedOrderId&quot;: &quot;A String&quot;, # Immutable. The ID of the guaranteed order that this inventory source belongs to. Only applicable when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`.
213 &quot;inventorySourceId&quot;: &quot;A String&quot;, # Output only. The unique ID of the inventory source. Assigned by the system.
214 &quot;inventorySourceProductType&quot;: &quot;A String&quot;, # Output only. The product type of the inventory source, denoting the way through which it sells inventory.
215 &quot;inventorySourceType&quot;: &quot;A String&quot;, # Denotes the type of the inventory source.
216 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the inventory source.
217 &quot;publisherName&quot;: &quot;A String&quot;, # The publisher/seller name of the inventory source.
218 &quot;rateDetails&quot;: { # The rate related settings of the inventory source. # Required. The rate details of the inventory source.
219 &quot;inventorySourceRateType&quot;: &quot;A String&quot;, # The rate type. Acceptable values are `INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED`, `INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR`, and `INVENTORY_SOURCE_RATE_TYPE_CPD`.
220 &quot;minimumSpend&quot;: { # 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.
221 &quot;currencyCode&quot;: &quot;A String&quot;, # The three-letter currency code defined in ISO 4217.
222 &quot;nanos&quot;: 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.
223 &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount. For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
224 },
225 &quot;rate&quot;: { # Represents an amount of money with its currency type. # The rate for the inventory source.
226 &quot;currencyCode&quot;: &quot;A String&quot;, # The three-letter currency code defined in ISO 4217.
227 &quot;nanos&quot;: 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.
228 &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount. For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
229 },
230 &quot;unitsPurchased&quot;: &quot;A String&quot;, # Required for guaranteed inventory sources. The number of impressions guaranteed by the seller.
231 },
232 &quot;readAdvertiserIds&quot;: [ # Output only. The IDs of advertisers with read-only access to the inventory source.
233 &quot;A String&quot;,
234 ],
235 &quot;readPartnerIds&quot;: [ # 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.
236 &quot;A String&quot;,
237 ],
238 &quot;readWriteAccessors&quot;: { # 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.
239 &quot;advertisers&quot;: { # The advertisers with access to the inventory source. # The advertisers with access to the inventory source. All advertisers must belong to the same partner.
240 &quot;advertiserIds&quot;: [ # The IDs of the advertisers.
241 &quot;A String&quot;,
242 ],
243 },
244 &quot;partner&quot;: { # The partner with access to the inventory source. # The partner with access to the inventory source.
245 &quot;partnerId&quot;: &quot;A String&quot;, # The ID of the partner.
246 },
247 },
248 &quot;status&quot;: { # The status related settings of the inventory source. # The status settings of the inventory source.
249 &quot;configStatus&quot;: &quot;A String&quot;, # 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.
250 &quot;entityPauseReason&quot;: &quot;A String&quot;, # 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`.
251 &quot;entityStatus&quot;: &quot;A String&quot;, # 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`.
252 &quot;sellerPauseReason&quot;: &quot;A String&quot;, # 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`.
253 &quot;sellerStatus&quot;: &quot;A String&quot;, # 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`.
254 },
255 &quot;timeRange&quot;: { # A time range. # The time range when this inventory source starts and stops serving.
256 &quot;endTime&quot;: &quot;A String&quot;, # Required. The upper bound of a time range, inclusive.
257 &quot;startTime&quot;: &quot;A String&quot;, # Required. The lower bound of a time range, inclusive.
258 },
259 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the inventory source was last updated. Assigned by the system.
260 }</pre>
261 </div>
262
263 <div class="method">
264 <code class="details" id="editInventorySourceReadWriteAccessors">editInventorySourceReadWriteAccessors(inventorySourceId, body=None, x__xgafv=None)</code>
265 <pre>Edits read/write accessors of an inventory source. Returns the updated read_write_accessors for the inventory source.
266
267 Args:
268 inventorySourceId: string, Required. The ID of inventory source to update. (required)
269 body: object, The request body.
270 The object takes the form of:
271
272 { # Request message for InventorySourceService.EditInventorySourceReadWriteAccessors.
273 &quot;advertisersUpdate&quot;: { # 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.
274 &quot;addedAdvertisers&quot;: [ # The advertisers to add.
275 &quot;A String&quot;,
276 ],
277 &quot;removedAdvertisers&quot;: [ # The advertisers to remove.
278 &quot;A String&quot;,
279 ],
280 },
281 &quot;assignPartner&quot;: 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.
282 &quot;partnerId&quot;: &quot;A String&quot;, # Required. The partner context by which the accessors change is being made.
283 }
284
285 x__xgafv: string, V1 error format.
286 Allowed values
287 1 - v1 error format
288 2 - v2 error format
289
290 Returns:
291 An object of the form:
292
293 { # The partner or advertisers with access to the inventory source.
294 &quot;advertisers&quot;: { # The advertisers with access to the inventory source. # The advertisers with access to the inventory source. All advertisers must belong to the same partner.
295 &quot;advertiserIds&quot;: [ # The IDs of the advertisers.
296 &quot;A String&quot;,
297 ],
298 },
299 &quot;partner&quot;: { # The partner with access to the inventory source. # The partner with access to the inventory source.
300 &quot;partnerId&quot;: &quot;A String&quot;, # The ID of the partner.
301 },
302 }</pre>
303 </div>
304
305 <div class="method">
306 <code class="details" id="get">get(inventorySourceId, partnerId=None, x__xgafv=None)</code>
307 <pre>Gets an inventory source.
308
309 Args:
310 inventorySourceId: string, Required. The ID of the inventory source to fetch. (required)
311 partnerId: string, Required. The ID of the DV360 partner to which the fetched inventory source is permissioned.
312 x__xgafv: string, V1 error format.
313 Allowed values
314 1 - v1 error format
315 2 - v2 error format
316
317 Returns:
318 An object of the form:
319
320 { # An inventory source.
321 &quot;commitment&quot;: &quot;A String&quot;, # Whether the inventory source has a guaranteed or non-guaranteed delivery.
322 &quot;creativeConfigs&quot;: [ # The creative requirements of the inventory source. Not applicable for auction packages.
323 { # Creative requirements configuration for the inventory source.
324 &quot;creativeType&quot;: &quot;A String&quot;, # The type of creative that can be assigned to the inventory source. Only the following types are supported: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_VIDEO`
325 &quot;displayCreativeConfig&quot;: { # The configuration for display creatives. # The configuration for display creatives. Applicable when creative_type is `CREATIVE_TYPE_STANDARD`.
326 &quot;creativeSize&quot;: { # Dimensions. # The size requirements for display creatives that can be assigned to the inventory source.
327 &quot;heightPixels&quot;: 42, # The height in pixels.
328 &quot;widthPixels&quot;: 42, # The width in pixels.
329 },
330 },
331 &quot;videoCreativeConfig&quot;: { # The configuration for video creatives. # The configuration for video creatives. Applicable when creative_type is `CREATIVE_TYPE_VIDEO`.
332 &quot;duration&quot;: &quot;A String&quot;, # The duration requirements for the video creatives that can be assigned to the inventory source.
333 },
334 },
335 ],
336 &quot;dealId&quot;: &quot;A String&quot;, # 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.
337 &quot;deliveryMethod&quot;: &quot;A String&quot;, # 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`.
338 &quot;displayName&quot;: &quot;A String&quot;, # The display name of the inventory source. Must be UTF-8 encoded with a maximum size of 240 bytes.
339 &quot;exchange&quot;: &quot;A String&quot;, # The exchange to which the inventory source belongs.
340 &quot;guaranteedOrderId&quot;: &quot;A String&quot;, # Immutable. The ID of the guaranteed order that this inventory source belongs to. Only applicable when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`.
341 &quot;inventorySourceId&quot;: &quot;A String&quot;, # Output only. The unique ID of the inventory source. Assigned by the system.
342 &quot;inventorySourceProductType&quot;: &quot;A String&quot;, # Output only. The product type of the inventory source, denoting the way through which it sells inventory.
343 &quot;inventorySourceType&quot;: &quot;A String&quot;, # Denotes the type of the inventory source.
344 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the inventory source.
345 &quot;publisherName&quot;: &quot;A String&quot;, # The publisher/seller name of the inventory source.
346 &quot;rateDetails&quot;: { # The rate related settings of the inventory source. # Required. The rate details of the inventory source.
347 &quot;inventorySourceRateType&quot;: &quot;A String&quot;, # The rate type. Acceptable values are `INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED`, `INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR`, and `INVENTORY_SOURCE_RATE_TYPE_CPD`.
348 &quot;minimumSpend&quot;: { # 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.
349 &quot;currencyCode&quot;: &quot;A String&quot;, # The three-letter currency code defined in ISO 4217.
350 &quot;nanos&quot;: 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.
351 &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount. For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
352 },
353 &quot;rate&quot;: { # Represents an amount of money with its currency type. # The rate for the inventory source.
354 &quot;currencyCode&quot;: &quot;A String&quot;, # The three-letter currency code defined in ISO 4217.
355 &quot;nanos&quot;: 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.
356 &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount. For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
357 },
358 &quot;unitsPurchased&quot;: &quot;A String&quot;, # Required for guaranteed inventory sources. The number of impressions guaranteed by the seller.
359 },
360 &quot;readAdvertiserIds&quot;: [ # Output only. The IDs of advertisers with read-only access to the inventory source.
361 &quot;A String&quot;,
362 ],
363 &quot;readPartnerIds&quot;: [ # 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.
364 &quot;A String&quot;,
365 ],
366 &quot;readWriteAccessors&quot;: { # 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.
367 &quot;advertisers&quot;: { # The advertisers with access to the inventory source. # The advertisers with access to the inventory source. All advertisers must belong to the same partner.
368 &quot;advertiserIds&quot;: [ # The IDs of the advertisers.
369 &quot;A String&quot;,
370 ],
371 },
372 &quot;partner&quot;: { # The partner with access to the inventory source. # The partner with access to the inventory source.
373 &quot;partnerId&quot;: &quot;A String&quot;, # The ID of the partner.
374 },
375 },
376 &quot;status&quot;: { # The status related settings of the inventory source. # The status settings of the inventory source.
377 &quot;configStatus&quot;: &quot;A String&quot;, # 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.
378 &quot;entityPauseReason&quot;: &quot;A String&quot;, # 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`.
379 &quot;entityStatus&quot;: &quot;A String&quot;, # 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`.
380 &quot;sellerPauseReason&quot;: &quot;A String&quot;, # 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`.
381 &quot;sellerStatus&quot;: &quot;A String&quot;, # 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`.
382 },
383 &quot;timeRange&quot;: { # A time range. # The time range when this inventory source starts and stops serving.
384 &quot;endTime&quot;: &quot;A String&quot;, # Required. The upper bound of a time range, inclusive.
385 &quot;startTime&quot;: &quot;A String&quot;, # Required. The lower bound of a time range, inclusive.
386 },
387 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the inventory source was last updated. Assigned by the system.
388 }</pre>
389 </div>
390
391 <div class="method">
392 <code class="details" id="list">list(advertiserId=None, filter=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None)</code>
393 <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.
394
395 Args:
396 advertiserId: string, The ID of the advertiser that has access to the inventory source.
397 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=&quot;ENTITY_STATUS_ACTIVE&quot;` * Inventory sources belonging to Google Ad Manager or Rubicon exchanges: `exchange=&quot;EXCHANGE_GOOGLE_AD_MANAGER&quot; OR exchange=&quot;EXCHANGE_RUBICON&quot;` 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.
398 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 &quot;desc&quot; should be added to the field name. For example, `displayName desc`.
399 pageSize: integer, Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
400 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.
401 partnerId: string, The ID of the partner that has access to the inventory source.
402 x__xgafv: string, V1 error format.
403 Allowed values
404 1 - v1 error format
405 2 - v2 error format
406
407 Returns:
408 An object of the form:
409
410 {
411 &quot;inventorySources&quot;: [ # The list of inventory sources. This list will be absent if empty.
412 { # An inventory source.
413 &quot;commitment&quot;: &quot;A String&quot;, # Whether the inventory source has a guaranteed or non-guaranteed delivery.
414 &quot;creativeConfigs&quot;: [ # The creative requirements of the inventory source. Not applicable for auction packages.
415 { # Creative requirements configuration for the inventory source.
416 &quot;creativeType&quot;: &quot;A String&quot;, # The type of creative that can be assigned to the inventory source. Only the following types are supported: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_VIDEO`
417 &quot;displayCreativeConfig&quot;: { # The configuration for display creatives. # The configuration for display creatives. Applicable when creative_type is `CREATIVE_TYPE_STANDARD`.
418 &quot;creativeSize&quot;: { # Dimensions. # The size requirements for display creatives that can be assigned to the inventory source.
419 &quot;heightPixels&quot;: 42, # The height in pixels.
420 &quot;widthPixels&quot;: 42, # The width in pixels.
421 },
422 },
423 &quot;videoCreativeConfig&quot;: { # The configuration for video creatives. # The configuration for video creatives. Applicable when creative_type is `CREATIVE_TYPE_VIDEO`.
424 &quot;duration&quot;: &quot;A String&quot;, # The duration requirements for the video creatives that can be assigned to the inventory source.
425 },
426 },
427 ],
428 &quot;dealId&quot;: &quot;A String&quot;, # 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.
429 &quot;deliveryMethod&quot;: &quot;A String&quot;, # 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`.
430 &quot;displayName&quot;: &quot;A String&quot;, # The display name of the inventory source. Must be UTF-8 encoded with a maximum size of 240 bytes.
431 &quot;exchange&quot;: &quot;A String&quot;, # The exchange to which the inventory source belongs.
432 &quot;guaranteedOrderId&quot;: &quot;A String&quot;, # Immutable. The ID of the guaranteed order that this inventory source belongs to. Only applicable when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`.
433 &quot;inventorySourceId&quot;: &quot;A String&quot;, # Output only. The unique ID of the inventory source. Assigned by the system.
434 &quot;inventorySourceProductType&quot;: &quot;A String&quot;, # Output only. The product type of the inventory source, denoting the way through which it sells inventory.
435 &quot;inventorySourceType&quot;: &quot;A String&quot;, # Denotes the type of the inventory source.
436 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the inventory source.
437 &quot;publisherName&quot;: &quot;A String&quot;, # The publisher/seller name of the inventory source.
438 &quot;rateDetails&quot;: { # The rate related settings of the inventory source. # Required. The rate details of the inventory source.
439 &quot;inventorySourceRateType&quot;: &quot;A String&quot;, # The rate type. Acceptable values are `INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED`, `INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR`, and `INVENTORY_SOURCE_RATE_TYPE_CPD`.
440 &quot;minimumSpend&quot;: { # 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.
441 &quot;currencyCode&quot;: &quot;A String&quot;, # The three-letter currency code defined in ISO 4217.
442 &quot;nanos&quot;: 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.
443 &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount. For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
444 },
445 &quot;rate&quot;: { # Represents an amount of money with its currency type. # The rate for the inventory source.
446 &quot;currencyCode&quot;: &quot;A String&quot;, # The three-letter currency code defined in ISO 4217.
447 &quot;nanos&quot;: 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.
448 &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount. For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
449 },
450 &quot;unitsPurchased&quot;: &quot;A String&quot;, # Required for guaranteed inventory sources. The number of impressions guaranteed by the seller.
451 },
452 &quot;readAdvertiserIds&quot;: [ # Output only. The IDs of advertisers with read-only access to the inventory source.
453 &quot;A String&quot;,
454 ],
455 &quot;readPartnerIds&quot;: [ # 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.
456 &quot;A String&quot;,
457 ],
458 &quot;readWriteAccessors&quot;: { # 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.
459 &quot;advertisers&quot;: { # The advertisers with access to the inventory source. # The advertisers with access to the inventory source. All advertisers must belong to the same partner.
460 &quot;advertiserIds&quot;: [ # The IDs of the advertisers.
461 &quot;A String&quot;,
462 ],
463 },
464 &quot;partner&quot;: { # The partner with access to the inventory source. # The partner with access to the inventory source.
465 &quot;partnerId&quot;: &quot;A String&quot;, # The ID of the partner.
466 },
467 },
468 &quot;status&quot;: { # The status related settings of the inventory source. # The status settings of the inventory source.
469 &quot;configStatus&quot;: &quot;A String&quot;, # 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.
470 &quot;entityPauseReason&quot;: &quot;A String&quot;, # 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`.
471 &quot;entityStatus&quot;: &quot;A String&quot;, # 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`.
472 &quot;sellerPauseReason&quot;: &quot;A String&quot;, # 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`.
473 &quot;sellerStatus&quot;: &quot;A String&quot;, # 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`.
474 },
475 &quot;timeRange&quot;: { # A time range. # The time range when this inventory source starts and stops serving.
476 &quot;endTime&quot;: &quot;A String&quot;, # Required. The upper bound of a time range, inclusive.
477 &quot;startTime&quot;: &quot;A String&quot;, # Required. The lower bound of a time range, inclusive.
478 },
479 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the inventory source was last updated. Assigned by the system.
480 },
481 ],
482 &quot;nextPageToken&quot;: &quot;A String&quot;, # 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.
483 }</pre>
484 </div>
485
486 <div class="method">
487 <code class="details" id="list_next">list_next()</code>
488 <pre>Retrieves the next page of results.
489
490 Args:
491 previous_request: The request for the previous page. (required)
492 previous_response: The response from the request for the previous page. (required)
493
494 Returns:
495 A request object that you can call &#x27;execute()&#x27; on to request the next
496 page. Returns None if there are no more items in the collection.
497 </pre>
498 </div>
499
500 <div class="method">
501 <code class="details" id="patch">patch(inventorySourceId, advertiserId=None, body=None, partnerId=None, updateMask=None, x__xgafv=None)</code>
502 <pre>Updates an existing inventory source. Returns the updated inventory source if successful.
503
504 Args:
505 inventorySourceId: string, Output only. The unique ID of the inventory source. Assigned by the system. (required)
506 body: object, The request body.
507 The object takes the form of:
508
509 { # An inventory source.
510 &quot;commitment&quot;: &quot;A String&quot;, # Whether the inventory source has a guaranteed or non-guaranteed delivery.
511 &quot;creativeConfigs&quot;: [ # The creative requirements of the inventory source. Not applicable for auction packages.
512 { # Creative requirements configuration for the inventory source.
513 &quot;creativeType&quot;: &quot;A String&quot;, # The type of creative that can be assigned to the inventory source. Only the following types are supported: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_VIDEO`
514 &quot;displayCreativeConfig&quot;: { # The configuration for display creatives. # The configuration for display creatives. Applicable when creative_type is `CREATIVE_TYPE_STANDARD`.
515 &quot;creativeSize&quot;: { # Dimensions. # The size requirements for display creatives that can be assigned to the inventory source.
516 &quot;heightPixels&quot;: 42, # The height in pixels.
517 &quot;widthPixels&quot;: 42, # The width in pixels.
518 },
519 },
520 &quot;videoCreativeConfig&quot;: { # The configuration for video creatives. # The configuration for video creatives. Applicable when creative_type is `CREATIVE_TYPE_VIDEO`.
521 &quot;duration&quot;: &quot;A String&quot;, # The duration requirements for the video creatives that can be assigned to the inventory source.
522 },
523 },
524 ],
525 &quot;dealId&quot;: &quot;A String&quot;, # 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.
526 &quot;deliveryMethod&quot;: &quot;A String&quot;, # 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`.
527 &quot;displayName&quot;: &quot;A String&quot;, # The display name of the inventory source. Must be UTF-8 encoded with a maximum size of 240 bytes.
528 &quot;exchange&quot;: &quot;A String&quot;, # The exchange to which the inventory source belongs.
529 &quot;guaranteedOrderId&quot;: &quot;A String&quot;, # Immutable. The ID of the guaranteed order that this inventory source belongs to. Only applicable when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`.
530 &quot;inventorySourceId&quot;: &quot;A String&quot;, # Output only. The unique ID of the inventory source. Assigned by the system.
531 &quot;inventorySourceProductType&quot;: &quot;A String&quot;, # Output only. The product type of the inventory source, denoting the way through which it sells inventory.
532 &quot;inventorySourceType&quot;: &quot;A String&quot;, # Denotes the type of the inventory source.
533 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the inventory source.
534 &quot;publisherName&quot;: &quot;A String&quot;, # The publisher/seller name of the inventory source.
535 &quot;rateDetails&quot;: { # The rate related settings of the inventory source. # Required. The rate details of the inventory source.
536 &quot;inventorySourceRateType&quot;: &quot;A String&quot;, # The rate type. Acceptable values are `INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED`, `INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR`, and `INVENTORY_SOURCE_RATE_TYPE_CPD`.
537 &quot;minimumSpend&quot;: { # 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.
538 &quot;currencyCode&quot;: &quot;A String&quot;, # The three-letter currency code defined in ISO 4217.
539 &quot;nanos&quot;: 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.
540 &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount. For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
541 },
542 &quot;rate&quot;: { # Represents an amount of money with its currency type. # The rate for the inventory source.
543 &quot;currencyCode&quot;: &quot;A String&quot;, # The three-letter currency code defined in ISO 4217.
544 &quot;nanos&quot;: 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.
545 &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount. For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
546 },
547 &quot;unitsPurchased&quot;: &quot;A String&quot;, # Required for guaranteed inventory sources. The number of impressions guaranteed by the seller.
548 },
549 &quot;readAdvertiserIds&quot;: [ # Output only. The IDs of advertisers with read-only access to the inventory source.
550 &quot;A String&quot;,
551 ],
552 &quot;readPartnerIds&quot;: [ # 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.
553 &quot;A String&quot;,
554 ],
555 &quot;readWriteAccessors&quot;: { # 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.
556 &quot;advertisers&quot;: { # The advertisers with access to the inventory source. # The advertisers with access to the inventory source. All advertisers must belong to the same partner.
557 &quot;advertiserIds&quot;: [ # The IDs of the advertisers.
558 &quot;A String&quot;,
559 ],
560 },
561 &quot;partner&quot;: { # The partner with access to the inventory source. # The partner with access to the inventory source.
562 &quot;partnerId&quot;: &quot;A String&quot;, # The ID of the partner.
563 },
564 },
565 &quot;status&quot;: { # The status related settings of the inventory source. # The status settings of the inventory source.
566 &quot;configStatus&quot;: &quot;A String&quot;, # 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.
567 &quot;entityPauseReason&quot;: &quot;A String&quot;, # 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`.
568 &quot;entityStatus&quot;: &quot;A String&quot;, # 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`.
569 &quot;sellerPauseReason&quot;: &quot;A String&quot;, # 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`.
570 &quot;sellerStatus&quot;: &quot;A String&quot;, # 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`.
571 },
572 &quot;timeRange&quot;: { # A time range. # The time range when this inventory source starts and stops serving.
573 &quot;endTime&quot;: &quot;A String&quot;, # Required. The upper bound of a time range, inclusive.
574 &quot;startTime&quot;: &quot;A String&quot;, # Required. The lower bound of a time range, inclusive.
575 },
576 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the inventory source was last updated. Assigned by the system.
577 }
578
579 advertiserId: string, The ID of the advertiser that the request is being made within.
580 partnerId: string, The ID of the partner that the request is being made within.
581 updateMask: string, Required. The mask to control which fields to update.
582 x__xgafv: string, V1 error format.
583 Allowed values
584 1 - v1 error format
585 2 - v2 error format
586
587 Returns:
588 An object of the form:
589
590 { # An inventory source.
591 &quot;commitment&quot;: &quot;A String&quot;, # Whether the inventory source has a guaranteed or non-guaranteed delivery.
592 &quot;creativeConfigs&quot;: [ # The creative requirements of the inventory source. Not applicable for auction packages.
593 { # Creative requirements configuration for the inventory source.
594 &quot;creativeType&quot;: &quot;A String&quot;, # The type of creative that can be assigned to the inventory source. Only the following types are supported: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_VIDEO`
595 &quot;displayCreativeConfig&quot;: { # The configuration for display creatives. # The configuration for display creatives. Applicable when creative_type is `CREATIVE_TYPE_STANDARD`.
596 &quot;creativeSize&quot;: { # Dimensions. # The size requirements for display creatives that can be assigned to the inventory source.
597 &quot;heightPixels&quot;: 42, # The height in pixels.
598 &quot;widthPixels&quot;: 42, # The width in pixels.
599 },
600 },
601 &quot;videoCreativeConfig&quot;: { # The configuration for video creatives. # The configuration for video creatives. Applicable when creative_type is `CREATIVE_TYPE_VIDEO`.
602 &quot;duration&quot;: &quot;A String&quot;, # The duration requirements for the video creatives that can be assigned to the inventory source.
603 },
604 },
605 ],
606 &quot;dealId&quot;: &quot;A String&quot;, # 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.
607 &quot;deliveryMethod&quot;: &quot;A String&quot;, # 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`.
608 &quot;displayName&quot;: &quot;A String&quot;, # The display name of the inventory source. Must be UTF-8 encoded with a maximum size of 240 bytes.
609 &quot;exchange&quot;: &quot;A String&quot;, # The exchange to which the inventory source belongs.
610 &quot;guaranteedOrderId&quot;: &quot;A String&quot;, # Immutable. The ID of the guaranteed order that this inventory source belongs to. Only applicable when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`.
611 &quot;inventorySourceId&quot;: &quot;A String&quot;, # Output only. The unique ID of the inventory source. Assigned by the system.
612 &quot;inventorySourceProductType&quot;: &quot;A String&quot;, # Output only. The product type of the inventory source, denoting the way through which it sells inventory.
613 &quot;inventorySourceType&quot;: &quot;A String&quot;, # Denotes the type of the inventory source.
614 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the inventory source.
615 &quot;publisherName&quot;: &quot;A String&quot;, # The publisher/seller name of the inventory source.
616 &quot;rateDetails&quot;: { # The rate related settings of the inventory source. # Required. The rate details of the inventory source.
617 &quot;inventorySourceRateType&quot;: &quot;A String&quot;, # The rate type. Acceptable values are `INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED`, `INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR`, and `INVENTORY_SOURCE_RATE_TYPE_CPD`.
618 &quot;minimumSpend&quot;: { # 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.
619 &quot;currencyCode&quot;: &quot;A String&quot;, # The three-letter currency code defined in ISO 4217.
620 &quot;nanos&quot;: 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.
621 &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount. For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
622 },
623 &quot;rate&quot;: { # Represents an amount of money with its currency type. # The rate for the inventory source.
624 &quot;currencyCode&quot;: &quot;A String&quot;, # The three-letter currency code defined in ISO 4217.
625 &quot;nanos&quot;: 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.
626 &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount. For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
627 },
628 &quot;unitsPurchased&quot;: &quot;A String&quot;, # Required for guaranteed inventory sources. The number of impressions guaranteed by the seller.
629 },
630 &quot;readAdvertiserIds&quot;: [ # Output only. The IDs of advertisers with read-only access to the inventory source.
631 &quot;A String&quot;,
632 ],
633 &quot;readPartnerIds&quot;: [ # 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.
634 &quot;A String&quot;,
635 ],
636 &quot;readWriteAccessors&quot;: { # 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.
637 &quot;advertisers&quot;: { # The advertisers with access to the inventory source. # The advertisers with access to the inventory source. All advertisers must belong to the same partner.
638 &quot;advertiserIds&quot;: [ # The IDs of the advertisers.
639 &quot;A String&quot;,
640 ],
641 },
642 &quot;partner&quot;: { # The partner with access to the inventory source. # The partner with access to the inventory source.
643 &quot;partnerId&quot;: &quot;A String&quot;, # The ID of the partner.
644 },
645 },
646 &quot;status&quot;: { # The status related settings of the inventory source. # The status settings of the inventory source.
647 &quot;configStatus&quot;: &quot;A String&quot;, # 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.
648 &quot;entityPauseReason&quot;: &quot;A String&quot;, # 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`.
649 &quot;entityStatus&quot;: &quot;A String&quot;, # 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`.
650 &quot;sellerPauseReason&quot;: &quot;A String&quot;, # 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`.
651 &quot;sellerStatus&quot;: &quot;A String&quot;, # 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`.
652 },
653 &quot;timeRange&quot;: { # A time range. # The time range when this inventory source starts and stops serving.
654 &quot;endTime&quot;: &quot;A String&quot;, # Required. The upper bound of a time range, inclusive.
655 &quot;startTime&quot;: &quot;A String&quot;, # Required. The lower bound of a time range, inclusive.
656 },
657 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the inventory source was last updated. Assigned by the system.
658 }</pre>
659 </div>
660
661 </body></html>