ABCDEFGHIJKLMNOPQRSTUVWXYZAAABAC
1
NOTICE: This file is deprecated and has been replaced by an Excel file downloadable on Github here.
2
HeaderPositionDefinitionsql_datatypeDDL descProtoProto Notes
3
account_id1Beeswax bidder account ID; represents the bidder seat for a particular clientINT4request.adcandidate.account_id
4
ad_position2If applicable, ad position on pageVARCHAR(255)request.imp.video.pos
5
app_bundle3Application bundle or package name (e.g., com.foo.mygame). This is intended to be a unique ID across multiple exchanges.VARCHAR(255)request.app.bundle
6
app_id4Application ID on the exchange. For uniqueness, Uses ad exchange/SSP identifier as prefix e.g. pm/ representing pubmaticVARCHAR(255)request.app.id
7
app_name5Application nameVARCHAR(255)request.app.name
8
auction_adgroup_id6Internal Unique IDVARCHAR(255)N/ATo be deprecated
9
auction_id7Unique ID for every bid request in the system. A joining key for all the events associated with the bid request, like impression, clicks, and activities.VARCHAR(255)request.ext.auction_id_str
10
beeswax_fee_rate_micros8For PERCENT fee-type option, applicable Beeswax fee rate in micros
1 micro = 0.000,0001%
INT8Internal
11
bid_hour9Datestamp during which a particular bid was made, YYYY-MM-DD HH:00:00 in ET timezoneTIMESTAMPYYYY-MM-DD HH24:MI:SS in ETN/A
12
bid_price_micros_usd10Bid price returned by the bidding agent (in USD micros); $1.00 CPM = 1,000,000 microsINT8BidAgentResponse.bids.bid_price_micros_usdDeprecated
13
bid_reduction_rate_micros11For BID_REDUCTION(rev-share) fee type option, applicable Bid reduction rate in micros
1 micro = 0.000,0001%
INT8Internal
14
bid_time12Time of bid request sent, YYYY-MM-DD HH:MM:SS in ET timezoneTIMESTAMPYYYY-MM-DD HH24:MI:SS.MS in ETN/AConverted from the bid timestamp (epoch)
15
buzz_key13Beeswax Buzz key, an identifier for client bidder instancesVARCHAR(255)request.ext.buzz_key
16
campaign_id14ID of the campaign that submitted the bidINT4li.campaign_id
17
campaign_revenue_amount_micros15Amount of revenue set in the campaign config for completion of the revenue type condition, in micros.
1 USD = 1,000,000 micros
INT8li.revenue_revenue_amount_micros
18
campaign_revenue_type16Campaign revenue type determines how revenue is booked by the advertiser for a particular campaign; CPM or CPC (cost per click) basisVARCHAR(255)li.revenue_revenue_type
19
category17comma separate list of IAB-defined content categories:
http://www.iab.com/guidelines/iab-quality-assurance-guidelines-qag-taxonomy/;
determine type of content associated with a particular slice of inventory
VARCHAR(255)site_cat
20
clearing_price_micros_usd18Auction Clearing price(in micros) returned by exchange. This is the raw media cost.
1 USD = 1,000,000 micros
INT8N/A
21
clicks19Set to 1 if the impression received a clickINT2N/A
22
content_coppa_flag20Children’s Online Privacy Protection Act (COPPA) Flag; inventory with this flag carries several ad quality limitationsINT4regs.coppa
23
content_language21Language in which content associated to the impression is written (as declared by the publisher)VARCHAR(255)site.content_language
24
content_rating22Content parental rating (as declared by the publisher)VARCHAR(255)site.ontent_contentrating
25
conversions23Number of conversions associated to a particular impressionINT4N/A
26
conversion_order24Conversion order, constitutes how many orders a particular conversion represents; info provided by the advertiser in Beeswax UI/APINUMERIC(18,6)N/A
27
conversion_value25Value of a given conversion as ispecified by the advertiser in Beeswax UI/APINUMERIC(18,6)N/A
28
create_time26Time created; Beeswax internal bookkeeping fieldTIMESTAMPYYYY-MM-DD HH24:MI:SS.US in UTCN/A
29
creative_id27Beeswax ID for the creative that won an impressionINT4adgroup.creatives_id
30
customer_id28Customer Beeswax IDINT4adgroup.customer_id
31
deal_id29Populated with the impression's Deal ID if an impression was sold via a deal.VARCHAR(255)imp.pmp.deals_idThis is actually computed from the deal ID bid upon plus the exchange prefix
32
domain30Domain name from which a given impression originatedVARCHAR(255)site_domain
33
environment_type31Environment type (APP or WEB)VARCHAR(255)imp.ext.environment_type
34
exchange_discrepancy_rate_micros32Observed operational spend discrepancy between exchange and Beeswax.
1 micro = 0.000,0001%
INT8adgroup.biling_info.exchange_discrepancy_rate_micros
35
geo_city33City geo code
IP address. MaxMindDB Lookup data
VARCHAR(255)ext.targeting.geo_cityNOTE: All Geo is augmented based on IP address in the MaxMind database, and you should use the data in the Geo extension for consistency
36
geo_country34Country geo name
IP address. MaxMindDB Lookup data
VARCHAR(255)ext.targeting.geo_countryNOTE: All Geo is augmented based on IP address in the MaxMind database, and you should use the data in the Geo extension for consistency
37
geo_metro35Metro geo code
IP address. MaxMindDB Lookup data
VARCHAR(255)ext_targeting_geo_metroNOTE: All Geo is augmented based on IP address in the MaxMind database, and you should use the data in the Geo extension for consistency
38
geo_region36Geo region name
IP address. MaxMindDB Lookup data
VARCHAR(255)ext_targeting_geo_regionNOTE: All Geo is augmented based on IP address in the MaxMind database, and you should use the data in the Geo extension for consistency
39
geo_zip37Zip code
IP address. MaxMindDB Lookup data
VARCHAR(255)ext_targeting_geo_zipNOTE: All Geo is augmented based on IP address in the MaxMind database, and you should use the data in the Geo extension for consistency
40
has_frequency_cap38Frequency capped at campaign/lineitem levelINT2N/Aimpevent_has_frequency_cap
41
inventory_interstitial39determines if ad tag responsible for the impression accepts interstitial creatives or not; 1 for yes, 0 for noINT4imp_intstl
42
inventory_source40Inventory source - exchange nameVARCHAR(255)ext_inventory_source
43
inventory_source_relationship41Inventory source relationship—direct or indirectVARCHAR(255)site_content_sourcerelationship
44
ip_address42IP address provided by the exchange during the auctionVARCHAR(255)device_ip
45
ip_range43IP address provided by the exchange during the auction (same as ip_address)VARCHAR(255)Same as above: device_ip
46
line_item_id44Line Item ID that was responsible for winning the auction, as listed in BeeswaxINT4li_id
47
line_item_revenue_amount_micros45Amount of revenue set in the line item config for completion of the revenue type condition, in micros.
1 USD = 1,000,000 micros
INT8li_revenue_revenue_amount_micros
48
line_item_revenue_type46Type determines how the revenue was booked by the line item e.g. on a CPM or CPC basisVARCHAR(255)li_revenue_revenue_type
49
placement47Placement ID/name, as provided by the publisher. Prefixed with exchange handle.VARCHAR(255)imp_ext_placement
50
platform_bandwidth48Shows whether the browser is using wifi or carrier to establish connection with internet to generate the impressionVARCHAR(255)device_connectiontype
51
platform_browser49Name of browser used during the auction for the impression at handVARCHAR(255)device_ext_augmented_browser
52
platform_browser_version50Version of browser used to during the auction for the impression at handVARCHAR(255)device_ext_augmented_browser_version
53
platform_carrier51If the device is using a mobile carrier to establish internet connection, this field will identify which carrier is usedVARCHAR(255)device_ext_augmented_carrier
54
platform_device_didmd552Hardware device ID (e.g., IMEI); hashed via MD5VARCHAR(255)device_didmd5
55
platform_device_didsha153Hardware device ID (e.g., IMEI); hashed via SHA1VARCHAR(255)device_didsha1
56
platform_device_dpidmd554Platform device ID (e.g., Android ID); hashed via MD5VARCHAR(255)device_dpidmd5
57
platform_device_dpidsha155Platform device ID (e.g., Android ID); hashed via SHA1VARCHAR(255)device_dpidsha1
58
platform_device_idfa56iOS app ID; "Identifier for Advertisers"; deprecatedVARCHAR(255)N/ADeprecated
59
platform_device_ifa57ID sanctioned for advertiser use in the clear (i.e., not hashed)VARCHAR(255)device_ifa
60
platform_device_make58Make of the device used to generate the impressionVARCHAR(255)device_ext_augmented_make
61
platform_device_model59Model of the device used to generate the impressionVARCHAR(255)device_ext_augmented_model
62
platform_device_screen_size60Screensize of the device used to generate the impressionVARCHAR(255)device_ext_augmented_device_screen_size
63
platform_device_type61Type of the device used to generate the impressionVARCHAR(255)device_devicetype
64
platform_js62Indicates whether the browser supports JavaScript or notINT4device_js
65
platform_os63Operating system of the device used to generate the impressionVARCHAR(255)device_ext_augmented_os
66
platform_os_version64Operating system version of the device used to generate the impressionVARCHAR(255)device_ext_augmented_osv
67
pre_reduction_bid_price_micros_usd65Bid price returned by the bidding agent in micros.
1 USD = 1,000,000 micros
INT8N/A
68
revenue_amount_micros66Revenue in micros. Takes into account the Revenue Type to calculate actual revenue generated by impression based on whether revenue condition was achieved.This represents the actual revenue generated by an impression.
1 USD = 1,000,000 micros
INT8N/A
69
segment_id67Beeswax segment ID; contains all segments the user qualifies for, comma-delimited, regardless if it is targeted on the line item that wonVARCHAR(600)ext_segment
70
segment_user_id68Beeswax segment user IDINT2N/ADeprecated
71
site_id69ID of the site that generated the impression, as provided by the publisherVARCHAR(255)site_idIn the proto, this does not carry the exchange prefix; that would need to be mapped on your end
72
site_name70Name of the site that generated the impression, as provided by the publisherVARCHAR(255)site_name
73
time_of_week71Time of week in GPS weekly time during which the impression occurred; internalINT4ext_time_of_week
74
user_id72Device ID for mobile, cookie for desktop. Will populate with cookie on a desktop OR an iOS/Android ID for mobileVARCHAR(255)user_ext_user_id
75
video_boxing_allowed73Indicates if letter-boxing of 4:3 content into a 16:9 window is
allowed, where 0 = no, 1 = yes
INT2imp_video_boxingallowed
76
video_companion_required74A banner companion ad is required to accompany the video ad: 0=false, 1=trueINT4video_companionadTrue if video_companionad is non-empty
77
video_completes75Number of videos watched through completion; Set to 1 if video watched through completionINT2N/A
78
video_midpoints76Number of videos watched through video midpoint; Set to 1 if video watched through video midpointINT2N/A
79
video_playback_method77Video playback method, as determined by the publisher.VARCHAR(255)imp_video_playbackmethod
80
video_player_size78Video player sizeVARCHAR(255){imp_video_w}x{imp_video_h}Player size is based off a combination of height and width of the player size
81
video_plays79Number of video plays; Set to 1 if video playsINT2N/A
82
video_q1s80Number of videos watched the first quarter; Set to 1 if video watched through the first quarterINT2N/A
83
video_q3s81Number of videos watched through the third quarter; Set to 1 if video watched through the third quarterINT2N/A
84
video_skips82Number of video skips; Set to 1 if video is skippedINT2N/A
85
video_start_delay83Indicates the start delay in seconds for pre-roll, mid-roll, or
post-roll ad placements
INT2imp_video_startdelay
86
win_cost_micros_usd84Total win_cost including media cost, beeswax fees, exchange-specific disprecancy adjustment, vendor fees
1 USD = 1,000,000 micros
INT8N/A
87
advertiser_id85Advertiser ID for the impressionINT8li_advertiser_id
88
vendor_fee_micros_usd86Vendor fee in micros, USD
1 USD = 1,000,000 micros
INT8N/A
89
test87Indicator of test mode in which auctions are not billable, where 0 = live mode, 1 = test modeBOOLEANtest
90
placement_type88Placement type, indicates whether the placement is meant for banner, video ads, or bothVARCHAR(255)imp_ext_placement_type
91
geo_lat89Latitude associated with the impressionVARCHAR(50)ext_targeting_geo_latLat and Long come from either the bid request's user.geo.lat or the device.geo.lat
92
geo_lon90Longitude associated with the impressionVARCHAR(50)ext_targeting_geo_lonLat and Long come from either the bid request's user.geo.long or the device.geo.long
93
total_cpm_vendor_fee_amount_micros91Internal, tracks total vendor fee per CPM.
1 USD = 1,000,000 micros
INT8N/ACalculated from Line Item CPM vendor fees (including creative vendor fees) and Campaign CPM vendor fees
94
total_percent_vendor_fee_amount_micros92Internal, tracks total vendor fee percentage of win_cost_micros_usd.
1 USD = 1,000,000 micros
INT8N/ACalculated from Line Item percent-based vendor fees (including creative vendor fees) and Campaign percent-based vendor fees
95
bid_time_epoch_in_usecs93bid timestamp(epoch) with microsecond precision.
Allows the customer to calculate the bid_time in any timezone instead of relying on `bid_time` field which is ET timezone
INT8N/AConverted from the auction ID
96
model_id94Holds the `agent_id` field value of the BidAgentResponse return by the customer's bidding agent.
If the line item uses Bid Models, this filed will contain the Bid Model ID.
This can be used for debugging.
VARCHAR(255)li_bidding_agent_data_agent_id
97
model_params95Holds the `agent_params` field value of the BidAgentResponse return by the customer's bidding agent.
If the line item uses Bid Models, this will contain the cache results for the Bid Model lookup.
This can be used for debugging.
Format => {key}={value},{key}={value}..
VARCHAR(600)li_bidding_agent_data_agent_params
98
data_center96Beeswax's data center responsible for processing the bid request/response in questionVARCHAR(50)N/A
99
billing_version97InternalVARCHAR(50)N/A
100
in_view98Determines if the impression is viewable or notINT2N/A