Method: bidders.finalizedDeals.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists finalized deals. Use the URL path "/v1/buyers/{accountId}/finalizedDeals" to list finalized deals for the current buyer and its clients. Bidders can use the URL path "/v1/bidders/{accountId}/finalizedDeals" to list finalized deals for the bidder, its buyers and all their clients.
HTTP request
GET https://authorizedbuyersmarketplace.googleapis.com/v1/{parent=bidders/*}/finalizedDeals
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. The buyer to list the finalized deals for, in the format: buyers/{accountId}. When used to list finalized deals for a bidder, its buyers and clients, in the format bidders/{accountId}.
|
Query parameters
| Parameters |
filter |
string
Optional query string using the Cloud API list filtering syntax Supported columns for filtering are:
- deal.displayName
- deal.dealType
- deal.createTime
- deal.updateTime
- deal.flightStartTime
- deal.flightEndTime
- deal.eligibleSeatIds
- dealServingStatus
|
orderBy |
string
An optional query string to sort finalized deals using the Cloud API sorting syntax. If no sort order is specified, results will be returned in an arbitrary order. Supported columns for sorting are:
- deal.displayName
- deal.createTime
- deal.updateTime
- deal.flightStartTime
- deal.flightEndTime
- rtbMetrics.bidRequests7Days
- rtbMetrics.bids7Days
- rtbMetrics.adImpressions7Days
- rtbMetrics.bidRate7Days
- rtbMetrics.filteredBidRate7Days
- rtbMetrics.mustBidRateCurrentMonth
|
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 ListFinalizedDealsResponse.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of ListFinalizedDealsResponse.
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 finalized deals for buyers and bidders, accessible via respective URL paths with account IDs.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering and sorting of deals using query parameters like \u003ccode\u003efilter\u003c/code\u003e and \u003ccode\u003eorderBy\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eSupports pagination with \u003ccode\u003epageSize\u003c/code\u003e and \u003ccode\u003epageToken\u003c/code\u003e for retrieving large result sets.\u003c/p\u003e\n"],["\u003cp\u003eRequires the \u003ccode\u003ehttps://www.googleapis.com/auth/authorized-buyers-marketplace\u003c/code\u003e OAuth scope for authorization.\u003c/p\u003e\n"],["\u003cp\u003eProvides details on HTTP request structure, path/query parameters, and expected response.\u003c/p\u003e\n"]]],[],null,["# Method: bidders.finalizedDeals.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- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists finalized deals. Use the URL path \"/v1/buyers/{accountId}/finalizedDeals\" to list finalized deals for the current buyer and its clients. Bidders can use the URL path \"/v1/bidders/{accountId}/finalizedDeals\" to list finalized deals for the bidder, its buyers and all their clients.\n\n### HTTP request\n\n`GET https://authorizedbuyersmarketplace.googleapis.com/v1/{parent=bidders/*}/finalizedDeals`\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 buyer to list the finalized deals for, in the format: `buyers/{accountId}`. When used to list finalized deals for a bidder, its buyers and clients, in the format `bidders/{accountId}`. |\n\n### Query parameters\n\n| Parameters ||\n|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `filter` | `string` Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: - deal.displayName - deal.dealType - deal.createTime - deal.updateTime - deal.flightStartTime - deal.flightEndTime - deal.eligibleSeatIds - dealServingStatus |\n| `orderBy` | `string` An optional query string to sort finalized deals using the [Cloud API sorting syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order). If no sort order is specified, results will be returned in an arbitrary order. Supported columns for sorting are: - deal.displayName - deal.createTime - deal.updateTime - deal.flightStartTime - deal.flightEndTime - rtbMetrics.bidRequests7Days - rtbMetrics.bids7Days - rtbMetrics.adImpressions7Days - rtbMetrics.bidRate7Days - rtbMetrics.filteredBidRate7Days - rtbMetrics.mustBidRateCurrentMonth |\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 ListFinalizedDealsResponse. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [ListFinalizedDealsResponse](/authorized-buyers/apis/marketplace/reference/rest/v1/ListFinalizedDealsResponse).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/authorized-buyers-marketplace`"]]
