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 Extension

The item.ext contains a number of fields required for trading but which are not in the OpenRTB IAB spec and thus supported as extensions.

Item extension Object Properties
Value Type Description
at string

(Recommended) Passes additional auction types used by some Suppliers which fall outside those covered in the Open RTB specification.

  • 501 rubicon AST, Modified First Price
  • 502 rubicon AST, Modified Second Price
ads_txt object (Recommended) Contains the ads.txt information about the Supplier, see the Ads.txt Object and BidSwitch and Ads.txt sections for more details.
google object This field is optional and is used only in Google AdX bid requests, see Google Object.
wt float

The SmartSwitch bid weight. This field shows the total number of bid requests with the same SmartSwitch Score that this Bid Request represents.

This number can be used to calculate the amount of traffic of this type that would be received if SmartSwitch were turned off. Any bid request that you receive with this weight (X) is highly likely to be sent X times without SmartSwitch filtering. See the SmartSwitch Bid Request Weight section for more details.

When this field value equals 1, there are no unsent bid requests with a matching score.

Ads.txt Object

The item.ext.ads_txt object will contain the verified details of the Supplier and Publisher trading relationship.

Ads.txt Object Properties
Value Type Description
status int

(Required) Indicates what information the ads.txt file contained regarding this Suppliers selling relationship with the publisher:

  • 1 = direct
  • 2 = reseller
  • 3 = unauthorized
auth_id string Passes the TAG ID if present in the ads.txt file, e.g. "8765jfhfg09j"
pub_id string

(Required) The unmodified publisher ID at that Supplier e.g., "123456789"

Note: In the standard Publisher object, BidSwitch passes the publisher.id field including the SSP prefix, e.g. aol_123456789, see the Publisher Object for more details

Google Object

Google Object Properties
Value Type Description
detected_vertical* array of objects List of detected vertical values as defined by Google, see Detected_vertical Object

Detected_vertical Object

Detected Vertical Object Properties
Value Type Description
id integer The vertical ID as defined by AdX docs, for example, 1014. See their relevant information here; https://developers.google.com/authorized-buyers/rtb/realtime-bidding-guide
weight float Weight for this vertical, in the (0.0, 1.0) range. More relevant verticals have higher weights, for example, 1.0

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
        }
    ]
}