Method: buyers.proposals.deals.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists all deals in a proposal. To retrieve only the finalized revision deals regardless if a deal is being renegotiated, see the FinalizedDeals resource.
HTTP request
GET https://authorizedbuyersmarketplace.googleapis.com/v1alpha/{parent=buyers/*/proposals/*}/deals
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. The name of the proposal containing the deals to retrieve. Format: buyers/{accountId}/proposals/{proposalId}
|
Query parameters
| Parameters |
pageSize |
integer
Requested page size. The server may return fewer results than requested. If requested more than 500, the server will return 500 results per page. If unspecified, the server will pick a default page size of 100.
|
pageToken |
string
The page token as returned from ListDealsResponse.
|
Request body
The request body must be empty.
Response body
Response message for listing deals in a proposal.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"deals": [
{
object (Deal)
}
],
"nextPageToken": string
} |
| Fields |
deals[] |
object (Deal)
The list of deals.
|
nextPageToken |
string
Token to fetch the next page of results.
|
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/authorized-buyers-marketplace
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\u003eLists all deals within a given proposal, allowing retrieval of both finalized and renegotiated deals.\u003c/p\u003e\n"],["\u003cp\u003eEnables pagination to retrieve large datasets of deals, offering control over the number of results per page through \u003ccode\u003epageSize\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eProvides programmatic access via HTTP GET request, utilizing gRPC Transcoding for efficient communication.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization using the \u003ccode\u003ehttps://www.googleapis.com/auth/authorized-buyers-marketplace\u003c/code\u003e OAuth scope for security.\u003c/p\u003e\n"],["\u003cp\u003eReturns a JSON response containing a list of deals and a token for retrieving subsequent pages, if available.\u003c/p\u003e\n"]]],["This resource outlines the process for listing deals within a proposal via an HTTP GET request. The endpoint, `https://authorizedbuyersmarketplace.googleapis.com/v1alpha/{parent=buyers/*/proposals/*}/deals`, uses the `parent` path parameter to specify the proposal. Optional query parameters, `pageSize` and `pageToken`, allow pagination of results. The request body must be empty. The response body, in JSON format, contains an array of `deals` and a `nextPageToken` for subsequent pages. The request requires the `authorized-buyers-marketplace` authorization scope.\n"],null,["# Method: buyers.proposals.deals.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListDealsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists all deals in a proposal. To retrieve only the finalized revision deals regardless if a deal is being renegotiated, see the FinalizedDeals resource.\n\n### HTTP request\n\n`GET https://authorizedbuyersmarketplace.googleapis.com/v1alpha/{parent=buyers/*/proposals/*}/deals`\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 retrieve. Format: buyers/{accountId}/proposals/{proposalId} |\n\n### Query parameters\n\n| Parameters ||\n|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` Requested page size. The server may return fewer results than requested. If requested more than 500, the server will return 500 results per page. If unspecified, the server will pick a default page size of 100. |\n| `pageToken` | `string` The page token as returned from ListDealsResponse. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse message for listing deals in a proposal.\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/v1alpha/buyers.proposals.deals#Deal) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|--------------------------------------------------------------------------------------------------------------------------------|\n| `deals[]` | `object (`[Deal](/authorized-buyers/apis/marketplace/reference/rest/v1alpha/buyers.proposals.deals#Deal)`)` The list of deals. |\n| `nextPageToken` | `string` Token to fetch the next page of results. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/authorized-buyers-marketplace`"]]
