Method: accounts.proposals.list
Stay organized with collections
Save and categorize content based on your preferences.
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
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 2024-09-18 UTC.
[null,null,["Last updated 2024-09-18 UTC."],[[["\u003cp\u003eRetrieve a list of proposals with optional filtering using PQL queries.\u003c/p\u003e\n"],["\u003cp\u003eRequest specific pages using \u003ccode\u003epageSize\u003c/code\u003e and \u003ccode\u003epageToken\u003c/code\u003e for pagination.\u003c/p\u003e\n"],["\u003cp\u003eUtilize path parameters to specify the buyer account ID and query parameters to filter and paginate results.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/adexchange.buyer\u003c/code\u003e scope.\u003c/p\u003e\n"]]],[],null,["# Method: accounts.proposals.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\nList 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.\n\n### HTTP request\n\n`GET https://adexchangebuyer.googleapis.com/v2beta1/accounts/{accountId}/proposals`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|-------------|-----------------------------------|\n| `accountId` | `string` Account ID of the buyer. |\n\n### Query parameters\n\n| Parameters ||\n|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `filter` | `string` An optional PQL filter query used to query for proposals. Nested repeated fields, such as proposal.deals.targetingCriterion, cannot be filtered. |\n| `pageSize` | `integer` Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. |\n| `pageToken` | `string` The page token as returned from ListProposalsResponse. |\n| `filterSyntax` | `enum (`[FilterSyntax](/authorized-buyers/apis/reference/rest/v2beta1/FilterSyntax)`)` Syntax the filter is written in. Current implementation defaults to PQL but in the future it will be LIST_FILTER. |\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 [ListProposalsResponse](/authorized-buyers/apis/reference/rest/v2beta1/ListProposalsResponse).\n\n### Authorization Scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/adexchange.buyer`"]]
