Bid Request Fields for Web Inventory
In OpenRTB, the bidrequest object acts as the central container for a request. It provides a complete description of the ad opportunity, user information, environment details, and any other context needed for effective bidding.
Below are the fields that Adagio considers required or highly recommended for OpenRTB S2S bid requests on Web inventory. A sample bid request from a publisher appears after the table.
- Required: Necessary to receive a response from Adagio.
- Highly Recommended: Shown to improve yield and performance.
Required parameters
Section titled “Required parameters”bidrequest.idbidrequest.site.domainbidrequest.imp[].idbidrequest.imp[].tagid- depending on the media
bidrequest.imp[].banner.*,bidrequest.imp[].video.*orbidrequest.imp[].native.*
- if applicable:
bidrequest.regs.*bidrequest.user.consentorbidrequest.user.ext.consent
Recommended parameters
Section titled “Recommended parameters”⚡️ Highly Recommended
bidrequest.site.publisher.idbidrequest.tmaxbidrequest.curbidrequest.source.*: all sub-fields are considered as bringing value to the demandbidrequest.user.buyeruid: ⭐️ essential to improve monetizationbidrequest.user.databidrequest.user.ext.eidsorbidrequest.user.eidsbidrequest.imp[].bidfloorbidrequest.imp[].bidfloorcur- if open measurement is present :
bidrequest.imp[].api = 7bidrequest.source.ext.omidpn(string): OM SDK partner name.bidrequest.source.ext.omidpv(string): OM SDK version
bidrequest.imp[].ext.gpid
✅ Recommended
bidrequest.site.ext.pagetypebidrequest.site.ext.categorybidrequest.imp[].metricbidrequest.imp[].instlbidrequest.imp[].exp- for video:
bidrequest.imp[].displaymanagerbidrequest.imp[].displaymanagerver
bidrequest.device.*: all sub-fields are considered as bringing value to the demandbidrequest.geo.*: all sub-fields are considered as bringing value to the demand
Bid Request Sample for Web
Section titled “Bid Request Sample for Web ”{ "id": "4388c899-137d-4a18-a13a-a8a221515f95", "tmax": 1200, "imp": [ { "id": "1", "tagid": "12303405", "banner": { "format": [ { "w": 728, "h": 90 }, { "w": 970, "h": 90 } ], "topframe": 1 }, "bidfloor": 0.01, "ext": { "gpid": "/Quizzes/970x90/sidebar" } } ], "at": 1, "cur": [ "USD" ], "site": { "name": "adagio-test", "page": "https://adagio.io/contact", "domain": "maville.com", "publisher": { "id": "1010", "name": "Adagio Test" }, "ext": { "pagetype": "topic", "category": "home" } }, "regs": { "ext": { "gdpr": 1 }, "coppa": 0 }, "user": { "ext": { "consent": "CO9boCtO9boCtAJAEBENBBCsAP_AAH_AACiQHGtd_X_fb39j-_59_9t0eY1f9_7_v20zjgeds-8Nyd_X_L8X42M7vB36pq4KuR4Eu3LBAQFlHOHcTUmw6IkVqTPsak2Mr7NKJ7PEinMbe2dYGHtfn9VTuZKYr97s___z__-__v__79f_r-3_3_vp9V---2BxIBJhqXwEWYljgSTRpVCiBCFcSHQAgAooRhaJrCAlcFOyuAj9BAwAQGoCMCIEGIKMWQQAAAABJREBIAeCARAEQCAAEAKkBCAAjQBBYASBgEAAoBoWAEUAQgSEGRwVHKYEBEi0UE8lYAlF3sYYQhlFADQIAAAA.f_gAD_gAAAAA" }, "buyeruid": "SvCyIi2UJ4sijQJgw15ppenGPqMsmhJlK-G2jfHq7_I" }, "source": { "tid": "4388c899-137d-4a18-a13a-a8a221515f95" "ext": { "schain": { "ver": "1.0", "complete": 1, "nodes": [ { "asi": "advertising-sys.com", "sid": "99999", "hp": 1 } ] } } }, "device": { "ua": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.66 Safari/537.36", "geo": { "lat": "41.22", "lon": "15.28", "type": 2, "ipservice": 3, "country": "ITA", "region": "75", "city": "Panni", "accuracy": 1.11 }, "ip": "87.10.150.0", "dnt": 0, "devicetype": 2, "os": "Windows", "osv": "10", "js": 1, "language": "en" }}{ "id": "de641c15-bace-4f80-8425-d21b4f62fecc", "tmax": 1200, "imp": [ { "id": "1", "tagid": "12303405", "bidfloor": 0.02268, "video": { "protocols": [ 2, 5 ], "placement": 1, "playbackend": 1, "minduration": 5, "skip": 1, "playbackmethod": [3], "maxduration": 60, "startdelay": 0, "linearity": 1, "mimes": [ "video/mp4", "video/webm" ] }, "ext": { "gpid": "/Quizzes/970x90/sidebar" } } ], "site": { "name": "adagio-test", "page": "https://adagio.io/contact", "domain": "maville.com", "publisher": { "id": "1010", "name": "Adagio Test" }, "ext": { "pagetype": "topic", "category": "home" } }, "regs": { "ext": { "gdpr": 1 }, "coppa": 0 }, "user": { "ext": { "consent": "CO9boCtO9boCtAJAEBENBBCsAP_AAH_AACiQHGtd_X_fb39j-_59_9t0eY1f9_7_v20zjgeds-8Nyd_X_L8X42M7vB36pq4KuR4Eu3LBAQFlHOHcTUmw6IkVqTPsak2Mr7NKJ7PEinMbe2dYGHtfn9VTuZKYr97s___z__-__v__79f_r-3_3_vp9V---2BxIBJhqXwEWYljgSTRpVCiBCFcSHQAgAooRhaJrCAlcFOyuAj9BAwAQGoCMCIEGIKMWQQAAAABJREBIAeCARAEQCAAEAKkBCAAjQBBYASBgEAAoBoWAEUAQgSEGRwVHKYEBEi0UE8lYAlF3sYYQhlFADQIAAAA.f_gAD_gAAAAA" }, "buyeruid": "SvCyIi2UJ4sijQJgw15ppenGPqMsmhJlK-G2jfHq7_I" }, "source": { "tid": "de641c15-bace-4f80-8425-d21b4f62fecc", "ext": { "schain": { "ver": "1.0", "complete": 1, "nodes": [ { "asi": "advertising-sys.com", "sid": "99999", "hp": 1 } ] } } }, "device": { "ua": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.66 Safari/537.36", "geo": { "lat": "41.22", "lon": "15.28", "type": 2, "ipservice": 3, "country": "ITA", "region": "75", "city": "Panni", "accuracy": 1.11 }, "ip": "87.10.150.0", "dnt": 0, "devicetype": 2, "os": "Windows", "osv": "10", "js": 1, "language": "en" }}{ "id": "4388c899-137d-4a18-a13a-a8a221515f95", "tmax": 1200, "imp": [ { "id": "1", "tagid": "12303405", "native": { "request": "{\"plcmtcnt\":1,\"plcmttype\":2,\"privacy\":1,\"context\":1,\"contextsubtype\":12,\"assets\":[{\"id\":1,\"data\":{\"type\":12},\"required\":1},{\"title\":{\"len\":50},\"id\":2,\"required\":1},{\"id\":3,\"img\":{\"w\":80,\"h\":80,\"type\":1},\"required\":1},{\"id\":4,\"img\":{\"w\":1200,\"h\":627,\"type\":3},\"required\":1},{\"data\":{\"type\":3},\"id\":5,\"required\":0},{\"id\":6,\"data\":{\"len\":100,\"type\":2},\"required\":1}],\"ver\":\"1.2\"}" }, "bidfloor": 0.324, "ext": { "gpid": "/Quizzes/970x90/sidebar" } } ], "at": 1, "cur": [ "USD" ], "site": { "name": "adagio-test", "page": "https://adagio.io/contact", "domain": "maville.com", "publisher": { "id": "1010", "name": "Adagio Test" }, "ext": { "pagetype": "topic", "category": "home" } }, "regs": { "ext": { "gdpr": 1 }, "coppa": 0 }, "user": { "ext": { "consent": "CO9boCtO9boCtAJAEBENBBCsAP_AAH_AACiQHGtd_X_fb39j-_59_9t0eY1f9_7_v20zjgeds-8Nyd_X_L8X42M7vB36pq4KuR4Eu3LBAQFlHOHcTUmw6IkVqTPsak2Mr7NKJ7PEinMbe2dYGHtfn9VTuZKYr97s___z__-__v__79f_r-3_3_vp9V---2BxIBJhqXwEWYljgSTRpVCiBCFcSHQAgAooRhaJrCAlcFOyuAj9BAwAQGoCMCIEGIKMWQQAAAABJREBIAeCARAEQCAAEAKkBCAAjQBBYASBgEAAoBoWAEUAQgSEGRwVHKYEBEi0UE8lYAlF3sYYQhlFADQIAAAA.f_gAD_gAAAAA" }, "buyeruid": "SvCyIi2UJ4sijQJgw15ppenGPqMsmhJlK-G2jfHq7_I" }, "source": { "tid": "4388c899-137d-4a18-a13a-a8a221515f95", "ext": { "schain": { "ver": "1.0", "complete": 1, "nodes": [ { "asi": "advertising-sys.com", "sid": "99999", "hp": 1 } ] } } }, "device": { "ua": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.66 Safari/537.36", "geo": { "lat": "41.22", "lon": "15.28", "type": 2, "ipservice": 3, "country": "ITA", "region": "75", "city": "Panni", "accuracy": 1.11 }, "ip": "87.10.150.0", "dnt": 0, "devicetype": 2, "os": "Windows", "osv": "10", "js": 1, "language": "en" }}