This is an invitation-only beta feature.
For a list of methods for this resource, see the end of this page.
Resource representations
Represents a proposal in the marketplace. A proposal is the unit of negotiation between a seller and a buyer and contains deals which are served. Each field in a proposal can have one of the following setting:
(readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller.
{ "kind": "adexchangebuyer#proposal", "proposalId": string, "revisionTimeMs": long, "revisionNumber": long, "originatorRole": string, "seller": { "accountId": string, "subAccountId": string }, "buyer": { "accountId": string }, "billedBuyer": { "accountId": string }, "name": string, "proposalState": string, "isRenegotiating": boolean, "buyerPrivateData": { "referenceId": string, "referencePayload": bytes }, "sellerContacts": [ { "email": string, "name": string } ], "buyerContacts": [ { "email": string, "name": string } ], "hasBuyerSignedOff": boolean, "hasSellerSignedOff": boolean, "labels": [ { "label": string, "deprecatedMarketplaceDealParty": { "buyer": { "accountId": string }, "seller": { "accountId": string, "subAccountId": string } }, "accountId": string, "createTimeMs": long } ], "isSetupComplete": boolean, "lastUpdaterOrCommentorRole": string, "inventorySource": string, "privateAuctionId": string, "negotiationId": string, "dbmAdvertiserIds": [ string ] }
Property name | Value | Description | Notes |
---|---|---|---|
billedBuyer |
nested object |
Reference to the buyer that will get billed for this proposal. (readonly) | |
billedBuyer.accountId |
string |
Adx account id of the buyer. | |
buyer |
nested object |
Reference to the buyer on the proposal. (readonly, except on create) | |
buyer.accountId |
string |
Adx account id of the buyer. | |
buyerContacts[] |
list |
Optional contact information of the buyer. (seller-readonly) | |
buyerContacts[].email |
string |
Email address of the contact. | |
buyerContacts[].name |
string |
The name of the contact. | |
buyerPrivateData |
nested object |
Private data for buyer. (hidden from seller). | |
buyerPrivateData.referenceId |
string |
||
buyerPrivateData.referencePayload |
bytes |
||
dbmAdvertiserIds[] |
list |
IDs of DBM advertisers permission to this proposal. | |
hasBuyerSignedOff |
boolean |
When an proposal is in an accepted state, indicates whether the buyer has signed off. Once both sides have signed off on a deal, the proposal can be finalized by the seller. (seller-readonly) | |
hasSellerSignedOff |
boolean |
When an proposal is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the proposal can be finalized by the seller. (buyer-readonly) | |
inventorySource |
string |
What exchange will provide this inventory (readonly, except on create).
Acceptable values are:
|
|
isRenegotiating |
boolean |
True if the proposal is being renegotiated (readonly). | |
isSetupComplete |
boolean |
True, if the buyside inventory setup is complete for this proposal. (readonly, except via OrderSetupCompleted action) Deprecated in favor of deal level setup complete flag. | |
kind |
string |
Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#proposal" . |
|
labels[] |
list |
List of labels associated with the proposal. (readonly) | |
labels[].accountId |
string |
The accountId of the party that created the label. | |
labels[].createTimeMs |
long |
The creation time (in ms since epoch) for the label. | |
labels[].deprecatedMarketplaceDealParty |
nested object |
Information about the party that created the label. | |
labels[].deprecatedMarketplaceDealParty.buyer |
nested object |
The buyer/seller associated with the deal. One of buyer/seller is specified for a deal-party. | |
labels[].deprecatedMarketplaceDealParty.buyer.accountId |
string |
Adx account id of the buyer. | |
labels[].deprecatedMarketplaceDealParty.seller |
nested object |
The buyer/seller associated with the deal. One of buyer/seller is specified for a deal party. | |
labels[].deprecatedMarketplaceDealParty.seller.accountId |
string |
The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product. | |
labels[].deprecatedMarketplaceDealParty.seller.subAccountId |
string |
Optional sub-account id for the seller. | |
labels[].label |
string |
The label to use.
Acceptable values are:
|
|
lastUpdaterOrCommentorRole |
string |
The role of the last user that either updated the proposal or left a comment. (readonly)
Acceptable values are:
|
|
name |
string |
The name for the proposal (updatable) | |
negotiationId |
string |
Optional negotiation id if this proposal is a preferred deal proposal. | |
originatorRole |
string |
Indicates whether the buyer/seller created the proposal.(readonly)
Acceptable values are:
|
|
privateAuctionId |
string |
Optional private auction id if this proposal is a private auction proposal. | |
proposalId |
string |
The unique id of the proposal. (readonly). | |
proposalState |
string |
The current state of the proposal. (readonly)
Acceptable values are:
|
|
revisionNumber |
long |
The revision number for the proposal (readonly). | |
revisionTimeMs |
long |
The time (ms since epoch) when the proposal was last revised (readonly). | |
seller |
nested object |
Reference to the seller on the proposal. (readonly, except on create) | |
seller.accountId |
string |
The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product. | |
seller.subAccountId |
string |
Optional sub-account id for the seller. | |
sellerContacts[] |
list |
Optional contact information of the seller (buyer-readonly). | |
sellerContacts[].email |
string |
Email address of the contact. | |
sellerContacts[].name |
string |
The name of the contact. |
Methods
- get
- Get a proposal given its id
- insert
- Create the given list of proposals
- patch
- Update the given proposal. This method supports patch semantics.
- search
- Search for proposals using PQL query
- setupcomplete
- Update the given proposal to indicate that setup has been completed.
- update
- Update the given proposal