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