Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / adexchangebuyer2_v2beta1.accounts.proposals.html
blob: 867343fc7748c13264ca7513bb04ac635ab679ef [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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="adexchangebuyer2_v2beta1.html">Ad Exchange Buyer API II</a> . <a href="adexchangebuyer2_v2beta1.accounts.html">accounts</a> . <a href="adexchangebuyer2_v2beta1.accounts.proposals.html">proposals</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]78 <code><a href="#accept">accept(accountId, proposalId, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]79<p class="firstline">Mark the proposal as accepted at the given revision number. If the number</p>
80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]81 <code><a href="#addNote">addNote(accountId, proposalId, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]82<p class="firstline">Create a new note and attach it to the proposal. The note is assigned</p>
83<p class="toc_element">
84 <code><a href="#cancelNegotiation">cancelNegotiation(accountId, proposalId, body=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Cancel an ongoing negotiation on a proposal. This does not cancel or end</p>
86<p class="toc_element">
87 <code><a href="#completeSetup">completeSetup(accountId, proposalId, body=None, x__xgafv=None)</a></code></p>
88<p class="firstline">Update the given proposal to indicate that setup has been completed.</p>
89<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]90 <code><a href="#create">create(accountId, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]91<p class="firstline">Create the given proposal. Each created proposal and any deals it contains</p>
92<p class="toc_element">
93 <code><a href="#get">get(accountId, proposalId, x__xgafv=None)</a></code></p>
94<p class="firstline">Gets a proposal given its ID. The proposal is returned at its head</p>
95<p class="toc_element">
96 <code><a href="#list">list(accountId, pageSize=None, pageToken=None, x__xgafv=None, filterSyntax=None, filter=None)</a></code></p>
97<p class="firstline">List proposals. A filter expression (PQL query) may be specified to</p>
98<p class="toc_element">
99 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
100<p class="firstline">Retrieves the next page of results.</p>
101<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]102 <code><a href="#pause">pause(accountId, proposalId, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]103<p class="firstline">Update the given proposal to pause serving.</p>
104<p class="toc_element">
105 <code><a href="#resume">resume(accountId, proposalId, body=None, x__xgafv=None)</a></code></p>
106<p class="firstline">Update the given proposal to resume serving.</p>
107<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]108 <code><a href="#update">update(accountId, proposalId, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]109<p class="firstline">Update the given proposal at the client known revision number. If the</p>
110<h3>Method Details</h3>
111<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]112 <code class="details" id="accept">accept(accountId, proposalId, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]113 <pre>Mark the proposal as accepted at the given revision number. If the number
114does not match the server's revision number an `ABORTED` error message will
115be returned. This call updates the proposal_state from `PROPOSED` to
116`BUYER_ACCEPTED`, or from `SELLER_ACCEPTED` to `FINALIZED`.
117
118Args:
119 accountId: string, Account ID of the buyer. (required)
120 proposalId: string, The ID of the proposal to accept. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]121 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]122 The object takes the form of:
123
124{ # Request to accept a proposal.
125 "proposalRevision": "A String", # The last known client revision number of the proposal.
126 }
127
128 x__xgafv: string, V1 error format.
129 Allowed values
130 1 - v1 error format
131 2 - v2 error format
132
133Returns:
134 An object of the form:
135
136 { # Note: this resource requires whitelisting for access. Please contact your
137 # account manager for access to Marketplace resources.
138 #
139 # Represents a proposal in the Marketplace. A proposal is the unit of
140 # negotiation between a seller and a buyer and contains deals which
141 # are served.
142 #
143 # Note: you can not update, create, or otherwise modify Private
144 # Auction or Preferred Deals deals through the API.
145 #
146 # Fields are updatable unless noted otherwise.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]147 "deals": [ # The deals associated with this proposal. For Private Auction proposals
148 # (whose deals have NonGuaranteedAuctionTerms), there will only be one deal.
149 { # A deal represents a segment of inventory for displaying ads on.
150 # A proposal can contain multiple deals. A deal contains the terms and
151 # targeting information that is used for serving.
152 "updateTime": "A String", # Output only. The time when the deal was last updated.
153 "createProductRevision": "A String", # Optional revision number of the product that the deal was created from.
154 # If present on create, and the server `product_revision` has advanced sinced
155 # the passed-in `create_product_revision`, an `ABORTED` error will be
156 # returned.
157 #
158 # Note: This field may be set only when creating the resource. Modifying
159 # this field while updating the resource will result in an error.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]160 "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals.
161 # PUBLISHER means creative is provided by seller and ADVERTISER means
162 # creative is provided by buyer.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]163 "availableStartTime": "A String", # Optional proposed flight start time of the deal.
164 # This will generally be stored in the granularity of one second since deal
165 # serving starts at seconds boundary. Any time specified with more
166 # granularity (e.g., in milliseconds) will be truncated towards the start of
167 # time in seconds.
168 "availableEndTime": "A String", # Proposed flight end time of the deal.
169 # This will generally be stored in a granularity of a second.
170 # A value is not required for Private Auction deals or Preferred Deals.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]171 "externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is
172 # finalized. This is the deal ID that shows up in serving/reporting etc.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]173 "targeting": { # Targeting represents different criteria that can be used by advertisers to # Output only. Specifies the subset of inventory targeted by the deal.
174 # target ad inventory. For example, they can choose to target ad requests only
175 # if the user is in the US.
176 # Multiple types of targeting are always applied as a logical AND, unless noted
177 # otherwise.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]178 "placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or # Placement targeting information, e.g., URL, mobile applications.
179 # mobile applications.
180 # Different placement targeting types will be logically OR'ed.
181 "urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). # URLs to be included/excluded.
182 # For Private Auction and AdX Preferred Deals, URLs are either included or
183 # excluded.
184 # For Programmatic Guaranteed and Preferred Deals, this doesn't
185 # apply.
186 "excludedUrls": [ # A list of URLs to be excluded.
187 "A String",
188 ],
189 "targetedUrls": [ # A list of URLs to be included.
190 "A String",
191 ],
192 },
193 "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal.
194 # This doesn't apply to Auction Packages.
195 "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that # Publisher owned apps to be targeted or excluded by the publisher to
196 # display the ads in.
197 # publishers own.
198 # Mobile application IDs are from App Store and Google Play Store.
199 # Android App ID, for example, com.google.android.apps.maps, can be found in
200 # Google Play Store URL.
201 # iOS App ID (which is a number) can be found at the end of iTunes store URL.
202 # First party mobile applications is either included or excluded.
203 "excludedAppIds": [ # A list of application IDs to be excluded.
204 "A String",
205 ],
206 "targetedAppIds": [ # A list of application IDs to be included.
207 "A String",
208 ],
209 },
210 },
211 },
212 "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of # Geo criteria IDs to be included/excluded.
213 # included and excluded numeric IDs.
214 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
215 "A String",
216 ],
217 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
218 "A String",
219 ],
220 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]221 "videoTargeting": { # Represents targeting information about video. # Video targeting information.
222 "excludedPositionTypes": [ # A list of video positions to be excluded.
223 # Position types can either be included or excluded (XOR).
224 "A String",
225 ],
226 "targetedPositionTypes": [ # A list of video positions to be included.
227 # When the included list is present, the excluded list must be empty.
228 # When the excluded list is present, the included list must be empty.
229 "A String",
230 ],
231 },
232 "technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category.
233 "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device categories to be included/excluded.
234 # included and excluded numeric IDs.
235 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
236 "A String",
237 ],
238 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
239 "A String",
240 ],
241 },
242 "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
243 "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating systems to be included/excluded.
244 # included and excluded numeric IDs.
245 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
246 "A String",
247 ],
248 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
249 "A String",
250 ],
251 },
252 "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating system versions to be included/excluded.
253 # included and excluded numeric IDs.
254 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
255 "A String",
256 ],
257 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
258 "A String",
259 ],
260 },
261 },
262 "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device capabilities to be included/excluded.
263 # included and excluded numeric IDs.
264 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
265 "A String",
266 ],
267 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
268 "A String",
269 ],
270 },
271 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]272 "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on an ad # Inventory sizes to be included/excluded.
273 # request. It only applies to Private Auction, AdX Preferred Deals and
274 # Auction Packages. This targeting does not apply to Programmatic Guaranteed
275 # and Preferred Deals in Ad Manager.
276 "targetedInventorySizes": [ # A list of inventory sizes to be included.
277 { # Represents size of a single ad slot, or a creative.
278 "width": "A String", # The width of the ad slot in pixels.
279 # This field will be present only when size type is `PIXEL`.
280 "sizeType": "A String", # The size type of the ad slot.
281 "height": "A String", # The height of the ad slot in pixels.
282 # This field will be present only when size type is `PIXEL`.
283 },
284 ],
285 "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
286 { # Represents size of a single ad slot, or a creative.
287 "width": "A String", # The width of the ad slot in pixels.
288 # This field will be present only when size type is `PIXEL`.
289 "sizeType": "A String", # The size type of the ad slot.
290 "height": "A String", # The height of the ad slot in pixels.
291 # This field will be present only when size type is `PIXEL`.
292 },
293 ],
294 },
295 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]296 "createTime": "A String", # Output only. The time of the deal creation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]297 "webPropertyCode": "A String", # The web property code for the seller copied over from the product.
298 "proposalId": "A String", # Output only. ID of the proposal that this deal is part of.
299 "deliveryControl": { # Message contains details about how the deals will be paced. # The set of fields around delivery control that are interesting for a buyer
300 # to see but are non-negotiable. These are set by the publisher.
301 "frequencyCaps": [ # Output only. Specifies any frequency caps.
302 { # Frequency cap.
303 "numTimeUnits": 42, # The amount of time, in the units specified by time_unit_type. Defines the
304 # amount of time over which impressions per user are counted and capped.
305 "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over
306 # which impressions per user are counted and capped.
307 "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the
308 # specified time period.
309 },
310 ],
311 "creativeBlockingLevel": "A String", # Output only. Specified the creative blocking levels to be applied.
312 "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
313 },
314 "description": "A String", # Description for the deal terms.
315 "dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned).
316 "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
317 "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]318 "creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ # Output only. Restricitions about the creatives associated with the deal
319 # (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals
320 # in Ad Manager.
321 # Preferred Deal in Ad Manager.
322 # This doesn't apply to Private Auction and AdX Preferred Deals.
323 "creativeFormat": "A String", # The format of the environment that the creatives will be displayed in.
324 "creativeSpecifications": [
325 { # Represents information for a creative that is associated with a Programmatic
326 # Guaranteed/Preferred Deal in Ad Manager.
327 "creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative.
328 "width": "A String", # The width of the ad slot in pixels.
329 # This field will be present only when size type is `PIXEL`.
330 "sizeType": "A String", # The size type of the ad slot.
331 "height": "A String", # The height of the ad slot in pixels.
332 # This field will be present only when size type is `PIXEL`.
333 },
334 "creativeCompanionSizes": [ # Companion sizes may be filled in only when this is a video creative.
335 { # Represents size of a single ad slot, or a creative.
336 "width": "A String", # The width of the ad slot in pixels.
337 # This field will be present only when size type is `PIXEL`.
338 "sizeType": "A String", # The size type of the ad slot.
339 "height": "A String", # The height of the ad slot in pixels.
340 # This field will be present only when size type is `PIXEL`.
341 },
342 ],
343 },
344 ],
345 "skippableAdType": "A String", # Skippable video ads allow viewers to skip ads after 5 seconds.
346 },
347 "createProductId": "A String", # The product ID from which this deal was created.
348 #
349 # Note: This field may be set only when creating the resource. Modifying
350 # this field while updating the resource will result in an error.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]351 "dealTerms": { # The deal terms specify the details of a Product/deal. They specify things # The negotiable terms of the deal.
352 # like price per buyer, the type of pricing model (e.g., fixed price, auction)
353 # and expected impressions from the publisher.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]354 "brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED)
355 "estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal.
356 # Can be set by buyer or seller.
357 "pricingType": "A String", # The pricing type for the deal/product. (default: CPM)
358 "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
359 "nanos": 42, # Number of nano (10^-9) units of the amount.
360 # The value must be between -999,999,999 and +999,999,999 inclusive.
361 # If `units` is positive, `nanos` must be positive or zero.
362 # If `units` is zero, `nanos` can be positive, zero, or negative.
363 # If `units` is negative, `nanos` must be negative or zero.
364 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
365 "units": "A String", # The whole units of the amount.
366 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
367 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
368 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]369 },
370 "sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the
371 # time zone used to mark the boundaries of a day. It should be an
372 # IANA TZ name, such as "America/Los_Angeles". For more information,
373 # see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.
374 "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day.
375 # Can be set by buyer or seller.
376 "nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via # The terms for non-guaranteed fixed price deals.
377 # the API at this time, but can be returned in a get or list request.
378 "fixedPrices": [ # Fixed price for the specified buyer.
379 { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in
380 # a product can become 0 or 1 deals. To check if there is a PricePerBuyer for
381 # a particular buyer or buyer/advertiser pair, we look for the most specific
382 # matching rule - we first look for a rule matching the buyer and advertiser,
383 # next a rule with the buyer but an empty advertiser list, and otherwise look
384 # for a matching rule where no buyer is set.
385 "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # The buyer who will pay this price. If unset, all buyers can pay this price
386 # (if the
387 # advertisers match, and there's no more specific rule matching the buyer).
388 # Authorized Buyers account ID.
389 "accountId": "A String", # Authorized Buyers account ID of the buyer.
390 },
391 "advertiserIds": [ # The list of advertisers for this price when associated with this buyer.
392 # If empty, all advertisers with this buyer pay this price.
393 "A String",
394 ],
395 "price": { # Represents a price and a pricing type for a product / deal. # The specified price.
396 "pricingType": "A String", # The pricing type for the deal/product. (default: CPM)
397 "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
398 "nanos": 42, # Number of nano (10^-9) units of the amount.
399 # The value must be between -999,999,999 and +999,999,999 inclusive.
400 # If `units` is positive, `nanos` must be positive or zero.
401 # If `units` is zero, `nanos` can be positive, zero, or negative.
402 # If `units` is negative, `nanos` must be negative or zero.
403 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
404 "units": "A String", # The whole units of the amount.
405 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
406 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
407 },
408 },
409 },
410 ],
411 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]412 "guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals.
413 "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage
414 # of guaranteed looks that the buyer is guaranteeing to buy.
415 "fixedPrices": [ # Fixed price for the specified buyer.
416 { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in
417 # a product can become 0 or 1 deals. To check if there is a PricePerBuyer for
418 # a particular buyer or buyer/advertiser pair, we look for the most specific
419 # matching rule - we first look for a rule matching the buyer and advertiser,
420 # next a rule with the buyer but an empty advertiser list, and otherwise look
421 # for a matching rule where no buyer is set.
422 "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # The buyer who will pay this price. If unset, all buyers can pay this price
423 # (if the
424 # advertisers match, and there's no more specific rule matching the buyer).
425 # Authorized Buyers account ID.
426 "accountId": "A String", # Authorized Buyers account ID of the buyer.
427 },
428 "advertiserIds": [ # The list of advertisers for this price when associated with this buyer.
429 # If empty, all advertisers with this buyer pay this price.
430 "A String",
431 ],
432 "price": { # Represents a price and a pricing type for a product / deal. # The specified price.
433 "pricingType": "A String", # The pricing type for the deal/product. (default: CPM)
434 "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
435 "nanos": 42, # Number of nano (10^-9) units of the amount.
436 # The value must be between -999,999,999 and +999,999,999 inclusive.
437 # If `units` is positive, `nanos` must be positive or zero.
438 # If `units` is zero, `nanos` can be positive, zero, or negative.
439 # If `units` is negative, `nanos` must be negative or zero.
440 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
441 "units": "A String", # The whole units of the amount.
442 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
443 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
444 },
445 },
446 },
447 ],
448 "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.
449 "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]450 },
451 "nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only # The terms for non-guaranteed auction deals.
452 # by the seller, but they can be returned in a get or list request.
453 "reservePricesPerBuyer": [ # Reserve price for the specified buyer.
454 { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in
455 # a product can become 0 or 1 deals. To check if there is a PricePerBuyer for
456 # a particular buyer or buyer/advertiser pair, we look for the most specific
457 # matching rule - we first look for a rule matching the buyer and advertiser,
458 # next a rule with the buyer but an empty advertiser list, and otherwise look
459 # for a matching rule where no buyer is set.
460 "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # The buyer who will pay this price. If unset, all buyers can pay this price
461 # (if the
462 # advertisers match, and there's no more specific rule matching the buyer).
463 # Authorized Buyers account ID.
464 "accountId": "A String", # Authorized Buyers account ID of the buyer.
465 },
466 "advertiserIds": [ # The list of advertisers for this price when associated with this buyer.
467 # If empty, all advertisers with this buyer pay this price.
468 "A String",
469 ],
470 "price": { # Represents a price and a pricing type for a product / deal. # The specified price.
471 "pricingType": "A String", # The pricing type for the deal/product. (default: CPM)
472 "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
473 "nanos": 42, # Number of nano (10^-9) units of the amount.
474 # The value must be between -999,999,999 and +999,999,999 inclusive.
475 # If `units` is positive, `nanos` must be positive or zero.
476 # If `units` is zero, `nanos` can be positive, zero, or negative.
477 # If `units` is negative, `nanos` must be negative or zero.
478 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
479 "units": "A String", # The whole units of the amount.
480 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
481 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
482 },
483 },
484 },
485 ],
486 "autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers
487 # in this private auction.
488 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]489 "description": "A String", # Publisher provided description for the terms.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]490 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]491 "sellerContacts": [ # Output only. Seller contact information for the deal.
492 { # Contains information on how a buyer or seller can be reached.
493 "email": "A String", # Email address for the contact.
494 "name": "A String", # The name of the contact.
495 },
496 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]497 "displayName": "A String", # The name of the deal.
498 "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller).
499 "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list
500 # operations (max-length: 1024 unicode code units).
501 },
502 "syndicationProduct": "A String", # The syndication product associated with the deal.
503 #
504 # Note: This field may be set only when creating the resource. Modifying
505 # this field while updating the resource will result in an error.
506 "targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared
507 # targeting entity is AND'd together.
508 { # Advertisers can target different attributes of an ad slot. For example,
509 # they can choose to show ads only if the user is in the U.S. Such
510 # targeting criteria can be specified as part of Shared Targeting.
511 "inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd
512 # together.
513 { # A polymorphic targeting value used as part of Shared Targeting.
514 "stringValue": "A String", # The string value to include/exclude.
515 "longValue": "A String", # The long value to include/exclude.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]516 "dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.
517 # Filled in when the key is GOOG_DAYPART_TARGETING.
518 # The definition of this targeting is derived from the structure
519 # used by Ad Manager.
520 "dayParts": [ # A list of day part targeting criterion.
521 { # Daypart targeting message that specifies if the ad can be shown
522 # only during certain parts of a day/week.
523 "dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.
524 "endTime": { # Represents a time of day. The date and time zone are either not significant # The ending time of the day for the ad to show (minute level
525 # granularity). The end time is exclusive. This field is not available
526 # for filtering in PQL queries.
527 # or are specified elsewhere. An API may choose to allow leap seconds. Related
528 # types are google.type.Date and `google.protobuf.Timestamp`.
529 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
530 # to allow the value "24:00:00" for scenarios like business closing time.
531 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
532 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
533 # allow the value 60 if it allows leap-seconds.
534 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
535 },
536 "startTime": { # Represents a time of day. The date and time zone are either not significant # The starting time of day for the ad to show (minute level granularity).
537 # The start time is inclusive.
538 # This field is not available for filtering in PQL queries.
539 # or are specified elsewhere. An API may choose to allow leap seconds. Related
540 # types are google.type.Date and `google.protobuf.Timestamp`.
541 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
542 # to allow the value "24:00:00" for scenarios like business closing time.
543 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
544 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
545 # allow the value 60 if it allows leap-seconds.
546 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
547 },
548 },
549 ],
550 "timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.
551 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]552 "creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.
553 # Filled in when key = GOOG_CREATIVE_SIZE
554 "companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).
555 # Companion sizes may be filled in only when creative_size_type = VIDEO
556 { # Message depicting the size of the creative. The units of width and
557 # height depend on the type of the targeting.
558 "width": 42, # The width of the creative
559 "height": 42, # The height of the creative.
560 },
561 ],
562 "nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value
563 # only if creative_size_type = CreativeSizeType.NATIVE.
564 "allowedFormats": [ # What formats are allowed by the publisher.
565 # If this repeated field is empty then all formats are allowed.
566 # For example, if this field contains AllowedFormatType.AUDIO then the
567 # publisher only allows an audio ad (without any video).
568 "A String",
569 ],
570 "skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if
571 # creative_size_type = CreativeSizeType.VIDEO.
572 "creativeSizeType": "A String", # The creative size type.
573 "size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size
574 # of the creative
575 # height depend on the type of the targeting.
576 "width": 42, # The width of the creative
577 "height": 42, # The height of the creative.
578 },
579 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]580 },
581 ],
582 "exclusions": [ # The list of values to exclude from targeting. Each value is AND'd
583 # together.
584 { # A polymorphic targeting value used as part of Shared Targeting.
585 "stringValue": "A String", # The string value to include/exclude.
586 "longValue": "A String", # The long value to include/exclude.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]587 "dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.
588 # Filled in when the key is GOOG_DAYPART_TARGETING.
589 # The definition of this targeting is derived from the structure
590 # used by Ad Manager.
591 "dayParts": [ # A list of day part targeting criterion.
592 { # Daypart targeting message that specifies if the ad can be shown
593 # only during certain parts of a day/week.
594 "dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.
595 "endTime": { # Represents a time of day. The date and time zone are either not significant # The ending time of the day for the ad to show (minute level
596 # granularity). The end time is exclusive. This field is not available
597 # for filtering in PQL queries.
598 # or are specified elsewhere. An API may choose to allow leap seconds. Related
599 # types are google.type.Date and `google.protobuf.Timestamp`.
600 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
601 # to allow the value "24:00:00" for scenarios like business closing time.
602 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
603 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
604 # allow the value 60 if it allows leap-seconds.
605 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
606 },
607 "startTime": { # Represents a time of day. The date and time zone are either not significant # The starting time of day for the ad to show (minute level granularity).
608 # The start time is inclusive.
609 # This field is not available for filtering in PQL queries.
610 # or are specified elsewhere. An API may choose to allow leap seconds. Related
611 # types are google.type.Date and `google.protobuf.Timestamp`.
612 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
613 # to allow the value "24:00:00" for scenarios like business closing time.
614 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
615 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
616 # allow the value 60 if it allows leap-seconds.
617 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
618 },
619 },
620 ],
621 "timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.
622 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]623 "creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.
624 # Filled in when key = GOOG_CREATIVE_SIZE
625 "companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).
626 # Companion sizes may be filled in only when creative_size_type = VIDEO
627 { # Message depicting the size of the creative. The units of width and
628 # height depend on the type of the targeting.
629 "width": 42, # The width of the creative
630 "height": 42, # The height of the creative.
631 },
632 ],
633 "nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value
634 # only if creative_size_type = CreativeSizeType.NATIVE.
635 "allowedFormats": [ # What formats are allowed by the publisher.
636 # If this repeated field is empty then all formats are allowed.
637 # For example, if this field contains AllowedFormatType.AUDIO then the
638 # publisher only allows an audio ad (without any video).
639 "A String",
640 ],
641 "skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if
642 # creative_size_type = CreativeSizeType.VIDEO.
643 "creativeSizeType": "A String", # The creative size type.
644 "size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size
645 # of the creative
646 # height depend on the type of the targeting.
647 "width": 42, # The width of the creative
648 "height": 42, # The height of the creative.
649 },
650 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]651 },
652 ],
653 "key": "A String", # The key representing the shared targeting criterion.
654 # Targeting criteria defined by Google ad servers will begin with GOOG_.
655 # Third parties may define their own keys.
656 # A list of permissible keys along with the acceptable values will be
657 # provided as part of the external documentation.
658 },
659 ],
660 "dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal.
661 "dealPauseStatus": { # Tracks which parties (if any) have paused a deal. # Output only. Tracks which parties (if any) have paused a deal.
662 # The deal is considered paused if either hasBuyerPaused or
663 # hasSellPaused is true.
664 "hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally.
665 "buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal.
666 "sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal.
667 "hasBuyerPaused": True or False, # True, if the buyer has paused the deal unilaterally.
668 "firstPausedBy": "A String", # The role of the person who first paused this deal.
669 },
670 },
671 "isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this
672 # deal.
673 },
674 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]675 "updateTime": "A String", # Output only. The time when the proposal was last revised.
676 "proposalState": "A String", # Output only. The current state of the proposal.
677 "proposalRevision": "A String", # Output only. The revision number for the proposal.
678 # Each update to the proposal or the deal causes the proposal revision number
679 # to auto-increment. The buyer keeps track of the last revision number they
680 # know of and pass it in when making an update. If the head revision number
681 # on the server has since incremented, then an ABORTED error is returned
682 # during the update operation to let the buyer know that a subsequent update
683 # was made.
684 "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller).
685 "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list
686 # operations (max-length: 1024 unicode code units).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]687 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]688 "privateAuctionId": "A String", # Output only. Private auction ID if this proposal is a private auction
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]689 # proposal.
690 "notes": [ # Output only. The notes associated with this proposal.
691 { # A proposal may be associated to several notes.
692 "note": "A String", # The actual note to attach.
693 # (max-length: 1024 unicode code units)
694 #
695 # Note: This field may be set only when creating the resource. Modifying
696 # this field while updating the resource will result in an error.
697 "creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note.
698 "proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created.
699 "createTime": "A String", # Output only. The timestamp for when this note was created.
700 "noteId": "A String", # Output only. The unique ID for the note.
701 },
702 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]703 "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.
704 "billedBuyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Output only. Reference to the buyer that will get billed for this proposal.
705 # Authorized Buyers account ID.
706 "accountId": "A String", # Authorized Buyers account ID of the buyer.
707 },
708 "seller": { # Represents a seller of inventory. Each seller is identified by a unique # Reference to the seller on the proposal.
709 #
710 # Note: This field may be set only when creating the resource. Modifying
711 # this field while updating the resource will result in an error.
712 # Ad Manager account ID.
713 "subAccountId": "A String", # Optional sub-account ID for the seller.
714 "accountId": "A String", # The unique ID for the seller. The seller fills in this field.
715 # The seller account ID is then available to buyer in the product.
716 },
717 "sellerContacts": [ # Output only. Contact information for the seller.
718 { # Contains information on how a buyer or seller can be reached.
719 "email": "A String", # Email address for the contact.
720 "name": "A String", # The name of the contact.
721 },
722 ],
723 "proposalId": "A String", # Output only. The unique ID of the proposal.
724 "isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated.
725 "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Reference to the buyer on the proposal.
726 #
727 # Note: This field may be set only when creating the resource. Modifying
728 # this field while updating the resource will result in an error.
729 # Authorized Buyers account ID.
730 "accountId": "A String", # Authorized Buyers account ID of the buyer.
731 },
732 "isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this
733 # proposal.
734 "displayName": "A String", # The name for the proposal.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]735 "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or
736 # left a comment.
737 "buyerContacts": [ # Contact information for the buyer.
738 { # Contains information on how a buyer or seller can be reached.
739 "email": "A String", # Email address for the contact.
740 "name": "A String", # The name of the contact.
741 },
742 ],
743 }</pre>
744</div>
745
746<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]747 <code class="details" id="addNote">addNote(accountId, proposalId, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]748 <pre>Create a new note and attach it to the proposal. The note is assigned
749a unique ID by the server.
750The proposal revision number will not increase when associated with a
751new note.
752
753Args:
754 accountId: string, Account ID of the buyer. (required)
755 proposalId: string, The ID of the proposal to attach the note to. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]756 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]757 The object takes the form of:
758
759{ # Request message for adding a note to a given proposal.
760 "note": { # A proposal may be associated to several notes. # Details of the note to add.
761 "note": "A String", # The actual note to attach.
762 # (max-length: 1024 unicode code units)
763 #
764 # Note: This field may be set only when creating the resource. Modifying
765 # this field while updating the resource will result in an error.
766 "creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note.
767 "proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created.
768 "createTime": "A String", # Output only. The timestamp for when this note was created.
769 "noteId": "A String", # Output only. The unique ID for the note.
770 },
771 }
772
773 x__xgafv: string, V1 error format.
774 Allowed values
775 1 - v1 error format
776 2 - v2 error format
777
778Returns:
779 An object of the form:
780
781 { # A proposal may be associated to several notes.
782 "note": "A String", # The actual note to attach.
783 # (max-length: 1024 unicode code units)
784 #
785 # Note: This field may be set only when creating the resource. Modifying
786 # this field while updating the resource will result in an error.
787 "creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note.
788 "proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created.
789 "createTime": "A String", # Output only. The timestamp for when this note was created.
790 "noteId": "A String", # Output only. The unique ID for the note.
791 }</pre>
792</div>
793
794<div class="method">
795 <code class="details" id="cancelNegotiation">cancelNegotiation(accountId, proposalId, body=None, x__xgafv=None)</code>
796 <pre>Cancel an ongoing negotiation on a proposal. This does not cancel or end
797serving for the deals if the proposal has been finalized, but only cancels
798a negotiation unilaterally.
799
800Args:
801 accountId: string, Account ID of the buyer. (required)
802 proposalId: string, The ID of the proposal to cancel negotiation for. (required)
803 body: object, The request body.
804 The object takes the form of:
805
806{ # Request to cancel an ongoing negotiation.
807 }
808
809 x__xgafv: string, V1 error format.
810 Allowed values
811 1 - v1 error format
812 2 - v2 error format
813
814Returns:
815 An object of the form:
816
817 { # Note: this resource requires whitelisting for access. Please contact your
818 # account manager for access to Marketplace resources.
819 #
820 # Represents a proposal in the Marketplace. A proposal is the unit of
821 # negotiation between a seller and a buyer and contains deals which
822 # are served.
823 #
824 # Note: you can not update, create, or otherwise modify Private
825 # Auction or Preferred Deals deals through the API.
826 #
827 # Fields are updatable unless noted otherwise.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]828 "deals": [ # The deals associated with this proposal. For Private Auction proposals
829 # (whose deals have NonGuaranteedAuctionTerms), there will only be one deal.
830 { # A deal represents a segment of inventory for displaying ads on.
831 # A proposal can contain multiple deals. A deal contains the terms and
832 # targeting information that is used for serving.
833 "updateTime": "A String", # Output only. The time when the deal was last updated.
834 "createProductRevision": "A String", # Optional revision number of the product that the deal was created from.
835 # If present on create, and the server `product_revision` has advanced sinced
836 # the passed-in `create_product_revision`, an `ABORTED` error will be
837 # returned.
838 #
839 # Note: This field may be set only when creating the resource. Modifying
840 # this field while updating the resource will result in an error.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]841 "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals.
842 # PUBLISHER means creative is provided by seller and ADVERTISER means
843 # creative is provided by buyer.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]844 "availableStartTime": "A String", # Optional proposed flight start time of the deal.
845 # This will generally be stored in the granularity of one second since deal
846 # serving starts at seconds boundary. Any time specified with more
847 # granularity (e.g., in milliseconds) will be truncated towards the start of
848 # time in seconds.
849 "availableEndTime": "A String", # Proposed flight end time of the deal.
850 # This will generally be stored in a granularity of a second.
851 # A value is not required for Private Auction deals or Preferred Deals.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]852 "externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is
853 # finalized. This is the deal ID that shows up in serving/reporting etc.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]854 "targeting": { # Targeting represents different criteria that can be used by advertisers to # Output only. Specifies the subset of inventory targeted by the deal.
855 # target ad inventory. For example, they can choose to target ad requests only
856 # if the user is in the US.
857 # Multiple types of targeting are always applied as a logical AND, unless noted
858 # otherwise.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]859 "placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or # Placement targeting information, e.g., URL, mobile applications.
860 # mobile applications.
861 # Different placement targeting types will be logically OR'ed.
862 "urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). # URLs to be included/excluded.
863 # For Private Auction and AdX Preferred Deals, URLs are either included or
864 # excluded.
865 # For Programmatic Guaranteed and Preferred Deals, this doesn't
866 # apply.
867 "excludedUrls": [ # A list of URLs to be excluded.
868 "A String",
869 ],
870 "targetedUrls": [ # A list of URLs to be included.
871 "A String",
872 ],
873 },
874 "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal.
875 # This doesn't apply to Auction Packages.
876 "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that # Publisher owned apps to be targeted or excluded by the publisher to
877 # display the ads in.
878 # publishers own.
879 # Mobile application IDs are from App Store and Google Play Store.
880 # Android App ID, for example, com.google.android.apps.maps, can be found in
881 # Google Play Store URL.
882 # iOS App ID (which is a number) can be found at the end of iTunes store URL.
883 # First party mobile applications is either included or excluded.
884 "excludedAppIds": [ # A list of application IDs to be excluded.
885 "A String",
886 ],
887 "targetedAppIds": [ # A list of application IDs to be included.
888 "A String",
889 ],
890 },
891 },
892 },
893 "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of # Geo criteria IDs to be included/excluded.
894 # included and excluded numeric IDs.
895 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
896 "A String",
897 ],
898 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
899 "A String",
900 ],
901 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]902 "videoTargeting": { # Represents targeting information about video. # Video targeting information.
903 "excludedPositionTypes": [ # A list of video positions to be excluded.
904 # Position types can either be included or excluded (XOR).
905 "A String",
906 ],
907 "targetedPositionTypes": [ # A list of video positions to be included.
908 # When the included list is present, the excluded list must be empty.
909 # When the excluded list is present, the included list must be empty.
910 "A String",
911 ],
912 },
913 "technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category.
914 "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device categories to be included/excluded.
915 # included and excluded numeric IDs.
916 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
917 "A String",
918 ],
919 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
920 "A String",
921 ],
922 },
923 "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
924 "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating systems to be included/excluded.
925 # included and excluded numeric IDs.
926 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
927 "A String",
928 ],
929 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
930 "A String",
931 ],
932 },
933 "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating system versions to be included/excluded.
934 # included and excluded numeric IDs.
935 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
936 "A String",
937 ],
938 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
939 "A String",
940 ],
941 },
942 },
943 "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device capabilities to be included/excluded.
944 # included and excluded numeric IDs.
945 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
946 "A String",
947 ],
948 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
949 "A String",
950 ],
951 },
952 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]953 "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on an ad # Inventory sizes to be included/excluded.
954 # request. It only applies to Private Auction, AdX Preferred Deals and
955 # Auction Packages. This targeting does not apply to Programmatic Guaranteed
956 # and Preferred Deals in Ad Manager.
957 "targetedInventorySizes": [ # A list of inventory sizes to be included.
958 { # Represents size of a single ad slot, or a creative.
959 "width": "A String", # The width of the ad slot in pixels.
960 # This field will be present only when size type is `PIXEL`.
961 "sizeType": "A String", # The size type of the ad slot.
962 "height": "A String", # The height of the ad slot in pixels.
963 # This field will be present only when size type is `PIXEL`.
964 },
965 ],
966 "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
967 { # Represents size of a single ad slot, or a creative.
968 "width": "A String", # The width of the ad slot in pixels.
969 # This field will be present only when size type is `PIXEL`.
970 "sizeType": "A String", # The size type of the ad slot.
971 "height": "A String", # The height of the ad slot in pixels.
972 # This field will be present only when size type is `PIXEL`.
973 },
974 ],
975 },
976 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]977 "createTime": "A String", # Output only. The time of the deal creation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]978 "webPropertyCode": "A String", # The web property code for the seller copied over from the product.
979 "proposalId": "A String", # Output only. ID of the proposal that this deal is part of.
980 "deliveryControl": { # Message contains details about how the deals will be paced. # The set of fields around delivery control that are interesting for a buyer
981 # to see but are non-negotiable. These are set by the publisher.
982 "frequencyCaps": [ # Output only. Specifies any frequency caps.
983 { # Frequency cap.
984 "numTimeUnits": 42, # The amount of time, in the units specified by time_unit_type. Defines the
985 # amount of time over which impressions per user are counted and capped.
986 "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over
987 # which impressions per user are counted and capped.
988 "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the
989 # specified time period.
990 },
991 ],
992 "creativeBlockingLevel": "A String", # Output only. Specified the creative blocking levels to be applied.
993 "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
994 },
995 "description": "A String", # Description for the deal terms.
996 "dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned).
997 "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
998 "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]999 "creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ # Output only. Restricitions about the creatives associated with the deal
1000 # (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals
1001 # in Ad Manager.
1002 # Preferred Deal in Ad Manager.
1003 # This doesn't apply to Private Auction and AdX Preferred Deals.
1004 "creativeFormat": "A String", # The format of the environment that the creatives will be displayed in.
1005 "creativeSpecifications": [
1006 { # Represents information for a creative that is associated with a Programmatic
1007 # Guaranteed/Preferred Deal in Ad Manager.
1008 "creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative.
1009 "width": "A String", # The width of the ad slot in pixels.
1010 # This field will be present only when size type is `PIXEL`.
1011 "sizeType": "A String", # The size type of the ad slot.
1012 "height": "A String", # The height of the ad slot in pixels.
1013 # This field will be present only when size type is `PIXEL`.
1014 },
1015 "creativeCompanionSizes": [ # Companion sizes may be filled in only when this is a video creative.
1016 { # Represents size of a single ad slot, or a creative.
1017 "width": "A String", # The width of the ad slot in pixels.
1018 # This field will be present only when size type is `PIXEL`.
1019 "sizeType": "A String", # The size type of the ad slot.
1020 "height": "A String", # The height of the ad slot in pixels.
1021 # This field will be present only when size type is `PIXEL`.
1022 },
1023 ],
1024 },
1025 ],
1026 "skippableAdType": "A String", # Skippable video ads allow viewers to skip ads after 5 seconds.
1027 },
1028 "createProductId": "A String", # The product ID from which this deal was created.
1029 #
1030 # Note: This field may be set only when creating the resource. Modifying
1031 # this field while updating the resource will result in an error.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1032 "dealTerms": { # The deal terms specify the details of a Product/deal. They specify things # The negotiable terms of the deal.
1033 # like price per buyer, the type of pricing model (e.g., fixed price, auction)
1034 # and expected impressions from the publisher.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1035 "brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED)
1036 "estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal.
1037 # Can be set by buyer or seller.
1038 "pricingType": "A String", # The pricing type for the deal/product. (default: CPM)
1039 "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
1040 "nanos": 42, # Number of nano (10^-9) units of the amount.
1041 # The value must be between -999,999,999 and +999,999,999 inclusive.
1042 # If `units` is positive, `nanos` must be positive or zero.
1043 # If `units` is zero, `nanos` can be positive, zero, or negative.
1044 # If `units` is negative, `nanos` must be negative or zero.
1045 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
1046 "units": "A String", # The whole units of the amount.
1047 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
1048 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
1049 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1050 },
1051 "sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the
1052 # time zone used to mark the boundaries of a day. It should be an
1053 # IANA TZ name, such as "America/Los_Angeles". For more information,
1054 # see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.
1055 "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day.
1056 # Can be set by buyer or seller.
1057 "nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via # The terms for non-guaranteed fixed price deals.
1058 # the API at this time, but can be returned in a get or list request.
1059 "fixedPrices": [ # Fixed price for the specified buyer.
1060 { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in
1061 # a product can become 0 or 1 deals. To check if there is a PricePerBuyer for
1062 # a particular buyer or buyer/advertiser pair, we look for the most specific
1063 # matching rule - we first look for a rule matching the buyer and advertiser,
1064 # next a rule with the buyer but an empty advertiser list, and otherwise look
1065 # for a matching rule where no buyer is set.
1066 "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # The buyer who will pay this price. If unset, all buyers can pay this price
1067 # (if the
1068 # advertisers match, and there's no more specific rule matching the buyer).
1069 # Authorized Buyers account ID.
1070 "accountId": "A String", # Authorized Buyers account ID of the buyer.
1071 },
1072 "advertiserIds": [ # The list of advertisers for this price when associated with this buyer.
1073 # If empty, all advertisers with this buyer pay this price.
1074 "A String",
1075 ],
1076 "price": { # Represents a price and a pricing type for a product / deal. # The specified price.
1077 "pricingType": "A String", # The pricing type for the deal/product. (default: CPM)
1078 "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
1079 "nanos": 42, # Number of nano (10^-9) units of the amount.
1080 # The value must be between -999,999,999 and +999,999,999 inclusive.
1081 # If `units` is positive, `nanos` must be positive or zero.
1082 # If `units` is zero, `nanos` can be positive, zero, or negative.
1083 # If `units` is negative, `nanos` must be negative or zero.
1084 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
1085 "units": "A String", # The whole units of the amount.
1086 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
1087 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
1088 },
1089 },
1090 },
1091 ],
1092 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1093 "guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals.
1094 "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage
1095 # of guaranteed looks that the buyer is guaranteeing to buy.
1096 "fixedPrices": [ # Fixed price for the specified buyer.
1097 { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in
1098 # a product can become 0 or 1 deals. To check if there is a PricePerBuyer for
1099 # a particular buyer or buyer/advertiser pair, we look for the most specific
1100 # matching rule - we first look for a rule matching the buyer and advertiser,
1101 # next a rule with the buyer but an empty advertiser list, and otherwise look
1102 # for a matching rule where no buyer is set.
1103 "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # The buyer who will pay this price. If unset, all buyers can pay this price
1104 # (if the
1105 # advertisers match, and there's no more specific rule matching the buyer).
1106 # Authorized Buyers account ID.
1107 "accountId": "A String", # Authorized Buyers account ID of the buyer.
1108 },
1109 "advertiserIds": [ # The list of advertisers for this price when associated with this buyer.
1110 # If empty, all advertisers with this buyer pay this price.
1111 "A String",
1112 ],
1113 "price": { # Represents a price and a pricing type for a product / deal. # The specified price.
1114 "pricingType": "A String", # The pricing type for the deal/product. (default: CPM)
1115 "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
1116 "nanos": 42, # Number of nano (10^-9) units of the amount.
1117 # The value must be between -999,999,999 and +999,999,999 inclusive.
1118 # If `units` is positive, `nanos` must be positive or zero.
1119 # If `units` is zero, `nanos` can be positive, zero, or negative.
1120 # If `units` is negative, `nanos` must be negative or zero.
1121 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
1122 "units": "A String", # The whole units of the amount.
1123 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
1124 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
1125 },
1126 },
1127 },
1128 ],
1129 "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.
1130 "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1131 },
1132 "nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only # The terms for non-guaranteed auction deals.
1133 # by the seller, but they can be returned in a get or list request.
1134 "reservePricesPerBuyer": [ # Reserve price for the specified buyer.
1135 { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in
1136 # a product can become 0 or 1 deals. To check if there is a PricePerBuyer for
1137 # a particular buyer or buyer/advertiser pair, we look for the most specific
1138 # matching rule - we first look for a rule matching the buyer and advertiser,
1139 # next a rule with the buyer but an empty advertiser list, and otherwise look
1140 # for a matching rule where no buyer is set.
1141 "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # The buyer who will pay this price. If unset, all buyers can pay this price
1142 # (if the
1143 # advertisers match, and there's no more specific rule matching the buyer).
1144 # Authorized Buyers account ID.
1145 "accountId": "A String", # Authorized Buyers account ID of the buyer.
1146 },
1147 "advertiserIds": [ # The list of advertisers for this price when associated with this buyer.
1148 # If empty, all advertisers with this buyer pay this price.
1149 "A String",
1150 ],
1151 "price": { # Represents a price and a pricing type for a product / deal. # The specified price.
1152 "pricingType": "A String", # The pricing type for the deal/product. (default: CPM)
1153 "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
1154 "nanos": 42, # Number of nano (10^-9) units of the amount.
1155 # The value must be between -999,999,999 and +999,999,999 inclusive.
1156 # If `units` is positive, `nanos` must be positive or zero.
1157 # If `units` is zero, `nanos` can be positive, zero, or negative.
1158 # If `units` is negative, `nanos` must be negative or zero.
1159 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
1160 "units": "A String", # The whole units of the amount.
1161 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
1162 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
1163 },
1164 },
1165 },
1166 ],
1167 "autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers
1168 # in this private auction.
1169 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1170 "description": "A String", # Publisher provided description for the terms.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1171 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1172 "sellerContacts": [ # Output only. Seller contact information for the deal.
1173 { # Contains information on how a buyer or seller can be reached.
1174 "email": "A String", # Email address for the contact.
1175 "name": "A String", # The name of the contact.
1176 },
1177 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1178 "displayName": "A String", # The name of the deal.
1179 "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller).
1180 "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list
1181 # operations (max-length: 1024 unicode code units).
1182 },
1183 "syndicationProduct": "A String", # The syndication product associated with the deal.
1184 #
1185 # Note: This field may be set only when creating the resource. Modifying
1186 # this field while updating the resource will result in an error.
1187 "targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared
1188 # targeting entity is AND'd together.
1189 { # Advertisers can target different attributes of an ad slot. For example,
1190 # they can choose to show ads only if the user is in the U.S. Such
1191 # targeting criteria can be specified as part of Shared Targeting.
1192 "inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd
1193 # together.
1194 { # A polymorphic targeting value used as part of Shared Targeting.
1195 "stringValue": "A String", # The string value to include/exclude.
1196 "longValue": "A String", # The long value to include/exclude.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1197 "dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.
1198 # Filled in when the key is GOOG_DAYPART_TARGETING.
1199 # The definition of this targeting is derived from the structure
1200 # used by Ad Manager.
1201 "dayParts": [ # A list of day part targeting criterion.
1202 { # Daypart targeting message that specifies if the ad can be shown
1203 # only during certain parts of a day/week.
1204 "dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.
1205 "endTime": { # Represents a time of day. The date and time zone are either not significant # The ending time of the day for the ad to show (minute level
1206 # granularity). The end time is exclusive. This field is not available
1207 # for filtering in PQL queries.
1208 # or are specified elsewhere. An API may choose to allow leap seconds. Related
1209 # types are google.type.Date and `google.protobuf.Timestamp`.
1210 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
1211 # to allow the value "24:00:00" for scenarios like business closing time.
1212 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
1213 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
1214 # allow the value 60 if it allows leap-seconds.
1215 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
1216 },
1217 "startTime": { # Represents a time of day. The date and time zone are either not significant # The starting time of day for the ad to show (minute level granularity).
1218 # The start time is inclusive.
1219 # This field is not available for filtering in PQL queries.
1220 # or are specified elsewhere. An API may choose to allow leap seconds. Related
1221 # types are google.type.Date and `google.protobuf.Timestamp`.
1222 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
1223 # to allow the value "24:00:00" for scenarios like business closing time.
1224 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
1225 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
1226 # allow the value 60 if it allows leap-seconds.
1227 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
1228 },
1229 },
1230 ],
1231 "timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.
1232 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1233 "creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.
1234 # Filled in when key = GOOG_CREATIVE_SIZE
1235 "companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).
1236 # Companion sizes may be filled in only when creative_size_type = VIDEO
1237 { # Message depicting the size of the creative. The units of width and
1238 # height depend on the type of the targeting.
1239 "width": 42, # The width of the creative
1240 "height": 42, # The height of the creative.
1241 },
1242 ],
1243 "nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value
1244 # only if creative_size_type = CreativeSizeType.NATIVE.
1245 "allowedFormats": [ # What formats are allowed by the publisher.
1246 # If this repeated field is empty then all formats are allowed.
1247 # For example, if this field contains AllowedFormatType.AUDIO then the
1248 # publisher only allows an audio ad (without any video).
1249 "A String",
1250 ],
1251 "skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if
1252 # creative_size_type = CreativeSizeType.VIDEO.
1253 "creativeSizeType": "A String", # The creative size type.
1254 "size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size
1255 # of the creative
1256 # height depend on the type of the targeting.
1257 "width": 42, # The width of the creative
1258 "height": 42, # The height of the creative.
1259 },
1260 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1261 },
1262 ],
1263 "exclusions": [ # The list of values to exclude from targeting. Each value is AND'd
1264 # together.
1265 { # A polymorphic targeting value used as part of Shared Targeting.
1266 "stringValue": "A String", # The string value to include/exclude.
1267 "longValue": "A String", # The long value to include/exclude.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1268 "dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.
1269 # Filled in when the key is GOOG_DAYPART_TARGETING.
1270 # The definition of this targeting is derived from the structure
1271 # used by Ad Manager.
1272 "dayParts": [ # A list of day part targeting criterion.
1273 { # Daypart targeting message that specifies if the ad can be shown
1274 # only during certain parts of a day/week.
1275 "dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.
1276 "endTime": { # Represents a time of day. The date and time zone are either not significant # The ending time of the day for the ad to show (minute level
1277 # granularity). The end time is exclusive. This field is not available
1278 # for filtering in PQL queries.
1279 # or are specified elsewhere. An API may choose to allow leap seconds. Related
1280 # types are google.type.Date and `google.protobuf.Timestamp`.
1281 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
1282 # to allow the value "24:00:00" for scenarios like business closing time.
1283 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
1284 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
1285 # allow the value 60 if it allows leap-seconds.
1286 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
1287 },
1288 "startTime": { # Represents a time of day. The date and time zone are either not significant # The starting time of day for the ad to show (minute level granularity).
1289 # The start time is inclusive.
1290 # This field is not available for filtering in PQL queries.
1291 # or are specified elsewhere. An API may choose to allow leap seconds. Related
1292 # types are google.type.Date and `google.protobuf.Timestamp`.
1293 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
1294 # to allow the value "24:00:00" for scenarios like business closing time.
1295 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
1296 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
1297 # allow the value 60 if it allows leap-seconds.
1298 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
1299 },
1300 },
1301 ],
1302 "timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.
1303 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1304 "creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.
1305 # Filled in when key = GOOG_CREATIVE_SIZE
1306 "companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).
1307 # Companion sizes may be filled in only when creative_size_type = VIDEO
1308 { # Message depicting the size of the creative. The units of width and
1309 # height depend on the type of the targeting.
1310 "width": 42, # The width of the creative
1311 "height": 42, # The height of the creative.
1312 },
1313 ],
1314 "nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value
1315 # only if creative_size_type = CreativeSizeType.NATIVE.
1316 "allowedFormats": [ # What formats are allowed by the publisher.
1317 # If this repeated field is empty then all formats are allowed.
1318 # For example, if this field contains AllowedFormatType.AUDIO then the
1319 # publisher only allows an audio ad (without any video).
1320 "A String",
1321 ],
1322 "skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if
1323 # creative_size_type = CreativeSizeType.VIDEO.
1324 "creativeSizeType": "A String", # The creative size type.
1325 "size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size
1326 # of the creative
1327 # height depend on the type of the targeting.
1328 "width": 42, # The width of the creative
1329 "height": 42, # The height of the creative.
1330 },
1331 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1332 },
1333 ],
1334 "key": "A String", # The key representing the shared targeting criterion.
1335 # Targeting criteria defined by Google ad servers will begin with GOOG_.
1336 # Third parties may define their own keys.
1337 # A list of permissible keys along with the acceptable values will be
1338 # provided as part of the external documentation.
1339 },
1340 ],
1341 "dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal.
1342 "dealPauseStatus": { # Tracks which parties (if any) have paused a deal. # Output only. Tracks which parties (if any) have paused a deal.
1343 # The deal is considered paused if either hasBuyerPaused or
1344 # hasSellPaused is true.
1345 "hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally.
1346 "buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal.
1347 "sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal.
1348 "hasBuyerPaused": True or False, # True, if the buyer has paused the deal unilaterally.
1349 "firstPausedBy": "A String", # The role of the person who first paused this deal.
1350 },
1351 },
1352 "isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this
1353 # deal.
1354 },
1355 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1356 "updateTime": "A String", # Output only. The time when the proposal was last revised.
1357 "proposalState": "A String", # Output only. The current state of the proposal.
1358 "proposalRevision": "A String", # Output only. The revision number for the proposal.
1359 # Each update to the proposal or the deal causes the proposal revision number
1360 # to auto-increment. The buyer keeps track of the last revision number they
1361 # know of and pass it in when making an update. If the head revision number
1362 # on the server has since incremented, then an ABORTED error is returned
1363 # during the update operation to let the buyer know that a subsequent update
1364 # was made.
1365 "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller).
1366 "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list
1367 # operations (max-length: 1024 unicode code units).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1368 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1369 "privateAuctionId": "A String", # Output only. Private auction ID if this proposal is a private auction
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1370 # proposal.
1371 "notes": [ # Output only. The notes associated with this proposal.
1372 { # A proposal may be associated to several notes.
1373 "note": "A String", # The actual note to attach.
1374 # (max-length: 1024 unicode code units)
1375 #
1376 # Note: This field may be set only when creating the resource. Modifying
1377 # this field while updating the resource will result in an error.
1378 "creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note.
1379 "proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created.
1380 "createTime": "A String", # Output only. The timestamp for when this note was created.
1381 "noteId": "A String", # Output only. The unique ID for the note.
1382 },
1383 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1384 "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.
1385 "billedBuyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Output only. Reference to the buyer that will get billed for this proposal.
1386 # Authorized Buyers account ID.
1387 "accountId": "A String", # Authorized Buyers account ID of the buyer.
1388 },
1389 "seller": { # Represents a seller of inventory. Each seller is identified by a unique # Reference to the seller on the proposal.
1390 #
1391 # Note: This field may be set only when creating the resource. Modifying
1392 # this field while updating the resource will result in an error.
1393 # Ad Manager account ID.
1394 "subAccountId": "A String", # Optional sub-account ID for the seller.
1395 "accountId": "A String", # The unique ID for the seller. The seller fills in this field.
1396 # The seller account ID is then available to buyer in the product.
1397 },
1398 "sellerContacts": [ # Output only. Contact information for the seller.
1399 { # Contains information on how a buyer or seller can be reached.
1400 "email": "A String", # Email address for the contact.
1401 "name": "A String", # The name of the contact.
1402 },
1403 ],
1404 "proposalId": "A String", # Output only. The unique ID of the proposal.
1405 "isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated.
1406 "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Reference to the buyer on the proposal.
1407 #
1408 # Note: This field may be set only when creating the resource. Modifying
1409 # this field while updating the resource will result in an error.
1410 # Authorized Buyers account ID.
1411 "accountId": "A String", # Authorized Buyers account ID of the buyer.
1412 },
1413 "isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this
1414 # proposal.
1415 "displayName": "A String", # The name for the proposal.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1416 "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or
1417 # left a comment.
1418 "buyerContacts": [ # Contact information for the buyer.
1419 { # Contains information on how a buyer or seller can be reached.
1420 "email": "A String", # Email address for the contact.
1421 "name": "A String", # The name of the contact.
1422 },
1423 ],
1424 }</pre>
1425</div>
1426
1427<div class="method">
1428 <code class="details" id="completeSetup">completeSetup(accountId, proposalId, body=None, x__xgafv=None)</code>
1429 <pre>Update the given proposal to indicate that setup has been completed.
1430This method is called by the buyer when the line items have been created
1431on their end for a finalized proposal and all the required creatives
1432have been uploaded using the creatives API. This call updates the
1433`is_setup_completed` bit on the proposal and also notifies the seller.
1434The server will advance the revision number of the most recent proposal.
1435
1436Args:
1437 accountId: string, Account ID of the buyer. (required)
1438 proposalId: string, The ID of the proposal to mark as setup completed. (required)
1439 body: object, The request body.
1440 The object takes the form of:
1441
1442{ # Request message for indicating that the proposal's setup step is complete.
1443 }
1444
1445 x__xgafv: string, V1 error format.
1446 Allowed values
1447 1 - v1 error format
1448 2 - v2 error format
1449
1450Returns:
1451 An object of the form:
1452
1453 { # Note: this resource requires whitelisting for access. Please contact your
1454 # account manager for access to Marketplace resources.
1455 #
1456 # Represents a proposal in the Marketplace. A proposal is the unit of
1457 # negotiation between a seller and a buyer and contains deals which
1458 # are served.
1459 #
1460 # Note: you can not update, create, or otherwise modify Private
1461 # Auction or Preferred Deals deals through the API.
1462 #
1463 # Fields are updatable unless noted otherwise.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1464 "deals": [ # The deals associated with this proposal. For Private Auction proposals
1465 # (whose deals have NonGuaranteedAuctionTerms), there will only be one deal.
1466 { # A deal represents a segment of inventory for displaying ads on.
1467 # A proposal can contain multiple deals. A deal contains the terms and
1468 # targeting information that is used for serving.
1469 "updateTime": "A String", # Output only. The time when the deal was last updated.
1470 "createProductRevision": "A String", # Optional revision number of the product that the deal was created from.
1471 # If present on create, and the server `product_revision` has advanced sinced
1472 # the passed-in `create_product_revision`, an `ABORTED` error will be
1473 # returned.
1474 #
1475 # Note: This field may be set only when creating the resource. Modifying
1476 # this field while updating the resource will result in an error.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1477 "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals.
1478 # PUBLISHER means creative is provided by seller and ADVERTISER means
1479 # creative is provided by buyer.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1480 "availableStartTime": "A String", # Optional proposed flight start time of the deal.
1481 # This will generally be stored in the granularity of one second since deal
1482 # serving starts at seconds boundary. Any time specified with more
1483 # granularity (e.g., in milliseconds) will be truncated towards the start of
1484 # time in seconds.
1485 "availableEndTime": "A String", # Proposed flight end time of the deal.
1486 # This will generally be stored in a granularity of a second.
1487 # A value is not required for Private Auction deals or Preferred Deals.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1488 "externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is
1489 # finalized. This is the deal ID that shows up in serving/reporting etc.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1490 "targeting": { # Targeting represents different criteria that can be used by advertisers to # Output only. Specifies the subset of inventory targeted by the deal.
1491 # target ad inventory. For example, they can choose to target ad requests only
1492 # if the user is in the US.
1493 # Multiple types of targeting are always applied as a logical AND, unless noted
1494 # otherwise.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1495 "placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or # Placement targeting information, e.g., URL, mobile applications.
1496 # mobile applications.
1497 # Different placement targeting types will be logically OR'ed.
1498 "urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). # URLs to be included/excluded.
1499 # For Private Auction and AdX Preferred Deals, URLs are either included or
1500 # excluded.
1501 # For Programmatic Guaranteed and Preferred Deals, this doesn't
1502 # apply.
1503 "excludedUrls": [ # A list of URLs to be excluded.
1504 "A String",
1505 ],
1506 "targetedUrls": [ # A list of URLs to be included.
1507 "A String",
1508 ],
1509 },
1510 "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal.
1511 # This doesn't apply to Auction Packages.
1512 "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that # Publisher owned apps to be targeted or excluded by the publisher to
1513 # display the ads in.
1514 # publishers own.
1515 # Mobile application IDs are from App Store and Google Play Store.
1516 # Android App ID, for example, com.google.android.apps.maps, can be found in
1517 # Google Play Store URL.
1518 # iOS App ID (which is a number) can be found at the end of iTunes store URL.
1519 # First party mobile applications is either included or excluded.
1520 "excludedAppIds": [ # A list of application IDs to be excluded.
1521 "A String",
1522 ],
1523 "targetedAppIds": [ # A list of application IDs to be included.
1524 "A String",
1525 ],
1526 },
1527 },
1528 },
1529 "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of # Geo criteria IDs to be included/excluded.
1530 # included and excluded numeric IDs.
1531 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
1532 "A String",
1533 ],
1534 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
1535 "A String",
1536 ],
1537 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1538 "videoTargeting": { # Represents targeting information about video. # Video targeting information.
1539 "excludedPositionTypes": [ # A list of video positions to be excluded.
1540 # Position types can either be included or excluded (XOR).
1541 "A String",
1542 ],
1543 "targetedPositionTypes": [ # A list of video positions to be included.
1544 # When the included list is present, the excluded list must be empty.
1545 # When the excluded list is present, the included list must be empty.
1546 "A String",
1547 ],
1548 },
1549 "technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category.
1550 "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device categories to be included/excluded.
1551 # included and excluded numeric IDs.
1552 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
1553 "A String",
1554 ],
1555 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
1556 "A String",
1557 ],
1558 },
1559 "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
1560 "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating systems to be included/excluded.
1561 # included and excluded numeric IDs.
1562 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
1563 "A String",
1564 ],
1565 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
1566 "A String",
1567 ],
1568 },
1569 "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating system versions to be included/excluded.
1570 # included and excluded numeric IDs.
1571 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
1572 "A String",
1573 ],
1574 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
1575 "A String",
1576 ],
1577 },
1578 },
1579 "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device capabilities to be included/excluded.
1580 # included and excluded numeric IDs.
1581 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
1582 "A String",
1583 ],
1584 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
1585 "A String",
1586 ],
1587 },
1588 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1589 "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on an ad # Inventory sizes to be included/excluded.
1590 # request. It only applies to Private Auction, AdX Preferred Deals and
1591 # Auction Packages. This targeting does not apply to Programmatic Guaranteed
1592 # and Preferred Deals in Ad Manager.
1593 "targetedInventorySizes": [ # A list of inventory sizes to be included.
1594 { # Represents size of a single ad slot, or a creative.
1595 "width": "A String", # The width of the ad slot in pixels.
1596 # This field will be present only when size type is `PIXEL`.
1597 "sizeType": "A String", # The size type of the ad slot.
1598 "height": "A String", # The height of the ad slot in pixels.
1599 # This field will be present only when size type is `PIXEL`.
1600 },
1601 ],
1602 "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
1603 { # Represents size of a single ad slot, or a creative.
1604 "width": "A String", # The width of the ad slot in pixels.
1605 # This field will be present only when size type is `PIXEL`.
1606 "sizeType": "A String", # The size type of the ad slot.
1607 "height": "A String", # The height of the ad slot in pixels.
1608 # This field will be present only when size type is `PIXEL`.
1609 },
1610 ],
1611 },
1612 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1613 "createTime": "A String", # Output only. The time of the deal creation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1614 "webPropertyCode": "A String", # The web property code for the seller copied over from the product.
1615 "proposalId": "A String", # Output only. ID of the proposal that this deal is part of.
1616 "deliveryControl": { # Message contains details about how the deals will be paced. # The set of fields around delivery control that are interesting for a buyer
1617 # to see but are non-negotiable. These are set by the publisher.
1618 "frequencyCaps": [ # Output only. Specifies any frequency caps.
1619 { # Frequency cap.
1620 "numTimeUnits": 42, # The amount of time, in the units specified by time_unit_type. Defines the
1621 # amount of time over which impressions per user are counted and capped.
1622 "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over
1623 # which impressions per user are counted and capped.
1624 "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the
1625 # specified time period.
1626 },
1627 ],
1628 "creativeBlockingLevel": "A String", # Output only. Specified the creative blocking levels to be applied.
1629 "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
1630 },
1631 "description": "A String", # Description for the deal terms.
1632 "dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned).
1633 "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
1634 "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1635 "creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ # Output only. Restricitions about the creatives associated with the deal
1636 # (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals
1637 # in Ad Manager.
1638 # Preferred Deal in Ad Manager.
1639 # This doesn't apply to Private Auction and AdX Preferred Deals.
1640 "creativeFormat": "A String", # The format of the environment that the creatives will be displayed in.
1641 "creativeSpecifications": [
1642 { # Represents information for a creative that is associated with a Programmatic
1643 # Guaranteed/Preferred Deal in Ad Manager.
1644 "creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative.
1645 "width": "A String", # The width of the ad slot in pixels.
1646 # This field will be present only when size type is `PIXEL`.
1647 "sizeType": "A String", # The size type of the ad slot.
1648 "height": "A String", # The height of the ad slot in pixels.
1649 # This field will be present only when size type is `PIXEL`.
1650 },
1651 "creativeCompanionSizes": [ # Companion sizes may be filled in only when this is a video creative.
1652 { # Represents size of a single ad slot, or a creative.
1653 "width": "A String", # The width of the ad slot in pixels.
1654 # This field will be present only when size type is `PIXEL`.
1655 "sizeType": "A String", # The size type of the ad slot.
1656 "height": "A String", # The height of the ad slot in pixels.
1657 # This field will be present only when size type is `PIXEL`.
1658 },
1659 ],
1660 },
1661 ],
1662 "skippableAdType": "A String", # Skippable video ads allow viewers to skip ads after 5 seconds.
1663 },
1664 "createProductId": "A String", # The product ID from which this deal was created.
1665 #
1666 # Note: This field may be set only when creating the resource. Modifying
1667 # this field while updating the resource will result in an error.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1668 "dealTerms": { # The deal terms specify the details of a Product/deal. They specify things # The negotiable terms of the deal.
1669 # like price per buyer, the type of pricing model (e.g., fixed price, auction)
1670 # and expected impressions from the publisher.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1671 "brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED)
1672 "estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal.
1673 # Can be set by buyer or seller.
1674 "pricingType": "A String", # The pricing type for the deal/product. (default: CPM)
1675 "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
1676 "nanos": 42, # Number of nano (10^-9) units of the amount.
1677 # The value must be between -999,999,999 and +999,999,999 inclusive.
1678 # If `units` is positive, `nanos` must be positive or zero.
1679 # If `units` is zero, `nanos` can be positive, zero, or negative.
1680 # If `units` is negative, `nanos` must be negative or zero.
1681 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
1682 "units": "A String", # The whole units of the amount.
1683 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
1684 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
1685 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1686 },
1687 "sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the
1688 # time zone used to mark the boundaries of a day. It should be an
1689 # IANA TZ name, such as "America/Los_Angeles". For more information,
1690 # see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.
1691 "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day.
1692 # Can be set by buyer or seller.
1693 "nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via # The terms for non-guaranteed fixed price deals.
1694 # the API at this time, but can be returned in a get or list request.
1695 "fixedPrices": [ # Fixed price for the specified buyer.
1696 { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in
1697 # a product can become 0 or 1 deals. To check if there is a PricePerBuyer for
1698 # a particular buyer or buyer/advertiser pair, we look for the most specific
1699 # matching rule - we first look for a rule matching the buyer and advertiser,
1700 # next a rule with the buyer but an empty advertiser list, and otherwise look
1701 # for a matching rule where no buyer is set.
1702 "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # The buyer who will pay this price. If unset, all buyers can pay this price
1703 # (if the
1704 # advertisers match, and there's no more specific rule matching the buyer).
1705 # Authorized Buyers account ID.
1706 "accountId": "A String", # Authorized Buyers account ID of the buyer.
1707 },
1708 "advertiserIds": [ # The list of advertisers for this price when associated with this buyer.
1709 # If empty, all advertisers with this buyer pay this price.
1710 "A String",
1711 ],
1712 "price": { # Represents a price and a pricing type for a product / deal. # The specified price.
1713 "pricingType": "A String", # The pricing type for the deal/product. (default: CPM)
1714 "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
1715 "nanos": 42, # Number of nano (10^-9) units of the amount.
1716 # The value must be between -999,999,999 and +999,999,999 inclusive.
1717 # If `units` is positive, `nanos` must be positive or zero.
1718 # If `units` is zero, `nanos` can be positive, zero, or negative.
1719 # If `units` is negative, `nanos` must be negative or zero.
1720 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
1721 "units": "A String", # The whole units of the amount.
1722 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
1723 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
1724 },
1725 },
1726 },
1727 ],
1728 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1729 "guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals.
1730 "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage
1731 # of guaranteed looks that the buyer is guaranteeing to buy.
1732 "fixedPrices": [ # Fixed price for the specified buyer.
1733 { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in
1734 # a product can become 0 or 1 deals. To check if there is a PricePerBuyer for
1735 # a particular buyer or buyer/advertiser pair, we look for the most specific
1736 # matching rule - we first look for a rule matching the buyer and advertiser,
1737 # next a rule with the buyer but an empty advertiser list, and otherwise look
1738 # for a matching rule where no buyer is set.
1739 "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # The buyer who will pay this price. If unset, all buyers can pay this price
1740 # (if the
1741 # advertisers match, and there's no more specific rule matching the buyer).
1742 # Authorized Buyers account ID.
1743 "accountId": "A String", # Authorized Buyers account ID of the buyer.
1744 },
1745 "advertiserIds": [ # The list of advertisers for this price when associated with this buyer.
1746 # If empty, all advertisers with this buyer pay this price.
1747 "A String",
1748 ],
1749 "price": { # Represents a price and a pricing type for a product / deal. # The specified price.
1750 "pricingType": "A String", # The pricing type for the deal/product. (default: CPM)
1751 "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
1752 "nanos": 42, # Number of nano (10^-9) units of the amount.
1753 # The value must be between -999,999,999 and +999,999,999 inclusive.
1754 # If `units` is positive, `nanos` must be positive or zero.
1755 # If `units` is zero, `nanos` can be positive, zero, or negative.
1756 # If `units` is negative, `nanos` must be negative or zero.
1757 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
1758 "units": "A String", # The whole units of the amount.
1759 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
1760 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
1761 },
1762 },
1763 },
1764 ],
1765 "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.
1766 "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1767 },
1768 "nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only # The terms for non-guaranteed auction deals.
1769 # by the seller, but they can be returned in a get or list request.
1770 "reservePricesPerBuyer": [ # Reserve price for the specified buyer.
1771 { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in
1772 # a product can become 0 or 1 deals. To check if there is a PricePerBuyer for
1773 # a particular buyer or buyer/advertiser pair, we look for the most specific
1774 # matching rule - we first look for a rule matching the buyer and advertiser,
1775 # next a rule with the buyer but an empty advertiser list, and otherwise look
1776 # for a matching rule where no buyer is set.
1777 "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # The buyer who will pay this price. If unset, all buyers can pay this price
1778 # (if the
1779 # advertisers match, and there's no more specific rule matching the buyer).
1780 # Authorized Buyers account ID.
1781 "accountId": "A String", # Authorized Buyers account ID of the buyer.
1782 },
1783 "advertiserIds": [ # The list of advertisers for this price when associated with this buyer.
1784 # If empty, all advertisers with this buyer pay this price.
1785 "A String",
1786 ],
1787 "price": { # Represents a price and a pricing type for a product / deal. # The specified price.
1788 "pricingType": "A String", # The pricing type for the deal/product. (default: CPM)
1789 "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
1790 "nanos": 42, # Number of nano (10^-9) units of the amount.
1791 # The value must be between -999,999,999 and +999,999,999 inclusive.
1792 # If `units` is positive, `nanos` must be positive or zero.
1793 # If `units` is zero, `nanos` can be positive, zero, or negative.
1794 # If `units` is negative, `nanos` must be negative or zero.
1795 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
1796 "units": "A String", # The whole units of the amount.
1797 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
1798 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
1799 },
1800 },
1801 },
1802 ],
1803 "autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers
1804 # in this private auction.
1805 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1806 "description": "A String", # Publisher provided description for the terms.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1807 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1808 "sellerContacts": [ # Output only. Seller contact information for the deal.
1809 { # Contains information on how a buyer or seller can be reached.
1810 "email": "A String", # Email address for the contact.
1811 "name": "A String", # The name of the contact.
1812 },
1813 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1814 "displayName": "A String", # The name of the deal.
1815 "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller).
1816 "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list
1817 # operations (max-length: 1024 unicode code units).
1818 },
1819 "syndicationProduct": "A String", # The syndication product associated with the deal.
1820 #
1821 # Note: This field may be set only when creating the resource. Modifying
1822 # this field while updating the resource will result in an error.
1823 "targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared
1824 # targeting entity is AND'd together.
1825 { # Advertisers can target different attributes of an ad slot. For example,
1826 # they can choose to show ads only if the user is in the U.S. Such
1827 # targeting criteria can be specified as part of Shared Targeting.
1828 "inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd
1829 # together.
1830 { # A polymorphic targeting value used as part of Shared Targeting.
1831 "stringValue": "A String", # The string value to include/exclude.
1832 "longValue": "A String", # The long value to include/exclude.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1833 "dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.
1834 # Filled in when the key is GOOG_DAYPART_TARGETING.
1835 # The definition of this targeting is derived from the structure
1836 # used by Ad Manager.
1837 "dayParts": [ # A list of day part targeting criterion.
1838 { # Daypart targeting message that specifies if the ad can be shown
1839 # only during certain parts of a day/week.
1840 "dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.
1841 "endTime": { # Represents a time of day. The date and time zone are either not significant # The ending time of the day for the ad to show (minute level
1842 # granularity). The end time is exclusive. This field is not available
1843 # for filtering in PQL queries.
1844 # or are specified elsewhere. An API may choose to allow leap seconds. Related
1845 # types are google.type.Date and `google.protobuf.Timestamp`.
1846 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
1847 # to allow the value "24:00:00" for scenarios like business closing time.
1848 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
1849 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
1850 # allow the value 60 if it allows leap-seconds.
1851 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
1852 },
1853 "startTime": { # Represents a time of day. The date and time zone are either not significant # The starting time of day for the ad to show (minute level granularity).
1854 # The start time is inclusive.
1855 # This field is not available for filtering in PQL queries.
1856 # or are specified elsewhere. An API may choose to allow leap seconds. Related
1857 # types are google.type.Date and `google.protobuf.Timestamp`.
1858 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
1859 # to allow the value "24:00:00" for scenarios like business closing time.
1860 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
1861 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
1862 # allow the value 60 if it allows leap-seconds.
1863 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
1864 },
1865 },
1866 ],
1867 "timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.
1868 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1869 "creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.
1870 # Filled in when key = GOOG_CREATIVE_SIZE
1871 "companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).
1872 # Companion sizes may be filled in only when creative_size_type = VIDEO
1873 { # Message depicting the size of the creative. The units of width and
1874 # height depend on the type of the targeting.
1875 "width": 42, # The width of the creative
1876 "height": 42, # The height of the creative.
1877 },
1878 ],
1879 "nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value
1880 # only if creative_size_type = CreativeSizeType.NATIVE.
1881 "allowedFormats": [ # What formats are allowed by the publisher.
1882 # If this repeated field is empty then all formats are allowed.
1883 # For example, if this field contains AllowedFormatType.AUDIO then the
1884 # publisher only allows an audio ad (without any video).
1885 "A String",
1886 ],
1887 "skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if
1888 # creative_size_type = CreativeSizeType.VIDEO.
1889 "creativeSizeType": "A String", # The creative size type.
1890 "size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size
1891 # of the creative
1892 # height depend on the type of the targeting.
1893 "width": 42, # The width of the creative
1894 "height": 42, # The height of the creative.
1895 },
1896 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1897 },
1898 ],
1899 "exclusions": [ # The list of values to exclude from targeting. Each value is AND'd
1900 # together.
1901 { # A polymorphic targeting value used as part of Shared Targeting.
1902 "stringValue": "A String", # The string value to include/exclude.
1903 "longValue": "A String", # The long value to include/exclude.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1904 "dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.
1905 # Filled in when the key is GOOG_DAYPART_TARGETING.
1906 # The definition of this targeting is derived from the structure
1907 # used by Ad Manager.
1908 "dayParts": [ # A list of day part targeting criterion.
1909 { # Daypart targeting message that specifies if the ad can be shown
1910 # only during certain parts of a day/week.
1911 "dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.
1912 "endTime": { # Represents a time of day. The date and time zone are either not significant # The ending time of the day for the ad to show (minute level
1913 # granularity). The end time is exclusive. This field is not available
1914 # for filtering in PQL queries.
1915 # or are specified elsewhere. An API may choose to allow leap seconds. Related
1916 # types are google.type.Date and `google.protobuf.Timestamp`.
1917 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
1918 # to allow the value "24:00:00" for scenarios like business closing time.
1919 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
1920 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
1921 # allow the value 60 if it allows leap-seconds.
1922 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
1923 },
1924 "startTime": { # Represents a time of day. The date and time zone are either not significant # The starting time of day for the ad to show (minute level granularity).
1925 # The start time is inclusive.
1926 # This field is not available for filtering in PQL queries.
1927 # or are specified elsewhere. An API may choose to allow leap seconds. Related
1928 # types are google.type.Date and `google.protobuf.Timestamp`.
1929 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
1930 # to allow the value "24:00:00" for scenarios like business closing time.
1931 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
1932 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
1933 # allow the value 60 if it allows leap-seconds.
1934 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
1935 },
1936 },
1937 ],
1938 "timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.
1939 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1940 "creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.
1941 # Filled in when key = GOOG_CREATIVE_SIZE
1942 "companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).
1943 # Companion sizes may be filled in only when creative_size_type = VIDEO
1944 { # Message depicting the size of the creative. The units of width and
1945 # height depend on the type of the targeting.
1946 "width": 42, # The width of the creative
1947 "height": 42, # The height of the creative.
1948 },
1949 ],
1950 "nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value
1951 # only if creative_size_type = CreativeSizeType.NATIVE.
1952 "allowedFormats": [ # What formats are allowed by the publisher.
1953 # If this repeated field is empty then all formats are allowed.
1954 # For example, if this field contains AllowedFormatType.AUDIO then the
1955 # publisher only allows an audio ad (without any video).
1956 "A String",
1957 ],
1958 "skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if
1959 # creative_size_type = CreativeSizeType.VIDEO.
1960 "creativeSizeType": "A String", # The creative size type.
1961 "size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size
1962 # of the creative
1963 # height depend on the type of the targeting.
1964 "width": 42, # The width of the creative
1965 "height": 42, # The height of the creative.
1966 },
1967 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1968 },
1969 ],
1970 "key": "A String", # The key representing the shared targeting criterion.
1971 # Targeting criteria defined by Google ad servers will begin with GOOG_.
1972 # Third parties may define their own keys.
1973 # A list of permissible keys along with the acceptable values will be
1974 # provided as part of the external documentation.
1975 },
1976 ],
1977 "dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal.
1978 "dealPauseStatus": { # Tracks which parties (if any) have paused a deal. # Output only. Tracks which parties (if any) have paused a deal.
1979 # The deal is considered paused if either hasBuyerPaused or
1980 # hasSellPaused is true.
1981 "hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally.
1982 "buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal.
1983 "sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal.
1984 "hasBuyerPaused": True or False, # True, if the buyer has paused the deal unilaterally.
1985 "firstPausedBy": "A String", # The role of the person who first paused this deal.
1986 },
1987 },
1988 "isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this
1989 # deal.
1990 },
1991 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1992 "updateTime": "A String", # Output only. The time when the proposal was last revised.
1993 "proposalState": "A String", # Output only. The current state of the proposal.
1994 "proposalRevision": "A String", # Output only. The revision number for the proposal.
1995 # Each update to the proposal or the deal causes the proposal revision number
1996 # to auto-increment. The buyer keeps track of the last revision number they
1997 # know of and pass it in when making an update. If the head revision number
1998 # on the server has since incremented, then an ABORTED error is returned
1999 # during the update operation to let the buyer know that a subsequent update
2000 # was made.
2001 "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller).
2002 "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list
2003 # operations (max-length: 1024 unicode code units).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2004 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2005 "privateAuctionId": "A String", # Output only. Private auction ID if this proposal is a private auction
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2006 # proposal.
2007 "notes": [ # Output only. The notes associated with this proposal.
2008 { # A proposal may be associated to several notes.
2009 "note": "A String", # The actual note to attach.
2010 # (max-length: 1024 unicode code units)
2011 #
2012 # Note: This field may be set only when creating the resource. Modifying
2013 # this field while updating the resource will result in an error.
2014 "creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note.
2015 "proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created.
2016 "createTime": "A String", # Output only. The timestamp for when this note was created.
2017 "noteId": "A String", # Output only. The unique ID for the note.
2018 },
2019 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2020 "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.
2021 "billedBuyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Output only. Reference to the buyer that will get billed for this proposal.
2022 # Authorized Buyers account ID.
2023 "accountId": "A String", # Authorized Buyers account ID of the buyer.
2024 },
2025 "seller": { # Represents a seller of inventory. Each seller is identified by a unique # Reference to the seller on the proposal.
2026 #
2027 # Note: This field may be set only when creating the resource. Modifying
2028 # this field while updating the resource will result in an error.
2029 # Ad Manager account ID.
2030 "subAccountId": "A String", # Optional sub-account ID for the seller.
2031 "accountId": "A String", # The unique ID for the seller. The seller fills in this field.
2032 # The seller account ID is then available to buyer in the product.
2033 },
2034 "sellerContacts": [ # Output only. Contact information for the seller.
2035 { # Contains information on how a buyer or seller can be reached.
2036 "email": "A String", # Email address for the contact.
2037 "name": "A String", # The name of the contact.
2038 },
2039 ],
2040 "proposalId": "A String", # Output only. The unique ID of the proposal.
2041 "isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated.
2042 "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Reference to the buyer on the proposal.
2043 #
2044 # Note: This field may be set only when creating the resource. Modifying
2045 # this field while updating the resource will result in an error.
2046 # Authorized Buyers account ID.
2047 "accountId": "A String", # Authorized Buyers account ID of the buyer.
2048 },
2049 "isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this
2050 # proposal.
2051 "displayName": "A String", # The name for the proposal.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2052 "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or
2053 # left a comment.
2054 "buyerContacts": [ # Contact information for the buyer.
2055 { # Contains information on how a buyer or seller can be reached.
2056 "email": "A String", # Email address for the contact.
2057 "name": "A String", # The name of the contact.
2058 },
2059 ],
2060 }</pre>
2061</div>
2062
2063<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2064 <code class="details" id="create">create(accountId, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2065 <pre>Create the given proposal. Each created proposal and any deals it contains
2066are assigned a unique ID by the server.
2067
2068Args:
2069 accountId: string, Account ID of the buyer. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2070 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2071 The object takes the form of:
2072
2073{ # Note: this resource requires whitelisting for access. Please contact your
2074 # account manager for access to Marketplace resources.
2075 #
2076 # Represents a proposal in the Marketplace. A proposal is the unit of
2077 # negotiation between a seller and a buyer and contains deals which
2078 # are served.
2079 #
2080 # Note: you can not update, create, or otherwise modify Private
2081 # Auction or Preferred Deals deals through the API.
2082 #
2083 # Fields are updatable unless noted otherwise.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2084 "deals": [ # The deals associated with this proposal. For Private Auction proposals
2085 # (whose deals have NonGuaranteedAuctionTerms), there will only be one deal.
2086 { # A deal represents a segment of inventory for displaying ads on.
2087 # A proposal can contain multiple deals. A deal contains the terms and
2088 # targeting information that is used for serving.
2089 "updateTime": "A String", # Output only. The time when the deal was last updated.
2090 "createProductRevision": "A String", # Optional revision number of the product that the deal was created from.
2091 # If present on create, and the server `product_revision` has advanced sinced
2092 # the passed-in `create_product_revision`, an `ABORTED` error will be
2093 # returned.
2094 #
2095 # Note: This field may be set only when creating the resource. Modifying
2096 # this field while updating the resource will result in an error.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2097 "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals.
2098 # PUBLISHER means creative is provided by seller and ADVERTISER means
2099 # creative is provided by buyer.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2100 "availableStartTime": "A String", # Optional proposed flight start time of the deal.
2101 # This will generally be stored in the granularity of one second since deal
2102 # serving starts at seconds boundary. Any time specified with more
2103 # granularity (e.g., in milliseconds) will be truncated towards the start of
2104 # time in seconds.
2105 "availableEndTime": "A String", # Proposed flight end time of the deal.
2106 # This will generally be stored in a granularity of a second.
2107 # A value is not required for Private Auction deals or Preferred Deals.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2108 "externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is
2109 # finalized. This is the deal ID that shows up in serving/reporting etc.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2110 "targeting": { # Targeting represents different criteria that can be used by advertisers to # Output only. Specifies the subset of inventory targeted by the deal.
2111 # target ad inventory. For example, they can choose to target ad requests only
2112 # if the user is in the US.
2113 # Multiple types of targeting are always applied as a logical AND, unless noted
2114 # otherwise.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2115 "placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or # Placement targeting information, e.g., URL, mobile applications.
2116 # mobile applications.
2117 # Different placement targeting types will be logically OR'ed.
2118 "urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). # URLs to be included/excluded.
2119 # For Private Auction and AdX Preferred Deals, URLs are either included or
2120 # excluded.
2121 # For Programmatic Guaranteed and Preferred Deals, this doesn't
2122 # apply.
2123 "excludedUrls": [ # A list of URLs to be excluded.
2124 "A String",
2125 ],
2126 "targetedUrls": [ # A list of URLs to be included.
2127 "A String",
2128 ],
2129 },
2130 "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal.
2131 # This doesn't apply to Auction Packages.
2132 "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that # Publisher owned apps to be targeted or excluded by the publisher to
2133 # display the ads in.
2134 # publishers own.
2135 # Mobile application IDs are from App Store and Google Play Store.
2136 # Android App ID, for example, com.google.android.apps.maps, can be found in
2137 # Google Play Store URL.
2138 # iOS App ID (which is a number) can be found at the end of iTunes store URL.
2139 # First party mobile applications is either included or excluded.
2140 "excludedAppIds": [ # A list of application IDs to be excluded.
2141 "A String",
2142 ],
2143 "targetedAppIds": [ # A list of application IDs to be included.
2144 "A String",
2145 ],
2146 },
2147 },
2148 },
2149 "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of # Geo criteria IDs to be included/excluded.
2150 # included and excluded numeric IDs.
2151 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
2152 "A String",
2153 ],
2154 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
2155 "A String",
2156 ],
2157 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2158 "videoTargeting": { # Represents targeting information about video. # Video targeting information.
2159 "excludedPositionTypes": [ # A list of video positions to be excluded.
2160 # Position types can either be included or excluded (XOR).
2161 "A String",
2162 ],
2163 "targetedPositionTypes": [ # A list of video positions to be included.
2164 # When the included list is present, the excluded list must be empty.
2165 # When the excluded list is present, the included list must be empty.
2166 "A String",
2167 ],
2168 },
2169 "technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category.
2170 "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device categories to be included/excluded.
2171 # included and excluded numeric IDs.
2172 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
2173 "A String",
2174 ],
2175 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
2176 "A String",
2177 ],
2178 },
2179 "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
2180 "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating systems to be included/excluded.
2181 # included and excluded numeric IDs.
2182 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
2183 "A String",
2184 ],
2185 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
2186 "A String",
2187 ],
2188 },
2189 "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating system versions to be included/excluded.
2190 # included and excluded numeric IDs.
2191 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
2192 "A String",
2193 ],
2194 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
2195 "A String",
2196 ],
2197 },
2198 },
2199 "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device capabilities to be included/excluded.
2200 # included and excluded numeric IDs.
2201 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
2202 "A String",
2203 ],
2204 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
2205 "A String",
2206 ],
2207 },
2208 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2209 "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on an ad # Inventory sizes to be included/excluded.
2210 # request. It only applies to Private Auction, AdX Preferred Deals and
2211 # Auction Packages. This targeting does not apply to Programmatic Guaranteed
2212 # and Preferred Deals in Ad Manager.
2213 "targetedInventorySizes": [ # A list of inventory sizes to be included.
2214 { # Represents size of a single ad slot, or a creative.
2215 "width": "A String", # The width of the ad slot in pixels.
2216 # This field will be present only when size type is `PIXEL`.
2217 "sizeType": "A String", # The size type of the ad slot.
2218 "height": "A String", # The height of the ad slot in pixels.
2219 # This field will be present only when size type is `PIXEL`.
2220 },
2221 ],
2222 "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
2223 { # Represents size of a single ad slot, or a creative.
2224 "width": "A String", # The width of the ad slot in pixels.
2225 # This field will be present only when size type is `PIXEL`.
2226 "sizeType": "A String", # The size type of the ad slot.
2227 "height": "A String", # The height of the ad slot in pixels.
2228 # This field will be present only when size type is `PIXEL`.
2229 },
2230 ],
2231 },
2232 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2233 "createTime": "A String", # Output only. The time of the deal creation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2234 "webPropertyCode": "A String", # The web property code for the seller copied over from the product.
2235 "proposalId": "A String", # Output only. ID of the proposal that this deal is part of.
2236 "deliveryControl": { # Message contains details about how the deals will be paced. # The set of fields around delivery control that are interesting for a buyer
2237 # to see but are non-negotiable. These are set by the publisher.
2238 "frequencyCaps": [ # Output only. Specifies any frequency caps.
2239 { # Frequency cap.
2240 "numTimeUnits": 42, # The amount of time, in the units specified by time_unit_type. Defines the
2241 # amount of time over which impressions per user are counted and capped.
2242 "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over
2243 # which impressions per user are counted and capped.
2244 "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the
2245 # specified time period.
2246 },
2247 ],
2248 "creativeBlockingLevel": "A String", # Output only. Specified the creative blocking levels to be applied.
2249 "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
2250 },
2251 "description": "A String", # Description for the deal terms.
2252 "dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned).
2253 "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
2254 "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2255 "creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ # Output only. Restricitions about the creatives associated with the deal
2256 # (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals
2257 # in Ad Manager.
2258 # Preferred Deal in Ad Manager.
2259 # This doesn't apply to Private Auction and AdX Preferred Deals.
2260 "creativeFormat": "A String", # The format of the environment that the creatives will be displayed in.
2261 "creativeSpecifications": [
2262 { # Represents information for a creative that is associated with a Programmatic
2263 # Guaranteed/Preferred Deal in Ad Manager.
2264 "creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative.
2265 "width": "A String", # The width of the ad slot in pixels.
2266 # This field will be present only when size type is `PIXEL`.
2267 "sizeType": "A String", # The size type of the ad slot.
2268 "height": "A String", # The height of the ad slot in pixels.
2269 # This field will be present only when size type is `PIXEL`.
2270 },
2271 "creativeCompanionSizes": [ # Companion sizes may be filled in only when this is a video creative.
2272 { # Represents size of a single ad slot, or a creative.
2273 "width": "A String", # The width of the ad slot in pixels.
2274 # This field will be present only when size type is `PIXEL`.
2275 "sizeType": "A String", # The size type of the ad slot.
2276 "height": "A String", # The height of the ad slot in pixels.
2277 # This field will be present only when size type is `PIXEL`.
2278 },
2279 ],
2280 },
2281 ],
2282 "skippableAdType": "A String", # Skippable video ads allow viewers to skip ads after 5 seconds.
2283 },
2284 "createProductId": "A String", # The product ID from which this deal was created.
2285 #
2286 # Note: This field may be set only when creating the resource. Modifying
2287 # this field while updating the resource will result in an error.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2288 "dealTerms": { # The deal terms specify the details of a Product/deal. They specify things # The negotiable terms of the deal.
2289 # like price per buyer, the type of pricing model (e.g., fixed price, auction)
2290 # and expected impressions from the publisher.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2291 "brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED)
2292 "estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal.
2293 # Can be set by buyer or seller.
2294 "pricingType": "A String", # The pricing type for the deal/product. (default: CPM)
2295 "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
2296 "nanos": 42, # Number of nano (10^-9) units of the amount.
2297 # The value must be between -999,999,999 and +999,999,999 inclusive.
2298 # If `units` is positive, `nanos` must be positive or zero.
2299 # If `units` is zero, `nanos` can be positive, zero, or negative.
2300 # If `units` is negative, `nanos` must be negative or zero.
2301 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
2302 "units": "A String", # The whole units of the amount.
2303 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
2304 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
2305 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2306 },
2307 "sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the
2308 # time zone used to mark the boundaries of a day. It should be an
2309 # IANA TZ name, such as "America/Los_Angeles". For more information,
2310 # see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.
2311 "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day.
2312 # Can be set by buyer or seller.
2313 "nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via # The terms for non-guaranteed fixed price deals.
2314 # the API at this time, but can be returned in a get or list request.
2315 "fixedPrices": [ # Fixed price for the specified buyer.
2316 { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in
2317 # a product can become 0 or 1 deals. To check if there is a PricePerBuyer for
2318 # a particular buyer or buyer/advertiser pair, we look for the most specific
2319 # matching rule - we first look for a rule matching the buyer and advertiser,
2320 # next a rule with the buyer but an empty advertiser list, and otherwise look
2321 # for a matching rule where no buyer is set.
2322 "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # The buyer who will pay this price. If unset, all buyers can pay this price
2323 # (if the
2324 # advertisers match, and there's no more specific rule matching the buyer).
2325 # Authorized Buyers account ID.
2326 "accountId": "A String", # Authorized Buyers account ID of the buyer.
2327 },
2328 "advertiserIds": [ # The list of advertisers for this price when associated with this buyer.
2329 # If empty, all advertisers with this buyer pay this price.
2330 "A String",
2331 ],
2332 "price": { # Represents a price and a pricing type for a product / deal. # The specified price.
2333 "pricingType": "A String", # The pricing type for the deal/product. (default: CPM)
2334 "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
2335 "nanos": 42, # Number of nano (10^-9) units of the amount.
2336 # The value must be between -999,999,999 and +999,999,999 inclusive.
2337 # If `units` is positive, `nanos` must be positive or zero.
2338 # If `units` is zero, `nanos` can be positive, zero, or negative.
2339 # If `units` is negative, `nanos` must be negative or zero.
2340 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
2341 "units": "A String", # The whole units of the amount.
2342 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
2343 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
2344 },
2345 },
2346 },
2347 ],
2348 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2349 "guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals.
2350 "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage
2351 # of guaranteed looks that the buyer is guaranteeing to buy.
2352 "fixedPrices": [ # Fixed price for the specified buyer.
2353 { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in
2354 # a product can become 0 or 1 deals. To check if there is a PricePerBuyer for
2355 # a particular buyer or buyer/advertiser pair, we look for the most specific
2356 # matching rule - we first look for a rule matching the buyer and advertiser,
2357 # next a rule with the buyer but an empty advertiser list, and otherwise look
2358 # for a matching rule where no buyer is set.
2359 "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # The buyer who will pay this price. If unset, all buyers can pay this price
2360 # (if the
2361 # advertisers match, and there's no more specific rule matching the buyer).
2362 # Authorized Buyers account ID.
2363 "accountId": "A String", # Authorized Buyers account ID of the buyer.
2364 },
2365 "advertiserIds": [ # The list of advertisers for this price when associated with this buyer.
2366 # If empty, all advertisers with this buyer pay this price.
2367 "A String",
2368 ],
2369 "price": { # Represents a price and a pricing type for a product / deal. # The specified price.
2370 "pricingType": "A String", # The pricing type for the deal/product. (default: CPM)
2371 "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
2372 "nanos": 42, # Number of nano (10^-9) units of the amount.
2373 # The value must be between -999,999,999 and +999,999,999 inclusive.
2374 # If `units` is positive, `nanos` must be positive or zero.
2375 # If `units` is zero, `nanos` can be positive, zero, or negative.
2376 # If `units` is negative, `nanos` must be negative or zero.
2377 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
2378 "units": "A String", # The whole units of the amount.
2379 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
2380 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
2381 },
2382 },
2383 },
2384 ],
2385 "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.
2386 "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2387 },
2388 "nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only # The terms for non-guaranteed auction deals.
2389 # by the seller, but they can be returned in a get or list request.
2390 "reservePricesPerBuyer": [ # Reserve price for the specified buyer.
2391 { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in
2392 # a product can become 0 or 1 deals. To check if there is a PricePerBuyer for
2393 # a particular buyer or buyer/advertiser pair, we look for the most specific
2394 # matching rule - we first look for a rule matching the buyer and advertiser,
2395 # next a rule with the buyer but an empty advertiser list, and otherwise look
2396 # for a matching rule where no buyer is set.
2397 "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # The buyer who will pay this price. If unset, all buyers can pay this price
2398 # (if the
2399 # advertisers match, and there's no more specific rule matching the buyer).
2400 # Authorized Buyers account ID.
2401 "accountId": "A String", # Authorized Buyers account ID of the buyer.
2402 },
2403 "advertiserIds": [ # The list of advertisers for this price when associated with this buyer.
2404 # If empty, all advertisers with this buyer pay this price.
2405 "A String",
2406 ],
2407 "price": { # Represents a price and a pricing type for a product / deal. # The specified price.
2408 "pricingType": "A String", # The pricing type for the deal/product. (default: CPM)
2409 "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
2410 "nanos": 42, # Number of nano (10^-9) units of the amount.
2411 # The value must be between -999,999,999 and +999,999,999 inclusive.
2412 # If `units` is positive, `nanos` must be positive or zero.
2413 # If `units` is zero, `nanos` can be positive, zero, or negative.
2414 # If `units` is negative, `nanos` must be negative or zero.
2415 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
2416 "units": "A String", # The whole units of the amount.
2417 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
2418 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
2419 },
2420 },
2421 },
2422 ],
2423 "autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers
2424 # in this private auction.
2425 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2426 "description": "A String", # Publisher provided description for the terms.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2427 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2428 "sellerContacts": [ # Output only. Seller contact information for the deal.
2429 { # Contains information on how a buyer or seller can be reached.
2430 "email": "A String", # Email address for the contact.
2431 "name": "A String", # The name of the contact.
2432 },
2433 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2434 "displayName": "A String", # The name of the deal.
2435 "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller).
2436 "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list
2437 # operations (max-length: 1024 unicode code units).
2438 },
2439 "syndicationProduct": "A String", # The syndication product associated with the deal.
2440 #
2441 # Note: This field may be set only when creating the resource. Modifying
2442 # this field while updating the resource will result in an error.
2443 "targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared
2444 # targeting entity is AND'd together.
2445 { # Advertisers can target different attributes of an ad slot. For example,
2446 # they can choose to show ads only if the user is in the U.S. Such
2447 # targeting criteria can be specified as part of Shared Targeting.
2448 "inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd
2449 # together.
2450 { # A polymorphic targeting value used as part of Shared Targeting.
2451 "stringValue": "A String", # The string value to include/exclude.
2452 "longValue": "A String", # The long value to include/exclude.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2453 "dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.
2454 # Filled in when the key is GOOG_DAYPART_TARGETING.
2455 # The definition of this targeting is derived from the structure
2456 # used by Ad Manager.
2457 "dayParts": [ # A list of day part targeting criterion.
2458 { # Daypart targeting message that specifies if the ad can be shown
2459 # only during certain parts of a day/week.
2460 "dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.
2461 "endTime": { # Represents a time of day. The date and time zone are either not significant # The ending time of the day for the ad to show (minute level
2462 # granularity). The end time is exclusive. This field is not available
2463 # for filtering in PQL queries.
2464 # or are specified elsewhere. An API may choose to allow leap seconds. Related
2465 # types are google.type.Date and `google.protobuf.Timestamp`.
2466 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
2467 # to allow the value "24:00:00" for scenarios like business closing time.
2468 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
2469 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
2470 # allow the value 60 if it allows leap-seconds.
2471 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
2472 },
2473 "startTime": { # Represents a time of day. The date and time zone are either not significant # The starting time of day for the ad to show (minute level granularity).
2474 # The start time is inclusive.
2475 # This field is not available for filtering in PQL queries.
2476 # or are specified elsewhere. An API may choose to allow leap seconds. Related
2477 # types are google.type.Date and `google.protobuf.Timestamp`.
2478 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
2479 # to allow the value "24:00:00" for scenarios like business closing time.
2480 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
2481 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
2482 # allow the value 60 if it allows leap-seconds.
2483 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
2484 },
2485 },
2486 ],
2487 "timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.
2488 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2489 "creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.
2490 # Filled in when key = GOOG_CREATIVE_SIZE
2491 "companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).
2492 # Companion sizes may be filled in only when creative_size_type = VIDEO
2493 { # Message depicting the size of the creative. The units of width and
2494 # height depend on the type of the targeting.
2495 "width": 42, # The width of the creative
2496 "height": 42, # The height of the creative.
2497 },
2498 ],
2499 "nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value
2500 # only if creative_size_type = CreativeSizeType.NATIVE.
2501 "allowedFormats": [ # What formats are allowed by the publisher.
2502 # If this repeated field is empty then all formats are allowed.
2503 # For example, if this field contains AllowedFormatType.AUDIO then the
2504 # publisher only allows an audio ad (without any video).
2505 "A String",
2506 ],
2507 "skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if
2508 # creative_size_type = CreativeSizeType.VIDEO.
2509 "creativeSizeType": "A String", # The creative size type.
2510 "size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size
2511 # of the creative
2512 # height depend on the type of the targeting.
2513 "width": 42, # The width of the creative
2514 "height": 42, # The height of the creative.
2515 },
2516 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2517 },
2518 ],
2519 "exclusions": [ # The list of values to exclude from targeting. Each value is AND'd
2520 # together.
2521 { # A polymorphic targeting value used as part of Shared Targeting.
2522 "stringValue": "A String", # The string value to include/exclude.
2523 "longValue": "A String", # The long value to include/exclude.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2524 "dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.
2525 # Filled in when the key is GOOG_DAYPART_TARGETING.
2526 # The definition of this targeting is derived from the structure
2527 # used by Ad Manager.
2528 "dayParts": [ # A list of day part targeting criterion.
2529 { # Daypart targeting message that specifies if the ad can be shown
2530 # only during certain parts of a day/week.
2531 "dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.
2532 "endTime": { # Represents a time of day. The date and time zone are either not significant # The ending time of the day for the ad to show (minute level
2533 # granularity). The end time is exclusive. This field is not available
2534 # for filtering in PQL queries.
2535 # or are specified elsewhere. An API may choose to allow leap seconds. Related
2536 # types are google.type.Date and `google.protobuf.Timestamp`.
2537 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
2538 # to allow the value "24:00:00" for scenarios like business closing time.
2539 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
2540 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
2541 # allow the value 60 if it allows leap-seconds.
2542 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
2543 },
2544 "startTime": { # Represents a time of day. The date and time zone are either not significant # The starting time of day for the ad to show (minute level granularity).
2545 # The start time is inclusive.
2546 # This field is not available for filtering in PQL queries.
2547 # or are specified elsewhere. An API may choose to allow leap seconds. Related
2548 # types are google.type.Date and `google.protobuf.Timestamp`.
2549 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
2550 # to allow the value "24:00:00" for scenarios like business closing time.
2551 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
2552 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
2553 # allow the value 60 if it allows leap-seconds.
2554 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
2555 },
2556 },
2557 ],
2558 "timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.
2559 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2560 "creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.
2561 # Filled in when key = GOOG_CREATIVE_SIZE
2562 "companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).
2563 # Companion sizes may be filled in only when creative_size_type = VIDEO
2564 { # Message depicting the size of the creative. The units of width and
2565 # height depend on the type of the targeting.
2566 "width": 42, # The width of the creative
2567 "height": 42, # The height of the creative.
2568 },
2569 ],
2570 "nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value
2571 # only if creative_size_type = CreativeSizeType.NATIVE.
2572 "allowedFormats": [ # What formats are allowed by the publisher.
2573 # If this repeated field is empty then all formats are allowed.
2574 # For example, if this field contains AllowedFormatType.AUDIO then the
2575 # publisher only allows an audio ad (without any video).
2576 "A String",
2577 ],
2578 "skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if
2579 # creative_size_type = CreativeSizeType.VIDEO.
2580 "creativeSizeType": "A String", # The creative size type.
2581 "size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size
2582 # of the creative
2583 # height depend on the type of the targeting.
2584 "width": 42, # The width of the creative
2585 "height": 42, # The height of the creative.
2586 },
2587 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2588 },
2589 ],
2590 "key": "A String", # The key representing the shared targeting criterion.
2591 # Targeting criteria defined by Google ad servers will begin with GOOG_.
2592 # Third parties may define their own keys.
2593 # A list of permissible keys along with the acceptable values will be
2594 # provided as part of the external documentation.
2595 },
2596 ],
2597 "dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal.
2598 "dealPauseStatus": { # Tracks which parties (if any) have paused a deal. # Output only. Tracks which parties (if any) have paused a deal.
2599 # The deal is considered paused if either hasBuyerPaused or
2600 # hasSellPaused is true.
2601 "hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally.
2602 "buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal.
2603 "sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal.
2604 "hasBuyerPaused": True or False, # True, if the buyer has paused the deal unilaterally.
2605 "firstPausedBy": "A String", # The role of the person who first paused this deal.
2606 },
2607 },
2608 "isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this
2609 # deal.
2610 },
2611 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2612 "updateTime": "A String", # Output only. The time when the proposal was last revised.
2613 "proposalState": "A String", # Output only. The current state of the proposal.
2614 "proposalRevision": "A String", # Output only. The revision number for the proposal.
2615 # Each update to the proposal or the deal causes the proposal revision number
2616 # to auto-increment. The buyer keeps track of the last revision number they
2617 # know of and pass it in when making an update. If the head revision number
2618 # on the server has since incremented, then an ABORTED error is returned
2619 # during the update operation to let the buyer know that a subsequent update
2620 # was made.
2621 "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller).
2622 "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list
2623 # operations (max-length: 1024 unicode code units).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2624 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2625 "privateAuctionId": "A String", # Output only. Private auction ID if this proposal is a private auction
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2626 # proposal.
2627 "notes": [ # Output only. The notes associated with this proposal.
2628 { # A proposal may be associated to several notes.
2629 "note": "A String", # The actual note to attach.
2630 # (max-length: 1024 unicode code units)
2631 #
2632 # Note: This field may be set only when creating the resource. Modifying
2633 # this field while updating the resource will result in an error.
2634 "creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note.
2635 "proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created.
2636 "createTime": "A String", # Output only. The timestamp for when this note was created.
2637 "noteId": "A String", # Output only. The unique ID for the note.
2638 },
2639 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2640 "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.
2641 "billedBuyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Output only. Reference to the buyer that will get billed for this proposal.
2642 # Authorized Buyers account ID.
2643 "accountId": "A String", # Authorized Buyers account ID of the buyer.
2644 },
2645 "seller": { # Represents a seller of inventory. Each seller is identified by a unique # Reference to the seller on the proposal.
2646 #
2647 # Note: This field may be set only when creating the resource. Modifying
2648 # this field while updating the resource will result in an error.
2649 # Ad Manager account ID.
2650 "subAccountId": "A String", # Optional sub-account ID for the seller.
2651 "accountId": "A String", # The unique ID for the seller. The seller fills in this field.
2652 # The seller account ID is then available to buyer in the product.
2653 },
2654 "sellerContacts": [ # Output only. Contact information for the seller.
2655 { # Contains information on how a buyer or seller can be reached.
2656 "email": "A String", # Email address for the contact.
2657 "name": "A String", # The name of the contact.
2658 },
2659 ],
2660 "proposalId": "A String", # Output only. The unique ID of the proposal.
2661 "isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated.
2662 "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Reference to the buyer on the proposal.
2663 #
2664 # Note: This field may be set only when creating the resource. Modifying
2665 # this field while updating the resource will result in an error.
2666 # Authorized Buyers account ID.
2667 "accountId": "A String", # Authorized Buyers account ID of the buyer.
2668 },
2669 "isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this
2670 # proposal.
2671 "displayName": "A String", # The name for the proposal.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2672 "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or
2673 # left a comment.
2674 "buyerContacts": [ # Contact information for the buyer.
2675 { # Contains information on how a buyer or seller can be reached.
2676 "email": "A String", # Email address for the contact.
2677 "name": "A String", # The name of the contact.
2678 },
2679 ],
2680}
2681
2682 x__xgafv: string, V1 error format.
2683 Allowed values
2684 1 - v1 error format
2685 2 - v2 error format
2686
2687Returns:
2688 An object of the form:
2689
2690 { # Note: this resource requires whitelisting for access. Please contact your
2691 # account manager for access to Marketplace resources.
2692 #
2693 # Represents a proposal in the Marketplace. A proposal is the unit of
2694 # negotiation between a seller and a buyer and contains deals which
2695 # are served.
2696 #
2697 # Note: you can not update, create, or otherwise modify Private
2698 # Auction or Preferred Deals deals through the API.
2699 #
2700 # Fields are updatable unless noted otherwise.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2701 "deals": [ # The deals associated with this proposal. For Private Auction proposals
2702 # (whose deals have NonGuaranteedAuctionTerms), there will only be one deal.
2703 { # A deal represents a segment of inventory for displaying ads on.
2704 # A proposal can contain multiple deals. A deal contains the terms and
2705 # targeting information that is used for serving.
2706 "updateTime": "A String", # Output only. The time when the deal was last updated.
2707 "createProductRevision": "A String", # Optional revision number of the product that the deal was created from.
2708 # If present on create, and the server `product_revision` has advanced sinced
2709 # the passed-in `create_product_revision`, an `ABORTED` error will be
2710 # returned.
2711 #
2712 # Note: This field may be set only when creating the resource. Modifying
2713 # this field while updating the resource will result in an error.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2714 "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals.
2715 # PUBLISHER means creative is provided by seller and ADVERTISER means
2716 # creative is provided by buyer.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2717 "availableStartTime": "A String", # Optional proposed flight start time of the deal.
2718 # This will generally be stored in the granularity of one second since deal
2719 # serving starts at seconds boundary. Any time specified with more
2720 # granularity (e.g., in milliseconds) will be truncated towards the start of
2721 # time in seconds.
2722 "availableEndTime": "A String", # Proposed flight end time of the deal.
2723 # This will generally be stored in a granularity of a second.
2724 # A value is not required for Private Auction deals or Preferred Deals.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2725 "externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is
2726 # finalized. This is the deal ID that shows up in serving/reporting etc.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2727 "targeting": { # Targeting represents different criteria that can be used by advertisers to # Output only. Specifies the subset of inventory targeted by the deal.
2728 # target ad inventory. For example, they can choose to target ad requests only
2729 # if the user is in the US.
2730 # Multiple types of targeting are always applied as a logical AND, unless noted
2731 # otherwise.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2732 "placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or # Placement targeting information, e.g., URL, mobile applications.
2733 # mobile applications.
2734 # Different placement targeting types will be logically OR'ed.
2735 "urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). # URLs to be included/excluded.
2736 # For Private Auction and AdX Preferred Deals, URLs are either included or
2737 # excluded.
2738 # For Programmatic Guaranteed and Preferred Deals, this doesn't
2739 # apply.
2740 "excludedUrls": [ # A list of URLs to be excluded.
2741 "A String",
2742 ],
2743 "targetedUrls": [ # A list of URLs to be included.
2744 "A String",
2745 ],
2746 },
2747 "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal.
2748 # This doesn't apply to Auction Packages.
2749 "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that # Publisher owned apps to be targeted or excluded by the publisher to
2750 # display the ads in.
2751 # publishers own.
2752 # Mobile application IDs are from App Store and Google Play Store.
2753 # Android App ID, for example, com.google.android.apps.maps, can be found in
2754 # Google Play Store URL.
2755 # iOS App ID (which is a number) can be found at the end of iTunes store URL.
2756 # First party mobile applications is either included or excluded.
2757 "excludedAppIds": [ # A list of application IDs to be excluded.
2758 "A String",
2759 ],
2760 "targetedAppIds": [ # A list of application IDs to be included.
2761 "A String",
2762 ],
2763 },
2764 },
2765 },
2766 "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of # Geo criteria IDs to be included/excluded.
2767 # included and excluded numeric IDs.
2768 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
2769 "A String",
2770 ],
2771 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
2772 "A String",
2773 ],
2774 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2775 "videoTargeting": { # Represents targeting information about video. # Video targeting information.
2776 "excludedPositionTypes": [ # A list of video positions to be excluded.
2777 # Position types can either be included or excluded (XOR).
2778 "A String",
2779 ],
2780 "targetedPositionTypes": [ # A list of video positions to be included.
2781 # When the included list is present, the excluded list must be empty.
2782 # When the excluded list is present, the included list must be empty.
2783 "A String",
2784 ],
2785 },
2786 "technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category.
2787 "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device categories to be included/excluded.
2788 # included and excluded numeric IDs.
2789 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
2790 "A String",
2791 ],
2792 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
2793 "A String",
2794 ],
2795 },
2796 "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
2797 "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating systems to be included/excluded.
2798 # included and excluded numeric IDs.
2799 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
2800 "A String",
2801 ],
2802 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
2803 "A String",
2804 ],
2805 },
2806 "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating system versions to be included/excluded.
2807 # included and excluded numeric IDs.
2808 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
2809 "A String",
2810 ],
2811 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
2812 "A String",
2813 ],
2814 },
2815 },
2816 "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device capabilities to be included/excluded.
2817 # included and excluded numeric IDs.
2818 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
2819 "A String",
2820 ],
2821 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
2822 "A String",
2823 ],
2824 },
2825 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2826 "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on an ad # Inventory sizes to be included/excluded.
2827 # request. It only applies to Private Auction, AdX Preferred Deals and
2828 # Auction Packages. This targeting does not apply to Programmatic Guaranteed
2829 # and Preferred Deals in Ad Manager.
2830 "targetedInventorySizes": [ # A list of inventory sizes to be included.
2831 { # Represents size of a single ad slot, or a creative.
2832 "width": "A String", # The width of the ad slot in pixels.
2833 # This field will be present only when size type is `PIXEL`.
2834 "sizeType": "A String", # The size type of the ad slot.
2835 "height": "A String", # The height of the ad slot in pixels.
2836 # This field will be present only when size type is `PIXEL`.
2837 },
2838 ],
2839 "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
2840 { # Represents size of a single ad slot, or a creative.
2841 "width": "A String", # The width of the ad slot in pixels.
2842 # This field will be present only when size type is `PIXEL`.
2843 "sizeType": "A String", # The size type of the ad slot.
2844 "height": "A String", # The height of the ad slot in pixels.
2845 # This field will be present only when size type is `PIXEL`.
2846 },
2847 ],
2848 },
2849 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2850 "createTime": "A String", # Output only. The time of the deal creation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2851 "webPropertyCode": "A String", # The web property code for the seller copied over from the product.
2852 "proposalId": "A String", # Output only. ID of the proposal that this deal is part of.
2853 "deliveryControl": { # Message contains details about how the deals will be paced. # The set of fields around delivery control that are interesting for a buyer
2854 # to see but are non-negotiable. These are set by the publisher.
2855 "frequencyCaps": [ # Output only. Specifies any frequency caps.
2856 { # Frequency cap.
2857 "numTimeUnits": 42, # The amount of time, in the units specified by time_unit_type. Defines the
2858 # amount of time over which impressions per user are counted and capped.
2859 "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over
2860 # which impressions per user are counted and capped.
2861 "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the
2862 # specified time period.
2863 },
2864 ],
2865 "creativeBlockingLevel": "A String", # Output only. Specified the creative blocking levels to be applied.
2866 "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
2867 },
2868 "description": "A String", # Description for the deal terms.
2869 "dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned).
2870 "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
2871 "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2872 "creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ # Output only. Restricitions about the creatives associated with the deal
2873 # (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals
2874 # in Ad Manager.
2875 # Preferred Deal in Ad Manager.
2876 # This doesn't apply to Private Auction and AdX Preferred Deals.
2877 "creativeFormat": "A String", # The format of the environment that the creatives will be displayed in.
2878 "creativeSpecifications": [
2879 { # Represents information for a creative that is associated with a Programmatic
2880 # Guaranteed/Preferred Deal in Ad Manager.
2881 "creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative.
2882 "width": "A String", # The width of the ad slot in pixels.
2883 # This field will be present only when size type is `PIXEL`.
2884 "sizeType": "A String", # The size type of the ad slot.
2885 "height": "A String", # The height of the ad slot in pixels.
2886 # This field will be present only when size type is `PIXEL`.
2887 },
2888 "creativeCompanionSizes": [ # Companion sizes may be filled in only when this is a video creative.
2889 { # Represents size of a single ad slot, or a creative.
2890 "width": "A String", # The width of the ad slot in pixels.
2891 # This field will be present only when size type is `PIXEL`.
2892 "sizeType": "A String", # The size type of the ad slot.
2893 "height": "A String", # The height of the ad slot in pixels.
2894 # This field will be present only when size type is `PIXEL`.
2895 },
2896 ],
2897 },
2898 ],
2899 "skippableAdType": "A String", # Skippable video ads allow viewers to skip ads after 5 seconds.
2900 },
2901 "createProductId": "A String", # The product ID from which this deal was created.
2902 #
2903 # Note: This field may be set only when creating the resource. Modifying
2904 # this field while updating the resource will result in an error.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2905 "dealTerms": { # The deal terms specify the details of a Product/deal. They specify things # The negotiable terms of the deal.
2906 # like price per buyer, the type of pricing model (e.g., fixed price, auction)
2907 # and expected impressions from the publisher.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2908 "brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED)
2909 "estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal.
2910 # Can be set by buyer or seller.
2911 "pricingType": "A String", # The pricing type for the deal/product. (default: CPM)
2912 "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
2913 "nanos": 42, # Number of nano (10^-9) units of the amount.
2914 # The value must be between -999,999,999 and +999,999,999 inclusive.
2915 # If `units` is positive, `nanos` must be positive or zero.
2916 # If `units` is zero, `nanos` can be positive, zero, or negative.
2917 # If `units` is negative, `nanos` must be negative or zero.
2918 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
2919 "units": "A String", # The whole units of the amount.
2920 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
2921 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
2922 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2923 },
2924 "sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the
2925 # time zone used to mark the boundaries of a day. It should be an
2926 # IANA TZ name, such as "America/Los_Angeles". For more information,
2927 # see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.
2928 "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day.
2929 # Can be set by buyer or seller.
2930 "nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via # The terms for non-guaranteed fixed price deals.
2931 # the API at this time, but can be returned in a get or list request.
2932 "fixedPrices": [ # Fixed price for the specified buyer.
2933 { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in
2934 # a product can become 0 or 1 deals. To check if there is a PricePerBuyer for
2935 # a particular buyer or buyer/advertiser pair, we look for the most specific
2936 # matching rule - we first look for a rule matching the buyer and advertiser,
2937 # next a rule with the buyer but an empty advertiser list, and otherwise look
2938 # for a matching rule where no buyer is set.
2939 "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # The buyer who will pay this price. If unset, all buyers can pay this price
2940 # (if the
2941 # advertisers match, and there's no more specific rule matching the buyer).
2942 # Authorized Buyers account ID.
2943 "accountId": "A String", # Authorized Buyers account ID of the buyer.
2944 },
2945 "advertiserIds": [ # The list of advertisers for this price when associated with this buyer.
2946 # If empty, all advertisers with this buyer pay this price.
2947 "A String",
2948 ],
2949 "price": { # Represents a price and a pricing type for a product / deal. # The specified price.
2950 "pricingType": "A String", # The pricing type for the deal/product. (default: CPM)
2951 "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
2952 "nanos": 42, # Number of nano (10^-9) units of the amount.
2953 # The value must be between -999,999,999 and +999,999,999 inclusive.
2954 # If `units` is positive, `nanos` must be positive or zero.
2955 # If `units` is zero, `nanos` can be positive, zero, or negative.
2956 # If `units` is negative, `nanos` must be negative or zero.
2957 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
2958 "units": "A String", # The whole units of the amount.
2959 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
2960 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
2961 },
2962 },
2963 },
2964 ],
2965 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2966 "guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals.
2967 "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage
2968 # of guaranteed looks that the buyer is guaranteeing to buy.
2969 "fixedPrices": [ # Fixed price for the specified buyer.
2970 { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in
2971 # a product can become 0 or 1 deals. To check if there is a PricePerBuyer for
2972 # a particular buyer or buyer/advertiser pair, we look for the most specific
2973 # matching rule - we first look for a rule matching the buyer and advertiser,
2974 # next a rule with the buyer but an empty advertiser list, and otherwise look
2975 # for a matching rule where no buyer is set.
2976 "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # The buyer who will pay this price. If unset, all buyers can pay this price
2977 # (if the
2978 # advertisers match, and there's no more specific rule matching the buyer).
2979 # Authorized Buyers account ID.
2980 "accountId": "A String", # Authorized Buyers account ID of the buyer.
2981 },
2982 "advertiserIds": [ # The list of advertisers for this price when associated with this buyer.
2983 # If empty, all advertisers with this buyer pay this price.
2984 "A String",
2985 ],
2986 "price": { # Represents a price and a pricing type for a product / deal. # The specified price.
2987 "pricingType": "A String", # The pricing type for the deal/product. (default: CPM)
2988 "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
2989 "nanos": 42, # Number of nano (10^-9) units of the amount.
2990 # The value must be between -999,999,999 and +999,999,999 inclusive.
2991 # If `units` is positive, `nanos` must be positive or zero.
2992 # If `units` is zero, `nanos` can be positive, zero, or negative.
2993 # If `units` is negative, `nanos` must be negative or zero.
2994 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
2995 "units": "A String", # The whole units of the amount.
2996 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
2997 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
2998 },
2999 },
3000 },
3001 ],
3002 "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.
3003 "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3004 },
3005 "nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only # The terms for non-guaranteed auction deals.
3006 # by the seller, but they can be returned in a get or list request.
3007 "reservePricesPerBuyer": [ # Reserve price for the specified buyer.
3008 { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in
3009 # a product can become 0 or 1 deals. To check if there is a PricePerBuyer for
3010 # a particular buyer or buyer/advertiser pair, we look for the most specific
3011 # matching rule - we first look for a rule matching the buyer and advertiser,
3012 # next a rule with the buyer but an empty advertiser list, and otherwise look
3013 # for a matching rule where no buyer is set.
3014 "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # The buyer who will pay this price. If unset, all buyers can pay this price
3015 # (if the
3016 # advertisers match, and there's no more specific rule matching the buyer).
3017 # Authorized Buyers account ID.
3018 "accountId": "A String", # Authorized Buyers account ID of the buyer.
3019 },
3020 "advertiserIds": [ # The list of advertisers for this price when associated with this buyer.
3021 # If empty, all advertisers with this buyer pay this price.
3022 "A String",
3023 ],
3024 "price": { # Represents a price and a pricing type for a product / deal. # The specified price.
3025 "pricingType": "A String", # The pricing type for the deal/product. (default: CPM)
3026 "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
3027 "nanos": 42, # Number of nano (10^-9) units of the amount.
3028 # The value must be between -999,999,999 and +999,999,999 inclusive.
3029 # If `units` is positive, `nanos` must be positive or zero.
3030 # If `units` is zero, `nanos` can be positive, zero, or negative.
3031 # If `units` is negative, `nanos` must be negative or zero.
3032 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
3033 "units": "A String", # The whole units of the amount.
3034 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
3035 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
3036 },
3037 },
3038 },
3039 ],
3040 "autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers
3041 # in this private auction.
3042 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3043 "description": "A String", # Publisher provided description for the terms.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3044 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3045 "sellerContacts": [ # Output only. Seller contact information for the deal.
3046 { # Contains information on how a buyer or seller can be reached.
3047 "email": "A String", # Email address for the contact.
3048 "name": "A String", # The name of the contact.
3049 },
3050 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3051 "displayName": "A String", # The name of the deal.
3052 "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller).
3053 "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list
3054 # operations (max-length: 1024 unicode code units).
3055 },
3056 "syndicationProduct": "A String", # The syndication product associated with the deal.
3057 #
3058 # Note: This field may be set only when creating the resource. Modifying
3059 # this field while updating the resource will result in an error.
3060 "targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared
3061 # targeting entity is AND'd together.
3062 { # Advertisers can target different attributes of an ad slot. For example,
3063 # they can choose to show ads only if the user is in the U.S. Such
3064 # targeting criteria can be specified as part of Shared Targeting.
3065 "inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd
3066 # together.
3067 { # A polymorphic targeting value used as part of Shared Targeting.
3068 "stringValue": "A String", # The string value to include/exclude.
3069 "longValue": "A String", # The long value to include/exclude.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3070 "dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.
3071 # Filled in when the key is GOOG_DAYPART_TARGETING.
3072 # The definition of this targeting is derived from the structure
3073 # used by Ad Manager.
3074 "dayParts": [ # A list of day part targeting criterion.
3075 { # Daypart targeting message that specifies if the ad can be shown
3076 # only during certain parts of a day/week.
3077 "dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.
3078 "endTime": { # Represents a time of day. The date and time zone are either not significant # The ending time of the day for the ad to show (minute level
3079 # granularity). The end time is exclusive. This field is not available
3080 # for filtering in PQL queries.
3081 # or are specified elsewhere. An API may choose to allow leap seconds. Related
3082 # types are google.type.Date and `google.protobuf.Timestamp`.
3083 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
3084 # to allow the value "24:00:00" for scenarios like business closing time.
3085 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
3086 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
3087 # allow the value 60 if it allows leap-seconds.
3088 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
3089 },
3090 "startTime": { # Represents a time of day. The date and time zone are either not significant # The starting time of day for the ad to show (minute level granularity).
3091 # The start time is inclusive.
3092 # This field is not available for filtering in PQL queries.
3093 # or are specified elsewhere. An API may choose to allow leap seconds. Related
3094 # types are google.type.Date and `google.protobuf.Timestamp`.
3095 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
3096 # to allow the value "24:00:00" for scenarios like business closing time.
3097 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
3098 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
3099 # allow the value 60 if it allows leap-seconds.
3100 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
3101 },
3102 },
3103 ],
3104 "timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.
3105 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3106 "creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.
3107 # Filled in when key = GOOG_CREATIVE_SIZE
3108 "companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).
3109 # Companion sizes may be filled in only when creative_size_type = VIDEO
3110 { # Message depicting the size of the creative. The units of width and
3111 # height depend on the type of the targeting.
3112 "width": 42, # The width of the creative
3113 "height": 42, # The height of the creative.
3114 },
3115 ],
3116 "nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value
3117 # only if creative_size_type = CreativeSizeType.NATIVE.
3118 "allowedFormats": [ # What formats are allowed by the publisher.
3119 # If this repeated field is empty then all formats are allowed.
3120 # For example, if this field contains AllowedFormatType.AUDIO then the
3121 # publisher only allows an audio ad (without any video).
3122 "A String",
3123 ],
3124 "skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if
3125 # creative_size_type = CreativeSizeType.VIDEO.
3126 "creativeSizeType": "A String", # The creative size type.
3127 "size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size
3128 # of the creative
3129 # height depend on the type of the targeting.
3130 "width": 42, # The width of the creative
3131 "height": 42, # The height of the creative.
3132 },
3133 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3134 },
3135 ],
3136 "exclusions": [ # The list of values to exclude from targeting. Each value is AND'd
3137 # together.
3138 { # A polymorphic targeting value used as part of Shared Targeting.
3139 "stringValue": "A String", # The string value to include/exclude.
3140 "longValue": "A String", # The long value to include/exclude.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3141 "dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.
3142 # Filled in when the key is GOOG_DAYPART_TARGETING.
3143 # The definition of this targeting is derived from the structure
3144 # used by Ad Manager.
3145 "dayParts": [ # A list of day part targeting criterion.
3146 { # Daypart targeting message that specifies if the ad can be shown
3147 # only during certain parts of a day/week.
3148 "dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.
3149 "endTime": { # Represents a time of day. The date and time zone are either not significant # The ending time of the day for the ad to show (minute level
3150 # granularity). The end time is exclusive. This field is not available
3151 # for filtering in PQL queries.
3152 # or are specified elsewhere. An API may choose to allow leap seconds. Related
3153 # types are google.type.Date and `google.protobuf.Timestamp`.
3154 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
3155 # to allow the value "24:00:00" for scenarios like business closing time.
3156 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
3157 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
3158 # allow the value 60 if it allows leap-seconds.
3159 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
3160 },
3161 "startTime": { # Represents a time of day. The date and time zone are either not significant # The starting time of day for the ad to show (minute level granularity).
3162 # The start time is inclusive.
3163 # This field is not available for filtering in PQL queries.
3164 # or are specified elsewhere. An API may choose to allow leap seconds. Related
3165 # types are google.type.Date and `google.protobuf.Timestamp`.
3166 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
3167 # to allow the value "24:00:00" for scenarios like business closing time.
3168 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
3169 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
3170 # allow the value 60 if it allows leap-seconds.
3171 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
3172 },
3173 },
3174 ],
3175 "timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.
3176 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3177 "creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.
3178 # Filled in when key = GOOG_CREATIVE_SIZE
3179 "companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).
3180 # Companion sizes may be filled in only when creative_size_type = VIDEO
3181 { # Message depicting the size of the creative. The units of width and
3182 # height depend on the type of the targeting.
3183 "width": 42, # The width of the creative
3184 "height": 42, # The height of the creative.
3185 },
3186 ],
3187 "nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value
3188 # only if creative_size_type = CreativeSizeType.NATIVE.
3189 "allowedFormats": [ # What formats are allowed by the publisher.
3190 # If this repeated field is empty then all formats are allowed.
3191 # For example, if this field contains AllowedFormatType.AUDIO then the
3192 # publisher only allows an audio ad (without any video).
3193 "A String",
3194 ],
3195 "skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if
3196 # creative_size_type = CreativeSizeType.VIDEO.
3197 "creativeSizeType": "A String", # The creative size type.
3198 "size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size
3199 # of the creative
3200 # height depend on the type of the targeting.
3201 "width": 42, # The width of the creative
3202 "height": 42, # The height of the creative.
3203 },
3204 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3205 },
3206 ],
3207 "key": "A String", # The key representing the shared targeting criterion.
3208 # Targeting criteria defined by Google ad servers will begin with GOOG_.
3209 # Third parties may define their own keys.
3210 # A list of permissible keys along with the acceptable values will be
3211 # provided as part of the external documentation.
3212 },
3213 ],
3214 "dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal.
3215 "dealPauseStatus": { # Tracks which parties (if any) have paused a deal. # Output only. Tracks which parties (if any) have paused a deal.
3216 # The deal is considered paused if either hasBuyerPaused or
3217 # hasSellPaused is true.
3218 "hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally.
3219 "buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal.
3220 "sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal.
3221 "hasBuyerPaused": True or False, # True, if the buyer has paused the deal unilaterally.
3222 "firstPausedBy": "A String", # The role of the person who first paused this deal.
3223 },
3224 },
3225 "isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this
3226 # deal.
3227 },
3228 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3229 "updateTime": "A String", # Output only. The time when the proposal was last revised.
3230 "proposalState": "A String", # Output only. The current state of the proposal.
3231 "proposalRevision": "A String", # Output only. The revision number for the proposal.
3232 # Each update to the proposal or the deal causes the proposal revision number
3233 # to auto-increment. The buyer keeps track of the last revision number they
3234 # know of and pass it in when making an update. If the head revision number
3235 # on the server has since incremented, then an ABORTED error is returned
3236 # during the update operation to let the buyer know that a subsequent update
3237 # was made.
3238 "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller).
3239 "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list
3240 # operations (max-length: 1024 unicode code units).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3241 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3242 "privateAuctionId": "A String", # Output only. Private auction ID if this proposal is a private auction
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3243 # proposal.
3244 "notes": [ # Output only. The notes associated with this proposal.
3245 { # A proposal may be associated to several notes.
3246 "note": "A String", # The actual note to attach.
3247 # (max-length: 1024 unicode code units)
3248 #
3249 # Note: This field may be set only when creating the resource. Modifying
3250 # this field while updating the resource will result in an error.
3251 "creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note.
3252 "proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created.
3253 "createTime": "A String", # Output only. The timestamp for when this note was created.
3254 "noteId": "A String", # Output only. The unique ID for the note.
3255 },
3256 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3257 "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.
3258 "billedBuyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Output only. Reference to the buyer that will get billed for this proposal.
3259 # Authorized Buyers account ID.
3260 "accountId": "A String", # Authorized Buyers account ID of the buyer.
3261 },
3262 "seller": { # Represents a seller of inventory. Each seller is identified by a unique # Reference to the seller on the proposal.
3263 #
3264 # Note: This field may be set only when creating the resource. Modifying
3265 # this field while updating the resource will result in an error.
3266 # Ad Manager account ID.
3267 "subAccountId": "A String", # Optional sub-account ID for the seller.
3268 "accountId": "A String", # The unique ID for the seller. The seller fills in this field.
3269 # The seller account ID is then available to buyer in the product.
3270 },
3271 "sellerContacts": [ # Output only. Contact information for the seller.
3272 { # Contains information on how a buyer or seller can be reached.
3273 "email": "A String", # Email address for the contact.
3274 "name": "A String", # The name of the contact.
3275 },
3276 ],
3277 "proposalId": "A String", # Output only. The unique ID of the proposal.
3278 "isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated.
3279 "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Reference to the buyer on the proposal.
3280 #
3281 # Note: This field may be set only when creating the resource. Modifying
3282 # this field while updating the resource will result in an error.
3283 # Authorized Buyers account ID.
3284 "accountId": "A String", # Authorized Buyers account ID of the buyer.
3285 },
3286 "isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this
3287 # proposal.
3288 "displayName": "A String", # The name for the proposal.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3289 "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or
3290 # left a comment.
3291 "buyerContacts": [ # Contact information for the buyer.
3292 { # Contains information on how a buyer or seller can be reached.
3293 "email": "A String", # Email address for the contact.
3294 "name": "A String", # The name of the contact.
3295 },
3296 ],
3297 }</pre>
3298</div>
3299
3300<div class="method">
3301 <code class="details" id="get">get(accountId, proposalId, x__xgafv=None)</code>
3302 <pre>Gets a proposal given its ID. The proposal is returned at its head
3303revision.
3304
3305Args:
3306 accountId: string, Account ID of the buyer. (required)
3307 proposalId: string, The unique ID of the proposal (required)
3308 x__xgafv: string, V1 error format.
3309 Allowed values
3310 1 - v1 error format
3311 2 - v2 error format
3312
3313Returns:
3314 An object of the form:
3315
3316 { # Note: this resource requires whitelisting for access. Please contact your
3317 # account manager for access to Marketplace resources.
3318 #
3319 # Represents a proposal in the Marketplace. A proposal is the unit of
3320 # negotiation between a seller and a buyer and contains deals which
3321 # are served.
3322 #
3323 # Note: you can not update, create, or otherwise modify Private
3324 # Auction or Preferred Deals deals through the API.
3325 #
3326 # Fields are updatable unless noted otherwise.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3327 "deals": [ # The deals associated with this proposal. For Private Auction proposals
3328 # (whose deals have NonGuaranteedAuctionTerms), there will only be one deal.
3329 { # A deal represents a segment of inventory for displaying ads on.
3330 # A proposal can contain multiple deals. A deal contains the terms and
3331 # targeting information that is used for serving.
3332 "updateTime": "A String", # Output only. The time when the deal was last updated.
3333 "createProductRevision": "A String", # Optional revision number of the product that the deal was created from.
3334 # If present on create, and the server `product_revision` has advanced sinced
3335 # the passed-in `create_product_revision`, an `ABORTED` error will be
3336 # returned.
3337 #
3338 # Note: This field may be set only when creating the resource. Modifying
3339 # this field while updating the resource will result in an error.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3340 "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals.
3341 # PUBLISHER means creative is provided by seller and ADVERTISER means
3342 # creative is provided by buyer.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3343 "availableStartTime": "A String", # Optional proposed flight start time of the deal.
3344 # This will generally be stored in the granularity of one second since deal
3345 # serving starts at seconds boundary. Any time specified with more
3346 # granularity (e.g., in milliseconds) will be truncated towards the start of
3347 # time in seconds.
3348 "availableEndTime": "A String", # Proposed flight end time of the deal.
3349 # This will generally be stored in a granularity of a second.
3350 # A value is not required for Private Auction deals or Preferred Deals.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3351 "externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is
3352 # finalized. This is the deal ID that shows up in serving/reporting etc.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3353 "targeting": { # Targeting represents different criteria that can be used by advertisers to # Output only. Specifies the subset of inventory targeted by the deal.
3354 # target ad inventory. For example, they can choose to target ad requests only
3355 # if the user is in the US.
3356 # Multiple types of targeting are always applied as a logical AND, unless noted
3357 # otherwise.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3358 "placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or # Placement targeting information, e.g., URL, mobile applications.
3359 # mobile applications.
3360 # Different placement targeting types will be logically OR'ed.
3361 "urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). # URLs to be included/excluded.
3362 # For Private Auction and AdX Preferred Deals, URLs are either included or
3363 # excluded.
3364 # For Programmatic Guaranteed and Preferred Deals, this doesn't
3365 # apply.
3366 "excludedUrls": [ # A list of URLs to be excluded.
3367 "A String",
3368 ],
3369 "targetedUrls": [ # A list of URLs to be included.
3370 "A String",
3371 ],
3372 },
3373 "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal.
3374 # This doesn't apply to Auction Packages.
3375 "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that # Publisher owned apps to be targeted or excluded by the publisher to
3376 # display the ads in.
3377 # publishers own.
3378 # Mobile application IDs are from App Store and Google Play Store.
3379 # Android App ID, for example, com.google.android.apps.maps, can be found in
3380 # Google Play Store URL.
3381 # iOS App ID (which is a number) can be found at the end of iTunes store URL.
3382 # First party mobile applications is either included or excluded.
3383 "excludedAppIds": [ # A list of application IDs to be excluded.
3384 "A String",
3385 ],
3386 "targetedAppIds": [ # A list of application IDs to be included.
3387 "A String",
3388 ],
3389 },
3390 },
3391 },
3392 "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of # Geo criteria IDs to be included/excluded.
3393 # included and excluded numeric IDs.
3394 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
3395 "A String",
3396 ],
3397 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
3398 "A String",
3399 ],
3400 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3401 "videoTargeting": { # Represents targeting information about video. # Video targeting information.
3402 "excludedPositionTypes": [ # A list of video positions to be excluded.
3403 # Position types can either be included or excluded (XOR).
3404 "A String",
3405 ],
3406 "targetedPositionTypes": [ # A list of video positions to be included.
3407 # When the included list is present, the excluded list must be empty.
3408 # When the excluded list is present, the included list must be empty.
3409 "A String",
3410 ],
3411 },
3412 "technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category.
3413 "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device categories to be included/excluded.
3414 # included and excluded numeric IDs.
3415 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
3416 "A String",
3417 ],
3418 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
3419 "A String",
3420 ],
3421 },
3422 "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
3423 "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating systems to be included/excluded.
3424 # included and excluded numeric IDs.
3425 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
3426 "A String",
3427 ],
3428 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
3429 "A String",
3430 ],
3431 },
3432 "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating system versions to be included/excluded.
3433 # included and excluded numeric IDs.
3434 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
3435 "A String",
3436 ],
3437 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
3438 "A String",
3439 ],
3440 },
3441 },
3442 "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device capabilities to be included/excluded.
3443 # included and excluded numeric IDs.
3444 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
3445 "A String",
3446 ],
3447 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
3448 "A String",
3449 ],
3450 },
3451 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3452 "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on an ad # Inventory sizes to be included/excluded.
3453 # request. It only applies to Private Auction, AdX Preferred Deals and
3454 # Auction Packages. This targeting does not apply to Programmatic Guaranteed
3455 # and Preferred Deals in Ad Manager.
3456 "targetedInventorySizes": [ # A list of inventory sizes to be included.
3457 { # Represents size of a single ad slot, or a creative.
3458 "width": "A String", # The width of the ad slot in pixels.
3459 # This field will be present only when size type is `PIXEL`.
3460 "sizeType": "A String", # The size type of the ad slot.
3461 "height": "A String", # The height of the ad slot in pixels.
3462 # This field will be present only when size type is `PIXEL`.
3463 },
3464 ],
3465 "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
3466 { # Represents size of a single ad slot, or a creative.
3467 "width": "A String", # The width of the ad slot in pixels.
3468 # This field will be present only when size type is `PIXEL`.
3469 "sizeType": "A String", # The size type of the ad slot.
3470 "height": "A String", # The height of the ad slot in pixels.
3471 # This field will be present only when size type is `PIXEL`.
3472 },
3473 ],
3474 },
3475 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3476 "createTime": "A String", # Output only. The time of the deal creation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3477 "webPropertyCode": "A String", # The web property code for the seller copied over from the product.
3478 "proposalId": "A String", # Output only. ID of the proposal that this deal is part of.
3479 "deliveryControl": { # Message contains details about how the deals will be paced. # The set of fields around delivery control that are interesting for a buyer
3480 # to see but are non-negotiable. These are set by the publisher.
3481 "frequencyCaps": [ # Output only. Specifies any frequency caps.
3482 { # Frequency cap.
3483 "numTimeUnits": 42, # The amount of time, in the units specified by time_unit_type. Defines the
3484 # amount of time over which impressions per user are counted and capped.
3485 "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over
3486 # which impressions per user are counted and capped.
3487 "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the
3488 # specified time period.
3489 },
3490 ],
3491 "creativeBlockingLevel": "A String", # Output only. Specified the creative blocking levels to be applied.
3492 "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
3493 },
3494 "description": "A String", # Description for the deal terms.
3495 "dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned).
3496 "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
3497 "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3498 "creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ # Output only. Restricitions about the creatives associated with the deal
3499 # (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals
3500 # in Ad Manager.
3501 # Preferred Deal in Ad Manager.
3502 # This doesn't apply to Private Auction and AdX Preferred Deals.
3503 "creativeFormat": "A String", # The format of the environment that the creatives will be displayed in.
3504 "creativeSpecifications": [
3505 { # Represents information for a creative that is associated with a Programmatic
3506 # Guaranteed/Preferred Deal in Ad Manager.
3507 "creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative.
3508 "width": "A String", # The width of the ad slot in pixels.
3509 # This field will be present only when size type is `PIXEL`.
3510 "sizeType": "A String", # The size type of the ad slot.
3511 "height": "A String", # The height of the ad slot in pixels.
3512 # This field will be present only when size type is `PIXEL`.
3513 },
3514 "creativeCompanionSizes": [ # Companion sizes may be filled in only when this is a video creative.
3515 { # Represents size of a single ad slot, or a creative.
3516 "width": "A String", # The width of the ad slot in pixels.
3517 # This field will be present only when size type is `PIXEL`.
3518 "sizeType": "A String", # The size type of the ad slot.
3519 "height": "A String", # The height of the ad slot in pixels.
3520 # This field will be present only when size type is `PIXEL`.
3521 },
3522 ],
3523 },
3524 ],
3525 "skippableAdType": "A String", # Skippable video ads allow viewers to skip ads after 5 seconds.
3526 },
3527 "createProductId": "A String", # The product ID from which this deal was created.
3528 #
3529 # Note: This field may be set only when creating the resource. Modifying
3530 # this field while updating the resource will result in an error.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3531 "dealTerms": { # The deal terms specify the details of a Product/deal. They specify things # The negotiable terms of the deal.
3532 # like price per buyer, the type of pricing model (e.g., fixed price, auction)
3533 # and expected impressions from the publisher.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3534 "brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED)
3535 "estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal.
3536 # Can be set by buyer or seller.
3537 "pricingType": "A String", # The pricing type for the deal/product. (default: CPM)
3538 "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
3539 "nanos": 42, # Number of nano (10^-9) units of the amount.
3540 # The value must be between -999,999,999 and +999,999,999 inclusive.
3541 # If `units` is positive, `nanos` must be positive or zero.
3542 # If `units` is zero, `nanos` can be positive, zero, or negative.
3543 # If `units` is negative, `nanos` must be negative or zero.
3544 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
3545 "units": "A String", # The whole units of the amount.
3546 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
3547 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
3548 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3549 },
3550 "sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the
3551 # time zone used to mark the boundaries of a day. It should be an
3552 # IANA TZ name, such as "America/Los_Angeles". For more information,
3553 # see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.
3554 "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day.
3555 # Can be set by buyer or seller.
3556 "nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via # The terms for non-guaranteed fixed price deals.
3557 # the API at this time, but can be returned in a get or list request.
3558 "fixedPrices": [ # Fixed price for the specified buyer.
3559 { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in
3560 # a product can become 0 or 1 deals. To check if there is a PricePerBuyer for
3561 # a particular buyer or buyer/advertiser pair, we look for the most specific
3562 # matching rule - we first look for a rule matching the buyer and advertiser,
3563 # next a rule with the buyer but an empty advertiser list, and otherwise look
3564 # for a matching rule where no buyer is set.
3565 "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # The buyer who will pay this price. If unset, all buyers can pay this price
3566 # (if the
3567 # advertisers match, and there's no more specific rule matching the buyer).
3568 # Authorized Buyers account ID.
3569 "accountId": "A String", # Authorized Buyers account ID of the buyer.
3570 },
3571 "advertiserIds": [ # The list of advertisers for this price when associated with this buyer.
3572 # If empty, all advertisers with this buyer pay this price.
3573 "A String",
3574 ],
3575 "price": { # Represents a price and a pricing type for a product / deal. # The specified price.
3576 "pricingType": "A String", # The pricing type for the deal/product. (default: CPM)
3577 "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
3578 "nanos": 42, # Number of nano (10^-9) units of the amount.
3579 # The value must be between -999,999,999 and +999,999,999 inclusive.
3580 # If `units` is positive, `nanos` must be positive or zero.
3581 # If `units` is zero, `nanos` can be positive, zero, or negative.
3582 # If `units` is negative, `nanos` must be negative or zero.
3583 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
3584 "units": "A String", # The whole units of the amount.
3585 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
3586 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
3587 },
3588 },
3589 },
3590 ],
3591 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3592 "guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals.
3593 "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage
3594 # of guaranteed looks that the buyer is guaranteeing to buy.
3595 "fixedPrices": [ # Fixed price for the specified buyer.
3596 { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in
3597 # a product can become 0 or 1 deals. To check if there is a PricePerBuyer for
3598 # a particular buyer or buyer/advertiser pair, we look for the most specific
3599 # matching rule - we first look for a rule matching the buyer and advertiser,
3600 # next a rule with the buyer but an empty advertiser list, and otherwise look
3601 # for a matching rule where no buyer is set.
3602 "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # The buyer who will pay this price. If unset, all buyers can pay this price
3603 # (if the
3604 # advertisers match, and there's no more specific rule matching the buyer).
3605 # Authorized Buyers account ID.
3606 "accountId": "A String", # Authorized Buyers account ID of the buyer.
3607 },
3608 "advertiserIds": [ # The list of advertisers for this price when associated with this buyer.
3609 # If empty, all advertisers with this buyer pay this price.
3610 "A String",
3611 ],
3612 "price": { # Represents a price and a pricing type for a product / deal. # The specified price.
3613 "pricingType": "A String", # The pricing type for the deal/product. (default: CPM)
3614 "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
3615 "nanos": 42, # Number of nano (10^-9) units of the amount.
3616 # The value must be between -999,999,999 and +999,999,999 inclusive.
3617 # If `units` is positive, `nanos` must be positive or zero.
3618 # If `units` is zero, `nanos` can be positive, zero, or negative.
3619 # If `units` is negative, `nanos` must be negative or zero.
3620 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
3621 "units": "A String", # The whole units of the amount.
3622 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
3623 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
3624 },
3625 },
3626 },
3627 ],
3628 "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.
3629 "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3630 },
3631 "nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only # The terms for non-guaranteed auction deals.
3632 # by the seller, but they can be returned in a get or list request.
3633 "reservePricesPerBuyer": [ # Reserve price for the specified buyer.
3634 { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in
3635 # a product can become 0 or 1 deals. To check if there is a PricePerBuyer for
3636 # a particular buyer or buyer/advertiser pair, we look for the most specific
3637 # matching rule - we first look for a rule matching the buyer and advertiser,
3638 # next a rule with the buyer but an empty advertiser list, and otherwise look
3639 # for a matching rule where no buyer is set.
3640 "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # The buyer who will pay this price. If unset, all buyers can pay this price
3641 # (if the
3642 # advertisers match, and there's no more specific rule matching the buyer).
3643 # Authorized Buyers account ID.
3644 "accountId": "A String", # Authorized Buyers account ID of the buyer.
3645 },
3646 "advertiserIds": [ # The list of advertisers for this price when associated with this buyer.
3647 # If empty, all advertisers with this buyer pay this price.
3648 "A String",
3649 ],
3650 "price": { # Represents a price and a pricing type for a product / deal. # The specified price.
3651 "pricingType": "A String", # The pricing type for the deal/product. (default: CPM)
3652 "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
3653 "nanos": 42, # Number of nano (10^-9) units of the amount.
3654 # The value must be between -999,999,999 and +999,999,999 inclusive.
3655 # If `units` is positive, `nanos` must be positive or zero.
3656 # If `units` is zero, `nanos` can be positive, zero, or negative.
3657 # If `units` is negative, `nanos` must be negative or zero.
3658 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
3659 "units": "A String", # The whole units of the amount.
3660 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
3661 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
3662 },
3663 },
3664 },
3665 ],
3666 "autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers
3667 # in this private auction.
3668 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3669 "description": "A String", # Publisher provided description for the terms.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3670 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3671 "sellerContacts": [ # Output only. Seller contact information for the deal.
3672 { # Contains information on how a buyer or seller can be reached.
3673 "email": "A String", # Email address for the contact.
3674 "name": "A String", # The name of the contact.
3675 },
3676 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3677 "displayName": "A String", # The name of the deal.
3678 "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller).
3679 "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list
3680 # operations (max-length: 1024 unicode code units).
3681 },
3682 "syndicationProduct": "A String", # The syndication product associated with the deal.
3683 #
3684 # Note: This field may be set only when creating the resource. Modifying
3685 # this field while updating the resource will result in an error.
3686 "targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared
3687 # targeting entity is AND'd together.
3688 { # Advertisers can target different attributes of an ad slot. For example,
3689 # they can choose to show ads only if the user is in the U.S. Such
3690 # targeting criteria can be specified as part of Shared Targeting.
3691 "inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd
3692 # together.
3693 { # A polymorphic targeting value used as part of Shared Targeting.
3694 "stringValue": "A String", # The string value to include/exclude.
3695 "longValue": "A String", # The long value to include/exclude.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3696 "dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.
3697 # Filled in when the key is GOOG_DAYPART_TARGETING.
3698 # The definition of this targeting is derived from the structure
3699 # used by Ad Manager.
3700 "dayParts": [ # A list of day part targeting criterion.
3701 { # Daypart targeting message that specifies if the ad can be shown
3702 # only during certain parts of a day/week.
3703 "dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.
3704 "endTime": { # Represents a time of day. The date and time zone are either not significant # The ending time of the day for the ad to show (minute level
3705 # granularity). The end time is exclusive. This field is not available
3706 # for filtering in PQL queries.
3707 # or are specified elsewhere. An API may choose to allow leap seconds. Related
3708 # types are google.type.Date and `google.protobuf.Timestamp`.
3709 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
3710 # to allow the value "24:00:00" for scenarios like business closing time.
3711 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
3712 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
3713 # allow the value 60 if it allows leap-seconds.
3714 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
3715 },
3716 "startTime": { # Represents a time of day. The date and time zone are either not significant # The starting time of day for the ad to show (minute level granularity).
3717 # The start time is inclusive.
3718 # This field is not available for filtering in PQL queries.
3719 # or are specified elsewhere. An API may choose to allow leap seconds. Related
3720 # types are google.type.Date and `google.protobuf.Timestamp`.
3721 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
3722 # to allow the value "24:00:00" for scenarios like business closing time.
3723 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
3724 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
3725 # allow the value 60 if it allows leap-seconds.
3726 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
3727 },
3728 },
3729 ],
3730 "timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.
3731 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3732 "creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.
3733 # Filled in when key = GOOG_CREATIVE_SIZE
3734 "companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).
3735 # Companion sizes may be filled in only when creative_size_type = VIDEO
3736 { # Message depicting the size of the creative. The units of width and
3737 # height depend on the type of the targeting.
3738 "width": 42, # The width of the creative
3739 "height": 42, # The height of the creative.
3740 },
3741 ],
3742 "nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value
3743 # only if creative_size_type = CreativeSizeType.NATIVE.
3744 "allowedFormats": [ # What formats are allowed by the publisher.
3745 # If this repeated field is empty then all formats are allowed.
3746 # For example, if this field contains AllowedFormatType.AUDIO then the
3747 # publisher only allows an audio ad (without any video).
3748 "A String",
3749 ],
3750 "skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if
3751 # creative_size_type = CreativeSizeType.VIDEO.
3752 "creativeSizeType": "A String", # The creative size type.
3753 "size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size
3754 # of the creative
3755 # height depend on the type of the targeting.
3756 "width": 42, # The width of the creative
3757 "height": 42, # The height of the creative.
3758 },
3759 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3760 },
3761 ],
3762 "exclusions": [ # The list of values to exclude from targeting. Each value is AND'd
3763 # together.
3764 { # A polymorphic targeting value used as part of Shared Targeting.
3765 "stringValue": "A String", # The string value to include/exclude.
3766 "longValue": "A String", # The long value to include/exclude.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3767 "dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.
3768 # Filled in when the key is GOOG_DAYPART_TARGETING.
3769 # The definition of this targeting is derived from the structure
3770 # used by Ad Manager.
3771 "dayParts": [ # A list of day part targeting criterion.
3772 { # Daypart targeting message that specifies if the ad can be shown
3773 # only during certain parts of a day/week.
3774 "dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.
3775 "endTime": { # Represents a time of day. The date and time zone are either not significant # The ending time of the day for the ad to show (minute level
3776 # granularity). The end time is exclusive. This field is not available
3777 # for filtering in PQL queries.
3778 # or are specified elsewhere. An API may choose to allow leap seconds. Related
3779 # types are google.type.Date and `google.protobuf.Timestamp`.
3780 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
3781 # to allow the value "24:00:00" for scenarios like business closing time.
3782 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
3783 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
3784 # allow the value 60 if it allows leap-seconds.
3785 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
3786 },
3787 "startTime": { # Represents a time of day. The date and time zone are either not significant # The starting time of day for the ad to show (minute level granularity).
3788 # The start time is inclusive.
3789 # This field is not available for filtering in PQL queries.
3790 # or are specified elsewhere. An API may choose to allow leap seconds. Related
3791 # types are google.type.Date and `google.protobuf.Timestamp`.
3792 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
3793 # to allow the value "24:00:00" for scenarios like business closing time.
3794 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
3795 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
3796 # allow the value 60 if it allows leap-seconds.
3797 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
3798 },
3799 },
3800 ],
3801 "timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.
3802 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3803 "creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.
3804 # Filled in when key = GOOG_CREATIVE_SIZE
3805 "companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).
3806 # Companion sizes may be filled in only when creative_size_type = VIDEO
3807 { # Message depicting the size of the creative. The units of width and
3808 # height depend on the type of the targeting.
3809 "width": 42, # The width of the creative
3810 "height": 42, # The height of the creative.
3811 },
3812 ],
3813 "nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value
3814 # only if creative_size_type = CreativeSizeType.NATIVE.
3815 "allowedFormats": [ # What formats are allowed by the publisher.
3816 # If this repeated field is empty then all formats are allowed.
3817 # For example, if this field contains AllowedFormatType.AUDIO then the
3818 # publisher only allows an audio ad (without any video).
3819 "A String",
3820 ],
3821 "skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if
3822 # creative_size_type = CreativeSizeType.VIDEO.
3823 "creativeSizeType": "A String", # The creative size type.
3824 "size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size
3825 # of the creative
3826 # height depend on the type of the targeting.
3827 "width": 42, # The width of the creative
3828 "height": 42, # The height of the creative.
3829 },
3830 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3831 },
3832 ],
3833 "key": "A String", # The key representing the shared targeting criterion.
3834 # Targeting criteria defined by Google ad servers will begin with GOOG_.
3835 # Third parties may define their own keys.
3836 # A list of permissible keys along with the acceptable values will be
3837 # provided as part of the external documentation.
3838 },
3839 ],
3840 "dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal.
3841 "dealPauseStatus": { # Tracks which parties (if any) have paused a deal. # Output only. Tracks which parties (if any) have paused a deal.
3842 # The deal is considered paused if either hasBuyerPaused or
3843 # hasSellPaused is true.
3844 "hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally.
3845 "buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal.
3846 "sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal.
3847 "hasBuyerPaused": True or False, # True, if the buyer has paused the deal unilaterally.
3848 "firstPausedBy": "A String", # The role of the person who first paused this deal.
3849 },
3850 },
3851 "isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this
3852 # deal.
3853 },
3854 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3855 "updateTime": "A String", # Output only. The time when the proposal was last revised.
3856 "proposalState": "A String", # Output only. The current state of the proposal.
3857 "proposalRevision": "A String", # Output only. The revision number for the proposal.
3858 # Each update to the proposal or the deal causes the proposal revision number
3859 # to auto-increment. The buyer keeps track of the last revision number they
3860 # know of and pass it in when making an update. If the head revision number
3861 # on the server has since incremented, then an ABORTED error is returned
3862 # during the update operation to let the buyer know that a subsequent update
3863 # was made.
3864 "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller).
3865 "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list
3866 # operations (max-length: 1024 unicode code units).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3867 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3868 "privateAuctionId": "A String", # Output only. Private auction ID if this proposal is a private auction
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3869 # proposal.
3870 "notes": [ # Output only. The notes associated with this proposal.
3871 { # A proposal may be associated to several notes.
3872 "note": "A String", # The actual note to attach.
3873 # (max-length: 1024 unicode code units)
3874 #
3875 # Note: This field may be set only when creating the resource. Modifying
3876 # this field while updating the resource will result in an error.
3877 "creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note.
3878 "proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created.
3879 "createTime": "A String", # Output only. The timestamp for when this note was created.
3880 "noteId": "A String", # Output only. The unique ID for the note.
3881 },
3882 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3883 "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.
3884 "billedBuyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Output only. Reference to the buyer that will get billed for this proposal.
3885 # Authorized Buyers account ID.
3886 "accountId": "A String", # Authorized Buyers account ID of the buyer.
3887 },
3888 "seller": { # Represents a seller of inventory. Each seller is identified by a unique # Reference to the seller on the proposal.
3889 #
3890 # Note: This field may be set only when creating the resource. Modifying
3891 # this field while updating the resource will result in an error.
3892 # Ad Manager account ID.
3893 "subAccountId": "A String", # Optional sub-account ID for the seller.
3894 "accountId": "A String", # The unique ID for the seller. The seller fills in this field.
3895 # The seller account ID is then available to buyer in the product.
3896 },
3897 "sellerContacts": [ # Output only. Contact information for the seller.
3898 { # Contains information on how a buyer or seller can be reached.
3899 "email": "A String", # Email address for the contact.
3900 "name": "A String", # The name of the contact.
3901 },
3902 ],
3903 "proposalId": "A String", # Output only. The unique ID of the proposal.
3904 "isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated.
3905 "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Reference to the buyer on the proposal.
3906 #
3907 # Note: This field may be set only when creating the resource. Modifying
3908 # this field while updating the resource will result in an error.
3909 # Authorized Buyers account ID.
3910 "accountId": "A String", # Authorized Buyers account ID of the buyer.
3911 },
3912 "isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this
3913 # proposal.
3914 "displayName": "A String", # The name for the proposal.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3915 "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or
3916 # left a comment.
3917 "buyerContacts": [ # Contact information for the buyer.
3918 { # Contains information on how a buyer or seller can be reached.
3919 "email": "A String", # Email address for the contact.
3920 "name": "A String", # The name of the contact.
3921 },
3922 ],
3923 }</pre>
3924</div>
3925
3926<div class="method">
3927 <code class="details" id="list">list(accountId, pageSize=None, pageToken=None, x__xgafv=None, filterSyntax=None, filter=None)</code>
3928 <pre>List proposals. A filter expression (PQL query) may be specified to
3929filter the results. To retrieve all finalized proposals, regardless if a
3930proposal is being renegotiated, see the FinalizedProposals resource.
3931Note that Bidder/ChildSeat relationships differ from the usual behavior.
3932A Bidder account can only see its child seats' proposals by specifying
3933the ChildSeat's accountId in the request path.
3934
3935Args:
3936 accountId: string, Account ID of the buyer. (required)
3937 pageSize: integer, Requested page size. The server may return fewer results than requested.
3938If unspecified, the server will pick an appropriate default.
3939 pageToken: string, The page token as returned from ListProposalsResponse.
3940 x__xgafv: string, V1 error format.
3941 Allowed values
3942 1 - v1 error format
3943 2 - v2 error format
3944 filterSyntax: string, Syntax the filter is written in. Current implementation defaults to PQL
3945but in the future it will be LIST_FILTER.
3946 filter: string, An optional PQL filter query used to query for proposals.
3947
3948Nested repeated fields, such as proposal.deals.targetingCriterion,
3949cannot be filtered.
3950
3951Returns:
3952 An object of the form:
3953
3954 { # Response message for listing proposals.
3955 "nextPageToken": "A String", # Continuation token for fetching the next page of results.
3956 "proposals": [ # The list of proposals.
3957 { # Note: this resource requires whitelisting for access. Please contact your
3958 # account manager for access to Marketplace resources.
3959 #
3960 # Represents a proposal in the Marketplace. A proposal is the unit of
3961 # negotiation between a seller and a buyer and contains deals which
3962 # are served.
3963 #
3964 # Note: you can not update, create, or otherwise modify Private
3965 # Auction or Preferred Deals deals through the API.
3966 #
3967 # Fields are updatable unless noted otherwise.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3968 "deals": [ # The deals associated with this proposal. For Private Auction proposals
3969 # (whose deals have NonGuaranteedAuctionTerms), there will only be one deal.
3970 { # A deal represents a segment of inventory for displaying ads on.
3971 # A proposal can contain multiple deals. A deal contains the terms and
3972 # targeting information that is used for serving.
3973 "updateTime": "A String", # Output only. The time when the deal was last updated.
3974 "createProductRevision": "A String", # Optional revision number of the product that the deal was created from.
3975 # If present on create, and the server `product_revision` has advanced sinced
3976 # the passed-in `create_product_revision`, an `ABORTED` error will be
3977 # returned.
3978 #
3979 # Note: This field may be set only when creating the resource. Modifying
3980 # this field while updating the resource will result in an error.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3981 "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals.
3982 # PUBLISHER means creative is provided by seller and ADVERTISER means
3983 # creative is provided by buyer.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3984 "availableStartTime": "A String", # Optional proposed flight start time of the deal.
3985 # This will generally be stored in the granularity of one second since deal
3986 # serving starts at seconds boundary. Any time specified with more
3987 # granularity (e.g., in milliseconds) will be truncated towards the start of
3988 # time in seconds.
3989 "availableEndTime": "A String", # Proposed flight end time of the deal.
3990 # This will generally be stored in a granularity of a second.
3991 # A value is not required for Private Auction deals or Preferred Deals.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3992 "externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is
3993 # finalized. This is the deal ID that shows up in serving/reporting etc.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3994 "targeting": { # Targeting represents different criteria that can be used by advertisers to # Output only. Specifies the subset of inventory targeted by the deal.
3995 # target ad inventory. For example, they can choose to target ad requests only
3996 # if the user is in the US.
3997 # Multiple types of targeting are always applied as a logical AND, unless noted
3998 # otherwise.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3999 "placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or # Placement targeting information, e.g., URL, mobile applications.
4000 # mobile applications.
4001 # Different placement targeting types will be logically OR'ed.
4002 "urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). # URLs to be included/excluded.
4003 # For Private Auction and AdX Preferred Deals, URLs are either included or
4004 # excluded.
4005 # For Programmatic Guaranteed and Preferred Deals, this doesn't
4006 # apply.
4007 "excludedUrls": [ # A list of URLs to be excluded.
4008 "A String",
4009 ],
4010 "targetedUrls": [ # A list of URLs to be included.
4011 "A String",
4012 ],
4013 },
4014 "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal.
4015 # This doesn't apply to Auction Packages.
4016 "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that # Publisher owned apps to be targeted or excluded by the publisher to
4017 # display the ads in.
4018 # publishers own.
4019 # Mobile application IDs are from App Store and Google Play Store.
4020 # Android App ID, for example, com.google.android.apps.maps, can be found in
4021 # Google Play Store URL.
4022 # iOS App ID (which is a number) can be found at the end of iTunes store URL.
4023 # First party mobile applications is either included or excluded.
4024 "excludedAppIds": [ # A list of application IDs to be excluded.
4025 "A String",
4026 ],
4027 "targetedAppIds": [ # A list of application IDs to be included.
4028 "A String",
4029 ],
4030 },
4031 },
4032 },
4033 "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of # Geo criteria IDs to be included/excluded.
4034 # included and excluded numeric IDs.
4035 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
4036 "A String",
4037 ],
4038 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
4039 "A String",
4040 ],
4041 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4042 "videoTargeting": { # Represents targeting information about video. # Video targeting information.
4043 "excludedPositionTypes": [ # A list of video positions to be excluded.
4044 # Position types can either be included or excluded (XOR).
4045 "A String",
4046 ],
4047 "targetedPositionTypes": [ # A list of video positions to be included.
4048 # When the included list is present, the excluded list must be empty.
4049 # When the excluded list is present, the included list must be empty.
4050 "A String",
4051 ],
4052 },
4053 "technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category.
4054 "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device categories to be included/excluded.
4055 # included and excluded numeric IDs.
4056 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
4057 "A String",
4058 ],
4059 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
4060 "A String",
4061 ],
4062 },
4063 "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
4064 "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating systems to be included/excluded.
4065 # included and excluded numeric IDs.
4066 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
4067 "A String",
4068 ],
4069 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
4070 "A String",
4071 ],
4072 },
4073 "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating system versions to be included/excluded.
4074 # included and excluded numeric IDs.
4075 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
4076 "A String",
4077 ],
4078 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
4079 "A String",
4080 ],
4081 },
4082 },
4083 "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device capabilities to be included/excluded.
4084 # included and excluded numeric IDs.
4085 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
4086 "A String",
4087 ],
4088 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
4089 "A String",
4090 ],
4091 },
4092 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4093 "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on an ad # Inventory sizes to be included/excluded.
4094 # request. It only applies to Private Auction, AdX Preferred Deals and
4095 # Auction Packages. This targeting does not apply to Programmatic Guaranteed
4096 # and Preferred Deals in Ad Manager.
4097 "targetedInventorySizes": [ # A list of inventory sizes to be included.
4098 { # Represents size of a single ad slot, or a creative.
4099 "width": "A String", # The width of the ad slot in pixels.
4100 # This field will be present only when size type is `PIXEL`.
4101 "sizeType": "A String", # The size type of the ad slot.
4102 "height": "A String", # The height of the ad slot in pixels.
4103 # This field will be present only when size type is `PIXEL`.
4104 },
4105 ],
4106 "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
4107 { # Represents size of a single ad slot, or a creative.
4108 "width": "A String", # The width of the ad slot in pixels.
4109 # This field will be present only when size type is `PIXEL`.
4110 "sizeType": "A String", # The size type of the ad slot.
4111 "height": "A String", # The height of the ad slot in pixels.
4112 # This field will be present only when size type is `PIXEL`.
4113 },
4114 ],
4115 },
4116 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4117 "createTime": "A String", # Output only. The time of the deal creation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4118 "webPropertyCode": "A String", # The web property code for the seller copied over from the product.
4119 "proposalId": "A String", # Output only. ID of the proposal that this deal is part of.
4120 "deliveryControl": { # Message contains details about how the deals will be paced. # The set of fields around delivery control that are interesting for a buyer
4121 # to see but are non-negotiable. These are set by the publisher.
4122 "frequencyCaps": [ # Output only. Specifies any frequency caps.
4123 { # Frequency cap.
4124 "numTimeUnits": 42, # The amount of time, in the units specified by time_unit_type. Defines the
4125 # amount of time over which impressions per user are counted and capped.
4126 "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over
4127 # which impressions per user are counted and capped.
4128 "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the
4129 # specified time period.
4130 },
4131 ],
4132 "creativeBlockingLevel": "A String", # Output only. Specified the creative blocking levels to be applied.
4133 "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
4134 },
4135 "description": "A String", # Description for the deal terms.
4136 "dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned).
4137 "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
4138 "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4139 "creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ # Output only. Restricitions about the creatives associated with the deal
4140 # (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals
4141 # in Ad Manager.
4142 # Preferred Deal in Ad Manager.
4143 # This doesn't apply to Private Auction and AdX Preferred Deals.
4144 "creativeFormat": "A String", # The format of the environment that the creatives will be displayed in.
4145 "creativeSpecifications": [
4146 { # Represents information for a creative that is associated with a Programmatic
4147 # Guaranteed/Preferred Deal in Ad Manager.
4148 "creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative.
4149 "width": "A String", # The width of the ad slot in pixels.
4150 # This field will be present only when size type is `PIXEL`.
4151 "sizeType": "A String", # The size type of the ad slot.
4152 "height": "A String", # The height of the ad slot in pixels.
4153 # This field will be present only when size type is `PIXEL`.
4154 },
4155 "creativeCompanionSizes": [ # Companion sizes may be filled in only when this is a video creative.
4156 { # Represents size of a single ad slot, or a creative.
4157 "width": "A String", # The width of the ad slot in pixels.
4158 # This field will be present only when size type is `PIXEL`.
4159 "sizeType": "A String", # The size type of the ad slot.
4160 "height": "A String", # The height of the ad slot in pixels.
4161 # This field will be present only when size type is `PIXEL`.
4162 },
4163 ],
4164 },
4165 ],
4166 "skippableAdType": "A String", # Skippable video ads allow viewers to skip ads after 5 seconds.
4167 },
4168 "createProductId": "A String", # The product ID from which this deal was created.
4169 #
4170 # Note: This field may be set only when creating the resource. Modifying
4171 # this field while updating the resource will result in an error.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4172 "dealTerms": { # The deal terms specify the details of a Product/deal. They specify things # The negotiable terms of the deal.
4173 # like price per buyer, the type of pricing model (e.g., fixed price, auction)
4174 # and expected impressions from the publisher.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4175 "brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED)
4176 "estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal.
4177 # Can be set by buyer or seller.
4178 "pricingType": "A String", # The pricing type for the deal/product. (default: CPM)
4179 "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
4180 "nanos": 42, # Number of nano (10^-9) units of the amount.
4181 # The value must be between -999,999,999 and +999,999,999 inclusive.
4182 # If `units` is positive, `nanos` must be positive or zero.
4183 # If `units` is zero, `nanos` can be positive, zero, or negative.
4184 # If `units` is negative, `nanos` must be negative or zero.
4185 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
4186 "units": "A String", # The whole units of the amount.
4187 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
4188 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
4189 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4190 },
4191 "sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the
4192 # time zone used to mark the boundaries of a day. It should be an
4193 # IANA TZ name, such as "America/Los_Angeles". For more information,
4194 # see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.
4195 "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day.
4196 # Can be set by buyer or seller.
4197 "nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via # The terms for non-guaranteed fixed price deals.
4198 # the API at this time, but can be returned in a get or list request.
4199 "fixedPrices": [ # Fixed price for the specified buyer.
4200 { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in
4201 # a product can become 0 or 1 deals. To check if there is a PricePerBuyer for
4202 # a particular buyer or buyer/advertiser pair, we look for the most specific
4203 # matching rule - we first look for a rule matching the buyer and advertiser,
4204 # next a rule with the buyer but an empty advertiser list, and otherwise look
4205 # for a matching rule where no buyer is set.
4206 "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # The buyer who will pay this price. If unset, all buyers can pay this price
4207 # (if the
4208 # advertisers match, and there's no more specific rule matching the buyer).
4209 # Authorized Buyers account ID.
4210 "accountId": "A String", # Authorized Buyers account ID of the buyer.
4211 },
4212 "advertiserIds": [ # The list of advertisers for this price when associated with this buyer.
4213 # If empty, all advertisers with this buyer pay this price.
4214 "A String",
4215 ],
4216 "price": { # Represents a price and a pricing type for a product / deal. # The specified price.
4217 "pricingType": "A String", # The pricing type for the deal/product. (default: CPM)
4218 "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
4219 "nanos": 42, # Number of nano (10^-9) units of the amount.
4220 # The value must be between -999,999,999 and +999,999,999 inclusive.
4221 # If `units` is positive, `nanos` must be positive or zero.
4222 # If `units` is zero, `nanos` can be positive, zero, or negative.
4223 # If `units` is negative, `nanos` must be negative or zero.
4224 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
4225 "units": "A String", # The whole units of the amount.
4226 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
4227 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
4228 },
4229 },
4230 },
4231 ],
4232 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4233 "guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals.
4234 "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage
4235 # of guaranteed looks that the buyer is guaranteeing to buy.
4236 "fixedPrices": [ # Fixed price for the specified buyer.
4237 { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in
4238 # a product can become 0 or 1 deals. To check if there is a PricePerBuyer for
4239 # a particular buyer or buyer/advertiser pair, we look for the most specific
4240 # matching rule - we first look for a rule matching the buyer and advertiser,
4241 # next a rule with the buyer but an empty advertiser list, and otherwise look
4242 # for a matching rule where no buyer is set.
4243 "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # The buyer who will pay this price. If unset, all buyers can pay this price
4244 # (if the
4245 # advertisers match, and there's no more specific rule matching the buyer).
4246 # Authorized Buyers account ID.
4247 "accountId": "A String", # Authorized Buyers account ID of the buyer.
4248 },
4249 "advertiserIds": [ # The list of advertisers for this price when associated with this buyer.
4250 # If empty, all advertisers with this buyer pay this price.
4251 "A String",
4252 ],
4253 "price": { # Represents a price and a pricing type for a product / deal. # The specified price.
4254 "pricingType": "A String", # The pricing type for the deal/product. (default: CPM)
4255 "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
4256 "nanos": 42, # Number of nano (10^-9) units of the amount.
4257 # The value must be between -999,999,999 and +999,999,999 inclusive.
4258 # If `units` is positive, `nanos` must be positive or zero.
4259 # If `units` is zero, `nanos` can be positive, zero, or negative.
4260 # If `units` is negative, `nanos` must be negative or zero.
4261 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
4262 "units": "A String", # The whole units of the amount.
4263 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
4264 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
4265 },
4266 },
4267 },
4268 ],
4269 "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.
4270 "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4271 },
4272 "nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only # The terms for non-guaranteed auction deals.
4273 # by the seller, but they can be returned in a get or list request.
4274 "reservePricesPerBuyer": [ # Reserve price for the specified buyer.
4275 { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in
4276 # a product can become 0 or 1 deals. To check if there is a PricePerBuyer for
4277 # a particular buyer or buyer/advertiser pair, we look for the most specific
4278 # matching rule - we first look for a rule matching the buyer and advertiser,
4279 # next a rule with the buyer but an empty advertiser list, and otherwise look
4280 # for a matching rule where no buyer is set.
4281 "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # The buyer who will pay this price. If unset, all buyers can pay this price
4282 # (if the
4283 # advertisers match, and there's no more specific rule matching the buyer).
4284 # Authorized Buyers account ID.
4285 "accountId": "A String", # Authorized Buyers account ID of the buyer.
4286 },
4287 "advertiserIds": [ # The list of advertisers for this price when associated with this buyer.
4288 # If empty, all advertisers with this buyer pay this price.
4289 "A String",
4290 ],
4291 "price": { # Represents a price and a pricing type for a product / deal. # The specified price.
4292 "pricingType": "A String", # The pricing type for the deal/product. (default: CPM)
4293 "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
4294 "nanos": 42, # Number of nano (10^-9) units of the amount.
4295 # The value must be between -999,999,999 and +999,999,999 inclusive.
4296 # If `units` is positive, `nanos` must be positive or zero.
4297 # If `units` is zero, `nanos` can be positive, zero, or negative.
4298 # If `units` is negative, `nanos` must be negative or zero.
4299 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
4300 "units": "A String", # The whole units of the amount.
4301 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
4302 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
4303 },
4304 },
4305 },
4306 ],
4307 "autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers
4308 # in this private auction.
4309 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4310 "description": "A String", # Publisher provided description for the terms.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4311 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4312 "sellerContacts": [ # Output only. Seller contact information for the deal.
4313 { # Contains information on how a buyer or seller can be reached.
4314 "email": "A String", # Email address for the contact.
4315 "name": "A String", # The name of the contact.
4316 },
4317 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4318 "displayName": "A String", # The name of the deal.
4319 "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller).
4320 "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list
4321 # operations (max-length: 1024 unicode code units).
4322 },
4323 "syndicationProduct": "A String", # The syndication product associated with the deal.
4324 #
4325 # Note: This field may be set only when creating the resource. Modifying
4326 # this field while updating the resource will result in an error.
4327 "targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared
4328 # targeting entity is AND'd together.
4329 { # Advertisers can target different attributes of an ad slot. For example,
4330 # they can choose to show ads only if the user is in the U.S. Such
4331 # targeting criteria can be specified as part of Shared Targeting.
4332 "inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd
4333 # together.
4334 { # A polymorphic targeting value used as part of Shared Targeting.
4335 "stringValue": "A String", # The string value to include/exclude.
4336 "longValue": "A String", # The long value to include/exclude.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4337 "dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.
4338 # Filled in when the key is GOOG_DAYPART_TARGETING.
4339 # The definition of this targeting is derived from the structure
4340 # used by Ad Manager.
4341 "dayParts": [ # A list of day part targeting criterion.
4342 { # Daypart targeting message that specifies if the ad can be shown
4343 # only during certain parts of a day/week.
4344 "dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.
4345 "endTime": { # Represents a time of day. The date and time zone are either not significant # The ending time of the day for the ad to show (minute level
4346 # granularity). The end time is exclusive. This field is not available
4347 # for filtering in PQL queries.
4348 # or are specified elsewhere. An API may choose to allow leap seconds. Related
4349 # types are google.type.Date and `google.protobuf.Timestamp`.
4350 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
4351 # to allow the value "24:00:00" for scenarios like business closing time.
4352 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
4353 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
4354 # allow the value 60 if it allows leap-seconds.
4355 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
4356 },
4357 "startTime": { # Represents a time of day. The date and time zone are either not significant # The starting time of day for the ad to show (minute level granularity).
4358 # The start time is inclusive.
4359 # This field is not available for filtering in PQL queries.
4360 # or are specified elsewhere. An API may choose to allow leap seconds. Related
4361 # types are google.type.Date and `google.protobuf.Timestamp`.
4362 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
4363 # to allow the value "24:00:00" for scenarios like business closing time.
4364 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
4365 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
4366 # allow the value 60 if it allows leap-seconds.
4367 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
4368 },
4369 },
4370 ],
4371 "timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.
4372 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4373 "creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.
4374 # Filled in when key = GOOG_CREATIVE_SIZE
4375 "companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).
4376 # Companion sizes may be filled in only when creative_size_type = VIDEO
4377 { # Message depicting the size of the creative. The units of width and
4378 # height depend on the type of the targeting.
4379 "width": 42, # The width of the creative
4380 "height": 42, # The height of the creative.
4381 },
4382 ],
4383 "nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value
4384 # only if creative_size_type = CreativeSizeType.NATIVE.
4385 "allowedFormats": [ # What formats are allowed by the publisher.
4386 # If this repeated field is empty then all formats are allowed.
4387 # For example, if this field contains AllowedFormatType.AUDIO then the
4388 # publisher only allows an audio ad (without any video).
4389 "A String",
4390 ],
4391 "skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if
4392 # creative_size_type = CreativeSizeType.VIDEO.
4393 "creativeSizeType": "A String", # The creative size type.
4394 "size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size
4395 # of the creative
4396 # height depend on the type of the targeting.
4397 "width": 42, # The width of the creative
4398 "height": 42, # The height of the creative.
4399 },
4400 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4401 },
4402 ],
4403 "exclusions": [ # The list of values to exclude from targeting. Each value is AND'd
4404 # together.
4405 { # A polymorphic targeting value used as part of Shared Targeting.
4406 "stringValue": "A String", # The string value to include/exclude.
4407 "longValue": "A String", # The long value to include/exclude.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4408 "dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.
4409 # Filled in when the key is GOOG_DAYPART_TARGETING.
4410 # The definition of this targeting is derived from the structure
4411 # used by Ad Manager.
4412 "dayParts": [ # A list of day part targeting criterion.
4413 { # Daypart targeting message that specifies if the ad can be shown
4414 # only during certain parts of a day/week.
4415 "dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.
4416 "endTime": { # Represents a time of day. The date and time zone are either not significant # The ending time of the day for the ad to show (minute level
4417 # granularity). The end time is exclusive. This field is not available
4418 # for filtering in PQL queries.
4419 # or are specified elsewhere. An API may choose to allow leap seconds. Related
4420 # types are google.type.Date and `google.protobuf.Timestamp`.
4421 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
4422 # to allow the value "24:00:00" for scenarios like business closing time.
4423 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
4424 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
4425 # allow the value 60 if it allows leap-seconds.
4426 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
4427 },
4428 "startTime": { # Represents a time of day. The date and time zone are either not significant # The starting time of day for the ad to show (minute level granularity).
4429 # The start time is inclusive.
4430 # This field is not available for filtering in PQL queries.
4431 # or are specified elsewhere. An API may choose to allow leap seconds. Related
4432 # types are google.type.Date and `google.protobuf.Timestamp`.
4433 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
4434 # to allow the value "24:00:00" for scenarios like business closing time.
4435 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
4436 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
4437 # allow the value 60 if it allows leap-seconds.
4438 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
4439 },
4440 },
4441 ],
4442 "timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.
4443 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4444 "creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.
4445 # Filled in when key = GOOG_CREATIVE_SIZE
4446 "companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).
4447 # Companion sizes may be filled in only when creative_size_type = VIDEO
4448 { # Message depicting the size of the creative. The units of width and
4449 # height depend on the type of the targeting.
4450 "width": 42, # The width of the creative
4451 "height": 42, # The height of the creative.
4452 },
4453 ],
4454 "nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value
4455 # only if creative_size_type = CreativeSizeType.NATIVE.
4456 "allowedFormats": [ # What formats are allowed by the publisher.
4457 # If this repeated field is empty then all formats are allowed.
4458 # For example, if this field contains AllowedFormatType.AUDIO then the
4459 # publisher only allows an audio ad (without any video).
4460 "A String",
4461 ],
4462 "skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if
4463 # creative_size_type = CreativeSizeType.VIDEO.
4464 "creativeSizeType": "A String", # The creative size type.
4465 "size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size
4466 # of the creative
4467 # height depend on the type of the targeting.
4468 "width": 42, # The width of the creative
4469 "height": 42, # The height of the creative.
4470 },
4471 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4472 },
4473 ],
4474 "key": "A String", # The key representing the shared targeting criterion.
4475 # Targeting criteria defined by Google ad servers will begin with GOOG_.
4476 # Third parties may define their own keys.
4477 # A list of permissible keys along with the acceptable values will be
4478 # provided as part of the external documentation.
4479 },
4480 ],
4481 "dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal.
4482 "dealPauseStatus": { # Tracks which parties (if any) have paused a deal. # Output only. Tracks which parties (if any) have paused a deal.
4483 # The deal is considered paused if either hasBuyerPaused or
4484 # hasSellPaused is true.
4485 "hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally.
4486 "buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal.
4487 "sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal.
4488 "hasBuyerPaused": True or False, # True, if the buyer has paused the deal unilaterally.
4489 "firstPausedBy": "A String", # The role of the person who first paused this deal.
4490 },
4491 },
4492 "isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this
4493 # deal.
4494 },
4495 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4496 "updateTime": "A String", # Output only. The time when the proposal was last revised.
4497 "proposalState": "A String", # Output only. The current state of the proposal.
4498 "proposalRevision": "A String", # Output only. The revision number for the proposal.
4499 # Each update to the proposal or the deal causes the proposal revision number
4500 # to auto-increment. The buyer keeps track of the last revision number they
4501 # know of and pass it in when making an update. If the head revision number
4502 # on the server has since incremented, then an ABORTED error is returned
4503 # during the update operation to let the buyer know that a subsequent update
4504 # was made.
4505 "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller).
4506 "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list
4507 # operations (max-length: 1024 unicode code units).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4508 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4509 "privateAuctionId": "A String", # Output only. Private auction ID if this proposal is a private auction
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4510 # proposal.
4511 "notes": [ # Output only. The notes associated with this proposal.
4512 { # A proposal may be associated to several notes.
4513 "note": "A String", # The actual note to attach.
4514 # (max-length: 1024 unicode code units)
4515 #
4516 # Note: This field may be set only when creating the resource. Modifying
4517 # this field while updating the resource will result in an error.
4518 "creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note.
4519 "proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created.
4520 "createTime": "A String", # Output only. The timestamp for when this note was created.
4521 "noteId": "A String", # Output only. The unique ID for the note.
4522 },
4523 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4524 "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.
4525 "billedBuyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Output only. Reference to the buyer that will get billed for this proposal.
4526 # Authorized Buyers account ID.
4527 "accountId": "A String", # Authorized Buyers account ID of the buyer.
4528 },
4529 "seller": { # Represents a seller of inventory. Each seller is identified by a unique # Reference to the seller on the proposal.
4530 #
4531 # Note: This field may be set only when creating the resource. Modifying
4532 # this field while updating the resource will result in an error.
4533 # Ad Manager account ID.
4534 "subAccountId": "A String", # Optional sub-account ID for the seller.
4535 "accountId": "A String", # The unique ID for the seller. The seller fills in this field.
4536 # The seller account ID is then available to buyer in the product.
4537 },
4538 "sellerContacts": [ # Output only. Contact information for the seller.
4539 { # Contains information on how a buyer or seller can be reached.
4540 "email": "A String", # Email address for the contact.
4541 "name": "A String", # The name of the contact.
4542 },
4543 ],
4544 "proposalId": "A String", # Output only. The unique ID of the proposal.
4545 "isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated.
4546 "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Reference to the buyer on the proposal.
4547 #
4548 # Note: This field may be set only when creating the resource. Modifying
4549 # this field while updating the resource will result in an error.
4550 # Authorized Buyers account ID.
4551 "accountId": "A String", # Authorized Buyers account ID of the buyer.
4552 },
4553 "isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this
4554 # proposal.
4555 "displayName": "A String", # The name for the proposal.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4556 "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or
4557 # left a comment.
4558 "buyerContacts": [ # Contact information for the buyer.
4559 { # Contains information on how a buyer or seller can be reached.
4560 "email": "A String", # Email address for the contact.
4561 "name": "A String", # The name of the contact.
4562 },
4563 ],
4564 },
4565 ],
4566 }</pre>
4567</div>
4568
4569<div class="method">
4570 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
4571 <pre>Retrieves the next page of results.
4572
4573Args:
4574 previous_request: The request for the previous page. (required)
4575 previous_response: The response from the request for the previous page. (required)
4576
4577Returns:
4578 A request object that you can call 'execute()' on to request the next
4579 page. Returns None if there are no more items in the collection.
4580 </pre>
4581</div>
4582
4583<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4584 <code class="details" id="pause">pause(accountId, proposalId, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4585 <pre>Update the given proposal to pause serving.
4586This method will set the
4587`DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to true for all
4588deals in the proposal.
4589
4590It is a no-op to pause an already-paused proposal.
4591It is an error to call PauseProposal for a proposal that is not
4592finalized or renegotiating.
4593
4594Args:
4595 accountId: string, Account ID of the buyer. (required)
4596 proposalId: string, The ID of the proposal to pause. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4597 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4598 The object takes the form of:
4599
4600{ # Request message to pause serving for an already-finalized proposal.
4601 "reason": "A String", # The reason why the proposal is being paused.
4602 # This human readable message will be displayed in the seller's UI.
4603 # (Max length: 1000 unicode code units.)
4604 }
4605
4606 x__xgafv: string, V1 error format.
4607 Allowed values
4608 1 - v1 error format
4609 2 - v2 error format
4610
4611Returns:
4612 An object of the form:
4613
4614 { # Note: this resource requires whitelisting for access. Please contact your
4615 # account manager for access to Marketplace resources.
4616 #
4617 # Represents a proposal in the Marketplace. A proposal is the unit of
4618 # negotiation between a seller and a buyer and contains deals which
4619 # are served.
4620 #
4621 # Note: you can not update, create, or otherwise modify Private
4622 # Auction or Preferred Deals deals through the API.
4623 #
4624 # Fields are updatable unless noted otherwise.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4625 "deals": [ # The deals associated with this proposal. For Private Auction proposals
4626 # (whose deals have NonGuaranteedAuctionTerms), there will only be one deal.
4627 { # A deal represents a segment of inventory for displaying ads on.
4628 # A proposal can contain multiple deals. A deal contains the terms and
4629 # targeting information that is used for serving.
4630 "updateTime": "A String", # Output only. The time when the deal was last updated.
4631 "createProductRevision": "A String", # Optional revision number of the product that the deal was created from.
4632 # If present on create, and the server `product_revision` has advanced sinced
4633 # the passed-in `create_product_revision`, an `ABORTED` error will be
4634 # returned.
4635 #
4636 # Note: This field may be set only when creating the resource. Modifying
4637 # this field while updating the resource will result in an error.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4638 "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals.
4639 # PUBLISHER means creative is provided by seller and ADVERTISER means
4640 # creative is provided by buyer.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4641 "availableStartTime": "A String", # Optional proposed flight start time of the deal.
4642 # This will generally be stored in the granularity of one second since deal
4643 # serving starts at seconds boundary. Any time specified with more
4644 # granularity (e.g., in milliseconds) will be truncated towards the start of
4645 # time in seconds.
4646 "availableEndTime": "A String", # Proposed flight end time of the deal.
4647 # This will generally be stored in a granularity of a second.
4648 # A value is not required for Private Auction deals or Preferred Deals.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4649 "externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is
4650 # finalized. This is the deal ID that shows up in serving/reporting etc.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4651 "targeting": { # Targeting represents different criteria that can be used by advertisers to # Output only. Specifies the subset of inventory targeted by the deal.
4652 # target ad inventory. For example, they can choose to target ad requests only
4653 # if the user is in the US.
4654 # Multiple types of targeting are always applied as a logical AND, unless noted
4655 # otherwise.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4656 "placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or # Placement targeting information, e.g., URL, mobile applications.
4657 # mobile applications.
4658 # Different placement targeting types will be logically OR'ed.
4659 "urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). # URLs to be included/excluded.
4660 # For Private Auction and AdX Preferred Deals, URLs are either included or
4661 # excluded.
4662 # For Programmatic Guaranteed and Preferred Deals, this doesn't
4663 # apply.
4664 "excludedUrls": [ # A list of URLs to be excluded.
4665 "A String",
4666 ],
4667 "targetedUrls": [ # A list of URLs to be included.
4668 "A String",
4669 ],
4670 },
4671 "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal.
4672 # This doesn't apply to Auction Packages.
4673 "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that # Publisher owned apps to be targeted or excluded by the publisher to
4674 # display the ads in.
4675 # publishers own.
4676 # Mobile application IDs are from App Store and Google Play Store.
4677 # Android App ID, for example, com.google.android.apps.maps, can be found in
4678 # Google Play Store URL.
4679 # iOS App ID (which is a number) can be found at the end of iTunes store URL.
4680 # First party mobile applications is either included or excluded.
4681 "excludedAppIds": [ # A list of application IDs to be excluded.
4682 "A String",
4683 ],
4684 "targetedAppIds": [ # A list of application IDs to be included.
4685 "A String",
4686 ],
4687 },
4688 },
4689 },
4690 "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of # Geo criteria IDs to be included/excluded.
4691 # included and excluded numeric IDs.
4692 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
4693 "A String",
4694 ],
4695 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
4696 "A String",
4697 ],
4698 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4699 "videoTargeting": { # Represents targeting information about video. # Video targeting information.
4700 "excludedPositionTypes": [ # A list of video positions to be excluded.
4701 # Position types can either be included or excluded (XOR).
4702 "A String",
4703 ],
4704 "targetedPositionTypes": [ # A list of video positions to be included.
4705 # When the included list is present, the excluded list must be empty.
4706 # When the excluded list is present, the included list must be empty.
4707 "A String",
4708 ],
4709 },
4710 "technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category.
4711 "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device categories to be included/excluded.
4712 # included and excluded numeric IDs.
4713 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
4714 "A String",
4715 ],
4716 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
4717 "A String",
4718 ],
4719 },
4720 "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
4721 "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating systems to be included/excluded.
4722 # included and excluded numeric IDs.
4723 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
4724 "A String",
4725 ],
4726 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
4727 "A String",
4728 ],
4729 },
4730 "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating system versions to be included/excluded.
4731 # included and excluded numeric IDs.
4732 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
4733 "A String",
4734 ],
4735 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
4736 "A String",
4737 ],
4738 },
4739 },
4740 "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device capabilities to be included/excluded.
4741 # included and excluded numeric IDs.
4742 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
4743 "A String",
4744 ],
4745 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
4746 "A String",
4747 ],
4748 },
4749 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4750 "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on an ad # Inventory sizes to be included/excluded.
4751 # request. It only applies to Private Auction, AdX Preferred Deals and
4752 # Auction Packages. This targeting does not apply to Programmatic Guaranteed
4753 # and Preferred Deals in Ad Manager.
4754 "targetedInventorySizes": [ # A list of inventory sizes to be included.
4755 { # Represents size of a single ad slot, or a creative.
4756 "width": "A String", # The width of the ad slot in pixels.
4757 # This field will be present only when size type is `PIXEL`.
4758 "sizeType": "A String", # The size type of the ad slot.
4759 "height": "A String", # The height of the ad slot in pixels.
4760 # This field will be present only when size type is `PIXEL`.
4761 },
4762 ],
4763 "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
4764 { # Represents size of a single ad slot, or a creative.
4765 "width": "A String", # The width of the ad slot in pixels.
4766 # This field will be present only when size type is `PIXEL`.
4767 "sizeType": "A String", # The size type of the ad slot.
4768 "height": "A String", # The height of the ad slot in pixels.
4769 # This field will be present only when size type is `PIXEL`.
4770 },
4771 ],
4772 },
4773 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4774 "createTime": "A String", # Output only. The time of the deal creation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4775 "webPropertyCode": "A String", # The web property code for the seller copied over from the product.
4776 "proposalId": "A String", # Output only. ID of the proposal that this deal is part of.
4777 "deliveryControl": { # Message contains details about how the deals will be paced. # The set of fields around delivery control that are interesting for a buyer
4778 # to see but are non-negotiable. These are set by the publisher.
4779 "frequencyCaps": [ # Output only. Specifies any frequency caps.
4780 { # Frequency cap.
4781 "numTimeUnits": 42, # The amount of time, in the units specified by time_unit_type. Defines the
4782 # amount of time over which impressions per user are counted and capped.
4783 "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over
4784 # which impressions per user are counted and capped.
4785 "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the
4786 # specified time period.
4787 },
4788 ],
4789 "creativeBlockingLevel": "A String", # Output only. Specified the creative blocking levels to be applied.
4790 "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
4791 },
4792 "description": "A String", # Description for the deal terms.
4793 "dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned).
4794 "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
4795 "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4796 "creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ # Output only. Restricitions about the creatives associated with the deal
4797 # (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals
4798 # in Ad Manager.
4799 # Preferred Deal in Ad Manager.
4800 # This doesn't apply to Private Auction and AdX Preferred Deals.
4801 "creativeFormat": "A String", # The format of the environment that the creatives will be displayed in.
4802 "creativeSpecifications": [
4803 { # Represents information for a creative that is associated with a Programmatic
4804 # Guaranteed/Preferred Deal in Ad Manager.
4805 "creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative.
4806 "width": "A String", # The width of the ad slot in pixels.
4807 # This field will be present only when size type is `PIXEL`.
4808 "sizeType": "A String", # The size type of the ad slot.
4809 "height": "A String", # The height of the ad slot in pixels.
4810 # This field will be present only when size type is `PIXEL`.
4811 },
4812 "creativeCompanionSizes": [ # Companion sizes may be filled in only when this is a video creative.
4813 { # Represents size of a single ad slot, or a creative.
4814 "width": "A String", # The width of the ad slot in pixels.
4815 # This field will be present only when size type is `PIXEL`.
4816 "sizeType": "A String", # The size type of the ad slot.
4817 "height": "A String", # The height of the ad slot in pixels.
4818 # This field will be present only when size type is `PIXEL`.
4819 },
4820 ],
4821 },
4822 ],
4823 "skippableAdType": "A String", # Skippable video ads allow viewers to skip ads after 5 seconds.
4824 },
4825 "createProductId": "A String", # The product ID from which this deal was created.
4826 #
4827 # Note: This field may be set only when creating the resource. Modifying
4828 # this field while updating the resource will result in an error.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4829 "dealTerms": { # The deal terms specify the details of a Product/deal. They specify things # The negotiable terms of the deal.
4830 # like price per buyer, the type of pricing model (e.g., fixed price, auction)
4831 # and expected impressions from the publisher.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4832 "brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED)
4833 "estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal.
4834 # Can be set by buyer or seller.
4835 "pricingType": "A String", # The pricing type for the deal/product. (default: CPM)
4836 "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
4837 "nanos": 42, # Number of nano (10^-9) units of the amount.
4838 # The value must be between -999,999,999 and +999,999,999 inclusive.
4839 # If `units` is positive, `nanos` must be positive or zero.
4840 # If `units` is zero, `nanos` can be positive, zero, or negative.
4841 # If `units` is negative, `nanos` must be negative or zero.
4842 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
4843 "units": "A String", # The whole units of the amount.
4844 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
4845 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
4846 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4847 },
4848 "sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the
4849 # time zone used to mark the boundaries of a day. It should be an
4850 # IANA TZ name, such as "America/Los_Angeles". For more information,
4851 # see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.
4852 "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day.
4853 # Can be set by buyer or seller.
4854 "nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via # The terms for non-guaranteed fixed price deals.
4855 # the API at this time, but can be returned in a get or list request.
4856 "fixedPrices": [ # Fixed price for the specified buyer.
4857 { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in
4858 # a product can become 0 or 1 deals. To check if there is a PricePerBuyer for
4859 # a particular buyer or buyer/advertiser pair, we look for the most specific
4860 # matching rule - we first look for a rule matching the buyer and advertiser,
4861 # next a rule with the buyer but an empty advertiser list, and otherwise look
4862 # for a matching rule where no buyer is set.
4863 "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # The buyer who will pay this price. If unset, all buyers can pay this price
4864 # (if the
4865 # advertisers match, and there's no more specific rule matching the buyer).
4866 # Authorized Buyers account ID.
4867 "accountId": "A String", # Authorized Buyers account ID of the buyer.
4868 },
4869 "advertiserIds": [ # The list of advertisers for this price when associated with this buyer.
4870 # If empty, all advertisers with this buyer pay this price.
4871 "A String",
4872 ],
4873 "price": { # Represents a price and a pricing type for a product / deal. # The specified price.
4874 "pricingType": "A String", # The pricing type for the deal/product. (default: CPM)
4875 "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
4876 "nanos": 42, # Number of nano (10^-9) units of the amount.
4877 # The value must be between -999,999,999 and +999,999,999 inclusive.
4878 # If `units` is positive, `nanos` must be positive or zero.
4879 # If `units` is zero, `nanos` can be positive, zero, or negative.
4880 # If `units` is negative, `nanos` must be negative or zero.
4881 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
4882 "units": "A String", # The whole units of the amount.
4883 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
4884 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
4885 },
4886 },
4887 },
4888 ],
4889 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4890 "guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals.
4891 "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage
4892 # of guaranteed looks that the buyer is guaranteeing to buy.
4893 "fixedPrices": [ # Fixed price for the specified buyer.
4894 { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in
4895 # a product can become 0 or 1 deals. To check if there is a PricePerBuyer for
4896 # a particular buyer or buyer/advertiser pair, we look for the most specific
4897 # matching rule - we first look for a rule matching the buyer and advertiser,
4898 # next a rule with the buyer but an empty advertiser list, and otherwise look
4899 # for a matching rule where no buyer is set.
4900 "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # The buyer who will pay this price. If unset, all buyers can pay this price
4901 # (if the
4902 # advertisers match, and there's no more specific rule matching the buyer).
4903 # Authorized Buyers account ID.
4904 "accountId": "A String", # Authorized Buyers account ID of the buyer.
4905 },
4906 "advertiserIds": [ # The list of advertisers for this price when associated with this buyer.
4907 # If empty, all advertisers with this buyer pay this price.
4908 "A String",
4909 ],
4910 "price": { # Represents a price and a pricing type for a product / deal. # The specified price.
4911 "pricingType": "A String", # The pricing type for the deal/product. (default: CPM)
4912 "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
4913 "nanos": 42, # Number of nano (10^-9) units of the amount.
4914 # The value must be between -999,999,999 and +999,999,999 inclusive.
4915 # If `units` is positive, `nanos` must be positive or zero.
4916 # If `units` is zero, `nanos` can be positive, zero, or negative.
4917 # If `units` is negative, `nanos` must be negative or zero.
4918 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
4919 "units": "A String", # The whole units of the amount.
4920 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
4921 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
4922 },
4923 },
4924 },
4925 ],
4926 "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.
4927 "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4928 },
4929 "nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only # The terms for non-guaranteed auction deals.
4930 # by the seller, but they can be returned in a get or list request.
4931 "reservePricesPerBuyer": [ # Reserve price for the specified buyer.
4932 { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in
4933 # a product can become 0 or 1 deals. To check if there is a PricePerBuyer for
4934 # a particular buyer or buyer/advertiser pair, we look for the most specific
4935 # matching rule - we first look for a rule matching the buyer and advertiser,
4936 # next a rule with the buyer but an empty advertiser list, and otherwise look
4937 # for a matching rule where no buyer is set.
4938 "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # The buyer who will pay this price. If unset, all buyers can pay this price
4939 # (if the
4940 # advertisers match, and there's no more specific rule matching the buyer).
4941 # Authorized Buyers account ID.
4942 "accountId": "A String", # Authorized Buyers account ID of the buyer.
4943 },
4944 "advertiserIds": [ # The list of advertisers for this price when associated with this buyer.
4945 # If empty, all advertisers with this buyer pay this price.
4946 "A String",
4947 ],
4948 "price": { # Represents a price and a pricing type for a product / deal. # The specified price.
4949 "pricingType": "A String", # The pricing type for the deal/product. (default: CPM)
4950 "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
4951 "nanos": 42, # Number of nano (10^-9) units of the amount.
4952 # The value must be between -999,999,999 and +999,999,999 inclusive.
4953 # If `units` is positive, `nanos` must be positive or zero.
4954 # If `units` is zero, `nanos` can be positive, zero, or negative.
4955 # If `units` is negative, `nanos` must be negative or zero.
4956 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
4957 "units": "A String", # The whole units of the amount.
4958 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
4959 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
4960 },
4961 },
4962 },
4963 ],
4964 "autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers
4965 # in this private auction.
4966 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4967 "description": "A String", # Publisher provided description for the terms.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4968 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4969 "sellerContacts": [ # Output only. Seller contact information for the deal.
4970 { # Contains information on how a buyer or seller can be reached.
4971 "email": "A String", # Email address for the contact.
4972 "name": "A String", # The name of the contact.
4973 },
4974 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4975 "displayName": "A String", # The name of the deal.
4976 "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller).
4977 "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list
4978 # operations (max-length: 1024 unicode code units).
4979 },
4980 "syndicationProduct": "A String", # The syndication product associated with the deal.
4981 #
4982 # Note: This field may be set only when creating the resource. Modifying
4983 # this field while updating the resource will result in an error.
4984 "targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared
4985 # targeting entity is AND'd together.
4986 { # Advertisers can target different attributes of an ad slot. For example,
4987 # they can choose to show ads only if the user is in the U.S. Such
4988 # targeting criteria can be specified as part of Shared Targeting.
4989 "inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd
4990 # together.
4991 { # A polymorphic targeting value used as part of Shared Targeting.
4992 "stringValue": "A String", # The string value to include/exclude.
4993 "longValue": "A String", # The long value to include/exclude.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4994 "dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.
4995 # Filled in when the key is GOOG_DAYPART_TARGETING.
4996 # The definition of this targeting is derived from the structure
4997 # used by Ad Manager.
4998 "dayParts": [ # A list of day part targeting criterion.
4999 { # Daypart targeting message that specifies if the ad can be shown
5000 # only during certain parts of a day/week.
5001 "dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.
5002 "endTime": { # Represents a time of day. The date and time zone are either not significant # The ending time of the day for the ad to show (minute level
5003 # granularity). The end time is exclusive. This field is not available
5004 # for filtering in PQL queries.
5005 # or are specified elsewhere. An API may choose to allow leap seconds. Related
5006 # types are google.type.Date and `google.protobuf.Timestamp`.
5007 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
5008 # to allow the value "24:00:00" for scenarios like business closing time.
5009 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
5010 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
5011 # allow the value 60 if it allows leap-seconds.
5012 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
5013 },
5014 "startTime": { # Represents a time of day. The date and time zone are either not significant # The starting time of day for the ad to show (minute level granularity).
5015 # The start time is inclusive.
5016 # This field is not available for filtering in PQL queries.
5017 # or are specified elsewhere. An API may choose to allow leap seconds. Related
5018 # types are google.type.Date and `google.protobuf.Timestamp`.
5019 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
5020 # to allow the value "24:00:00" for scenarios like business closing time.
5021 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
5022 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
5023 # allow the value 60 if it allows leap-seconds.
5024 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
5025 },
5026 },
5027 ],
5028 "timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.
5029 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5030 "creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.
5031 # Filled in when key = GOOG_CREATIVE_SIZE
5032 "companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).
5033 # Companion sizes may be filled in only when creative_size_type = VIDEO
5034 { # Message depicting the size of the creative. The units of width and
5035 # height depend on the type of the targeting.
5036 "width": 42, # The width of the creative
5037 "height": 42, # The height of the creative.
5038 },
5039 ],
5040 "nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value
5041 # only if creative_size_type = CreativeSizeType.NATIVE.
5042 "allowedFormats": [ # What formats are allowed by the publisher.
5043 # If this repeated field is empty then all formats are allowed.
5044 # For example, if this field contains AllowedFormatType.AUDIO then the
5045 # publisher only allows an audio ad (without any video).
5046 "A String",
5047 ],
5048 "skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if
5049 # creative_size_type = CreativeSizeType.VIDEO.
5050 "creativeSizeType": "A String", # The creative size type.
5051 "size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size
5052 # of the creative
5053 # height depend on the type of the targeting.
5054 "width": 42, # The width of the creative
5055 "height": 42, # The height of the creative.
5056 },
5057 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5058 },
5059 ],
5060 "exclusions": [ # The list of values to exclude from targeting. Each value is AND'd
5061 # together.
5062 { # A polymorphic targeting value used as part of Shared Targeting.
5063 "stringValue": "A String", # The string value to include/exclude.
5064 "longValue": "A String", # The long value to include/exclude.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5065 "dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.
5066 # Filled in when the key is GOOG_DAYPART_TARGETING.
5067 # The definition of this targeting is derived from the structure
5068 # used by Ad Manager.
5069 "dayParts": [ # A list of day part targeting criterion.
5070 { # Daypart targeting message that specifies if the ad can be shown
5071 # only during certain parts of a day/week.
5072 "dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.
5073 "endTime": { # Represents a time of day. The date and time zone are either not significant # The ending time of the day for the ad to show (minute level
5074 # granularity). The end time is exclusive. This field is not available
5075 # for filtering in PQL queries.
5076 # or are specified elsewhere. An API may choose to allow leap seconds. Related
5077 # types are google.type.Date and `google.protobuf.Timestamp`.
5078 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
5079 # to allow the value "24:00:00" for scenarios like business closing time.
5080 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
5081 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
5082 # allow the value 60 if it allows leap-seconds.
5083 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
5084 },
5085 "startTime": { # Represents a time of day. The date and time zone are either not significant # The starting time of day for the ad to show (minute level granularity).
5086 # The start time is inclusive.
5087 # This field is not available for filtering in PQL queries.
5088 # or are specified elsewhere. An API may choose to allow leap seconds. Related
5089 # types are google.type.Date and `google.protobuf.Timestamp`.
5090 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
5091 # to allow the value "24:00:00" for scenarios like business closing time.
5092 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
5093 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
5094 # allow the value 60 if it allows leap-seconds.
5095 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
5096 },
5097 },
5098 ],
5099 "timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.
5100 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5101 "creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.
5102 # Filled in when key = GOOG_CREATIVE_SIZE
5103 "companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).
5104 # Companion sizes may be filled in only when creative_size_type = VIDEO
5105 { # Message depicting the size of the creative. The units of width and
5106 # height depend on the type of the targeting.
5107 "width": 42, # The width of the creative
5108 "height": 42, # The height of the creative.
5109 },
5110 ],
5111 "nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value
5112 # only if creative_size_type = CreativeSizeType.NATIVE.
5113 "allowedFormats": [ # What formats are allowed by the publisher.
5114 # If this repeated field is empty then all formats are allowed.
5115 # For example, if this field contains AllowedFormatType.AUDIO then the
5116 # publisher only allows an audio ad (without any video).
5117 "A String",
5118 ],
5119 "skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if
5120 # creative_size_type = CreativeSizeType.VIDEO.
5121 "creativeSizeType": "A String", # The creative size type.
5122 "size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size
5123 # of the creative
5124 # height depend on the type of the targeting.
5125 "width": 42, # The width of the creative
5126 "height": 42, # The height of the creative.
5127 },
5128 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5129 },
5130 ],
5131 "key": "A String", # The key representing the shared targeting criterion.
5132 # Targeting criteria defined by Google ad servers will begin with GOOG_.
5133 # Third parties may define their own keys.
5134 # A list of permissible keys along with the acceptable values will be
5135 # provided as part of the external documentation.
5136 },
5137 ],
5138 "dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal.
5139 "dealPauseStatus": { # Tracks which parties (if any) have paused a deal. # Output only. Tracks which parties (if any) have paused a deal.
5140 # The deal is considered paused if either hasBuyerPaused or
5141 # hasSellPaused is true.
5142 "hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally.
5143 "buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal.
5144 "sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal.
5145 "hasBuyerPaused": True or False, # True, if the buyer has paused the deal unilaterally.
5146 "firstPausedBy": "A String", # The role of the person who first paused this deal.
5147 },
5148 },
5149 "isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this
5150 # deal.
5151 },
5152 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5153 "updateTime": "A String", # Output only. The time when the proposal was last revised.
5154 "proposalState": "A String", # Output only. The current state of the proposal.
5155 "proposalRevision": "A String", # Output only. The revision number for the proposal.
5156 # Each update to the proposal or the deal causes the proposal revision number
5157 # to auto-increment. The buyer keeps track of the last revision number they
5158 # know of and pass it in when making an update. If the head revision number
5159 # on the server has since incremented, then an ABORTED error is returned
5160 # during the update operation to let the buyer know that a subsequent update
5161 # was made.
5162 "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller).
5163 "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list
5164 # operations (max-length: 1024 unicode code units).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5165 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5166 "privateAuctionId": "A String", # Output only. Private auction ID if this proposal is a private auction
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5167 # proposal.
5168 "notes": [ # Output only. The notes associated with this proposal.
5169 { # A proposal may be associated to several notes.
5170 "note": "A String", # The actual note to attach.
5171 # (max-length: 1024 unicode code units)
5172 #
5173 # Note: This field may be set only when creating the resource. Modifying
5174 # this field while updating the resource will result in an error.
5175 "creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note.
5176 "proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created.
5177 "createTime": "A String", # Output only. The timestamp for when this note was created.
5178 "noteId": "A String", # Output only. The unique ID for the note.
5179 },
5180 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5181 "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.
5182 "billedBuyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Output only. Reference to the buyer that will get billed for this proposal.
5183 # Authorized Buyers account ID.
5184 "accountId": "A String", # Authorized Buyers account ID of the buyer.
5185 },
5186 "seller": { # Represents a seller of inventory. Each seller is identified by a unique # Reference to the seller on the proposal.
5187 #
5188 # Note: This field may be set only when creating the resource. Modifying
5189 # this field while updating the resource will result in an error.
5190 # Ad Manager account ID.
5191 "subAccountId": "A String", # Optional sub-account ID for the seller.
5192 "accountId": "A String", # The unique ID for the seller. The seller fills in this field.
5193 # The seller account ID is then available to buyer in the product.
5194 },
5195 "sellerContacts": [ # Output only. Contact information for the seller.
5196 { # Contains information on how a buyer or seller can be reached.
5197 "email": "A String", # Email address for the contact.
5198 "name": "A String", # The name of the contact.
5199 },
5200 ],
5201 "proposalId": "A String", # Output only. The unique ID of the proposal.
5202 "isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated.
5203 "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Reference to the buyer on the proposal.
5204 #
5205 # Note: This field may be set only when creating the resource. Modifying
5206 # this field while updating the resource will result in an error.
5207 # Authorized Buyers account ID.
5208 "accountId": "A String", # Authorized Buyers account ID of the buyer.
5209 },
5210 "isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this
5211 # proposal.
5212 "displayName": "A String", # The name for the proposal.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5213 "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or
5214 # left a comment.
5215 "buyerContacts": [ # Contact information for the buyer.
5216 { # Contains information on how a buyer or seller can be reached.
5217 "email": "A String", # Email address for the contact.
5218 "name": "A String", # The name of the contact.
5219 },
5220 ],
5221 }</pre>
5222</div>
5223
5224<div class="method">
5225 <code class="details" id="resume">resume(accountId, proposalId, body=None, x__xgafv=None)</code>
5226 <pre>Update the given proposal to resume serving.
5227This method will set the
5228`DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to false for all
5229deals in the proposal.
5230
5231Note that if the `has_seller_paused` bit is also set, serving will not
5232resume until the seller also resumes.
5233
5234It is a no-op to resume an already-running proposal.
5235It is an error to call ResumeProposal for a proposal that is not
5236finalized or renegotiating.
5237
5238Args:
5239 accountId: string, Account ID of the buyer. (required)
5240 proposalId: string, The ID of the proposal to resume. (required)
5241 body: object, The request body.
5242 The object takes the form of:
5243
5244{ # Request message to resume (unpause) serving for an already-finalized
5245 # proposal.
5246 }
5247
5248 x__xgafv: string, V1 error format.
5249 Allowed values
5250 1 - v1 error format
5251 2 - v2 error format
5252
5253Returns:
5254 An object of the form:
5255
5256 { # Note: this resource requires whitelisting for access. Please contact your
5257 # account manager for access to Marketplace resources.
5258 #
5259 # Represents a proposal in the Marketplace. A proposal is the unit of
5260 # negotiation between a seller and a buyer and contains deals which
5261 # are served.
5262 #
5263 # Note: you can not update, create, or otherwise modify Private
5264 # Auction or Preferred Deals deals through the API.
5265 #
5266 # Fields are updatable unless noted otherwise.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5267 "deals": [ # The deals associated with this proposal. For Private Auction proposals
5268 # (whose deals have NonGuaranteedAuctionTerms), there will only be one deal.
5269 { # A deal represents a segment of inventory for displaying ads on.
5270 # A proposal can contain multiple deals. A deal contains the terms and
5271 # targeting information that is used for serving.
5272 "updateTime": "A String", # Output only. The time when the deal was last updated.
5273 "createProductRevision": "A String", # Optional revision number of the product that the deal was created from.
5274 # If present on create, and the server `product_revision` has advanced sinced
5275 # the passed-in `create_product_revision`, an `ABORTED` error will be
5276 # returned.
5277 #
5278 # Note: This field may be set only when creating the resource. Modifying
5279 # this field while updating the resource will result in an error.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5280 "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals.
5281 # PUBLISHER means creative is provided by seller and ADVERTISER means
5282 # creative is provided by buyer.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5283 "availableStartTime": "A String", # Optional proposed flight start time of the deal.
5284 # This will generally be stored in the granularity of one second since deal
5285 # serving starts at seconds boundary. Any time specified with more
5286 # granularity (e.g., in milliseconds) will be truncated towards the start of
5287 # time in seconds.
5288 "availableEndTime": "A String", # Proposed flight end time of the deal.
5289 # This will generally be stored in a granularity of a second.
5290 # A value is not required for Private Auction deals or Preferred Deals.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5291 "externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is
5292 # finalized. This is the deal ID that shows up in serving/reporting etc.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5293 "targeting": { # Targeting represents different criteria that can be used by advertisers to # Output only. Specifies the subset of inventory targeted by the deal.
5294 # target ad inventory. For example, they can choose to target ad requests only
5295 # if the user is in the US.
5296 # Multiple types of targeting are always applied as a logical AND, unless noted
5297 # otherwise.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5298 "placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or # Placement targeting information, e.g., URL, mobile applications.
5299 # mobile applications.
5300 # Different placement targeting types will be logically OR'ed.
5301 "urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). # URLs to be included/excluded.
5302 # For Private Auction and AdX Preferred Deals, URLs are either included or
5303 # excluded.
5304 # For Programmatic Guaranteed and Preferred Deals, this doesn't
5305 # apply.
5306 "excludedUrls": [ # A list of URLs to be excluded.
5307 "A String",
5308 ],
5309 "targetedUrls": [ # A list of URLs to be included.
5310 "A String",
5311 ],
5312 },
5313 "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal.
5314 # This doesn't apply to Auction Packages.
5315 "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that # Publisher owned apps to be targeted or excluded by the publisher to
5316 # display the ads in.
5317 # publishers own.
5318 # Mobile application IDs are from App Store and Google Play Store.
5319 # Android App ID, for example, com.google.android.apps.maps, can be found in
5320 # Google Play Store URL.
5321 # iOS App ID (which is a number) can be found at the end of iTunes store URL.
5322 # First party mobile applications is either included or excluded.
5323 "excludedAppIds": [ # A list of application IDs to be excluded.
5324 "A String",
5325 ],
5326 "targetedAppIds": [ # A list of application IDs to be included.
5327 "A String",
5328 ],
5329 },
5330 },
5331 },
5332 "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of # Geo criteria IDs to be included/excluded.
5333 # included and excluded numeric IDs.
5334 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
5335 "A String",
5336 ],
5337 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
5338 "A String",
5339 ],
5340 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5341 "videoTargeting": { # Represents targeting information about video. # Video targeting information.
5342 "excludedPositionTypes": [ # A list of video positions to be excluded.
5343 # Position types can either be included or excluded (XOR).
5344 "A String",
5345 ],
5346 "targetedPositionTypes": [ # A list of video positions to be included.
5347 # When the included list is present, the excluded list must be empty.
5348 # When the excluded list is present, the included list must be empty.
5349 "A String",
5350 ],
5351 },
5352 "technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category.
5353 "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device categories to be included/excluded.
5354 # included and excluded numeric IDs.
5355 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
5356 "A String",
5357 ],
5358 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
5359 "A String",
5360 ],
5361 },
5362 "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
5363 "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating systems to be included/excluded.
5364 # included and excluded numeric IDs.
5365 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
5366 "A String",
5367 ],
5368 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
5369 "A String",
5370 ],
5371 },
5372 "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating system versions to be included/excluded.
5373 # included and excluded numeric IDs.
5374 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
5375 "A String",
5376 ],
5377 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
5378 "A String",
5379 ],
5380 },
5381 },
5382 "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device capabilities to be included/excluded.
5383 # included and excluded numeric IDs.
5384 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
5385 "A String",
5386 ],
5387 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
5388 "A String",
5389 ],
5390 },
5391 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5392 "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on an ad # Inventory sizes to be included/excluded.
5393 # request. It only applies to Private Auction, AdX Preferred Deals and
5394 # Auction Packages. This targeting does not apply to Programmatic Guaranteed
5395 # and Preferred Deals in Ad Manager.
5396 "targetedInventorySizes": [ # A list of inventory sizes to be included.
5397 { # Represents size of a single ad slot, or a creative.
5398 "width": "A String", # The width of the ad slot in pixels.
5399 # This field will be present only when size type is `PIXEL`.
5400 "sizeType": "A String", # The size type of the ad slot.
5401 "height": "A String", # The height of the ad slot in pixels.
5402 # This field will be present only when size type is `PIXEL`.
5403 },
5404 ],
5405 "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
5406 { # Represents size of a single ad slot, or a creative.
5407 "width": "A String", # The width of the ad slot in pixels.
5408 # This field will be present only when size type is `PIXEL`.
5409 "sizeType": "A String", # The size type of the ad slot.
5410 "height": "A String", # The height of the ad slot in pixels.
5411 # This field will be present only when size type is `PIXEL`.
5412 },
5413 ],
5414 },
5415 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5416 "createTime": "A String", # Output only. The time of the deal creation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5417 "webPropertyCode": "A String", # The web property code for the seller copied over from the product.
5418 "proposalId": "A String", # Output only. ID of the proposal that this deal is part of.
5419 "deliveryControl": { # Message contains details about how the deals will be paced. # The set of fields around delivery control that are interesting for a buyer
5420 # to see but are non-negotiable. These are set by the publisher.
5421 "frequencyCaps": [ # Output only. Specifies any frequency caps.
5422 { # Frequency cap.
5423 "numTimeUnits": 42, # The amount of time, in the units specified by time_unit_type. Defines the
5424 # amount of time over which impressions per user are counted and capped.
5425 "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over
5426 # which impressions per user are counted and capped.
5427 "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the
5428 # specified time period.
5429 },
5430 ],
5431 "creativeBlockingLevel": "A String", # Output only. Specified the creative blocking levels to be applied.
5432 "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
5433 },
5434 "description": "A String", # Description for the deal terms.
5435 "dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned).
5436 "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
5437 "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5438 "creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ # Output only. Restricitions about the creatives associated with the deal
5439 # (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals
5440 # in Ad Manager.
5441 # Preferred Deal in Ad Manager.
5442 # This doesn't apply to Private Auction and AdX Preferred Deals.
5443 "creativeFormat": "A String", # The format of the environment that the creatives will be displayed in.
5444 "creativeSpecifications": [
5445 { # Represents information for a creative that is associated with a Programmatic
5446 # Guaranteed/Preferred Deal in Ad Manager.
5447 "creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative.
5448 "width": "A String", # The width of the ad slot in pixels.
5449 # This field will be present only when size type is `PIXEL`.
5450 "sizeType": "A String", # The size type of the ad slot.
5451 "height": "A String", # The height of the ad slot in pixels.
5452 # This field will be present only when size type is `PIXEL`.
5453 },
5454 "creativeCompanionSizes": [ # Companion sizes may be filled in only when this is a video creative.
5455 { # Represents size of a single ad slot, or a creative.
5456 "width": "A String", # The width of the ad slot in pixels.
5457 # This field will be present only when size type is `PIXEL`.
5458 "sizeType": "A String", # The size type of the ad slot.
5459 "height": "A String", # The height of the ad slot in pixels.
5460 # This field will be present only when size type is `PIXEL`.
5461 },
5462 ],
5463 },
5464 ],
5465 "skippableAdType": "A String", # Skippable video ads allow viewers to skip ads after 5 seconds.
5466 },
5467 "createProductId": "A String", # The product ID from which this deal was created.
5468 #
5469 # Note: This field may be set only when creating the resource. Modifying
5470 # this field while updating the resource will result in an error.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5471 "dealTerms": { # The deal terms specify the details of a Product/deal. They specify things # The negotiable terms of the deal.
5472 # like price per buyer, the type of pricing model (e.g., fixed price, auction)
5473 # and expected impressions from the publisher.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5474 "brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED)
5475 "estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal.
5476 # Can be set by buyer or seller.
5477 "pricingType": "A String", # The pricing type for the deal/product. (default: CPM)
5478 "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
5479 "nanos": 42, # Number of nano (10^-9) units of the amount.
5480 # The value must be between -999,999,999 and +999,999,999 inclusive.
5481 # If `units` is positive, `nanos` must be positive or zero.
5482 # If `units` is zero, `nanos` can be positive, zero, or negative.
5483 # If `units` is negative, `nanos` must be negative or zero.
5484 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
5485 "units": "A String", # The whole units of the amount.
5486 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
5487 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
5488 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5489 },
5490 "sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the
5491 # time zone used to mark the boundaries of a day. It should be an
5492 # IANA TZ name, such as "America/Los_Angeles". For more information,
5493 # see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.
5494 "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day.
5495 # Can be set by buyer or seller.
5496 "nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via # The terms for non-guaranteed fixed price deals.
5497 # the API at this time, but can be returned in a get or list request.
5498 "fixedPrices": [ # Fixed price for the specified buyer.
5499 { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in
5500 # a product can become 0 or 1 deals. To check if there is a PricePerBuyer for
5501 # a particular buyer or buyer/advertiser pair, we look for the most specific
5502 # matching rule - we first look for a rule matching the buyer and advertiser,
5503 # next a rule with the buyer but an empty advertiser list, and otherwise look
5504 # for a matching rule where no buyer is set.
5505 "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # The buyer who will pay this price. If unset, all buyers can pay this price
5506 # (if the
5507 # advertisers match, and there's no more specific rule matching the buyer).
5508 # Authorized Buyers account ID.
5509 "accountId": "A String", # Authorized Buyers account ID of the buyer.
5510 },
5511 "advertiserIds": [ # The list of advertisers for this price when associated with this buyer.
5512 # If empty, all advertisers with this buyer pay this price.
5513 "A String",
5514 ],
5515 "price": { # Represents a price and a pricing type for a product / deal. # The specified price.
5516 "pricingType": "A String", # The pricing type for the deal/product. (default: CPM)
5517 "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
5518 "nanos": 42, # Number of nano (10^-9) units of the amount.
5519 # The value must be between -999,999,999 and +999,999,999 inclusive.
5520 # If `units` is positive, `nanos` must be positive or zero.
5521 # If `units` is zero, `nanos` can be positive, zero, or negative.
5522 # If `units` is negative, `nanos` must be negative or zero.
5523 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
5524 "units": "A String", # The whole units of the amount.
5525 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
5526 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
5527 },
5528 },
5529 },
5530 ],
5531 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5532 "guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals.
5533 "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage
5534 # of guaranteed looks that the buyer is guaranteeing to buy.
5535 "fixedPrices": [ # Fixed price for the specified buyer.
5536 { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in
5537 # a product can become 0 or 1 deals. To check if there is a PricePerBuyer for
5538 # a particular buyer or buyer/advertiser pair, we look for the most specific
5539 # matching rule - we first look for a rule matching the buyer and advertiser,
5540 # next a rule with the buyer but an empty advertiser list, and otherwise look
5541 # for a matching rule where no buyer is set.
5542 "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # The buyer who will pay this price. If unset, all buyers can pay this price
5543 # (if the
5544 # advertisers match, and there's no more specific rule matching the buyer).
5545 # Authorized Buyers account ID.
5546 "accountId": "A String", # Authorized Buyers account ID of the buyer.
5547 },
5548 "advertiserIds": [ # The list of advertisers for this price when associated with this buyer.
5549 # If empty, all advertisers with this buyer pay this price.
5550 "A String",
5551 ],
5552 "price": { # Represents a price and a pricing type for a product / deal. # The specified price.
5553 "pricingType": "A String", # The pricing type for the deal/product. (default: CPM)
5554 "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
5555 "nanos": 42, # Number of nano (10^-9) units of the amount.
5556 # The value must be between -999,999,999 and +999,999,999 inclusive.
5557 # If `units` is positive, `nanos` must be positive or zero.
5558 # If `units` is zero, `nanos` can be positive, zero, or negative.
5559 # If `units` is negative, `nanos` must be negative or zero.
5560 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
5561 "units": "A String", # The whole units of the amount.
5562 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
5563 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
5564 },
5565 },
5566 },
5567 ],
5568 "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.
5569 "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5570 },
5571 "nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only # The terms for non-guaranteed auction deals.
5572 # by the seller, but they can be returned in a get or list request.
5573 "reservePricesPerBuyer": [ # Reserve price for the specified buyer.
5574 { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in
5575 # a product can become 0 or 1 deals. To check if there is a PricePerBuyer for
5576 # a particular buyer or buyer/advertiser pair, we look for the most specific
5577 # matching rule - we first look for a rule matching the buyer and advertiser,
5578 # next a rule with the buyer but an empty advertiser list, and otherwise look
5579 # for a matching rule where no buyer is set.
5580 "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # The buyer who will pay this price. If unset, all buyers can pay this price
5581 # (if the
5582 # advertisers match, and there's no more specific rule matching the buyer).
5583 # Authorized Buyers account ID.
5584 "accountId": "A String", # Authorized Buyers account ID of the buyer.
5585 },
5586 "advertiserIds": [ # The list of advertisers for this price when associated with this buyer.
5587 # If empty, all advertisers with this buyer pay this price.
5588 "A String",
5589 ],
5590 "price": { # Represents a price and a pricing type for a product / deal. # The specified price.
5591 "pricingType": "A String", # The pricing type for the deal/product. (default: CPM)
5592 "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
5593 "nanos": 42, # Number of nano (10^-9) units of the amount.
5594 # The value must be between -999,999,999 and +999,999,999 inclusive.
5595 # If `units` is positive, `nanos` must be positive or zero.
5596 # If `units` is zero, `nanos` can be positive, zero, or negative.
5597 # If `units` is negative, `nanos` must be negative or zero.
5598 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
5599 "units": "A String", # The whole units of the amount.
5600 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
5601 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
5602 },
5603 },
5604 },
5605 ],
5606 "autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers
5607 # in this private auction.
5608 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5609 "description": "A String", # Publisher provided description for the terms.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5610 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5611 "sellerContacts": [ # Output only. Seller contact information for the deal.
5612 { # Contains information on how a buyer or seller can be reached.
5613 "email": "A String", # Email address for the contact.
5614 "name": "A String", # The name of the contact.
5615 },
5616 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5617 "displayName": "A String", # The name of the deal.
5618 "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller).
5619 "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list
5620 # operations (max-length: 1024 unicode code units).
5621 },
5622 "syndicationProduct": "A String", # The syndication product associated with the deal.
5623 #
5624 # Note: This field may be set only when creating the resource. Modifying
5625 # this field while updating the resource will result in an error.
5626 "targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared
5627 # targeting entity is AND'd together.
5628 { # Advertisers can target different attributes of an ad slot. For example,
5629 # they can choose to show ads only if the user is in the U.S. Such
5630 # targeting criteria can be specified as part of Shared Targeting.
5631 "inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd
5632 # together.
5633 { # A polymorphic targeting value used as part of Shared Targeting.
5634 "stringValue": "A String", # The string value to include/exclude.
5635 "longValue": "A String", # The long value to include/exclude.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5636 "dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.
5637 # Filled in when the key is GOOG_DAYPART_TARGETING.
5638 # The definition of this targeting is derived from the structure
5639 # used by Ad Manager.
5640 "dayParts": [ # A list of day part targeting criterion.
5641 { # Daypart targeting message that specifies if the ad can be shown
5642 # only during certain parts of a day/week.
5643 "dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.
5644 "endTime": { # Represents a time of day. The date and time zone are either not significant # The ending time of the day for the ad to show (minute level
5645 # granularity). The end time is exclusive. This field is not available
5646 # for filtering in PQL queries.
5647 # or are specified elsewhere. An API may choose to allow leap seconds. Related
5648 # types are google.type.Date and `google.protobuf.Timestamp`.
5649 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
5650 # to allow the value "24:00:00" for scenarios like business closing time.
5651 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
5652 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
5653 # allow the value 60 if it allows leap-seconds.
5654 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
5655 },
5656 "startTime": { # Represents a time of day. The date and time zone are either not significant # The starting time of day for the ad to show (minute level granularity).
5657 # The start time is inclusive.
5658 # This field is not available for filtering in PQL queries.
5659 # or are specified elsewhere. An API may choose to allow leap seconds. Related
5660 # types are google.type.Date and `google.protobuf.Timestamp`.
5661 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
5662 # to allow the value "24:00:00" for scenarios like business closing time.
5663 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
5664 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
5665 # allow the value 60 if it allows leap-seconds.
5666 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
5667 },
5668 },
5669 ],
5670 "timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.
5671 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5672 "creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.
5673 # Filled in when key = GOOG_CREATIVE_SIZE
5674 "companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).
5675 # Companion sizes may be filled in only when creative_size_type = VIDEO
5676 { # Message depicting the size of the creative. The units of width and
5677 # height depend on the type of the targeting.
5678 "width": 42, # The width of the creative
5679 "height": 42, # The height of the creative.
5680 },
5681 ],
5682 "nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value
5683 # only if creative_size_type = CreativeSizeType.NATIVE.
5684 "allowedFormats": [ # What formats are allowed by the publisher.
5685 # If this repeated field is empty then all formats are allowed.
5686 # For example, if this field contains AllowedFormatType.AUDIO then the
5687 # publisher only allows an audio ad (without any video).
5688 "A String",
5689 ],
5690 "skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if
5691 # creative_size_type = CreativeSizeType.VIDEO.
5692 "creativeSizeType": "A String", # The creative size type.
5693 "size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size
5694 # of the creative
5695 # height depend on the type of the targeting.
5696 "width": 42, # The width of the creative
5697 "height": 42, # The height of the creative.
5698 },
5699 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5700 },
5701 ],
5702 "exclusions": [ # The list of values to exclude from targeting. Each value is AND'd
5703 # together.
5704 { # A polymorphic targeting value used as part of Shared Targeting.
5705 "stringValue": "A String", # The string value to include/exclude.
5706 "longValue": "A String", # The long value to include/exclude.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5707 "dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.
5708 # Filled in when the key is GOOG_DAYPART_TARGETING.
5709 # The definition of this targeting is derived from the structure
5710 # used by Ad Manager.
5711 "dayParts": [ # A list of day part targeting criterion.
5712 { # Daypart targeting message that specifies if the ad can be shown
5713 # only during certain parts of a day/week.
5714 "dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.
5715 "endTime": { # Represents a time of day. The date and time zone are either not significant # The ending time of the day for the ad to show (minute level
5716 # granularity). The end time is exclusive. This field is not available
5717 # for filtering in PQL queries.
5718 # or are specified elsewhere. An API may choose to allow leap seconds. Related
5719 # types are google.type.Date and `google.protobuf.Timestamp`.
5720 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
5721 # to allow the value "24:00:00" for scenarios like business closing time.
5722 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
5723 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
5724 # allow the value 60 if it allows leap-seconds.
5725 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
5726 },
5727 "startTime": { # Represents a time of day. The date and time zone are either not significant # The starting time of day for the ad to show (minute level granularity).
5728 # The start time is inclusive.
5729 # This field is not available for filtering in PQL queries.
5730 # or are specified elsewhere. An API may choose to allow leap seconds. Related
5731 # types are google.type.Date and `google.protobuf.Timestamp`.
5732 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
5733 # to allow the value "24:00:00" for scenarios like business closing time.
5734 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
5735 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
5736 # allow the value 60 if it allows leap-seconds.
5737 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
5738 },
5739 },
5740 ],
5741 "timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.
5742 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5743 "creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.
5744 # Filled in when key = GOOG_CREATIVE_SIZE
5745 "companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).
5746 # Companion sizes may be filled in only when creative_size_type = VIDEO
5747 { # Message depicting the size of the creative. The units of width and
5748 # height depend on the type of the targeting.
5749 "width": 42, # The width of the creative
5750 "height": 42, # The height of the creative.
5751 },
5752 ],
5753 "nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value
5754 # only if creative_size_type = CreativeSizeType.NATIVE.
5755 "allowedFormats": [ # What formats are allowed by the publisher.
5756 # If this repeated field is empty then all formats are allowed.
5757 # For example, if this field contains AllowedFormatType.AUDIO then the
5758 # publisher only allows an audio ad (without any video).
5759 "A String",
5760 ],
5761 "skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if
5762 # creative_size_type = CreativeSizeType.VIDEO.
5763 "creativeSizeType": "A String", # The creative size type.
5764 "size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size
5765 # of the creative
5766 # height depend on the type of the targeting.
5767 "width": 42, # The width of the creative
5768 "height": 42, # The height of the creative.
5769 },
5770 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5771 },
5772 ],
5773 "key": "A String", # The key representing the shared targeting criterion.
5774 # Targeting criteria defined by Google ad servers will begin with GOOG_.
5775 # Third parties may define their own keys.
5776 # A list of permissible keys along with the acceptable values will be
5777 # provided as part of the external documentation.
5778 },
5779 ],
5780 "dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal.
5781 "dealPauseStatus": { # Tracks which parties (if any) have paused a deal. # Output only. Tracks which parties (if any) have paused a deal.
5782 # The deal is considered paused if either hasBuyerPaused or
5783 # hasSellPaused is true.
5784 "hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally.
5785 "buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal.
5786 "sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal.
5787 "hasBuyerPaused": True or False, # True, if the buyer has paused the deal unilaterally.
5788 "firstPausedBy": "A String", # The role of the person who first paused this deal.
5789 },
5790 },
5791 "isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this
5792 # deal.
5793 },
5794 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5795 "updateTime": "A String", # Output only. The time when the proposal was last revised.
5796 "proposalState": "A String", # Output only. The current state of the proposal.
5797 "proposalRevision": "A String", # Output only. The revision number for the proposal.
5798 # Each update to the proposal or the deal causes the proposal revision number
5799 # to auto-increment. The buyer keeps track of the last revision number they
5800 # know of and pass it in when making an update. If the head revision number
5801 # on the server has since incremented, then an ABORTED error is returned
5802 # during the update operation to let the buyer know that a subsequent update
5803 # was made.
5804 "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller).
5805 "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list
5806 # operations (max-length: 1024 unicode code units).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5807 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5808 "privateAuctionId": "A String", # Output only. Private auction ID if this proposal is a private auction
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5809 # proposal.
5810 "notes": [ # Output only. The notes associated with this proposal.
5811 { # A proposal may be associated to several notes.
5812 "note": "A String", # The actual note to attach.
5813 # (max-length: 1024 unicode code units)
5814 #
5815 # Note: This field may be set only when creating the resource. Modifying
5816 # this field while updating the resource will result in an error.
5817 "creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note.
5818 "proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created.
5819 "createTime": "A String", # Output only. The timestamp for when this note was created.
5820 "noteId": "A String", # Output only. The unique ID for the note.
5821 },
5822 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5823 "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.
5824 "billedBuyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Output only. Reference to the buyer that will get billed for this proposal.
5825 # Authorized Buyers account ID.
5826 "accountId": "A String", # Authorized Buyers account ID of the buyer.
5827 },
5828 "seller": { # Represents a seller of inventory. Each seller is identified by a unique # Reference to the seller on the proposal.
5829 #
5830 # Note: This field may be set only when creating the resource. Modifying
5831 # this field while updating the resource will result in an error.
5832 # Ad Manager account ID.
5833 "subAccountId": "A String", # Optional sub-account ID for the seller.
5834 "accountId": "A String", # The unique ID for the seller. The seller fills in this field.
5835 # The seller account ID is then available to buyer in the product.
5836 },
5837 "sellerContacts": [ # Output only. Contact information for the seller.
5838 { # Contains information on how a buyer or seller can be reached.
5839 "email": "A String", # Email address for the contact.
5840 "name": "A String", # The name of the contact.
5841 },
5842 ],
5843 "proposalId": "A String", # Output only. The unique ID of the proposal.
5844 "isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated.
5845 "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Reference to the buyer on the proposal.
5846 #
5847 # Note: This field may be set only when creating the resource. Modifying
5848 # this field while updating the resource will result in an error.
5849 # Authorized Buyers account ID.
5850 "accountId": "A String", # Authorized Buyers account ID of the buyer.
5851 },
5852 "isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this
5853 # proposal.
5854 "displayName": "A String", # The name for the proposal.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5855 "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or
5856 # left a comment.
5857 "buyerContacts": [ # Contact information for the buyer.
5858 { # Contains information on how a buyer or seller can be reached.
5859 "email": "A String", # Email address for the contact.
5860 "name": "A String", # The name of the contact.
5861 },
5862 ],
5863 }</pre>
5864</div>
5865
5866<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5867 <code class="details" id="update">update(accountId, proposalId, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5868 <pre>Update the given proposal at the client known revision number. If the
5869server revision has advanced since the passed-in
5870`proposal.proposal_revision`, an `ABORTED` error message will be returned.
5871Only the buyer-modifiable fields of the proposal will be updated.
5872
5873Note that the deals in the proposal will be updated to match the passed-in
5874copy.
5875If a passed-in deal does not have a `deal_id`, the server will assign a new
5876unique ID and create the deal.
5877If passed-in deal has a `deal_id`, it will be updated to match the
5878passed-in copy.
5879Any existing deals not present in the passed-in proposal will be deleted.
5880It is an error to pass in a deal with a `deal_id` not present at head.
5881
5882Args:
5883 accountId: string, Account ID of the buyer. (required)
5884 proposalId: string, The unique ID of the proposal. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5885 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5886 The object takes the form of:
5887
5888{ # Note: this resource requires whitelisting for access. Please contact your
5889 # account manager for access to Marketplace resources.
5890 #
5891 # Represents a proposal in the Marketplace. A proposal is the unit of
5892 # negotiation between a seller and a buyer and contains deals which
5893 # are served.
5894 #
5895 # Note: you can not update, create, or otherwise modify Private
5896 # Auction or Preferred Deals deals through the API.
5897 #
5898 # Fields are updatable unless noted otherwise.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5899 "deals": [ # The deals associated with this proposal. For Private Auction proposals
5900 # (whose deals have NonGuaranteedAuctionTerms), there will only be one deal.
5901 { # A deal represents a segment of inventory for displaying ads on.
5902 # A proposal can contain multiple deals. A deal contains the terms and
5903 # targeting information that is used for serving.
5904 "updateTime": "A String", # Output only. The time when the deal was last updated.
5905 "createProductRevision": "A String", # Optional revision number of the product that the deal was created from.
5906 # If present on create, and the server `product_revision` has advanced sinced
5907 # the passed-in `create_product_revision`, an `ABORTED` error will be
5908 # returned.
5909 #
5910 # Note: This field may be set only when creating the resource. Modifying
5911 # this field while updating the resource will result in an error.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5912 "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals.
5913 # PUBLISHER means creative is provided by seller and ADVERTISER means
5914 # creative is provided by buyer.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5915 "availableStartTime": "A String", # Optional proposed flight start time of the deal.
5916 # This will generally be stored in the granularity of one second since deal
5917 # serving starts at seconds boundary. Any time specified with more
5918 # granularity (e.g., in milliseconds) will be truncated towards the start of
5919 # time in seconds.
5920 "availableEndTime": "A String", # Proposed flight end time of the deal.
5921 # This will generally be stored in a granularity of a second.
5922 # A value is not required for Private Auction deals or Preferred Deals.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5923 "externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is
5924 # finalized. This is the deal ID that shows up in serving/reporting etc.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5925 "targeting": { # Targeting represents different criteria that can be used by advertisers to # Output only. Specifies the subset of inventory targeted by the deal.
5926 # target ad inventory. For example, they can choose to target ad requests only
5927 # if the user is in the US.
5928 # Multiple types of targeting are always applied as a logical AND, unless noted
5929 # otherwise.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5930 "placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or # Placement targeting information, e.g., URL, mobile applications.
5931 # mobile applications.
5932 # Different placement targeting types will be logically OR'ed.
5933 "urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). # URLs to be included/excluded.
5934 # For Private Auction and AdX Preferred Deals, URLs are either included or
5935 # excluded.
5936 # For Programmatic Guaranteed and Preferred Deals, this doesn't
5937 # apply.
5938 "excludedUrls": [ # A list of URLs to be excluded.
5939 "A String",
5940 ],
5941 "targetedUrls": [ # A list of URLs to be included.
5942 "A String",
5943 ],
5944 },
5945 "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal.
5946 # This doesn't apply to Auction Packages.
5947 "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that # Publisher owned apps to be targeted or excluded by the publisher to
5948 # display the ads in.
5949 # publishers own.
5950 # Mobile application IDs are from App Store and Google Play Store.
5951 # Android App ID, for example, com.google.android.apps.maps, can be found in
5952 # Google Play Store URL.
5953 # iOS App ID (which is a number) can be found at the end of iTunes store URL.
5954 # First party mobile applications is either included or excluded.
5955 "excludedAppIds": [ # A list of application IDs to be excluded.
5956 "A String",
5957 ],
5958 "targetedAppIds": [ # A list of application IDs to be included.
5959 "A String",
5960 ],
5961 },
5962 },
5963 },
5964 "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of # Geo criteria IDs to be included/excluded.
5965 # included and excluded numeric IDs.
5966 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
5967 "A String",
5968 ],
5969 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
5970 "A String",
5971 ],
5972 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5973 "videoTargeting": { # Represents targeting information about video. # Video targeting information.
5974 "excludedPositionTypes": [ # A list of video positions to be excluded.
5975 # Position types can either be included or excluded (XOR).
5976 "A String",
5977 ],
5978 "targetedPositionTypes": [ # A list of video positions to be included.
5979 # When the included list is present, the excluded list must be empty.
5980 # When the excluded list is present, the included list must be empty.
5981 "A String",
5982 ],
5983 },
5984 "technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category.
5985 "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device categories to be included/excluded.
5986 # included and excluded numeric IDs.
5987 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
5988 "A String",
5989 ],
5990 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
5991 "A String",
5992 ],
5993 },
5994 "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
5995 "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating systems to be included/excluded.
5996 # included and excluded numeric IDs.
5997 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
5998 "A String",
5999 ],
6000 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
6001 "A String",
6002 ],
6003 },
6004 "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating system versions to be included/excluded.
6005 # included and excluded numeric IDs.
6006 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
6007 "A String",
6008 ],
6009 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
6010 "A String",
6011 ],
6012 },
6013 },
6014 "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device capabilities to be included/excluded.
6015 # included and excluded numeric IDs.
6016 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
6017 "A String",
6018 ],
6019 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
6020 "A String",
6021 ],
6022 },
6023 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6024 "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on an ad # Inventory sizes to be included/excluded.
6025 # request. It only applies to Private Auction, AdX Preferred Deals and
6026 # Auction Packages. This targeting does not apply to Programmatic Guaranteed
6027 # and Preferred Deals in Ad Manager.
6028 "targetedInventorySizes": [ # A list of inventory sizes to be included.
6029 { # Represents size of a single ad slot, or a creative.
6030 "width": "A String", # The width of the ad slot in pixels.
6031 # This field will be present only when size type is `PIXEL`.
6032 "sizeType": "A String", # The size type of the ad slot.
6033 "height": "A String", # The height of the ad slot in pixels.
6034 # This field will be present only when size type is `PIXEL`.
6035 },
6036 ],
6037 "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
6038 { # Represents size of a single ad slot, or a creative.
6039 "width": "A String", # The width of the ad slot in pixels.
6040 # This field will be present only when size type is `PIXEL`.
6041 "sizeType": "A String", # The size type of the ad slot.
6042 "height": "A String", # The height of the ad slot in pixels.
6043 # This field will be present only when size type is `PIXEL`.
6044 },
6045 ],
6046 },
6047 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6048 "createTime": "A String", # Output only. The time of the deal creation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6049 "webPropertyCode": "A String", # The web property code for the seller copied over from the product.
6050 "proposalId": "A String", # Output only. ID of the proposal that this deal is part of.
6051 "deliveryControl": { # Message contains details about how the deals will be paced. # The set of fields around delivery control that are interesting for a buyer
6052 # to see but are non-negotiable. These are set by the publisher.
6053 "frequencyCaps": [ # Output only. Specifies any frequency caps.
6054 { # Frequency cap.
6055 "numTimeUnits": 42, # The amount of time, in the units specified by time_unit_type. Defines the
6056 # amount of time over which impressions per user are counted and capped.
6057 "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over
6058 # which impressions per user are counted and capped.
6059 "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the
6060 # specified time period.
6061 },
6062 ],
6063 "creativeBlockingLevel": "A String", # Output only. Specified the creative blocking levels to be applied.
6064 "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
6065 },
6066 "description": "A String", # Description for the deal terms.
6067 "dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned).
6068 "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
6069 "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6070 "creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ # Output only. Restricitions about the creatives associated with the deal
6071 # (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals
6072 # in Ad Manager.
6073 # Preferred Deal in Ad Manager.
6074 # This doesn't apply to Private Auction and AdX Preferred Deals.
6075 "creativeFormat": "A String", # The format of the environment that the creatives will be displayed in.
6076 "creativeSpecifications": [
6077 { # Represents information for a creative that is associated with a Programmatic
6078 # Guaranteed/Preferred Deal in Ad Manager.
6079 "creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative.
6080 "width": "A String", # The width of the ad slot in pixels.
6081 # This field will be present only when size type is `PIXEL`.
6082 "sizeType": "A String", # The size type of the ad slot.
6083 "height": "A String", # The height of the ad slot in pixels.
6084 # This field will be present only when size type is `PIXEL`.
6085 },
6086 "creativeCompanionSizes": [ # Companion sizes may be filled in only when this is a video creative.
6087 { # Represents size of a single ad slot, or a creative.
6088 "width": "A String", # The width of the ad slot in pixels.
6089 # This field will be present only when size type is `PIXEL`.
6090 "sizeType": "A String", # The size type of the ad slot.
6091 "height": "A String", # The height of the ad slot in pixels.
6092 # This field will be present only when size type is `PIXEL`.
6093 },
6094 ],
6095 },
6096 ],
6097 "skippableAdType": "A String", # Skippable video ads allow viewers to skip ads after 5 seconds.
6098 },
6099 "createProductId": "A String", # The product ID from which this deal was created.
6100 #
6101 # Note: This field may be set only when creating the resource. Modifying
6102 # this field while updating the resource will result in an error.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6103 "dealTerms": { # The deal terms specify the details of a Product/deal. They specify things # The negotiable terms of the deal.
6104 # like price per buyer, the type of pricing model (e.g., fixed price, auction)
6105 # and expected impressions from the publisher.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6106 "brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED)
6107 "estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal.
6108 # Can be set by buyer or seller.
6109 "pricingType": "A String", # The pricing type for the deal/product. (default: CPM)
6110 "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
6111 "nanos": 42, # Number of nano (10^-9) units of the amount.
6112 # The value must be between -999,999,999 and +999,999,999 inclusive.
6113 # If `units` is positive, `nanos` must be positive or zero.
6114 # If `units` is zero, `nanos` can be positive, zero, or negative.
6115 # If `units` is negative, `nanos` must be negative or zero.
6116 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
6117 "units": "A String", # The whole units of the amount.
6118 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
6119 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
6120 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6121 },
6122 "sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the
6123 # time zone used to mark the boundaries of a day. It should be an
6124 # IANA TZ name, such as "America/Los_Angeles". For more information,
6125 # see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.
6126 "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day.
6127 # Can be set by buyer or seller.
6128 "nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via # The terms for non-guaranteed fixed price deals.
6129 # the API at this time, but can be returned in a get or list request.
6130 "fixedPrices": [ # Fixed price for the specified buyer.
6131 { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in
6132 # a product can become 0 or 1 deals. To check if there is a PricePerBuyer for
6133 # a particular buyer or buyer/advertiser pair, we look for the most specific
6134 # matching rule - we first look for a rule matching the buyer and advertiser,
6135 # next a rule with the buyer but an empty advertiser list, and otherwise look
6136 # for a matching rule where no buyer is set.
6137 "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # The buyer who will pay this price. If unset, all buyers can pay this price
6138 # (if the
6139 # advertisers match, and there's no more specific rule matching the buyer).
6140 # Authorized Buyers account ID.
6141 "accountId": "A String", # Authorized Buyers account ID of the buyer.
6142 },
6143 "advertiserIds": [ # The list of advertisers for this price when associated with this buyer.
6144 # If empty, all advertisers with this buyer pay this price.
6145 "A String",
6146 ],
6147 "price": { # Represents a price and a pricing type for a product / deal. # The specified price.
6148 "pricingType": "A String", # The pricing type for the deal/product. (default: CPM)
6149 "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
6150 "nanos": 42, # Number of nano (10^-9) units of the amount.
6151 # The value must be between -999,999,999 and +999,999,999 inclusive.
6152 # If `units` is positive, `nanos` must be positive or zero.
6153 # If `units` is zero, `nanos` can be positive, zero, or negative.
6154 # If `units` is negative, `nanos` must be negative or zero.
6155 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
6156 "units": "A String", # The whole units of the amount.
6157 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
6158 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
6159 },
6160 },
6161 },
6162 ],
6163 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6164 "guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals.
6165 "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage
6166 # of guaranteed looks that the buyer is guaranteeing to buy.
6167 "fixedPrices": [ # Fixed price for the specified buyer.
6168 { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in
6169 # a product can become 0 or 1 deals. To check if there is a PricePerBuyer for
6170 # a particular buyer or buyer/advertiser pair, we look for the most specific
6171 # matching rule - we first look for a rule matching the buyer and advertiser,
6172 # next a rule with the buyer but an empty advertiser list, and otherwise look
6173 # for a matching rule where no buyer is set.
6174 "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # The buyer who will pay this price. If unset, all buyers can pay this price
6175 # (if the
6176 # advertisers match, and there's no more specific rule matching the buyer).
6177 # Authorized Buyers account ID.
6178 "accountId": "A String", # Authorized Buyers account ID of the buyer.
6179 },
6180 "advertiserIds": [ # The list of advertisers for this price when associated with this buyer.
6181 # If empty, all advertisers with this buyer pay this price.
6182 "A String",
6183 ],
6184 "price": { # Represents a price and a pricing type for a product / deal. # The specified price.
6185 "pricingType": "A String", # The pricing type for the deal/product. (default: CPM)
6186 "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
6187 "nanos": 42, # Number of nano (10^-9) units of the amount.
6188 # The value must be between -999,999,999 and +999,999,999 inclusive.
6189 # If `units` is positive, `nanos` must be positive or zero.
6190 # If `units` is zero, `nanos` can be positive, zero, or negative.
6191 # If `units` is negative, `nanos` must be negative or zero.
6192 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
6193 "units": "A String", # The whole units of the amount.
6194 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
6195 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
6196 },
6197 },
6198 },
6199 ],
6200 "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.
6201 "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6202 },
6203 "nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only # The terms for non-guaranteed auction deals.
6204 # by the seller, but they can be returned in a get or list request.
6205 "reservePricesPerBuyer": [ # Reserve price for the specified buyer.
6206 { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in
6207 # a product can become 0 or 1 deals. To check if there is a PricePerBuyer for
6208 # a particular buyer or buyer/advertiser pair, we look for the most specific
6209 # matching rule - we first look for a rule matching the buyer and advertiser,
6210 # next a rule with the buyer but an empty advertiser list, and otherwise look
6211 # for a matching rule where no buyer is set.
6212 "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # The buyer who will pay this price. If unset, all buyers can pay this price
6213 # (if the
6214 # advertisers match, and there's no more specific rule matching the buyer).
6215 # Authorized Buyers account ID.
6216 "accountId": "A String", # Authorized Buyers account ID of the buyer.
6217 },
6218 "advertiserIds": [ # The list of advertisers for this price when associated with this buyer.
6219 # If empty, all advertisers with this buyer pay this price.
6220 "A String",
6221 ],
6222 "price": { # Represents a price and a pricing type for a product / deal. # The specified price.
6223 "pricingType": "A String", # The pricing type for the deal/product. (default: CPM)
6224 "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
6225 "nanos": 42, # Number of nano (10^-9) units of the amount.
6226 # The value must be between -999,999,999 and +999,999,999 inclusive.
6227 # If `units` is positive, `nanos` must be positive or zero.
6228 # If `units` is zero, `nanos` can be positive, zero, or negative.
6229 # If `units` is negative, `nanos` must be negative or zero.
6230 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
6231 "units": "A String", # The whole units of the amount.
6232 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
6233 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
6234 },
6235 },
6236 },
6237 ],
6238 "autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers
6239 # in this private auction.
6240 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6241 "description": "A String", # Publisher provided description for the terms.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6242 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6243 "sellerContacts": [ # Output only. Seller contact information for the deal.
6244 { # Contains information on how a buyer or seller can be reached.
6245 "email": "A String", # Email address for the contact.
6246 "name": "A String", # The name of the contact.
6247 },
6248 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6249 "displayName": "A String", # The name of the deal.
6250 "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller).
6251 "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list
6252 # operations (max-length: 1024 unicode code units).
6253 },
6254 "syndicationProduct": "A String", # The syndication product associated with the deal.
6255 #
6256 # Note: This field may be set only when creating the resource. Modifying
6257 # this field while updating the resource will result in an error.
6258 "targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared
6259 # targeting entity is AND'd together.
6260 { # Advertisers can target different attributes of an ad slot. For example,
6261 # they can choose to show ads only if the user is in the U.S. Such
6262 # targeting criteria can be specified as part of Shared Targeting.
6263 "inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd
6264 # together.
6265 { # A polymorphic targeting value used as part of Shared Targeting.
6266 "stringValue": "A String", # The string value to include/exclude.
6267 "longValue": "A String", # The long value to include/exclude.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6268 "dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.
6269 # Filled in when the key is GOOG_DAYPART_TARGETING.
6270 # The definition of this targeting is derived from the structure
6271 # used by Ad Manager.
6272 "dayParts": [ # A list of day part targeting criterion.
6273 { # Daypart targeting message that specifies if the ad can be shown
6274 # only during certain parts of a day/week.
6275 "dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.
6276 "endTime": { # Represents a time of day. The date and time zone are either not significant # The ending time of the day for the ad to show (minute level
6277 # granularity). The end time is exclusive. This field is not available
6278 # for filtering in PQL queries.
6279 # or are specified elsewhere. An API may choose to allow leap seconds. Related
6280 # types are google.type.Date and `google.protobuf.Timestamp`.
6281 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
6282 # to allow the value "24:00:00" for scenarios like business closing time.
6283 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
6284 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
6285 # allow the value 60 if it allows leap-seconds.
6286 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
6287 },
6288 "startTime": { # Represents a time of day. The date and time zone are either not significant # The starting time of day for the ad to show (minute level granularity).
6289 # The start time is inclusive.
6290 # This field is not available for filtering in PQL queries.
6291 # or are specified elsewhere. An API may choose to allow leap seconds. Related
6292 # types are google.type.Date and `google.protobuf.Timestamp`.
6293 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
6294 # to allow the value "24:00:00" for scenarios like business closing time.
6295 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
6296 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
6297 # allow the value 60 if it allows leap-seconds.
6298 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
6299 },
6300 },
6301 ],
6302 "timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.
6303 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6304 "creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.
6305 # Filled in when key = GOOG_CREATIVE_SIZE
6306 "companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).
6307 # Companion sizes may be filled in only when creative_size_type = VIDEO
6308 { # Message depicting the size of the creative. The units of width and
6309 # height depend on the type of the targeting.
6310 "width": 42, # The width of the creative
6311 "height": 42, # The height of the creative.
6312 },
6313 ],
6314 "nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value
6315 # only if creative_size_type = CreativeSizeType.NATIVE.
6316 "allowedFormats": [ # What formats are allowed by the publisher.
6317 # If this repeated field is empty then all formats are allowed.
6318 # For example, if this field contains AllowedFormatType.AUDIO then the
6319 # publisher only allows an audio ad (without any video).
6320 "A String",
6321 ],
6322 "skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if
6323 # creative_size_type = CreativeSizeType.VIDEO.
6324 "creativeSizeType": "A String", # The creative size type.
6325 "size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size
6326 # of the creative
6327 # height depend on the type of the targeting.
6328 "width": 42, # The width of the creative
6329 "height": 42, # The height of the creative.
6330 },
6331 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6332 },
6333 ],
6334 "exclusions": [ # The list of values to exclude from targeting. Each value is AND'd
6335 # together.
6336 { # A polymorphic targeting value used as part of Shared Targeting.
6337 "stringValue": "A String", # The string value to include/exclude.
6338 "longValue": "A String", # The long value to include/exclude.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6339 "dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.
6340 # Filled in when the key is GOOG_DAYPART_TARGETING.
6341 # The definition of this targeting is derived from the structure
6342 # used by Ad Manager.
6343 "dayParts": [ # A list of day part targeting criterion.
6344 { # Daypart targeting message that specifies if the ad can be shown
6345 # only during certain parts of a day/week.
6346 "dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.
6347 "endTime": { # Represents a time of day. The date and time zone are either not significant # The ending time of the day for the ad to show (minute level
6348 # granularity). The end time is exclusive. This field is not available
6349 # for filtering in PQL queries.
6350 # or are specified elsewhere. An API may choose to allow leap seconds. Related
6351 # types are google.type.Date and `google.protobuf.Timestamp`.
6352 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
6353 # to allow the value "24:00:00" for scenarios like business closing time.
6354 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
6355 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
6356 # allow the value 60 if it allows leap-seconds.
6357 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
6358 },
6359 "startTime": { # Represents a time of day. The date and time zone are either not significant # The starting time of day for the ad to show (minute level granularity).
6360 # The start time is inclusive.
6361 # This field is not available for filtering in PQL queries.
6362 # or are specified elsewhere. An API may choose to allow leap seconds. Related
6363 # types are google.type.Date and `google.protobuf.Timestamp`.
6364 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
6365 # to allow the value "24:00:00" for scenarios like business closing time.
6366 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
6367 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
6368 # allow the value 60 if it allows leap-seconds.
6369 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
6370 },
6371 },
6372 ],
6373 "timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.
6374 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6375 "creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.
6376 # Filled in when key = GOOG_CREATIVE_SIZE
6377 "companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).
6378 # Companion sizes may be filled in only when creative_size_type = VIDEO
6379 { # Message depicting the size of the creative. The units of width and
6380 # height depend on the type of the targeting.
6381 "width": 42, # The width of the creative
6382 "height": 42, # The height of the creative.
6383 },
6384 ],
6385 "nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value
6386 # only if creative_size_type = CreativeSizeType.NATIVE.
6387 "allowedFormats": [ # What formats are allowed by the publisher.
6388 # If this repeated field is empty then all formats are allowed.
6389 # For example, if this field contains AllowedFormatType.AUDIO then the
6390 # publisher only allows an audio ad (without any video).
6391 "A String",
6392 ],
6393 "skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if
6394 # creative_size_type = CreativeSizeType.VIDEO.
6395 "creativeSizeType": "A String", # The creative size type.
6396 "size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size
6397 # of the creative
6398 # height depend on the type of the targeting.
6399 "width": 42, # The width of the creative
6400 "height": 42, # The height of the creative.
6401 },
6402 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6403 },
6404 ],
6405 "key": "A String", # The key representing the shared targeting criterion.
6406 # Targeting criteria defined by Google ad servers will begin with GOOG_.
6407 # Third parties may define their own keys.
6408 # A list of permissible keys along with the acceptable values will be
6409 # provided as part of the external documentation.
6410 },
6411 ],
6412 "dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal.
6413 "dealPauseStatus": { # Tracks which parties (if any) have paused a deal. # Output only. Tracks which parties (if any) have paused a deal.
6414 # The deal is considered paused if either hasBuyerPaused or
6415 # hasSellPaused is true.
6416 "hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally.
6417 "buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal.
6418 "sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal.
6419 "hasBuyerPaused": True or False, # True, if the buyer has paused the deal unilaterally.
6420 "firstPausedBy": "A String", # The role of the person who first paused this deal.
6421 },
6422 },
6423 "isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this
6424 # deal.
6425 },
6426 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6427 "updateTime": "A String", # Output only. The time when the proposal was last revised.
6428 "proposalState": "A String", # Output only. The current state of the proposal.
6429 "proposalRevision": "A String", # Output only. The revision number for the proposal.
6430 # Each update to the proposal or the deal causes the proposal revision number
6431 # to auto-increment. The buyer keeps track of the last revision number they
6432 # know of and pass it in when making an update. If the head revision number
6433 # on the server has since incremented, then an ABORTED error is returned
6434 # during the update operation to let the buyer know that a subsequent update
6435 # was made.
6436 "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller).
6437 "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list
6438 # operations (max-length: 1024 unicode code units).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6439 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6440 "privateAuctionId": "A String", # Output only. Private auction ID if this proposal is a private auction
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6441 # proposal.
6442 "notes": [ # Output only. The notes associated with this proposal.
6443 { # A proposal may be associated to several notes.
6444 "note": "A String", # The actual note to attach.
6445 # (max-length: 1024 unicode code units)
6446 #
6447 # Note: This field may be set only when creating the resource. Modifying
6448 # this field while updating the resource will result in an error.
6449 "creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note.
6450 "proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created.
6451 "createTime": "A String", # Output only. The timestamp for when this note was created.
6452 "noteId": "A String", # Output only. The unique ID for the note.
6453 },
6454 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6455 "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.
6456 "billedBuyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Output only. Reference to the buyer that will get billed for this proposal.
6457 # Authorized Buyers account ID.
6458 "accountId": "A String", # Authorized Buyers account ID of the buyer.
6459 },
6460 "seller": { # Represents a seller of inventory. Each seller is identified by a unique # Reference to the seller on the proposal.
6461 #
6462 # Note: This field may be set only when creating the resource. Modifying
6463 # this field while updating the resource will result in an error.
6464 # Ad Manager account ID.
6465 "subAccountId": "A String", # Optional sub-account ID for the seller.
6466 "accountId": "A String", # The unique ID for the seller. The seller fills in this field.
6467 # The seller account ID is then available to buyer in the product.
6468 },
6469 "sellerContacts": [ # Output only. Contact information for the seller.
6470 { # Contains information on how a buyer or seller can be reached.
6471 "email": "A String", # Email address for the contact.
6472 "name": "A String", # The name of the contact.
6473 },
6474 ],
6475 "proposalId": "A String", # Output only. The unique ID of the proposal.
6476 "isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated.
6477 "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Reference to the buyer on the proposal.
6478 #
6479 # Note: This field may be set only when creating the resource. Modifying
6480 # this field while updating the resource will result in an error.
6481 # Authorized Buyers account ID.
6482 "accountId": "A String", # Authorized Buyers account ID of the buyer.
6483 },
6484 "isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this
6485 # proposal.
6486 "displayName": "A String", # The name for the proposal.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6487 "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or
6488 # left a comment.
6489 "buyerContacts": [ # Contact information for the buyer.
6490 { # Contains information on how a buyer or seller can be reached.
6491 "email": "A String", # Email address for the contact.
6492 "name": "A String", # The name of the contact.
6493 },
6494 ],
6495}
6496
6497 x__xgafv: string, V1 error format.
6498 Allowed values
6499 1 - v1 error format
6500 2 - v2 error format
6501
6502Returns:
6503 An object of the form:
6504
6505 { # Note: this resource requires whitelisting for access. Please contact your
6506 # account manager for access to Marketplace resources.
6507 #
6508 # Represents a proposal in the Marketplace. A proposal is the unit of
6509 # negotiation between a seller and a buyer and contains deals which
6510 # are served.
6511 #
6512 # Note: you can not update, create, or otherwise modify Private
6513 # Auction or Preferred Deals deals through the API.
6514 #
6515 # Fields are updatable unless noted otherwise.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6516 "deals": [ # The deals associated with this proposal. For Private Auction proposals
6517 # (whose deals have NonGuaranteedAuctionTerms), there will only be one deal.
6518 { # A deal represents a segment of inventory for displaying ads on.
6519 # A proposal can contain multiple deals. A deal contains the terms and
6520 # targeting information that is used for serving.
6521 "updateTime": "A String", # Output only. The time when the deal was last updated.
6522 "createProductRevision": "A String", # Optional revision number of the product that the deal was created from.
6523 # If present on create, and the server `product_revision` has advanced sinced
6524 # the passed-in `create_product_revision`, an `ABORTED` error will be
6525 # returned.
6526 #
6527 # Note: This field may be set only when creating the resource. Modifying
6528 # this field while updating the resource will result in an error.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6529 "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals.
6530 # PUBLISHER means creative is provided by seller and ADVERTISER means
6531 # creative is provided by buyer.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6532 "availableStartTime": "A String", # Optional proposed flight start time of the deal.
6533 # This will generally be stored in the granularity of one second since deal
6534 # serving starts at seconds boundary. Any time specified with more
6535 # granularity (e.g., in milliseconds) will be truncated towards the start of
6536 # time in seconds.
6537 "availableEndTime": "A String", # Proposed flight end time of the deal.
6538 # This will generally be stored in a granularity of a second.
6539 # A value is not required for Private Auction deals or Preferred Deals.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6540 "externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is
6541 # finalized. This is the deal ID that shows up in serving/reporting etc.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6542 "targeting": { # Targeting represents different criteria that can be used by advertisers to # Output only. Specifies the subset of inventory targeted by the deal.
6543 # target ad inventory. For example, they can choose to target ad requests only
6544 # if the user is in the US.
6545 # Multiple types of targeting are always applied as a logical AND, unless noted
6546 # otherwise.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6547 "placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or # Placement targeting information, e.g., URL, mobile applications.
6548 # mobile applications.
6549 # Different placement targeting types will be logically OR'ed.
6550 "urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). # URLs to be included/excluded.
6551 # For Private Auction and AdX Preferred Deals, URLs are either included or
6552 # excluded.
6553 # For Programmatic Guaranteed and Preferred Deals, this doesn't
6554 # apply.
6555 "excludedUrls": [ # A list of URLs to be excluded.
6556 "A String",
6557 ],
6558 "targetedUrls": [ # A list of URLs to be included.
6559 "A String",
6560 ],
6561 },
6562 "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal.
6563 # This doesn't apply to Auction Packages.
6564 "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that # Publisher owned apps to be targeted or excluded by the publisher to
6565 # display the ads in.
6566 # publishers own.
6567 # Mobile application IDs are from App Store and Google Play Store.
6568 # Android App ID, for example, com.google.android.apps.maps, can be found in
6569 # Google Play Store URL.
6570 # iOS App ID (which is a number) can be found at the end of iTunes store URL.
6571 # First party mobile applications is either included or excluded.
6572 "excludedAppIds": [ # A list of application IDs to be excluded.
6573 "A String",
6574 ],
6575 "targetedAppIds": [ # A list of application IDs to be included.
6576 "A String",
6577 ],
6578 },
6579 },
6580 },
6581 "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of # Geo criteria IDs to be included/excluded.
6582 # included and excluded numeric IDs.
6583 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
6584 "A String",
6585 ],
6586 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
6587 "A String",
6588 ],
6589 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6590 "videoTargeting": { # Represents targeting information about video. # Video targeting information.
6591 "excludedPositionTypes": [ # A list of video positions to be excluded.
6592 # Position types can either be included or excluded (XOR).
6593 "A String",
6594 ],
6595 "targetedPositionTypes": [ # A list of video positions to be included.
6596 # When the included list is present, the excluded list must be empty.
6597 # When the excluded list is present, the included list must be empty.
6598 "A String",
6599 ],
6600 },
6601 "technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category.
6602 "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device categories to be included/excluded.
6603 # included and excluded numeric IDs.
6604 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
6605 "A String",
6606 ],
6607 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
6608 "A String",
6609 ],
6610 },
6611 "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
6612 "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating systems to be included/excluded.
6613 # included and excluded numeric IDs.
6614 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
6615 "A String",
6616 ],
6617 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
6618 "A String",
6619 ],
6620 },
6621 "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating system versions to be included/excluded.
6622 # included and excluded numeric IDs.
6623 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
6624 "A String",
6625 ],
6626 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
6627 "A String",
6628 ],
6629 },
6630 },
6631 "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device capabilities to be included/excluded.
6632 # included and excluded numeric IDs.
6633 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
6634 "A String",
6635 ],
6636 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
6637 "A String",
6638 ],
6639 },
6640 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6641 "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on an ad # Inventory sizes to be included/excluded.
6642 # request. It only applies to Private Auction, AdX Preferred Deals and
6643 # Auction Packages. This targeting does not apply to Programmatic Guaranteed
6644 # and Preferred Deals in Ad Manager.
6645 "targetedInventorySizes": [ # A list of inventory sizes to be included.
6646 { # Represents size of a single ad slot, or a creative.
6647 "width": "A String", # The width of the ad slot in pixels.
6648 # This field will be present only when size type is `PIXEL`.
6649 "sizeType": "A String", # The size type of the ad slot.
6650 "height": "A String", # The height of the ad slot in pixels.
6651 # This field will be present only when size type is `PIXEL`.
6652 },
6653 ],
6654 "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
6655 { # Represents size of a single ad slot, or a creative.
6656 "width": "A String", # The width of the ad slot in pixels.
6657 # This field will be present only when size type is `PIXEL`.
6658 "sizeType": "A String", # The size type of the ad slot.
6659 "height": "A String", # The height of the ad slot in pixels.
6660 # This field will be present only when size type is `PIXEL`.
6661 },
6662 ],
6663 },
6664 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6665 "createTime": "A String", # Output only. The time of the deal creation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6666 "webPropertyCode": "A String", # The web property code for the seller copied over from the product.
6667 "proposalId": "A String", # Output only. ID of the proposal that this deal is part of.
6668 "deliveryControl": { # Message contains details about how the deals will be paced. # The set of fields around delivery control that are interesting for a buyer
6669 # to see but are non-negotiable. These are set by the publisher.
6670 "frequencyCaps": [ # Output only. Specifies any frequency caps.
6671 { # Frequency cap.
6672 "numTimeUnits": 42, # The amount of time, in the units specified by time_unit_type. Defines the
6673 # amount of time over which impressions per user are counted and capped.
6674 "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over
6675 # which impressions per user are counted and capped.
6676 "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the
6677 # specified time period.
6678 },
6679 ],
6680 "creativeBlockingLevel": "A String", # Output only. Specified the creative blocking levels to be applied.
6681 "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
6682 },
6683 "description": "A String", # Description for the deal terms.
6684 "dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned).
6685 "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
6686 "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6687 "creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ # Output only. Restricitions about the creatives associated with the deal
6688 # (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals
6689 # in Ad Manager.
6690 # Preferred Deal in Ad Manager.
6691 # This doesn't apply to Private Auction and AdX Preferred Deals.
6692 "creativeFormat": "A String", # The format of the environment that the creatives will be displayed in.
6693 "creativeSpecifications": [
6694 { # Represents information for a creative that is associated with a Programmatic
6695 # Guaranteed/Preferred Deal in Ad Manager.
6696 "creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative.
6697 "width": "A String", # The width of the ad slot in pixels.
6698 # This field will be present only when size type is `PIXEL`.
6699 "sizeType": "A String", # The size type of the ad slot.
6700 "height": "A String", # The height of the ad slot in pixels.
6701 # This field will be present only when size type is `PIXEL`.
6702 },
6703 "creativeCompanionSizes": [ # Companion sizes may be filled in only when this is a video creative.
6704 { # Represents size of a single ad slot, or a creative.
6705 "width": "A String", # The width of the ad slot in pixels.
6706 # This field will be present only when size type is `PIXEL`.
6707 "sizeType": "A String", # The size type of the ad slot.
6708 "height": "A String", # The height of the ad slot in pixels.
6709 # This field will be present only when size type is `PIXEL`.
6710 },
6711 ],
6712 },
6713 ],
6714 "skippableAdType": "A String", # Skippable video ads allow viewers to skip ads after 5 seconds.
6715 },
6716 "createProductId": "A String", # The product ID from which this deal was created.
6717 #
6718 # Note: This field may be set only when creating the resource. Modifying
6719 # this field while updating the resource will result in an error.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6720 "dealTerms": { # The deal terms specify the details of a Product/deal. They specify things # The negotiable terms of the deal.
6721 # like price per buyer, the type of pricing model (e.g., fixed price, auction)
6722 # and expected impressions from the publisher.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6723 "brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED)
6724 "estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal.
6725 # Can be set by buyer or seller.
6726 "pricingType": "A String", # The pricing type for the deal/product. (default: CPM)
6727 "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
6728 "nanos": 42, # Number of nano (10^-9) units of the amount.
6729 # The value must be between -999,999,999 and +999,999,999 inclusive.
6730 # If `units` is positive, `nanos` must be positive or zero.
6731 # If `units` is zero, `nanos` can be positive, zero, or negative.
6732 # If `units` is negative, `nanos` must be negative or zero.
6733 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
6734 "units": "A String", # The whole units of the amount.
6735 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
6736 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
6737 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6738 },
6739 "sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the
6740 # time zone used to mark the boundaries of a day. It should be an
6741 # IANA TZ name, such as "America/Los_Angeles". For more information,
6742 # see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.
6743 "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day.
6744 # Can be set by buyer or seller.
6745 "nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via # The terms for non-guaranteed fixed price deals.
6746 # the API at this time, but can be returned in a get or list request.
6747 "fixedPrices": [ # Fixed price for the specified buyer.
6748 { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in
6749 # a product can become 0 or 1 deals. To check if there is a PricePerBuyer for
6750 # a particular buyer or buyer/advertiser pair, we look for the most specific
6751 # matching rule - we first look for a rule matching the buyer and advertiser,
6752 # next a rule with the buyer but an empty advertiser list, and otherwise look
6753 # for a matching rule where no buyer is set.
6754 "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # The buyer who will pay this price. If unset, all buyers can pay this price
6755 # (if the
6756 # advertisers match, and there's no more specific rule matching the buyer).
6757 # Authorized Buyers account ID.
6758 "accountId": "A String", # Authorized Buyers account ID of the buyer.
6759 },
6760 "advertiserIds": [ # The list of advertisers for this price when associated with this buyer.
6761 # If empty, all advertisers with this buyer pay this price.
6762 "A String",
6763 ],
6764 "price": { # Represents a price and a pricing type for a product / deal. # The specified price.
6765 "pricingType": "A String", # The pricing type for the deal/product. (default: CPM)
6766 "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
6767 "nanos": 42, # Number of nano (10^-9) units of the amount.
6768 # The value must be between -999,999,999 and +999,999,999 inclusive.
6769 # If `units` is positive, `nanos` must be positive or zero.
6770 # If `units` is zero, `nanos` can be positive, zero, or negative.
6771 # If `units` is negative, `nanos` must be negative or zero.
6772 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
6773 "units": "A String", # The whole units of the amount.
6774 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
6775 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
6776 },
6777 },
6778 },
6779 ],
6780 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6781 "guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals.
6782 "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage
6783 # of guaranteed looks that the buyer is guaranteeing to buy.
6784 "fixedPrices": [ # Fixed price for the specified buyer.
6785 { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in
6786 # a product can become 0 or 1 deals. To check if there is a PricePerBuyer for
6787 # a particular buyer or buyer/advertiser pair, we look for the most specific
6788 # matching rule - we first look for a rule matching the buyer and advertiser,
6789 # next a rule with the buyer but an empty advertiser list, and otherwise look
6790 # for a matching rule where no buyer is set.
6791 "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # The buyer who will pay this price. If unset, all buyers can pay this price
6792 # (if the
6793 # advertisers match, and there's no more specific rule matching the buyer).
6794 # Authorized Buyers account ID.
6795 "accountId": "A String", # Authorized Buyers account ID of the buyer.
6796 },
6797 "advertiserIds": [ # The list of advertisers for this price when associated with this buyer.
6798 # If empty, all advertisers with this buyer pay this price.
6799 "A String",
6800 ],
6801 "price": { # Represents a price and a pricing type for a product / deal. # The specified price.
6802 "pricingType": "A String", # The pricing type for the deal/product. (default: CPM)
6803 "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
6804 "nanos": 42, # Number of nano (10^-9) units of the amount.
6805 # The value must be between -999,999,999 and +999,999,999 inclusive.
6806 # If `units` is positive, `nanos` must be positive or zero.
6807 # If `units` is zero, `nanos` can be positive, zero, or negative.
6808 # If `units` is negative, `nanos` must be negative or zero.
6809 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
6810 "units": "A String", # The whole units of the amount.
6811 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
6812 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
6813 },
6814 },
6815 },
6816 ],
6817 "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.
6818 "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6819 },
6820 "nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only # The terms for non-guaranteed auction deals.
6821 # by the seller, but they can be returned in a get or list request.
6822 "reservePricesPerBuyer": [ # Reserve price for the specified buyer.
6823 { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in
6824 # a product can become 0 or 1 deals. To check if there is a PricePerBuyer for
6825 # a particular buyer or buyer/advertiser pair, we look for the most specific
6826 # matching rule - we first look for a rule matching the buyer and advertiser,
6827 # next a rule with the buyer but an empty advertiser list, and otherwise look
6828 # for a matching rule where no buyer is set.
6829 "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # The buyer who will pay this price. If unset, all buyers can pay this price
6830 # (if the
6831 # advertisers match, and there's no more specific rule matching the buyer).
6832 # Authorized Buyers account ID.
6833 "accountId": "A String", # Authorized Buyers account ID of the buyer.
6834 },
6835 "advertiserIds": [ # The list of advertisers for this price when associated with this buyer.
6836 # If empty, all advertisers with this buyer pay this price.
6837 "A String",
6838 ],
6839 "price": { # Represents a price and a pricing type for a product / deal. # The specified price.
6840 "pricingType": "A String", # The pricing type for the deal/product. (default: CPM)
6841 "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
6842 "nanos": 42, # Number of nano (10^-9) units of the amount.
6843 # The value must be between -999,999,999 and +999,999,999 inclusive.
6844 # If `units` is positive, `nanos` must be positive or zero.
6845 # If `units` is zero, `nanos` can be positive, zero, or negative.
6846 # If `units` is negative, `nanos` must be negative or zero.
6847 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
6848 "units": "A String", # The whole units of the amount.
6849 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
6850 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
6851 },
6852 },
6853 },
6854 ],
6855 "autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers
6856 # in this private auction.
6857 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6858 "description": "A String", # Publisher provided description for the terms.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6859 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6860 "sellerContacts": [ # Output only. Seller contact information for the deal.
6861 { # Contains information on how a buyer or seller can be reached.
6862 "email": "A String", # Email address for the contact.
6863 "name": "A String", # The name of the contact.
6864 },
6865 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6866 "displayName": "A String", # The name of the deal.
6867 "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller).
6868 "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list
6869 # operations (max-length: 1024 unicode code units).
6870 },
6871 "syndicationProduct": "A String", # The syndication product associated with the deal.
6872 #
6873 # Note: This field may be set only when creating the resource. Modifying
6874 # this field while updating the resource will result in an error.
6875 "targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared
6876 # targeting entity is AND'd together.
6877 { # Advertisers can target different attributes of an ad slot. For example,
6878 # they can choose to show ads only if the user is in the U.S. Such
6879 # targeting criteria can be specified as part of Shared Targeting.
6880 "inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd
6881 # together.
6882 { # A polymorphic targeting value used as part of Shared Targeting.
6883 "stringValue": "A String", # The string value to include/exclude.
6884 "longValue": "A String", # The long value to include/exclude.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6885 "dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.
6886 # Filled in when the key is GOOG_DAYPART_TARGETING.
6887 # The definition of this targeting is derived from the structure
6888 # used by Ad Manager.
6889 "dayParts": [ # A list of day part targeting criterion.
6890 { # Daypart targeting message that specifies if the ad can be shown
6891 # only during certain parts of a day/week.
6892 "dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.
6893 "endTime": { # Represents a time of day. The date and time zone are either not significant # The ending time of the day for the ad to show (minute level
6894 # granularity). The end time is exclusive. This field is not available
6895 # for filtering in PQL queries.
6896 # or are specified elsewhere. An API may choose to allow leap seconds. Related
6897 # types are google.type.Date and `google.protobuf.Timestamp`.
6898 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
6899 # to allow the value "24:00:00" for scenarios like business closing time.
6900 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
6901 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
6902 # allow the value 60 if it allows leap-seconds.
6903 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
6904 },
6905 "startTime": { # Represents a time of day. The date and time zone are either not significant # The starting time of day for the ad to show (minute level granularity).
6906 # The start time is inclusive.
6907 # This field is not available for filtering in PQL queries.
6908 # or are specified elsewhere. An API may choose to allow leap seconds. Related
6909 # types are google.type.Date and `google.protobuf.Timestamp`.
6910 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
6911 # to allow the value "24:00:00" for scenarios like business closing time.
6912 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
6913 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
6914 # allow the value 60 if it allows leap-seconds.
6915 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
6916 },
6917 },
6918 ],
6919 "timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.
6920 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6921 "creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.
6922 # Filled in when key = GOOG_CREATIVE_SIZE
6923 "companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).
6924 # Companion sizes may be filled in only when creative_size_type = VIDEO
6925 { # Message depicting the size of the creative. The units of width and
6926 # height depend on the type of the targeting.
6927 "width": 42, # The width of the creative
6928 "height": 42, # The height of the creative.
6929 },
6930 ],
6931 "nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value
6932 # only if creative_size_type = CreativeSizeType.NATIVE.
6933 "allowedFormats": [ # What formats are allowed by the publisher.
6934 # If this repeated field is empty then all formats are allowed.
6935 # For example, if this field contains AllowedFormatType.AUDIO then the
6936 # publisher only allows an audio ad (without any video).
6937 "A String",
6938 ],
6939 "skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if
6940 # creative_size_type = CreativeSizeType.VIDEO.
6941 "creativeSizeType": "A String", # The creative size type.
6942 "size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size
6943 # of the creative
6944 # height depend on the type of the targeting.
6945 "width": 42, # The width of the creative
6946 "height": 42, # The height of the creative.
6947 },
6948 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6949 },
6950 ],
6951 "exclusions": [ # The list of values to exclude from targeting. Each value is AND'd
6952 # together.
6953 { # A polymorphic targeting value used as part of Shared Targeting.
6954 "stringValue": "A String", # The string value to include/exclude.
6955 "longValue": "A String", # The long value to include/exclude.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]6956 "dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.
6957 # Filled in when the key is GOOG_DAYPART_TARGETING.
6958 # The definition of this targeting is derived from the structure
6959 # used by Ad Manager.
6960 "dayParts": [ # A list of day part targeting criterion.
6961 { # Daypart targeting message that specifies if the ad can be shown
6962 # only during certain parts of a day/week.
6963 "dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.
6964 "endTime": { # Represents a time of day. The date and time zone are either not significant # The ending time of the day for the ad to show (minute level
6965 # granularity). The end time is exclusive. This field is not available
6966 # for filtering in PQL queries.
6967 # or are specified elsewhere. An API may choose to allow leap seconds. Related
6968 # types are google.type.Date and `google.protobuf.Timestamp`.
6969 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
6970 # to allow the value "24:00:00" for scenarios like business closing time.
6971 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
6972 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
6973 # allow the value 60 if it allows leap-seconds.
6974 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
6975 },
6976 "startTime": { # Represents a time of day. The date and time zone are either not significant # The starting time of day for the ad to show (minute level granularity).
6977 # The start time is inclusive.
6978 # This field is not available for filtering in PQL queries.
6979 # or are specified elsewhere. An API may choose to allow leap seconds. Related
6980 # types are google.type.Date and `google.protobuf.Timestamp`.
6981 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
6982 # to allow the value "24:00:00" for scenarios like business closing time.
6983 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
6984 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
6985 # allow the value 60 if it allows leap-seconds.
6986 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
6987 },
6988 },
6989 ],
6990 "timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.
6991 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]6992 "creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.
6993 # Filled in when key = GOOG_CREATIVE_SIZE
6994 "companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).
6995 # Companion sizes may be filled in only when creative_size_type = VIDEO
6996 { # Message depicting the size of the creative. The units of width and
6997 # height depend on the type of the targeting.
6998 "width": 42, # The width of the creative
6999 "height": 42, # The height of the creative.
7000 },
7001 ],
7002 "nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value
7003 # only if creative_size_type = CreativeSizeType.NATIVE.
7004 "allowedFormats": [ # What formats are allowed by the publisher.
7005 # If this repeated field is empty then all formats are allowed.
7006 # For example, if this field contains AllowedFormatType.AUDIO then the
7007 # publisher only allows an audio ad (without any video).
7008 "A String",
7009 ],
7010 "skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if
7011 # creative_size_type = CreativeSizeType.VIDEO.
7012 "creativeSizeType": "A String", # The creative size type.
7013 "size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size
7014 # of the creative
7015 # height depend on the type of the targeting.
7016 "width": 42, # The width of the creative
7017 "height": 42, # The height of the creative.
7018 },
7019 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7020 },
7021 ],
7022 "key": "A String", # The key representing the shared targeting criterion.
7023 # Targeting criteria defined by Google ad servers will begin with GOOG_.
7024 # Third parties may define their own keys.
7025 # A list of permissible keys along with the acceptable values will be
7026 # provided as part of the external documentation.
7027 },
7028 ],
7029 "dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal.
7030 "dealPauseStatus": { # Tracks which parties (if any) have paused a deal. # Output only. Tracks which parties (if any) have paused a deal.
7031 # The deal is considered paused if either hasBuyerPaused or
7032 # hasSellPaused is true.
7033 "hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally.
7034 "buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal.
7035 "sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal.
7036 "hasBuyerPaused": True or False, # True, if the buyer has paused the deal unilaterally.
7037 "firstPausedBy": "A String", # The role of the person who first paused this deal.
7038 },
7039 },
7040 "isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this
7041 # deal.
7042 },
7043 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7044 "updateTime": "A String", # Output only. The time when the proposal was last revised.
7045 "proposalState": "A String", # Output only. The current state of the proposal.
7046 "proposalRevision": "A String", # Output only. The revision number for the proposal.
7047 # Each update to the proposal or the deal causes the proposal revision number
7048 # to auto-increment. The buyer keeps track of the last revision number they
7049 # know of and pass it in when making an update. If the head revision number
7050 # on the server has since incremented, then an ABORTED error is returned
7051 # during the update operation to let the buyer know that a subsequent update
7052 # was made.
7053 "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller).
7054 "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list
7055 # operations (max-length: 1024 unicode code units).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7056 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7057 "privateAuctionId": "A String", # Output only. Private auction ID if this proposal is a private auction
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7058 # proposal.
7059 "notes": [ # Output only. The notes associated with this proposal.
7060 { # A proposal may be associated to several notes.
7061 "note": "A String", # The actual note to attach.
7062 # (max-length: 1024 unicode code units)
7063 #
7064 # Note: This field may be set only when creating the resource. Modifying
7065 # this field while updating the resource will result in an error.
7066 "creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note.
7067 "proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created.
7068 "createTime": "A String", # Output only. The timestamp for when this note was created.
7069 "noteId": "A String", # Output only. The unique ID for the note.
7070 },
7071 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7072 "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.
7073 "billedBuyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Output only. Reference to the buyer that will get billed for this proposal.
7074 # Authorized Buyers account ID.
7075 "accountId": "A String", # Authorized Buyers account ID of the buyer.
7076 },
7077 "seller": { # Represents a seller of inventory. Each seller is identified by a unique # Reference to the seller on the proposal.
7078 #
7079 # Note: This field may be set only when creating the resource. Modifying
7080 # this field while updating the resource will result in an error.
7081 # Ad Manager account ID.
7082 "subAccountId": "A String", # Optional sub-account ID for the seller.
7083 "accountId": "A String", # The unique ID for the seller. The seller fills in this field.
7084 # The seller account ID is then available to buyer in the product.
7085 },
7086 "sellerContacts": [ # Output only. Contact information for the seller.
7087 { # Contains information on how a buyer or seller can be reached.
7088 "email": "A String", # Email address for the contact.
7089 "name": "A String", # The name of the contact.
7090 },
7091 ],
7092 "proposalId": "A String", # Output only. The unique ID of the proposal.
7093 "isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated.
7094 "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Reference to the buyer on the proposal.
7095 #
7096 # Note: This field may be set only when creating the resource. Modifying
7097 # this field while updating the resource will result in an error.
7098 # Authorized Buyers account ID.
7099 "accountId": "A String", # Authorized Buyers account ID of the buyer.
7100 },
7101 "isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this
7102 # proposal.
7103 "displayName": "A String", # The name for the proposal.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7104 "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or
7105 # left a comment.
7106 "buyerContacts": [ # Contact information for the buyer.
7107 { # Contains information on how a buyer or seller can be reached.
7108 "email": "A String", # Email address for the contact.
7109 "name": "A String", # The name of the contact.
7110 },
7111 ],
7112 }</pre>
7113</div>
7114
7115</body></html>