Method: buyers.finalizedDeals.list

  • You can list finalized deals for a buyer and its clients using the URL path "/v1alpha/buyers/{accountId}/finalizedDeals" or for a bidder, its buyers and clients using "/v1alpha/bidders/{accountId}/finalizedDeals".

  • The HTTP request to list finalized deals uses the GET method.

  • Path parameters are used to specify the buyer or bidder account ID.

  • Query parameters allow for filtering, ordering, setting page size, and specifying a page token for the results.

  • The request body should be empty.

  • The response body contains a ListFinalizedDealsResponse object if successful.

  • Authorization requires the https://www.googleapis.com/auth/authorized-buyers-marketplace OAuth scope.

Lists finalized deals. Use the URL path "/v1alpha/buyers/{accountId}/finalizedDeals" to list finalized deals for the current buyer and its clients. Bidders can use the URL path "/v1alpha/bidders/{accountId}/finalizedDeals" to list finalized deals for the bidder, its buyers and all their clients.

HTTP request

GET https://authorizedbuyersmarketplace.googleapis.com/v1alpha/{parent=buyers/*}/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