REST Resource: sellers.products

Resource: Product

A single product.

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

string

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

externalId

string

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

Additional freeform field to describe the product.

labels

map (key: string, value: string)

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.

bookingLeadDuration

string (Duration format)

Required. Lead duration required to book the product. Now + bookingLeadDuration should be after flight start.

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

assignmentLeadDuration

string (Duration format)

Required. Lead duration required to assign creatives.

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

minFlightDuration

string (Duration format)

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".

state

enum (State)

Output only. The state of this product.

currencyCode

string

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

State

Possible values for product state.

Enums
STATE_UNSPECIFIED Default value when Product State is not specified or is unknown in this version.
STATE_ACTIVE Product is active.
STATE_DELETED Product is deleted.

Methods

create

Creates a new product.

delete

Deletes an existing product.

get

Retrieves an individual product.

list

Lists products.

patch

Updates an existing product.