Method: buyers.proposals.patch

  • Updates a proposal with the given revision, returning an error if the provided revision is outdated.

  • Only specified fields in the updateMask query parameter are modified; immutable and output-only fields are ignored.

  • Private auction proposals cannot be updated and will result in an error.

  • Requires the https://www.googleapis.com/auth/authorized-buyers-marketplace authorization scope.

  • The request body should contain a Proposal object with desired updates.

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.

HTTP request

PATCH https://authorizedbuyersmarketplace.googleapis.com/v1alpha/{proposal.name=buyers/*/proposals/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
proposal.name

string

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

Query parameters

Parameters
updateMask

string (FieldMask format)

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.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body contains an instance of Proposal.

Response body

If successful, the response body contains an instance of Proposal.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/authorized-buyers-marketplace