REST Resource: buyers.proposals

    Resource: Proposal

    Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer.

    JSON representation 
     { 
 "name" 
 : 
 string 
 , 
 "updateTime" 
 : 
 string 
 , 
 "proposalRevision" 
 : 
 string 
 , 
 "dealType" 
 : 
 enum (  DealType 
 
) 
 , 
 "displayName" 
 : 
 string 
 , 
 "state" 
 : 
 enum (  State 
 
) 
 , 
 "isRenegotiating" 
 : 
 boolean 
 , 
 "originatorRole" 
 : 
 enum (  BuyerSellerRole 
 
) 
 , 
 "publisherProfile" 
 : 
 string 
 , 
 "buyerPrivateData" 
 : 
 { 
 object (  PrivateData 
 
) 
 } 
 , 
 "billedBuyer" 
 : 
 string 
 , 
 "sellerContacts" 
 : 
 [ 
 { 
 object (  Contact 
 
) 
 } 
 ] 
 , 
 "buyerContacts" 
 : 
 [ 
 { 
 object (  Contact 
 
) 
 } 
 ] 
 , 
 "lastUpdaterOrCommentorRole" 
 : 
 enum (  BuyerSellerRole 
 
) 
 , 
 "termsAndConditions" 
 : 
 string 
 , 
 "pausingConsented" 
 : 
 boolean 
 , 
 "notes" 
 : 
 [ 
 { 
 object (  Note 
 
) 
 } 
 ] 
 , 
 // Union field negotiating_buyer 
can be only one of the following: 
 "buyer" 
 : 
 string 
 , 
 "client" 
 : 
 string 
 // End of list of possible types for union field negotiating_buyer 
. 
 }
    Fields
    name

    string

    Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId}

    updateTime

    string ( Timestamp format)

    Output only. The time when the proposal was last revised.

    Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .

    proposalRevision

    string ( int64 format)

    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.

    dealType

    enum ( DealType )

    Output only. Type of deal the proposal contains.

    displayName

    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.

    state

    enum ( State )

    Output only. Indicates the state of the proposal.

    isRenegotiating

    boolean

    Output only. True if the proposal was previously finalized and is now being renegotiated.

    originatorRole

    enum ( BuyerSellerRole )

    Output only. Indicates whether the buyer/seller created the proposal.

    publisherProfile

    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.

    buyerPrivateData

    object ( PrivateData )

    Buyer private data (hidden from seller).

    billedBuyer

    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}

    sellerContacts[]

    object ( Contact )

    Output only. Contact information for the seller.

    buyerContacts[]

    object ( Contact )

    Contact information for the buyer.

    lastUpdaterOrCommentorRole

    enum ( BuyerSellerRole )

    Output only. The role of the last user that either updated the proposal or left a comment.

    termsAndConditions

    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.

    pausingConsented

    boolean

    Whether pausing is allowed for the proposal. This is a negotiable term between buyers and publishers.

    notes[]

    object ( Note )

    A list of notes from the buyer and the seller attached to this proposal.

    Union field negotiating_buyer . The buyer who negotiates this proposal with publishers. Can be either a buyer or client. negotiating_buyer can be only one of the following:
    buyer

    string

    Output only. Refers to a buyer in [The Realtime-bidding API][google.ads.realtimebidding.v1.Buyer]. Format: buyers/{buyerAccountId}

    client

    string

    Output only. Refers to a Client . Format: buyers/{buyerAccountId}/clients/{clientAccountid}

    State

    Possible state for a proposal

    Enums
    STATE_UNSPECIFIED Unspecified proposal state
    BUYER_REVIEW_REQUESTED When a proposal is waiting for buyer to review.
    SELLER_REVIEW_REQUESTED When the proposal is waiting for the seller to review.
    BUYER_ACCEPTANCE_REQUESTED When the seller accepted the proposal and sent it to the buyer for review.
    FINALIZED When both buyer and seller has accepted the proposal
    TERMINATED When either buyer or seller has cancelled the proposal

    PrivateData

    Buyers are allowed to store certain types of private data in a proposal.

    JSON representation 
     { 
 "referenceId" 
 : 
 string 
 }
    Fields
    referenceId

    string

    A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units).

    Contact

    Contains information on how a buyer or seller can be reached.

    JSON representation 
     { 
 "email" 
 : 
 string 
 , 
 "displayName" 
 : 
 string 
 }
    Fields
    email

    string

    Email address for the contact.
    displayName

    string

    The displayName of the contact.

    Note

    A text note attached to the proposal to facilitate the communication between buyers and sellers.

    JSON representation 
     { 
 "createTime" 
 : 
 string 
 , 
 "creatorRole" 
 : 
 enum (  BuyerSellerRole 
 
) 
 , 
 "note" 
 : 
 string 
 }
    Fields
    createTime

    string ( Timestamp format)

    Output only. When this note was created.

    Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .
    creatorRole

    enum ( BuyerSellerRole )

    Output only. The role who created the note.
    note

    string

    The text of the note. Maximum length is 1024 characters.

    Methods

    accept

    		Accepts the proposal at the given revision number.

    addNote

    		Creates a note for this proposal and sends to the seller.

    cancelNegotiation

    		Cancels an ongoing negotiation on a proposal.

    get

    		Gets a proposal using its resource name.

    list

    		Lists proposals.

    patch

    		Updates the proposal at the given revision number.

    sendRfp

    		Sends a request for proposal (RFP) to a publisher to initiate the negotiation regarding certain inventory.
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: