RTB Manual

AdKernel RTB
OpenRTB specification for SSPs

based on IAB OpenRTB 2.4 specification
Introduction
This documentation allows to integrate Native Ads SSP to adKernel platform.
TM
AdKernel Contact Information
Support Services, support@adkernel.com
License
TM
AdKernel Native Ads RTB SSPs Specification is based on OpenRTB Specification licensed under a Creative Commons
Attribution 3.0 License, based on a work at openrtb.info. Permissions beyond the scope of this license may be available at
openrtb.info. To view a copy of this license, visit http://creativecommons.org/licenses/by/3.0/ or
write to Creative Commons, 171 Second Street, Suite 300, San Francisco, CA 94105, USA.
AdKernel. All rights reserved. 2016. v.1.2.

Contents
1. Getting Started
2. Terminology
3. RTB Ecosystem
4. RTB Basics
5. Win Notifications
6. User Syncing
7. Object Specification
8. Request and Response Examples
9. Native-specific Fields Specification

Getting Started (p.1)
This specification contains a detailed explanation of a real-time bidding interface. Not all objects are
required, and each object may contain a number of optional parameters.
To assist a first time reader of

the specification, we have indicated which fields are essential to support a minimum viable real time
bidding interface for Native Ads.
A minimal viable interface should include the required parameters.
Optional parameters may be included to ensure

maximum value is derived by the parties.

Getting Started (p.2)
Figure 1: Example of how Required and Optional attributes are presented.
Attribute Type Description
id required ...
imp required ...

Examples of required attributes.
Grouped at the tops of tables for convenience.
site required ...
device required ...
user optional ...

Examples of optional attributes, with and without
defaults. tmax optional ...
bcat optional ...

Terminology
The following terms are used throughout this document specifically in the context of the RTB
Interface and this specification.
Term Definition
RTB - Bidding for individual impressions in real-time (i.e., while a consumer is waiting).
Exchange - A service that conducts an auction among bidders per impression.
Bidder - An entity that competes in real-time auctions to acquire impressions (adKernel platform).
Seat - An entity that wishes to obtain impressions and uses bidders to act on their behalf.
Publisher - An entity that operates one or more sites.
Site - Ad supported content including web and applications unless otherwise specified.

RTB Ecosystem
The mission of the RTB project is to spur greater growth in the Real-Time Bidding (RTB) marketplace by providing open industry standards for communication between buyers of advertising and
sellers of publisher inventory. There are several aspects to these standards including but not limited to the actual real-time bidding protocol, information taxonomies, offline configuration
synchronization, and many more. This document specifies a standard for the Real-Time Bidding Interface. These protocol standards aim to simplify the connection between suppliers of
publisher inventory (i.e., exchanges, networks working with publishers, and sell-side platforms) and competitive buyers of that inventory (i.e., bidders, demand side platforms, or networks
working with advertisers). The overall goal of RTB is to create a lingua franca for communicating between buyers and sellers.
The intent is not to regulate exactly how each business operates. As a project, we aim to make integration between parties easier, so that innovation can happen at a deeper-level at each of the
businesses in the ecosystem.
Buy-Side Sell-Side
Advertiser Consumer
Ad Network Ad Network
Demand-Side Sell-Side
(working for (working for
Platform Platform
buyer) buyer)
Agency Trading
Desk or In-house RTB Server Publisher
RTB Client
Team
Advertiser Auction Service Publisher

Bidder Service
Ad Server Ad Server
Data Figure 2: High-level communications between parties in the Open RTB Ecosystem
Management Data Broker
Platform
RTB Basics
The following figure illustrates the OpenRTB interactions between an exchange and its bidders.
Ad requests originate at publisher sites. For each inbound ad request, bid requests are broadcast to bidders, responses are evaluated under prevailing
auction rules, the winner is notified, and ad markup is returned. The win notice URL and ad markup can contain any of several standard macros that
enable the exchange to communicate critical data to the bidder (e.g., clearing price)
Publishers Buyers
0. Ad Request
1. Bid Request (Auction, Site, Device,& User Data)
Bidder
5. Ad RTB (adKernel
Exchange 2. Bid Response (Bid, Ad URL or Markup) Platform) Insertion
Orders
Real-Time Real-Time
Auction 3. Win Notice (Settlement Price)
Decisioning
Tag Setup
Engine
4. Ad Markup if not on Bid Response
Figure 3: Real-Time request sequence Setup & Traffic Control (Config., Rate Throttling, Request Filters)

Win Notifications
Platform supports two OpenRTB implementations:
1. OpenRTB without “nurl” (default). In this scenario, “nurl” field is absent in bid responses and the system will record wins
automatically when impression happens. SSP has to replace ${AUCTION_PRICE} before the ad markup is being rendered.
2. OpenRTB with “nurl”. Win URL is represented as a separate bid response field. In case of 2nd price auction usage, “nurl” has
to be called before the actual impression happens.

User Syncing
SSP Initiated User Matching
To sync a particular user with AdKernel, the SSP should initiate the user to call for image or iframe pixel using the following URLs:
Image:
<img src='//sync.adkernel.com/user-sync?zone={zone_id}&t=image&r=SSP_REDIR_URL' style ='display:none' width='0' height='0'></img>
Iframe:
<iframe src='//sync.adkernel.com/user-sync?zone={zone_id}&r=SSP_REDIR_URL' style ='display:none' width='0' height='0'
frameborder='0'></iframe>
Where:
- SSP_REDIR_URL is URL-encoded redirect URL to SSP that shall include macro {UID} which will be replaced with buyer’s userId;
- {zone_id} - SSP-specific zone id.
After performing successful user sync, SSP needs to sent DSP’s user id in user.buyeruid bid request field.

Object Specification: Bid Request (p. 1)
The top-level bid request object contains a globally unique bid request or auction ID. This id attribute is required as is at least one impression object.
Other attributes in this top-level object establish rules and restrictions that apply to all impressions being offered.
id string; required Unique ID of the bid request, provided by the exchange.
imp required Representing the impressions offered. At least 1 Imp object is required.
site either site or app is required The publisher’s website.
app either site or app is required The publisher’s application (i.e., non-browser applications).
device required The user’s device to which the impression will be delivered.
user optional The human user of the device; the advertising audience.
at integer; optional Auction type, where 1 = First Price, 2 = Second Price. Default: at=2.
tmax integer; optional Maximum time in milliseconds to submit a bid to avoid timeout. This value is commonly
communicated offline if it is set up on a pub zone.

Object Specification: Bid Request (p. 2)
cur string array Only USD is supported.
bcat string array Blocked advertiser categories using the IAB content categories.
badv string array Block list of advertisers by their domains (e.g., “ford.com”).

Object Specification: Impression
This object describes an ad placement or impression being auctioned.
id string; required A unique identifier for this impression within the context of the bid request (typically,
starts with 1 and increments).
banner either banner,native or video A Banner object.

required
native either banner,native or video A Native object.

required
video either banner,native or video A Video object.

required
bidfloor optional; float; default 0 Minimum bid for this impression expressed in CPM
secure optional; integer Flag to indicate if the impression requires secure HTTPS URL creative assets and
markup, where 0 = non-secure, 1 = secure.

Object Specification: Banner
This object represents the most general type of impression.
w integer; required Width of the impression in pixels.
h integer; required Height of the impression in pixels.
battr integer array; optional Blocked creative attributes.
pos integer; optional Ad position on screen.
btype integer array; optional Blocked banner ad types.
mimes string array; optional Content MIME types supported. Popular MIME types may include:
“application/x-shockwave-flash”, ”image/jpeg” and “image/gif”.

Object Specification: Video
This object represents the most general type of impression.
mimes string array; optional Content MIME types supported.
minduration integer; optional Height of the impression in pixels.
maxduration integer; optional Maximum video ad duration in seconds.
protocols integer array; optional Minimum width of the impression in pixels.
w integer; optional Width of the video player.
h integer; optional Height of the video player.
api integer array; optional List of supported API frameworks for this impression.
linearity integer; optional Indicates if the impression must be linear or non-linear.
startdelay integer; optional (default = 0) >0 = Mid-Roll (value indicates start delay in second), 0 = Pre-Roll, -1 = Generic
Mid-Roll, -2 = Generic Post-Roll.
Object Specification: Native, User
“Native” as an object represents a native type impression. Native ad units are intended to blend seamlessly into the surrounding content. As
such, the response must be well-structured to afford the publisher fine-grained control over rendering.
“User” as an object contains information known or derived about the human user of the device (i.e., the audience for advertising).
Object Attribute Type Description
Native request required Request payload complying with the Native Ad Specification as a string.
battr integer array; optional Blocked creative attributes.
User id string; optional Exchange-specific ID for the user.
buyeruid string; optional Buyer-specific ID for the user as mapped by the exchange for the buyer.
yob integer; optional Year of birth as a 4-digit integer.

Native Request Markup Object
Native request Markup is escaped json document that should be included to a Native Object’s attribute - request.
The Default column dictates how optional parameters should be interpreted if explicit values are not provided.
Field Scope Type Default Description
ver optional string 1 Version of the Native Markup version in use.
layout recommended integer - The Layout ID of the native ad unit.
adunit recommended integer - The Ad unit ID of the native ad unit.
plcmtcnt optional integer 1 The number of identical placements in this Layout.
seq optional integer 0 0 for the first ad, 1 for the second ad, and so on.
assets required an array of - Any bid must comply with the array of elements expressed by the
Asset Objects Exchange.

Object Specification: Site
This object should be included if the ad supported content is a website as opposed to a non-browser application.
pagecat string array; optional Array of IAB content categories that describe the current page or view of the site.
domain string; optional Domain of the site (e.g., “mysite.foo.com”).
page string; optional URL of the page where the impression will be shown.
cat string array; optional Array of IAB content categories of the site.
sectioncat string array; optional Array of IAB content categories that describe the current section of the site.

App Object (p. 1)
This object should be included if the ad supported content is a non-browser application (typically in mobile) as opposed to a website.
id string; optional Exchange-specific app ID.
name string; optional App name (may be aliased at the publisher’s request)
bundle string; required Application bundle or package name (e.g., com.foo.mygame for Android apps and 123456
for Apple apps).
domain string; optional Domain of the app (e.g., “mygame.foo.com”).
storeurl string; optional App store URL for an installed app.
cat string array; optional Array of IAB content categories of the app.
sectioncat string array; optional Array of IAB content categories that describe the current section of the app.
pagecat string array; optional Array of IAB content categories that describe the current page or view of the app.

App Object (p. 2)
This object should be included if the ad supported content is a non-browser application (typically in mobile) as opposed to a website.
ver string; optional Application version.
privacypolicy integer; optional Indicates if the app has a privacy policy, where 0 = no, 1 = yes.
paid integer; optional 0 = app is free, 1 = the app is a paid version.
keywords string; optional Comma separated list of keywords about the app.

Device Object (p. 1)
This object provides information pertaining to the device through which the user is interacting. Device information includes its hardware,
platform, location, and carrier data. The device can refer to a mobile handset, a desktop computer, set top box, or other digital device. For
desktop devices only “ua” and “ip” attributes are required. Mobile devices require “ifa” or “ifa” hashes to be present.
ua string; required Browser user agent string.
geo object Location of the device assumed to be the user’s current location defined by a Geo object.
ip string; required IPv4 address.
devicetype Integer; optional The general type of device.
make string; optional Device make (e.g., “Apple”).
model string; optional Device model (e.g., “iPhone”).
os string; optional Device operating system (e.g., “iOS”).
osv string; optional Device operating system version (e.g., “3.1.2”).

hwv string; optional Hardware version of the device (e.g., “5S” for iPhone 5S).
h integer; optional Physical height of the screen in pixels.
w integer; optional Physical width of the screen in pixels.
ppi integer; optional Screen size as pixels per linear inch.
pxratio float; optional The ratio of physical pixels to device independent pixels.
js integer; optional Support for JavaScript, where 0 = no, 1 = yes.
flashver string; optional Version of Flash supported by the browser.
language string; optional Browser language using ISO-639-1-alpha-2.
carrier string; optional Carrier or ISP (e.g., “VERIZON”). “WIFI” is often used in mobile to indicate high bandwidth.
connectiontype integer; optional Network connection type.

ifa ID sanctioned for advertiser use in the clear (i.e., not hashed). “Apple ID for Advertising” or
“Android Advertiser Id”.
didsha1 Hardware device ID (e.g., IMEI); hashed via SHA1.

string; at least 1 must be
didmd5 present; optional Hardware device ID (e.g., IMEI); hashed via MD5.
dpidsha1 Platform device ID (e.g., Android ID); hashed via SHA1.
dpidmd5 Platform device ID (e.g., Android ID); hashed via MD5.
macsha1 string; optional MAC address of the device; hashed via SHA1.
macmd5 string; optional MAC address of the device; hashed via MD5.

Geo Object
This object encapsulates various methods for specifying a geographic location.
lat float; optional Latitude from -90.0 to +90.0, where negative is south.
lon float; optional Longitude from -180.0 to +180.0, where negative is west.
type integer; optional Source of location data; recommended when passing lat/lon. type=1: GPS/Location
Services, type=2: IP Address, type=3: User provided (e.g., registration data).
country string; optional Country code using ISO-3166-1-alpha-3.
region string; optional Region code using ISO-3166-2; 2-letter state code if USA.
city string; optional City from MaxMind geo database.
zip string; optional Zip or postal code.
utcoffset integer; optional Local time as the number +/- of minutes from UTC.

Asset Object
The main container object for each asset requested or supported by Exchange on behalf of the rendering client. Any object that is required is
to be flagged as such. Only one of the {title,img,data,video} objects should be present in each object. All others should be null/absent. The id
is to be unique within the Asset Object array so that the response can be aligned.
id required integer - Unique asset ID, assigned by exchange. Typically a counter for the
array.
required optional integer 0 Set to 1 if asset is required (exchange will not accept a bid
without it).
title object - Title object for title assets.
data object - Data object for ratings, prices etc.

one of the
{title, img,
img data, video} object - Image object for image assets.
video object - Video object for video assets.

Title Object
The Title object is to be used for title element of the Native ad.
len required integer - Maximum length of the text in the title element.

Image Asset Object
The Image object to be used for all image elements of the Native ad such as Icons, Main Image, etc.
type optional integer - Type ID of the image element supported by the publisher.
w optional integer Width of the image in pixels.
wmin recommended integer - The minimum requested width of the image in pixels.
h optional integer - Height of the image in pixels.
hmin recommended integer - The minimum requested height of the image in pixels.
mimes optional array of strings All types allowed Whitelist of content MIME types supported. Popular MIME types
include, but are not limited to “image/jpg” “image/gif”.

Video Asset Object
The video object to be used for all video elements supported in the Native Ad.
mimes required array of strings - Content MIME types supported. Popular MIME types include,but
are not limited to “video/x-ms-wmv” for Windows Media, and
“video/x-flv” for Flash Video.
minduration required integer - Minimum video ad duration in seconds.
maxduration required integer - Maximum video ad duration in seconds.
protocols required array of integers - An array of video protocols the publisher can accept in the bid
response.

Data Asset Object
The Data Object is to be used for all non-core elements of the native unit.
type required integer - Type ID of the element supported by the publisher. The publisher
can display this information in an appropriate format.
len optional integer - Maximum length of the text in the element’s response.

Banner Request Example
1. {
2. "id": "4487159888663217854",
3. "imp": [ {
4. "id": "1",
5. "banner": {
6. "w": 300,
7. "h": 250
8. }
9. }],
10. "site": {
11. "page": "http://test.com/page1?param=value"
12. },
13. "device": {
14. "ua": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_6_8) AppleWebKit/537.13 (KHTML, like Gecko) Version/5.1.7 Safari/534.57.2",
15. "ip": "1.1.1.1"
16. }
17. }

Banner Response Example
1. {
2. "id" : "4487159888663217854",
3. "seatbid" : [ {
4. "bid" : [ {
5. "id" : "QRh2T-YNIFk_0",
6. "impid" : "1",
7. "price" : 0.01,
8. "adid" : "823011",
9. "nurl" : "http://rtb.adkernel.com/win?i=QRh2T-YNIFk_0&price=${AUCTION_PRICE}",
10. "adm" : "<a href=\"http://rtb.adkernel.com/click?i=QRh2T-YNIFk_0\" target=\"_blank\"><img src=\"http://rtb.adkernel.com/n1/ad/300x250_EUNqbCsW.png\"
width=\"300\" height=\"250\" border=\"0\" ></a><img src='http://rtb.adkernel.com/pixel?i=QRh2T-YNIFk_0' alt=' ' style='display:none'>",
11. "adomain" : [ "adkernel.com" ],
12. "iurl" : "http://xs.wowconversions.com/n1/ad/300x250_EUNqbCsW.png",
13. "cid" : "28734",
14. "crid" : "823011",
15. "cat" : [ "IAB3-1" ]
16. } ]
17. } ]
18. }

Native Request Example
1. {
2. "id": "4487159888663217854",
3. "imp": [
4. {
5. "id": "1",
6. "native": {
7. "request": "{ \"native\": { \"plcmtcnt\": 5, \"assets\": [ { \"id\": 1, \"title\": { \"len\": 25 } }, { \"id\": 2, \"data\": {
\"type\": 2, \"len\": 35 } }, { \"id\": 3, \"data\": { \"type\": 10, \"len\": 35 } }, { \"id\": 4, \"data\": { \"type\": 11, \"len\":
35 } }, { \"id\": 5, \"img\": { \"wmin\": 50, \"hmin\": 50 } } ] } }"
8. }
9. },
10. {
11. "id": "2",
12. "native": {
13. "request": "{ \"native\": { \"plcmtcnt\": 3, \"assets\": [ { \"id\": 1, \"title\": { \"len\": 40 } }, { \"id\": 2,
\"required\": 1, \"data\": { \"type\": 2, \"len\": 30 } }, { \"id\": 3, \"data\": { \"type\": 8, \"len\": 35 } }, { \"id\": 4,
\"video\": { \"mimes\": [\"video/mp4\"], \"minduration\": 10, \"maxduration\": 30, \"protocols\": [2] } } ] } }"
14. }
15. }
16. ],
17. "site": {
18. "page": "http://test.com/page1?param=value"
19. },
20. "device": {
21. "ua": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_6_8) AppleWebKit/537.13 (KHTML, like Gecko) Version/5.1.7 Safari/534.57.2",
22. "ip": "123.145.167.13"
23. }
24. }
View formatted Native ad markup requests here

Native Response Example
1. {
2. "id": "4487159888663217854",
3. "seatbid": [
4. {
5. "bid": [
6. {
7. "id": "890784660",
8. "impid": "1",
9. "price": 0.75,
10. "nurl": "http://ads.adkernel.com/win?i=zlyFxRMRjBk_0",
11. "adm": "{\"native\":{\"assets\":[{\"id\":1,\"title\":{\"text\":\"TextAd 1 Title\"}},{\"id\":2,\"data\":{\"value\":\"TextAd 1
Descriprion\"}},{\"id\":3,\"data\":{\"value\":\"TextAd 1 Descriprion Line
2\"}},{\"id\":4,\"data\":{\"value\":\"www.textad1.com\"}},{\"id\":5,\"img\":{\"url\":\"http://ads.adkernel.com/thumbnail?i=zlyFxRMRjBk_0\"}}],\"link\":{\"url\
":\"http://ads.adkernel.com/click?i=zlyFxRMRjBk_0\"},\"imptrackers\":[\"http://ads.adkernel.com/impression?i=zlyFxRMRjBk_0\"]}}",
12. "adomain": [ "adkernel.com" ],
13. "iurl": "http://ads.adkernel.com/1.png"
14. },
15. {
16. "id": "1309277383",
17. "impid": "1",
18. "price": 0.7,
19. "nurl": "http://ads.adkernel.com/win?i=zlyFxRMRjBk_1",
20. "adm": "{\"native\":{\"assets\":[{\"id\":1,\"title\":{\"text\":\"TextAd 2 Title\"}},{\"id\":2,\"data\":{\"value\":\"TextAd 2
Descriprion\"}},{\"id\":3,\"data\":{\"value\":\"TextAd 2 Descriprion Line
2\"}},{\"id\":4,\"data\":{\"value\":\"www.textad2.com\"}},{\"id\":5,\"img\":{\"url\":\"http://ads.adkernel.com/thumbnail?i=zlyFxRMRjBk_1\"}}],\"link\":{\"url\
":\"http://ads.adkernel.com/click?i=zlyFxRMRjBk_1\"},\"imptrackers\":[\"http://ads.adkernel.com/impression?i=zlyFxRMRjBk_1\"]}}",
21. "adomain": [ "adkernel.com" ],
22. "iurl": "http://ads.adkernel.com/1.png"
23. }
24. ]
25. }
26. ]
27. }

Native Impressions Markup Request Examples
1. {
2. "native": { 1. {
3. "plcmtcnt": 5, Impression 1 2. "native": { Impression 2
4. "assets": [ 3. "plcmtcnt": 3,
5. { 4. "assets": [
6. "id": 1, 5. {
7. "title": { 6. "id": 1,
8. "len": 25 7. "title": {
9. } 8. "len": 40
10. }, 9. }
11. { 10. },
12. "id": 2, 11. {
13. "data": { 12. "id": 2,
14. "type": 2, 13. "required": 1,
15. "len": 35 14. "data": {
16. } 15. "type": 2,
17. }, 16. "len": 30
18. { 17. }
19. "id": 3, 18. },
20. "data": { 19. {
21. "type": 10, 20. "id": 3,
22. "len": 35 21. "data": {
23. } 22. "type": 8,
24. }, 23. "len": 35
25. { 24. }
26. "id": 4, 25. },
27. "data": { 26. {
28. "type": 11, 27. "id": 4,
29. "len": 35 28. "video": {
30. } 29. "mimes": ["video/mp4"],
31. }, 30. "minduration": 10,
32. { 31. "maxduration": 30,
33. "id": 5, 32. "protocols": [2]
34. "img": { 33. }
35. "wmin": 50, 34. }
36. "hmin": 50 35. ]
37. } 36. }
38. } 37. }
39. ]
40. }
41. }

Video Request Example
{
"id" : "4875919083579324639",
"imp" : [ {
"id" : "1",
"video" : {
"mimes" : [ "application/x-shockwave-flash", "video/mp4", "video/webm", "video/x-ms-wmv", "video/x-flv" ],
"w" : 300,
"h" : 250,
"startdelay" : 0,
"linearity" : 1,
"api" : [ 1, 2 ]
},
"bidfloor" : 2.8
} ],
"site" : {
"domain" : "test.com",
"page" : "http://www.test.com/"
},
"device" : {
"ua" : "Mozilla/5.0 (Linux; Android 4.4.4; SGH-M919 Build/KTU84P) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/33.0.0.0
Mobile Safari/537.36 Flipboard/3.4.15/2970,3.4.15.2970",
"ip" : "173.28.127.49",
"geo" : {
"lat" : 31.450195,
"lon" : -110.8311,
"country" : "USA",
"region" : "AZ",
"city" : "Nogales",
"zip" : "85621",
"type" : 2
},
},
"user" : {
"id" : "830413997"
}
}
Video Response Example
1. {
2. "id": "4875919083579324639",
3. "seatbid": [{
4. "bid": [{
5. "id": "qEUtBo*gUd4_0_0",
6. "impid": "1",
7. "price": 2.85,
8. "adid": "33437",
9. "nurl": "http://win-dsp.adkernel.com/win?i=qEUtBo*gUd4_0_0",
10. "adm": "<VAST version=\"2.0\"><Ad><Wrapper><AdSystem>AdKernel
DSP</AdSystem><VASTAdTagURI><![CDATA[http://dsp.adkernel.com/admarkup?i=qEUtBo*gUd4_0_0]]></VASTAdTagURI><Impression><![CDATA[http://dsp.adkernel.com/vtrack?i
=qEUtBo*gUd4_0_0&event=wrapper_impression]]></Impression></Wrapper></Ad></VAST>",
11. "cat": ["IAB19-14"],
12. "adomain": ["ford.ca"],
13. "cid": "5993",
14. "crid": "33437"
15. }
16. ]
17. }
18. ],
19. "bidid": "qEUtBo*gUd4"
20. }

Supported Native Ad Units
Ad Unit ID Description
1 Paid Search Units
2 Recommendation Widgets
3 Promoted Listings
4 In-Ad (IAB Standard) with Native Element Units
5 Custom /”Can’t Be Contained”
501 In-Feed
502 End of Post
503 In-Article
504 In-Image

Supported Native Layouts
Layout ID Description
1 Content Wall
2 App Wall
3 News Feed
4 Chat List
5 Carousel
6 Content Stream
7 Grid adjoining the content

Image Asset Types
Type ID Name Description
1 Icon Icon image
2 Logo Logo image for the brand/app.
3 Main Large image preview for the ad

Data Asset Types (p. 1)
Type ID Name Description Format
1 sponsored Sponsored By message where response should contain the brand name of the text
sponsor.
2 desc Descriptive text associated with the product or service being advertised. text
3 rating Rating of the product being offered to the user. For example an app’s rating in an number formatted as
app store from 0-5. string
4 likes Number of social ratings or “likes” of the product being offered to the user. number formatted as
string
5 downloads Number downloads/installs of this product number formatted as

string
6 price Price for product / app / in-app purchase. Value should include currency symbol number formatted as
in localised format. string
7 saleprice Sale price that can be used together with price to indicate a discounted price number formatted as
compared to a regular price. Value should include currency symbol in localised string
format.

Data Asset Types (p. 2)
Type ID Name Description Format
8 phone Phone number formatted string
9 address Address text
10 desc2 Additional descriptive text associated with the product or service being text
advertised
11 displayurl Display URL for the text ad text
12 ctatext CTA description-descriptive text describing a ‘call to action’ button for the text
destination URL

Banner Ad Types
ID Description
1 XHTML Text Ad (usually mobile)
2 XHTML Banner Ad. (usually mobile)
3 Javascript Ad; must be valid XHTML (i.e., Script Tags Included)
4 Iframe

Creative Attributes (p.1)
ID Description
1 Audio Ad (Auto-Play)
2 Audio Ad (User Initiated)
3 Expandable (Automatic)
4 Expandable (User Initiated - Click)
5 Expandable (User Initiated - Rollover)
6 In-Banner Video Ad (Auto-Play)
7 In-Banner Video Ad (User Initiated)
8 Pop (e.g., Over, Under, or Upon Exit)
9 Provocative or Suggestive Imagery

Creative Attributes (p.2)
ID Description
10 Shaky, Flashing, Flickering, Extreme Animation, Smileys
11 Surveys
12 Text Only
13 User Interactive (e.g., Embedded Games)
14 Windows Dialog or Alert Style
15 Has Audio On/Off Button
16 Ad provides Skip Button (e.g. VPAID-rendered skip button on pre-roll video)
17 Adobe Flash

Ad Position
ID Description
0 Unknown
1 Above the fold
2 DEPRECATED - May or may not be initially visible depending on screen

size/resolution
3 Below the Fold
4 Header
5 Footer
6 Sidebar
7 Full Screen

Api Frameworks
ID Description
1 VPAID 1.0
2 VPAID 2.0
3 MRAID-1
4 ORMMA
5 MRAID-2

Video Linearity
ID Description
1 Linear / In-Stream
2 Non-Linear / Overlay

Protocols
ID Description
1 VAST 1.0
2 VAST 2.0
3 VAST 3.0
4 VAST 1.0 Wrapper
5 VAST 2.0 Wrapper
6 VAST 3.0 Wrapper
7 Vast 4.0
8 DAAST 1.0

Device Type
ID Description Notes
1 Mobile/Tablet Version 2.0
2 Personal Computer Version 2.0
3 Connected TV Version 2.0
4 Phone New for Version 2.2
5 Tablet New for Version 2.2
6 Connected Device New for Version 2.2
7 Set Top Box New for Version 2.2

RTB Manual

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

RTB Manual

Uploaded by

Copyright:

Available Formats

AdKernel RTB

OpenRTB specification for SSPs

AdKernel. All rights reserved. 2016. v.1.2.

AdKernel. All rights reserved. 2016. v.1.2.

To assist a first time reader of

A minimal viable interface should include the required parameters.

Optional parameters may be included to ensure

AdKernel. All rights reserved. 2016. v.1.2.

Attribute Type Description

imp required ...

device required ...

user optional ...

bcat optional ...

AdKernel. All rights reserved. 2016. v.1.2.

AdKernel. All rights reserved. 2016. v.1.2.

Advertiser Auction Service Publisher

AdKernel. All rights reserved. 2016. v.1.2.

AdKernel. All rights reserved. 2016. v.1.2.

AdKernel. All rights reserved. 2016. v.1.2.

Attribute Type Description

id string; required Unique ID of the bid request, provided by the exchange.

site either site or app is required The publisher’s website.

AdKernel. All rights reserved. 2016. v.1.2.

cur string array Only USD is supported.

AdKernel. All rights reserved. 2016. v.1.2.

Attribute Type Description

banner either banner,native or video A Banner object.

native either banner,native or video A Native object.

video either banner,native or video A Video object.

AdKernel. All rights reserved. 2016. v.1.2.

Attribute Type Description

w integer; required Width of the impression in pixels.

h integer; required Height of the impression in pixels.

battr integer array; optional Blocked creative attributes.

pos integer; optional Ad position on screen.

btype integer array; optional Blocked banner ad types.

AdKernel. All rights reserved. 2016. v.1.2.

Attribute Type Description

mimes string array; optional Content MIME types supported.

minduration integer; optional Height of the impression in pixels.

maxduration integer; optional Maximum video ad duration in seconds.

protocols integer array; optional Minimum width of the impression in pixels.

w integer; optional Width of the video player.

h integer; optional Height of the video player.

linearity integer; optional Indicates if the impression must be linear or non-linear.

Object Attribute Type Description

battr integer array; optional Blocked creative attributes.

User id string; optional Exchange-specific ID for the user.

yob integer; optional Year of birth as a 4-digit integer.

AdKernel. All rights reserved. 2016. v.1.2.

Field Scope Type Default Description

ver optional string 1 Version of the Native Markup version in use.

layout recommended integer - The Layout ID of the native ad unit.

adunit recommended integer - The Ad unit ID of the native ad unit.

plcmtcnt optional integer 1 The number of identical placements in this Layout.

AdKernel. All rights reserved. 2016. v.1.2.

Attribute Type Description

domain string; optional Domain of the site (e.g., “mysite.foo.com”).

AdKernel. All rights reserved. 2016. v.1.2.

Attribute Type Description

id string; optional Exchange-specific app ID.

domain string; optional Domain of the app (e.g., “mygame.foo.com”).

storeurl string; optional App store URL for an installed app.