REST Resource: products

Resource: Product

A single product.

JSON representation
{
  "name": string,
  "externalId": string,
  "displayName": string,
  "description": string,
  "labels": {
    string: string,
    ...
  },
  "creativeSpecifications": [
    {
      object (CreativeSpecification)
    }
  ],
  "bookingLeadTime": string,
  "assignmentLeadTime": string,
  "minFlightDuration": string,
  "maxFlightDuration": string,
  "slotDuration": string,
  "createTime": string,
  "updateTime": string,
  "currencyCode": string
}
Fields
name

string

The resource name of the product in the format: products/{id}. For example products/product123.

externalId

string

Optional. An id used to map this entity to external sources.

displayName

string

Required. The display name of the product.

Must be UTF-8 encoded with a maximum size of 240 bytes.

description

string

Optional. Additional freeform field to describe the product.

labels

map (key: string, value: string)

Optional. The set of freeform labels to describe this product.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

creativeSpecifications[]

object (CreativeSpecification)

Required. List of permissible creatives that can be served for this product.

bookingLeadTime

string (Duration format)

Required. Lead time required to book the product. Now + bookingLeadTime should be after flight start.

A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".

assignmentLeadTime

string (Duration format)

Required. Lead time required to assign creatives.

A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".

minFlightDuration

string (Duration format)

Optional. Minimum flight duration for this product.

A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".

maxFlightDuration

string (Duration format)

Required. Maximum flight duration for this product.

A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".

slotDuration

string (Duration format)

Required. Slot duration for this product.

A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".

createTime

string (Timestamp format)

Output only. Creation timestamp for the product.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Output only. Last updated timestamp for the product.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

currencyCode

string

The 3-letter uppercase currency code defined in ISO 4217.

Methods

create

Creates a new product.

get

Retrieves an individual product.

list

Lists products.

patch

Updates an existing product.