Method: buyers.proposals.deals.list

  • This document outlines how to list all deals within a specific proposal using an HTTP GET request.

  • The request requires a parent parameter specifying the account and proposal ID, and optionally accepts pageSize and pageToken query parameters for pagination.

  • The request body must be empty, and the successful response body contains a list of deal objects and a token for fetching the next page.

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

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/v1/{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