1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="authorizedbuyersmarketplace_v1.html">Authorized Buyers Marketplace API</a> . <a href="authorizedbuyersmarketplace_v1.buyers.html">buyers</a> . <a href="authorizedbuyersmarketplace_v1.buyers.proposals.html">proposals</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="authorizedbuyersmarketplace_v1.buyers.proposals.deals.html">deals()</a></code> 79</p> 80<p class="firstline">Returns the deals Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="#accept">accept(name, body=None, x__xgafv=None)</a></code></p> 84<p class="firstline">Accepts the proposal at the given revision number. If the revision number in the request is behind the latest from the server, an error message will be returned. This call updates the Proposal.state from `BUYER_ACCEPTANCE_REQUESTED` to `FINALIZED`; it has no side effect if the Proposal.state is already `FINALIZED` and throws exception if the Proposal.state is not either `BUYER_ACCEPTANCE_REQUESTED` or `FINALIZED`. Accepting a proposal means the buyer understands and accepts the Proposal.terms_and_conditions proposed by the seller.</p> 85<p class="toc_element"> 86 <code><a href="#addNote">addNote(proposal, body=None, x__xgafv=None)</a></code></p> 87<p class="firstline">Creates a note for this proposal and sends to the seller.</p> 88<p class="toc_element"> 89 <code><a href="#cancelNegotiation">cancelNegotiation(proposal, body=None, x__xgafv=None)</a></code></p> 90<p class="firstline">Cancels an ongoing negotiation on a proposal. This does not cancel or end serving for the deals if the proposal has been finalized. If the proposal has not been finalized before, calling this method will set the Proposal.state to `TERMINATED` and increment the Proposal.proposal_revision. If the proposal has been finalized before and is under renegotiation now, calling this method will reset the Proposal.state to `FINALIZED` and increment the Proposal.proposal_revision. This method does not support private auction proposals whose Proposal.deal_type is 'PRIVATE_AUCTION'.</p> 91<p class="toc_element"> 92 <code><a href="#close">close()</a></code></p> 93<p class="firstline">Close httplib2 connections.</p> 94<p class="toc_element"> 95 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 96<p class="firstline">Gets a proposal using its name. The proposal is returned at most recent revision. revision.</p> 97<p class="toc_element"> 98 <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 99<p class="firstline">Lists proposals. A filter expression (list filter syntax) may be specified to filter the results. This will not list finalized versions of proposals that are being renegotiated; to retrieve these use the finalizedProposals resource.</p> 100<p class="toc_element"> 101 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 102<p class="firstline">Retrieves the next page of results.</p> 103<p class="toc_element"> 104 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> 105<p class="firstline">Updates the proposal at the given revision number. If the revision number in the request is behind the latest from the server, an error message will be returned. See FieldMask for how to use FieldMask. Only fields specified in the UpdateProposalRequest.update_mask will be updated; Fields noted as 'Immutable' or 'Output only' yet specified in the UpdateProposalRequest.update_mask will be ignored and left unchanged. Updating a private auction proposal is not allowed and will result in an error.</p> 106<p class="toc_element"> 107 <code><a href="#sendRfp">sendRfp(buyer, body=None, x__xgafv=None)</a></code></p> 108<p class="firstline">Sends a request for proposal (RFP) to a publisher to initiate the negotiation regarding certain inventory. In the RFP, buyers can specify the deal type, deal terms, start and end dates, targeting, and a message to the publisher. Once the RFP is sent, a proposal in `SELLER_REVIEW_REQUESTED` state will be created and returned in the response. The publisher may review your request and respond with detailed deals in the proposal.</p> 109<h3>Method Details</h3> 110<div class="method"> 111 <code class="details" id="accept">accept(name, body=None, x__xgafv=None)</code> 112 <pre>Accepts the proposal at the given revision number. If the revision number in the request is behind the latest from the server, an error message will be returned. This call updates the Proposal.state from `BUYER_ACCEPTANCE_REQUESTED` to `FINALIZED`; it has no side effect if the Proposal.state is already `FINALIZED` and throws exception if the Proposal.state is not either `BUYER_ACCEPTANCE_REQUESTED` or `FINALIZED`. Accepting a proposal means the buyer understands and accepts the Proposal.terms_and_conditions proposed by the seller. 113 114Args: 115 name: string, Name of the proposal. Format: `buyers/{accountId}/proposals/{proposalId}` (required) 116 body: object, The request body. 117 The object takes the form of: 118 119{ # Request to accept a proposal. Accepting a proposal implies acceptance of the publisher terms_and_conditions, if any. 120 "proposalRevision": "A String", # The last known client revision number of the proposal. 121} 122 123 x__xgafv: string, V1 error format. 124 Allowed values 125 1 - v1 error format 126 2 - v2 error format 127 128Returns: 129 An object of the form: 130 131 { # Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer. 132 "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer. Format : `buyers/{buyerAccountId}` 133 "buyer": "A String", # Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}` 134 "buyerContacts": [ # Contact information for the buyer. 135 { # Contains information on how a buyer or seller can be reached. 136 "displayName": "A String", # The display_name of the contact. 137 "email": "A String", # Email address for the contact. 138 }, 139 ], 140 "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal or deal. # Buyer private data (hidden from seller). 141 "referenceId": "A String", # A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). 142 }, 143 "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}` 144 "dealType": "A String", # Output only. Type of deal the proposal contains. 145 "displayName": "A String", # Output only. The descriptive name for the proposal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the proposal. 146 "isRenegotiating": True or False, # Output only. True if the proposal was previously finalized and is now being renegotiated. 147 "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or left a comment. 148 "name": "A String", # Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId} 149 "notes": [ # A list of notes from the buyer and the seller attached to this proposal. 150 { # A text note attached to the proposal to facilitate the communication between buyers and sellers. 151 "createTime": "A String", # Output only. When this note was created. 152 "creatorRole": "A String", # Output only. The role who created the note. 153 "note": "A String", # The text of the note. Maximum length is 1024 characters. 154 }, 155 ], 156 "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal. 157 "pausingConsented": True or False, # Whether pausing is allowed for the proposal. This is a negotiable term between buyers and publishers. 158 "proposalRevision": "A String", # Output only. The revision number for the proposal. Each update to the proposal or 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. 159 "publisherProfile": "A String", # Immutable. Reference to the seller on the proposal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}` Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. 160 "sellerContacts": [ # Output only. Contact information for the seller. 161 { # Contains information on how a buyer or seller can be reached. 162 "displayName": "A String", # The display_name of the contact. 163 "email": "A String", # Email address for the contact. 164 }, 165 ], 166 "state": "A String", # Output only. Indicates the state of the proposal. 167 "termsAndConditions": "A String", # Output only. The terms and conditions associated with this proposal. Accepting a proposal implies acceptance of this field. This is created by the seller, the buyer can only view it. 168 "updateTime": "A String", # Output only. The time when the proposal was last revised. 169}</pre> 170</div> 171 172<div class="method"> 173 <code class="details" id="addNote">addNote(proposal, body=None, x__xgafv=None)</code> 174 <pre>Creates a note for this proposal and sends to the seller. 175 176Args: 177 proposal: string, Name of the proposal. Format: `buyers/{accountId}/proposals/{proposalId}` (required) 178 body: object, The request body. 179 The object takes the form of: 180 181{ # Request to add a note. 182 "note": { # A text note attached to the proposal to facilitate the communication between buyers and sellers. # The note to add. 183 "createTime": "A String", # Output only. When this note was created. 184 "creatorRole": "A String", # Output only. The role who created the note. 185 "note": "A String", # The text of the note. Maximum length is 1024 characters. 186 }, 187} 188 189 x__xgafv: string, V1 error format. 190 Allowed values 191 1 - v1 error format 192 2 - v2 error format 193 194Returns: 195 An object of the form: 196 197 { # Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer. 198 "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer. Format : `buyers/{buyerAccountId}` 199 "buyer": "A String", # Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}` 200 "buyerContacts": [ # Contact information for the buyer. 201 { # Contains information on how a buyer or seller can be reached. 202 "displayName": "A String", # The display_name of the contact. 203 "email": "A String", # Email address for the contact. 204 }, 205 ], 206 "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal or deal. # Buyer private data (hidden from seller). 207 "referenceId": "A String", # A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). 208 }, 209 "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}` 210 "dealType": "A String", # Output only. Type of deal the proposal contains. 211 "displayName": "A String", # Output only. The descriptive name for the proposal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the proposal. 212 "isRenegotiating": True or False, # Output only. True if the proposal was previously finalized and is now being renegotiated. 213 "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or left a comment. 214 "name": "A String", # Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId} 215 "notes": [ # A list of notes from the buyer and the seller attached to this proposal. 216 { # A text note attached to the proposal to facilitate the communication between buyers and sellers. 217 "createTime": "A String", # Output only. When this note was created. 218 "creatorRole": "A String", # Output only. The role who created the note. 219 "note": "A String", # The text of the note. Maximum length is 1024 characters. 220 }, 221 ], 222 "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal. 223 "pausingConsented": True or False, # Whether pausing is allowed for the proposal. This is a negotiable term between buyers and publishers. 224 "proposalRevision": "A String", # Output only. The revision number for the proposal. Each update to the proposal or 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. 225 "publisherProfile": "A String", # Immutable. Reference to the seller on the proposal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}` Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. 226 "sellerContacts": [ # Output only. Contact information for the seller. 227 { # Contains information on how a buyer or seller can be reached. 228 "displayName": "A String", # The display_name of the contact. 229 "email": "A String", # Email address for the contact. 230 }, 231 ], 232 "state": "A String", # Output only. Indicates the state of the proposal. 233 "termsAndConditions": "A String", # Output only. The terms and conditions associated with this proposal. Accepting a proposal implies acceptance of this field. This is created by the seller, the buyer can only view it. 234 "updateTime": "A String", # Output only. The time when the proposal was last revised. 235}</pre> 236</div> 237 238<div class="method"> 239 <code class="details" id="cancelNegotiation">cancelNegotiation(proposal, body=None, x__xgafv=None)</code> 240 <pre>Cancels an ongoing negotiation on a proposal. This does not cancel or end serving for the deals if the proposal has been finalized. If the proposal has not been finalized before, calling this method will set the Proposal.state to `TERMINATED` and increment the Proposal.proposal_revision. If the proposal has been finalized before and is under renegotiation now, calling this method will reset the Proposal.state to `FINALIZED` and increment the Proposal.proposal_revision. This method does not support private auction proposals whose Proposal.deal_type is 'PRIVATE_AUCTION'. 241 242Args: 243 proposal: string, Name of the proposal. Format: `buyers/{accountId}/proposals/{proposalId}` (required) 244 body: object, The request body. 245 The object takes the form of: 246 247{ # Request to cancel an ongoing negotiation. 248} 249 250 x__xgafv: string, V1 error format. 251 Allowed values 252 1 - v1 error format 253 2 - v2 error format 254 255Returns: 256 An object of the form: 257 258 { # Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer. 259 "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer. Format : `buyers/{buyerAccountId}` 260 "buyer": "A String", # Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}` 261 "buyerContacts": [ # Contact information for the buyer. 262 { # Contains information on how a buyer or seller can be reached. 263 "displayName": "A String", # The display_name of the contact. 264 "email": "A String", # Email address for the contact. 265 }, 266 ], 267 "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal or deal. # Buyer private data (hidden from seller). 268 "referenceId": "A String", # A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). 269 }, 270 "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}` 271 "dealType": "A String", # Output only. Type of deal the proposal contains. 272 "displayName": "A String", # Output only. The descriptive name for the proposal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the proposal. 273 "isRenegotiating": True or False, # Output only. True if the proposal was previously finalized and is now being renegotiated. 274 "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or left a comment. 275 "name": "A String", # Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId} 276 "notes": [ # A list of notes from the buyer and the seller attached to this proposal. 277 { # A text note attached to the proposal to facilitate the communication between buyers and sellers. 278 "createTime": "A String", # Output only. When this note was created. 279 "creatorRole": "A String", # Output only. The role who created the note. 280 "note": "A String", # The text of the note. Maximum length is 1024 characters. 281 }, 282 ], 283 "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal. 284 "pausingConsented": True or False, # Whether pausing is allowed for the proposal. This is a negotiable term between buyers and publishers. 285 "proposalRevision": "A String", # Output only. The revision number for the proposal. Each update to the proposal or 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. 286 "publisherProfile": "A String", # Immutable. Reference to the seller on the proposal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}` Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. 287 "sellerContacts": [ # Output only. Contact information for the seller. 288 { # Contains information on how a buyer or seller can be reached. 289 "displayName": "A String", # The display_name of the contact. 290 "email": "A String", # Email address for the contact. 291 }, 292 ], 293 "state": "A String", # Output only. Indicates the state of the proposal. 294 "termsAndConditions": "A String", # Output only. The terms and conditions associated with this proposal. Accepting a proposal implies acceptance of this field. This is created by the seller, the buyer can only view it. 295 "updateTime": "A String", # Output only. The time when the proposal was last revised. 296}</pre> 297</div> 298 299<div class="method"> 300 <code class="details" id="close">close()</code> 301 <pre>Close httplib2 connections.</pre> 302</div> 303 304<div class="method"> 305 <code class="details" id="get">get(name, x__xgafv=None)</code> 306 <pre>Gets a proposal using its name. The proposal is returned at most recent revision. revision. 307 308Args: 309 name: string, Required. Name of the proposal. Format: `buyers/{accountId}/proposals/{proposalId}` (required) 310 x__xgafv: string, V1 error format. 311 Allowed values 312 1 - v1 error format 313 2 - v2 error format 314 315Returns: 316 An object of the form: 317 318 { # Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer. 319 "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer. Format : `buyers/{buyerAccountId}` 320 "buyer": "A String", # Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}` 321 "buyerContacts": [ # Contact information for the buyer. 322 { # Contains information on how a buyer or seller can be reached. 323 "displayName": "A String", # The display_name of the contact. 324 "email": "A String", # Email address for the contact. 325 }, 326 ], 327 "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal or deal. # Buyer private data (hidden from seller). 328 "referenceId": "A String", # A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). 329 }, 330 "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}` 331 "dealType": "A String", # Output only. Type of deal the proposal contains. 332 "displayName": "A String", # Output only. The descriptive name for the proposal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the proposal. 333 "isRenegotiating": True or False, # Output only. True if the proposal was previously finalized and is now being renegotiated. 334 "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or left a comment. 335 "name": "A String", # Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId} 336 "notes": [ # A list of notes from the buyer and the seller attached to this proposal. 337 { # A text note attached to the proposal to facilitate the communication between buyers and sellers. 338 "createTime": "A String", # Output only. When this note was created. 339 "creatorRole": "A String", # Output only. The role who created the note. 340 "note": "A String", # The text of the note. Maximum length is 1024 characters. 341 }, 342 ], 343 "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal. 344 "pausingConsented": True or False, # Whether pausing is allowed for the proposal. This is a negotiable term between buyers and publishers. 345 "proposalRevision": "A String", # Output only. The revision number for the proposal. Each update to the proposal or 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. 346 "publisherProfile": "A String", # Immutable. Reference to the seller on the proposal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}` Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. 347 "sellerContacts": [ # Output only. Contact information for the seller. 348 { # Contains information on how a buyer or seller can be reached. 349 "displayName": "A String", # The display_name of the contact. 350 "email": "A String", # Email address for the contact. 351 }, 352 ], 353 "state": "A String", # Output only. Indicates the state of the proposal. 354 "termsAndConditions": "A String", # Output only. The terms and conditions associated with this proposal. Accepting a proposal implies acceptance of this field. This is created by the seller, the buyer can only view it. 355 "updateTime": "A String", # Output only. The time when the proposal was last revised. 356}</pre> 357</div> 358 359<div class="method"> 360 <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> 361 <pre>Lists proposals. A filter expression (list filter syntax) may be specified to filter the results. This will not list finalized versions of proposals that are being renegotiated; to retrieve these use the finalizedProposals resource. 362 363Args: 364 parent: string, Required. Parent that owns the collection of proposals Format: `buyers/{accountId}` (required) 365 filter: string, Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters) Supported columns for filtering are: * displayName * dealType * updateTime * state 366 pageSize: integer, Requested page size. The server may return fewer results than requested. If unspecified, the server will put a size of 500. 367 pageToken: string, The page token as returned from ListProposalsResponse. 368 x__xgafv: string, V1 error format. 369 Allowed values 370 1 - v1 error format 371 2 - v2 error format 372 373Returns: 374 An object of the form: 375 376 { # Response message for listing proposals. 377 "nextPageToken": "A String", # Continuation token for fetching the next page of results. 378 "proposals": [ # The list of proposals. 379 { # Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer. 380 "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer. Format : `buyers/{buyerAccountId}` 381 "buyer": "A String", # Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}` 382 "buyerContacts": [ # Contact information for the buyer. 383 { # Contains information on how a buyer or seller can be reached. 384 "displayName": "A String", # The display_name of the contact. 385 "email": "A String", # Email address for the contact. 386 }, 387 ], 388 "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal or deal. # Buyer private data (hidden from seller). 389 "referenceId": "A String", # A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). 390 }, 391 "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}` 392 "dealType": "A String", # Output only. Type of deal the proposal contains. 393 "displayName": "A String", # Output only. The descriptive name for the proposal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the proposal. 394 "isRenegotiating": True or False, # Output only. True if the proposal was previously finalized and is now being renegotiated. 395 "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or left a comment. 396 "name": "A String", # Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId} 397 "notes": [ # A list of notes from the buyer and the seller attached to this proposal. 398 { # A text note attached to the proposal to facilitate the communication between buyers and sellers. 399 "createTime": "A String", # Output only. When this note was created. 400 "creatorRole": "A String", # Output only. The role who created the note. 401 "note": "A String", # The text of the note. Maximum length is 1024 characters. 402 }, 403 ], 404 "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal. 405 "pausingConsented": True or False, # Whether pausing is allowed for the proposal. This is a negotiable term between buyers and publishers. 406 "proposalRevision": "A String", # Output only. The revision number for the proposal. Each update to the proposal or 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. 407 "publisherProfile": "A String", # Immutable. Reference to the seller on the proposal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}` Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. 408 "sellerContacts": [ # Output only. Contact information for the seller. 409 { # Contains information on how a buyer or seller can be reached. 410 "displayName": "A String", # The display_name of the contact. 411 "email": "A String", # Email address for the contact. 412 }, 413 ], 414 "state": "A String", # Output only. Indicates the state of the proposal. 415 "termsAndConditions": "A String", # Output only. The terms and conditions associated with this proposal. Accepting a proposal implies acceptance of this field. This is created by the seller, the buyer can only view it. 416 "updateTime": "A String", # Output only. The time when the proposal was last revised. 417 }, 418 ], 419}</pre> 420</div> 421 422<div class="method"> 423 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 424 <pre>Retrieves the next page of results. 425 426Args: 427 previous_request: The request for the previous page. (required) 428 previous_response: The response from the request for the previous page. (required) 429 430Returns: 431 A request object that you can call 'execute()' on to request the next 432 page. Returns None if there are no more items in the collection. 433 </pre> 434</div> 435 436<div class="method"> 437 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> 438 <pre>Updates the proposal at the given revision number. If the revision number in the request is behind the latest from the server, an error message will be returned. See FieldMask for how to use FieldMask. Only fields specified in the UpdateProposalRequest.update_mask will be updated; Fields noted as 'Immutable' or 'Output only' yet specified in the UpdateProposalRequest.update_mask will be ignored and left unchanged. Updating a private auction proposal is not allowed and will result in an error. 439 440Args: 441 name: string, Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId} (required) 442 body: object, The request body. 443 The object takes the form of: 444 445{ # Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer. 446 "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer. Format : `buyers/{buyerAccountId}` 447 "buyer": "A String", # Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}` 448 "buyerContacts": [ # Contact information for the buyer. 449 { # Contains information on how a buyer or seller can be reached. 450 "displayName": "A String", # The display_name of the contact. 451 "email": "A String", # Email address for the contact. 452 }, 453 ], 454 "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal or deal. # Buyer private data (hidden from seller). 455 "referenceId": "A String", # A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). 456 }, 457 "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}` 458 "dealType": "A String", # Output only. Type of deal the proposal contains. 459 "displayName": "A String", # Output only. The descriptive name for the proposal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the proposal. 460 "isRenegotiating": True or False, # Output only. True if the proposal was previously finalized and is now being renegotiated. 461 "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or left a comment. 462 "name": "A String", # Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId} 463 "notes": [ # A list of notes from the buyer and the seller attached to this proposal. 464 { # A text note attached to the proposal to facilitate the communication between buyers and sellers. 465 "createTime": "A String", # Output only. When this note was created. 466 "creatorRole": "A String", # Output only. The role who created the note. 467 "note": "A String", # The text of the note. Maximum length is 1024 characters. 468 }, 469 ], 470 "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal. 471 "pausingConsented": True or False, # Whether pausing is allowed for the proposal. This is a negotiable term between buyers and publishers. 472 "proposalRevision": "A String", # Output only. The revision number for the proposal. Each update to the proposal or 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. 473 "publisherProfile": "A String", # Immutable. Reference to the seller on the proposal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}` Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. 474 "sellerContacts": [ # Output only. Contact information for the seller. 475 { # Contains information on how a buyer or seller can be reached. 476 "displayName": "A String", # The display_name of the contact. 477 "email": "A String", # Email address for the contact. 478 }, 479 ], 480 "state": "A String", # Output only. Indicates the state of the proposal. 481 "termsAndConditions": "A String", # Output only. The terms and conditions associated with this proposal. Accepting a proposal implies acceptance of this field. This is created by the seller, the buyer can only view it. 482 "updateTime": "A String", # Output only. The time when the proposal was last revised. 483} 484 485 updateMask: string, List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, e.g. false for boolean fields, 0 for integer fields. A special field mask consisting of a single path "*" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask. 486 x__xgafv: string, V1 error format. 487 Allowed values 488 1 - v1 error format 489 2 - v2 error format 490 491Returns: 492 An object of the form: 493 494 { # Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer. 495 "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer. Format : `buyers/{buyerAccountId}` 496 "buyer": "A String", # Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}` 497 "buyerContacts": [ # Contact information for the buyer. 498 { # Contains information on how a buyer or seller can be reached. 499 "displayName": "A String", # The display_name of the contact. 500 "email": "A String", # Email address for the contact. 501 }, 502 ], 503 "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal or deal. # Buyer private data (hidden from seller). 504 "referenceId": "A String", # A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). 505 }, 506 "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}` 507 "dealType": "A String", # Output only. Type of deal the proposal contains. 508 "displayName": "A String", # Output only. The descriptive name for the proposal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the proposal. 509 "isRenegotiating": True or False, # Output only. True if the proposal was previously finalized and is now being renegotiated. 510 "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or left a comment. 511 "name": "A String", # Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId} 512 "notes": [ # A list of notes from the buyer and the seller attached to this proposal. 513 { # A text note attached to the proposal to facilitate the communication between buyers and sellers. 514 "createTime": "A String", # Output only. When this note was created. 515 "creatorRole": "A String", # Output only. The role who created the note. 516 "note": "A String", # The text of the note. Maximum length is 1024 characters. 517 }, 518 ], 519 "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal. 520 "pausingConsented": True or False, # Whether pausing is allowed for the proposal. This is a negotiable term between buyers and publishers. 521 "proposalRevision": "A String", # Output only. The revision number for the proposal. Each update to the proposal or 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. 522 "publisherProfile": "A String", # Immutable. Reference to the seller on the proposal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}` Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. 523 "sellerContacts": [ # Output only. Contact information for the seller. 524 { # Contains information on how a buyer or seller can be reached. 525 "displayName": "A String", # The display_name of the contact. 526 "email": "A String", # Email address for the contact. 527 }, 528 ], 529 "state": "A String", # Output only. Indicates the state of the proposal. 530 "termsAndConditions": "A String", # Output only. The terms and conditions associated with this proposal. Accepting a proposal implies acceptance of this field. This is created by the seller, the buyer can only view it. 531 "updateTime": "A String", # Output only. The time when the proposal was last revised. 532}</pre> 533</div> 534 535<div class="method"> 536 <code class="details" id="sendRfp">sendRfp(buyer, body=None, x__xgafv=None)</code> 537 <pre>Sends a request for proposal (RFP) to a publisher to initiate the negotiation regarding certain inventory. In the RFP, buyers can specify the deal type, deal terms, start and end dates, targeting, and a message to the publisher. Once the RFP is sent, a proposal in `SELLER_REVIEW_REQUESTED` state will be created and returned in the response. The publisher may review your request and respond with detailed deals in the proposal. 538 539Args: 540 buyer: string, Required. The current buyer who is sending the RFP in the format: `buyers/{accountId}`. (required) 541 body: object, The request body. 542 The object takes the form of: 543 544{ # Request to send an RFP. All fields in this request are proposed to publisher and subject to changes by publisher during later negotiation. 545 "buyerContacts": [ # Contact information for the buyer. 546 { # Contains information on how a buyer or seller can be reached. 547 "displayName": "A String", # The display_name of the contact. 548 "email": "A String", # Email address for the contact. 549 }, 550 ], 551 "client": "A String", # If the current buyer is sending the RFP on behalf of its client, use this field to specify the name of the client in the format: `buyers/{accountId}/clients/{clientAccountid}`. 552 "displayName": "A String", # Required. The display name of the proposal being created by this RFP. 553 "estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly. 554 "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. 555 "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. 556 "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. 557 }, 558 "flightEndTime": "A String", # Required. Proposed flight end time of the RFP. A timestamp in RFC3339 UTC "Zulu" format. Note that the specified value will be truncated to a granularity of one second. 559 "flightStartTime": "A String", # Required. Proposed flight start time of the RFP. A timestamp in RFC3339 UTC "Zulu" format. Note that the specified value will be truncated to a granularity of one second. 560 "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Geo criteria IDs to be targeted. Refer to Geo tables. 561 "excludedCriteriaIds": [ # A list of numeric IDs to be excluded. 562 "A String", 563 ], 564 "targetedCriteriaIds": [ # A list of numeric IDs to be included. 565 "A String", 566 ], 567 }, 568 "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Inventory sizes to be targeted. 569 "excludedInventorySizes": [ # A list of inventory sizes to be excluded. 570 { # Represents size of a single ad slot, or a creative. 571 "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`. 572 "type": "A String", # The type of the ad slot size. 573 "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`. 574 }, 575 ], 576 "targetedInventorySizes": [ # A list of inventory sizes to be included. 577 { # Represents size of a single ad slot, or a creative. 578 "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`. 579 "type": "A String", # The type of the ad slot size. 580 "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`. 581 }, 582 ], 583 }, 584 "note": "A String", # A message that is sent to the publisher. Maximum length is 1024 characters. 585 "preferredDealTerms": { # Pricing terms for Preferred Deals. # The terms for preferred deals. 586 "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal. 587 "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified. 588 "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. 589 "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. 590 "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. 591 }, 592 "type": "A String", # The pricing type for the deal. 593 }, 594 }, 595 "programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals. 596 "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal. 597 "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified. 598 "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. 599 "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. 600 "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. 601 }, 602 "type": "A String", # The pricing type for the deal. 603 }, 604 "guaranteedLooks": "A String", # Count of guaranteed looks. 605 "impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached. 606 "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. 607 "percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100. 608 "reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD. 609 }, 610 "publisherProfile": "A String", # Required. The profile of the publisher who will receive this RFP in the format: `buyers/{accountId}/publisherProfiles/{publisherProfileId}`. 611} 612 613 x__xgafv: string, V1 error format. 614 Allowed values 615 1 - v1 error format 616 2 - v2 error format 617 618Returns: 619 An object of the form: 620 621 { # Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer. 622 "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer. Format : `buyers/{buyerAccountId}` 623 "buyer": "A String", # Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}` 624 "buyerContacts": [ # Contact information for the buyer. 625 { # Contains information on how a buyer or seller can be reached. 626 "displayName": "A String", # The display_name of the contact. 627 "email": "A String", # Email address for the contact. 628 }, 629 ], 630 "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal or deal. # Buyer private data (hidden from seller). 631 "referenceId": "A String", # A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). 632 }, 633 "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}` 634 "dealType": "A String", # Output only. Type of deal the proposal contains. 635 "displayName": "A String", # Output only. The descriptive name for the proposal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the proposal. 636 "isRenegotiating": True or False, # Output only. True if the proposal was previously finalized and is now being renegotiated. 637 "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or left a comment. 638 "name": "A String", # Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId} 639 "notes": [ # A list of notes from the buyer and the seller attached to this proposal. 640 { # A text note attached to the proposal to facilitate the communication between buyers and sellers. 641 "createTime": "A String", # Output only. When this note was created. 642 "creatorRole": "A String", # Output only. The role who created the note. 643 "note": "A String", # The text of the note. Maximum length is 1024 characters. 644 }, 645 ], 646 "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal. 647 "pausingConsented": True or False, # Whether pausing is allowed for the proposal. This is a negotiable term between buyers and publishers. 648 "proposalRevision": "A String", # Output only. The revision number for the proposal. Each update to the proposal or 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. 649 "publisherProfile": "A String", # Immutable. Reference to the seller on the proposal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}` Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. 650 "sellerContacts": [ # Output only. Contact information for the seller. 651 { # Contains information on how a buyer or seller can be reached. 652 "displayName": "A String", # The display_name of the contact. 653 "email": "A String", # Email address for the contact. 654 }, 655 ], 656 "state": "A String", # Output only. Indicates the state of the proposal. 657 "termsAndConditions": "A String", # Output only. The terms and conditions associated with this proposal. Accepting a proposal implies acceptance of this field. This is created by the seller, the buyer can only view it. 658 "updateTime": "A String", # Output only. The time when the proposal was last revised. 659}</pre> 660</div> 661 662</body></html>