BIDS Available Fields
The BIDS available fields are as follows.
Field name | Data type | Description |
---|---|---|
timestamp | timestamp | Timestamp in UTC. |
auction_id | string | Unique identifier for the associated auction. |
dsp_name | string | The name of the DSP that submitted the bid to OpenX. |
seat_id | string | OpenX buyer identifier. In most cases, this is equivalent to the DSP seat id. |
openx_brand_id | long | OpenX identifier for the brand. |
a_domain | string | The advertiser domain as passed to OpenX by the DSP. |
creative_id | string | Identifier for the creative. |
auction_type | string | The OpenX auction type for the transaction.1 = first price2 = second price |
impression | boolean | Indicates whether a valid impression was served for that transaction.TRUE = valid impressionFALSE = not valid impression |
ortb_loss_reason | string | OpenRTB 2.5 loss reason name, which provides information about the outcome of a bid response. Note: This will be AUCTION_WINNER when you won the OpenX auction, but does not represent downstream auction result. |
ortb_loss_reason_code | integer | OpenRTB 2.5 loss reason code, which provides information about the outcome of a bid response. Note: This will be AUCTION_WINNER when you won the OpenX auction, but does not represent downstream auction result. |
deal_id | string | An alphanumeric string that represents a private marketplace deal, populated when an OpenRTB deal id was bid upon. |
bid_amt_1st_price | double | Buyer’s actual 1st price bid for that auction (auction type = 1 ).Note: bid_amt_1st_price and bid_amt_2nd_price are mutually exclusive. |
bid_amt_2nd_price | double | Buyer’s actual 2nd price bid for that auction (auction type = 2 ).Note: bid_amt_1st_price and bid_amt_2nd_price are mutually exclusive. |
floor_usd | double | The publisher specified auction floor. |
gross_revenue | double | Gross revenue for the publisher before share. All revenue is measured in USD. This is equivalent to your winning bid price. Note: This field is only available for won impressions. |
min_bid_to_win | double | The bid you would have needed to submit in order to surpass all other bidders and seller-wide floors in the OpenX auction. This field is only included if your bid lost the auction for a price related reason. Note: Also, this field does not apply to auctions that were won by a deal bid (preferred & private auction deals). |
inventory_channel | string | The environment where the creative would serve: • Web • In-app • CTV |
device_type | string | The type of device from which the impression opportunity originated (desktop, phone, tablet, etc.). |
operating_system | string | 3-character device operating system. |
browser | string | 3-character browser code. |
seller_id | long | OpenX publisher account identifier. Note: It is possible for one publisher to have multiple seller ids. |
site_id | integer | OpenX site identifier. |
adunit_id | long | OpenX ad unit identifier. |
domain | string | The top level domain from the ad request. |
page_url | string | URL of the webpage where the ad call originated (with query args and references removed). |
app_bundle | string | A platform-specific mobile application ID intended to be unique to the application. This dimension does not apply to web traffic. • Android ID = string, package name • iOS ID = numeric identifier |
creative_type | string | The type of creative being requested: banner or video. |
ad_size | string | The size of the requested ad slot, in pixels: • Display = width by height • Video = player width by height |
integration_type | string | The integration type of the supply partner who sent the ad request: • Prebid.js = client-side Prebid • Prebid Server = server-side Prebid • OB = Google Open Bidding • A9 TAM = Amazon Transparent Ad Marketplace • Tag = Direct js tag integration • Bidder = OpenX header bidder • Index = Index container • OpenX Mobile SDK = iOS or Android SDK • OpenRTB Server = OpenRTB server-side integration • Other |
country | string | Two-character ISO country code. |
state | string | Code = state and province. |
dma | integer | Designated market area (DMA). |
zip_postal | string | Zip or postal code. |
cookie_match_status | boolean | Cookie match status. • TRUE = OpenX had a buyeruid for the corresponding DSP.• FALSE = OpenX didn’t have a buyeruid for the corresponding DSP.Note: When OpenX does not host a match table with a DSP, this will always be FALSE . The DSP may have had a match in their hosted match table. |
p_id | variant | Unique identifier for people-based IDs (only available in certain cases). This field is the JSON representation of p_ids{"provider1":"ABC12345","provider2":"XYZ6789","provider3":"123456ABC"} Note: • This field is only available for won impressions. • This field is not available for EU impressions. |
p_ids | string | Unique identifier for people-based IDs (only available in certain cases). The format uses key value pairs. The first value is the provider_id , and the second value is the identifier.For example, provider1:ABC12345;provider2:XYZ6789;provider3:123456ABC Note: • This field is only available for won impressions. • This field is not available for EU impressions. |