GOgoogle
buyers

PATCH /v1/buyers/{buyersId}/proposals/{proposalsId}

Changed on

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.

Request

  • Base URL
    https://authorizedbuyersmarketplace.googleapis.com
  • URL
    https://authorizedbuyersmarketplace.googleapis.com/v1/buyers/{buyersId}/proposals/{proposalsId}
  • 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

Query parameters

updateMaskstring google-fieldmask

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.

Request body

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.

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