Method: accounts.proposals.list

  • This page describes how to list proposals using an HTTP GET request to the specified URL.

  • You can filter the results using an optional PQL filter query in the request.

  • The request requires an accountId as a path parameter and accepts optional query parameters like pageSize, pageToken, and filterSyntax.

  • The request body must be empty, and a successful response returns a ListProposalsResponse.

  • To access this functionality, the request needs the https://www.googleapis.com/auth/adexchange.buyer OAuth scope.

List proposals. A filter expression (PQL query) may be specified to filter the results. To retrieve all finalized proposals, regardless if a proposal is being renegotiated, see the FinalizedProposals resource. Note that Bidder/ChildSeat relationships differ from the usual behavior. A Bidder account can only see its child seats' proposals by specifying the ChildSeat's accountId in the request path.

HTTP request

GET https://adexchangebuyer.googleapis.com/v2beta1/accounts/{accountId}/proposals

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
accountId

string

Account ID of the buyer.

Query parameters

Parameters
filter

string

An optional PQL filter query used to query for proposals.

Nested repeated fields, such as proposal.deals.targetingCriterion, cannot be filtered.
pageSize

integer

Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
pageToken

string

The page token as returned from ListProposalsResponse.
filterSyntax

enum (FilterSyntax)

Syntax the filter is written in. Current implementation defaults to PQL but in the future it will be LIST_FILTER.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of ListProposalsResponse.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adexchange.buyer