Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / adexchangebuyer2_v2beta1.accounts.finalizedProposals.html
blob: f80af56e44a29a9998ec2e4dd52c6087f71e4f4a [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.finalizedProposals.html">finalizedProposals</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#list">list(accountId, pageSize=None, pageToken=None, x__xgafv=None, filterSyntax=None, filter=None)</a></code></p>
79<p class="firstline">List finalized proposals, regardless if a proposal is being renegotiated.</p>
80<p class="toc_element">
81 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
82<p class="firstline">Retrieves the next page of results.</p>
83<h3>Method Details</h3>
84<div class="method">
85 <code class="details" id="list">list(accountId, pageSize=None, pageToken=None, x__xgafv=None, filterSyntax=None, filter=None)</code>
86 <pre>List finalized proposals, regardless if a proposal is being renegotiated.
87A filter expression (PQL query) may be specified to filter the results.
88The notes will not be returned.
89
90Args:
91 accountId: string, Account ID of the buyer. (required)
92 pageSize: integer, Requested page size. The server may return fewer results than requested.
93If unspecified, the server will pick an appropriate default.
94 pageToken: string, The page token as returned from ListProposalsResponse.
95 x__xgafv: string, V1 error format.
96 Allowed values
97 1 - v1 error format
98 2 - v2 error format
99 filterSyntax: string, Syntax the filter is written in. Current implementation defaults to PQL
100but in the future it will be LIST_FILTER.
101 filter: string, An optional PQL filter query used to query for proposals.
102
103Nested repeated fields, such as proposal.deals.targetingCriterion,
104cannot be filtered.
105
106Returns:
107 An object of the form:
108
109 { # Response message for listing proposals.
110 "nextPageToken": "A String", # Continuation token for fetching the next page of results.
111 "proposals": [ # The list of proposals.
112 { # Note: this resource requires whitelisting for access. Please contact your
113 # account manager for access to Marketplace resources.
114 #
115 # Represents a proposal in the Marketplace. A proposal is the unit of
116 # negotiation between a seller and a buyer and contains deals which
117 # are served.
118 #
119 # Note: you can not update, create, or otherwise modify Private
120 # Auction or Preferred Deals deals through the API.
121 #
122 # Fields are updatable unless noted otherwise.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]123 "deals": [ # The deals associated with this proposal. For Private Auction proposals
124 # (whose deals have NonGuaranteedAuctionTerms), there will only be one deal.
125 { # A deal represents a segment of inventory for displaying ads on.
126 # A proposal can contain multiple deals. A deal contains the terms and
127 # targeting information that is used for serving.
128 "updateTime": "A String", # Output only. The time when the deal was last updated.
129 "createProductRevision": "A String", # Optional revision number of the product that the deal was created from.
130 # If present on create, and the server `product_revision` has advanced sinced
131 # the passed-in `create_product_revision`, an `ABORTED` error will be
132 # returned.
133 #
134 # Note: This field may be set only when creating the resource. Modifying
135 # this field while updating the resource will result in an error.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]136 "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals.
137 # PUBLISHER means creative is provided by seller and ADVERTISER means
138 # creative is provided by buyer.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]139 "availableStartTime": "A String", # Optional proposed flight start time of the deal.
140 # This will generally be stored in the granularity of one second since deal
141 # serving starts at seconds boundary. Any time specified with more
142 # granularity (e.g., in milliseconds) will be truncated towards the start of
143 # time in seconds.
144 "availableEndTime": "A String", # Proposed flight end time of the deal.
145 # This will generally be stored in a granularity of a second.
146 # A value is not required for Private Auction deals or Preferred Deals.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]147 "externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is
148 # finalized. This is the deal ID that shows up in serving/reporting etc.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]149 "targeting": { # Targeting represents different criteria that can be used by advertisers to # Output only. Specifies the subset of inventory targeted by the deal.
150 # target ad inventory. For example, they can choose to target ad requests only
151 # if the user is in the US.
152 # Multiple types of targeting are always applied as a logical AND, unless noted
153 # otherwise.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]154 "placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or # Placement targeting information, e.g., URL, mobile applications.
155 # mobile applications.
156 # Different placement targeting types will be logically OR'ed.
157 "urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). # URLs to be included/excluded.
158 # For Private Auction and AdX Preferred Deals, URLs are either included or
159 # excluded.
160 # For Programmatic Guaranteed and Preferred Deals, this doesn't
161 # apply.
162 "excludedUrls": [ # A list of URLs to be excluded.
163 "A String",
164 ],
165 "targetedUrls": [ # A list of URLs to be included.
166 "A String",
167 ],
168 },
169 "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal.
170 # This doesn't apply to Auction Packages.
171 "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that # Publisher owned apps to be targeted or excluded by the publisher to
172 # display the ads in.
173 # publishers own.
174 # Mobile application IDs are from App Store and Google Play Store.
175 # Android App ID, for example, com.google.android.apps.maps, can be found in
176 # Google Play Store URL.
177 # iOS App ID (which is a number) can be found at the end of iTunes store URL.
178 # First party mobile applications is either included or excluded.
179 "excludedAppIds": [ # A list of application IDs to be excluded.
180 "A String",
181 ],
182 "targetedAppIds": [ # A list of application IDs to be included.
183 "A String",
184 ],
185 },
186 },
187 },
188 "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of # Geo criteria IDs to be included/excluded.
189 # included and excluded numeric IDs.
190 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
191 "A String",
192 ],
193 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
194 "A String",
195 ],
196 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]197 "videoTargeting": { # Represents targeting information about video. # Video targeting information.
198 "excludedPositionTypes": [ # A list of video positions to be excluded.
199 # Position types can either be included or excluded (XOR).
200 "A String",
201 ],
202 "targetedPositionTypes": [ # A list of video positions to be included.
203 # When the included list is present, the excluded list must be empty.
204 # When the excluded list is present, the included list must be empty.
205 "A String",
206 ],
207 },
208 "technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category.
209 "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device categories to be included/excluded.
210 # included and excluded numeric IDs.
211 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
212 "A String",
213 ],
214 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
215 "A String",
216 ],
217 },
218 "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
219 "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating systems to be included/excluded.
220 # included and excluded numeric IDs.
221 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
222 "A String",
223 ],
224 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
225 "A String",
226 ],
227 },
228 "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of # IDs of operating system versions to be included/excluded.
229 # included and excluded numeric IDs.
230 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
231 "A String",
232 ],
233 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
234 "A String",
235 ],
236 },
237 },
238 "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of # IDs of device capabilities to be included/excluded.
239 # included and excluded numeric IDs.
240 "targetedCriteriaIds": [ # A list of numeric IDs to be included.
241 "A String",
242 ],
243 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
244 "A String",
245 ],
246 },
247 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]248 "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on an ad # Inventory sizes to be included/excluded.
249 # request. It only applies to Private Auction, AdX Preferred Deals and
250 # Auction Packages. This targeting does not apply to Programmatic Guaranteed
251 # and Preferred Deals in Ad Manager.
252 "targetedInventorySizes": [ # A list of inventory sizes to be included.
253 { # Represents size of a single ad slot, or a creative.
254 "width": "A String", # The width of the ad slot in pixels.
255 # This field will be present only when size type is `PIXEL`.
256 "sizeType": "A String", # The size type of the ad slot.
257 "height": "A String", # The height of the ad slot in pixels.
258 # This field will be present only when size type is `PIXEL`.
259 },
260 ],
261 "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
262 { # Represents size of a single ad slot, or a creative.
263 "width": "A String", # The width of the ad slot in pixels.
264 # This field will be present only when size type is `PIXEL`.
265 "sizeType": "A String", # The size type of the ad slot.
266 "height": "A String", # The height of the ad slot in pixels.
267 # This field will be present only when size type is `PIXEL`.
268 },
269 ],
270 },
271 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]272 "createTime": "A String", # Output only. The time of the deal creation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]273 "webPropertyCode": "A String", # The web property code for the seller copied over from the product.
274 "proposalId": "A String", # Output only. ID of the proposal that this deal is part of.
275 "deliveryControl": { # Message contains details about how the deals will be paced. # The set of fields around delivery control that are interesting for a buyer
276 # to see but are non-negotiable. These are set by the publisher.
277 "frequencyCaps": [ # Output only. Specifies any frequency caps.
278 { # Frequency cap.
279 "numTimeUnits": 42, # The amount of time, in the units specified by time_unit_type. Defines the
280 # amount of time over which impressions per user are counted and capped.
281 "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over
282 # which impressions per user are counted and capped.
283 "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the
284 # specified time period.
285 },
286 ],
287 "creativeBlockingLevel": "A String", # Output only. Specified the creative blocking levels to be applied.
288 "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
289 },
290 "description": "A String", # Description for the deal terms.
291 "dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned).
292 "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
293 "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]294 "creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ # Output only. Restricitions about the creatives associated with the deal
295 # (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals
296 # in Ad Manager.
297 # Preferred Deal in Ad Manager.
298 # This doesn't apply to Private Auction and AdX Preferred Deals.
299 "creativeFormat": "A String", # The format of the environment that the creatives will be displayed in.
300 "creativeSpecifications": [
301 { # Represents information for a creative that is associated with a Programmatic
302 # Guaranteed/Preferred Deal in Ad Manager.
303 "creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative.
304 "width": "A String", # The width of the ad slot in pixels.
305 # This field will be present only when size type is `PIXEL`.
306 "sizeType": "A String", # The size type of the ad slot.
307 "height": "A String", # The height of the ad slot in pixels.
308 # This field will be present only when size type is `PIXEL`.
309 },
310 "creativeCompanionSizes": [ # Companion sizes may be filled in only when this is a video creative.
311 { # Represents size of a single ad slot, or a creative.
312 "width": "A String", # The width of the ad slot in pixels.
313 # This field will be present only when size type is `PIXEL`.
314 "sizeType": "A String", # The size type of the ad slot.
315 "height": "A String", # The height of the ad slot in pixels.
316 # This field will be present only when size type is `PIXEL`.
317 },
318 ],
319 },
320 ],
321 "skippableAdType": "A String", # Skippable video ads allow viewers to skip ads after 5 seconds.
322 },
323 "createProductId": "A String", # The product ID from which this deal was created.
324 #
325 # Note: This field may be set only when creating the resource. Modifying
326 # this field while updating the resource will result in an error.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]327 "dealTerms": { # The deal terms specify the details of a Product/deal. They specify things # The negotiable terms of the deal.
328 # like price per buyer, the type of pricing model (e.g., fixed price, auction)
329 # and expected impressions from the publisher.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]330 "brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED)
331 "estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal.
332 # Can be set by buyer or seller.
333 "pricingType": "A String", # The pricing type for the deal/product. (default: CPM)
334 "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
335 "nanos": 42, # Number of nano (10^-9) units of the amount.
336 # The value must be between -999,999,999 and +999,999,999 inclusive.
337 # If `units` is positive, `nanos` must be positive or zero.
338 # If `units` is zero, `nanos` can be positive, zero, or negative.
339 # If `units` is negative, `nanos` must be negative or zero.
340 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
341 "units": "A String", # The whole units of the amount.
342 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
343 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
344 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]345 },
346 "sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the
347 # time zone used to mark the boundaries of a day. It should be an
348 # IANA TZ name, such as "America/Los_Angeles". For more information,
349 # see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.
350 "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day.
351 # Can be set by buyer or seller.
352 "nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via # The terms for non-guaranteed fixed price deals.
353 # the API at this time, but can be returned in a get or list request.
354 "fixedPrices": [ # Fixed price for the specified buyer.
355 { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in
356 # a product can become 0 or 1 deals. To check if there is a PricePerBuyer for
357 # a particular buyer or buyer/advertiser pair, we look for the most specific
358 # matching rule - we first look for a rule matching the buyer and advertiser,
359 # next a rule with the buyer but an empty advertiser list, and otherwise look
360 # for a matching rule where no buyer is set.
361 "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
362 # (if the
363 # advertisers match, and there's no more specific rule matching the buyer).
364 # Authorized Buyers account ID.
365 "accountId": "A String", # Authorized Buyers account ID of the buyer.
366 },
367 "advertiserIds": [ # The list of advertisers for this price when associated with this buyer.
368 # If empty, all advertisers with this buyer pay this price.
369 "A String",
370 ],
371 "price": { # Represents a price and a pricing type for a product / deal. # The specified price.
372 "pricingType": "A String", # The pricing type for the deal/product. (default: CPM)
373 "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
374 "nanos": 42, # Number of nano (10^-9) units of the amount.
375 # The value must be between -999,999,999 and +999,999,999 inclusive.
376 # If `units` is positive, `nanos` must be positive or zero.
377 # If `units` is zero, `nanos` can be positive, zero, or negative.
378 # If `units` is negative, `nanos` must be negative or zero.
379 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
380 "units": "A String", # The whole units of the amount.
381 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
382 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
383 },
384 },
385 },
386 ],
387 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]388 "guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals.
389 "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage
390 # of guaranteed looks that the buyer is guaranteeing to buy.
391 "fixedPrices": [ # Fixed price for the specified buyer.
392 { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in
393 # a product can become 0 or 1 deals. To check if there is a PricePerBuyer for
394 # a particular buyer or buyer/advertiser pair, we look for the most specific
395 # matching rule - we first look for a rule matching the buyer and advertiser,
396 # next a rule with the buyer but an empty advertiser list, and otherwise look
397 # for a matching rule where no buyer is set.
398 "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
399 # (if the
400 # advertisers match, and there's no more specific rule matching the buyer).
401 # Authorized Buyers account ID.
402 "accountId": "A String", # Authorized Buyers account ID of the buyer.
403 },
404 "advertiserIds": [ # The list of advertisers for this price when associated with this buyer.
405 # If empty, all advertisers with this buyer pay this price.
406 "A String",
407 ],
408 "price": { # Represents a price and a pricing type for a product / deal. # The specified price.
409 "pricingType": "A String", # The pricing type for the deal/product. (default: CPM)
410 "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
411 "nanos": 42, # Number of nano (10^-9) units of the amount.
412 # The value must be between -999,999,999 and +999,999,999 inclusive.
413 # If `units` is positive, `nanos` must be positive or zero.
414 # If `units` is zero, `nanos` can be positive, zero, or negative.
415 # If `units` is negative, `nanos` must be negative or zero.
416 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
417 "units": "A String", # The whole units of the amount.
418 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
419 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
420 },
421 },
422 },
423 ],
424 "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.
425 "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]426 },
427 "nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only # The terms for non-guaranteed auction deals.
428 # by the seller, but they can be returned in a get or list request.
429 "reservePricesPerBuyer": [ # Reserve price for the specified buyer.
430 { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in
431 # a product can become 0 or 1 deals. To check if there is a PricePerBuyer for
432 # a particular buyer or buyer/advertiser pair, we look for the most specific
433 # matching rule - we first look for a rule matching the buyer and advertiser,
434 # next a rule with the buyer but an empty advertiser list, and otherwise look
435 # for a matching rule where no buyer is set.
436 "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
437 # (if the
438 # advertisers match, and there's no more specific rule matching the buyer).
439 # Authorized Buyers account ID.
440 "accountId": "A String", # Authorized Buyers account ID of the buyer.
441 },
442 "advertiserIds": [ # The list of advertisers for this price when associated with this buyer.
443 # If empty, all advertisers with this buyer pay this price.
444 "A String",
445 ],
446 "price": { # Represents a price and a pricing type for a product / deal. # The specified price.
447 "pricingType": "A String", # The pricing type for the deal/product. (default: CPM)
448 "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
449 "nanos": 42, # Number of nano (10^-9) units of the amount.
450 # The value must be between -999,999,999 and +999,999,999 inclusive.
451 # If `units` is positive, `nanos` must be positive or zero.
452 # If `units` is zero, `nanos` can be positive, zero, or negative.
453 # If `units` is negative, `nanos` must be negative or zero.
454 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
455 "units": "A String", # The whole units of the amount.
456 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
457 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
458 },
459 },
460 },
461 ],
462 "autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers
463 # in this private auction.
464 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]465 "description": "A String", # Publisher provided description for the terms.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]466 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]467 "sellerContacts": [ # Output only. Seller contact information for the deal.
468 { # Contains information on how a buyer or seller can be reached.
469 "email": "A String", # Email address for the contact.
470 "name": "A String", # The name of the contact.
471 },
472 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]473 "displayName": "A String", # The name of the deal.
474 "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller).
475 "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list
476 # operations (max-length: 1024 unicode code units).
477 },
478 "syndicationProduct": "A String", # The syndication product associated with the deal.
479 #
480 # Note: This field may be set only when creating the resource. Modifying
481 # this field while updating the resource will result in an error.
482 "targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared
483 # targeting entity is AND'd together.
484 { # Advertisers can target different attributes of an ad slot. For example,
485 # they can choose to show ads only if the user is in the U.S. Such
486 # targeting criteria can be specified as part of Shared Targeting.
487 "inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd
488 # together.
489 { # A polymorphic targeting value used as part of Shared Targeting.
490 "stringValue": "A String", # The string value to include/exclude.
491 "longValue": "A String", # The long value to include/exclude.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]492 "dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.
493 # Filled in when the key is GOOG_DAYPART_TARGETING.
494 # The definition of this targeting is derived from the structure
495 # used by Ad Manager.
496 "dayParts": [ # A list of day part targeting criterion.
497 { # Daypart targeting message that specifies if the ad can be shown
498 # only during certain parts of a day/week.
499 "dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.
500 "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
501 # granularity). The end time is exclusive. This field is not available
502 # for filtering in PQL queries.
503 # or are specified elsewhere. An API may choose to allow leap seconds. Related
504 # types are google.type.Date and `google.protobuf.Timestamp`.
505 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
506 # to allow the value "24:00:00" for scenarios like business closing time.
507 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
508 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
509 # allow the value 60 if it allows leap-seconds.
510 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
511 },
512 "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).
513 # The start time is inclusive.
514 # This field is not available for filtering in PQL queries.
515 # or are specified elsewhere. An API may choose to allow leap seconds. Related
516 # types are google.type.Date and `google.protobuf.Timestamp`.
517 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
518 # to allow the value "24:00:00" for scenarios like business closing time.
519 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
520 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
521 # allow the value 60 if it allows leap-seconds.
522 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
523 },
524 },
525 ],
526 "timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.
527 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]528 "creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.
529 # Filled in when key = GOOG_CREATIVE_SIZE
530 "companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).
531 # Companion sizes may be filled in only when creative_size_type = VIDEO
532 { # Message depicting the size of the creative. The units of width and
533 # height depend on the type of the targeting.
534 "width": 42, # The width of the creative
535 "height": 42, # The height of the creative.
536 },
537 ],
538 "nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value
539 # only if creative_size_type = CreativeSizeType.NATIVE.
540 "allowedFormats": [ # What formats are allowed by the publisher.
541 # If this repeated field is empty then all formats are allowed.
542 # For example, if this field contains AllowedFormatType.AUDIO then the
543 # publisher only allows an audio ad (without any video).
544 "A String",
545 ],
546 "skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if
547 # creative_size_type = CreativeSizeType.VIDEO.
548 "creativeSizeType": "A String", # The creative size type.
549 "size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size
550 # of the creative
551 # height depend on the type of the targeting.
552 "width": 42, # The width of the creative
553 "height": 42, # The height of the creative.
554 },
555 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]556 },
557 ],
558 "exclusions": [ # The list of values to exclude from targeting. Each value is AND'd
559 # together.
560 { # A polymorphic targeting value used as part of Shared Targeting.
561 "stringValue": "A String", # The string value to include/exclude.
562 "longValue": "A String", # The long value to include/exclude.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]563 "dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.
564 # Filled in when the key is GOOG_DAYPART_TARGETING.
565 # The definition of this targeting is derived from the structure
566 # used by Ad Manager.
567 "dayParts": [ # A list of day part targeting criterion.
568 { # Daypart targeting message that specifies if the ad can be shown
569 # only during certain parts of a day/week.
570 "dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.
571 "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
572 # granularity). The end time is exclusive. This field is not available
573 # for filtering in PQL queries.
574 # or are specified elsewhere. An API may choose to allow leap seconds. Related
575 # types are google.type.Date and `google.protobuf.Timestamp`.
576 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
577 # to allow the value "24:00:00" for scenarios like business closing time.
578 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
579 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
580 # allow the value 60 if it allows leap-seconds.
581 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
582 },
583 "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).
584 # The start time is inclusive.
585 # This field is not available for filtering in PQL queries.
586 # or are specified elsewhere. An API may choose to allow leap seconds. Related
587 # types are google.type.Date and `google.protobuf.Timestamp`.
588 "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
589 # to allow the value "24:00:00" for scenarios like business closing time.
590 "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
591 "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
592 # allow the value 60 if it allows leap-seconds.
593 "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
594 },
595 },
596 ],
597 "timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.
598 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]599 "creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.
600 # Filled in when key = GOOG_CREATIVE_SIZE
601 "companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).
602 # Companion sizes may be filled in only when creative_size_type = VIDEO
603 { # Message depicting the size of the creative. The units of width and
604 # height depend on the type of the targeting.
605 "width": 42, # The width of the creative
606 "height": 42, # The height of the creative.
607 },
608 ],
609 "nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value
610 # only if creative_size_type = CreativeSizeType.NATIVE.
611 "allowedFormats": [ # What formats are allowed by the publisher.
612 # If this repeated field is empty then all formats are allowed.
613 # For example, if this field contains AllowedFormatType.AUDIO then the
614 # publisher only allows an audio ad (without any video).
615 "A String",
616 ],
617 "skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if
618 # creative_size_type = CreativeSizeType.VIDEO.
619 "creativeSizeType": "A String", # The creative size type.
620 "size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size
621 # of the creative
622 # height depend on the type of the targeting.
623 "width": 42, # The width of the creative
624 "height": 42, # The height of the creative.
625 },
626 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]627 },
628 ],
629 "key": "A String", # The key representing the shared targeting criterion.
630 # Targeting criteria defined by Google ad servers will begin with GOOG_.
631 # Third parties may define their own keys.
632 # A list of permissible keys along with the acceptable values will be
633 # provided as part of the external documentation.
634 },
635 ],
636 "dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal.
637 "dealPauseStatus": { # Tracks which parties (if any) have paused a deal. # Output only. Tracks which parties (if any) have paused a deal.
638 # The deal is considered paused if either hasBuyerPaused or
639 # hasSellPaused is true.
640 "hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally.
641 "buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal.
642 "sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal.
643 "hasBuyerPaused": True or False, # True, if the buyer has paused the deal unilaterally.
644 "firstPausedBy": "A String", # The role of the person who first paused this deal.
645 },
646 },
647 "isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this
648 # deal.
649 },
650 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]651 "updateTime": "A String", # Output only. The time when the proposal was last revised.
652 "proposalState": "A String", # Output only. The current state of the proposal.
653 "proposalRevision": "A String", # Output only. The revision number for the proposal.
654 # Each update to the proposal or the deal causes the proposal revision number
655 # to auto-increment. The buyer keeps track of the last revision number they
656 # know of and pass it in when making an update. If the head revision number
657 # on the server has since incremented, then an ABORTED error is returned
658 # during the update operation to let the buyer know that a subsequent update
659 # was made.
660 "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller).
661 "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list
662 # operations (max-length: 1024 unicode code units).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]663 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]664 "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]665 # proposal.
666 "notes": [ # Output only. The notes associated with this proposal.
667 { # A proposal may be associated to several notes.
668 "note": "A String", # The actual note to attach.
669 # (max-length: 1024 unicode code units)
670 #
671 # Note: This field may be set only when creating the resource. Modifying
672 # this field while updating the resource will result in an error.
673 "creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note.
674 "proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created.
675 "createTime": "A String", # Output only. The timestamp for when this note was created.
676 "noteId": "A String", # Output only. The unique ID for the note.
677 },
678 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]679 "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.
680 "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.
681 # Authorized Buyers account ID.
682 "accountId": "A String", # Authorized Buyers account ID of the buyer.
683 },
684 "seller": { # Represents a seller of inventory. Each seller is identified by a unique # Reference to the seller on the proposal.
685 #
686 # Note: This field may be set only when creating the resource. Modifying
687 # this field while updating the resource will result in an error.
688 # Ad Manager account ID.
689 "subAccountId": "A String", # Optional sub-account ID for the seller.
690 "accountId": "A String", # The unique ID for the seller. The seller fills in this field.
691 # The seller account ID is then available to buyer in the product.
692 },
693 "sellerContacts": [ # Output only. Contact information for the seller.
694 { # Contains information on how a buyer or seller can be reached.
695 "email": "A String", # Email address for the contact.
696 "name": "A String", # The name of the contact.
697 },
698 ],
699 "proposalId": "A String", # Output only. The unique ID of the proposal.
700 "isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated.
701 "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique # Reference to the buyer on the proposal.
702 #
703 # Note: This field may be set only when creating the resource. Modifying
704 # this field while updating the resource will result in an error.
705 # Authorized Buyers account ID.
706 "accountId": "A String", # Authorized Buyers account ID of the buyer.
707 },
708 "isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this
709 # proposal.
710 "displayName": "A String", # The name for the proposal.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]711 "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or
712 # left a comment.
713 "buyerContacts": [ # Contact information for the buyer.
714 { # Contains information on how a buyer or seller can be reached.
715 "email": "A String", # Email address for the contact.
716 "name": "A String", # The name of the contact.
717 },
718 ],
719 },
720 ],
721 }</pre>
722</div>
723
724<div class="method">
725 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
726 <pre>Retrieves the next page of results.
727
728Args:
729 previous_request: The request for the previous page. (required)
730 previous_response: The response from the request for the previous page. (required)
731
732Returns:
733 A request object that you can call 'execute()' on to request the next
734 page. Returns None if there are no more items in the collection.
735 </pre>
736</div>
737
738</body></html>