Method: accounts.products.list

  • This document describes how to list all products visible to a buyer, with optional filtering using a PQL query.

  • The request uses a GET HTTP method with a specific URL structure including the buyer's account ID as a path parameter.

  • Optional query parameters allow for filtering by a PQL query, specifying the page size, and providing a page token for pagination.

  • The request body must be empty, and a successful response body will contain a list of matching products and a nextPageToken for pagination.

  • Authorization requires the https://www.googleapis.com/auth/adexchange.buyer OAuth scope.

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