Impression Log Fields¶
Name |
Type |
Is Nullable |
Description |
---|---|---|---|
request |
record |
false |
|
request.datetime |
string |
false |
|
bid_context_wrapper |
record |
false |
|
bid_context_wrapper.bid |
record |
false |
|
bid_context_wrapper.bid.id |
string |
false |
The unique bid request ID, generated by the client |
bid_context_wrapper.bid.time |
integer |
false |
The bid event timestamp: seconds since epoch |
bid_context_wrapper.bid.datetime |
string |
false |
The bid event timestamp, |
bid_context_wrapper.bid.ssp |
string |
false |
Supplier identification string, e.g. |
bid_context_wrapper.user |
record |
false |
|
bid_context_wrapper.user.ip |
string |
false |
Specifies the IPv4 address closest to the device, string |
bid_context_wrapper.user.languages |
array of strings |
false |
The Alpha-2/ISO 639-1 code of browser language, e.g. |
bid_context_wrapper.user.segments |
array of strings |
false |
A list of pixel segments associated with the user ID |
bid_context_wrapper.user.audience_segments |
array of strings |
false |
A list of audience segments associated with the user ID |
bid_context_wrapper.user.gender |
string |
true |
Specifies the user gender, e.g. |
bid_context_wrapper.user.yob |
integer |
true |
The year of the user’s birth as a 4-digit integer, e.g. |
bid_context_wrapper.user.ifa |
string |
true |
The native identifier for advertisers. An ID assigned by the device or browser for use as an advertising identifier, for example Apple’s IDFA or Android’s Advertising ID |
bid_context_wrapper.user.lat |
float |
true |
Latitude from -90 to 90 (South is negative), e.g. |
bid_context_wrapper.user.lon |
float |
true |
Longitude from -180 to 180 (West is negative), e.g. |
bid_context_wrapper.user.carrier |
string |
true |
A carrier or an ISP derived from the IP address, e.g. |
bid_context_wrapper.user.connectiontype |
string |
true |
A connection type value, one of the following: Unknown, Ethernet, WIFI, Cellular Network - Unknown Generation, Cellular Network - 2G, Cellular Network - 3G, Cellular Network - 4G |
bid_context_wrapper.user.dnt |
integer |
true |
Do not track. |
bid_context_wrapper.user.mccmnc |
string |
true |
A mobile carrier as the concatenated MCC-MNC code, e.g. |
bid_context_wrapper.user.ec_geo |
record |
false |
|
bid_context_wrapper.user.ec_geo.country |
string |
false |
The ISO code of the country matching the user’s IPv4 address, e.g. |
bid_context_wrapper.user.ec_geo.region |
string |
false |
The ISO code of the first subdivision of the address matching user’s IPv4
address, e.g. |
bid_context_wrapper.user.ec_geo.subregion |
string |
true |
The ISO code of the second subdivision of address matching user’s IPv4 address, e.g. ‘LND’, an empty string if not applicable |
bid_context_wrapper.user.ec_geo.city |
string |
false |
The name of the city (in English) matching the user’s IPv4 address, e.g.
|
bid_context_wrapper.user.ec_geo.dma |
integer |
false |
The metro code of the address matching the user’s IPv4 address, e.g. |
bid_context_wrapper.user.ec_geo.zip |
string |
false |
The postal code of the address matching the user’s IPv4 address, e.g. |
bid_context_wrapper.user.ec_geo.country_region |
string |
false |
Concatenation of the country, the first subdivsion and the second subdivision of
the address, e.g. |
bid_context_wrapper.user.ec_geo.geo_isp |
string |
true |
The Internet Service Provider associated with the user’s IPv4 address, e.g.
|
bid_context_wrapper.user.ec_geo.digital_element_country |
string |
false |
The two letter code of the country matching the user’s IPv4 address, e.g. |
bid_context_wrapper.user.ec_geo.digital_element_region |
string |
false |
The ISO code of the region of the address matching the user’s IPv4 address,
e.g. |
bid_context_wrapper.user.ec_geo.digital_element_city |
string |
false |
The name of the city (in English) matching the user’s IPv4 address, e.g.
|
bid_context_wrapper.user.ec_geo.digital_element_postal_code |
string |
false |
The postal code of the address matching the user’s IPv4 address |
bid_context_wrapper.user.ec_geo.digital_element_postal_ext |
string |
false |
The postal code ext of the address matching the user’s IPv4 address |
bid_context_wrapper.user.ec_geo.digital_element_country_region |
string |
false |
Concatenation of the country and region of the address, e.g. ‘UK-LND’ |
bid_context_wrapper.user.ec_agent |
record |
false |
|
bid_context_wrapper.user.ec_agent.device |
record |
false |
|
bid_context_wrapper.user.ec_agent.device.type |
string |
false |
The device type associated with the device’s user agent string |
bid_context_wrapper.user.ec_agent.device.maker |
string |
false |
The device maker associated with the device’s user agent string |
bid_context_wrapper.user.ec_agent.device.model |
string |
false |
The device model associated with the device’s user agent string |
bid_context_wrapper.user.ec_agent.os |
record |
false |
|
bid_context_wrapper.user.ec_agent.os.name |
string |
false |
The operating system name associated with the device’s user agent string |
bid_context_wrapper.user.ec_agent.os.version |
string |
false |
The operating system version associated with the device’s user agent string |
bid_context_wrapper.user.ec_agent.browser |
record |
false |
|
bid_context_wrapper.user.ec_agent.browser.name |
string |
false |
browser name associated with device’s user agent string |
bid_context_wrapper.user.ec_agent.browser.version |
string |
false |
The browser version associated with the device’s user agent string |
bid_context_wrapper.supply |
record |
false |
|
bid_context_wrapper.supply.slot_id |
string |
false |
The ID of the impression being shown, unique within the bid request, e.g. |
bid_context_wrapper.supply.site_page |
string |
false |
The URL of the site.page, e.g. |
bid_context_wrapper.supply.ec_site_domain |
string |
false |
The host part of the URL from either the site.domain or the app.domain field of
the request, e.g. |
bid_context_wrapper.supply.ec_page_domain |
string |
false |
The host part of the URL from the site.page, e.g. |
bid_context_wrapper.supply.publisher_id |
string |
false |
An exchange specific identifier consisting of the Supplier exchange name, and the
publisher ID attached with an underline, e.g. |
bid_context_wrapper.supply.site_id |
string |
false |
An exchange specific identifier consisting of the Supplier’s exchange name, and
the target site ID (for website requests) or the application ID (for
in-app requests) attached with an underline, e.g. |
bid_context_wrapper.supply.topframe |
string |
false |
Indicates if the banner is in the top frame as opposed to an iframe.
|
bid_context_wrapper.supply.visibility |
string |
false |
Ad Position as defined in the OpenRTB protocol, one of the following: |
bid_context_wrapper.supply.is_secure_request |
boolean |
false |
Specifies if the page is SSL compliant: |
bid_context_wrapper.supply.blocked_adv_categories |
array of strings |
false |
Blocked Advertiser Categories listed in the IAB taxonomy and extended with
additional sensitive categories, e.g. |
bid_context_wrapper.supply.is_app |
integer |
false |
Indicates if the request has an app section. |
bid_context_wrapper.supply.content_categories |
array of strings |
false |
An array of IAB content categories for the impression or the publisher site (for
in-app), e.g. |
bid_context_wrapper.supply.pub_categories |
array of strings |
false |
An array of IAB content categories for the publisher, e.g. |
bid_context_wrapper.supply.s2s_call |
boolean |
false |
Specifies the notification type(s) supported by the supplier: |
bid_context_wrapper.supply.requested_sizes |
array of strings |
false |
An array of sizes ( |
bid_context_wrapper.supply.grapeshot_channels |
array of strings |
false |
Grapeshot channels applicable to the bid request coming either from a site page
or an app bundle, e.g. |
bid_context_wrapper.supply.source_name |
string |
true |
The site or the application name, e.g. |
bid_context_wrapper.supply.app_bundle |
string |
true |
The application bundle or package name, e.g. |
bid_context_wrapper.supply.content_type |
string |
false |
The creative type, either |
bid_context |
record |
false |
|
bid_context.demand |
record |
false |
|
bid_context.demand.client_id |
integer |
true |
The numeric ID of the client for whom the request was intended |
bid_context.demand.advertiser_id |
integer |
false |
The numeric ID of the advertiser associated with the client and the creative |
bid_context.demand.campaign_id |
integer |
false |
The numeric ID of the campaign associated with the client and the creative |
bid_context.demand.line_item_id |
integer |
false |
The numeric ID of the line item associated with the client and the creative |
bid_context.demand.creative_id |
integer |
false |
The numeric id of the creative |
bid_context.demand.strategy_id |
integer |
true |
The ID of the optimization strategy used |
bid_context.demand.can_track_clicks |
boolean |
false |
The value of the ‘can_track_clicks’ creative field |
bid_context.demand.creative_size |
string |
false |
Concatenation of width, ‘x’ symbol and height creative fields, only ‘x’ with missing width and height |
bid_context.demand.creative_viewability_vendors |
array of strings |
false |
An array of viewability vendors |
bid_context.demand.bid_amount |
double |
false |
The bid amount value in the bid currency |
bid_context.demand.deal_id |
string |
true |
The deal ID, e.g. |
bid_context.demand.tag_type |
string |
false |
Either |
user_request |
record |
false |
|
user_request.ip |
string |
false |
The user’s IPv4 address |
user_request.useragent |
string |
false |
The user’s browser user agent string |
uuid |
string |
true |
The unique BidSwitch user ID; idfa or Android ID for in-app traffic |
fees |
record |
false |
|
fees.opd |
double |
false |
OPD type fee value |
fees.grapeshot |
double |
false |
Grapeshot type fee value |
fees.cdn |
double |
true |
CDN type fee value |
fees.custom_1 |
double |
false |
Custom(1) type fee value |
payout |
record |
false |
|
payout.actual_pub |
double |
false |
The auction price of the impression |
payout.original_media_cost |
double |
false |
The auction price of the impression minus fee modifications |
payout.expected_adv |
double |
false |
The expected advertiser payout |
payout.adv_payout |
double |
false |
The advertiser payout |
winner_price |
float |
false |
The auction price of the impression |
Impression Logs Example¶
{
payout:
{
expected_adv: 0.000255085714286
actual_pub: 0.000249984
adv_payout: 0.000255085714286
original_media_cost: 0.000249984
}
uuid: None
bid_context_wrapper:
{
bid:
{
datetime: '2021-01-31 01:30:05'
id: 'd2004fb5-6b9c-496b-af90-3819b346dc73'
ssp: 'triplelift'
time: 1612056605
}
user:
{
ip: '69.146.201.128'
segments:
[
]
lon: None
yob: 0
connectiontype: 'Unknown'
mccmnc: None
languages:
[
'en'
]
dnt: None
carrier: None
ifa: None
ec_agent:
{
device:
{
model: 'Apple_iPhone'
type: 'Phone'
maker: 'Apple'
}
os:
{
version: 'iOS_14'
name: 'iOS'
}
browser:
{
version: 'Safari_14'
name: 'Safari'
}
}
gender: ''
lat: None
ec_geo:
{
dma: 767
digital_element_postal_ext: '3338'
digital_element_postal_code: '82601'
zip: '82604'
city: 'Casper'
country: 'US'
region: 'WY'
geo_isp: 'Spectrum'
digital_element_city: 'casper'
subregion: ''
digital_element_country: 'us'
digital_element_region: 'wy'
digital_element_country_region: 'us-wy'
country_region: 'US-WY-'
}
audience_segments:
[
]
}
supply:
{
s2s_call: False
pub_categories:
[
]
site_page: 'https://www.simplyrecipes.com/recipes/french_onion_soup/'
grapeshot_channels:
[
]
blocked_adv_categories:
[
'BSW1'
'BSW10'
'BSW2'
'BSW4'
'IAB25-3'
'IAB26'
'IAB9-9'
]
site_id: 'triplelift_36407'
visibility: 'UNKNOWN'
ec_site_domain: 'simplyrecipes.com'
requested_sizes:
[
'320x50'
'320x50'
]
content_categories:
[
'IAB1'
'IAB10'
'IAB12'
'IAB14-7'
'IAB16'
'IAB17'
'IAB18'
'IAB19'
'IAB2'
'IAB20'
'IAB24'
'IAB3'
'IAB5'
'IAB7'
'IAB8'
'IAB8-16'
'IAB9'
]
is_app: 0
slot_id: '1'
content_type: 'display'
ec_page_domain: 'simplyrecipes.com'
topframe: ''
source_name: None
is_secure_request: True
publisher_id: 'triplelift_7951'
app_bundle: None
}
}
winner_price: 0.000249984004768
request:
{
datetime: '2021-01-31 01:30:06'
}
potential_landing_convs:
[
]
bid_context:
{
demand:
{
deal_id: None
bid_amount: 0.00025
creative_id: 500001
campaign_id: 500002
can_track_clicks: True
creative_viewability_vendors:
[
]
advertiser_id: 500003
client_id: 500000
creative_size: '320x50'
line_item_id: 500004
strategy_id: 1
tag_type: 'iframe'
}
}
user_request:
{
ip: '69.146.201.128'
useragent: 'Mozilla/5.0 (iPhone; CPU iPhone OS 14_3 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.0.2 Mobile/15E148 Safari/604.1'
}
potential_vast_events:
[
]
potential_pv_convs:
[
]
fees:
{
opd: 0.0
grapeshot: 0.0
cdn: 0.0
custom_1: 0.0
}
potential_pc_convs:
[
]
potential_install_convs:
[
]
}