burl Field Overview¶
The idea behind the burl
field is to standardise the billing mechanism
for Server-to-Server (s2s) notifications sent to Buyers. As such, it has the
following properties when used with The MediaGrid:
It must contain the win price macro
It is always a server-to-server (S2S) call
It can be used in conjunction with the
adm
ornurl
field, as well as used independently.
burl Response Examples¶
A win price macro can be passed in the burl
field, and the adm
or nurl
field. The win price macro cannot be given in the adm
and nurl
field
simultaneously.
burl Response¶
{
"seatbid":[
{
"bid":[
{
"burl":"https://dsp.com/winnotice?impid=102&winprice=${AUCTION_PRICE}",
"adm":"<a href=\"https://adserver.com/clickadid=12345&tracker=${CLICK_URL:URLENCODE}\"><img src=\"https://image1.cdn.com/impid=102\"/></a>"
}
]
}
]
}
burl + adm Response¶
In this response, both the burl
and adm
fields contain the win price
macro. The nurl
field is not given as it is optional with the use of the
burl
field..
{
"seatbid":[
{
"bid":[
{
"burl":"https://dsp.com/winnotice?impid=102&winprice=${AUCTION_PRICE}",
"adm":"<iframe src=\"http://dsp.com/imp?bc=12345aaabbb&price=${AUCTION_PRICE}\"><\/iframe>"
}
]
}
]
}
burl + nurl Response¶
In this response, both the burl
and nurl
fields contain the win price
macro. The adm
field does not.
{
"seatbid":[
{
"bid":[
{
"burl":"https://dsp.com/imp?impid=102&winprice=${AUCTION_PRICE}",
"adm":"<a href=\"https://adserver.com/clickadid=12345&tracker=${CLICK_URL:URLENCODE}\"><img src=\"https://image1.cdn.com/impid=102\"/></a>",
"nurl":"https://dsp.com/winnotice?impid=102&winprice=${AUCTION_PRICE}"
}
]
}
]
}