Method: buyers.proposals.deals.batchUpdate

  • The batchUpdate method allows for updating multiple deals within the same proposal.

  • The HTTP request for this method is a POST request to the specified URL which includes the parent proposal identifier.

  • The request body contains a list of UpdateDealRequest objects, each specifying the deal to be updated and an optional update mask.

  • A successful response body contains a list of the updated Deal objects.

  • This method requires authorization with the https://www.googleapis.com/auth/authorized-buyers-marketplace OAuth scope.

Batch updates multiple deals in the same proposal.

HTTP request

POST https://authorizedbuyersmarketplace.googleapis.com/v1alpha/{parent=buyers/*/proposals/*}/deals:batchUpdate

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The name of the proposal containing the deals to batch update. Format: buyers/{accountId}/proposals/{proposalId}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "requests": [
    {
      object (UpdateDealRequest)
    }
  ]
}
Fields
requests[]

object (UpdateDealRequest)

Required. List of request messages to update deals.

Response body

Response message for batch updating deals.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "deals": [
    {
      object (Deal)
    }
  ]
}
Fields
deals[]

object (Deal)

Deals updated.

Authorization scopes

Requires the following OAuth scope:

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

UpdateDealRequest

Request message for updating the deal at the given revision number.

JSON representation 
{
  "deal": {
    object (Deal)
  },
  "updateMask": string
}
Fields
deal

object (Deal)

Required. The deal to update.

The deal's name field is used to identify the deal to be updated. Note: proposalRevision will have to be provided within the resource or else an error will be thrown. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
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".