Method: accounts.products.list
Stay organized with collections
Save and categorize content based on your preferences.
List all products visible to the buyer (optionally filtered by the specified PQL query).
HTTP request
GET https://adexchangebuyer.googleapis.com/v2beta1/accounts/{accountId}/products
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
accountId |
string
Account ID of the buyer.
|
Query parameters
| Parameters |
filter |
string
An optional PQL query used to query for products. See https://developers.google.com/ad-manager/docs/pqlreference for documentation about PQL and examples. Nested repeated fields, such as product.targetingCriterion.inclusions, 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 ListProductsResponse.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
Response message for listing products visible to the buyer.
| JSON representation |
{
"products": [
{
object (Product)
}
],
"nextPageToken": string
} |
| Fields |
products[] |
object (Product)
The list of matching products at their head revision number.
|
nextPageToken |
string
List pagination support.
|
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\u003eLists all products accessible to the buyer, with optional filtering using PQL queries.\u003c/p\u003e\n"],["\u003cp\u003eUtilizes the HTTP GET method and requires the \u003ccode\u003eaccountId\u003c/code\u003e as a path parameter.\u003c/p\u003e\n"],["\u003cp\u003eAllows for pagination using \u003ccode\u003epageSize\u003c/code\u003e and \u003ccode\u003epageToken\u003c/code\u003e query parameters.\u003c/p\u003e\n"],["\u003cp\u003eReturns a list of products and a token for retrieving subsequent pages in the response body.\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"]]],["This document details how to list products visible to a buyer via an HTTP GET request to `https://adexchangebuyer.googleapis.com/v2beta1/accounts/{accountId}/products`. The `accountId` is required as a path parameter. Optional query parameters include `filter` (PQL query), `pageSize`, and `pageToken` for pagination. The request body must be empty. A successful response contains a JSON body with a list of `products` and a `nextPageToken` for further pagination. The request requires `https://www.googleapis.com/auth/adexchange.buyer` authorization scope.\n"],null,["# Method: accounts.products.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 - [JSON representation](#body.ListProductsResponse.SCHEMA_REPRESENTATION)\n- [Authorization Scopes](#body.aspect)\n- [Try it!](#try-it)\n\nList all products visible to the buyer (optionally filtered by the specified PQL query).\n\n### HTTP request\n\n`GET https://adexchangebuyer.googleapis.com/v2beta1/accounts/{accountId}/products`\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 query used to query for products. See \u003chttps://developers.google.com/ad-manager/docs/pqlreference\u003e for documentation about PQL and examples. Nested repeated fields, such as product.targetingCriterion.inclusions, 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 ListProductsResponse. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\nResponse message for listing products visible to the buyer.\n\n| JSON representation ||\n|--------------------------------------------------------------------------------------------------------------------------------------------|---|\n| ``` { \"products\": [ { object (/authorized-buyers/apis/reference/rest/v2beta1/accounts.products#Product) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `products[]` | `object (`[Product](/authorized-buyers/apis/reference/rest/v2beta1/accounts.products#Product)`)` The list of matching products at their head revision number. |\n| `nextPageToken` | `string` List pagination support. |\n\n### Authorization Scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/adexchange.buyer`"]]
