| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="adexchangebuyer2_v2beta1.html">Ad Exchange Buyer API II</a> . <a href="adexchangebuyer2_v2beta1.accounts.html">accounts</a> . <a href="adexchangebuyer2_v2beta1.accounts.proposals.html">proposals</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 78 | <code><a href="#accept">accept(accountId, proposalId, body=None, x__xgafv=None)</a></code></p> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 79 | <p class="firstline">Mark the proposal as accepted at the given revision number. If the number does not match the server's revision number an `ABORTED` error message will be returned. This call updates the proposal_state from `PROPOSED` to `BUYER_ACCEPTED`, or from `SELLER_ACCEPTED` to `FINALIZED`.</p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 80 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 81 | <code><a href="#addNote">addNote(accountId, proposalId, body=None, x__xgafv=None)</a></code></p> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 82 | <p class="firstline">Create a new note and attach it to the proposal. The note is assigned a unique ID by the server. The proposal revision number will not increase when associated with a new note.</p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 83 | <p class="toc_element"> |
| 84 | <code><a href="#cancelNegotiation">cancelNegotiation(accountId, proposalId, body=None, x__xgafv=None)</a></code></p> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 85 | <p class="firstline">Cancel an ongoing negotiation on a proposal. This does not cancel or end serving for the deals if the proposal has been finalized, but only cancels a negotiation unilaterally.</p> |
| 86 | <p class="toc_element"> |
| 87 | <code><a href="#close">close()</a></code></p> |
| 88 | <p class="firstline">Close httplib2 connections.</p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 89 | <p class="toc_element"> |
| 90 | <code><a href="#completeSetup">completeSetup(accountId, proposalId, body=None, x__xgafv=None)</a></code></p> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 91 | <p class="firstline">Update the given proposal to indicate that setup has been completed. This method is called by the buyer when the line items have been created on their end for a finalized proposal and all the required creatives have been uploaded using the creatives API. This call updates the `is_setup_completed` bit on the proposal and also notifies the seller. The server will advance the revision number of the most recent proposal.</p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 92 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 93 | <code><a href="#create">create(accountId, body=None, x__xgafv=None)</a></code></p> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 94 | <p class="firstline">Create the given proposal. Each created proposal and any deals it contains are assigned a unique ID by the server.</p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 95 | <p class="toc_element"> |
| 96 | <code><a href="#get">get(accountId, proposalId, x__xgafv=None)</a></code></p> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 97 | <p class="firstline">Gets a proposal given its ID. The proposal is returned at its head revision.</p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 98 | <p class="toc_element"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 99 | <code><a href="#list">list(accountId, pageToken=None, pageSize=None, filter=None, filterSyntax=None, x__xgafv=None)</a></code></p> |
| 100 | <p class="firstline">List proposals. A filter expression (PQL query) may be specified to filter the results. To retrieve all finalized proposals, regardless if a proposal is being renegotiated, see the FinalizedProposals resource. Note that Bidder/ChildSeat relationships differ from the usual behavior. A Bidder account can only see its child seats' proposals by specifying the ChildSeat's accountId in the request path.</p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 101 | <p class="toc_element"> |
| 102 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 103 | <p class="firstline">Retrieves the next page of results.</p> |
| 104 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 105 | <code><a href="#pause">pause(accountId, proposalId, body=None, x__xgafv=None)</a></code></p> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 106 | <p class="firstline">Update the given proposal to pause serving. This method will set the `DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to true for all deals in the proposal. It is a no-op to pause an already-paused proposal. It is an error to call PauseProposal for a proposal that is not finalized or renegotiating.</p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 107 | <p class="toc_element"> |
| 108 | <code><a href="#resume">resume(accountId, proposalId, body=None, x__xgafv=None)</a></code></p> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 109 | <p class="firstline">Update the given proposal to resume serving. This method will set the `DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to false for all deals in the proposal. Note that if the `has_seller_paused` bit is also set, serving will not resume until the seller also resumes. It is a no-op to resume an already-running proposal. It is an error to call ResumeProposal for a proposal that is not finalized or renegotiating.</p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 110 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 111 | <code><a href="#update">update(accountId, proposalId, body=None, x__xgafv=None)</a></code></p> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 112 | <p class="firstline">Update the given proposal at the client known revision number. If the server revision has advanced since the passed-in `proposal.proposal_revision`, an `ABORTED` error message will be returned. Only the buyer-modifiable fields of the proposal will be updated. Note that the deals in the proposal will be updated to match the passed-in copy. If a passed-in deal does not have a `deal_id`, the server will assign a new unique ID and create the deal. If passed-in deal has a `deal_id`, it will be updated to match the passed-in copy. Any existing deals not present in the passed-in proposal will be deleted. It is an error to pass in a deal with a `deal_id` not present at head.</p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 113 | <h3>Method Details</h3> |
| 114 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 115 | <code class="details" id="accept">accept(accountId, proposalId, body=None, x__xgafv=None)</code> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 116 | <pre>Mark the proposal as accepted at the given revision number. If the number does not match the server's revision number an `ABORTED` error message will be returned. This call updates the proposal_state from `PROPOSED` to `BUYER_ACCEPTED`, or from `SELLER_ACCEPTED` to `FINALIZED`. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 117 | |
| 118 | Args: |
| 119 | accountId: string, Account ID of the buyer. (required) |
| 120 | proposalId: string, The ID of the proposal to accept. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 121 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 122 | The object takes the form of: |
| 123 | |
| 124 | { # Request to accept a proposal. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 125 | "proposalRevision": "A String", # The last known client revision number of the proposal. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 126 | } |
| 127 | |
| 128 | x__xgafv: string, V1 error format. |
| 129 | Allowed values |
| 130 | 1 - v1 error format |
| 131 | 2 - v2 error format |
| 132 | |
| 133 | Returns: |
| 134 | An object of the form: |
| 135 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 136 | { # Note: this resource requires whitelisting for access. Please contact your account manager for access to Marketplace resources. Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer and contains deals which are served. Note: you can not update, create, or otherwise modify Private Auction or Preferred Deals deals through the API. Fields are updatable unless noted otherwise. |
| 137 | "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. # Reference to the buyer on the proposal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| 138 | "accountId": "A String", # Authorized Buyers account ID of the buyer. |
| 139 | }, |
| 140 | "isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated. |
| 141 | "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller). |
| 142 | "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). |
| 143 | }, |
| 144 | "privateAuctionId": "A String", # Output only. Private auction ID if this proposal is a private auction proposal. |
| 145 | "displayName": "A String", # The name for the proposal. |
| 146 | "deals": [ # The deals associated with this proposal. For Private Auction proposals (whose deals have NonGuaranteedAuctionTerms), there will only be one deal. |
| 147 | { # A deal represents a segment of inventory for displaying ads on. A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving. |
| 148 | "dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned). |
| 149 | "syndicationProduct": "A String", # The syndication product associated with the deal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| 150 | "createTime": "A String", # Output only. The time of the deal creation. |
| 151 | "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by buyer. |
| 152 | "availableEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not required for Private Auction deals or Preferred Deals. |
| 153 | "deliveryControl": { # Message contains details about how the deals will be paced. # The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. |
| 154 | "frequencyCaps": [ # Output only. Specifies any frequency caps. |
| 155 | { # Frequency cap. |
| 156 | "numTimeUnits": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped. |
| 157 | "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period. |
| 158 | "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped. |
| 159 | }, |
| 160 | ], |
| 161 | "creativeBlockingLevel": "A String", # Output only. Specified the creative blocking levels to be applied. |
| 162 | "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced. |
| 163 | }, |
| 164 | "createProductId": "A String", # The product ID from which this deal was created. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| 165 | "webPropertyCode": "A String", # The web property code for the seller copied over from the product. |
| 166 | "proposalId": "A String", # Output only. ID of the proposal that this deal is part of. |
| 167 | "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller). |
| 168 | "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). |
| 169 | }, |
| 170 | "createProductRevision": "A String", # Optional revision number of the product that the deal was created from. If present on create, and the server `product_revision` has advanced sinced the passed-in `create_product_revision`, an `ABORTED` error will be returned. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 171 | "displayName": "A String", # The name of the deal. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 172 | "targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared targeting entity is AND'd together. |
| 173 | { # Advertisers can target different attributes of an ad slot. For example, they can choose to show ads only if the user is in the U.S. Such targeting criteria can be specified as part of Shared Targeting. |
| 174 | "key": "A String", # The key representing the shared targeting criterion. Targeting criteria defined by Google ad servers will begin with GOOG_. Third parties may define their own keys. A list of permissible keys along with the acceptable values will be provided as part of the external documentation. |
| 175 | "inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd together. |
| 176 | { # A polymorphic targeting value used as part of Shared Targeting. |
| 177 | "dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING. The definition of this targeting is derived from the structure used by Ad Manager. |
| 178 | "dayParts": [ # A list of day part targeting criterion. |
| 179 | { # Daypart targeting message that specifies if the ad can be shown only during certain parts of a day/week. |
| 180 | "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # The ending time of the day for the ad to show (minute level granularity). The end time is exclusive. This field is not available for filtering in PQL queries. |
| 181 | "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| 182 | "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| 183 | "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| 184 | "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. |
| 185 | }, |
| 186 | "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # The starting time of day for the ad to show (minute level granularity). The start time is inclusive. This field is not available for filtering in PQL queries. |
| 187 | "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| 188 | "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| 189 | "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| 190 | "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. |
| 191 | }, |
| 192 | "dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days. |
| 193 | }, |
| 194 | ], |
| 195 | "timeZoneType": "A String", # The timezone to use for interpreting the day part targeting. |
| 196 | }, |
| 197 | "longValue": "A String", # The long value to include/exclude. |
| 198 | "stringValue": "A String", # The string value to include/exclude. |
| 199 | "creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude. Filled in when key = GOOG_CREATIVE_SIZE |
| 200 | "companionSizes": [ # For video creatives specifies the sizes of companion ads (if present). Companion sizes may be filled in only when creative_size_type = VIDEO |
| 201 | { # Message depicting the size of the creative. The units of width and height depend on the type of the targeting. |
| 202 | "height": 42, # The height of the creative. |
| 203 | "width": 42, # The width of the creative |
| 204 | }, |
| 205 | ], |
| 206 | "size": { # Message depicting the size of the creative. The units of width and height depend on the type of the targeting. # For regular or video creative size type, specifies the size of the creative |
| 207 | "height": 42, # The height of the creative. |
| 208 | "width": 42, # The width of the creative |
| 209 | }, |
| 210 | "nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value only if creative_size_type = CreativeSizeType.NATIVE. |
| 211 | "allowedFormats": [ # What formats are allowed by the publisher. If this repeated field is empty then all formats are allowed. For example, if this field contains AllowedFormatType.AUDIO then the publisher only allows an audio ad (without any video). |
| 212 | "A String", |
| 213 | ], |
| 214 | "creativeSizeType": "A String", # The creative size type. |
| 215 | "skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if creative_size_type = CreativeSizeType.VIDEO. |
| 216 | }, |
| 217 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 218 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 219 | "exclusions": [ # The list of values to exclude from targeting. Each value is AND'd together. |
| 220 | { # A polymorphic targeting value used as part of Shared Targeting. |
| 221 | "dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING. The definition of this targeting is derived from the structure used by Ad Manager. |
| 222 | "dayParts": [ # A list of day part targeting criterion. |
| 223 | { # Daypart targeting message that specifies if the ad can be shown only during certain parts of a day/week. |
| 224 | "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # The ending time of the day for the ad to show (minute level granularity). The end time is exclusive. This field is not available for filtering in PQL queries. |
| 225 | "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| 226 | "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| 227 | "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| 228 | "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. |
| 229 | }, |
| 230 | "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # The starting time of day for the ad to show (minute level granularity). The start time is inclusive. This field is not available for filtering in PQL queries. |
| 231 | "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| 232 | "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| 233 | "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| 234 | "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. |
| 235 | }, |
| 236 | "dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days. |
| 237 | }, |
| 238 | ], |
| 239 | "timeZoneType": "A String", # The timezone to use for interpreting the day part targeting. |
| 240 | }, |
| 241 | "longValue": "A String", # The long value to include/exclude. |
| 242 | "stringValue": "A String", # The string value to include/exclude. |
| 243 | "creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude. Filled in when key = GOOG_CREATIVE_SIZE |
| 244 | "companionSizes": [ # For video creatives specifies the sizes of companion ads (if present). Companion sizes may be filled in only when creative_size_type = VIDEO |
| 245 | { # Message depicting the size of the creative. The units of width and height depend on the type of the targeting. |
| 246 | "height": 42, # The height of the creative. |
| 247 | "width": 42, # The width of the creative |
| 248 | }, |
| 249 | ], |
| 250 | "size": { # Message depicting the size of the creative. The units of width and height depend on the type of the targeting. # For regular or video creative size type, specifies the size of the creative |
| 251 | "height": 42, # The height of the creative. |
| 252 | "width": 42, # The width of the creative |
| 253 | }, |
| 254 | "nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value only if creative_size_type = CreativeSizeType.NATIVE. |
| 255 | "allowedFormats": [ # What formats are allowed by the publisher. If this repeated field is empty then all formats are allowed. For example, if this field contains AllowedFormatType.AUDIO then the publisher only allows an audio ad (without any video). |
| 256 | "A String", |
| 257 | ], |
| 258 | "creativeSizeType": "A String", # The creative size type. |
| 259 | "skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if creative_size_type = CreativeSizeType.VIDEO. |
| 260 | }, |
| 261 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 262 | ], |
| 263 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 264 | ], |
| 265 | "targeting": { # Targeting represents different criteria that can be used by advertisers to target ad inventory. For example, they can choose to target ad requests only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. # Output only. Specifies the subset of inventory targeted by the deal. |
| 266 | "placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Placement targeting information, e.g., URL, mobile applications. |
| 267 | "urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). For Private Auction and AdX Preferred Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 268 | "excludedUrls": [ # A list of URLs to be excluded. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 269 | "A String", |
| 270 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 271 | "targetedUrls": [ # A list of URLs to be included. |
| 272 | "A String", |
| 273 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 274 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 275 | "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages. |
| 276 | "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Mobile application IDs are from App Store and Google Play Store. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 277 | "targetedAppIds": [ # A list of application IDs to be included. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 278 | "A String", |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 279 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 280 | "excludedAppIds": [ # A list of application IDs to be excluded. |
| 281 | "A String", |
| 282 | ], |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 283 | }, |
| 284 | }, |
| 285 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 286 | "technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 287 | "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # IDs of device capabilities to be included/excluded. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 288 | "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. |
| 289 | "A String", |
| 290 | ], |
| 291 | "targetedCriteriaIds": [ # A list of numeric IDs to be included. |
| 292 | "A String", |
| 293 | ], |
| 294 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 295 | "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # IDs of device categories to be included/excluded. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 296 | "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. |
| 297 | "A String", |
| 298 | ], |
| 299 | "targetedCriteriaIds": [ # A list of numeric IDs to be included. |
| 300 | "A String", |
| 301 | ], |
| 302 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 303 | "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 304 | "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # IDs of operating systems to be included/excluded. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 305 | "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. |
| 306 | "A String", |
| 307 | ], |
| 308 | "targetedCriteriaIds": [ # A list of numeric IDs to be included. |
| 309 | "A String", |
| 310 | ], |
| 311 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 312 | "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # IDs of operating system versions to be included/excluded. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 313 | "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. |
| 314 | "A String", |
| 315 | ], |
| 316 | "targetedCriteriaIds": [ # A list of numeric IDs to be included. |
| 317 | "A String", |
| 318 | ], |
| 319 | }, |
| 320 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 321 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 322 | "videoTargeting": { # Represents targeting information about video. # Video targeting information. |
| 323 | "excludedPositionTypes": [ # A list of video positions to be excluded. Position types can either be included or excluded (XOR). |
| 324 | "A String", |
| 325 | ], |
| 326 | "targetedPositionTypes": [ # A list of video positions to be included. When the included list is present, the excluded list must be empty. When the excluded list is present, the included list must be empty. |
| 327 | "A String", |
| 328 | ], |
| 329 | }, |
| 330 | "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on an ad request. It only applies to Private Auction, AdX Preferred Deals and Auction Packages. This targeting does not apply to Programmatic Guaranteed and Preferred Deals in Ad Manager. # Inventory sizes to be included/excluded. |
| 331 | "targetedInventorySizes": [ # A list of inventory sizes to be included. |
| 332 | { # Represents size of a single ad slot, or a creative. |
| 333 | "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 334 | "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 335 | "sizeType": "A String", # The size type of the ad slot. |
| 336 | }, |
| 337 | ], |
| 338 | "excludedInventorySizes": [ # A list of inventory sizes to be excluded. |
| 339 | { # Represents size of a single ad slot, or a creative. |
| 340 | "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 341 | "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 342 | "sizeType": "A String", # The size type of the ad slot. |
| 343 | }, |
| 344 | ], |
| 345 | }, |
| 346 | "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # Geo criteria IDs to be included/excluded. |
| 347 | "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. |
| 348 | "A String", |
| 349 | ], |
| 350 | "targetedCriteriaIds": [ # A list of numeric IDs to be included. |
| 351 | "A String", |
| 352 | ], |
| 353 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 354 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 355 | "externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is finalized. This is the deal ID that shows up in serving/reporting etc. |
| 356 | "isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this deal. |
| 357 | "creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ Preferred Deal in Ad Manager. This doesn't apply to Private Auction and AdX Preferred Deals. # Output only. Restricitions about the creatives associated with the deal (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals in Ad Manager. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 358 | "skippableAdType": "A String", # Skippable video ads allow viewers to skip ads after 5 seconds. |
| 359 | "creativeSpecifications": [ |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 360 | { # Represents information for a creative that is associated with a Programmatic Guaranteed/Preferred Deal in Ad Manager. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 361 | "creativeCompanionSizes": [ # Companion sizes may be filled in only when this is a video creative. |
| 362 | { # Represents size of a single ad slot, or a creative. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 363 | "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 364 | "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 365 | "sizeType": "A String", # The size type of the ad slot. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 366 | }, |
| 367 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 368 | "creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative. |
| 369 | "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 370 | "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 371 | "sizeType": "A String", # The size type of the ad slot. |
| 372 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 373 | }, |
| 374 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 375 | "creativeFormat": "A String", # The format of the environment that the creatives will be displayed in. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 376 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 377 | "availableStartTime": "A String", # Optional proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (e.g., in milliseconds) will be truncated towards the start of time in seconds. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 378 | "sellerContacts": [ # Output only. Seller contact information for the deal. |
| 379 | { # Contains information on how a buyer or seller can be reached. |
| 380 | "name": "A String", # The name of the contact. |
| 381 | "email": "A String", # Email address for the contact. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 382 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 383 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 384 | "dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal. |
| 385 | "dealPauseStatus": { # Tracks which parties (if any) have paused a deal. The deal is considered paused if either hasBuyerPaused or hasSellPaused is true. # Output only. Tracks which parties (if any) have paused a deal. |
| 386 | "buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal. |
| 387 | "hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally. |
| 388 | "sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal. |
| 389 | "hasBuyerPaused": True or False, # True, if the buyer has paused the deal unilaterally. |
| 390 | "firstPausedBy": "A String", # The role of the person who first paused this deal. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 391 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 392 | }, |
| 393 | "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy. |
| 394 | "updateTime": "A String", # Output only. The time when the deal was last updated. |
| 395 | "dealTerms": { # The deal terms specify the details of a Product/deal. They specify things like price per buyer, the type of pricing model (e.g., fixed price, auction) and expected impressions from the publisher. # The negotiable terms of the deal. |
| 396 | "nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via the API at this time, but can be returned in a get or list request. # The terms for non-guaranteed fixed price deals. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 397 | "fixedPrices": [ # Fixed price for the specified buyer. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 398 | { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in a product can become 0 or 1 deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set. |
| 399 | "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 400 | "accountId": "A String", # Authorized Buyers account ID of the buyer. |
| 401 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 402 | "advertiserIds": [ # The list of advertisers for this price when associated with this buyer. If empty, all advertisers with this buyer pay this price. |
| 403 | "A String", |
| 404 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 405 | "price": { # Represents a price and a pricing type for a product / deal. # The specified price. |
| 406 | "pricingType": "A String", # The pricing type for the deal/product. (default: CPM) |
| 407 | "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 408 | "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 409 | "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 410 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 411 | }, |
| 412 | }, |
| 413 | }, |
| 414 | ], |
| 415 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 416 | "description": "A String", # Publisher provided description for the terms. |
| 417 | "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day. Can be set by buyer or seller. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 418 | "guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 419 | "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 420 | "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product. |
| 421 | "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. |
| 422 | "fixedPrices": [ # Fixed price for the specified buyer. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 423 | { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in a product can become 0 or 1 deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set. |
| 424 | "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 425 | "accountId": "A String", # Authorized Buyers account ID of the buyer. |
| 426 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 427 | "advertiserIds": [ # The list of advertisers for this price when associated with this buyer. If empty, all advertisers with this buyer pay this price. |
| 428 | "A String", |
| 429 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 430 | "price": { # Represents a price and a pricing type for a product / deal. # The specified price. |
| 431 | "pricingType": "A String", # The pricing type for the deal/product. (default: CPM) |
| 432 | "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 433 | "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 434 | "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 435 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 436 | }, |
| 437 | }, |
| 438 | }, |
| 439 | ], |
| 440 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 441 | "sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the time zone used to mark the boundaries of a day. It should be an IANA TZ name, such as "America/Los_Angeles". For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. |
| 442 | "estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal. Can be set by buyer or seller. |
| 443 | "pricingType": "A String", # The pricing type for the deal/product. (default: CPM) |
| 444 | "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified. |
| 445 | "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 446 | "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 447 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 448 | }, |
| 449 | }, |
| 450 | "nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only by the seller, but they can be returned in a get or list request. # The terms for non-guaranteed auction deals. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 451 | "reservePricesPerBuyer": [ # Reserve price for the specified buyer. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 452 | { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in a product can become 0 or 1 deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set. |
| 453 | "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 454 | "accountId": "A String", # Authorized Buyers account ID of the buyer. |
| 455 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 456 | "advertiserIds": [ # The list of advertisers for this price when associated with this buyer. If empty, all advertisers with this buyer pay this price. |
| 457 | "A String", |
| 458 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 459 | "price": { # Represents a price and a pricing type for a product / deal. # The specified price. |
| 460 | "pricingType": "A String", # The pricing type for the deal/product. (default: CPM) |
| 461 | "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 462 | "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 463 | "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 464 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 465 | }, |
| 466 | }, |
| 467 | }, |
| 468 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 469 | "autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers in this private auction. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 470 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 471 | "brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED) |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 472 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 473 | "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible. |
| 474 | "description": "A String", # Description for the deal terms. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 475 | }, |
| 476 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 477 | "sellerContacts": [ # Output only. Contact information for the seller. |
| 478 | { # Contains information on how a buyer or seller can be reached. |
| 479 | "name": "A String", # The name of the contact. |
| 480 | "email": "A String", # Email address for the contact. |
| 481 | }, |
| 482 | ], |
| 483 | "billedBuyer": { # Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. # Output only. Reference to the buyer that will get billed for this proposal. |
| 484 | "accountId": "A String", # Authorized Buyers account ID of the buyer. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 485 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 486 | "proposalState": "A String", # Output only. The current state of the proposal. |
| 487 | "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or left a comment. |
| 488 | "seller": { # Represents a seller of inventory. Each seller is identified by a unique Ad Manager account ID. # Reference to the seller on the proposal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| 489 | "accountId": "A String", # The unique ID for the seller. The seller fills in this field. The seller account ID is then available to buyer in the product. |
| 490 | "subAccountId": "A String", # Optional sub-account ID for the seller. |
| 491 | }, |
| 492 | "proposalId": "A String", # Output only. The unique ID of the proposal. |
| 493 | "notes": [ # Output only. The notes associated with this proposal. |
| 494 | { # A proposal may be associated to several notes. |
| 495 | "proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created. |
| 496 | "creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note. |
| 497 | "note": "A String", # The actual note to attach. (max-length: 1024 unicode code units) Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| 498 | "noteId": "A String", # Output only. The unique ID for the note. |
| 499 | "createTime": "A String", # Output only. The timestamp for when this note was created. |
| 500 | }, |
| 501 | ], |
| 502 | "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal. |
| 503 | "updateTime": "A String", # Output only. The time when the proposal was last revised. |
| 504 | "isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this proposal. |
| 505 | "proposalRevision": "A String", # Output only. The revision number for the proposal. Each update to the proposal or the deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 506 | "buyerContacts": [ # Contact information for the buyer. |
| 507 | { # Contains information on how a buyer or seller can be reached. |
| 508 | "name": "A String", # The name of the contact. |
| 509 | "email": "A String", # Email address for the contact. |
| 510 | }, |
| 511 | ], |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 512 | }</pre> |
| 513 | </div> |
| 514 | |
| 515 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 516 | <code class="details" id="addNote">addNote(accountId, proposalId, body=None, x__xgafv=None)</code> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 517 | <pre>Create a new note and attach it to the proposal. The note is assigned a unique ID by the server. The proposal revision number will not increase when associated with a new note. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 518 | |
| 519 | Args: |
| 520 | accountId: string, Account ID of the buyer. (required) |
| 521 | proposalId: string, The ID of the proposal to attach the note to. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 522 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 523 | The object takes the form of: |
| 524 | |
| 525 | { # Request message for adding a note to a given proposal. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 526 | "note": { # A proposal may be associated to several notes. # Details of the note to add. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 527 | "proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created. |
| 528 | "creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 529 | "note": "A String", # The actual note to attach. (max-length: 1024 unicode code units) Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| 530 | "noteId": "A String", # Output only. The unique ID for the note. |
| 531 | "createTime": "A String", # Output only. The timestamp for when this note was created. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 532 | }, |
| 533 | } |
| 534 | |
| 535 | x__xgafv: string, V1 error format. |
| 536 | Allowed values |
| 537 | 1 - v1 error format |
| 538 | 2 - v2 error format |
| 539 | |
| 540 | Returns: |
| 541 | An object of the form: |
| 542 | |
| 543 | { # A proposal may be associated to several notes. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 544 | "proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created. |
| 545 | "creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 546 | "note": "A String", # The actual note to attach. (max-length: 1024 unicode code units) Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| 547 | "noteId": "A String", # Output only. The unique ID for the note. |
| 548 | "createTime": "A String", # Output only. The timestamp for when this note was created. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 549 | }</pre> |
| 550 | </div> |
| 551 | |
| 552 | <div class="method"> |
| 553 | <code class="details" id="cancelNegotiation">cancelNegotiation(accountId, proposalId, body=None, x__xgafv=None)</code> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 554 | <pre>Cancel an ongoing negotiation on a proposal. This does not cancel or end serving for the deals if the proposal has been finalized, but only cancels a negotiation unilaterally. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 555 | |
| 556 | Args: |
| 557 | accountId: string, Account ID of the buyer. (required) |
| 558 | proposalId: string, The ID of the proposal to cancel negotiation for. (required) |
| 559 | body: object, The request body. |
| 560 | The object takes the form of: |
| 561 | |
| 562 | { # Request to cancel an ongoing negotiation. |
| 563 | } |
| 564 | |
| 565 | x__xgafv: string, V1 error format. |
| 566 | Allowed values |
| 567 | 1 - v1 error format |
| 568 | 2 - v2 error format |
| 569 | |
| 570 | Returns: |
| 571 | An object of the form: |
| 572 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 573 | { # Note: this resource requires whitelisting for access. Please contact your account manager for access to Marketplace resources. Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer and contains deals which are served. Note: you can not update, create, or otherwise modify Private Auction or Preferred Deals deals through the API. Fields are updatable unless noted otherwise. |
| 574 | "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. # Reference to the buyer on the proposal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| 575 | "accountId": "A String", # Authorized Buyers account ID of the buyer. |
| 576 | }, |
| 577 | "isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated. |
| 578 | "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller). |
| 579 | "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). |
| 580 | }, |
| 581 | "privateAuctionId": "A String", # Output only. Private auction ID if this proposal is a private auction proposal. |
| 582 | "displayName": "A String", # The name for the proposal. |
| 583 | "deals": [ # The deals associated with this proposal. For Private Auction proposals (whose deals have NonGuaranteedAuctionTerms), there will only be one deal. |
| 584 | { # A deal represents a segment of inventory for displaying ads on. A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving. |
| 585 | "dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned). |
| 586 | "syndicationProduct": "A String", # The syndication product associated with the deal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| 587 | "createTime": "A String", # Output only. The time of the deal creation. |
| 588 | "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by buyer. |
| 589 | "availableEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not required for Private Auction deals or Preferred Deals. |
| 590 | "deliveryControl": { # Message contains details about how the deals will be paced. # The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. |
| 591 | "frequencyCaps": [ # Output only. Specifies any frequency caps. |
| 592 | { # Frequency cap. |
| 593 | "numTimeUnits": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped. |
| 594 | "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period. |
| 595 | "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped. |
| 596 | }, |
| 597 | ], |
| 598 | "creativeBlockingLevel": "A String", # Output only. Specified the creative blocking levels to be applied. |
| 599 | "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced. |
| 600 | }, |
| 601 | "createProductId": "A String", # The product ID from which this deal was created. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| 602 | "webPropertyCode": "A String", # The web property code for the seller copied over from the product. |
| 603 | "proposalId": "A String", # Output only. ID of the proposal that this deal is part of. |
| 604 | "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller). |
| 605 | "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). |
| 606 | }, |
| 607 | "createProductRevision": "A String", # Optional revision number of the product that the deal was created from. If present on create, and the server `product_revision` has advanced sinced the passed-in `create_product_revision`, an `ABORTED` error will be returned. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 608 | "displayName": "A String", # The name of the deal. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 609 | "targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared targeting entity is AND'd together. |
| 610 | { # Advertisers can target different attributes of an ad slot. For example, they can choose to show ads only if the user is in the U.S. Such targeting criteria can be specified as part of Shared Targeting. |
| 611 | "key": "A String", # The key representing the shared targeting criterion. Targeting criteria defined by Google ad servers will begin with GOOG_. Third parties may define their own keys. A list of permissible keys along with the acceptable values will be provided as part of the external documentation. |
| 612 | "inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd together. |
| 613 | { # A polymorphic targeting value used as part of Shared Targeting. |
| 614 | "dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING. The definition of this targeting is derived from the structure used by Ad Manager. |
| 615 | "dayParts": [ # A list of day part targeting criterion. |
| 616 | { # Daypart targeting message that specifies if the ad can be shown only during certain parts of a day/week. |
| 617 | "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # The ending time of the day for the ad to show (minute level granularity). The end time is exclusive. This field is not available for filtering in PQL queries. |
| 618 | "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| 619 | "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| 620 | "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| 621 | "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. |
| 622 | }, |
| 623 | "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # The starting time of day for the ad to show (minute level granularity). The start time is inclusive. This field is not available for filtering in PQL queries. |
| 624 | "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| 625 | "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| 626 | "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| 627 | "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. |
| 628 | }, |
| 629 | "dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days. |
| 630 | }, |
| 631 | ], |
| 632 | "timeZoneType": "A String", # The timezone to use for interpreting the day part targeting. |
| 633 | }, |
| 634 | "longValue": "A String", # The long value to include/exclude. |
| 635 | "stringValue": "A String", # The string value to include/exclude. |
| 636 | "creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude. Filled in when key = GOOG_CREATIVE_SIZE |
| 637 | "companionSizes": [ # For video creatives specifies the sizes of companion ads (if present). Companion sizes may be filled in only when creative_size_type = VIDEO |
| 638 | { # Message depicting the size of the creative. The units of width and height depend on the type of the targeting. |
| 639 | "height": 42, # The height of the creative. |
| 640 | "width": 42, # The width of the creative |
| 641 | }, |
| 642 | ], |
| 643 | "size": { # Message depicting the size of the creative. The units of width and height depend on the type of the targeting. # For regular or video creative size type, specifies the size of the creative |
| 644 | "height": 42, # The height of the creative. |
| 645 | "width": 42, # The width of the creative |
| 646 | }, |
| 647 | "nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value only if creative_size_type = CreativeSizeType.NATIVE. |
| 648 | "allowedFormats": [ # What formats are allowed by the publisher. If this repeated field is empty then all formats are allowed. For example, if this field contains AllowedFormatType.AUDIO then the publisher only allows an audio ad (without any video). |
| 649 | "A String", |
| 650 | ], |
| 651 | "creativeSizeType": "A String", # The creative size type. |
| 652 | "skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if creative_size_type = CreativeSizeType.VIDEO. |
| 653 | }, |
| 654 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 655 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 656 | "exclusions": [ # The list of values to exclude from targeting. Each value is AND'd together. |
| 657 | { # A polymorphic targeting value used as part of Shared Targeting. |
| 658 | "dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING. The definition of this targeting is derived from the structure used by Ad Manager. |
| 659 | "dayParts": [ # A list of day part targeting criterion. |
| 660 | { # Daypart targeting message that specifies if the ad can be shown only during certain parts of a day/week. |
| 661 | "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # The ending time of the day for the ad to show (minute level granularity). The end time is exclusive. This field is not available for filtering in PQL queries. |
| 662 | "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| 663 | "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| 664 | "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| 665 | "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. |
| 666 | }, |
| 667 | "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # The starting time of day for the ad to show (minute level granularity). The start time is inclusive. This field is not available for filtering in PQL queries. |
| 668 | "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| 669 | "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| 670 | "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| 671 | "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. |
| 672 | }, |
| 673 | "dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days. |
| 674 | }, |
| 675 | ], |
| 676 | "timeZoneType": "A String", # The timezone to use for interpreting the day part targeting. |
| 677 | }, |
| 678 | "longValue": "A String", # The long value to include/exclude. |
| 679 | "stringValue": "A String", # The string value to include/exclude. |
| 680 | "creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude. Filled in when key = GOOG_CREATIVE_SIZE |
| 681 | "companionSizes": [ # For video creatives specifies the sizes of companion ads (if present). Companion sizes may be filled in only when creative_size_type = VIDEO |
| 682 | { # Message depicting the size of the creative. The units of width and height depend on the type of the targeting. |
| 683 | "height": 42, # The height of the creative. |
| 684 | "width": 42, # The width of the creative |
| 685 | }, |
| 686 | ], |
| 687 | "size": { # Message depicting the size of the creative. The units of width and height depend on the type of the targeting. # For regular or video creative size type, specifies the size of the creative |
| 688 | "height": 42, # The height of the creative. |
| 689 | "width": 42, # The width of the creative |
| 690 | }, |
| 691 | "nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value only if creative_size_type = CreativeSizeType.NATIVE. |
| 692 | "allowedFormats": [ # What formats are allowed by the publisher. If this repeated field is empty then all formats are allowed. For example, if this field contains AllowedFormatType.AUDIO then the publisher only allows an audio ad (without any video). |
| 693 | "A String", |
| 694 | ], |
| 695 | "creativeSizeType": "A String", # The creative size type. |
| 696 | "skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if creative_size_type = CreativeSizeType.VIDEO. |
| 697 | }, |
| 698 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 699 | ], |
| 700 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 701 | ], |
| 702 | "targeting": { # Targeting represents different criteria that can be used by advertisers to target ad inventory. For example, they can choose to target ad requests only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. # Output only. Specifies the subset of inventory targeted by the deal. |
| 703 | "placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Placement targeting information, e.g., URL, mobile applications. |
| 704 | "urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). For Private Auction and AdX Preferred Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 705 | "excludedUrls": [ # A list of URLs to be excluded. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 706 | "A String", |
| 707 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 708 | "targetedUrls": [ # A list of URLs to be included. |
| 709 | "A String", |
| 710 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 711 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 712 | "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages. |
| 713 | "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Mobile application IDs are from App Store and Google Play Store. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 714 | "targetedAppIds": [ # A list of application IDs to be included. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 715 | "A String", |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 716 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 717 | "excludedAppIds": [ # A list of application IDs to be excluded. |
| 718 | "A String", |
| 719 | ], |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 720 | }, |
| 721 | }, |
| 722 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 723 | "technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 724 | "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # IDs of device capabilities to be included/excluded. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 725 | "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. |
| 726 | "A String", |
| 727 | ], |
| 728 | "targetedCriteriaIds": [ # A list of numeric IDs to be included. |
| 729 | "A String", |
| 730 | ], |
| 731 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 732 | "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # IDs of device categories to be included/excluded. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 733 | "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. |
| 734 | "A String", |
| 735 | ], |
| 736 | "targetedCriteriaIds": [ # A list of numeric IDs to be included. |
| 737 | "A String", |
| 738 | ], |
| 739 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 740 | "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 741 | "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # IDs of operating systems to be included/excluded. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 742 | "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. |
| 743 | "A String", |
| 744 | ], |
| 745 | "targetedCriteriaIds": [ # A list of numeric IDs to be included. |
| 746 | "A String", |
| 747 | ], |
| 748 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 749 | "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # IDs of operating system versions to be included/excluded. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 750 | "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. |
| 751 | "A String", |
| 752 | ], |
| 753 | "targetedCriteriaIds": [ # A list of numeric IDs to be included. |
| 754 | "A String", |
| 755 | ], |
| 756 | }, |
| 757 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 758 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 759 | "videoTargeting": { # Represents targeting information about video. # Video targeting information. |
| 760 | "excludedPositionTypes": [ # A list of video positions to be excluded. Position types can either be included or excluded (XOR). |
| 761 | "A String", |
| 762 | ], |
| 763 | "targetedPositionTypes": [ # A list of video positions to be included. When the included list is present, the excluded list must be empty. When the excluded list is present, the included list must be empty. |
| 764 | "A String", |
| 765 | ], |
| 766 | }, |
| 767 | "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on an ad request. It only applies to Private Auction, AdX Preferred Deals and Auction Packages. This targeting does not apply to Programmatic Guaranteed and Preferred Deals in Ad Manager. # Inventory sizes to be included/excluded. |
| 768 | "targetedInventorySizes": [ # A list of inventory sizes to be included. |
| 769 | { # Represents size of a single ad slot, or a creative. |
| 770 | "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 771 | "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 772 | "sizeType": "A String", # The size type of the ad slot. |
| 773 | }, |
| 774 | ], |
| 775 | "excludedInventorySizes": [ # A list of inventory sizes to be excluded. |
| 776 | { # Represents size of a single ad slot, or a creative. |
| 777 | "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 778 | "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 779 | "sizeType": "A String", # The size type of the ad slot. |
| 780 | }, |
| 781 | ], |
| 782 | }, |
| 783 | "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # Geo criteria IDs to be included/excluded. |
| 784 | "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. |
| 785 | "A String", |
| 786 | ], |
| 787 | "targetedCriteriaIds": [ # A list of numeric IDs to be included. |
| 788 | "A String", |
| 789 | ], |
| 790 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 791 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 792 | "externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is finalized. This is the deal ID that shows up in serving/reporting etc. |
| 793 | "isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this deal. |
| 794 | "creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ Preferred Deal in Ad Manager. This doesn't apply to Private Auction and AdX Preferred Deals. # Output only. Restricitions about the creatives associated with the deal (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals in Ad Manager. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 795 | "skippableAdType": "A String", # Skippable video ads allow viewers to skip ads after 5 seconds. |
| 796 | "creativeSpecifications": [ |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 797 | { # Represents information for a creative that is associated with a Programmatic Guaranteed/Preferred Deal in Ad Manager. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 798 | "creativeCompanionSizes": [ # Companion sizes may be filled in only when this is a video creative. |
| 799 | { # Represents size of a single ad slot, or a creative. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 800 | "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 801 | "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 802 | "sizeType": "A String", # The size type of the ad slot. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 803 | }, |
| 804 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 805 | "creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative. |
| 806 | "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 807 | "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 808 | "sizeType": "A String", # The size type of the ad slot. |
| 809 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 810 | }, |
| 811 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 812 | "creativeFormat": "A String", # The format of the environment that the creatives will be displayed in. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 813 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 814 | "availableStartTime": "A String", # Optional proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (e.g., in milliseconds) will be truncated towards the start of time in seconds. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 815 | "sellerContacts": [ # Output only. Seller contact information for the deal. |
| 816 | { # Contains information on how a buyer or seller can be reached. |
| 817 | "name": "A String", # The name of the contact. |
| 818 | "email": "A String", # Email address for the contact. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 819 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 820 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 821 | "dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal. |
| 822 | "dealPauseStatus": { # Tracks which parties (if any) have paused a deal. The deal is considered paused if either hasBuyerPaused or hasSellPaused is true. # Output only. Tracks which parties (if any) have paused a deal. |
| 823 | "buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal. |
| 824 | "hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally. |
| 825 | "sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal. |
| 826 | "hasBuyerPaused": True or False, # True, if the buyer has paused the deal unilaterally. |
| 827 | "firstPausedBy": "A String", # The role of the person who first paused this deal. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 828 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 829 | }, |
| 830 | "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy. |
| 831 | "updateTime": "A String", # Output only. The time when the deal was last updated. |
| 832 | "dealTerms": { # The deal terms specify the details of a Product/deal. They specify things like price per buyer, the type of pricing model (e.g., fixed price, auction) and expected impressions from the publisher. # The negotiable terms of the deal. |
| 833 | "nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via the API at this time, but can be returned in a get or list request. # The terms for non-guaranteed fixed price deals. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 834 | "fixedPrices": [ # Fixed price for the specified buyer. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 835 | { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in a product can become 0 or 1 deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set. |
| 836 | "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 837 | "accountId": "A String", # Authorized Buyers account ID of the buyer. |
| 838 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 839 | "advertiserIds": [ # The list of advertisers for this price when associated with this buyer. If empty, all advertisers with this buyer pay this price. |
| 840 | "A String", |
| 841 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 842 | "price": { # Represents a price and a pricing type for a product / deal. # The specified price. |
| 843 | "pricingType": "A String", # The pricing type for the deal/product. (default: CPM) |
| 844 | "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 845 | "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 846 | "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 847 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 848 | }, |
| 849 | }, |
| 850 | }, |
| 851 | ], |
| 852 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 853 | "description": "A String", # Publisher provided description for the terms. |
| 854 | "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day. Can be set by buyer or seller. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 855 | "guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 856 | "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 857 | "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product. |
| 858 | "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. |
| 859 | "fixedPrices": [ # Fixed price for the specified buyer. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 860 | { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in a product can become 0 or 1 deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set. |
| 861 | "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 862 | "accountId": "A String", # Authorized Buyers account ID of the buyer. |
| 863 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 864 | "advertiserIds": [ # The list of advertisers for this price when associated with this buyer. If empty, all advertisers with this buyer pay this price. |
| 865 | "A String", |
| 866 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 867 | "price": { # Represents a price and a pricing type for a product / deal. # The specified price. |
| 868 | "pricingType": "A String", # The pricing type for the deal/product. (default: CPM) |
| 869 | "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 870 | "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 871 | "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 872 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 873 | }, |
| 874 | }, |
| 875 | }, |
| 876 | ], |
| 877 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 878 | "sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the time zone used to mark the boundaries of a day. It should be an IANA TZ name, such as "America/Los_Angeles". For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. |
| 879 | "estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal. Can be set by buyer or seller. |
| 880 | "pricingType": "A String", # The pricing type for the deal/product. (default: CPM) |
| 881 | "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified. |
| 882 | "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 883 | "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 884 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 885 | }, |
| 886 | }, |
| 887 | "nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only by the seller, but they can be returned in a get or list request. # The terms for non-guaranteed auction deals. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 888 | "reservePricesPerBuyer": [ # Reserve price for the specified buyer. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 889 | { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in a product can become 0 or 1 deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set. |
| 890 | "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 891 | "accountId": "A String", # Authorized Buyers account ID of the buyer. |
| 892 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 893 | "advertiserIds": [ # The list of advertisers for this price when associated with this buyer. If empty, all advertisers with this buyer pay this price. |
| 894 | "A String", |
| 895 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 896 | "price": { # Represents a price and a pricing type for a product / deal. # The specified price. |
| 897 | "pricingType": "A String", # The pricing type for the deal/product. (default: CPM) |
| 898 | "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 899 | "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 900 | "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 901 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 902 | }, |
| 903 | }, |
| 904 | }, |
| 905 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 906 | "autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers in this private auction. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 907 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 908 | "brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED) |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 909 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 910 | "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible. |
| 911 | "description": "A String", # Description for the deal terms. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 912 | }, |
| 913 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 914 | "sellerContacts": [ # Output only. Contact information for the seller. |
| 915 | { # Contains information on how a buyer or seller can be reached. |
| 916 | "name": "A String", # The name of the contact. |
| 917 | "email": "A String", # Email address for the contact. |
| 918 | }, |
| 919 | ], |
| 920 | "billedBuyer": { # Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. # Output only. Reference to the buyer that will get billed for this proposal. |
| 921 | "accountId": "A String", # Authorized Buyers account ID of the buyer. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 922 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 923 | "proposalState": "A String", # Output only. The current state of the proposal. |
| 924 | "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or left a comment. |
| 925 | "seller": { # Represents a seller of inventory. Each seller is identified by a unique Ad Manager account ID. # Reference to the seller on the proposal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| 926 | "accountId": "A String", # The unique ID for the seller. The seller fills in this field. The seller account ID is then available to buyer in the product. |
| 927 | "subAccountId": "A String", # Optional sub-account ID for the seller. |
| 928 | }, |
| 929 | "proposalId": "A String", # Output only. The unique ID of the proposal. |
| 930 | "notes": [ # Output only. The notes associated with this proposal. |
| 931 | { # A proposal may be associated to several notes. |
| 932 | "proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created. |
| 933 | "creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note. |
| 934 | "note": "A String", # The actual note to attach. (max-length: 1024 unicode code units) Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| 935 | "noteId": "A String", # Output only. The unique ID for the note. |
| 936 | "createTime": "A String", # Output only. The timestamp for when this note was created. |
| 937 | }, |
| 938 | ], |
| 939 | "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal. |
| 940 | "updateTime": "A String", # Output only. The time when the proposal was last revised. |
| 941 | "isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this proposal. |
| 942 | "proposalRevision": "A String", # Output only. The revision number for the proposal. Each update to the proposal or the deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 943 | "buyerContacts": [ # Contact information for the buyer. |
| 944 | { # Contains information on how a buyer or seller can be reached. |
| 945 | "name": "A String", # The name of the contact. |
| 946 | "email": "A String", # Email address for the contact. |
| 947 | }, |
| 948 | ], |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 949 | }</pre> |
| 950 | </div> |
| 951 | |
| 952 | <div class="method"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 953 | <code class="details" id="close">close()</code> |
| 954 | <pre>Close httplib2 connections.</pre> |
| 955 | </div> |
| 956 | |
| 957 | <div class="method"> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 958 | <code class="details" id="completeSetup">completeSetup(accountId, proposalId, body=None, x__xgafv=None)</code> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 959 | <pre>Update the given proposal to indicate that setup has been completed. This method is called by the buyer when the line items have been created on their end for a finalized proposal and all the required creatives have been uploaded using the creatives API. This call updates the `is_setup_completed` bit on the proposal and also notifies the seller. The server will advance the revision number of the most recent proposal. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 960 | |
| 961 | Args: |
| 962 | accountId: string, Account ID of the buyer. (required) |
| 963 | proposalId: string, The ID of the proposal to mark as setup completed. (required) |
| 964 | body: object, The request body. |
| 965 | The object takes the form of: |
| 966 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 967 | { # Request message for indicating that the proposal's setup step is complete. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 968 | } |
| 969 | |
| 970 | x__xgafv: string, V1 error format. |
| 971 | Allowed values |
| 972 | 1 - v1 error format |
| 973 | 2 - v2 error format |
| 974 | |
| 975 | Returns: |
| 976 | An object of the form: |
| 977 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 978 | { # Note: this resource requires whitelisting for access. Please contact your account manager for access to Marketplace resources. Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer and contains deals which are served. Note: you can not update, create, or otherwise modify Private Auction or Preferred Deals deals through the API. Fields are updatable unless noted otherwise. |
| 979 | "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. # Reference to the buyer on the proposal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| 980 | "accountId": "A String", # Authorized Buyers account ID of the buyer. |
| 981 | }, |
| 982 | "isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated. |
| 983 | "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller). |
| 984 | "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). |
| 985 | }, |
| 986 | "privateAuctionId": "A String", # Output only. Private auction ID if this proposal is a private auction proposal. |
| 987 | "displayName": "A String", # The name for the proposal. |
| 988 | "deals": [ # The deals associated with this proposal. For Private Auction proposals (whose deals have NonGuaranteedAuctionTerms), there will only be one deal. |
| 989 | { # A deal represents a segment of inventory for displaying ads on. A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving. |
| 990 | "dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned). |
| 991 | "syndicationProduct": "A String", # The syndication product associated with the deal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| 992 | "createTime": "A String", # Output only. The time of the deal creation. |
| 993 | "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by buyer. |
| 994 | "availableEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not required for Private Auction deals or Preferred Deals. |
| 995 | "deliveryControl": { # Message contains details about how the deals will be paced. # The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. |
| 996 | "frequencyCaps": [ # Output only. Specifies any frequency caps. |
| 997 | { # Frequency cap. |
| 998 | "numTimeUnits": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped. |
| 999 | "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period. |
| 1000 | "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped. |
| 1001 | }, |
| 1002 | ], |
| 1003 | "creativeBlockingLevel": "A String", # Output only. Specified the creative blocking levels to be applied. |
| 1004 | "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced. |
| 1005 | }, |
| 1006 | "createProductId": "A String", # The product ID from which this deal was created. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| 1007 | "webPropertyCode": "A String", # The web property code for the seller copied over from the product. |
| 1008 | "proposalId": "A String", # Output only. ID of the proposal that this deal is part of. |
| 1009 | "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller). |
| 1010 | "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). |
| 1011 | }, |
| 1012 | "createProductRevision": "A String", # Optional revision number of the product that the deal was created from. If present on create, and the server `product_revision` has advanced sinced the passed-in `create_product_revision`, an `ABORTED` error will be returned. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1013 | "displayName": "A String", # The name of the deal. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1014 | "targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared targeting entity is AND'd together. |
| 1015 | { # Advertisers can target different attributes of an ad slot. For example, they can choose to show ads only if the user is in the U.S. Such targeting criteria can be specified as part of Shared Targeting. |
| 1016 | "key": "A String", # The key representing the shared targeting criterion. Targeting criteria defined by Google ad servers will begin with GOOG_. Third parties may define their own keys. A list of permissible keys along with the acceptable values will be provided as part of the external documentation. |
| 1017 | "inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd together. |
| 1018 | { # A polymorphic targeting value used as part of Shared Targeting. |
| 1019 | "dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING. The definition of this targeting is derived from the structure used by Ad Manager. |
| 1020 | "dayParts": [ # A list of day part targeting criterion. |
| 1021 | { # Daypart targeting message that specifies if the ad can be shown only during certain parts of a day/week. |
| 1022 | "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # The ending time of the day for the ad to show (minute level granularity). The end time is exclusive. This field is not available for filtering in PQL queries. |
| 1023 | "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| 1024 | "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| 1025 | "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| 1026 | "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. |
| 1027 | }, |
| 1028 | "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # The starting time of day for the ad to show (minute level granularity). The start time is inclusive. This field is not available for filtering in PQL queries. |
| 1029 | "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| 1030 | "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| 1031 | "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| 1032 | "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. |
| 1033 | }, |
| 1034 | "dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days. |
| 1035 | }, |
| 1036 | ], |
| 1037 | "timeZoneType": "A String", # The timezone to use for interpreting the day part targeting. |
| 1038 | }, |
| 1039 | "longValue": "A String", # The long value to include/exclude. |
| 1040 | "stringValue": "A String", # The string value to include/exclude. |
| 1041 | "creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude. Filled in when key = GOOG_CREATIVE_SIZE |
| 1042 | "companionSizes": [ # For video creatives specifies the sizes of companion ads (if present). Companion sizes may be filled in only when creative_size_type = VIDEO |
| 1043 | { # Message depicting the size of the creative. The units of width and height depend on the type of the targeting. |
| 1044 | "height": 42, # The height of the creative. |
| 1045 | "width": 42, # The width of the creative |
| 1046 | }, |
| 1047 | ], |
| 1048 | "size": { # Message depicting the size of the creative. The units of width and height depend on the type of the targeting. # For regular or video creative size type, specifies the size of the creative |
| 1049 | "height": 42, # The height of the creative. |
| 1050 | "width": 42, # The width of the creative |
| 1051 | }, |
| 1052 | "nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value only if creative_size_type = CreativeSizeType.NATIVE. |
| 1053 | "allowedFormats": [ # What formats are allowed by the publisher. If this repeated field is empty then all formats are allowed. For example, if this field contains AllowedFormatType.AUDIO then the publisher only allows an audio ad (without any video). |
| 1054 | "A String", |
| 1055 | ], |
| 1056 | "creativeSizeType": "A String", # The creative size type. |
| 1057 | "skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if creative_size_type = CreativeSizeType.VIDEO. |
| 1058 | }, |
| 1059 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1060 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1061 | "exclusions": [ # The list of values to exclude from targeting. Each value is AND'd together. |
| 1062 | { # A polymorphic targeting value used as part of Shared Targeting. |
| 1063 | "dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING. The definition of this targeting is derived from the structure used by Ad Manager. |
| 1064 | "dayParts": [ # A list of day part targeting criterion. |
| 1065 | { # Daypart targeting message that specifies if the ad can be shown only during certain parts of a day/week. |
| 1066 | "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # The ending time of the day for the ad to show (minute level granularity). The end time is exclusive. This field is not available for filtering in PQL queries. |
| 1067 | "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| 1068 | "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| 1069 | "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| 1070 | "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. |
| 1071 | }, |
| 1072 | "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # The starting time of day for the ad to show (minute level granularity). The start time is inclusive. This field is not available for filtering in PQL queries. |
| 1073 | "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| 1074 | "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| 1075 | "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| 1076 | "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. |
| 1077 | }, |
| 1078 | "dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days. |
| 1079 | }, |
| 1080 | ], |
| 1081 | "timeZoneType": "A String", # The timezone to use for interpreting the day part targeting. |
| 1082 | }, |
| 1083 | "longValue": "A String", # The long value to include/exclude. |
| 1084 | "stringValue": "A String", # The string value to include/exclude. |
| 1085 | "creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude. Filled in when key = GOOG_CREATIVE_SIZE |
| 1086 | "companionSizes": [ # For video creatives specifies the sizes of companion ads (if present). Companion sizes may be filled in only when creative_size_type = VIDEO |
| 1087 | { # Message depicting the size of the creative. The units of width and height depend on the type of the targeting. |
| 1088 | "height": 42, # The height of the creative. |
| 1089 | "width": 42, # The width of the creative |
| 1090 | }, |
| 1091 | ], |
| 1092 | "size": { # Message depicting the size of the creative. The units of width and height depend on the type of the targeting. # For regular or video creative size type, specifies the size of the creative |
| 1093 | "height": 42, # The height of the creative. |
| 1094 | "width": 42, # The width of the creative |
| 1095 | }, |
| 1096 | "nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value only if creative_size_type = CreativeSizeType.NATIVE. |
| 1097 | "allowedFormats": [ # What formats are allowed by the publisher. If this repeated field is empty then all formats are allowed. For example, if this field contains AllowedFormatType.AUDIO then the publisher only allows an audio ad (without any video). |
| 1098 | "A String", |
| 1099 | ], |
| 1100 | "creativeSizeType": "A String", # The creative size type. |
| 1101 | "skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if creative_size_type = CreativeSizeType.VIDEO. |
| 1102 | }, |
| 1103 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1104 | ], |
| 1105 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1106 | ], |
| 1107 | "targeting": { # Targeting represents different criteria that can be used by advertisers to target ad inventory. For example, they can choose to target ad requests only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. # Output only. Specifies the subset of inventory targeted by the deal. |
| 1108 | "placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Placement targeting information, e.g., URL, mobile applications. |
| 1109 | "urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). For Private Auction and AdX Preferred Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1110 | "excludedUrls": [ # A list of URLs to be excluded. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1111 | "A String", |
| 1112 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1113 | "targetedUrls": [ # A list of URLs to be included. |
| 1114 | "A String", |
| 1115 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1116 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1117 | "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages. |
| 1118 | "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Mobile application IDs are from App Store and Google Play Store. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1119 | "targetedAppIds": [ # A list of application IDs to be included. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1120 | "A String", |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1121 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1122 | "excludedAppIds": [ # A list of application IDs to be excluded. |
| 1123 | "A String", |
| 1124 | ], |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1125 | }, |
| 1126 | }, |
| 1127 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1128 | "technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1129 | "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # IDs of device capabilities to be included/excluded. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1130 | "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. |
| 1131 | "A String", |
| 1132 | ], |
| 1133 | "targetedCriteriaIds": [ # A list of numeric IDs to be included. |
| 1134 | "A String", |
| 1135 | ], |
| 1136 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1137 | "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # IDs of device categories to be included/excluded. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1138 | "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. |
| 1139 | "A String", |
| 1140 | ], |
| 1141 | "targetedCriteriaIds": [ # A list of numeric IDs to be included. |
| 1142 | "A String", |
| 1143 | ], |
| 1144 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1145 | "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1146 | "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # IDs of operating systems to be included/excluded. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1147 | "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. |
| 1148 | "A String", |
| 1149 | ], |
| 1150 | "targetedCriteriaIds": [ # A list of numeric IDs to be included. |
| 1151 | "A String", |
| 1152 | ], |
| 1153 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1154 | "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # IDs of operating system versions to be included/excluded. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1155 | "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. |
| 1156 | "A String", |
| 1157 | ], |
| 1158 | "targetedCriteriaIds": [ # A list of numeric IDs to be included. |
| 1159 | "A String", |
| 1160 | ], |
| 1161 | }, |
| 1162 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1163 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1164 | "videoTargeting": { # Represents targeting information about video. # Video targeting information. |
| 1165 | "excludedPositionTypes": [ # A list of video positions to be excluded. Position types can either be included or excluded (XOR). |
| 1166 | "A String", |
| 1167 | ], |
| 1168 | "targetedPositionTypes": [ # A list of video positions to be included. When the included list is present, the excluded list must be empty. When the excluded list is present, the included list must be empty. |
| 1169 | "A String", |
| 1170 | ], |
| 1171 | }, |
| 1172 | "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on an ad request. It only applies to Private Auction, AdX Preferred Deals and Auction Packages. This targeting does not apply to Programmatic Guaranteed and Preferred Deals in Ad Manager. # Inventory sizes to be included/excluded. |
| 1173 | "targetedInventorySizes": [ # A list of inventory sizes to be included. |
| 1174 | { # Represents size of a single ad slot, or a creative. |
| 1175 | "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 1176 | "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1177 | "sizeType": "A String", # The size type of the ad slot. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1178 | }, |
| 1179 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1180 | "excludedInventorySizes": [ # A list of inventory sizes to be excluded. |
| 1181 | { # Represents size of a single ad slot, or a creative. |
| 1182 | "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 1183 | "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 1184 | "sizeType": "A String", # The size type of the ad slot. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1185 | }, |
| 1186 | ], |
| 1187 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1188 | "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # Geo criteria IDs to be included/excluded. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1189 | "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. |
| 1190 | "A String", |
| 1191 | ], |
| 1192 | "targetedCriteriaIds": [ # A list of numeric IDs to be included. |
| 1193 | "A String", |
| 1194 | ], |
| 1195 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1196 | }, |
| 1197 | "externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is finalized. This is the deal ID that shows up in serving/reporting etc. |
| 1198 | "isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this deal. |
| 1199 | "creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ Preferred Deal in Ad Manager. This doesn't apply to Private Auction and AdX Preferred Deals. # Output only. Restricitions about the creatives associated with the deal (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals in Ad Manager. |
| 1200 | "skippableAdType": "A String", # Skippable video ads allow viewers to skip ads after 5 seconds. |
| 1201 | "creativeSpecifications": [ |
| 1202 | { # Represents information for a creative that is associated with a Programmatic Guaranteed/Preferred Deal in Ad Manager. |
| 1203 | "creativeCompanionSizes": [ # Companion sizes may be filled in only when this is a video creative. |
| 1204 | { # Represents size of a single ad slot, or a creative. |
| 1205 | "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 1206 | "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 1207 | "sizeType": "A String", # The size type of the ad slot. |
| 1208 | }, |
| 1209 | ], |
| 1210 | "creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative. |
| 1211 | "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 1212 | "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 1213 | "sizeType": "A String", # The size type of the ad slot. |
| 1214 | }, |
| 1215 | }, |
| 1216 | ], |
| 1217 | "creativeFormat": "A String", # The format of the environment that the creatives will be displayed in. |
| 1218 | }, |
| 1219 | "availableStartTime": "A String", # Optional proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (e.g., in milliseconds) will be truncated towards the start of time in seconds. |
| 1220 | "sellerContacts": [ # Output only. Seller contact information for the deal. |
| 1221 | { # Contains information on how a buyer or seller can be reached. |
| 1222 | "name": "A String", # The name of the contact. |
| 1223 | "email": "A String", # Email address for the contact. |
| 1224 | }, |
| 1225 | ], |
| 1226 | "dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal. |
| 1227 | "dealPauseStatus": { # Tracks which parties (if any) have paused a deal. The deal is considered paused if either hasBuyerPaused or hasSellPaused is true. # Output only. Tracks which parties (if any) have paused a deal. |
| 1228 | "buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal. |
| 1229 | "hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally. |
| 1230 | "sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal. |
| 1231 | "hasBuyerPaused": True or False, # True, if the buyer has paused the deal unilaterally. |
| 1232 | "firstPausedBy": "A String", # The role of the person who first paused this deal. |
| 1233 | }, |
| 1234 | }, |
| 1235 | "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy. |
| 1236 | "updateTime": "A String", # Output only. The time when the deal was last updated. |
| 1237 | "dealTerms": { # The deal terms specify the details of a Product/deal. They specify things like price per buyer, the type of pricing model (e.g., fixed price, auction) and expected impressions from the publisher. # The negotiable terms of the deal. |
| 1238 | "nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via the API at this time, but can be returned in a get or list request. # The terms for non-guaranteed fixed price deals. |
| 1239 | "fixedPrices": [ # Fixed price for the specified buyer. |
| 1240 | { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in a product can become 0 or 1 deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set. |
| 1241 | "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer). |
| 1242 | "accountId": "A String", # Authorized Buyers account ID of the buyer. |
| 1243 | }, |
| 1244 | "advertiserIds": [ # The list of advertisers for this price when associated with this buyer. If empty, all advertisers with this buyer pay this price. |
| 1245 | "A String", |
| 1246 | ], |
| 1247 | "price": { # Represents a price and a pricing type for a product / deal. # The specified price. |
| 1248 | "pricingType": "A String", # The pricing type for the deal/product. (default: CPM) |
| 1249 | "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified. |
| 1250 | "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 1251 | "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 1252 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 1253 | }, |
| 1254 | }, |
| 1255 | }, |
| 1256 | ], |
| 1257 | }, |
| 1258 | "description": "A String", # Publisher provided description for the terms. |
| 1259 | "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day. Can be set by buyer or seller. |
| 1260 | "guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals. |
| 1261 | "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy. |
| 1262 | "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product. |
| 1263 | "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. |
| 1264 | "fixedPrices": [ # Fixed price for the specified buyer. |
| 1265 | { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in a product can become 0 or 1 deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set. |
| 1266 | "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer). |
| 1267 | "accountId": "A String", # Authorized Buyers account ID of the buyer. |
| 1268 | }, |
| 1269 | "advertiserIds": [ # The list of advertisers for this price when associated with this buyer. If empty, all advertisers with this buyer pay this price. |
| 1270 | "A String", |
| 1271 | ], |
| 1272 | "price": { # Represents a price and a pricing type for a product / deal. # The specified price. |
| 1273 | "pricingType": "A String", # The pricing type for the deal/product. (default: CPM) |
| 1274 | "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified. |
| 1275 | "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 1276 | "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 1277 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 1278 | }, |
| 1279 | }, |
| 1280 | }, |
| 1281 | ], |
| 1282 | }, |
| 1283 | "sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the time zone used to mark the boundaries of a day. It should be an IANA TZ name, such as "America/Los_Angeles". For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. |
| 1284 | "estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal. Can be set by buyer or seller. |
| 1285 | "pricingType": "A String", # The pricing type for the deal/product. (default: CPM) |
| 1286 | "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified. |
| 1287 | "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 1288 | "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 1289 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 1290 | }, |
| 1291 | }, |
| 1292 | "nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only by the seller, but they can be returned in a get or list request. # The terms for non-guaranteed auction deals. |
| 1293 | "reservePricesPerBuyer": [ # Reserve price for the specified buyer. |
| 1294 | { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in a product can become 0 or 1 deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set. |
| 1295 | "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer). |
| 1296 | "accountId": "A String", # Authorized Buyers account ID of the buyer. |
| 1297 | }, |
| 1298 | "advertiserIds": [ # The list of advertisers for this price when associated with this buyer. If empty, all advertisers with this buyer pay this price. |
| 1299 | "A String", |
| 1300 | ], |
| 1301 | "price": { # Represents a price and a pricing type for a product / deal. # The specified price. |
| 1302 | "pricingType": "A String", # The pricing type for the deal/product. (default: CPM) |
| 1303 | "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified. |
| 1304 | "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 1305 | "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 1306 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 1307 | }, |
| 1308 | }, |
| 1309 | }, |
| 1310 | ], |
| 1311 | "autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers in this private auction. |
| 1312 | }, |
| 1313 | "brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED) |
| 1314 | }, |
| 1315 | "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible. |
| 1316 | "description": "A String", # Description for the deal terms. |
| 1317 | }, |
| 1318 | ], |
| 1319 | "sellerContacts": [ # Output only. Contact information for the seller. |
| 1320 | { # Contains information on how a buyer or seller can be reached. |
| 1321 | "name": "A String", # The name of the contact. |
| 1322 | "email": "A String", # Email address for the contact. |
| 1323 | }, |
| 1324 | ], |
| 1325 | "billedBuyer": { # Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. # Output only. Reference to the buyer that will get billed for this proposal. |
| 1326 | "accountId": "A String", # Authorized Buyers account ID of the buyer. |
| 1327 | }, |
| 1328 | "proposalState": "A String", # Output only. The current state of the proposal. |
| 1329 | "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or left a comment. |
| 1330 | "seller": { # Represents a seller of inventory. Each seller is identified by a unique Ad Manager account ID. # Reference to the seller on the proposal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| 1331 | "accountId": "A String", # The unique ID for the seller. The seller fills in this field. The seller account ID is then available to buyer in the product. |
| 1332 | "subAccountId": "A String", # Optional sub-account ID for the seller. |
| 1333 | }, |
| 1334 | "proposalId": "A String", # Output only. The unique ID of the proposal. |
| 1335 | "notes": [ # Output only. The notes associated with this proposal. |
| 1336 | { # A proposal may be associated to several notes. |
| 1337 | "proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created. |
| 1338 | "creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note. |
| 1339 | "note": "A String", # The actual note to attach. (max-length: 1024 unicode code units) Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| 1340 | "noteId": "A String", # Output only. The unique ID for the note. |
| 1341 | "createTime": "A String", # Output only. The timestamp for when this note was created. |
| 1342 | }, |
| 1343 | ], |
| 1344 | "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal. |
| 1345 | "updateTime": "A String", # Output only. The time when the proposal was last revised. |
| 1346 | "isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this proposal. |
| 1347 | "proposalRevision": "A String", # Output only. The revision number for the proposal. Each update to the proposal or the deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made. |
| 1348 | "buyerContacts": [ # Contact information for the buyer. |
| 1349 | { # Contains information on how a buyer or seller can be reached. |
| 1350 | "name": "A String", # The name of the contact. |
| 1351 | "email": "A String", # Email address for the contact. |
| 1352 | }, |
| 1353 | ], |
| 1354 | }</pre> |
| 1355 | </div> |
| 1356 | |
| 1357 | <div class="method"> |
| 1358 | <code class="details" id="create">create(accountId, body=None, x__xgafv=None)</code> |
| 1359 | <pre>Create the given proposal. Each created proposal and any deals it contains are assigned a unique ID by the server. |
| 1360 | |
| 1361 | Args: |
| 1362 | accountId: string, Account ID of the buyer. (required) |
| 1363 | body: object, The request body. |
| 1364 | The object takes the form of: |
| 1365 | |
| 1366 | { # Note: this resource requires whitelisting for access. Please contact your account manager for access to Marketplace resources. Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer and contains deals which are served. Note: you can not update, create, or otherwise modify Private Auction or Preferred Deals deals through the API. Fields are updatable unless noted otherwise. |
| 1367 | "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. # Reference to the buyer on the proposal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| 1368 | "accountId": "A String", # Authorized Buyers account ID of the buyer. |
| 1369 | }, |
| 1370 | "isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated. |
| 1371 | "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller). |
| 1372 | "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). |
| 1373 | }, |
| 1374 | "privateAuctionId": "A String", # Output only. Private auction ID if this proposal is a private auction proposal. |
| 1375 | "displayName": "A String", # The name for the proposal. |
| 1376 | "deals": [ # The deals associated with this proposal. For Private Auction proposals (whose deals have NonGuaranteedAuctionTerms), there will only be one deal. |
| 1377 | { # A deal represents a segment of inventory for displaying ads on. A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving. |
| 1378 | "dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned). |
| 1379 | "syndicationProduct": "A String", # The syndication product associated with the deal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| 1380 | "createTime": "A String", # Output only. The time of the deal creation. |
| 1381 | "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by buyer. |
| 1382 | "availableEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not required for Private Auction deals or Preferred Deals. |
| 1383 | "deliveryControl": { # Message contains details about how the deals will be paced. # The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. |
| 1384 | "frequencyCaps": [ # Output only. Specifies any frequency caps. |
| 1385 | { # Frequency cap. |
| 1386 | "numTimeUnits": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped. |
| 1387 | "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period. |
| 1388 | "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped. |
| 1389 | }, |
| 1390 | ], |
| 1391 | "creativeBlockingLevel": "A String", # Output only. Specified the creative blocking levels to be applied. |
| 1392 | "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced. |
| 1393 | }, |
| 1394 | "createProductId": "A String", # The product ID from which this deal was created. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| 1395 | "webPropertyCode": "A String", # The web property code for the seller copied over from the product. |
| 1396 | "proposalId": "A String", # Output only. ID of the proposal that this deal is part of. |
| 1397 | "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller). |
| 1398 | "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). |
| 1399 | }, |
| 1400 | "createProductRevision": "A String", # Optional revision number of the product that the deal was created from. If present on create, and the server `product_revision` has advanced sinced the passed-in `create_product_revision`, an `ABORTED` error will be returned. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| 1401 | "displayName": "A String", # The name of the deal. |
| 1402 | "targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared targeting entity is AND'd together. |
| 1403 | { # Advertisers can target different attributes of an ad slot. For example, they can choose to show ads only if the user is in the U.S. Such targeting criteria can be specified as part of Shared Targeting. |
| 1404 | "key": "A String", # The key representing the shared targeting criterion. Targeting criteria defined by Google ad servers will begin with GOOG_. Third parties may define their own keys. A list of permissible keys along with the acceptable values will be provided as part of the external documentation. |
| 1405 | "inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd together. |
| 1406 | { # A polymorphic targeting value used as part of Shared Targeting. |
| 1407 | "dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING. The definition of this targeting is derived from the structure used by Ad Manager. |
| 1408 | "dayParts": [ # A list of day part targeting criterion. |
| 1409 | { # Daypart targeting message that specifies if the ad can be shown only during certain parts of a day/week. |
| 1410 | "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # The ending time of the day for the ad to show (minute level granularity). The end time is exclusive. This field is not available for filtering in PQL queries. |
| 1411 | "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| 1412 | "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| 1413 | "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| 1414 | "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. |
| 1415 | }, |
| 1416 | "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # The starting time of day for the ad to show (minute level granularity). The start time is inclusive. This field is not available for filtering in PQL queries. |
| 1417 | "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| 1418 | "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| 1419 | "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| 1420 | "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. |
| 1421 | }, |
| 1422 | "dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days. |
| 1423 | }, |
| 1424 | ], |
| 1425 | "timeZoneType": "A String", # The timezone to use for interpreting the day part targeting. |
| 1426 | }, |
| 1427 | "longValue": "A String", # The long value to include/exclude. |
| 1428 | "stringValue": "A String", # The string value to include/exclude. |
| 1429 | "creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude. Filled in when key = GOOG_CREATIVE_SIZE |
| 1430 | "companionSizes": [ # For video creatives specifies the sizes of companion ads (if present). Companion sizes may be filled in only when creative_size_type = VIDEO |
| 1431 | { # Message depicting the size of the creative. The units of width and height depend on the type of the targeting. |
| 1432 | "height": 42, # The height of the creative. |
| 1433 | "width": 42, # The width of the creative |
| 1434 | }, |
| 1435 | ], |
| 1436 | "size": { # Message depicting the size of the creative. The units of width and height depend on the type of the targeting. # For regular or video creative size type, specifies the size of the creative |
| 1437 | "height": 42, # The height of the creative. |
| 1438 | "width": 42, # The width of the creative |
| 1439 | }, |
| 1440 | "nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value only if creative_size_type = CreativeSizeType.NATIVE. |
| 1441 | "allowedFormats": [ # What formats are allowed by the publisher. If this repeated field is empty then all formats are allowed. For example, if this field contains AllowedFormatType.AUDIO then the publisher only allows an audio ad (without any video). |
| 1442 | "A String", |
| 1443 | ], |
| 1444 | "creativeSizeType": "A String", # The creative size type. |
| 1445 | "skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if creative_size_type = CreativeSizeType.VIDEO. |
| 1446 | }, |
| 1447 | }, |
| 1448 | ], |
| 1449 | "exclusions": [ # The list of values to exclude from targeting. Each value is AND'd together. |
| 1450 | { # A polymorphic targeting value used as part of Shared Targeting. |
| 1451 | "dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING. The definition of this targeting is derived from the structure used by Ad Manager. |
| 1452 | "dayParts": [ # A list of day part targeting criterion. |
| 1453 | { # Daypart targeting message that specifies if the ad can be shown only during certain parts of a day/week. |
| 1454 | "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # The ending time of the day for the ad to show (minute level granularity). The end time is exclusive. This field is not available for filtering in PQL queries. |
| 1455 | "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| 1456 | "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| 1457 | "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| 1458 | "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. |
| 1459 | }, |
| 1460 | "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # The starting time of day for the ad to show (minute level granularity). The start time is inclusive. This field is not available for filtering in PQL queries. |
| 1461 | "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| 1462 | "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| 1463 | "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| 1464 | "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. |
| 1465 | }, |
| 1466 | "dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days. |
| 1467 | }, |
| 1468 | ], |
| 1469 | "timeZoneType": "A String", # The timezone to use for interpreting the day part targeting. |
| 1470 | }, |
| 1471 | "longValue": "A String", # The long value to include/exclude. |
| 1472 | "stringValue": "A String", # The string value to include/exclude. |
| 1473 | "creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude. Filled in when key = GOOG_CREATIVE_SIZE |
| 1474 | "companionSizes": [ # For video creatives specifies the sizes of companion ads (if present). Companion sizes may be filled in only when creative_size_type = VIDEO |
| 1475 | { # Message depicting the size of the creative. The units of width and height depend on the type of the targeting. |
| 1476 | "height": 42, # The height of the creative. |
| 1477 | "width": 42, # The width of the creative |
| 1478 | }, |
| 1479 | ], |
| 1480 | "size": { # Message depicting the size of the creative. The units of width and height depend on the type of the targeting. # For regular or video creative size type, specifies the size of the creative |
| 1481 | "height": 42, # The height of the creative. |
| 1482 | "width": 42, # The width of the creative |
| 1483 | }, |
| 1484 | "nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value only if creative_size_type = CreativeSizeType.NATIVE. |
| 1485 | "allowedFormats": [ # What formats are allowed by the publisher. If this repeated field is empty then all formats are allowed. For example, if this field contains AllowedFormatType.AUDIO then the publisher only allows an audio ad (without any video). |
| 1486 | "A String", |
| 1487 | ], |
| 1488 | "creativeSizeType": "A String", # The creative size type. |
| 1489 | "skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if creative_size_type = CreativeSizeType.VIDEO. |
| 1490 | }, |
| 1491 | }, |
| 1492 | ], |
| 1493 | }, |
| 1494 | ], |
| 1495 | "targeting": { # Targeting represents different criteria that can be used by advertisers to target ad inventory. For example, they can choose to target ad requests only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. # Output only. Specifies the subset of inventory targeted by the deal. |
| 1496 | "placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Placement targeting information, e.g., URL, mobile applications. |
| 1497 | "urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). For Private Auction and AdX Preferred Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded. |
| 1498 | "excludedUrls": [ # A list of URLs to be excluded. |
| 1499 | "A String", |
| 1500 | ], |
| 1501 | "targetedUrls": [ # A list of URLs to be included. |
| 1502 | "A String", |
| 1503 | ], |
| 1504 | }, |
| 1505 | "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages. |
| 1506 | "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Mobile application IDs are from App Store and Google Play Store. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in. |
| 1507 | "targetedAppIds": [ # A list of application IDs to be included. |
| 1508 | "A String", |
| 1509 | ], |
| 1510 | "excludedAppIds": [ # A list of application IDs to be excluded. |
| 1511 | "A String", |
| 1512 | ], |
| 1513 | }, |
| 1514 | }, |
| 1515 | }, |
| 1516 | "technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category. |
| 1517 | "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # IDs of device capabilities to be included/excluded. |
| 1518 | "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. |
| 1519 | "A String", |
| 1520 | ], |
| 1521 | "targetedCriteriaIds": [ # A list of numeric IDs to be included. |
| 1522 | "A String", |
| 1523 | ], |
| 1524 | }, |
| 1525 | "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # IDs of device categories to be included/excluded. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1526 | "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. |
| 1527 | "A String", |
| 1528 | ], |
| 1529 | "targetedCriteriaIds": [ # A list of numeric IDs to be included. |
| 1530 | "A String", |
| 1531 | ], |
| 1532 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1533 | "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1534 | "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # IDs of operating systems to be included/excluded. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1535 | "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. |
| 1536 | "A String", |
| 1537 | ], |
| 1538 | "targetedCriteriaIds": [ # A list of numeric IDs to be included. |
| 1539 | "A String", |
| 1540 | ], |
| 1541 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1542 | "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # IDs of operating system versions to be included/excluded. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1543 | "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. |
| 1544 | "A String", |
| 1545 | ], |
| 1546 | "targetedCriteriaIds": [ # A list of numeric IDs to be included. |
| 1547 | "A String", |
| 1548 | ], |
| 1549 | }, |
| 1550 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1551 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1552 | "videoTargeting": { # Represents targeting information about video. # Video targeting information. |
| 1553 | "excludedPositionTypes": [ # A list of video positions to be excluded. Position types can either be included or excluded (XOR). |
| 1554 | "A String", |
| 1555 | ], |
| 1556 | "targetedPositionTypes": [ # A list of video positions to be included. When the included list is present, the excluded list must be empty. When the excluded list is present, the included list must be empty. |
| 1557 | "A String", |
| 1558 | ], |
| 1559 | }, |
| 1560 | "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on an ad request. It only applies to Private Auction, AdX Preferred Deals and Auction Packages. This targeting does not apply to Programmatic Guaranteed and Preferred Deals in Ad Manager. # Inventory sizes to be included/excluded. |
| 1561 | "targetedInventorySizes": [ # A list of inventory sizes to be included. |
| 1562 | { # Represents size of a single ad slot, or a creative. |
| 1563 | "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 1564 | "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 1565 | "sizeType": "A String", # The size type of the ad slot. |
| 1566 | }, |
| 1567 | ], |
| 1568 | "excludedInventorySizes": [ # A list of inventory sizes to be excluded. |
| 1569 | { # Represents size of a single ad slot, or a creative. |
| 1570 | "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 1571 | "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 1572 | "sizeType": "A String", # The size type of the ad slot. |
| 1573 | }, |
| 1574 | ], |
| 1575 | }, |
| 1576 | "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # Geo criteria IDs to be included/excluded. |
| 1577 | "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. |
| 1578 | "A String", |
| 1579 | ], |
| 1580 | "targetedCriteriaIds": [ # A list of numeric IDs to be included. |
| 1581 | "A String", |
| 1582 | ], |
| 1583 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1584 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1585 | "externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is finalized. This is the deal ID that shows up in serving/reporting etc. |
| 1586 | "isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this deal. |
| 1587 | "creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ Preferred Deal in Ad Manager. This doesn't apply to Private Auction and AdX Preferred Deals. # Output only. Restricitions about the creatives associated with the deal (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals in Ad Manager. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1588 | "skippableAdType": "A String", # Skippable video ads allow viewers to skip ads after 5 seconds. |
| 1589 | "creativeSpecifications": [ |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1590 | { # Represents information for a creative that is associated with a Programmatic Guaranteed/Preferred Deal in Ad Manager. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1591 | "creativeCompanionSizes": [ # Companion sizes may be filled in only when this is a video creative. |
| 1592 | { # Represents size of a single ad slot, or a creative. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1593 | "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 1594 | "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1595 | "sizeType": "A String", # The size type of the ad slot. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1596 | }, |
| 1597 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1598 | "creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative. |
| 1599 | "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 1600 | "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 1601 | "sizeType": "A String", # The size type of the ad slot. |
| 1602 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1603 | }, |
| 1604 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1605 | "creativeFormat": "A String", # The format of the environment that the creatives will be displayed in. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1606 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1607 | "availableStartTime": "A String", # Optional proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (e.g., in milliseconds) will be truncated towards the start of time in seconds. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1608 | "sellerContacts": [ # Output only. Seller contact information for the deal. |
| 1609 | { # Contains information on how a buyer or seller can be reached. |
| 1610 | "name": "A String", # The name of the contact. |
| 1611 | "email": "A String", # Email address for the contact. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1612 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1613 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1614 | "dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal. |
| 1615 | "dealPauseStatus": { # Tracks which parties (if any) have paused a deal. The deal is considered paused if either hasBuyerPaused or hasSellPaused is true. # Output only. Tracks which parties (if any) have paused a deal. |
| 1616 | "buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal. |
| 1617 | "hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally. |
| 1618 | "sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal. |
| 1619 | "hasBuyerPaused": True or False, # True, if the buyer has paused the deal unilaterally. |
| 1620 | "firstPausedBy": "A String", # The role of the person who first paused this deal. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1621 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1622 | }, |
| 1623 | "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy. |
| 1624 | "updateTime": "A String", # Output only. The time when the deal was last updated. |
| 1625 | "dealTerms": { # The deal terms specify the details of a Product/deal. They specify things like price per buyer, the type of pricing model (e.g., fixed price, auction) and expected impressions from the publisher. # The negotiable terms of the deal. |
| 1626 | "nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via the API at this time, but can be returned in a get or list request. # The terms for non-guaranteed fixed price deals. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1627 | "fixedPrices": [ # Fixed price for the specified buyer. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1628 | { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in a product can become 0 or 1 deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set. |
| 1629 | "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1630 | "accountId": "A String", # Authorized Buyers account ID of the buyer. |
| 1631 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1632 | "advertiserIds": [ # The list of advertisers for this price when associated with this buyer. If empty, all advertisers with this buyer pay this price. |
| 1633 | "A String", |
| 1634 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1635 | "price": { # Represents a price and a pricing type for a product / deal. # The specified price. |
| 1636 | "pricingType": "A String", # The pricing type for the deal/product. (default: CPM) |
| 1637 | "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1638 | "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 1639 | "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1640 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 1641 | }, |
| 1642 | }, |
| 1643 | }, |
| 1644 | ], |
| 1645 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1646 | "description": "A String", # Publisher provided description for the terms. |
| 1647 | "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day. Can be set by buyer or seller. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1648 | "guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1649 | "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1650 | "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product. |
| 1651 | "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. |
| 1652 | "fixedPrices": [ # Fixed price for the specified buyer. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1653 | { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in a product can become 0 or 1 deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set. |
| 1654 | "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1655 | "accountId": "A String", # Authorized Buyers account ID of the buyer. |
| 1656 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1657 | "advertiserIds": [ # The list of advertisers for this price when associated with this buyer. If empty, all advertisers with this buyer pay this price. |
| 1658 | "A String", |
| 1659 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1660 | "price": { # Represents a price and a pricing type for a product / deal. # The specified price. |
| 1661 | "pricingType": "A String", # The pricing type for the deal/product. (default: CPM) |
| 1662 | "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1663 | "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 1664 | "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1665 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 1666 | }, |
| 1667 | }, |
| 1668 | }, |
| 1669 | ], |
| 1670 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1671 | "sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the time zone used to mark the boundaries of a day. It should be an IANA TZ name, such as "America/Los_Angeles". For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. |
| 1672 | "estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal. Can be set by buyer or seller. |
| 1673 | "pricingType": "A String", # The pricing type for the deal/product. (default: CPM) |
| 1674 | "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified. |
| 1675 | "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 1676 | "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 1677 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 1678 | }, |
| 1679 | }, |
| 1680 | "nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only by the seller, but they can be returned in a get or list request. # The terms for non-guaranteed auction deals. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1681 | "reservePricesPerBuyer": [ # Reserve price for the specified buyer. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1682 | { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in a product can become 0 or 1 deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set. |
| 1683 | "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1684 | "accountId": "A String", # Authorized Buyers account ID of the buyer. |
| 1685 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1686 | "advertiserIds": [ # The list of advertisers for this price when associated with this buyer. If empty, all advertisers with this buyer pay this price. |
| 1687 | "A String", |
| 1688 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1689 | "price": { # Represents a price and a pricing type for a product / deal. # The specified price. |
| 1690 | "pricingType": "A String", # The pricing type for the deal/product. (default: CPM) |
| 1691 | "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1692 | "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 1693 | "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1694 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 1695 | }, |
| 1696 | }, |
| 1697 | }, |
| 1698 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1699 | "autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers in this private auction. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1700 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1701 | "brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED) |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1702 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1703 | "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible. |
| 1704 | "description": "A String", # Description for the deal terms. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1705 | }, |
| 1706 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1707 | "sellerContacts": [ # Output only. Contact information for the seller. |
| 1708 | { # Contains information on how a buyer or seller can be reached. |
| 1709 | "name": "A String", # The name of the contact. |
| 1710 | "email": "A String", # Email address for the contact. |
| 1711 | }, |
| 1712 | ], |
| 1713 | "billedBuyer": { # Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. # Output only. Reference to the buyer that will get billed for this proposal. |
| 1714 | "accountId": "A String", # Authorized Buyers account ID of the buyer. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1715 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1716 | "proposalState": "A String", # Output only. The current state of the proposal. |
| 1717 | "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or left a comment. |
| 1718 | "seller": { # Represents a seller of inventory. Each seller is identified by a unique Ad Manager account ID. # Reference to the seller on the proposal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| 1719 | "accountId": "A String", # The unique ID for the seller. The seller fills in this field. The seller account ID is then available to buyer in the product. |
| 1720 | "subAccountId": "A String", # Optional sub-account ID for the seller. |
| 1721 | }, |
| 1722 | "proposalId": "A String", # Output only. The unique ID of the proposal. |
| 1723 | "notes": [ # Output only. The notes associated with this proposal. |
| 1724 | { # A proposal may be associated to several notes. |
| 1725 | "proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created. |
| 1726 | "creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note. |
| 1727 | "note": "A String", # The actual note to attach. (max-length: 1024 unicode code units) Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| 1728 | "noteId": "A String", # Output only. The unique ID for the note. |
| 1729 | "createTime": "A String", # Output only. The timestamp for when this note was created. |
| 1730 | }, |
| 1731 | ], |
| 1732 | "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal. |
| 1733 | "updateTime": "A String", # Output only. The time when the proposal was last revised. |
| 1734 | "isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this proposal. |
| 1735 | "proposalRevision": "A String", # Output only. The revision number for the proposal. Each update to the proposal or the deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1736 | "buyerContacts": [ # Contact information for the buyer. |
| 1737 | { # Contains information on how a buyer or seller can be reached. |
| 1738 | "name": "A String", # The name of the contact. |
| 1739 | "email": "A String", # Email address for the contact. |
| 1740 | }, |
| 1741 | ], |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1742 | } |
| 1743 | |
| 1744 | x__xgafv: string, V1 error format. |
| 1745 | Allowed values |
| 1746 | 1 - v1 error format |
| 1747 | 2 - v2 error format |
| 1748 | |
| 1749 | Returns: |
| 1750 | An object of the form: |
| 1751 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1752 | { # Note: this resource requires whitelisting for access. Please contact your account manager for access to Marketplace resources. Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer and contains deals which are served. Note: you can not update, create, or otherwise modify Private Auction or Preferred Deals deals through the API. Fields are updatable unless noted otherwise. |
| 1753 | "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. # Reference to the buyer on the proposal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| 1754 | "accountId": "A String", # Authorized Buyers account ID of the buyer. |
| 1755 | }, |
| 1756 | "isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated. |
| 1757 | "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller). |
| 1758 | "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). |
| 1759 | }, |
| 1760 | "privateAuctionId": "A String", # Output only. Private auction ID if this proposal is a private auction proposal. |
| 1761 | "displayName": "A String", # The name for the proposal. |
| 1762 | "deals": [ # The deals associated with this proposal. For Private Auction proposals (whose deals have NonGuaranteedAuctionTerms), there will only be one deal. |
| 1763 | { # A deal represents a segment of inventory for displaying ads on. A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving. |
| 1764 | "dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned). |
| 1765 | "syndicationProduct": "A String", # The syndication product associated with the deal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| 1766 | "createTime": "A String", # Output only. The time of the deal creation. |
| 1767 | "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by buyer. |
| 1768 | "availableEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not required for Private Auction deals or Preferred Deals. |
| 1769 | "deliveryControl": { # Message contains details about how the deals will be paced. # The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. |
| 1770 | "frequencyCaps": [ # Output only. Specifies any frequency caps. |
| 1771 | { # Frequency cap. |
| 1772 | "numTimeUnits": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped. |
| 1773 | "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period. |
| 1774 | "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped. |
| 1775 | }, |
| 1776 | ], |
| 1777 | "creativeBlockingLevel": "A String", # Output only. Specified the creative blocking levels to be applied. |
| 1778 | "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced. |
| 1779 | }, |
| 1780 | "createProductId": "A String", # The product ID from which this deal was created. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| 1781 | "webPropertyCode": "A String", # The web property code for the seller copied over from the product. |
| 1782 | "proposalId": "A String", # Output only. ID of the proposal that this deal is part of. |
| 1783 | "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller). |
| 1784 | "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). |
| 1785 | }, |
| 1786 | "createProductRevision": "A String", # Optional revision number of the product that the deal was created from. If present on create, and the server `product_revision` has advanced sinced the passed-in `create_product_revision`, an `ABORTED` error will be returned. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1787 | "displayName": "A String", # The name of the deal. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1788 | "targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared targeting entity is AND'd together. |
| 1789 | { # Advertisers can target different attributes of an ad slot. For example, they can choose to show ads only if the user is in the U.S. Such targeting criteria can be specified as part of Shared Targeting. |
| 1790 | "key": "A String", # The key representing the shared targeting criterion. Targeting criteria defined by Google ad servers will begin with GOOG_. Third parties may define their own keys. A list of permissible keys along with the acceptable values will be provided as part of the external documentation. |
| 1791 | "inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd together. |
| 1792 | { # A polymorphic targeting value used as part of Shared Targeting. |
| 1793 | "dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING. The definition of this targeting is derived from the structure used by Ad Manager. |
| 1794 | "dayParts": [ # A list of day part targeting criterion. |
| 1795 | { # Daypart targeting message that specifies if the ad can be shown only during certain parts of a day/week. |
| 1796 | "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # The ending time of the day for the ad to show (minute level granularity). The end time is exclusive. This field is not available for filtering in PQL queries. |
| 1797 | "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| 1798 | "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| 1799 | "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| 1800 | "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. |
| 1801 | }, |
| 1802 | "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # The starting time of day for the ad to show (minute level granularity). The start time is inclusive. This field is not available for filtering in PQL queries. |
| 1803 | "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| 1804 | "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| 1805 | "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| 1806 | "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. |
| 1807 | }, |
| 1808 | "dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days. |
| 1809 | }, |
| 1810 | ], |
| 1811 | "timeZoneType": "A String", # The timezone to use for interpreting the day part targeting. |
| 1812 | }, |
| 1813 | "longValue": "A String", # The long value to include/exclude. |
| 1814 | "stringValue": "A String", # The string value to include/exclude. |
| 1815 | "creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude. Filled in when key = GOOG_CREATIVE_SIZE |
| 1816 | "companionSizes": [ # For video creatives specifies the sizes of companion ads (if present). Companion sizes may be filled in only when creative_size_type = VIDEO |
| 1817 | { # Message depicting the size of the creative. The units of width and height depend on the type of the targeting. |
| 1818 | "height": 42, # The height of the creative. |
| 1819 | "width": 42, # The width of the creative |
| 1820 | }, |
| 1821 | ], |
| 1822 | "size": { # Message depicting the size of the creative. The units of width and height depend on the type of the targeting. # For regular or video creative size type, specifies the size of the creative |
| 1823 | "height": 42, # The height of the creative. |
| 1824 | "width": 42, # The width of the creative |
| 1825 | }, |
| 1826 | "nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value only if creative_size_type = CreativeSizeType.NATIVE. |
| 1827 | "allowedFormats": [ # What formats are allowed by the publisher. If this repeated field is empty then all formats are allowed. For example, if this field contains AllowedFormatType.AUDIO then the publisher only allows an audio ad (without any video). |
| 1828 | "A String", |
| 1829 | ], |
| 1830 | "creativeSizeType": "A String", # The creative size type. |
| 1831 | "skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if creative_size_type = CreativeSizeType.VIDEO. |
| 1832 | }, |
| 1833 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1834 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1835 | "exclusions": [ # The list of values to exclude from targeting. Each value is AND'd together. |
| 1836 | { # A polymorphic targeting value used as part of Shared Targeting. |
| 1837 | "dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING. The definition of this targeting is derived from the structure used by Ad Manager. |
| 1838 | "dayParts": [ # A list of day part targeting criterion. |
| 1839 | { # Daypart targeting message that specifies if the ad can be shown only during certain parts of a day/week. |
| 1840 | "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # The ending time of the day for the ad to show (minute level granularity). The end time is exclusive. This field is not available for filtering in PQL queries. |
| 1841 | "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| 1842 | "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| 1843 | "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| 1844 | "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. |
| 1845 | }, |
| 1846 | "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # The starting time of day for the ad to show (minute level granularity). The start time is inclusive. This field is not available for filtering in PQL queries. |
| 1847 | "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| 1848 | "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| 1849 | "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| 1850 | "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. |
| 1851 | }, |
| 1852 | "dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days. |
| 1853 | }, |
| 1854 | ], |
| 1855 | "timeZoneType": "A String", # The timezone to use for interpreting the day part targeting. |
| 1856 | }, |
| 1857 | "longValue": "A String", # The long value to include/exclude. |
| 1858 | "stringValue": "A String", # The string value to include/exclude. |
| 1859 | "creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude. Filled in when key = GOOG_CREATIVE_SIZE |
| 1860 | "companionSizes": [ # For video creatives specifies the sizes of companion ads (if present). Companion sizes may be filled in only when creative_size_type = VIDEO |
| 1861 | { # Message depicting the size of the creative. The units of width and height depend on the type of the targeting. |
| 1862 | "height": 42, # The height of the creative. |
| 1863 | "width": 42, # The width of the creative |
| 1864 | }, |
| 1865 | ], |
| 1866 | "size": { # Message depicting the size of the creative. The units of width and height depend on the type of the targeting. # For regular or video creative size type, specifies the size of the creative |
| 1867 | "height": 42, # The height of the creative. |
| 1868 | "width": 42, # The width of the creative |
| 1869 | }, |
| 1870 | "nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value only if creative_size_type = CreativeSizeType.NATIVE. |
| 1871 | "allowedFormats": [ # What formats are allowed by the publisher. If this repeated field is empty then all formats are allowed. For example, if this field contains AllowedFormatType.AUDIO then the publisher only allows an audio ad (without any video). |
| 1872 | "A String", |
| 1873 | ], |
| 1874 | "creativeSizeType": "A String", # The creative size type. |
| 1875 | "skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if creative_size_type = CreativeSizeType.VIDEO. |
| 1876 | }, |
| 1877 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1878 | ], |
| 1879 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1880 | ], |
| 1881 | "targeting": { # Targeting represents different criteria that can be used by advertisers to target ad inventory. For example, they can choose to target ad requests only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. # Output only. Specifies the subset of inventory targeted by the deal. |
| 1882 | "placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Placement targeting information, e.g., URL, mobile applications. |
| 1883 | "urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). For Private Auction and AdX Preferred Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1884 | "excludedUrls": [ # A list of URLs to be excluded. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1885 | "A String", |
| 1886 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1887 | "targetedUrls": [ # A list of URLs to be included. |
| 1888 | "A String", |
| 1889 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1890 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1891 | "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages. |
| 1892 | "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Mobile application IDs are from App Store and Google Play Store. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1893 | "targetedAppIds": [ # A list of application IDs to be included. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1894 | "A String", |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1895 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1896 | "excludedAppIds": [ # A list of application IDs to be excluded. |
| 1897 | "A String", |
| 1898 | ], |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1899 | }, |
| 1900 | }, |
| 1901 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1902 | "technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1903 | "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # IDs of device capabilities to be included/excluded. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1904 | "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. |
| 1905 | "A String", |
| 1906 | ], |
| 1907 | "targetedCriteriaIds": [ # A list of numeric IDs to be included. |
| 1908 | "A String", |
| 1909 | ], |
| 1910 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1911 | "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # IDs of device categories to be included/excluded. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1912 | "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. |
| 1913 | "A String", |
| 1914 | ], |
| 1915 | "targetedCriteriaIds": [ # A list of numeric IDs to be included. |
| 1916 | "A String", |
| 1917 | ], |
| 1918 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1919 | "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1920 | "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # IDs of operating systems to be included/excluded. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1921 | "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. |
| 1922 | "A String", |
| 1923 | ], |
| 1924 | "targetedCriteriaIds": [ # A list of numeric IDs to be included. |
| 1925 | "A String", |
| 1926 | ], |
| 1927 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1928 | "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # IDs of operating system versions to be included/excluded. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1929 | "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. |
| 1930 | "A String", |
| 1931 | ], |
| 1932 | "targetedCriteriaIds": [ # A list of numeric IDs to be included. |
| 1933 | "A String", |
| 1934 | ], |
| 1935 | }, |
| 1936 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1937 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1938 | "videoTargeting": { # Represents targeting information about video. # Video targeting information. |
| 1939 | "excludedPositionTypes": [ # A list of video positions to be excluded. Position types can either be included or excluded (XOR). |
| 1940 | "A String", |
| 1941 | ], |
| 1942 | "targetedPositionTypes": [ # A list of video positions to be included. When the included list is present, the excluded list must be empty. When the excluded list is present, the included list must be empty. |
| 1943 | "A String", |
| 1944 | ], |
| 1945 | }, |
| 1946 | "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on an ad request. It only applies to Private Auction, AdX Preferred Deals and Auction Packages. This targeting does not apply to Programmatic Guaranteed and Preferred Deals in Ad Manager. # Inventory sizes to be included/excluded. |
| 1947 | "targetedInventorySizes": [ # A list of inventory sizes to be included. |
| 1948 | { # Represents size of a single ad slot, or a creative. |
| 1949 | "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 1950 | "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 1951 | "sizeType": "A String", # The size type of the ad slot. |
| 1952 | }, |
| 1953 | ], |
| 1954 | "excludedInventorySizes": [ # A list of inventory sizes to be excluded. |
| 1955 | { # Represents size of a single ad slot, or a creative. |
| 1956 | "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 1957 | "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 1958 | "sizeType": "A String", # The size type of the ad slot. |
| 1959 | }, |
| 1960 | ], |
| 1961 | }, |
| 1962 | "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # Geo criteria IDs to be included/excluded. |
| 1963 | "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. |
| 1964 | "A String", |
| 1965 | ], |
| 1966 | "targetedCriteriaIds": [ # A list of numeric IDs to be included. |
| 1967 | "A String", |
| 1968 | ], |
| 1969 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1970 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1971 | "externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is finalized. This is the deal ID that shows up in serving/reporting etc. |
| 1972 | "isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this deal. |
| 1973 | "creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ Preferred Deal in Ad Manager. This doesn't apply to Private Auction and AdX Preferred Deals. # Output only. Restricitions about the creatives associated with the deal (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals in Ad Manager. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1974 | "skippableAdType": "A String", # Skippable video ads allow viewers to skip ads after 5 seconds. |
| 1975 | "creativeSpecifications": [ |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1976 | { # Represents information for a creative that is associated with a Programmatic Guaranteed/Preferred Deal in Ad Manager. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1977 | "creativeCompanionSizes": [ # Companion sizes may be filled in only when this is a video creative. |
| 1978 | { # Represents size of a single ad slot, or a creative. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1979 | "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 1980 | "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1981 | "sizeType": "A String", # The size type of the ad slot. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1982 | }, |
| 1983 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1984 | "creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative. |
| 1985 | "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 1986 | "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 1987 | "sizeType": "A String", # The size type of the ad slot. |
| 1988 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1989 | }, |
| 1990 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1991 | "creativeFormat": "A String", # The format of the environment that the creatives will be displayed in. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1992 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1993 | "availableStartTime": "A String", # Optional proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (e.g., in milliseconds) will be truncated towards the start of time in seconds. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1994 | "sellerContacts": [ # Output only. Seller contact information for the deal. |
| 1995 | { # Contains information on how a buyer or seller can be reached. |
| 1996 | "name": "A String", # The name of the contact. |
| 1997 | "email": "A String", # Email address for the contact. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1998 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1999 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2000 | "dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal. |
| 2001 | "dealPauseStatus": { # Tracks which parties (if any) have paused a deal. The deal is considered paused if either hasBuyerPaused or hasSellPaused is true. # Output only. Tracks which parties (if any) have paused a deal. |
| 2002 | "buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal. |
| 2003 | "hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally. |
| 2004 | "sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal. |
| 2005 | "hasBuyerPaused": True or False, # True, if the buyer has paused the deal unilaterally. |
| 2006 | "firstPausedBy": "A String", # The role of the person who first paused this deal. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2007 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2008 | }, |
| 2009 | "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy. |
| 2010 | "updateTime": "A String", # Output only. The time when the deal was last updated. |
| 2011 | "dealTerms": { # The deal terms specify the details of a Product/deal. They specify things like price per buyer, the type of pricing model (e.g., fixed price, auction) and expected impressions from the publisher. # The negotiable terms of the deal. |
| 2012 | "nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via the API at this time, but can be returned in a get or list request. # The terms for non-guaranteed fixed price deals. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2013 | "fixedPrices": [ # Fixed price for the specified buyer. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2014 | { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in a product can become 0 or 1 deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set. |
| 2015 | "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2016 | "accountId": "A String", # Authorized Buyers account ID of the buyer. |
| 2017 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2018 | "advertiserIds": [ # The list of advertisers for this price when associated with this buyer. If empty, all advertisers with this buyer pay this price. |
| 2019 | "A String", |
| 2020 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2021 | "price": { # Represents a price and a pricing type for a product / deal. # The specified price. |
| 2022 | "pricingType": "A String", # The pricing type for the deal/product. (default: CPM) |
| 2023 | "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2024 | "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 2025 | "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2026 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 2027 | }, |
| 2028 | }, |
| 2029 | }, |
| 2030 | ], |
| 2031 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2032 | "description": "A String", # Publisher provided description for the terms. |
| 2033 | "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day. Can be set by buyer or seller. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2034 | "guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2035 | "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2036 | "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product. |
| 2037 | "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. |
| 2038 | "fixedPrices": [ # Fixed price for the specified buyer. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2039 | { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in a product can become 0 or 1 deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set. |
| 2040 | "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2041 | "accountId": "A String", # Authorized Buyers account ID of the buyer. |
| 2042 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2043 | "advertiserIds": [ # The list of advertisers for this price when associated with this buyer. If empty, all advertisers with this buyer pay this price. |
| 2044 | "A String", |
| 2045 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2046 | "price": { # Represents a price and a pricing type for a product / deal. # The specified price. |
| 2047 | "pricingType": "A String", # The pricing type for the deal/product. (default: CPM) |
| 2048 | "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2049 | "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 2050 | "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2051 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 2052 | }, |
| 2053 | }, |
| 2054 | }, |
| 2055 | ], |
| 2056 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2057 | "sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the time zone used to mark the boundaries of a day. It should be an IANA TZ name, such as "America/Los_Angeles". For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. |
| 2058 | "estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal. Can be set by buyer or seller. |
| 2059 | "pricingType": "A String", # The pricing type for the deal/product. (default: CPM) |
| 2060 | "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified. |
| 2061 | "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 2062 | "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 2063 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 2064 | }, |
| 2065 | }, |
| 2066 | "nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only by the seller, but they can be returned in a get or list request. # The terms for non-guaranteed auction deals. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2067 | "reservePricesPerBuyer": [ # Reserve price for the specified buyer. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2068 | { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in a product can become 0 or 1 deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set. |
| 2069 | "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2070 | "accountId": "A String", # Authorized Buyers account ID of the buyer. |
| 2071 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2072 | "advertiserIds": [ # The list of advertisers for this price when associated with this buyer. If empty, all advertisers with this buyer pay this price. |
| 2073 | "A String", |
| 2074 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2075 | "price": { # Represents a price and a pricing type for a product / deal. # The specified price. |
| 2076 | "pricingType": "A String", # The pricing type for the deal/product. (default: CPM) |
| 2077 | "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2078 | "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 2079 | "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2080 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 2081 | }, |
| 2082 | }, |
| 2083 | }, |
| 2084 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2085 | "autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers in this private auction. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2086 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2087 | "brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED) |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2088 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2089 | "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible. |
| 2090 | "description": "A String", # Description for the deal terms. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2091 | }, |
| 2092 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2093 | "sellerContacts": [ # Output only. Contact information for the seller. |
| 2094 | { # Contains information on how a buyer or seller can be reached. |
| 2095 | "name": "A String", # The name of the contact. |
| 2096 | "email": "A String", # Email address for the contact. |
| 2097 | }, |
| 2098 | ], |
| 2099 | "billedBuyer": { # Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. # Output only. Reference to the buyer that will get billed for this proposal. |
| 2100 | "accountId": "A String", # Authorized Buyers account ID of the buyer. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2101 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2102 | "proposalState": "A String", # Output only. The current state of the proposal. |
| 2103 | "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or left a comment. |
| 2104 | "seller": { # Represents a seller of inventory. Each seller is identified by a unique Ad Manager account ID. # Reference to the seller on the proposal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| 2105 | "accountId": "A String", # The unique ID for the seller. The seller fills in this field. The seller account ID is then available to buyer in the product. |
| 2106 | "subAccountId": "A String", # Optional sub-account ID for the seller. |
| 2107 | }, |
| 2108 | "proposalId": "A String", # Output only. The unique ID of the proposal. |
| 2109 | "notes": [ # Output only. The notes associated with this proposal. |
| 2110 | { # A proposal may be associated to several notes. |
| 2111 | "proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created. |
| 2112 | "creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note. |
| 2113 | "note": "A String", # The actual note to attach. (max-length: 1024 unicode code units) Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| 2114 | "noteId": "A String", # Output only. The unique ID for the note. |
| 2115 | "createTime": "A String", # Output only. The timestamp for when this note was created. |
| 2116 | }, |
| 2117 | ], |
| 2118 | "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal. |
| 2119 | "updateTime": "A String", # Output only. The time when the proposal was last revised. |
| 2120 | "isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this proposal. |
| 2121 | "proposalRevision": "A String", # Output only. The revision number for the proposal. Each update to the proposal or the deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2122 | "buyerContacts": [ # Contact information for the buyer. |
| 2123 | { # Contains information on how a buyer or seller can be reached. |
| 2124 | "name": "A String", # The name of the contact. |
| 2125 | "email": "A String", # Email address for the contact. |
| 2126 | }, |
| 2127 | ], |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2128 | }</pre> |
| 2129 | </div> |
| 2130 | |
| 2131 | <div class="method"> |
| 2132 | <code class="details" id="get">get(accountId, proposalId, x__xgafv=None)</code> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2133 | <pre>Gets a proposal given its ID. The proposal is returned at its head revision. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2134 | |
| 2135 | Args: |
| 2136 | accountId: string, Account ID of the buyer. (required) |
| 2137 | proposalId: string, The unique ID of the proposal (required) |
| 2138 | x__xgafv: string, V1 error format. |
| 2139 | Allowed values |
| 2140 | 1 - v1 error format |
| 2141 | 2 - v2 error format |
| 2142 | |
| 2143 | Returns: |
| 2144 | An object of the form: |
| 2145 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2146 | { # Note: this resource requires whitelisting for access. Please contact your account manager for access to Marketplace resources. Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer and contains deals which are served. Note: you can not update, create, or otherwise modify Private Auction or Preferred Deals deals through the API. Fields are updatable unless noted otherwise. |
| 2147 | "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. # Reference to the buyer on the proposal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| 2148 | "accountId": "A String", # Authorized Buyers account ID of the buyer. |
| 2149 | }, |
| 2150 | "isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated. |
| 2151 | "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller). |
| 2152 | "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). |
| 2153 | }, |
| 2154 | "privateAuctionId": "A String", # Output only. Private auction ID if this proposal is a private auction proposal. |
| 2155 | "displayName": "A String", # The name for the proposal. |
| 2156 | "deals": [ # The deals associated with this proposal. For Private Auction proposals (whose deals have NonGuaranteedAuctionTerms), there will only be one deal. |
| 2157 | { # A deal represents a segment of inventory for displaying ads on. A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving. |
| 2158 | "dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned). |
| 2159 | "syndicationProduct": "A String", # The syndication product associated with the deal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| 2160 | "createTime": "A String", # Output only. The time of the deal creation. |
| 2161 | "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by buyer. |
| 2162 | "availableEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not required for Private Auction deals or Preferred Deals. |
| 2163 | "deliveryControl": { # Message contains details about how the deals will be paced. # The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. |
| 2164 | "frequencyCaps": [ # Output only. Specifies any frequency caps. |
| 2165 | { # Frequency cap. |
| 2166 | "numTimeUnits": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped. |
| 2167 | "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period. |
| 2168 | "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped. |
| 2169 | }, |
| 2170 | ], |
| 2171 | "creativeBlockingLevel": "A String", # Output only. Specified the creative blocking levels to be applied. |
| 2172 | "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced. |
| 2173 | }, |
| 2174 | "createProductId": "A String", # The product ID from which this deal was created. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| 2175 | "webPropertyCode": "A String", # The web property code for the seller copied over from the product. |
| 2176 | "proposalId": "A String", # Output only. ID of the proposal that this deal is part of. |
| 2177 | "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller). |
| 2178 | "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). |
| 2179 | }, |
| 2180 | "createProductRevision": "A String", # Optional revision number of the product that the deal was created from. If present on create, and the server `product_revision` has advanced sinced the passed-in `create_product_revision`, an `ABORTED` error will be returned. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2181 | "displayName": "A String", # The name of the deal. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2182 | "targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared targeting entity is AND'd together. |
| 2183 | { # Advertisers can target different attributes of an ad slot. For example, they can choose to show ads only if the user is in the U.S. Such targeting criteria can be specified as part of Shared Targeting. |
| 2184 | "key": "A String", # The key representing the shared targeting criterion. Targeting criteria defined by Google ad servers will begin with GOOG_. Third parties may define their own keys. A list of permissible keys along with the acceptable values will be provided as part of the external documentation. |
| 2185 | "inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd together. |
| 2186 | { # A polymorphic targeting value used as part of Shared Targeting. |
| 2187 | "dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING. The definition of this targeting is derived from the structure used by Ad Manager. |
| 2188 | "dayParts": [ # A list of day part targeting criterion. |
| 2189 | { # Daypart targeting message that specifies if the ad can be shown only during certain parts of a day/week. |
| 2190 | "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # The ending time of the day for the ad to show (minute level granularity). The end time is exclusive. This field is not available for filtering in PQL queries. |
| 2191 | "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| 2192 | "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| 2193 | "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| 2194 | "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. |
| 2195 | }, |
| 2196 | "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # The starting time of day for the ad to show (minute level granularity). The start time is inclusive. This field is not available for filtering in PQL queries. |
| 2197 | "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| 2198 | "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| 2199 | "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| 2200 | "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. |
| 2201 | }, |
| 2202 | "dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days. |
| 2203 | }, |
| 2204 | ], |
| 2205 | "timeZoneType": "A String", # The timezone to use for interpreting the day part targeting. |
| 2206 | }, |
| 2207 | "longValue": "A String", # The long value to include/exclude. |
| 2208 | "stringValue": "A String", # The string value to include/exclude. |
| 2209 | "creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude. Filled in when key = GOOG_CREATIVE_SIZE |
| 2210 | "companionSizes": [ # For video creatives specifies the sizes of companion ads (if present). Companion sizes may be filled in only when creative_size_type = VIDEO |
| 2211 | { # Message depicting the size of the creative. The units of width and height depend on the type of the targeting. |
| 2212 | "height": 42, # The height of the creative. |
| 2213 | "width": 42, # The width of the creative |
| 2214 | }, |
| 2215 | ], |
| 2216 | "size": { # Message depicting the size of the creative. The units of width and height depend on the type of the targeting. # For regular or video creative size type, specifies the size of the creative |
| 2217 | "height": 42, # The height of the creative. |
| 2218 | "width": 42, # The width of the creative |
| 2219 | }, |
| 2220 | "nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value only if creative_size_type = CreativeSizeType.NATIVE. |
| 2221 | "allowedFormats": [ # What formats are allowed by the publisher. If this repeated field is empty then all formats are allowed. For example, if this field contains AllowedFormatType.AUDIO then the publisher only allows an audio ad (without any video). |
| 2222 | "A String", |
| 2223 | ], |
| 2224 | "creativeSizeType": "A String", # The creative size type. |
| 2225 | "skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if creative_size_type = CreativeSizeType.VIDEO. |
| 2226 | }, |
| 2227 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2228 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2229 | "exclusions": [ # The list of values to exclude from targeting. Each value is AND'd together. |
| 2230 | { # A polymorphic targeting value used as part of Shared Targeting. |
| 2231 | "dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING. The definition of this targeting is derived from the structure used by Ad Manager. |
| 2232 | "dayParts": [ # A list of day part targeting criterion. |
| 2233 | { # Daypart targeting message that specifies if the ad can be shown only during certain parts of a day/week. |
| 2234 | "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # The ending time of the day for the ad to show (minute level granularity). The end time is exclusive. This field is not available for filtering in PQL queries. |
| 2235 | "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| 2236 | "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| 2237 | "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| 2238 | "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. |
| 2239 | }, |
| 2240 | "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # The starting time of day for the ad to show (minute level granularity). The start time is inclusive. This field is not available for filtering in PQL queries. |
| 2241 | "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| 2242 | "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| 2243 | "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| 2244 | "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. |
| 2245 | }, |
| 2246 | "dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days. |
| 2247 | }, |
| 2248 | ], |
| 2249 | "timeZoneType": "A String", # The timezone to use for interpreting the day part targeting. |
| 2250 | }, |
| 2251 | "longValue": "A String", # The long value to include/exclude. |
| 2252 | "stringValue": "A String", # The string value to include/exclude. |
| 2253 | "creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude. Filled in when key = GOOG_CREATIVE_SIZE |
| 2254 | "companionSizes": [ # For video creatives specifies the sizes of companion ads (if present). Companion sizes may be filled in only when creative_size_type = VIDEO |
| 2255 | { # Message depicting the size of the creative. The units of width and height depend on the type of the targeting. |
| 2256 | "height": 42, # The height of the creative. |
| 2257 | "width": 42, # The width of the creative |
| 2258 | }, |
| 2259 | ], |
| 2260 | "size": { # Message depicting the size of the creative. The units of width and height depend on the type of the targeting. # For regular or video creative size type, specifies the size of the creative |
| 2261 | "height": 42, # The height of the creative. |
| 2262 | "width": 42, # The width of the creative |
| 2263 | }, |
| 2264 | "nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value only if creative_size_type = CreativeSizeType.NATIVE. |
| 2265 | "allowedFormats": [ # What formats are allowed by the publisher. If this repeated field is empty then all formats are allowed. For example, if this field contains AllowedFormatType.AUDIO then the publisher only allows an audio ad (without any video). |
| 2266 | "A String", |
| 2267 | ], |
| 2268 | "creativeSizeType": "A String", # The creative size type. |
| 2269 | "skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if creative_size_type = CreativeSizeType.VIDEO. |
| 2270 | }, |
| 2271 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2272 | ], |
| 2273 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2274 | ], |
| 2275 | "targeting": { # Targeting represents different criteria that can be used by advertisers to target ad inventory. For example, they can choose to target ad requests only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. # Output only. Specifies the subset of inventory targeted by the deal. |
| 2276 | "placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Placement targeting information, e.g., URL, mobile applications. |
| 2277 | "urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). For Private Auction and AdX Preferred Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2278 | "excludedUrls": [ # A list of URLs to be excluded. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2279 | "A String", |
| 2280 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2281 | "targetedUrls": [ # A list of URLs to be included. |
| 2282 | "A String", |
| 2283 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2284 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2285 | "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages. |
| 2286 | "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Mobile application IDs are from App Store and Google Play Store. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2287 | "targetedAppIds": [ # A list of application IDs to be included. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2288 | "A String", |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2289 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2290 | "excludedAppIds": [ # A list of application IDs to be excluded. |
| 2291 | "A String", |
| 2292 | ], |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2293 | }, |
| 2294 | }, |
| 2295 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2296 | "technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2297 | "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # IDs of device capabilities to be included/excluded. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2298 | "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. |
| 2299 | "A String", |
| 2300 | ], |
| 2301 | "targetedCriteriaIds": [ # A list of numeric IDs to be included. |
| 2302 | "A String", |
| 2303 | ], |
| 2304 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2305 | "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # IDs of device categories to be included/excluded. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2306 | "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. |
| 2307 | "A String", |
| 2308 | ], |
| 2309 | "targetedCriteriaIds": [ # A list of numeric IDs to be included. |
| 2310 | "A String", |
| 2311 | ], |
| 2312 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2313 | "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2314 | "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # IDs of operating systems to be included/excluded. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2315 | "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. |
| 2316 | "A String", |
| 2317 | ], |
| 2318 | "targetedCriteriaIds": [ # A list of numeric IDs to be included. |
| 2319 | "A String", |
| 2320 | ], |
| 2321 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2322 | "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # IDs of operating system versions to be included/excluded. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2323 | "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. |
| 2324 | "A String", |
| 2325 | ], |
| 2326 | "targetedCriteriaIds": [ # A list of numeric IDs to be included. |
| 2327 | "A String", |
| 2328 | ], |
| 2329 | }, |
| 2330 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2331 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2332 | "videoTargeting": { # Represents targeting information about video. # Video targeting information. |
| 2333 | "excludedPositionTypes": [ # A list of video positions to be excluded. Position types can either be included or excluded (XOR). |
| 2334 | "A String", |
| 2335 | ], |
| 2336 | "targetedPositionTypes": [ # A list of video positions to be included. When the included list is present, the excluded list must be empty. When the excluded list is present, the included list must be empty. |
| 2337 | "A String", |
| 2338 | ], |
| 2339 | }, |
| 2340 | "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on an ad request. It only applies to Private Auction, AdX Preferred Deals and Auction Packages. This targeting does not apply to Programmatic Guaranteed and Preferred Deals in Ad Manager. # Inventory sizes to be included/excluded. |
| 2341 | "targetedInventorySizes": [ # A list of inventory sizes to be included. |
| 2342 | { # Represents size of a single ad slot, or a creative. |
| 2343 | "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 2344 | "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 2345 | "sizeType": "A String", # The size type of the ad slot. |
| 2346 | }, |
| 2347 | ], |
| 2348 | "excludedInventorySizes": [ # A list of inventory sizes to be excluded. |
| 2349 | { # Represents size of a single ad slot, or a creative. |
| 2350 | "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 2351 | "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 2352 | "sizeType": "A String", # The size type of the ad slot. |
| 2353 | }, |
| 2354 | ], |
| 2355 | }, |
| 2356 | "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # Geo criteria IDs to be included/excluded. |
| 2357 | "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. |
| 2358 | "A String", |
| 2359 | ], |
| 2360 | "targetedCriteriaIds": [ # A list of numeric IDs to be included. |
| 2361 | "A String", |
| 2362 | ], |
| 2363 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2364 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2365 | "externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is finalized. This is the deal ID that shows up in serving/reporting etc. |
| 2366 | "isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this deal. |
| 2367 | "creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ Preferred Deal in Ad Manager. This doesn't apply to Private Auction and AdX Preferred Deals. # Output only. Restricitions about the creatives associated with the deal (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals in Ad Manager. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2368 | "skippableAdType": "A String", # Skippable video ads allow viewers to skip ads after 5 seconds. |
| 2369 | "creativeSpecifications": [ |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2370 | { # Represents information for a creative that is associated with a Programmatic Guaranteed/Preferred Deal in Ad Manager. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2371 | "creativeCompanionSizes": [ # Companion sizes may be filled in only when this is a video creative. |
| 2372 | { # Represents size of a single ad slot, or a creative. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2373 | "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 2374 | "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2375 | "sizeType": "A String", # The size type of the ad slot. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2376 | }, |
| 2377 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2378 | "creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative. |
| 2379 | "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 2380 | "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 2381 | "sizeType": "A String", # The size type of the ad slot. |
| 2382 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2383 | }, |
| 2384 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2385 | "creativeFormat": "A String", # The format of the environment that the creatives will be displayed in. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2386 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2387 | "availableStartTime": "A String", # Optional proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (e.g., in milliseconds) will be truncated towards the start of time in seconds. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2388 | "sellerContacts": [ # Output only. Seller contact information for the deal. |
| 2389 | { # Contains information on how a buyer or seller can be reached. |
| 2390 | "name": "A String", # The name of the contact. |
| 2391 | "email": "A String", # Email address for the contact. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2392 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2393 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2394 | "dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal. |
| 2395 | "dealPauseStatus": { # Tracks which parties (if any) have paused a deal. The deal is considered paused if either hasBuyerPaused or hasSellPaused is true. # Output only. Tracks which parties (if any) have paused a deal. |
| 2396 | "buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal. |
| 2397 | "hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally. |
| 2398 | "sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal. |
| 2399 | "hasBuyerPaused": True or False, # True, if the buyer has paused the deal unilaterally. |
| 2400 | "firstPausedBy": "A String", # The role of the person who first paused this deal. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2401 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2402 | }, |
| 2403 | "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy. |
| 2404 | "updateTime": "A String", # Output only. The time when the deal was last updated. |
| 2405 | "dealTerms": { # The deal terms specify the details of a Product/deal. They specify things like price per buyer, the type of pricing model (e.g., fixed price, auction) and expected impressions from the publisher. # The negotiable terms of the deal. |
| 2406 | "nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via the API at this time, but can be returned in a get or list request. # The terms for non-guaranteed fixed price deals. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2407 | "fixedPrices": [ # Fixed price for the specified buyer. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2408 | { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in a product can become 0 or 1 deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set. |
| 2409 | "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2410 | "accountId": "A String", # Authorized Buyers account ID of the buyer. |
| 2411 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2412 | "advertiserIds": [ # The list of advertisers for this price when associated with this buyer. If empty, all advertisers with this buyer pay this price. |
| 2413 | "A String", |
| 2414 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2415 | "price": { # Represents a price and a pricing type for a product / deal. # The specified price. |
| 2416 | "pricingType": "A String", # The pricing type for the deal/product. (default: CPM) |
| 2417 | "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2418 | "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 2419 | "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2420 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 2421 | }, |
| 2422 | }, |
| 2423 | }, |
| 2424 | ], |
| 2425 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2426 | "description": "A String", # Publisher provided description for the terms. |
| 2427 | "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day. Can be set by buyer or seller. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2428 | "guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2429 | "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2430 | "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product. |
| 2431 | "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. |
| 2432 | "fixedPrices": [ # Fixed price for the specified buyer. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2433 | { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in a product can become 0 or 1 deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set. |
| 2434 | "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2435 | "accountId": "A String", # Authorized Buyers account ID of the buyer. |
| 2436 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2437 | "advertiserIds": [ # The list of advertisers for this price when associated with this buyer. If empty, all advertisers with this buyer pay this price. |
| 2438 | "A String", |
| 2439 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2440 | "price": { # Represents a price and a pricing type for a product / deal. # The specified price. |
| 2441 | "pricingType": "A String", # The pricing type for the deal/product. (default: CPM) |
| 2442 | "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2443 | "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 2444 | "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2445 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 2446 | }, |
| 2447 | }, |
| 2448 | }, |
| 2449 | ], |
| 2450 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2451 | "sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the time zone used to mark the boundaries of a day. It should be an IANA TZ name, such as "America/Los_Angeles". For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. |
| 2452 | "estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal. Can be set by buyer or seller. |
| 2453 | "pricingType": "A String", # The pricing type for the deal/product. (default: CPM) |
| 2454 | "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified. |
| 2455 | "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 2456 | "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 2457 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 2458 | }, |
| 2459 | }, |
| 2460 | "nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only by the seller, but they can be returned in a get or list request. # The terms for non-guaranteed auction deals. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2461 | "reservePricesPerBuyer": [ # Reserve price for the specified buyer. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2462 | { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in a product can become 0 or 1 deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set. |
| 2463 | "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2464 | "accountId": "A String", # Authorized Buyers account ID of the buyer. |
| 2465 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2466 | "advertiserIds": [ # The list of advertisers for this price when associated with this buyer. If empty, all advertisers with this buyer pay this price. |
| 2467 | "A String", |
| 2468 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2469 | "price": { # Represents a price and a pricing type for a product / deal. # The specified price. |
| 2470 | "pricingType": "A String", # The pricing type for the deal/product. (default: CPM) |
| 2471 | "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2472 | "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 2473 | "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2474 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 2475 | }, |
| 2476 | }, |
| 2477 | }, |
| 2478 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2479 | "autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers in this private auction. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2480 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2481 | "brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED) |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2482 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2483 | "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible. |
| 2484 | "description": "A String", # Description for the deal terms. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2485 | }, |
| 2486 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2487 | "sellerContacts": [ # Output only. Contact information for the seller. |
| 2488 | { # Contains information on how a buyer or seller can be reached. |
| 2489 | "name": "A String", # The name of the contact. |
| 2490 | "email": "A String", # Email address for the contact. |
| 2491 | }, |
| 2492 | ], |
| 2493 | "billedBuyer": { # Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. # Output only. Reference to the buyer that will get billed for this proposal. |
| 2494 | "accountId": "A String", # Authorized Buyers account ID of the buyer. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2495 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2496 | "proposalState": "A String", # Output only. The current state of the proposal. |
| 2497 | "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or left a comment. |
| 2498 | "seller": { # Represents a seller of inventory. Each seller is identified by a unique Ad Manager account ID. # Reference to the seller on the proposal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| 2499 | "accountId": "A String", # The unique ID for the seller. The seller fills in this field. The seller account ID is then available to buyer in the product. |
| 2500 | "subAccountId": "A String", # Optional sub-account ID for the seller. |
| 2501 | }, |
| 2502 | "proposalId": "A String", # Output only. The unique ID of the proposal. |
| 2503 | "notes": [ # Output only. The notes associated with this proposal. |
| 2504 | { # A proposal may be associated to several notes. |
| 2505 | "proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created. |
| 2506 | "creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note. |
| 2507 | "note": "A String", # The actual note to attach. (max-length: 1024 unicode code units) Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| 2508 | "noteId": "A String", # Output only. The unique ID for the note. |
| 2509 | "createTime": "A String", # Output only. The timestamp for when this note was created. |
| 2510 | }, |
| 2511 | ], |
| 2512 | "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal. |
| 2513 | "updateTime": "A String", # Output only. The time when the proposal was last revised. |
| 2514 | "isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this proposal. |
| 2515 | "proposalRevision": "A String", # Output only. The revision number for the proposal. Each update to the proposal or the deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2516 | "buyerContacts": [ # Contact information for the buyer. |
| 2517 | { # Contains information on how a buyer or seller can be reached. |
| 2518 | "name": "A String", # The name of the contact. |
| 2519 | "email": "A String", # Email address for the contact. |
| 2520 | }, |
| 2521 | ], |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2522 | }</pre> |
| 2523 | </div> |
| 2524 | |
| 2525 | <div class="method"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2526 | <code class="details" id="list">list(accountId, pageToken=None, pageSize=None, filter=None, filterSyntax=None, x__xgafv=None)</code> |
| 2527 | <pre>List proposals. A filter expression (PQL query) may be specified to filter the results. To retrieve all finalized proposals, regardless if a proposal is being renegotiated, see the FinalizedProposals resource. Note that Bidder/ChildSeat relationships differ from the usual behavior. A Bidder account can only see its child seats' proposals by specifying the ChildSeat's accountId in the request path. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2528 | |
| 2529 | Args: |
| 2530 | accountId: string, Account ID of the buyer. (required) |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2531 | pageToken: string, The page token as returned from ListProposalsResponse. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2532 | pageSize: integer, Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. |
| 2533 | filter: string, An optional PQL filter query used to query for proposals. Nested repeated fields, such as proposal.deals.targetingCriterion, cannot be filtered. |
| 2534 | filterSyntax: string, Syntax the filter is written in. Current implementation defaults to PQL but in the future it will be LIST_FILTER. |
| 2535 | Allowed values |
| 2536 | FILTER_SYNTAX_UNSPECIFIED - A placeholder for an undefined filter syntax. |
| 2537 | PQL - PQL query syntax. Visit https://developers.google.com/ad-manager/api/pqlreference for PQL documentation and examples. |
| 2538 | LIST_FILTER - API list filtering syntax. Read about syntax and usage at https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2539 | x__xgafv: string, V1 error format. |
| 2540 | Allowed values |
| 2541 | 1 - v1 error format |
| 2542 | 2 - v2 error format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2543 | |
| 2544 | Returns: |
| 2545 | An object of the form: |
| 2546 | |
| 2547 | { # Response message for listing proposals. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2548 | "nextPageToken": "A String", # Continuation token for fetching the next page of results. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2549 | "proposals": [ # The list of proposals. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2550 | { # Note: this resource requires whitelisting for access. Please contact your account manager for access to Marketplace resources. Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer and contains deals which are served. Note: you can not update, create, or otherwise modify Private Auction or Preferred Deals deals through the API. Fields are updatable unless noted otherwise. |
| 2551 | "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. # Reference to the buyer on the proposal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| 2552 | "accountId": "A String", # Authorized Buyers account ID of the buyer. |
| 2553 | }, |
| 2554 | "isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated. |
| 2555 | "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller). |
| 2556 | "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). |
| 2557 | }, |
| 2558 | "privateAuctionId": "A String", # Output only. Private auction ID if this proposal is a private auction proposal. |
| 2559 | "displayName": "A String", # The name for the proposal. |
| 2560 | "deals": [ # The deals associated with this proposal. For Private Auction proposals (whose deals have NonGuaranteedAuctionTerms), there will only be one deal. |
| 2561 | { # A deal represents a segment of inventory for displaying ads on. A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving. |
| 2562 | "dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned). |
| 2563 | "syndicationProduct": "A String", # The syndication product associated with the deal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| 2564 | "createTime": "A String", # Output only. The time of the deal creation. |
| 2565 | "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by buyer. |
| 2566 | "availableEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not required for Private Auction deals or Preferred Deals. |
| 2567 | "deliveryControl": { # Message contains details about how the deals will be paced. # The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. |
| 2568 | "frequencyCaps": [ # Output only. Specifies any frequency caps. |
| 2569 | { # Frequency cap. |
| 2570 | "numTimeUnits": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped. |
| 2571 | "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period. |
| 2572 | "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped. |
| 2573 | }, |
| 2574 | ], |
| 2575 | "creativeBlockingLevel": "A String", # Output only. Specified the creative blocking levels to be applied. |
| 2576 | "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced. |
| 2577 | }, |
| 2578 | "createProductId": "A String", # The product ID from which this deal was created. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| 2579 | "webPropertyCode": "A String", # The web property code for the seller copied over from the product. |
| 2580 | "proposalId": "A String", # Output only. ID of the proposal that this deal is part of. |
| 2581 | "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller). |
| 2582 | "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). |
| 2583 | }, |
| 2584 | "createProductRevision": "A String", # Optional revision number of the product that the deal was created from. If present on create, and the server `product_revision` has advanced sinced the passed-in `create_product_revision`, an `ABORTED` error will be returned. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2585 | "displayName": "A String", # The name of the deal. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2586 | "targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared targeting entity is AND'd together. |
| 2587 | { # Advertisers can target different attributes of an ad slot. For example, they can choose to show ads only if the user is in the U.S. Such targeting criteria can be specified as part of Shared Targeting. |
| 2588 | "key": "A String", # The key representing the shared targeting criterion. Targeting criteria defined by Google ad servers will begin with GOOG_. Third parties may define their own keys. A list of permissible keys along with the acceptable values will be provided as part of the external documentation. |
| 2589 | "inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd together. |
| 2590 | { # A polymorphic targeting value used as part of Shared Targeting. |
| 2591 | "dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING. The definition of this targeting is derived from the structure used by Ad Manager. |
| 2592 | "dayParts": [ # A list of day part targeting criterion. |
| 2593 | { # Daypart targeting message that specifies if the ad can be shown only during certain parts of a day/week. |
| 2594 | "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # The ending time of the day for the ad to show (minute level granularity). The end time is exclusive. This field is not available for filtering in PQL queries. |
| 2595 | "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| 2596 | "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| 2597 | "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| 2598 | "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. |
| 2599 | }, |
| 2600 | "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # The starting time of day for the ad to show (minute level granularity). The start time is inclusive. This field is not available for filtering in PQL queries. |
| 2601 | "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| 2602 | "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| 2603 | "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| 2604 | "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. |
| 2605 | }, |
| 2606 | "dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days. |
| 2607 | }, |
| 2608 | ], |
| 2609 | "timeZoneType": "A String", # The timezone to use for interpreting the day part targeting. |
| 2610 | }, |
| 2611 | "longValue": "A String", # The long value to include/exclude. |
| 2612 | "stringValue": "A String", # The string value to include/exclude. |
| 2613 | "creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude. Filled in when key = GOOG_CREATIVE_SIZE |
| 2614 | "companionSizes": [ # For video creatives specifies the sizes of companion ads (if present). Companion sizes may be filled in only when creative_size_type = VIDEO |
| 2615 | { # Message depicting the size of the creative. The units of width and height depend on the type of the targeting. |
| 2616 | "height": 42, # The height of the creative. |
| 2617 | "width": 42, # The width of the creative |
| 2618 | }, |
| 2619 | ], |
| 2620 | "size": { # Message depicting the size of the creative. The units of width and height depend on the type of the targeting. # For regular or video creative size type, specifies the size of the creative |
| 2621 | "height": 42, # The height of the creative. |
| 2622 | "width": 42, # The width of the creative |
| 2623 | }, |
| 2624 | "nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value only if creative_size_type = CreativeSizeType.NATIVE. |
| 2625 | "allowedFormats": [ # What formats are allowed by the publisher. If this repeated field is empty then all formats are allowed. For example, if this field contains AllowedFormatType.AUDIO then the publisher only allows an audio ad (without any video). |
| 2626 | "A String", |
| 2627 | ], |
| 2628 | "creativeSizeType": "A String", # The creative size type. |
| 2629 | "skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if creative_size_type = CreativeSizeType.VIDEO. |
| 2630 | }, |
| 2631 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2632 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2633 | "exclusions": [ # The list of values to exclude from targeting. Each value is AND'd together. |
| 2634 | { # A polymorphic targeting value used as part of Shared Targeting. |
| 2635 | "dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING. The definition of this targeting is derived from the structure used by Ad Manager. |
| 2636 | "dayParts": [ # A list of day part targeting criterion. |
| 2637 | { # Daypart targeting message that specifies if the ad can be shown only during certain parts of a day/week. |
| 2638 | "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # The ending time of the day for the ad to show (minute level granularity). The end time is exclusive. This field is not available for filtering in PQL queries. |
| 2639 | "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| 2640 | "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| 2641 | "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| 2642 | "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. |
| 2643 | }, |
| 2644 | "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # The starting time of day for the ad to show (minute level granularity). The start time is inclusive. This field is not available for filtering in PQL queries. |
| 2645 | "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| 2646 | "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| 2647 | "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| 2648 | "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. |
| 2649 | }, |
| 2650 | "dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days. |
| 2651 | }, |
| 2652 | ], |
| 2653 | "timeZoneType": "A String", # The timezone to use for interpreting the day part targeting. |
| 2654 | }, |
| 2655 | "longValue": "A String", # The long value to include/exclude. |
| 2656 | "stringValue": "A String", # The string value to include/exclude. |
| 2657 | "creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude. Filled in when key = GOOG_CREATIVE_SIZE |
| 2658 | "companionSizes": [ # For video creatives specifies the sizes of companion ads (if present). Companion sizes may be filled in only when creative_size_type = VIDEO |
| 2659 | { # Message depicting the size of the creative. The units of width and height depend on the type of the targeting. |
| 2660 | "height": 42, # The height of the creative. |
| 2661 | "width": 42, # The width of the creative |
| 2662 | }, |
| 2663 | ], |
| 2664 | "size": { # Message depicting the size of the creative. The units of width and height depend on the type of the targeting. # For regular or video creative size type, specifies the size of the creative |
| 2665 | "height": 42, # The height of the creative. |
| 2666 | "width": 42, # The width of the creative |
| 2667 | }, |
| 2668 | "nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value only if creative_size_type = CreativeSizeType.NATIVE. |
| 2669 | "allowedFormats": [ # What formats are allowed by the publisher. If this repeated field is empty then all formats are allowed. For example, if this field contains AllowedFormatType.AUDIO then the publisher only allows an audio ad (without any video). |
| 2670 | "A String", |
| 2671 | ], |
| 2672 | "creativeSizeType": "A String", # The creative size type. |
| 2673 | "skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if creative_size_type = CreativeSizeType.VIDEO. |
| 2674 | }, |
| 2675 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2676 | ], |
| 2677 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2678 | ], |
| 2679 | "targeting": { # Targeting represents different criteria that can be used by advertisers to target ad inventory. For example, they can choose to target ad requests only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. # Output only. Specifies the subset of inventory targeted by the deal. |
| 2680 | "placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Placement targeting information, e.g., URL, mobile applications. |
| 2681 | "urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). For Private Auction and AdX Preferred Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2682 | "excludedUrls": [ # A list of URLs to be excluded. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2683 | "A String", |
| 2684 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2685 | "targetedUrls": [ # A list of URLs to be included. |
| 2686 | "A String", |
| 2687 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2688 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2689 | "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages. |
| 2690 | "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Mobile application IDs are from App Store and Google Play Store. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2691 | "targetedAppIds": [ # A list of application IDs to be included. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2692 | "A String", |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2693 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2694 | "excludedAppIds": [ # A list of application IDs to be excluded. |
| 2695 | "A String", |
| 2696 | ], |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2697 | }, |
| 2698 | }, |
| 2699 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2700 | "technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2701 | "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # IDs of device capabilities to be included/excluded. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2702 | "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. |
| 2703 | "A String", |
| 2704 | ], |
| 2705 | "targetedCriteriaIds": [ # A list of numeric IDs to be included. |
| 2706 | "A String", |
| 2707 | ], |
| 2708 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2709 | "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # IDs of device categories to be included/excluded. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2710 | "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. |
| 2711 | "A String", |
| 2712 | ], |
| 2713 | "targetedCriteriaIds": [ # A list of numeric IDs to be included. |
| 2714 | "A String", |
| 2715 | ], |
| 2716 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2717 | "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2718 | "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # IDs of operating systems to be included/excluded. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2719 | "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. |
| 2720 | "A String", |
| 2721 | ], |
| 2722 | "targetedCriteriaIds": [ # A list of numeric IDs to be included. |
| 2723 | "A String", |
| 2724 | ], |
| 2725 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2726 | "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # IDs of operating system versions to be included/excluded. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2727 | "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. |
| 2728 | "A String", |
| 2729 | ], |
| 2730 | "targetedCriteriaIds": [ # A list of numeric IDs to be included. |
| 2731 | "A String", |
| 2732 | ], |
| 2733 | }, |
| 2734 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2735 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2736 | "videoTargeting": { # Represents targeting information about video. # Video targeting information. |
| 2737 | "excludedPositionTypes": [ # A list of video positions to be excluded. Position types can either be included or excluded (XOR). |
| 2738 | "A String", |
| 2739 | ], |
| 2740 | "targetedPositionTypes": [ # A list of video positions to be included. When the included list is present, the excluded list must be empty. When the excluded list is present, the included list must be empty. |
| 2741 | "A String", |
| 2742 | ], |
| 2743 | }, |
| 2744 | "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on an ad request. It only applies to Private Auction, AdX Preferred Deals and Auction Packages. This targeting does not apply to Programmatic Guaranteed and Preferred Deals in Ad Manager. # Inventory sizes to be included/excluded. |
| 2745 | "targetedInventorySizes": [ # A list of inventory sizes to be included. |
| 2746 | { # Represents size of a single ad slot, or a creative. |
| 2747 | "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 2748 | "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 2749 | "sizeType": "A String", # The size type of the ad slot. |
| 2750 | }, |
| 2751 | ], |
| 2752 | "excludedInventorySizes": [ # A list of inventory sizes to be excluded. |
| 2753 | { # Represents size of a single ad slot, or a creative. |
| 2754 | "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 2755 | "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 2756 | "sizeType": "A String", # The size type of the ad slot. |
| 2757 | }, |
| 2758 | ], |
| 2759 | }, |
| 2760 | "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # Geo criteria IDs to be included/excluded. |
| 2761 | "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. |
| 2762 | "A String", |
| 2763 | ], |
| 2764 | "targetedCriteriaIds": [ # A list of numeric IDs to be included. |
| 2765 | "A String", |
| 2766 | ], |
| 2767 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2768 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2769 | "externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is finalized. This is the deal ID that shows up in serving/reporting etc. |
| 2770 | "isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this deal. |
| 2771 | "creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ Preferred Deal in Ad Manager. This doesn't apply to Private Auction and AdX Preferred Deals. # Output only. Restricitions about the creatives associated with the deal (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals in Ad Manager. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2772 | "skippableAdType": "A String", # Skippable video ads allow viewers to skip ads after 5 seconds. |
| 2773 | "creativeSpecifications": [ |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2774 | { # Represents information for a creative that is associated with a Programmatic Guaranteed/Preferred Deal in Ad Manager. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2775 | "creativeCompanionSizes": [ # Companion sizes may be filled in only when this is a video creative. |
| 2776 | { # Represents size of a single ad slot, or a creative. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2777 | "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 2778 | "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2779 | "sizeType": "A String", # The size type of the ad slot. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2780 | }, |
| 2781 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2782 | "creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative. |
| 2783 | "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 2784 | "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 2785 | "sizeType": "A String", # The size type of the ad slot. |
| 2786 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2787 | }, |
| 2788 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2789 | "creativeFormat": "A String", # The format of the environment that the creatives will be displayed in. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2790 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2791 | "availableStartTime": "A String", # Optional proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (e.g., in milliseconds) will be truncated towards the start of time in seconds. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2792 | "sellerContacts": [ # Output only. Seller contact information for the deal. |
| 2793 | { # Contains information on how a buyer or seller can be reached. |
| 2794 | "name": "A String", # The name of the contact. |
| 2795 | "email": "A String", # Email address for the contact. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2796 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2797 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2798 | "dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal. |
| 2799 | "dealPauseStatus": { # Tracks which parties (if any) have paused a deal. The deal is considered paused if either hasBuyerPaused or hasSellPaused is true. # Output only. Tracks which parties (if any) have paused a deal. |
| 2800 | "buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal. |
| 2801 | "hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally. |
| 2802 | "sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal. |
| 2803 | "hasBuyerPaused": True or False, # True, if the buyer has paused the deal unilaterally. |
| 2804 | "firstPausedBy": "A String", # The role of the person who first paused this deal. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2805 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2806 | }, |
| 2807 | "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy. |
| 2808 | "updateTime": "A String", # Output only. The time when the deal was last updated. |
| 2809 | "dealTerms": { # The deal terms specify the details of a Product/deal. They specify things like price per buyer, the type of pricing model (e.g., fixed price, auction) and expected impressions from the publisher. # The negotiable terms of the deal. |
| 2810 | "nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via the API at this time, but can be returned in a get or list request. # The terms for non-guaranteed fixed price deals. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2811 | "fixedPrices": [ # Fixed price for the specified buyer. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2812 | { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in a product can become 0 or 1 deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set. |
| 2813 | "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2814 | "accountId": "A String", # Authorized Buyers account ID of the buyer. |
| 2815 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2816 | "advertiserIds": [ # The list of advertisers for this price when associated with this buyer. If empty, all advertisers with this buyer pay this price. |
| 2817 | "A String", |
| 2818 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2819 | "price": { # Represents a price and a pricing type for a product / deal. # The specified price. |
| 2820 | "pricingType": "A String", # The pricing type for the deal/product. (default: CPM) |
| 2821 | "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2822 | "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 2823 | "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2824 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 2825 | }, |
| 2826 | }, |
| 2827 | }, |
| 2828 | ], |
| 2829 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2830 | "description": "A String", # Publisher provided description for the terms. |
| 2831 | "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day. Can be set by buyer or seller. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2832 | "guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2833 | "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2834 | "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product. |
| 2835 | "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. |
| 2836 | "fixedPrices": [ # Fixed price for the specified buyer. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2837 | { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in a product can become 0 or 1 deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set. |
| 2838 | "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2839 | "accountId": "A String", # Authorized Buyers account ID of the buyer. |
| 2840 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2841 | "advertiserIds": [ # The list of advertisers for this price when associated with this buyer. If empty, all advertisers with this buyer pay this price. |
| 2842 | "A String", |
| 2843 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2844 | "price": { # Represents a price and a pricing type for a product / deal. # The specified price. |
| 2845 | "pricingType": "A String", # The pricing type for the deal/product. (default: CPM) |
| 2846 | "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2847 | "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 2848 | "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2849 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 2850 | }, |
| 2851 | }, |
| 2852 | }, |
| 2853 | ], |
| 2854 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2855 | "sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the time zone used to mark the boundaries of a day. It should be an IANA TZ name, such as "America/Los_Angeles". For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. |
| 2856 | "estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal. Can be set by buyer or seller. |
| 2857 | "pricingType": "A String", # The pricing type for the deal/product. (default: CPM) |
| 2858 | "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified. |
| 2859 | "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 2860 | "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 2861 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 2862 | }, |
| 2863 | }, |
| 2864 | "nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only by the seller, but they can be returned in a get or list request. # The terms for non-guaranteed auction deals. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2865 | "reservePricesPerBuyer": [ # Reserve price for the specified buyer. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2866 | { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in a product can become 0 or 1 deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set. |
| 2867 | "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2868 | "accountId": "A String", # Authorized Buyers account ID of the buyer. |
| 2869 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2870 | "advertiserIds": [ # The list of advertisers for this price when associated with this buyer. If empty, all advertisers with this buyer pay this price. |
| 2871 | "A String", |
| 2872 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2873 | "price": { # Represents a price and a pricing type for a product / deal. # The specified price. |
| 2874 | "pricingType": "A String", # The pricing type for the deal/product. (default: CPM) |
| 2875 | "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2876 | "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 2877 | "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2878 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 2879 | }, |
| 2880 | }, |
| 2881 | }, |
| 2882 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2883 | "autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers in this private auction. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2884 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2885 | "brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED) |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 2886 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2887 | "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible. |
| 2888 | "description": "A String", # Description for the deal terms. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2889 | }, |
| 2890 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2891 | "sellerContacts": [ # Output only. Contact information for the seller. |
| 2892 | { # Contains information on how a buyer or seller can be reached. |
| 2893 | "name": "A String", # The name of the contact. |
| 2894 | "email": "A String", # Email address for the contact. |
| 2895 | }, |
| 2896 | ], |
| 2897 | "billedBuyer": { # Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. # Output only. Reference to the buyer that will get billed for this proposal. |
| 2898 | "accountId": "A String", # Authorized Buyers account ID of the buyer. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2899 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2900 | "proposalState": "A String", # Output only. The current state of the proposal. |
| 2901 | "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or left a comment. |
| 2902 | "seller": { # Represents a seller of inventory. Each seller is identified by a unique Ad Manager account ID. # Reference to the seller on the proposal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| 2903 | "accountId": "A String", # The unique ID for the seller. The seller fills in this field. The seller account ID is then available to buyer in the product. |
| 2904 | "subAccountId": "A String", # Optional sub-account ID for the seller. |
| 2905 | }, |
| 2906 | "proposalId": "A String", # Output only. The unique ID of the proposal. |
| 2907 | "notes": [ # Output only. The notes associated with this proposal. |
| 2908 | { # A proposal may be associated to several notes. |
| 2909 | "proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created. |
| 2910 | "creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note. |
| 2911 | "note": "A String", # The actual note to attach. (max-length: 1024 unicode code units) Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| 2912 | "noteId": "A String", # Output only. The unique ID for the note. |
| 2913 | "createTime": "A String", # Output only. The timestamp for when this note was created. |
| 2914 | }, |
| 2915 | ], |
| 2916 | "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal. |
| 2917 | "updateTime": "A String", # Output only. The time when the proposal was last revised. |
| 2918 | "isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this proposal. |
| 2919 | "proposalRevision": "A String", # Output only. The revision number for the proposal. Each update to the proposal or the deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 2920 | "buyerContacts": [ # Contact information for the buyer. |
| 2921 | { # Contains information on how a buyer or seller can be reached. |
| 2922 | "name": "A String", # The name of the contact. |
| 2923 | "email": "A String", # Email address for the contact. |
| 2924 | }, |
| 2925 | ], |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2926 | }, |
| 2927 | ], |
| 2928 | }</pre> |
| 2929 | </div> |
| 2930 | |
| 2931 | <div class="method"> |
| 2932 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 2933 | <pre>Retrieves the next page of results. |
| 2934 | |
| 2935 | Args: |
| 2936 | previous_request: The request for the previous page. (required) |
| 2937 | previous_response: The response from the request for the previous page. (required) |
| 2938 | |
| 2939 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2940 | A request object that you can call 'execute()' on to request the next |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2941 | page. Returns None if there are no more items in the collection. |
| 2942 | </pre> |
| 2943 | </div> |
| 2944 | |
| 2945 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2946 | <code class="details" id="pause">pause(accountId, proposalId, body=None, x__xgafv=None)</code> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2947 | <pre>Update the given proposal to pause serving. This method will set the `DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to true for all deals in the proposal. It is a no-op to pause an already-paused proposal. It is an error to call PauseProposal for a proposal that is not finalized or renegotiating. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2948 | |
| 2949 | Args: |
| 2950 | accountId: string, Account ID of the buyer. (required) |
| 2951 | proposalId: string, The ID of the proposal to pause. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2952 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2953 | The object takes the form of: |
| 2954 | |
| 2955 | { # Request message to pause serving for an already-finalized proposal. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2956 | "reason": "A String", # The reason why the proposal is being paused. This human readable message will be displayed in the seller's UI. (Max length: 1000 unicode code units.) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2957 | } |
| 2958 | |
| 2959 | x__xgafv: string, V1 error format. |
| 2960 | Allowed values |
| 2961 | 1 - v1 error format |
| 2962 | 2 - v2 error format |
| 2963 | |
| 2964 | Returns: |
| 2965 | An object of the form: |
| 2966 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 2967 | { # Note: this resource requires whitelisting for access. Please contact your account manager for access to Marketplace resources. Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer and contains deals which are served. Note: you can not update, create, or otherwise modify Private Auction or Preferred Deals deals through the API. Fields are updatable unless noted otherwise. |
| 2968 | "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. # Reference to the buyer on the proposal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| 2969 | "accountId": "A String", # Authorized Buyers account ID of the buyer. |
| 2970 | }, |
| 2971 | "isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated. |
| 2972 | "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller). |
| 2973 | "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). |
| 2974 | }, |
| 2975 | "privateAuctionId": "A String", # Output only. Private auction ID if this proposal is a private auction proposal. |
| 2976 | "displayName": "A String", # The name for the proposal. |
| 2977 | "deals": [ # The deals associated with this proposal. For Private Auction proposals (whose deals have NonGuaranteedAuctionTerms), there will only be one deal. |
| 2978 | { # A deal represents a segment of inventory for displaying ads on. A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving. |
| 2979 | "dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned). |
| 2980 | "syndicationProduct": "A String", # The syndication product associated with the deal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| 2981 | "createTime": "A String", # Output only. The time of the deal creation. |
| 2982 | "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by buyer. |
| 2983 | "availableEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not required for Private Auction deals or Preferred Deals. |
| 2984 | "deliveryControl": { # Message contains details about how the deals will be paced. # The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. |
| 2985 | "frequencyCaps": [ # Output only. Specifies any frequency caps. |
| 2986 | { # Frequency cap. |
| 2987 | "numTimeUnits": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped. |
| 2988 | "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period. |
| 2989 | "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped. |
| 2990 | }, |
| 2991 | ], |
| 2992 | "creativeBlockingLevel": "A String", # Output only. Specified the creative blocking levels to be applied. |
| 2993 | "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced. |
| 2994 | }, |
| 2995 | "createProductId": "A String", # The product ID from which this deal was created. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| 2996 | "webPropertyCode": "A String", # The web property code for the seller copied over from the product. |
| 2997 | "proposalId": "A String", # Output only. ID of the proposal that this deal is part of. |
| 2998 | "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller). |
| 2999 | "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). |
| 3000 | }, |
| 3001 | "createProductRevision": "A String", # Optional revision number of the product that the deal was created from. If present on create, and the server `product_revision` has advanced sinced the passed-in `create_product_revision`, an `ABORTED` error will be returned. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 3002 | "displayName": "A String", # The name of the deal. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3003 | "targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared targeting entity is AND'd together. |
| 3004 | { # Advertisers can target different attributes of an ad slot. For example, they can choose to show ads only if the user is in the U.S. Such targeting criteria can be specified as part of Shared Targeting. |
| 3005 | "key": "A String", # The key representing the shared targeting criterion. Targeting criteria defined by Google ad servers will begin with GOOG_. Third parties may define their own keys. A list of permissible keys along with the acceptable values will be provided as part of the external documentation. |
| 3006 | "inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd together. |
| 3007 | { # A polymorphic targeting value used as part of Shared Targeting. |
| 3008 | "dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING. The definition of this targeting is derived from the structure used by Ad Manager. |
| 3009 | "dayParts": [ # A list of day part targeting criterion. |
| 3010 | { # Daypart targeting message that specifies if the ad can be shown only during certain parts of a day/week. |
| 3011 | "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # The ending time of the day for the ad to show (minute level granularity). The end time is exclusive. This field is not available for filtering in PQL queries. |
| 3012 | "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| 3013 | "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| 3014 | "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| 3015 | "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. |
| 3016 | }, |
| 3017 | "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # The starting time of day for the ad to show (minute level granularity). The start time is inclusive. This field is not available for filtering in PQL queries. |
| 3018 | "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| 3019 | "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| 3020 | "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| 3021 | "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. |
| 3022 | }, |
| 3023 | "dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days. |
| 3024 | }, |
| 3025 | ], |
| 3026 | "timeZoneType": "A String", # The timezone to use for interpreting the day part targeting. |
| 3027 | }, |
| 3028 | "longValue": "A String", # The long value to include/exclude. |
| 3029 | "stringValue": "A String", # The string value to include/exclude. |
| 3030 | "creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude. Filled in when key = GOOG_CREATIVE_SIZE |
| 3031 | "companionSizes": [ # For video creatives specifies the sizes of companion ads (if present). Companion sizes may be filled in only when creative_size_type = VIDEO |
| 3032 | { # Message depicting the size of the creative. The units of width and height depend on the type of the targeting. |
| 3033 | "height": 42, # The height of the creative. |
| 3034 | "width": 42, # The width of the creative |
| 3035 | }, |
| 3036 | ], |
| 3037 | "size": { # Message depicting the size of the creative. The units of width and height depend on the type of the targeting. # For regular or video creative size type, specifies the size of the creative |
| 3038 | "height": 42, # The height of the creative. |
| 3039 | "width": 42, # The width of the creative |
| 3040 | }, |
| 3041 | "nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value only if creative_size_type = CreativeSizeType.NATIVE. |
| 3042 | "allowedFormats": [ # What formats are allowed by the publisher. If this repeated field is empty then all formats are allowed. For example, if this field contains AllowedFormatType.AUDIO then the publisher only allows an audio ad (without any video). |
| 3043 | "A String", |
| 3044 | ], |
| 3045 | "creativeSizeType": "A String", # The creative size type. |
| 3046 | "skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if creative_size_type = CreativeSizeType.VIDEO. |
| 3047 | }, |
| 3048 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 3049 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3050 | "exclusions": [ # The list of values to exclude from targeting. Each value is AND'd together. |
| 3051 | { # A polymorphic targeting value used as part of Shared Targeting. |
| 3052 | "dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING. The definition of this targeting is derived from the structure used by Ad Manager. |
| 3053 | "dayParts": [ # A list of day part targeting criterion. |
| 3054 | { # Daypart targeting message that specifies if the ad can be shown only during certain parts of a day/week. |
| 3055 | "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # The ending time of the day for the ad to show (minute level granularity). The end time is exclusive. This field is not available for filtering in PQL queries. |
| 3056 | "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| 3057 | "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| 3058 | "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| 3059 | "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. |
| 3060 | }, |
| 3061 | "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # The starting time of day for the ad to show (minute level granularity). The start time is inclusive. This field is not available for filtering in PQL queries. |
| 3062 | "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| 3063 | "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| 3064 | "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| 3065 | "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. |
| 3066 | }, |
| 3067 | "dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days. |
| 3068 | }, |
| 3069 | ], |
| 3070 | "timeZoneType": "A String", # The timezone to use for interpreting the day part targeting. |
| 3071 | }, |
| 3072 | "longValue": "A String", # The long value to include/exclude. |
| 3073 | "stringValue": "A String", # The string value to include/exclude. |
| 3074 | "creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude. Filled in when key = GOOG_CREATIVE_SIZE |
| 3075 | "companionSizes": [ # For video creatives specifies the sizes of companion ads (if present). Companion sizes may be filled in only when creative_size_type = VIDEO |
| 3076 | { # Message depicting the size of the creative. The units of width and height depend on the type of the targeting. |
| 3077 | "height": 42, # The height of the creative. |
| 3078 | "width": 42, # The width of the creative |
| 3079 | }, |
| 3080 | ], |
| 3081 | "size": { # Message depicting the size of the creative. The units of width and height depend on the type of the targeting. # For regular or video creative size type, specifies the size of the creative |
| 3082 | "height": 42, # The height of the creative. |
| 3083 | "width": 42, # The width of the creative |
| 3084 | }, |
| 3085 | "nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value only if creative_size_type = CreativeSizeType.NATIVE. |
| 3086 | "allowedFormats": [ # What formats are allowed by the publisher. If this repeated field is empty then all formats are allowed. For example, if this field contains AllowedFormatType.AUDIO then the publisher only allows an audio ad (without any video). |
| 3087 | "A String", |
| 3088 | ], |
| 3089 | "creativeSizeType": "A String", # The creative size type. |
| 3090 | "skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if creative_size_type = CreativeSizeType.VIDEO. |
| 3091 | }, |
| 3092 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 3093 | ], |
| 3094 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3095 | ], |
| 3096 | "targeting": { # Targeting represents different criteria that can be used by advertisers to target ad inventory. For example, they can choose to target ad requests only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. # Output only. Specifies the subset of inventory targeted by the deal. |
| 3097 | "placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Placement targeting information, e.g., URL, mobile applications. |
| 3098 | "urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). For Private Auction and AdX Preferred Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 3099 | "excludedUrls": [ # A list of URLs to be excluded. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3100 | "A String", |
| 3101 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3102 | "targetedUrls": [ # A list of URLs to be included. |
| 3103 | "A String", |
| 3104 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3105 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3106 | "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages. |
| 3107 | "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Mobile application IDs are from App Store and Google Play Store. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3108 | "targetedAppIds": [ # A list of application IDs to be included. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3109 | "A String", |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3110 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3111 | "excludedAppIds": [ # A list of application IDs to be excluded. |
| 3112 | "A String", |
| 3113 | ], |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3114 | }, |
| 3115 | }, |
| 3116 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3117 | "technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3118 | "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # IDs of device capabilities to be included/excluded. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3119 | "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. |
| 3120 | "A String", |
| 3121 | ], |
| 3122 | "targetedCriteriaIds": [ # A list of numeric IDs to be included. |
| 3123 | "A String", |
| 3124 | ], |
| 3125 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3126 | "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # IDs of device categories to be included/excluded. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3127 | "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. |
| 3128 | "A String", |
| 3129 | ], |
| 3130 | "targetedCriteriaIds": [ # A list of numeric IDs to be included. |
| 3131 | "A String", |
| 3132 | ], |
| 3133 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 3134 | "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3135 | "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # IDs of operating systems to be included/excluded. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 3136 | "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. |
| 3137 | "A String", |
| 3138 | ], |
| 3139 | "targetedCriteriaIds": [ # A list of numeric IDs to be included. |
| 3140 | "A String", |
| 3141 | ], |
| 3142 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3143 | "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # IDs of operating system versions to be included/excluded. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 3144 | "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. |
| 3145 | "A String", |
| 3146 | ], |
| 3147 | "targetedCriteriaIds": [ # A list of numeric IDs to be included. |
| 3148 | "A String", |
| 3149 | ], |
| 3150 | }, |
| 3151 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3152 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3153 | "videoTargeting": { # Represents targeting information about video. # Video targeting information. |
| 3154 | "excludedPositionTypes": [ # A list of video positions to be excluded. Position types can either be included or excluded (XOR). |
| 3155 | "A String", |
| 3156 | ], |
| 3157 | "targetedPositionTypes": [ # A list of video positions to be included. When the included list is present, the excluded list must be empty. When the excluded list is present, the included list must be empty. |
| 3158 | "A String", |
| 3159 | ], |
| 3160 | }, |
| 3161 | "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on an ad request. It only applies to Private Auction, AdX Preferred Deals and Auction Packages. This targeting does not apply to Programmatic Guaranteed and Preferred Deals in Ad Manager. # Inventory sizes to be included/excluded. |
| 3162 | "targetedInventorySizes": [ # A list of inventory sizes to be included. |
| 3163 | { # Represents size of a single ad slot, or a creative. |
| 3164 | "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 3165 | "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 3166 | "sizeType": "A String", # The size type of the ad slot. |
| 3167 | }, |
| 3168 | ], |
| 3169 | "excludedInventorySizes": [ # A list of inventory sizes to be excluded. |
| 3170 | { # Represents size of a single ad slot, or a creative. |
| 3171 | "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 3172 | "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 3173 | "sizeType": "A String", # The size type of the ad slot. |
| 3174 | }, |
| 3175 | ], |
| 3176 | }, |
| 3177 | "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # Geo criteria IDs to be included/excluded. |
| 3178 | "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. |
| 3179 | "A String", |
| 3180 | ], |
| 3181 | "targetedCriteriaIds": [ # A list of numeric IDs to be included. |
| 3182 | "A String", |
| 3183 | ], |
| 3184 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3185 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3186 | "externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is finalized. This is the deal ID that shows up in serving/reporting etc. |
| 3187 | "isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this deal. |
| 3188 | "creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ Preferred Deal in Ad Manager. This doesn't apply to Private Auction and AdX Preferred Deals. # Output only. Restricitions about the creatives associated with the deal (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals in Ad Manager. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 3189 | "skippableAdType": "A String", # Skippable video ads allow viewers to skip ads after 5 seconds. |
| 3190 | "creativeSpecifications": [ |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3191 | { # Represents information for a creative that is associated with a Programmatic Guaranteed/Preferred Deal in Ad Manager. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 3192 | "creativeCompanionSizes": [ # Companion sizes may be filled in only when this is a video creative. |
| 3193 | { # Represents size of a single ad slot, or a creative. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3194 | "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 3195 | "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 3196 | "sizeType": "A String", # The size type of the ad slot. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 3197 | }, |
| 3198 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3199 | "creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative. |
| 3200 | "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 3201 | "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 3202 | "sizeType": "A String", # The size type of the ad slot. |
| 3203 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3204 | }, |
| 3205 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 3206 | "creativeFormat": "A String", # The format of the environment that the creatives will be displayed in. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3207 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3208 | "availableStartTime": "A String", # Optional proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (e.g., in milliseconds) will be truncated towards the start of time in seconds. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3209 | "sellerContacts": [ # Output only. Seller contact information for the deal. |
| 3210 | { # Contains information on how a buyer or seller can be reached. |
| 3211 | "name": "A String", # The name of the contact. |
| 3212 | "email": "A String", # Email address for the contact. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3213 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3214 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3215 | "dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal. |
| 3216 | "dealPauseStatus": { # Tracks which parties (if any) have paused a deal. The deal is considered paused if either hasBuyerPaused or hasSellPaused is true. # Output only. Tracks which parties (if any) have paused a deal. |
| 3217 | "buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal. |
| 3218 | "hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally. |
| 3219 | "sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal. |
| 3220 | "hasBuyerPaused": True or False, # True, if the buyer has paused the deal unilaterally. |
| 3221 | "firstPausedBy": "A String", # The role of the person who first paused this deal. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 3222 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3223 | }, |
| 3224 | "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy. |
| 3225 | "updateTime": "A String", # Output only. The time when the deal was last updated. |
| 3226 | "dealTerms": { # The deal terms specify the details of a Product/deal. They specify things like price per buyer, the type of pricing model (e.g., fixed price, auction) and expected impressions from the publisher. # The negotiable terms of the deal. |
| 3227 | "nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via the API at this time, but can be returned in a get or list request. # The terms for non-guaranteed fixed price deals. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 3228 | "fixedPrices": [ # Fixed price for the specified buyer. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3229 | { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in a product can become 0 or 1 deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set. |
| 3230 | "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 3231 | "accountId": "A String", # Authorized Buyers account ID of the buyer. |
| 3232 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3233 | "advertiserIds": [ # The list of advertisers for this price when associated with this buyer. If empty, all advertisers with this buyer pay this price. |
| 3234 | "A String", |
| 3235 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 3236 | "price": { # Represents a price and a pricing type for a product / deal. # The specified price. |
| 3237 | "pricingType": "A String", # The pricing type for the deal/product. (default: CPM) |
| 3238 | "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3239 | "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 3240 | "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 3241 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 3242 | }, |
| 3243 | }, |
| 3244 | }, |
| 3245 | ], |
| 3246 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3247 | "description": "A String", # Publisher provided description for the terms. |
| 3248 | "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day. Can be set by buyer or seller. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 3249 | "guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3250 | "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 3251 | "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product. |
| 3252 | "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. |
| 3253 | "fixedPrices": [ # Fixed price for the specified buyer. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3254 | { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in a product can become 0 or 1 deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set. |
| 3255 | "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 3256 | "accountId": "A String", # Authorized Buyers account ID of the buyer. |
| 3257 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3258 | "advertiserIds": [ # The list of advertisers for this price when associated with this buyer. If empty, all advertisers with this buyer pay this price. |
| 3259 | "A String", |
| 3260 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 3261 | "price": { # Represents a price and a pricing type for a product / deal. # The specified price. |
| 3262 | "pricingType": "A String", # The pricing type for the deal/product. (default: CPM) |
| 3263 | "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3264 | "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 3265 | "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 3266 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 3267 | }, |
| 3268 | }, |
| 3269 | }, |
| 3270 | ], |
| 3271 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3272 | "sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the time zone used to mark the boundaries of a day. It should be an IANA TZ name, such as "America/Los_Angeles". For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. |
| 3273 | "estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal. Can be set by buyer or seller. |
| 3274 | "pricingType": "A String", # The pricing type for the deal/product. (default: CPM) |
| 3275 | "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified. |
| 3276 | "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 3277 | "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 3278 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 3279 | }, |
| 3280 | }, |
| 3281 | "nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only by the seller, but they can be returned in a get or list request. # The terms for non-guaranteed auction deals. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 3282 | "reservePricesPerBuyer": [ # Reserve price for the specified buyer. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3283 | { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in a product can become 0 or 1 deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set. |
| 3284 | "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 3285 | "accountId": "A String", # Authorized Buyers account ID of the buyer. |
| 3286 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3287 | "advertiserIds": [ # The list of advertisers for this price when associated with this buyer. If empty, all advertisers with this buyer pay this price. |
| 3288 | "A String", |
| 3289 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 3290 | "price": { # Represents a price and a pricing type for a product / deal. # The specified price. |
| 3291 | "pricingType": "A String", # The pricing type for the deal/product. (default: CPM) |
| 3292 | "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3293 | "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 3294 | "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 3295 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 3296 | }, |
| 3297 | }, |
| 3298 | }, |
| 3299 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3300 | "autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers in this private auction. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 3301 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3302 | "brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED) |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 3303 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3304 | "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible. |
| 3305 | "description": "A String", # Description for the deal terms. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3306 | }, |
| 3307 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3308 | "sellerContacts": [ # Output only. Contact information for the seller. |
| 3309 | { # Contains information on how a buyer or seller can be reached. |
| 3310 | "name": "A String", # The name of the contact. |
| 3311 | "email": "A String", # Email address for the contact. |
| 3312 | }, |
| 3313 | ], |
| 3314 | "billedBuyer": { # Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. # Output only. Reference to the buyer that will get billed for this proposal. |
| 3315 | "accountId": "A String", # Authorized Buyers account ID of the buyer. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3316 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3317 | "proposalState": "A String", # Output only. The current state of the proposal. |
| 3318 | "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or left a comment. |
| 3319 | "seller": { # Represents a seller of inventory. Each seller is identified by a unique Ad Manager account ID. # Reference to the seller on the proposal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| 3320 | "accountId": "A String", # The unique ID for the seller. The seller fills in this field. The seller account ID is then available to buyer in the product. |
| 3321 | "subAccountId": "A String", # Optional sub-account ID for the seller. |
| 3322 | }, |
| 3323 | "proposalId": "A String", # Output only. The unique ID of the proposal. |
| 3324 | "notes": [ # Output only. The notes associated with this proposal. |
| 3325 | { # A proposal may be associated to several notes. |
| 3326 | "proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created. |
| 3327 | "creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note. |
| 3328 | "note": "A String", # The actual note to attach. (max-length: 1024 unicode code units) Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| 3329 | "noteId": "A String", # Output only. The unique ID for the note. |
| 3330 | "createTime": "A String", # Output only. The timestamp for when this note was created. |
| 3331 | }, |
| 3332 | ], |
| 3333 | "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal. |
| 3334 | "updateTime": "A String", # Output only. The time when the proposal was last revised. |
| 3335 | "isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this proposal. |
| 3336 | "proposalRevision": "A String", # Output only. The revision number for the proposal. Each update to the proposal or the deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3337 | "buyerContacts": [ # Contact information for the buyer. |
| 3338 | { # Contains information on how a buyer or seller can be reached. |
| 3339 | "name": "A String", # The name of the contact. |
| 3340 | "email": "A String", # Email address for the contact. |
| 3341 | }, |
| 3342 | ], |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3343 | }</pre> |
| 3344 | </div> |
| 3345 | |
| 3346 | <div class="method"> |
| 3347 | <code class="details" id="resume">resume(accountId, proposalId, body=None, x__xgafv=None)</code> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3348 | <pre>Update the given proposal to resume serving. This method will set the `DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to false for all deals in the proposal. Note that if the `has_seller_paused` bit is also set, serving will not resume until the seller also resumes. It is a no-op to resume an already-running proposal. It is an error to call ResumeProposal for a proposal that is not finalized or renegotiating. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3349 | |
| 3350 | Args: |
| 3351 | accountId: string, Account ID of the buyer. (required) |
| 3352 | proposalId: string, The ID of the proposal to resume. (required) |
| 3353 | body: object, The request body. |
| 3354 | The object takes the form of: |
| 3355 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3356 | { # Request message to resume (unpause) serving for an already-finalized proposal. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3357 | } |
| 3358 | |
| 3359 | x__xgafv: string, V1 error format. |
| 3360 | Allowed values |
| 3361 | 1 - v1 error format |
| 3362 | 2 - v2 error format |
| 3363 | |
| 3364 | Returns: |
| 3365 | An object of the form: |
| 3366 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3367 | { # Note: this resource requires whitelisting for access. Please contact your account manager for access to Marketplace resources. Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer and contains deals which are served. Note: you can not update, create, or otherwise modify Private Auction or Preferred Deals deals through the API. Fields are updatable unless noted otherwise. |
| 3368 | "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. # Reference to the buyer on the proposal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| 3369 | "accountId": "A String", # Authorized Buyers account ID of the buyer. |
| 3370 | }, |
| 3371 | "isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated. |
| 3372 | "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller). |
| 3373 | "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). |
| 3374 | }, |
| 3375 | "privateAuctionId": "A String", # Output only. Private auction ID if this proposal is a private auction proposal. |
| 3376 | "displayName": "A String", # The name for the proposal. |
| 3377 | "deals": [ # The deals associated with this proposal. For Private Auction proposals (whose deals have NonGuaranteedAuctionTerms), there will only be one deal. |
| 3378 | { # A deal represents a segment of inventory for displaying ads on. A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving. |
| 3379 | "dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned). |
| 3380 | "syndicationProduct": "A String", # The syndication product associated with the deal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| 3381 | "createTime": "A String", # Output only. The time of the deal creation. |
| 3382 | "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by buyer. |
| 3383 | "availableEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not required for Private Auction deals or Preferred Deals. |
| 3384 | "deliveryControl": { # Message contains details about how the deals will be paced. # The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. |
| 3385 | "frequencyCaps": [ # Output only. Specifies any frequency caps. |
| 3386 | { # Frequency cap. |
| 3387 | "numTimeUnits": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped. |
| 3388 | "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period. |
| 3389 | "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped. |
| 3390 | }, |
| 3391 | ], |
| 3392 | "creativeBlockingLevel": "A String", # Output only. Specified the creative blocking levels to be applied. |
| 3393 | "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced. |
| 3394 | }, |
| 3395 | "createProductId": "A String", # The product ID from which this deal was created. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| 3396 | "webPropertyCode": "A String", # The web property code for the seller copied over from the product. |
| 3397 | "proposalId": "A String", # Output only. ID of the proposal that this deal is part of. |
| 3398 | "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller). |
| 3399 | "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). |
| 3400 | }, |
| 3401 | "createProductRevision": "A String", # Optional revision number of the product that the deal was created from. If present on create, and the server `product_revision` has advanced sinced the passed-in `create_product_revision`, an `ABORTED` error will be returned. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 3402 | "displayName": "A String", # The name of the deal. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3403 | "targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared targeting entity is AND'd together. |
| 3404 | { # Advertisers can target different attributes of an ad slot. For example, they can choose to show ads only if the user is in the U.S. Such targeting criteria can be specified as part of Shared Targeting. |
| 3405 | "key": "A String", # The key representing the shared targeting criterion. Targeting criteria defined by Google ad servers will begin with GOOG_. Third parties may define their own keys. A list of permissible keys along with the acceptable values will be provided as part of the external documentation. |
| 3406 | "inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd together. |
| 3407 | { # A polymorphic targeting value used as part of Shared Targeting. |
| 3408 | "dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING. The definition of this targeting is derived from the structure used by Ad Manager. |
| 3409 | "dayParts": [ # A list of day part targeting criterion. |
| 3410 | { # Daypart targeting message that specifies if the ad can be shown only during certain parts of a day/week. |
| 3411 | "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # The ending time of the day for the ad to show (minute level granularity). The end time is exclusive. This field is not available for filtering in PQL queries. |
| 3412 | "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| 3413 | "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| 3414 | "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| 3415 | "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. |
| 3416 | }, |
| 3417 | "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # The starting time of day for the ad to show (minute level granularity). The start time is inclusive. This field is not available for filtering in PQL queries. |
| 3418 | "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| 3419 | "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| 3420 | "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| 3421 | "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. |
| 3422 | }, |
| 3423 | "dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days. |
| 3424 | }, |
| 3425 | ], |
| 3426 | "timeZoneType": "A String", # The timezone to use for interpreting the day part targeting. |
| 3427 | }, |
| 3428 | "longValue": "A String", # The long value to include/exclude. |
| 3429 | "stringValue": "A String", # The string value to include/exclude. |
| 3430 | "creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude. Filled in when key = GOOG_CREATIVE_SIZE |
| 3431 | "companionSizes": [ # For video creatives specifies the sizes of companion ads (if present). Companion sizes may be filled in only when creative_size_type = VIDEO |
| 3432 | { # Message depicting the size of the creative. The units of width and height depend on the type of the targeting. |
| 3433 | "height": 42, # The height of the creative. |
| 3434 | "width": 42, # The width of the creative |
| 3435 | }, |
| 3436 | ], |
| 3437 | "size": { # Message depicting the size of the creative. The units of width and height depend on the type of the targeting. # For regular or video creative size type, specifies the size of the creative |
| 3438 | "height": 42, # The height of the creative. |
| 3439 | "width": 42, # The width of the creative |
| 3440 | }, |
| 3441 | "nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value only if creative_size_type = CreativeSizeType.NATIVE. |
| 3442 | "allowedFormats": [ # What formats are allowed by the publisher. If this repeated field is empty then all formats are allowed. For example, if this field contains AllowedFormatType.AUDIO then the publisher only allows an audio ad (without any video). |
| 3443 | "A String", |
| 3444 | ], |
| 3445 | "creativeSizeType": "A String", # The creative size type. |
| 3446 | "skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if creative_size_type = CreativeSizeType.VIDEO. |
| 3447 | }, |
| 3448 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 3449 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3450 | "exclusions": [ # The list of values to exclude from targeting. Each value is AND'd together. |
| 3451 | { # A polymorphic targeting value used as part of Shared Targeting. |
| 3452 | "dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING. The definition of this targeting is derived from the structure used by Ad Manager. |
| 3453 | "dayParts": [ # A list of day part targeting criterion. |
| 3454 | { # Daypart targeting message that specifies if the ad can be shown only during certain parts of a day/week. |
| 3455 | "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # The ending time of the day for the ad to show (minute level granularity). The end time is exclusive. This field is not available for filtering in PQL queries. |
| 3456 | "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| 3457 | "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| 3458 | "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| 3459 | "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. |
| 3460 | }, |
| 3461 | "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # The starting time of day for the ad to show (minute level granularity). The start time is inclusive. This field is not available for filtering in PQL queries. |
| 3462 | "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| 3463 | "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| 3464 | "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| 3465 | "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. |
| 3466 | }, |
| 3467 | "dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days. |
| 3468 | }, |
| 3469 | ], |
| 3470 | "timeZoneType": "A String", # The timezone to use for interpreting the day part targeting. |
| 3471 | }, |
| 3472 | "longValue": "A String", # The long value to include/exclude. |
| 3473 | "stringValue": "A String", # The string value to include/exclude. |
| 3474 | "creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude. Filled in when key = GOOG_CREATIVE_SIZE |
| 3475 | "companionSizes": [ # For video creatives specifies the sizes of companion ads (if present). Companion sizes may be filled in only when creative_size_type = VIDEO |
| 3476 | { # Message depicting the size of the creative. The units of width and height depend on the type of the targeting. |
| 3477 | "height": 42, # The height of the creative. |
| 3478 | "width": 42, # The width of the creative |
| 3479 | }, |
| 3480 | ], |
| 3481 | "size": { # Message depicting the size of the creative. The units of width and height depend on the type of the targeting. # For regular or video creative size type, specifies the size of the creative |
| 3482 | "height": 42, # The height of the creative. |
| 3483 | "width": 42, # The width of the creative |
| 3484 | }, |
| 3485 | "nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value only if creative_size_type = CreativeSizeType.NATIVE. |
| 3486 | "allowedFormats": [ # What formats are allowed by the publisher. If this repeated field is empty then all formats are allowed. For example, if this field contains AllowedFormatType.AUDIO then the publisher only allows an audio ad (without any video). |
| 3487 | "A String", |
| 3488 | ], |
| 3489 | "creativeSizeType": "A String", # The creative size type. |
| 3490 | "skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if creative_size_type = CreativeSizeType.VIDEO. |
| 3491 | }, |
| 3492 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 3493 | ], |
| 3494 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3495 | ], |
| 3496 | "targeting": { # Targeting represents different criteria that can be used by advertisers to target ad inventory. For example, they can choose to target ad requests only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. # Output only. Specifies the subset of inventory targeted by the deal. |
| 3497 | "placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Placement targeting information, e.g., URL, mobile applications. |
| 3498 | "urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). For Private Auction and AdX Preferred Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 3499 | "excludedUrls": [ # A list of URLs to be excluded. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3500 | "A String", |
| 3501 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3502 | "targetedUrls": [ # A list of URLs to be included. |
| 3503 | "A String", |
| 3504 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3505 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3506 | "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages. |
| 3507 | "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Mobile application IDs are from App Store and Google Play Store. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3508 | "targetedAppIds": [ # A list of application IDs to be included. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3509 | "A String", |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3510 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3511 | "excludedAppIds": [ # A list of application IDs to be excluded. |
| 3512 | "A String", |
| 3513 | ], |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3514 | }, |
| 3515 | }, |
| 3516 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3517 | "technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3518 | "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # IDs of device capabilities to be included/excluded. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3519 | "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. |
| 3520 | "A String", |
| 3521 | ], |
| 3522 | "targetedCriteriaIds": [ # A list of numeric IDs to be included. |
| 3523 | "A String", |
| 3524 | ], |
| 3525 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3526 | "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # IDs of device categories to be included/excluded. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3527 | "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. |
| 3528 | "A String", |
| 3529 | ], |
| 3530 | "targetedCriteriaIds": [ # A list of numeric IDs to be included. |
| 3531 | "A String", |
| 3532 | ], |
| 3533 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 3534 | "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3535 | "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # IDs of operating systems to be included/excluded. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 3536 | "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. |
| 3537 | "A String", |
| 3538 | ], |
| 3539 | "targetedCriteriaIds": [ # A list of numeric IDs to be included. |
| 3540 | "A String", |
| 3541 | ], |
| 3542 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3543 | "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # IDs of operating system versions to be included/excluded. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 3544 | "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. |
| 3545 | "A String", |
| 3546 | ], |
| 3547 | "targetedCriteriaIds": [ # A list of numeric IDs to be included. |
| 3548 | "A String", |
| 3549 | ], |
| 3550 | }, |
| 3551 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3552 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3553 | "videoTargeting": { # Represents targeting information about video. # Video targeting information. |
| 3554 | "excludedPositionTypes": [ # A list of video positions to be excluded. Position types can either be included or excluded (XOR). |
| 3555 | "A String", |
| 3556 | ], |
| 3557 | "targetedPositionTypes": [ # A list of video positions to be included. When the included list is present, the excluded list must be empty. When the excluded list is present, the included list must be empty. |
| 3558 | "A String", |
| 3559 | ], |
| 3560 | }, |
| 3561 | "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on an ad request. It only applies to Private Auction, AdX Preferred Deals and Auction Packages. This targeting does not apply to Programmatic Guaranteed and Preferred Deals in Ad Manager. # Inventory sizes to be included/excluded. |
| 3562 | "targetedInventorySizes": [ # A list of inventory sizes to be included. |
| 3563 | { # Represents size of a single ad slot, or a creative. |
| 3564 | "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 3565 | "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 3566 | "sizeType": "A String", # The size type of the ad slot. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 3567 | }, |
| 3568 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3569 | "excludedInventorySizes": [ # A list of inventory sizes to be excluded. |
| 3570 | { # Represents size of a single ad slot, or a creative. |
| 3571 | "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 3572 | "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 3573 | "sizeType": "A String", # The size type of the ad slot. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 3574 | }, |
| 3575 | ], |
| 3576 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3577 | "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # Geo criteria IDs to be included/excluded. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3578 | "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. |
| 3579 | "A String", |
| 3580 | ], |
| 3581 | "targetedCriteriaIds": [ # A list of numeric IDs to be included. |
| 3582 | "A String", |
| 3583 | ], |
| 3584 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3585 | }, |
| 3586 | "externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is finalized. This is the deal ID that shows up in serving/reporting etc. |
| 3587 | "isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this deal. |
| 3588 | "creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ Preferred Deal in Ad Manager. This doesn't apply to Private Auction and AdX Preferred Deals. # Output only. Restricitions about the creatives associated with the deal (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals in Ad Manager. |
| 3589 | "skippableAdType": "A String", # Skippable video ads allow viewers to skip ads after 5 seconds. |
| 3590 | "creativeSpecifications": [ |
| 3591 | { # Represents information for a creative that is associated with a Programmatic Guaranteed/Preferred Deal in Ad Manager. |
| 3592 | "creativeCompanionSizes": [ # Companion sizes may be filled in only when this is a video creative. |
| 3593 | { # Represents size of a single ad slot, or a creative. |
| 3594 | "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 3595 | "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 3596 | "sizeType": "A String", # The size type of the ad slot. |
| 3597 | }, |
| 3598 | ], |
| 3599 | "creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative. |
| 3600 | "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 3601 | "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 3602 | "sizeType": "A String", # The size type of the ad slot. |
| 3603 | }, |
| 3604 | }, |
| 3605 | ], |
| 3606 | "creativeFormat": "A String", # The format of the environment that the creatives will be displayed in. |
| 3607 | }, |
| 3608 | "availableStartTime": "A String", # Optional proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (e.g., in milliseconds) will be truncated towards the start of time in seconds. |
| 3609 | "sellerContacts": [ # Output only. Seller contact information for the deal. |
| 3610 | { # Contains information on how a buyer or seller can be reached. |
| 3611 | "name": "A String", # The name of the contact. |
| 3612 | "email": "A String", # Email address for the contact. |
| 3613 | }, |
| 3614 | ], |
| 3615 | "dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal. |
| 3616 | "dealPauseStatus": { # Tracks which parties (if any) have paused a deal. The deal is considered paused if either hasBuyerPaused or hasSellPaused is true. # Output only. Tracks which parties (if any) have paused a deal. |
| 3617 | "buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal. |
| 3618 | "hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally. |
| 3619 | "sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal. |
| 3620 | "hasBuyerPaused": True or False, # True, if the buyer has paused the deal unilaterally. |
| 3621 | "firstPausedBy": "A String", # The role of the person who first paused this deal. |
| 3622 | }, |
| 3623 | }, |
| 3624 | "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy. |
| 3625 | "updateTime": "A String", # Output only. The time when the deal was last updated. |
| 3626 | "dealTerms": { # The deal terms specify the details of a Product/deal. They specify things like price per buyer, the type of pricing model (e.g., fixed price, auction) and expected impressions from the publisher. # The negotiable terms of the deal. |
| 3627 | "nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via the API at this time, but can be returned in a get or list request. # The terms for non-guaranteed fixed price deals. |
| 3628 | "fixedPrices": [ # Fixed price for the specified buyer. |
| 3629 | { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in a product can become 0 or 1 deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set. |
| 3630 | "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer). |
| 3631 | "accountId": "A String", # Authorized Buyers account ID of the buyer. |
| 3632 | }, |
| 3633 | "advertiserIds": [ # The list of advertisers for this price when associated with this buyer. If empty, all advertisers with this buyer pay this price. |
| 3634 | "A String", |
| 3635 | ], |
| 3636 | "price": { # Represents a price and a pricing type for a product / deal. # The specified price. |
| 3637 | "pricingType": "A String", # The pricing type for the deal/product. (default: CPM) |
| 3638 | "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified. |
| 3639 | "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 3640 | "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 3641 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 3642 | }, |
| 3643 | }, |
| 3644 | }, |
| 3645 | ], |
| 3646 | }, |
| 3647 | "description": "A String", # Publisher provided description for the terms. |
| 3648 | "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day. Can be set by buyer or seller. |
| 3649 | "guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals. |
| 3650 | "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy. |
| 3651 | "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product. |
| 3652 | "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. |
| 3653 | "fixedPrices": [ # Fixed price for the specified buyer. |
| 3654 | { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in a product can become 0 or 1 deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set. |
| 3655 | "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer). |
| 3656 | "accountId": "A String", # Authorized Buyers account ID of the buyer. |
| 3657 | }, |
| 3658 | "advertiserIds": [ # The list of advertisers for this price when associated with this buyer. If empty, all advertisers with this buyer pay this price. |
| 3659 | "A String", |
| 3660 | ], |
| 3661 | "price": { # Represents a price and a pricing type for a product / deal. # The specified price. |
| 3662 | "pricingType": "A String", # The pricing type for the deal/product. (default: CPM) |
| 3663 | "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified. |
| 3664 | "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 3665 | "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 3666 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 3667 | }, |
| 3668 | }, |
| 3669 | }, |
| 3670 | ], |
| 3671 | }, |
| 3672 | "sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the time zone used to mark the boundaries of a day. It should be an IANA TZ name, such as "America/Los_Angeles". For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. |
| 3673 | "estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal. Can be set by buyer or seller. |
| 3674 | "pricingType": "A String", # The pricing type for the deal/product. (default: CPM) |
| 3675 | "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified. |
| 3676 | "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 3677 | "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 3678 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 3679 | }, |
| 3680 | }, |
| 3681 | "nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only by the seller, but they can be returned in a get or list request. # The terms for non-guaranteed auction deals. |
| 3682 | "reservePricesPerBuyer": [ # Reserve price for the specified buyer. |
| 3683 | { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in a product can become 0 or 1 deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set. |
| 3684 | "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer). |
| 3685 | "accountId": "A String", # Authorized Buyers account ID of the buyer. |
| 3686 | }, |
| 3687 | "advertiserIds": [ # The list of advertisers for this price when associated with this buyer. If empty, all advertisers with this buyer pay this price. |
| 3688 | "A String", |
| 3689 | ], |
| 3690 | "price": { # Represents a price and a pricing type for a product / deal. # The specified price. |
| 3691 | "pricingType": "A String", # The pricing type for the deal/product. (default: CPM) |
| 3692 | "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified. |
| 3693 | "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 3694 | "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 3695 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 3696 | }, |
| 3697 | }, |
| 3698 | }, |
| 3699 | ], |
| 3700 | "autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers in this private auction. |
| 3701 | }, |
| 3702 | "brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED) |
| 3703 | }, |
| 3704 | "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible. |
| 3705 | "description": "A String", # Description for the deal terms. |
| 3706 | }, |
| 3707 | ], |
| 3708 | "sellerContacts": [ # Output only. Contact information for the seller. |
| 3709 | { # Contains information on how a buyer or seller can be reached. |
| 3710 | "name": "A String", # The name of the contact. |
| 3711 | "email": "A String", # Email address for the contact. |
| 3712 | }, |
| 3713 | ], |
| 3714 | "billedBuyer": { # Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. # Output only. Reference to the buyer that will get billed for this proposal. |
| 3715 | "accountId": "A String", # Authorized Buyers account ID of the buyer. |
| 3716 | }, |
| 3717 | "proposalState": "A String", # Output only. The current state of the proposal. |
| 3718 | "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or left a comment. |
| 3719 | "seller": { # Represents a seller of inventory. Each seller is identified by a unique Ad Manager account ID. # Reference to the seller on the proposal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| 3720 | "accountId": "A String", # The unique ID for the seller. The seller fills in this field. The seller account ID is then available to buyer in the product. |
| 3721 | "subAccountId": "A String", # Optional sub-account ID for the seller. |
| 3722 | }, |
| 3723 | "proposalId": "A String", # Output only. The unique ID of the proposal. |
| 3724 | "notes": [ # Output only. The notes associated with this proposal. |
| 3725 | { # A proposal may be associated to several notes. |
| 3726 | "proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created. |
| 3727 | "creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note. |
| 3728 | "note": "A String", # The actual note to attach. (max-length: 1024 unicode code units) Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| 3729 | "noteId": "A String", # Output only. The unique ID for the note. |
| 3730 | "createTime": "A String", # Output only. The timestamp for when this note was created. |
| 3731 | }, |
| 3732 | ], |
| 3733 | "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal. |
| 3734 | "updateTime": "A String", # Output only. The time when the proposal was last revised. |
| 3735 | "isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this proposal. |
| 3736 | "proposalRevision": "A String", # Output only. The revision number for the proposal. Each update to the proposal or the deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made. |
| 3737 | "buyerContacts": [ # Contact information for the buyer. |
| 3738 | { # Contains information on how a buyer or seller can be reached. |
| 3739 | "name": "A String", # The name of the contact. |
| 3740 | "email": "A String", # Email address for the contact. |
| 3741 | }, |
| 3742 | ], |
| 3743 | }</pre> |
| 3744 | </div> |
| 3745 | |
| 3746 | <div class="method"> |
| 3747 | <code class="details" id="update">update(accountId, proposalId, body=None, x__xgafv=None)</code> |
| 3748 | <pre>Update the given proposal at the client known revision number. If the server revision has advanced since the passed-in `proposal.proposal_revision`, an `ABORTED` error message will be returned. Only the buyer-modifiable fields of the proposal will be updated. Note that the deals in the proposal will be updated to match the passed-in copy. If a passed-in deal does not have a `deal_id`, the server will assign a new unique ID and create the deal. If passed-in deal has a `deal_id`, it will be updated to match the passed-in copy. Any existing deals not present in the passed-in proposal will be deleted. It is an error to pass in a deal with a `deal_id` not present at head. |
| 3749 | |
| 3750 | Args: |
| 3751 | accountId: string, Account ID of the buyer. (required) |
| 3752 | proposalId: string, The unique ID of the proposal. (required) |
| 3753 | body: object, The request body. |
| 3754 | The object takes the form of: |
| 3755 | |
| 3756 | { # Note: this resource requires whitelisting for access. Please contact your account manager for access to Marketplace resources. Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer and contains deals which are served. Note: you can not update, create, or otherwise modify Private Auction or Preferred Deals deals through the API. Fields are updatable unless noted otherwise. |
| 3757 | "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. # Reference to the buyer on the proposal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| 3758 | "accountId": "A String", # Authorized Buyers account ID of the buyer. |
| 3759 | }, |
| 3760 | "isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated. |
| 3761 | "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller). |
| 3762 | "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). |
| 3763 | }, |
| 3764 | "privateAuctionId": "A String", # Output only. Private auction ID if this proposal is a private auction proposal. |
| 3765 | "displayName": "A String", # The name for the proposal. |
| 3766 | "deals": [ # The deals associated with this proposal. For Private Auction proposals (whose deals have NonGuaranteedAuctionTerms), there will only be one deal. |
| 3767 | { # A deal represents a segment of inventory for displaying ads on. A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving. |
| 3768 | "dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned). |
| 3769 | "syndicationProduct": "A String", # The syndication product associated with the deal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| 3770 | "createTime": "A String", # Output only. The time of the deal creation. |
| 3771 | "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by buyer. |
| 3772 | "availableEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not required for Private Auction deals or Preferred Deals. |
| 3773 | "deliveryControl": { # Message contains details about how the deals will be paced. # The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. |
| 3774 | "frequencyCaps": [ # Output only. Specifies any frequency caps. |
| 3775 | { # Frequency cap. |
| 3776 | "numTimeUnits": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped. |
| 3777 | "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period. |
| 3778 | "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped. |
| 3779 | }, |
| 3780 | ], |
| 3781 | "creativeBlockingLevel": "A String", # Output only. Specified the creative blocking levels to be applied. |
| 3782 | "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced. |
| 3783 | }, |
| 3784 | "createProductId": "A String", # The product ID from which this deal was created. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| 3785 | "webPropertyCode": "A String", # The web property code for the seller copied over from the product. |
| 3786 | "proposalId": "A String", # Output only. ID of the proposal that this deal is part of. |
| 3787 | "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller). |
| 3788 | "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). |
| 3789 | }, |
| 3790 | "createProductRevision": "A String", # Optional revision number of the product that the deal was created from. If present on create, and the server `product_revision` has advanced sinced the passed-in `create_product_revision`, an `ABORTED` error will be returned. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| 3791 | "displayName": "A String", # The name of the deal. |
| 3792 | "targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared targeting entity is AND'd together. |
| 3793 | { # Advertisers can target different attributes of an ad slot. For example, they can choose to show ads only if the user is in the U.S. Such targeting criteria can be specified as part of Shared Targeting. |
| 3794 | "key": "A String", # The key representing the shared targeting criterion. Targeting criteria defined by Google ad servers will begin with GOOG_. Third parties may define their own keys. A list of permissible keys along with the acceptable values will be provided as part of the external documentation. |
| 3795 | "inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd together. |
| 3796 | { # A polymorphic targeting value used as part of Shared Targeting. |
| 3797 | "dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING. The definition of this targeting is derived from the structure used by Ad Manager. |
| 3798 | "dayParts": [ # A list of day part targeting criterion. |
| 3799 | { # Daypart targeting message that specifies if the ad can be shown only during certain parts of a day/week. |
| 3800 | "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # The ending time of the day for the ad to show (minute level granularity). The end time is exclusive. This field is not available for filtering in PQL queries. |
| 3801 | "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| 3802 | "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| 3803 | "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| 3804 | "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. |
| 3805 | }, |
| 3806 | "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # The starting time of day for the ad to show (minute level granularity). The start time is inclusive. This field is not available for filtering in PQL queries. |
| 3807 | "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| 3808 | "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| 3809 | "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| 3810 | "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. |
| 3811 | }, |
| 3812 | "dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days. |
| 3813 | }, |
| 3814 | ], |
| 3815 | "timeZoneType": "A String", # The timezone to use for interpreting the day part targeting. |
| 3816 | }, |
| 3817 | "longValue": "A String", # The long value to include/exclude. |
| 3818 | "stringValue": "A String", # The string value to include/exclude. |
| 3819 | "creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude. Filled in when key = GOOG_CREATIVE_SIZE |
| 3820 | "companionSizes": [ # For video creatives specifies the sizes of companion ads (if present). Companion sizes may be filled in only when creative_size_type = VIDEO |
| 3821 | { # Message depicting the size of the creative. The units of width and height depend on the type of the targeting. |
| 3822 | "height": 42, # The height of the creative. |
| 3823 | "width": 42, # The width of the creative |
| 3824 | }, |
| 3825 | ], |
| 3826 | "size": { # Message depicting the size of the creative. The units of width and height depend on the type of the targeting. # For regular or video creative size type, specifies the size of the creative |
| 3827 | "height": 42, # The height of the creative. |
| 3828 | "width": 42, # The width of the creative |
| 3829 | }, |
| 3830 | "nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value only if creative_size_type = CreativeSizeType.NATIVE. |
| 3831 | "allowedFormats": [ # What formats are allowed by the publisher. If this repeated field is empty then all formats are allowed. For example, if this field contains AllowedFormatType.AUDIO then the publisher only allows an audio ad (without any video). |
| 3832 | "A String", |
| 3833 | ], |
| 3834 | "creativeSizeType": "A String", # The creative size type. |
| 3835 | "skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if creative_size_type = CreativeSizeType.VIDEO. |
| 3836 | }, |
| 3837 | }, |
| 3838 | ], |
| 3839 | "exclusions": [ # The list of values to exclude from targeting. Each value is AND'd together. |
| 3840 | { # A polymorphic targeting value used as part of Shared Targeting. |
| 3841 | "dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING. The definition of this targeting is derived from the structure used by Ad Manager. |
| 3842 | "dayParts": [ # A list of day part targeting criterion. |
| 3843 | { # Daypart targeting message that specifies if the ad can be shown only during certain parts of a day/week. |
| 3844 | "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # The ending time of the day for the ad to show (minute level granularity). The end time is exclusive. This field is not available for filtering in PQL queries. |
| 3845 | "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| 3846 | "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| 3847 | "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| 3848 | "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. |
| 3849 | }, |
| 3850 | "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # The starting time of day for the ad to show (minute level granularity). The start time is inclusive. This field is not available for filtering in PQL queries. |
| 3851 | "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| 3852 | "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| 3853 | "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| 3854 | "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. |
| 3855 | }, |
| 3856 | "dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days. |
| 3857 | }, |
| 3858 | ], |
| 3859 | "timeZoneType": "A String", # The timezone to use for interpreting the day part targeting. |
| 3860 | }, |
| 3861 | "longValue": "A String", # The long value to include/exclude. |
| 3862 | "stringValue": "A String", # The string value to include/exclude. |
| 3863 | "creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude. Filled in when key = GOOG_CREATIVE_SIZE |
| 3864 | "companionSizes": [ # For video creatives specifies the sizes of companion ads (if present). Companion sizes may be filled in only when creative_size_type = VIDEO |
| 3865 | { # Message depicting the size of the creative. The units of width and height depend on the type of the targeting. |
| 3866 | "height": 42, # The height of the creative. |
| 3867 | "width": 42, # The width of the creative |
| 3868 | }, |
| 3869 | ], |
| 3870 | "size": { # Message depicting the size of the creative. The units of width and height depend on the type of the targeting. # For regular or video creative size type, specifies the size of the creative |
| 3871 | "height": 42, # The height of the creative. |
| 3872 | "width": 42, # The width of the creative |
| 3873 | }, |
| 3874 | "nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value only if creative_size_type = CreativeSizeType.NATIVE. |
| 3875 | "allowedFormats": [ # What formats are allowed by the publisher. If this repeated field is empty then all formats are allowed. For example, if this field contains AllowedFormatType.AUDIO then the publisher only allows an audio ad (without any video). |
| 3876 | "A String", |
| 3877 | ], |
| 3878 | "creativeSizeType": "A String", # The creative size type. |
| 3879 | "skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if creative_size_type = CreativeSizeType.VIDEO. |
| 3880 | }, |
| 3881 | }, |
| 3882 | ], |
| 3883 | }, |
| 3884 | ], |
| 3885 | "targeting": { # Targeting represents different criteria that can be used by advertisers to target ad inventory. For example, they can choose to target ad requests only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. # Output only. Specifies the subset of inventory targeted by the deal. |
| 3886 | "placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Placement targeting information, e.g., URL, mobile applications. |
| 3887 | "urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). For Private Auction and AdX Preferred Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded. |
| 3888 | "excludedUrls": [ # A list of URLs to be excluded. |
| 3889 | "A String", |
| 3890 | ], |
| 3891 | "targetedUrls": [ # A list of URLs to be included. |
| 3892 | "A String", |
| 3893 | ], |
| 3894 | }, |
| 3895 | "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages. |
| 3896 | "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Mobile application IDs are from App Store and Google Play Store. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in. |
| 3897 | "targetedAppIds": [ # A list of application IDs to be included. |
| 3898 | "A String", |
| 3899 | ], |
| 3900 | "excludedAppIds": [ # A list of application IDs to be excluded. |
| 3901 | "A String", |
| 3902 | ], |
| 3903 | }, |
| 3904 | }, |
| 3905 | }, |
| 3906 | "technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category. |
| 3907 | "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # IDs of device capabilities to be included/excluded. |
| 3908 | "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. |
| 3909 | "A String", |
| 3910 | ], |
| 3911 | "targetedCriteriaIds": [ # A list of numeric IDs to be included. |
| 3912 | "A String", |
| 3913 | ], |
| 3914 | }, |
| 3915 | "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # IDs of device categories to be included/excluded. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3916 | "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. |
| 3917 | "A String", |
| 3918 | ], |
| 3919 | "targetedCriteriaIds": [ # A list of numeric IDs to be included. |
| 3920 | "A String", |
| 3921 | ], |
| 3922 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 3923 | "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3924 | "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # IDs of operating systems to be included/excluded. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 3925 | "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. |
| 3926 | "A String", |
| 3927 | ], |
| 3928 | "targetedCriteriaIds": [ # A list of numeric IDs to be included. |
| 3929 | "A String", |
| 3930 | ], |
| 3931 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3932 | "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # IDs of operating system versions to be included/excluded. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 3933 | "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. |
| 3934 | "A String", |
| 3935 | ], |
| 3936 | "targetedCriteriaIds": [ # A list of numeric IDs to be included. |
| 3937 | "A String", |
| 3938 | ], |
| 3939 | }, |
| 3940 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3941 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3942 | "videoTargeting": { # Represents targeting information about video. # Video targeting information. |
| 3943 | "excludedPositionTypes": [ # A list of video positions to be excluded. Position types can either be included or excluded (XOR). |
| 3944 | "A String", |
| 3945 | ], |
| 3946 | "targetedPositionTypes": [ # A list of video positions to be included. When the included list is present, the excluded list must be empty. When the excluded list is present, the included list must be empty. |
| 3947 | "A String", |
| 3948 | ], |
| 3949 | }, |
| 3950 | "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on an ad request. It only applies to Private Auction, AdX Preferred Deals and Auction Packages. This targeting does not apply to Programmatic Guaranteed and Preferred Deals in Ad Manager. # Inventory sizes to be included/excluded. |
| 3951 | "targetedInventorySizes": [ # A list of inventory sizes to be included. |
| 3952 | { # Represents size of a single ad slot, or a creative. |
| 3953 | "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 3954 | "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 3955 | "sizeType": "A String", # The size type of the ad slot. |
| 3956 | }, |
| 3957 | ], |
| 3958 | "excludedInventorySizes": [ # A list of inventory sizes to be excluded. |
| 3959 | { # Represents size of a single ad slot, or a creative. |
| 3960 | "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 3961 | "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 3962 | "sizeType": "A String", # The size type of the ad slot. |
| 3963 | }, |
| 3964 | ], |
| 3965 | }, |
| 3966 | "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # Geo criteria IDs to be included/excluded. |
| 3967 | "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. |
| 3968 | "A String", |
| 3969 | ], |
| 3970 | "targetedCriteriaIds": [ # A list of numeric IDs to be included. |
| 3971 | "A String", |
| 3972 | ], |
| 3973 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3974 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3975 | "externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is finalized. This is the deal ID that shows up in serving/reporting etc. |
| 3976 | "isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this deal. |
| 3977 | "creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ Preferred Deal in Ad Manager. This doesn't apply to Private Auction and AdX Preferred Deals. # Output only. Restricitions about the creatives associated with the deal (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals in Ad Manager. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 3978 | "skippableAdType": "A String", # Skippable video ads allow viewers to skip ads after 5 seconds. |
| 3979 | "creativeSpecifications": [ |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3980 | { # Represents information for a creative that is associated with a Programmatic Guaranteed/Preferred Deal in Ad Manager. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 3981 | "creativeCompanionSizes": [ # Companion sizes may be filled in only when this is a video creative. |
| 3982 | { # Represents size of a single ad slot, or a creative. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3983 | "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 3984 | "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 3985 | "sizeType": "A String", # The size type of the ad slot. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 3986 | }, |
| 3987 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3988 | "creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative. |
| 3989 | "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 3990 | "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 3991 | "sizeType": "A String", # The size type of the ad slot. |
| 3992 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3993 | }, |
| 3994 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 3995 | "creativeFormat": "A String", # The format of the environment that the creatives will be displayed in. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3996 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 3997 | "availableStartTime": "A String", # Optional proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (e.g., in milliseconds) will be truncated towards the start of time in seconds. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 3998 | "sellerContacts": [ # Output only. Seller contact information for the deal. |
| 3999 | { # Contains information on how a buyer or seller can be reached. |
| 4000 | "name": "A String", # The name of the contact. |
| 4001 | "email": "A String", # Email address for the contact. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4002 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4003 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 4004 | "dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal. |
| 4005 | "dealPauseStatus": { # Tracks which parties (if any) have paused a deal. The deal is considered paused if either hasBuyerPaused or hasSellPaused is true. # Output only. Tracks which parties (if any) have paused a deal. |
| 4006 | "buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal. |
| 4007 | "hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally. |
| 4008 | "sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal. |
| 4009 | "hasBuyerPaused": True or False, # True, if the buyer has paused the deal unilaterally. |
| 4010 | "firstPausedBy": "A String", # The role of the person who first paused this deal. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 4011 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 4012 | }, |
| 4013 | "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy. |
| 4014 | "updateTime": "A String", # Output only. The time when the deal was last updated. |
| 4015 | "dealTerms": { # The deal terms specify the details of a Product/deal. They specify things like price per buyer, the type of pricing model (e.g., fixed price, auction) and expected impressions from the publisher. # The negotiable terms of the deal. |
| 4016 | "nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via the API at this time, but can be returned in a get or list request. # The terms for non-guaranteed fixed price deals. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 4017 | "fixedPrices": [ # Fixed price for the specified buyer. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 4018 | { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in a product can become 0 or 1 deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set. |
| 4019 | "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 4020 | "accountId": "A String", # Authorized Buyers account ID of the buyer. |
| 4021 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 4022 | "advertiserIds": [ # The list of advertisers for this price when associated with this buyer. If empty, all advertisers with this buyer pay this price. |
| 4023 | "A String", |
| 4024 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 4025 | "price": { # Represents a price and a pricing type for a product / deal. # The specified price. |
| 4026 | "pricingType": "A String", # The pricing type for the deal/product. (default: CPM) |
| 4027 | "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 4028 | "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 4029 | "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 4030 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 4031 | }, |
| 4032 | }, |
| 4033 | }, |
| 4034 | ], |
| 4035 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 4036 | "description": "A String", # Publisher provided description for the terms. |
| 4037 | "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day. Can be set by buyer or seller. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 4038 | "guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 4039 | "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 4040 | "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product. |
| 4041 | "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. |
| 4042 | "fixedPrices": [ # Fixed price for the specified buyer. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 4043 | { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in a product can become 0 or 1 deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set. |
| 4044 | "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 4045 | "accountId": "A String", # Authorized Buyers account ID of the buyer. |
| 4046 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 4047 | "advertiserIds": [ # The list of advertisers for this price when associated with this buyer. If empty, all advertisers with this buyer pay this price. |
| 4048 | "A String", |
| 4049 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 4050 | "price": { # Represents a price and a pricing type for a product / deal. # The specified price. |
| 4051 | "pricingType": "A String", # The pricing type for the deal/product. (default: CPM) |
| 4052 | "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 4053 | "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 4054 | "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 4055 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 4056 | }, |
| 4057 | }, |
| 4058 | }, |
| 4059 | ], |
| 4060 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 4061 | "sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the time zone used to mark the boundaries of a day. It should be an IANA TZ name, such as "America/Los_Angeles". For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. |
| 4062 | "estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal. Can be set by buyer or seller. |
| 4063 | "pricingType": "A String", # The pricing type for the deal/product. (default: CPM) |
| 4064 | "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified. |
| 4065 | "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 4066 | "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 4067 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 4068 | }, |
| 4069 | }, |
| 4070 | "nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only by the seller, but they can be returned in a get or list request. # The terms for non-guaranteed auction deals. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 4071 | "reservePricesPerBuyer": [ # Reserve price for the specified buyer. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 4072 | { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in a product can become 0 or 1 deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set. |
| 4073 | "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 4074 | "accountId": "A String", # Authorized Buyers account ID of the buyer. |
| 4075 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 4076 | "advertiserIds": [ # The list of advertisers for this price when associated with this buyer. If empty, all advertisers with this buyer pay this price. |
| 4077 | "A String", |
| 4078 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 4079 | "price": { # Represents a price and a pricing type for a product / deal. # The specified price. |
| 4080 | "pricingType": "A String", # The pricing type for the deal/product. (default: CPM) |
| 4081 | "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 4082 | "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 4083 | "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 4084 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 4085 | }, |
| 4086 | }, |
| 4087 | }, |
| 4088 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 4089 | "autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers in this private auction. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 4090 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 4091 | "brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED) |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 4092 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 4093 | "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible. |
| 4094 | "description": "A String", # Description for the deal terms. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4095 | }, |
| 4096 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 4097 | "sellerContacts": [ # Output only. Contact information for the seller. |
| 4098 | { # Contains information on how a buyer or seller can be reached. |
| 4099 | "name": "A String", # The name of the contact. |
| 4100 | "email": "A String", # Email address for the contact. |
| 4101 | }, |
| 4102 | ], |
| 4103 | "billedBuyer": { # Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. # Output only. Reference to the buyer that will get billed for this proposal. |
| 4104 | "accountId": "A String", # Authorized Buyers account ID of the buyer. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4105 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 4106 | "proposalState": "A String", # Output only. The current state of the proposal. |
| 4107 | "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or left a comment. |
| 4108 | "seller": { # Represents a seller of inventory. Each seller is identified by a unique Ad Manager account ID. # Reference to the seller on the proposal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| 4109 | "accountId": "A String", # The unique ID for the seller. The seller fills in this field. The seller account ID is then available to buyer in the product. |
| 4110 | "subAccountId": "A String", # Optional sub-account ID for the seller. |
| 4111 | }, |
| 4112 | "proposalId": "A String", # Output only. The unique ID of the proposal. |
| 4113 | "notes": [ # Output only. The notes associated with this proposal. |
| 4114 | { # A proposal may be associated to several notes. |
| 4115 | "proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created. |
| 4116 | "creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note. |
| 4117 | "note": "A String", # The actual note to attach. (max-length: 1024 unicode code units) Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| 4118 | "noteId": "A String", # Output only. The unique ID for the note. |
| 4119 | "createTime": "A String", # Output only. The timestamp for when this note was created. |
| 4120 | }, |
| 4121 | ], |
| 4122 | "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal. |
| 4123 | "updateTime": "A String", # Output only. The time when the proposal was last revised. |
| 4124 | "isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this proposal. |
| 4125 | "proposalRevision": "A String", # Output only. The revision number for the proposal. Each update to the proposal or the deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4126 | "buyerContacts": [ # Contact information for the buyer. |
| 4127 | { # Contains information on how a buyer or seller can be reached. |
| 4128 | "name": "A String", # The name of the contact. |
| 4129 | "email": "A String", # Email address for the contact. |
| 4130 | }, |
| 4131 | ], |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4132 | } |
| 4133 | |
| 4134 | x__xgafv: string, V1 error format. |
| 4135 | Allowed values |
| 4136 | 1 - v1 error format |
| 4137 | 2 - v2 error format |
| 4138 | |
| 4139 | Returns: |
| 4140 | An object of the form: |
| 4141 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 4142 | { # Note: this resource requires whitelisting for access. Please contact your account manager for access to Marketplace resources. Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer and contains deals which are served. Note: you can not update, create, or otherwise modify Private Auction or Preferred Deals deals through the API. Fields are updatable unless noted otherwise. |
| 4143 | "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. # Reference to the buyer on the proposal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| 4144 | "accountId": "A String", # Authorized Buyers account ID of the buyer. |
| 4145 | }, |
| 4146 | "isRenegotiating": True or False, # Output only. True if the proposal is being renegotiated. |
| 4147 | "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Private data for buyer. (hidden from seller). |
| 4148 | "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). |
| 4149 | }, |
| 4150 | "privateAuctionId": "A String", # Output only. Private auction ID if this proposal is a private auction proposal. |
| 4151 | "displayName": "A String", # The name for the proposal. |
| 4152 | "deals": [ # The deals associated with this proposal. For Private Auction proposals (whose deals have NonGuaranteedAuctionTerms), there will only be one deal. |
| 4153 | { # A deal represents a segment of inventory for displaying ads on. A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving. |
| 4154 | "dealId": "A String", # Output only. A unique deal ID for the deal (server-assigned). |
| 4155 | "syndicationProduct": "A String", # The syndication product associated with the deal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| 4156 | "createTime": "A String", # Output only. The time of the deal creation. |
| 4157 | "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by buyer. |
| 4158 | "availableEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not required for Private Auction deals or Preferred Deals. |
| 4159 | "deliveryControl": { # Message contains details about how the deals will be paced. # The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. |
| 4160 | "frequencyCaps": [ # Output only. Specifies any frequency caps. |
| 4161 | { # Frequency cap. |
| 4162 | "numTimeUnits": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped. |
| 4163 | "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period. |
| 4164 | "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped. |
| 4165 | }, |
| 4166 | ], |
| 4167 | "creativeBlockingLevel": "A String", # Output only. Specified the creative blocking levels to be applied. |
| 4168 | "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced. |
| 4169 | }, |
| 4170 | "createProductId": "A String", # The product ID from which this deal was created. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| 4171 | "webPropertyCode": "A String", # The web property code for the seller copied over from the product. |
| 4172 | "proposalId": "A String", # Output only. ID of the proposal that this deal is part of. |
| 4173 | "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal/deal. # Buyer private data (hidden from seller). |
| 4174 | "referenceId": "A String", # A buyer or seller specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). |
| 4175 | }, |
| 4176 | "createProductRevision": "A String", # Optional revision number of the product that the deal was created from. If present on create, and the server `product_revision` has advanced sinced the passed-in `create_product_revision`, an `ABORTED` error will be returned. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 4177 | "displayName": "A String", # The name of the deal. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 4178 | "targetingCriterion": [ # The shared targeting visible to buyers and sellers. Each shared targeting entity is AND'd together. |
| 4179 | { # Advertisers can target different attributes of an ad slot. For example, they can choose to show ads only if the user is in the U.S. Such targeting criteria can be specified as part of Shared Targeting. |
| 4180 | "key": "A String", # The key representing the shared targeting criterion. Targeting criteria defined by Google ad servers will begin with GOOG_. Third parties may define their own keys. A list of permissible keys along with the acceptable values will be provided as part of the external documentation. |
| 4181 | "inclusions": [ # The list of value to include as part of the targeting. Each value is OR'd together. |
| 4182 | { # A polymorphic targeting value used as part of Shared Targeting. |
| 4183 | "dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING. The definition of this targeting is derived from the structure used by Ad Manager. |
| 4184 | "dayParts": [ # A list of day part targeting criterion. |
| 4185 | { # Daypart targeting message that specifies if the ad can be shown only during certain parts of a day/week. |
| 4186 | "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # The ending time of the day for the ad to show (minute level granularity). The end time is exclusive. This field is not available for filtering in PQL queries. |
| 4187 | "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| 4188 | "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| 4189 | "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| 4190 | "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. |
| 4191 | }, |
| 4192 | "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # The starting time of day for the ad to show (minute level granularity). The start time is inclusive. This field is not available for filtering in PQL queries. |
| 4193 | "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| 4194 | "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| 4195 | "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| 4196 | "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. |
| 4197 | }, |
| 4198 | "dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days. |
| 4199 | }, |
| 4200 | ], |
| 4201 | "timeZoneType": "A String", # The timezone to use for interpreting the day part targeting. |
| 4202 | }, |
| 4203 | "longValue": "A String", # The long value to include/exclude. |
| 4204 | "stringValue": "A String", # The string value to include/exclude. |
| 4205 | "creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude. Filled in when key = GOOG_CREATIVE_SIZE |
| 4206 | "companionSizes": [ # For video creatives specifies the sizes of companion ads (if present). Companion sizes may be filled in only when creative_size_type = VIDEO |
| 4207 | { # Message depicting the size of the creative. The units of width and height depend on the type of the targeting. |
| 4208 | "height": 42, # The height of the creative. |
| 4209 | "width": 42, # The width of the creative |
| 4210 | }, |
| 4211 | ], |
| 4212 | "size": { # Message depicting the size of the creative. The units of width and height depend on the type of the targeting. # For regular or video creative size type, specifies the size of the creative |
| 4213 | "height": 42, # The height of the creative. |
| 4214 | "width": 42, # The width of the creative |
| 4215 | }, |
| 4216 | "nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value only if creative_size_type = CreativeSizeType.NATIVE. |
| 4217 | "allowedFormats": [ # What formats are allowed by the publisher. If this repeated field is empty then all formats are allowed. For example, if this field contains AllowedFormatType.AUDIO then the publisher only allows an audio ad (without any video). |
| 4218 | "A String", |
| 4219 | ], |
| 4220 | "creativeSizeType": "A String", # The creative size type. |
| 4221 | "skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if creative_size_type = CreativeSizeType.VIDEO. |
| 4222 | }, |
| 4223 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 4224 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 4225 | "exclusions": [ # The list of values to exclude from targeting. Each value is AND'd together. |
| 4226 | { # A polymorphic targeting value used as part of Shared Targeting. |
| 4227 | "dayPartTargetingValue": { # Specifies the day part targeting criteria. # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING. The definition of this targeting is derived from the structure used by Ad Manager. |
| 4228 | "dayParts": [ # A list of day part targeting criterion. |
| 4229 | { # Daypart targeting message that specifies if the ad can be shown only during certain parts of a day/week. |
| 4230 | "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # The ending time of the day for the ad to show (minute level granularity). The end time is exclusive. This field is not available for filtering in PQL queries. |
| 4231 | "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| 4232 | "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| 4233 | "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| 4234 | "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. |
| 4235 | }, |
| 4236 | "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # The starting time of day for the ad to show (minute level granularity). The start time is inclusive. This field is not available for filtering in PQL queries. |
| 4237 | "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| 4238 | "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| 4239 | "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| 4240 | "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. |
| 4241 | }, |
| 4242 | "dayOfWeek": "A String", # The day of the week to target. If unspecified, applicable to all days. |
| 4243 | }, |
| 4244 | ], |
| 4245 | "timeZoneType": "A String", # The timezone to use for interpreting the day part targeting. |
| 4246 | }, |
| 4247 | "longValue": "A String", # The long value to include/exclude. |
| 4248 | "stringValue": "A String", # The string value to include/exclude. |
| 4249 | "creativeSizeValue": { # Specifies the size of the creative. # The creative size value to include/exclude. Filled in when key = GOOG_CREATIVE_SIZE |
| 4250 | "companionSizes": [ # For video creatives specifies the sizes of companion ads (if present). Companion sizes may be filled in only when creative_size_type = VIDEO |
| 4251 | { # Message depicting the size of the creative. The units of width and height depend on the type of the targeting. |
| 4252 | "height": 42, # The height of the creative. |
| 4253 | "width": 42, # The width of the creative |
| 4254 | }, |
| 4255 | ], |
| 4256 | "size": { # Message depicting the size of the creative. The units of width and height depend on the type of the targeting. # For regular or video creative size type, specifies the size of the creative |
| 4257 | "height": 42, # The height of the creative. |
| 4258 | "width": 42, # The width of the creative |
| 4259 | }, |
| 4260 | "nativeTemplate": "A String", # Output only. The native template for this creative. It will have a value only if creative_size_type = CreativeSizeType.NATIVE. |
| 4261 | "allowedFormats": [ # What formats are allowed by the publisher. If this repeated field is empty then all formats are allowed. For example, if this field contains AllowedFormatType.AUDIO then the publisher only allows an audio ad (without any video). |
| 4262 | "A String", |
| 4263 | ], |
| 4264 | "creativeSizeType": "A String", # The creative size type. |
| 4265 | "skippableAdType": "A String", # The type of skippable ad for this creative. It will have a value only if creative_size_type = CreativeSizeType.VIDEO. |
| 4266 | }, |
| 4267 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 4268 | ], |
| 4269 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 4270 | ], |
| 4271 | "targeting": { # Targeting represents different criteria that can be used by advertisers to target ad inventory. For example, they can choose to target ad requests only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. # Output only. Specifies the subset of inventory targeted by the deal. |
| 4272 | "placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Placement targeting information, e.g., URL, mobile applications. |
| 4273 | "urlTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). For Private Auction and AdX Preferred Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 4274 | "excludedUrls": [ # A list of URLs to be excluded. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4275 | "A String", |
| 4276 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 4277 | "targetedUrls": [ # A list of URLs to be included. |
| 4278 | "A String", |
| 4279 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4280 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 4281 | "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages. |
| 4282 | "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Mobile application IDs are from App Store and Google Play Store. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4283 | "targetedAppIds": [ # A list of application IDs to be included. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 4284 | "A String", |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4285 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 4286 | "excludedAppIds": [ # A list of application IDs to be excluded. |
| 4287 | "A String", |
| 4288 | ], |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4289 | }, |
| 4290 | }, |
| 4291 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4292 | "technologyTargeting": { # Represents targeting about various types of technology. # Technology targeting information, e.g., operating system, device category. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 4293 | "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # IDs of device capabilities to be included/excluded. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4294 | "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. |
| 4295 | "A String", |
| 4296 | ], |
| 4297 | "targetedCriteriaIds": [ # A list of numeric IDs to be included. |
| 4298 | "A String", |
| 4299 | ], |
| 4300 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 4301 | "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # IDs of device categories to be included/excluded. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4302 | "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. |
| 4303 | "A String", |
| 4304 | ], |
| 4305 | "targetedCriteriaIds": [ # A list of numeric IDs to be included. |
| 4306 | "A String", |
| 4307 | ], |
| 4308 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 4309 | "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 4310 | "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # IDs of operating systems to be included/excluded. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 4311 | "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. |
| 4312 | "A String", |
| 4313 | ], |
| 4314 | "targetedCriteriaIds": [ # A list of numeric IDs to be included. |
| 4315 | "A String", |
| 4316 | ], |
| 4317 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 4318 | "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # IDs of operating system versions to be included/excluded. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 4319 | "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. |
| 4320 | "A String", |
| 4321 | ], |
| 4322 | "targetedCriteriaIds": [ # A list of numeric IDs to be included. |
| 4323 | "A String", |
| 4324 | ], |
| 4325 | }, |
| 4326 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4327 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 4328 | "videoTargeting": { # Represents targeting information about video. # Video targeting information. |
| 4329 | "excludedPositionTypes": [ # A list of video positions to be excluded. Position types can either be included or excluded (XOR). |
| 4330 | "A String", |
| 4331 | ], |
| 4332 | "targetedPositionTypes": [ # A list of video positions to be included. When the included list is present, the excluded list must be empty. When the excluded list is present, the included list must be empty. |
| 4333 | "A String", |
| 4334 | ], |
| 4335 | }, |
| 4336 | "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on an ad request. It only applies to Private Auction, AdX Preferred Deals and Auction Packages. This targeting does not apply to Programmatic Guaranteed and Preferred Deals in Ad Manager. # Inventory sizes to be included/excluded. |
| 4337 | "targetedInventorySizes": [ # A list of inventory sizes to be included. |
| 4338 | { # Represents size of a single ad slot, or a creative. |
| 4339 | "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 4340 | "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 4341 | "sizeType": "A String", # The size type of the ad slot. |
| 4342 | }, |
| 4343 | ], |
| 4344 | "excludedInventorySizes": [ # A list of inventory sizes to be excluded. |
| 4345 | { # Represents size of a single ad slot, or a creative. |
| 4346 | "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 4347 | "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 4348 | "sizeType": "A String", # The size type of the ad slot. |
| 4349 | }, |
| 4350 | ], |
| 4351 | }, |
| 4352 | "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. # Geo criteria IDs to be included/excluded. |
| 4353 | "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. |
| 4354 | "A String", |
| 4355 | ], |
| 4356 | "targetedCriteriaIds": [ # A list of numeric IDs to be included. |
| 4357 | "A String", |
| 4358 | ], |
| 4359 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4360 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 4361 | "externalDealId": "A String", # Output only. The external deal ID assigned to this deal once the deal is finalized. This is the deal ID that shows up in serving/reporting etc. |
| 4362 | "isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this deal. |
| 4363 | "creativeRestrictions": { # Represents creative restrictions associated to Programmatic Guaranteed/ Preferred Deal in Ad Manager. This doesn't apply to Private Auction and AdX Preferred Deals. # Output only. Restricitions about the creatives associated with the deal (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals in Ad Manager. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 4364 | "skippableAdType": "A String", # Skippable video ads allow viewers to skip ads after 5 seconds. |
| 4365 | "creativeSpecifications": [ |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 4366 | { # Represents information for a creative that is associated with a Programmatic Guaranteed/Preferred Deal in Ad Manager. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 4367 | "creativeCompanionSizes": [ # Companion sizes may be filled in only when this is a video creative. |
| 4368 | { # Represents size of a single ad slot, or a creative. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 4369 | "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 4370 | "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 4371 | "sizeType": "A String", # The size type of the ad slot. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 4372 | }, |
| 4373 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 4374 | "creativeSize": { # Represents size of a single ad slot, or a creative. # The size of the creative. |
| 4375 | "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 4376 | "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`. |
| 4377 | "sizeType": "A String", # The size type of the ad slot. |
| 4378 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4379 | }, |
| 4380 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 4381 | "creativeFormat": "A String", # The format of the environment that the creatives will be displayed in. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4382 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 4383 | "availableStartTime": "A String", # Optional proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (e.g., in milliseconds) will be truncated towards the start of time in seconds. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4384 | "sellerContacts": [ # Output only. Seller contact information for the deal. |
| 4385 | { # Contains information on how a buyer or seller can be reached. |
| 4386 | "name": "A String", # The name of the contact. |
| 4387 | "email": "A String", # Email address for the contact. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4388 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4389 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 4390 | "dealServingMetadata": { # Message captures metadata about the serving status of a deal. # Output only. Metadata about the serving status of this deal. |
| 4391 | "dealPauseStatus": { # Tracks which parties (if any) have paused a deal. The deal is considered paused if either hasBuyerPaused or hasSellPaused is true. # Output only. Tracks which parties (if any) have paused a deal. |
| 4392 | "buyerPauseReason": "A String", # The buyer's reason for pausing, if the buyer paused the deal. |
| 4393 | "hasSellerPaused": True or False, # True, if the seller has paused the deal unilaterally. |
| 4394 | "sellerPauseReason": "A String", # The seller's reason for pausing, if the seller paused the deal. |
| 4395 | "hasBuyerPaused": True or False, # True, if the buyer has paused the deal unilaterally. |
| 4396 | "firstPausedBy": "A String", # The role of the person who first paused this deal. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 4397 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 4398 | }, |
| 4399 | "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy. |
| 4400 | "updateTime": "A String", # Output only. The time when the deal was last updated. |
| 4401 | "dealTerms": { # The deal terms specify the details of a Product/deal. They specify things like price per buyer, the type of pricing model (e.g., fixed price, auction) and expected impressions from the publisher. # The negotiable terms of the deal. |
| 4402 | "nonGuaranteedFixedPriceTerms": { # Terms for Preferred Deals. Note that Preferred Deals cannot be created via the API at this time, but can be returned in a get or list request. # The terms for non-guaranteed fixed price deals. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 4403 | "fixedPrices": [ # Fixed price for the specified buyer. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 4404 | { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in a product can become 0 or 1 deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set. |
| 4405 | "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 4406 | "accountId": "A String", # Authorized Buyers account ID of the buyer. |
| 4407 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 4408 | "advertiserIds": [ # The list of advertisers for this price when associated with this buyer. If empty, all advertisers with this buyer pay this price. |
| 4409 | "A String", |
| 4410 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 4411 | "price": { # Represents a price and a pricing type for a product / deal. # The specified price. |
| 4412 | "pricingType": "A String", # The pricing type for the deal/product. (default: CPM) |
| 4413 | "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 4414 | "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 4415 | "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 4416 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 4417 | }, |
| 4418 | }, |
| 4419 | }, |
| 4420 | ], |
| 4421 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 4422 | "description": "A String", # Publisher provided description for the terms. |
| 4423 | "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day. Can be set by buyer or seller. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 4424 | "guaranteedFixedPriceTerms": { # Terms for Programmatic Guaranteed Deals. # The terms for guaranteed fixed price deals. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 4425 | "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 4426 | "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product. |
| 4427 | "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. |
| 4428 | "fixedPrices": [ # Fixed price for the specified buyer. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 4429 | { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in a product can become 0 or 1 deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set. |
| 4430 | "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 4431 | "accountId": "A String", # Authorized Buyers account ID of the buyer. |
| 4432 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 4433 | "advertiserIds": [ # The list of advertisers for this price when associated with this buyer. If empty, all advertisers with this buyer pay this price. |
| 4434 | "A String", |
| 4435 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 4436 | "price": { # Represents a price and a pricing type for a product / deal. # The specified price. |
| 4437 | "pricingType": "A String", # The pricing type for the deal/product. (default: CPM) |
| 4438 | "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 4439 | "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 4440 | "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 4441 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 4442 | }, |
| 4443 | }, |
| 4444 | }, |
| 4445 | ], |
| 4446 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 4447 | "sellerTimeZone": "A String", # The time zone name. For deals with Cost Per Day billing, defines the time zone used to mark the boundaries of a day. It should be an IANA TZ name, such as "America/Los_Angeles". For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. |
| 4448 | "estimatedGrossSpend": { # Represents a price and a pricing type for a product / deal. # Non-binding estimate of the estimated gross spend for this deal. Can be set by buyer or seller. |
| 4449 | "pricingType": "A String", # The pricing type for the deal/product. (default: CPM) |
| 4450 | "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified. |
| 4451 | "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 4452 | "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| 4453 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 4454 | }, |
| 4455 | }, |
| 4456 | "nonGuaranteedAuctionTerms": { # Terms for Private Auctions. Note that Private Auctions can be created only by the seller, but they can be returned in a get or list request. # The terms for non-guaranteed auction deals. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 4457 | "reservePricesPerBuyer": [ # Reserve price for the specified buyer. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 4458 | { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in a product can become 0 or 1 deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set. |
| 4459 | "buyer": { # Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 4460 | "accountId": "A String", # Authorized Buyers account ID of the buyer. |
| 4461 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 4462 | "advertiserIds": [ # The list of advertisers for this price when associated with this buyer. If empty, all advertisers with this buyer pay this price. |
| 4463 | "A String", |
| 4464 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 4465 | "price": { # Represents a price and a pricing type for a product / deal. # The specified price. |
| 4466 | "pricingType": "A String", # The pricing type for the deal/product. (default: CPM) |
| 4467 | "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 4468 | "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. |
| 4469 | "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 4470 | "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. |
| 4471 | }, |
| 4472 | }, |
| 4473 | }, |
| 4474 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 4475 | "autoOptimizePrivateAuction": True or False, # True if open auction buyers are allowed to compete with invited buyers in this private auction. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 4476 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 4477 | "brandingType": "A String", # Visibility of the URL in bid requests. (default: BRANDED) |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 4478 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 4479 | "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible. |
| 4480 | "description": "A String", # Description for the deal terms. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4481 | }, |
| 4482 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 4483 | "sellerContacts": [ # Output only. Contact information for the seller. |
| 4484 | { # Contains information on how a buyer or seller can be reached. |
| 4485 | "name": "A String", # The name of the contact. |
| 4486 | "email": "A String", # Email address for the contact. |
| 4487 | }, |
| 4488 | ], |
| 4489 | "billedBuyer": { # Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID. # Output only. Reference to the buyer that will get billed for this proposal. |
| 4490 | "accountId": "A String", # Authorized Buyers account ID of the buyer. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4491 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 4492 | "proposalState": "A String", # Output only. The current state of the proposal. |
| 4493 | "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or left a comment. |
| 4494 | "seller": { # Represents a seller of inventory. Each seller is identified by a unique Ad Manager account ID. # Reference to the seller on the proposal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| 4495 | "accountId": "A String", # The unique ID for the seller. The seller fills in this field. The seller account ID is then available to buyer in the product. |
| 4496 | "subAccountId": "A String", # Optional sub-account ID for the seller. |
| 4497 | }, |
| 4498 | "proposalId": "A String", # Output only. The unique ID of the proposal. |
| 4499 | "notes": [ # Output only. The notes associated with this proposal. |
| 4500 | { # A proposal may be associated to several notes. |
| 4501 | "proposalRevision": "A String", # Output only. The revision number of the proposal when the note is created. |
| 4502 | "creatorRole": "A String", # Output only. The role of the person (buyer/seller) creating the note. |
| 4503 | "note": "A String", # The actual note to attach. (max-length: 1024 unicode code units) Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| 4504 | "noteId": "A String", # Output only. The unique ID for the note. |
| 4505 | "createTime": "A String", # Output only. The timestamp for when this note was created. |
| 4506 | }, |
| 4507 | ], |
| 4508 | "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal. |
| 4509 | "updateTime": "A String", # Output only. The time when the proposal was last revised. |
| 4510 | "isSetupComplete": True or False, # Output only. True, if the buyside inventory setup is complete for this proposal. |
| 4511 | "proposalRevision": "A String", # Output only. The revision number for the proposal. Each update to the proposal or the deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 4512 | "buyerContacts": [ # Contact information for the buyer. |
| 4513 | { # Contains information on how a buyer or seller can be reached. |
| 4514 | "name": "A String", # The name of the contact. |
| 4515 | "email": "A String", # Email address for the contact. |
| 4516 | }, |
| 4517 | ], |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4518 | }</pre> |
| 4519 | </div> |
| 4520 | |
| 4521 | </body></html> |