Method: exchanges.orders.products.list

Lists product.

HTTP request

GET https://dv360seller.googleapis.com/v1beta1/{parent=exchanges/*/orders/*}/products

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

The parent resource name. Example: "exchanges/123/orders/456". Max 250 characters. Required.

Query parameters

Parameters
pageSize

integer

The maximum number of items to return. Max allowed value is 50. If unspecified or more than 50, will use 50 as page size.
pageToken

string

The nextPageToken value returned from a previous List request, if any.
filter

string

Allows filtering by product properties.

Supported syntax:

  • Filter expressions are made up of one or more restrictions.
  • Restrictions can be combined by AND or OR logical operators. A sequence of restrictions implicitly uses AND.
  • A restriction has the form of <field> <operator> <value>.
  • The operator must be EQUALS (=).
  • Supported fields:
    • externalDealId

Examples:

  • Get Products with external deal ID set to "12345" under an exchange. externalDealId="12345"

Setting Order Id to '-' to apply filter on Products across all Orders. orders/-/products?filter=externalDealId="12345"

The length of this field should be no more than 500 characters.

Request body

The request body must be empty.

Response body

Response to list order.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "products": [
    {
      object (Product)
    }
  ],
  "nextPageToken": string
}
Fields
products[]

object (Product)

Listed products. There will be a maximum number of items returned based on the pageSize field in the request.
nextPageToken

string

Token to retrieve the next page of results, or empty if there are no more results in the list.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/doubleclickbidmanager

For more information, see the OAuth 2.0 Overview.