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