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 not allowed and will result in an error.
Scopes
You will need authorization for the https://www.googleapis.com/auth/authorized-buyers-marketplace scope to make a valid call.
If unset, the scope for this method defaults to https://www.googleapis.com/auth/authorized-buyers-marketplace.
You can set the scope for this method like this: authorizedbuyersmarketplace1 --scope <scope> buyers proposals-patch ...
Required Scalar Argument
- <name> (string)
- Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId}
Required Request Value
The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.
For example, a structure like this:
Proposal:
billed-buyer: string
buyer: string
buyer-private-data:
reference-id: string
client: string
deal-type: string
display-name: string
is-renegotiating: boolean
last-updater-or-commentor-role: string
name: string
originator-role: string
pausing-consented: boolean
proposal-revision: string
publisher-profile: string
state: string
terms-and-conditions: string
update-time: string
can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.
-r . billed-buyer=dolore
- 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}
- 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 :
buyer=voluptua.
- Output only. Refers to a buyer in The Realtime-bidding API. Format:
buyers/{buyerAccountId}
- Output only. Refers to a buyer in The Realtime-bidding API. Format:
-
buyer-private-data reference-id=amet.
- A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units).
-
.. client=ea
- Output only. Refers to a Client. Format:
buyers/{buyerAccountId}/clients/{clientAccountid}
- Output only. Refers to a Client. Format:
deal-type=sadipscing
- Output only. Type of deal the proposal contains.
display-name=lorem
- 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.
is-renegotiating=true
- Output only. True if the proposal was previously finalized and is now being renegotiated.
last-updater-or-commentor-role=no
- Output only. The role of the last user that either updated the proposal or left a comment.
name=est
- Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId}
originator-role=at
- Output only. Indicates whether the buyer/seller created the proposal.
pausing-consented=true
- Whether pausing is allowed for the proposal. This is a negotiable term between buyers and publishers.
proposal-revision=sit
- 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.
publisher-profile=et
- 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.
- Immutable. Reference to the seller on the proposal. Format:
state=tempor
- Output only. Indicates the state of the proposal.
terms-and-conditions=aliquyam
- 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.
update-time=ipsum
- Output only. The time when the proposal was last revised.
About Cursors
The cursor position is key to comfortably set complex nested structures. The following rules apply:
- The cursor position is always set relative to the current one, unless the field name starts with the
.
character. Fields can be nested such as in-r f.s.o
. - The cursor position is set relative to the top-level structure if it starts with
.
, e.g.-r .s.s
- You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify
-r struct.sub_struct=bar
. - You can move the cursor one level up by using
..
. Each additional.
moves it up one additional level. E.g....
would go three levels up.
Optional Output Flags
The method's return value a JSON encoded structure, which will be written to standard output by default.
- -o out
- out specifies the destination to which to write the server's result to.
It will be a JSON-encoded structure.
The destination may be
-
to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.
- out specifies the destination to which to write the server's result to.
It will be a JSON-encoded structure.
The destination may be
Optional Method Properties
You may set the following properties to further configure the call. Please note that -p
is followed by one
or more key-value-pairs, and is called like this -p k1=v1 k2=v2
even though the listing below repeats the
-p
for completeness.
- -p update-mask=string
- 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.
Optional General Properties
The following properties can configure any call, and are not specific to this method.
-
-p $-xgafv=string
- V1 error format.
-
-p access-token=string
- OAuth access token.
-
-p alt=string
- Data format for response.
-
-p callback=string
- JSONP
-
-p fields=string
- Selector specifying which fields to include in a partial response.
-
-p key=string
- API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
-
-p oauth-token=string
- OAuth 2.0 token for the current user.
-
-p pretty-print=boolean
- Returns response with indentations and line breaks.
-
-p quota-user=string
- Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
-
-p upload-type=string
- Legacy upload protocol for media (e.g. "media", "multipart").
-
-p upload-protocol=string
- Upload protocol for media (e.g. "raw", "multipart").