Item Object

The item represents a unit of goods being offered for sale either on the open market or in relation to a private marketplace deal. The item.id attribute is required since there may be multiple items being offered in the same bid request and bids must reference the specific item of interest. There may be a maximum of 5 items per bid request.

Item Object Properties
Value Type Description
id string A unique identifier for this item within the context of the offer (typically starts with "1" and increments).
qty* int The quantity of items being offered, e.g. multiple identical impressions in a digital out-of-home scenario.
seq* int If multiple items are offered in the same bid request, the sequence number allows for the coordinated delivery.
flr* float Minimum bid price for this item expressed in CPM.
flrcur* str Currency of the flr attribute specified using ISO-4217 alpha codes. The default is "usd"
exp* int Impression expiry time. Advisory as to the number of seconds that may elapse between auction and fulfilment.
dt* int Delivery time. The timestamp when the item is expected to be fulfilled. This field can be used to signify day-parting, (e.g. when a DOOH impression will be displayed) in Unix format (i.e., milliseconds since the epoch).
dlvy* int

The supported item (e.g., an Ad object) delivery method required, where:

  • 0 either method
  • 1 the item must be sent as part of the transaction (e.g., by a value in the bid itself or fetched by a URL included in the bid)
  • 2 an item previously uploaded to the exchange referenced by its ID.

Note: that if an exchange does not supported prior upload, then the default of 0 is effectively the same as 1 since there can be no items to reference.

metric* array of objects An array of metric objects, see the Item Metric
deal* array of objects An array of deal objects relevant to this item, see the Deal Object
private* int

Indicates a private deal:

  • 0 or not present: all bids accepted
  • 1 bids are restricted to the deals specified and the terms thereof.
spec object (Required) This holds the Item Placement object, and objects within this come from those defined in the AdCom specification.

Item JSON Example

{
    "item":[
        {
            "id":"1",
            "exp":300,
            "ext":{
                "ssp":"google",
                "at":1,
                "ads_txt":{
                    "status":2,
                    "auth_id":"1kjgh7653",
                    "pub_id":"537120563"
                }
            },
            "qty":1,
            "flr":1.23,
            "flrcur":"usd",
            "seq":1,
            "private":0,
            "spec":{
                "placement":{

                }
            },
            "dt":1243
        }
    ]
}

Table Of Contents