Method: accounts.products.list

  • Lists all products accessible to the buyer, with optional filtering using PQL queries.

  • Utilizes the HTTP GET method and requires the accountId as a path parameter.

  • Allows for pagination using pageSize and pageToken query parameters.

  • Returns a list of products and a token for retrieving subsequent pages in the response body.

  • Requires authorization with the https://www.googleapis.com/auth/adexchange.buyer 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