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.products.html">products</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#get">get(accountId, productId, x__xgafv=None)</a></code></p>
79<p class="firstline">Gets the requested product by ID.</p>
80<p class="toc_element">
81  <code><a href="#list">list(accountId, pageSize=None, pageToken=None, x__xgafv=None, filter=None)</a></code></p>
82<p class="firstline">List all products visible to the buyer (optionally filtered by the</p>
83<p class="toc_element">
84  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
85<p class="firstline">Retrieves the next page of results.</p>
86<h3>Method Details</h3>
87<div class="method">
88    <code class="details" id="get">get(accountId, productId, x__xgafv=None)</code>
89  <pre>Gets the requested product by ID.
90
91Args:
92  accountId: string, Account ID of the buyer. (required)
93  productId: string, The ID for the product to get the head revision for. (required)
94  x__xgafv: string, V1 error format.
95    Allowed values
96      1 - v1 error format
97      2 - v2 error format
98
99Returns:
100  An object of the form:
101
102    { # Note: this resource requires whitelisting for access. Please contact your
103      # account manager for access to Marketplace resources.
104      #
105      # A product is a segment of inventory that a seller wishes to sell. It is
106      # associated with certain terms and targeting information which helps the buyer
107      # know more about the inventory.
108    "creatorContacts": [ # Optional contact information for the creator of this product.
109      { # Contains information on how a buyer or seller can be reached.
110        "email": "A String", # Email address for the contact.
111        "name": "A String", # The name of the contact.
112      },
113    ],
114    "updateTime": "A String", # Time of last update.
115    "terms": { # The deal terms specify the details of a Product/deal. They specify things # The negotiable terms of the deal.
116        # like price per buyer, the type of pricing model (e.g., fixed price, auction)
117        # and expected impressions from the publisher.
118      "description": "A String", # Publisher provided description for the terms.
119      "guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals.
120        "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage
121            # of guaranteed looks that the buyer is guaranteeing to buy.
122        "fixedPrices": [ # Fixed price for the specified buyer.
123          { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in
124              # a product can become 0 or 1 deals. To check if there is a PricePerBuyer for
125              # a particular buyer or buyer/advertiser pair, we look for the most specific
126              # matching rule - we first look for a rule matching the buyer and advertiser,
127              # next a rule with the buyer but an empty advertiser list, and otherwise look
128              # for a matching rule where no buyer is set.
129            "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
130                # (if the
131                # advertisers match, and there's no more specific rule matching the buyer).
132                # Authorized Buyers account ID.
133              "accountId": "A String", # Authorized Buyers account ID of the buyer.
134            },
135            "advertiserIds": [ # The list of advertisers for this price when associated with this buyer.
136                # If empty, all advertisers with this buyer pay this price.
137              "A String",
138            ],
139            "price": { # Represents a price and a pricing type for a product / deal. # The specified price.
140              "pricingType": "A String", # The pricing type for the deal/product. (default: CPM)
141              "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
142                "nanos": 42, # Number of nano (10^-9) units of the amount.
143                    # The value must be between -999,999,999 and +999,999,999 inclusive.
144                    # If `units` is positive, `nanos` must be positive or zero.
145                    # If `units` is zero, `nanos` can be positive, zero, or negative.
146                    # If `units` is negative, `nanos` must be negative or zero.
147                    # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
148                "units": "A String", # The whole units of the amount.
149                    # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
150                "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
151              },
152            },
153          },
154        ],
155        "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.
156        "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.
157      },
158      "sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the
159          # time zone used to mark the boundaries of a day. It should be an
160          # IANA TZ name, such as "America/Los_Angeles". For more information,
161          # see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.
162      "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day.
163          # Can be set by buyer or seller.
164      "nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via # The terms for non-guaranteed fixed price deals.
165          # the API at this time, but can be returned in a get or list request.
166        "fixedPrices": [ # Fixed price for the specified buyer.
167          { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in
168              # a product can become 0 or 1 deals. To check if there is a PricePerBuyer for
169              # a particular buyer or buyer/advertiser pair, we look for the most specific
170              # matching rule - we first look for a rule matching the buyer and advertiser,
171              # next a rule with the buyer but an empty advertiser list, and otherwise look
172              # for a matching rule where no buyer is set.
173            "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
174                # (if the
175                # advertisers match, and there's no more specific rule matching the buyer).
176                # Authorized Buyers account ID.
177              "accountId": "A String", # Authorized Buyers account ID of the buyer.
178            },
179            "advertiserIds": [ # The list of advertisers for this price when associated with this buyer.
180                # If empty, all advertisers with this buyer pay this price.
181              "A String",
182            ],
183            "price": { # Represents a price and a pricing type for a product / deal. # The specified price.
184              "pricingType": "A String", # The pricing type for the deal/product. (default: CPM)
185              "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
186                "nanos": 42, # Number of nano (10^-9) units of the amount.
187                    # The value must be between -999,999,999 and +999,999,999 inclusive.
188                    # If `units` is positive, `nanos` must be positive or zero.
189                    # If `units` is zero, `nanos` can be positive, zero, or negative.
190                    # If `units` is negative, `nanos` must be negative or zero.
191                    # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
192                "units": "A String", # The whole units of the amount.
193                    # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
194                "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
195              },
196            },
197          },
198        ],
199      },
200      "estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal.
201          # Can be set by buyer or seller.
202        "pricingType": "A String", # The pricing type for the deal/product. (default: CPM)
203        "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
204          "nanos": 42, # Number of nano (10^-9) units of the amount.
205              # The value must be between -999,999,999 and +999,999,999 inclusive.
206              # If `units` is positive, `nanos` must be positive or zero.
207              # If `units` is zero, `nanos` can be positive, zero, or negative.
208              # If `units` is negative, `nanos` must be negative or zero.
209              # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
210          "units": "A String", # The whole units of the amount.
211              # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
212          "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
213        },
214      },
215      "nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only # The terms for non-guaranteed auction deals.
216          # by the seller, but they can be returned in a get or list request.
217        "reservePricesPerBuyer": [ # Reserve price for the specified buyer.
218          { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in
219              # a product can become 0 or 1 deals. To check if there is a PricePerBuyer for
220              # a particular buyer or buyer/advertiser pair, we look for the most specific
221              # matching rule - we first look for a rule matching the buyer and advertiser,
222              # next a rule with the buyer but an empty advertiser list, and otherwise look
223              # for a matching rule where no buyer is set.
224            "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
225                # (if the
226                # advertisers match, and there's no more specific rule matching the buyer).
227                # Authorized Buyers account ID.
228              "accountId": "A String", # Authorized Buyers account ID of the buyer.
229            },
230            "advertiserIds": [ # The list of advertisers for this price when associated with this buyer.
231                # If empty, all advertisers with this buyer pay this price.
232              "A String",
233            ],
234            "price": { # Represents a price and a pricing type for a product / deal. # The specified price.
235              "pricingType": "A String", # The pricing type for the deal/product. (default: CPM)
236              "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
237                "nanos": 42, # Number of nano (10^-9) units of the amount.
238                    # The value must be between -999,999,999 and +999,999,999 inclusive.
239                    # If `units` is positive, `nanos` must be positive or zero.
240                    # If `units` is zero, `nanos` can be positive, zero, or negative.
241                    # If `units` is negative, `nanos` must be negative or zero.
242                    # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
243                "units": "A String", # The whole units of the amount.
244                    # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
245                "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
246              },
247            },
248          },
249        ],
250        "autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers
251            # in this private auction.
252      },
253      "brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED)
254    },
255    "syndicationProduct": "A String", # The syndication product associated with the deal.
256    "targetingCriterion": [ # Targeting that is shared between the buyer and the seller. Each targeting
257        # criterion has a specified key and for each key there is a list of inclusion
258        # value or exclusion values.
259      { # Advertisers can target different attributes of an ad slot. For example,
260          # they can choose to show ads only if the user is in the U.S. Such
261          # targeting criteria can be specified as part of Shared Targeting.
262        "inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd
263            # together.
264          { # A polymorphic targeting value used as part of Shared Targeting.
265            "stringValue": "A String", # The string value to include/exclude.
266            "longValue": "A String", # The long value to include/exclude.
267            "creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.
268                # Filled in when key = GOOG_CREATIVE_SIZE
269              "companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).
270                  # Companion sizes may be filled in only when creative_size_type = VIDEO
271                { # Message depicting the size of the creative. The units of width and
272                    # height depend on the type of the targeting.
273                  "width": 42, # The width of the creative
274                  "height": 42, # The height of the creative.
275                },
276              ],
277              "nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value
278                  # only if creative_size_type = CreativeSizeType.NATIVE.
279              "allowedFormats": [ # What formats are allowed by the publisher.
280                  # If this repeated field is empty then all formats are allowed.
281                  # For example, if this field contains AllowedFormatType.AUDIO then the
282                  # publisher only allows an audio ad (without any video).
283                "A String",
284              ],
285              "skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if
286                  # creative_size_type = CreativeSizeType.VIDEO.
287              "creativeSizeType": "A String", # The creative size type.
288              "size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size
289                  # of the creative
290                  # height depend on the type of the targeting.
291                "width": 42, # The width of the creative
292                "height": 42, # The height of the creative.
293              },
294            },
295            "dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.
296                # Filled in when the key is GOOG_DAYPART_TARGETING.
297                # The definition of this targeting is derived from the structure
298                # used by Ad Manager.
299              "dayParts": [ # A list of day part targeting criterion.
300                { # Daypart targeting message that specifies if the ad can be shown
301                    # only during certain parts of a day/week.
302                  "dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.
303                  "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
304                      # granularity). The end time is exclusive. This field is not available
305                      # for filtering in PQL queries.
306                      # or are specified elsewhere. An API may choose to allow leap seconds. Related
307                      # types are google.type.Date and `google.protobuf.Timestamp`.
308                    "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
309                        # allow the value 60 if it allows leap-seconds.
310                    "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
311                        # to allow the value "24:00:00" for scenarios like business closing time.
312                    "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
313                    "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
314                  },
315                  "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).
316                      # The start time is inclusive.
317                      # This field is not available for filtering in PQL queries.
318                      # or are specified elsewhere. An API may choose to allow leap seconds. Related
319                      # types are google.type.Date and `google.protobuf.Timestamp`.
320                    "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
321                        # allow the value 60 if it allows leap-seconds.
322                    "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
323                        # to allow the value "24:00:00" for scenarios like business closing time.
324                    "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
325                    "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
326                  },
327                },
328              ],
329              "timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.
330            },
331          },
332        ],
333        "exclusions": [ # The list of values to exclude from targeting. Each value is AND'd
334            # together.
335          { # A polymorphic targeting value used as part of Shared Targeting.
336            "stringValue": "A String", # The string value to include/exclude.
337            "longValue": "A String", # The long value to include/exclude.
338            "creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.
339                # Filled in when key = GOOG_CREATIVE_SIZE
340              "companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).
341                  # Companion sizes may be filled in only when creative_size_type = VIDEO
342                { # Message depicting the size of the creative. The units of width and
343                    # height depend on the type of the targeting.
344                  "width": 42, # The width of the creative
345                  "height": 42, # The height of the creative.
346                },
347              ],
348              "nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value
349                  # only if creative_size_type = CreativeSizeType.NATIVE.
350              "allowedFormats": [ # What formats are allowed by the publisher.
351                  # If this repeated field is empty then all formats are allowed.
352                  # For example, if this field contains AllowedFormatType.AUDIO then the
353                  # publisher only allows an audio ad (without any video).
354                "A String",
355              ],
356              "skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if
357                  # creative_size_type = CreativeSizeType.VIDEO.
358              "creativeSizeType": "A String", # The creative size type.
359              "size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size
360                  # of the creative
361                  # height depend on the type of the targeting.
362                "width": 42, # The width of the creative
363                "height": 42, # The height of the creative.
364              },
365            },
366            "dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.
367                # Filled in when the key is GOOG_DAYPART_TARGETING.
368                # The definition of this targeting is derived from the structure
369                # used by Ad Manager.
370              "dayParts": [ # A list of day part targeting criterion.
371                { # Daypart targeting message that specifies if the ad can be shown
372                    # only during certain parts of a day/week.
373                  "dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.
374                  "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
375                      # granularity). The end time is exclusive. This field is not available
376                      # for filtering in PQL queries.
377                      # or are specified elsewhere. An API may choose to allow leap seconds. Related
378                      # types are google.type.Date and `google.protobuf.Timestamp`.
379                    "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
380                        # allow the value 60 if it allows leap-seconds.
381                    "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
382                        # to allow the value "24:00:00" for scenarios like business closing time.
383                    "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
384                    "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
385                  },
386                  "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).
387                      # The start time is inclusive.
388                      # This field is not available 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                    "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
392                        # allow the value 60 if it allows leap-seconds.
393                    "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
394                        # to allow the value "24:00:00" for scenarios like business closing time.
395                    "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
396                    "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
397                  },
398                },
399              ],
400              "timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.
401            },
402          },
403        ],
404        "key": "A String", # The key representing the shared targeting criterion.
405            # Targeting criteria defined by Google ad servers will begin with GOOG_.
406            # Third parties may define their own keys.
407            # A list of permissible keys along with the acceptable values will be
408            # provided as part of the external documentation.
409      },
410    ],
411    "seller": { # Represents a seller of inventory. Each seller is identified by a unique # Information about the seller that created this product.
412        # Ad Manager account ID.
413      "subAccountId": "A String", # Optional sub-account ID for the seller.
414      "accountId": "A String", # The unique ID for the seller. The seller fills in this field.
415          # The seller account ID is then available to buyer in the product.
416    },
417    "webPropertyCode": "A String", # The web-property code for the seller. This needs to be copied as is when
418        # adding a new deal to a proposal.
419    "availableStartTime": "A String", # Inventory availability dates. The start time will be truncated to seconds
420        # during serving. Thus, a field specified as 3:23:34.456 (HH:mm:ss.SSS) will
421        # be truncated to 3:23:34 when serving.
422    "hasCreatorSignedOff": True or False, # If the creator has already signed off on the product, then the buyer can
423        # finalize the deal by accepting the product as is. When copying to a
424        # proposal, if any of the terms are changed, then auto_finalize is
425        # automatically set to false.
426    "productRevision": "A String", # The revision number of the product (auto-assigned by Marketplace).
427    "displayName": "A String", # The display name for this product as set by the seller.
428    "publisherProfileId": "A String", # An ID which can be used by the Publisher Profile API to get more
429        # information about the seller that created this product.
430    "availableEndTime": "A String", # The proposed end time for the deal. The field will be truncated to the
431        # order of seconds during serving.
432    "createTime": "A String", # Creation time.
433    "productId": "A String", # The unique ID for the product.
434  }</pre>
435</div>
436
437<div class="method">
438    <code class="details" id="list">list(accountId, pageSize=None, pageToken=None, x__xgafv=None, filter=None)</code>
439  <pre>List all products visible to the buyer (optionally filtered by the
440specified PQL query).
441
442Args:
443  accountId: string, Account ID of the buyer. (required)
444  pageSize: integer, Requested page size. The server may return fewer results than requested.
445If unspecified, the server will pick an appropriate default.
446  pageToken: string, The page token as returned from ListProductsResponse.
447  x__xgafv: string, V1 error format.
448    Allowed values
449      1 - v1 error format
450      2 - v2 error format
451  filter: string, An optional PQL query used to query for products. See
452https://developers.google.com/ad-manager/docs/pqlreference
453for documentation about PQL and examples.
454
455Nested repeated fields, such as product.targetingCriterion.inclusions,
456cannot be filtered.
457
458Returns:
459  An object of the form:
460
461    { # Response message for listing products visible to the buyer.
462    "nextPageToken": "A String", # List pagination support.
463    "products": [ # The list of matching products at their head revision number.
464      { # Note: this resource requires whitelisting for access. Please contact your
465          # account manager for access to Marketplace resources.
466          #
467          # A product is a segment of inventory that a seller wishes to sell. It is
468          # associated with certain terms and targeting information which helps the buyer
469          # know more about the inventory.
470        "creatorContacts": [ # Optional contact information for the creator of this product.
471          { # Contains information on how a buyer or seller can be reached.
472            "email": "A String", # Email address for the contact.
473            "name": "A String", # The name of the contact.
474          },
475        ],
476        "updateTime": "A String", # Time of last update.
477        "terms": { # The deal terms specify the details of a Product/deal. They specify things # The negotiable terms of the deal.
478            # like price per buyer, the type of pricing model (e.g., fixed price, auction)
479            # and expected impressions from the publisher.
480          "description": "A String", # Publisher provided description for the terms.
481          "guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals.
482            "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage
483                # of guaranteed looks that the buyer is guaranteeing to buy.
484            "fixedPrices": [ # Fixed price for the specified buyer.
485              { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in
486                  # a product can become 0 or 1 deals. To check if there is a PricePerBuyer for
487                  # a particular buyer or buyer/advertiser pair, we look for the most specific
488                  # matching rule - we first look for a rule matching the buyer and advertiser,
489                  # next a rule with the buyer but an empty advertiser list, and otherwise look
490                  # for a matching rule where no buyer is set.
491                "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
492                    # (if the
493                    # advertisers match, and there's no more specific rule matching the buyer).
494                    # Authorized Buyers account ID.
495                  "accountId": "A String", # Authorized Buyers account ID of the buyer.
496                },
497                "advertiserIds": [ # The list of advertisers for this price when associated with this buyer.
498                    # If empty, all advertisers with this buyer pay this price.
499                  "A String",
500                ],
501                "price": { # Represents a price and a pricing type for a product / deal. # The specified price.
502                  "pricingType": "A String", # The pricing type for the deal/product. (default: CPM)
503                  "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
504                    "nanos": 42, # Number of nano (10^-9) units of the amount.
505                        # The value must be between -999,999,999 and +999,999,999 inclusive.
506                        # If `units` is positive, `nanos` must be positive or zero.
507                        # If `units` is zero, `nanos` can be positive, zero, or negative.
508                        # If `units` is negative, `nanos` must be negative or zero.
509                        # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
510                    "units": "A String", # The whole units of the amount.
511                        # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
512                    "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
513                  },
514                },
515              },
516            ],
517            "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.
518            "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.
519          },
520          "sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the
521              # time zone used to mark the boundaries of a day. It should be an
522              # IANA TZ name, such as "America/Los_Angeles". For more information,
523              # see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.
524          "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day.
525              # Can be set by buyer or seller.
526          "nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via # The terms for non-guaranteed fixed price deals.
527              # the API at this time, but can be returned in a get or list request.
528            "fixedPrices": [ # Fixed price for the specified buyer.
529              { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in
530                  # a product can become 0 or 1 deals. To check if there is a PricePerBuyer for
531                  # a particular buyer or buyer/advertiser pair, we look for the most specific
532                  # matching rule - we first look for a rule matching the buyer and advertiser,
533                  # next a rule with the buyer but an empty advertiser list, and otherwise look
534                  # for a matching rule where no buyer is set.
535                "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
536                    # (if the
537                    # advertisers match, and there's no more specific rule matching the buyer).
538                    # Authorized Buyers account ID.
539                  "accountId": "A String", # Authorized Buyers account ID of the buyer.
540                },
541                "advertiserIds": [ # The list of advertisers for this price when associated with this buyer.
542                    # If empty, all advertisers with this buyer pay this price.
543                  "A String",
544                ],
545                "price": { # Represents a price and a pricing type for a product / deal. # The specified price.
546                  "pricingType": "A String", # The pricing type for the deal/product. (default: CPM)
547                  "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
548                    "nanos": 42, # Number of nano (10^-9) units of the amount.
549                        # The value must be between -999,999,999 and +999,999,999 inclusive.
550                        # If `units` is positive, `nanos` must be positive or zero.
551                        # If `units` is zero, `nanos` can be positive, zero, or negative.
552                        # If `units` is negative, `nanos` must be negative or zero.
553                        # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
554                    "units": "A String", # The whole units of the amount.
555                        # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
556                    "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
557                  },
558                },
559              },
560            ],
561          },
562          "estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal.
563              # Can be set by buyer or seller.
564            "pricingType": "A String", # The pricing type for the deal/product. (default: CPM)
565            "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
566              "nanos": 42, # Number of nano (10^-9) units of the amount.
567                  # The value must be between -999,999,999 and +999,999,999 inclusive.
568                  # If `units` is positive, `nanos` must be positive or zero.
569                  # If `units` is zero, `nanos` can be positive, zero, or negative.
570                  # If `units` is negative, `nanos` must be negative or zero.
571                  # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
572              "units": "A String", # The whole units of the amount.
573                  # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
574              "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
575            },
576          },
577          "nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only # The terms for non-guaranteed auction deals.
578              # by the seller, but they can be returned in a get or list request.
579            "reservePricesPerBuyer": [ # Reserve price for the specified buyer.
580              { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in
581                  # a product can become 0 or 1 deals. To check if there is a PricePerBuyer for
582                  # a particular buyer or buyer/advertiser pair, we look for the most specific
583                  # matching rule - we first look for a rule matching the buyer and advertiser,
584                  # next a rule with the buyer but an empty advertiser list, and otherwise look
585                  # for a matching rule where no buyer is set.
586                "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
587                    # (if the
588                    # advertisers match, and there's no more specific rule matching the buyer).
589                    # Authorized Buyers account ID.
590                  "accountId": "A String", # Authorized Buyers account ID of the buyer.
591                },
592                "advertiserIds": [ # The list of advertisers for this price when associated with this buyer.
593                    # If empty, all advertisers with this buyer pay this price.
594                  "A String",
595                ],
596                "price": { # Represents a price and a pricing type for a product / deal. # The specified price.
597                  "pricingType": "A String", # The pricing type for the deal/product. (default: CPM)
598                  "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
599                    "nanos": 42, # Number of nano (10^-9) units of the amount.
600                        # The value must be between -999,999,999 and +999,999,999 inclusive.
601                        # If `units` is positive, `nanos` must be positive or zero.
602                        # If `units` is zero, `nanos` can be positive, zero, or negative.
603                        # If `units` is negative, `nanos` must be negative or zero.
604                        # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
605                    "units": "A String", # The whole units of the amount.
606                        # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
607                    "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
608                  },
609                },
610              },
611            ],
612            "autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers
613                # in this private auction.
614          },
615          "brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED)
616        },
617        "syndicationProduct": "A String", # The syndication product associated with the deal.
618        "targetingCriterion": [ # Targeting that is shared between the buyer and the seller. Each targeting
619            # criterion has a specified key and for each key there is a list of inclusion
620            # value or exclusion values.
621          { # Advertisers can target different attributes of an ad slot. For example,
622              # they can choose to show ads only if the user is in the U.S. Such
623              # targeting criteria can be specified as part of Shared Targeting.
624            "inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd
625                # together.
626              { # A polymorphic targeting value used as part of Shared Targeting.
627                "stringValue": "A String", # The string value to include/exclude.
628                "longValue": "A String", # The long value to include/exclude.
629                "creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.
630                    # Filled in when key = GOOG_CREATIVE_SIZE
631                  "companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).
632                      # Companion sizes may be filled in only when creative_size_type = VIDEO
633                    { # Message depicting the size of the creative. The units of width and
634                        # height depend on the type of the targeting.
635                      "width": 42, # The width of the creative
636                      "height": 42, # The height of the creative.
637                    },
638                  ],
639                  "nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value
640                      # only if creative_size_type = CreativeSizeType.NATIVE.
641                  "allowedFormats": [ # What formats are allowed by the publisher.
642                      # If this repeated field is empty then all formats are allowed.
643                      # For example, if this field contains AllowedFormatType.AUDIO then the
644                      # publisher only allows an audio ad (without any video).
645                    "A String",
646                  ],
647                  "skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if
648                      # creative_size_type = CreativeSizeType.VIDEO.
649                  "creativeSizeType": "A String", # The creative size type.
650                  "size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size
651                      # of the creative
652                      # height depend on the type of the targeting.
653                    "width": 42, # The width of the creative
654                    "height": 42, # The height of the creative.
655                  },
656                },
657                "dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.
658                    # Filled in when the key is GOOG_DAYPART_TARGETING.
659                    # The definition of this targeting is derived from the structure
660                    # used by Ad Manager.
661                  "dayParts": [ # A list of day part targeting criterion.
662                    { # Daypart targeting message that specifies if the ad can be shown
663                        # only during certain parts of a day/week.
664                      "dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.
665                      "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
666                          # granularity). The end time is exclusive. This field is not available
667                          # for filtering in PQL queries.
668                          # or are specified elsewhere. An API may choose to allow leap seconds. Related
669                          # types are google.type.Date and `google.protobuf.Timestamp`.
670                        "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
671                            # allow the value 60 if it allows leap-seconds.
672                        "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
673                            # to allow the value "24:00:00" for scenarios like business closing time.
674                        "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
675                        "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
676                      },
677                      "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).
678                          # The start time is inclusive.
679                          # This field is not available for filtering in PQL queries.
680                          # or are specified elsewhere. An API may choose to allow leap seconds. Related
681                          # types are google.type.Date and `google.protobuf.Timestamp`.
682                        "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
683                            # allow the value 60 if it allows leap-seconds.
684                        "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
685                            # to allow the value "24:00:00" for scenarios like business closing time.
686                        "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
687                        "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
688                      },
689                    },
690                  ],
691                  "timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.
692                },
693              },
694            ],
695            "exclusions": [ # The list of values to exclude from targeting. Each value is AND'd
696                # together.
697              { # A polymorphic targeting value used as part of Shared Targeting.
698                "stringValue": "A String", # The string value to include/exclude.
699                "longValue": "A String", # The long value to include/exclude.
700                "creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude.
701                    # Filled in when key = GOOG_CREATIVE_SIZE
702                  "companionSizes": [ # For video creatives specifies the sizes of companion ads (if present).
703                      # Companion sizes may be filled in only when creative_size_type = VIDEO
704                    { # Message depicting the size of the creative. The units of width and
705                        # height depend on the type of the targeting.
706                      "width": 42, # The width of the creative
707                      "height": 42, # The height of the creative.
708                    },
709                  ],
710                  "nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value
711                      # only if creative_size_type = CreativeSizeType.NATIVE.
712                  "allowedFormats": [ # What formats are allowed by the publisher.
713                      # If this repeated field is empty then all formats are allowed.
714                      # For example, if this field contains AllowedFormatType.AUDIO then the
715                      # publisher only allows an audio ad (without any video).
716                    "A String",
717                  ],
718                  "skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if
719                      # creative_size_type = CreativeSizeType.VIDEO.
720                  "creativeSizeType": "A String", # The creative size type.
721                  "size": { # Message depicting the size of the creative. The units of width and # For regular or video creative size type, specifies the size
722                      # of the creative
723                      # height depend on the type of the targeting.
724                    "width": 42, # The width of the creative
725                    "height": 42, # The height of the creative.
726                  },
727                },
728                "dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude.
729                    # Filled in when the key is GOOG_DAYPART_TARGETING.
730                    # The definition of this targeting is derived from the structure
731                    # used by Ad Manager.
732                  "dayParts": [ # A list of day part targeting criterion.
733                    { # Daypart targeting message that specifies if the ad can be shown
734                        # only during certain parts of a day/week.
735                      "dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days.
736                      "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
737                          # granularity). The end time is exclusive. This field is not available
738                          # for filtering in PQL queries.
739                          # or are specified elsewhere. An API may choose to allow leap seconds. Related
740                          # types are google.type.Date and `google.protobuf.Timestamp`.
741                        "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
742                            # allow the value 60 if it allows leap-seconds.
743                        "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
744                            # to allow the value "24:00:00" for scenarios like business closing time.
745                        "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
746                        "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
747                      },
748                      "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).
749                          # The start time is inclusive.
750                          # This field is not available for filtering in PQL queries.
751                          # or are specified elsewhere. An API may choose to allow leap seconds. Related
752                          # types are google.type.Date and `google.protobuf.Timestamp`.
753                        "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
754                            # allow the value 60 if it allows leap-seconds.
755                        "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
756                            # to allow the value "24:00:00" for scenarios like business closing time.
757                        "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
758                        "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
759                      },
760                    },
761                  ],
762                  "timeZoneType": "A String", # The timezone to use for interpreting the day part targeting.
763                },
764              },
765            ],
766            "key": "A String", # The key representing the shared targeting criterion.
767                # Targeting criteria defined by Google ad servers will begin with GOOG_.
768                # Third parties may define their own keys.
769                # A list of permissible keys along with the acceptable values will be
770                # provided as part of the external documentation.
771          },
772        ],
773        "seller": { # Represents a seller of inventory. Each seller is identified by a unique # Information about the seller that created this product.
774            # Ad Manager account ID.
775          "subAccountId": "A String", # Optional sub-account ID for the seller.
776          "accountId": "A String", # The unique ID for the seller. The seller fills in this field.
777              # The seller account ID is then available to buyer in the product.
778        },
779        "webPropertyCode": "A String", # The web-property code for the seller. This needs to be copied as is when
780            # adding a new deal to a proposal.
781        "availableStartTime": "A String", # Inventory availability dates. The start time will be truncated to seconds
782            # during serving. Thus, a field specified as 3:23:34.456 (HH:mm:ss.SSS) will
783            # be truncated to 3:23:34 when serving.
784        "hasCreatorSignedOff": True or False, # If the creator has already signed off on the product, then the buyer can
785            # finalize the deal by accepting the product as is. When copying to a
786            # proposal, if any of the terms are changed, then auto_finalize is
787            # automatically set to false.
788        "productRevision": "A String", # The revision number of the product (auto-assigned by Marketplace).
789        "displayName": "A String", # The display name for this product as set by the seller.
790        "publisherProfileId": "A String", # An ID which can be used by the Publisher Profile API to get more
791            # information about the seller that created this product.
792        "availableEndTime": "A String", # The proposed end time for the deal. The field will be truncated to the
793            # order of seconds during serving.
794        "createTime": "A String", # Creation time.
795        "productId": "A String", # The unique ID for the product.
796      },
797    ],
798  }</pre>
799</div>
800
801<div class="method">
802    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
803  <pre>Retrieves the next page of results.
804
805Args:
806  previous_request: The request for the previous page. (required)
807  previous_response: The response from the request for the previous page. (required)
808
809Returns:
810  A request object that you can call 'execute()' on to request the next
811  page. Returns None if there are no more items in the collection.
812    </pre>
813</div>
814
815</body></html>