Method: accounts.finalizedProposals.list

  • This document outlines how to list finalized proposals using an HTTP GET request to the specified URL, with the ability to filter results using a PQL query.

  • Path parameters include the mandatory accountId, while optional query parameters allow for filtering, pagination size, page tokens, and specifying the filter syntax.

  • The request body should be empty for this operation, and a successful response will return a ListProposalsResponse instance.

  • Accessing this functionality requires the https://www.googleapis.com/auth/adexchange.buyer OAuth scope.

List finalized proposals, regardless if a proposal is being renegotiated. A filter expression (PQL query) may be specified to filter the results. The notes will not be returned.

HTTP request

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

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