A Node.js library which builds, validates and processes OpenRTB objects. This project was inspired by the good people at Metamarkets who build a similar library for Java.
npm install openrtb
The library exposes object builders which are used to construct new objects.
Supported objects builders
OpenRTB API Specification Version 2.3
-
BidRequest
- Imp
- Native
- Banner
- App
- Publisher
- Device
- User
- Imp
-
BidResponse
- SeatBid
- Bid
- SeatBid
OpenRTB API Specification Version 2.2
Not supported but most objects for v2.3 should work for this one too.
var builder = new BidRequestBuilder();
builder
.timestamp(moment.utc().format())
.id('1234')
.at(2)
.imp([
{
"id":"1",
"native":{
"request": {
"ver": 1,
"layout": 6,
"assets": [
{ "id": 0, "req": 1, "title": { "len": 25 } },
{ "id": 1, "req": 1, "img": { "type": 3, "wmin": 100, "hmin": 100 } },
{ "id": 3, "req": 0, "data": { "type": 2, "len": 90 } }
]
}
},
"tagid": "eb09ff2a287598302fd631493949169b0d17f815",
"bidfloor": 1.3
}
])
.app({
"id":"55",
"name":"Test App",
"cat":["IAB3-1"],
"storeurl": "https://www.example.com",
"publisher":{
"id": "6332"
}
})
.device({
"dnt":0,
"ua":"Mozilla/5.0 (Linux; U; Android 4.0.3; ko-kr; LG-L160L Build/IML74K) AppleWebkit/534.30 (KHTML, like Gecko) Version/4.0 Mobile Safari/534.30",
"ip":"76.174.49.222",
"connectiontype":2,
"devicetype":1,
"didsha1": "bbc9ff2a287598302fd631693949169b0d17f215",
"carrier": "o2",
"make": "samsung GT-I9300",
"model": "Android",
"language": "en",
"os": "Android",
"osv": "5.1.1",
"geo": {
"country": "UK"
}
})
.user({
"id":"55816b39711f9b5acf3b90e313ed29e51665623f",
"yob": 1987,
"gender": "M"
})
.ext({
'extra': '1234'
})
.build()
.then(function(bidRequest){
//Do something with the object
}); var builder = new BidResponseBuilder();
builder
.timestamp(moment.utc().format())
.status(1)
.bidderName('test-bidder')
.seatbid([
{
bid: [
{
status: 1,
clearPrice: 0.9,
adid: 1,
id: '819582c3-96b2-401a-b60d-7ac3c117a513',
impid: 'e317ae49-8cd1-47b0-b022-02a8830182ce',
price: 1.05,
nurl: 'https://trackwin.com/win?pid=784170&data=OuJifVtEK&price=${AUCTION_PRICE}',
adm: '{"native":{"assets":[{"id":0,"title":{"text":"Test Campaign"}},{"id":1,"img":{"url":"https://cdn.exampleimage.com/a/100/100/2639042","w":100,"h":100}},{"id":2,"img":{"url":"https://cdn.exampleimage.com/a/50/50/2639042","w":50,"h":50}},{"id":3,"data":{"value":"This is an amazing offer..."}},{"id":5,"data":{"value":"Install"}}],"link":{"url":"https://trackclick.com/Click?data=soDvIjYdQMm3WBjoORcGaDvJGOzgMvUap7vAw2"},"imptrackers":["https://trackimp.com/Pixel/Impression/?bidPrice=${AUCTION_PRICE}&data=OuJifVtEKZqw3Hw7456F-etFgvhJpYOu0&type=img"]}}',
cid: '9607',
crid: '335224',
iurl: 'https://cdn.testimage.net/1200x627.png',
adomain: ["example.com"]
}
]
}
])
.build()
.then(function(bidResponse){
//Do something with the object
});All builders will throw an error when trying to build an object that is missing a required parameter.
var builder = new BidRequestBuilder();
//Trying to build a bid request without a request id
builder
.timestamp(moment.utc().format())
.build()
.catch(function(err){
//The following statement will print 'BidRequest should have a requestId'
console.log(err.message);
});All objects inherit common functionality from a base RtbObject and also define some functionality of their own. See below for the documentation.
Converts the object to a JSON string. Properties that are undefined are not included.
Additional Properties
The timestamp of the bid request. If not provided explicitly at build time the default will be the current UTC when the object is created.
Additional Properties
The table below lists the possible values for a bid response status.
| Status | Description |
|---|---|
| 1 | Valid |
| 2 | Timeout |
| 3 | Invalid JSON |
| 4 | HTTP Error |
The bidder's name used for reporting and debugging.
The timestamp of bid response. If not provided explicitly at build time the default will be the current UTC when the object is created.
Additional Properties
The table below lists the possible values for a bid status.
| Status | Description |
|---|---|
| 1 | Won |
| 2 | Lost on Price |
| 3 | Below floor |
| 4 | Markup Delivery Failure |
| 5 | Unscreenable |
| 6 | Blocked by publisher |
| 7 | Unverified creative |
| 8 | Blocked advertiser |
| 9 | Blocked content category |
| 10 | Block creative attribute |
The bid clearing price determined after an auction.
A function which parses the bid's adm. If not provided explicitly the default implenentation is to return the adm as is.
Functions
Replaces auction macros for a bid.
This project is a work in progress. It was created for the specific purposes of the Avocarrot Native Ad Exchange (AVX) and some objects fields or functionality might be missing. If you want something to be added then please either get in touch or submit your own pull request.
This project is work in progress and we'd love more people contributing to it.
- Fork the repo
- Apply your changes
- Write tests
- Submit your pull request
For feedback or suggestions you can drop us a line at [email protected]