Method: buyers.proposals.deals.batchUpdate
Stay organized with collections
Save and categorize content based on your preferences.
Batch updates multiple deals in the same proposal.
HTTP request
POST https://authorizedbuyersmarketplace.googleapis.com/v1/{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:
| 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".
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-06-12 UTC.
[null,null,["Last updated 2025-06-12 UTC."],[[["\u003cp\u003eBatch updates multiple deals within the same proposal using the provided request body.\u003c/p\u003e\n"],["\u003cp\u003eThe request body should contain a list of \u003ccode\u003eUpdateDealRequest\u003c/code\u003e objects, specifying the deals to update and the desired changes.\u003c/p\u003e\n"],["\u003cp\u003eSuccessful responses will include a list of updated \u003ccode\u003eDeal\u003c/code\u003e objects.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization requires the \u003ccode\u003ehttps://www.googleapis.com/auth/authorized-buyers-marketplace\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eThe API utilizes gRPC Transcoding and expects specific path and request body structures.\u003c/p\u003e\n"]]],["This outlines the process for batch updating multiple deals within a proposal via an HTTP POST request to `buyers/*/proposals/*/deals:batchUpdate`. The request body, structured as JSON, contains an array of `UpdateDealRequest` objects, each specifying a deal to update and an `updateMask` field. The response body returns an array of `Deal` objects, representing the updated deals. The operation requires the `authorized-buyers-marketplace` OAuth scope.\n"],null,["# Method: buyers.proposals.deals.batchUpdate\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n - [JSON representation](#body.BatchUpdateDealsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [UpdateDealRequest](#UpdateDealRequest)\n - [JSON representation](#UpdateDealRequest.SCHEMA_REPRESENTATION)\n- [Try it!](#try-it)\n\nBatch updates multiple deals in the same proposal.\n\n### HTTP request\n\n`POST https://authorizedbuyersmarketplace.googleapis.com/v1/{parent=buyers/*/proposals/*}/deals:batchUpdate`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|-------------------------------------------------------------------------------------------------------------------------------------|\n| `parent` | `string` Required. The name of the proposal containing the deals to batch update. Format: buyers/{accountId}/proposals/{proposalId} |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"requests\": [ { object (/authorized-buyers/apis/marketplace/reference/rest/v1/buyers.proposals.deals/batchUpdate#UpdateDealRequest) } ] } ``` |\n\n| Fields ||\n|--------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `requests[]` | `object (`[UpdateDealRequest](/authorized-buyers/apis/marketplace/reference/rest/v1/buyers.proposals.deals/batchUpdate#UpdateDealRequest)`)` Required. List of request messages to update deals. |\n\n### Response body\n\nResponse message for batch updating deals.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"deals\": [ { object (/authorized-buyers/apis/marketplace/reference/rest/v1/buyers.proposals.deals#Deal) } ] } ``` |\n\n| Fields ||\n|-----------|-----------------------------------------------------------------------------------------------------------------------|\n| `deals[]` | `object (`[Deal](/authorized-buyers/apis/marketplace/reference/rest/v1/buyers.proposals.deals#Deal)`)` Deals updated. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/authorized-buyers-marketplace`\n\nUpdateDealRequest\n-----------------\n\nRequest message for updating the deal at the given revision number.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"deal\": { object (/authorized-buyers/apis/marketplace/reference/rest/v1/buyers.proposals.deals#Deal) }, \"updateMask\": string } ``` |\n\n| Fields ||\n|--------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `deal` | `object (`[Deal](/authorized-buyers/apis/marketplace/reference/rest/v1/buyers.proposals.deals#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} |\n| `updateMask` | `string (`[FieldMask](https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask)` 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\"`. |"]]
