GOgoogle
buyers

POST /v1/buyers/{buyersId}/proposals/{proposalsId}:cancelNegotiation

Changed on

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'.

Request

  • Base URL
    https://authorizedbuyersmarketplace.googleapis.com
  • URL
    https://authorizedbuyersmarketplace.googleapis.com/v1/buyers/{buyersId}/proposals/{proposalsId}:cancelNegotiation
  • Auth
    OAuth 2 and OAuth 2
    Implicit: https://accounts.google.com/o/oauth2/auth
    Scopes: https://www.googleapis.com/auth/authorized-buyers-marketplace
    Authorization code: https://accounts.google.com/o/oauth2/auth
    Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/authorized-buyers-marketplace

Path parameters

buyersIdstring required
proposalsIdstring required

Request body

CancelNegotiationRequest required

Request to cancel an ongoing negotiation.

Response

Successful response

billedBuyerstring

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}

buyerstring

Output only. Refers to a buyer in The Realtime-bidding API. Format: buyers/{buyerAccountId}

clientstring

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

dealType'DEAL_TYPE_UNSPECIFIED' | 'PREFERRED_DEAL' | 'PRIVATE_AUCTION' | 'PROGRAMMATIC_GUARANTEED'

Output only. Type of deal the proposal contains.

displayNamestring

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.

isRenegotiatingboolean

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

lastUpdaterOrCommentorRole'BUYER_SELLER_ROLE_UNSPECIFIED' | 'BUYER' | 'SELLER'

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

namestring

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

originatorRole'BUYER_SELLER_ROLE_UNSPECIFIED' | 'BUYER' | 'SELLER'

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

pausingConsentedboolean

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

proposalRevisionstring int64

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.

publisherProfilestring

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.

state'STATE_UNSPECIFIED' | 'BUYER_REVIEW_REQUESTED' | 'SELLER_REVIEW_REQUESTED' | 'BUYER_ACCEPTANCE_REQUESTED' | 'FINALIZED' | 'TERMINATED'

Output only. Indicates the state of the proposal.

termsAndConditionsstring

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.

updateTimestring google-datetime

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

Changes