> For the complete documentation index, see [llms.txt](https://adagio-io.gitbook.io/adagio-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://adagio-io.gitbook.io/adagio-documentation/openrtb-s2s-endpoint/editor/bid-request-fields-for-web-inventory.md). # 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. {% hint style="info" %} Access the full list of supported parameters in [Bid Request objects and parameters](/adagio-documentation/openrtb-s2s-endpoint/all-supported-openrtb-parameters/bid-request-objects-and-parameters.md) {% endhint %} ## Required parameters {% hint style="danger" %} AdRequests that do not include these parameters **won't be monetized****,** we've **only listed the parameters that are specific to Adagio** {% endhint %} * `bidrequest.id` * `bidrequest.site.domain` * `bidrequest.imp[].id` * `bidrequest.imp[].tagid` * depending on the media * `bidrequest.imp[].banner.*` , `bidrequest.imp[].video.*` or `bidrequest.imp[].native.*` * if applicable: * `bidrequest.regs.*` * `bidrequest.user.consent` or `bidrequest.user.ext.consent` ## Recommended parameters {% hint style="success" %} Including the parameters below has been shown to **increase the monetization performance** of your inventory {% endhint %}
⚡️ Highly Recommended * `bidrequest.site.publisher.id` * `bidrequest.tmax` * `bidrequest.cur` * `bidrequest.source.*`: *all sub-fields are considered as bringing value to the demand* * **`bidrequest.user.buyeruid`**: ⭐️ *essential to improve monetization* * `bidrequest.user.data` * `bidrequest.user.ext.eids` *or* `bidrequest.user.eids` * `bidrequest.imp[].bidfloor` * `bidrequest.imp[].bidfloorcur` * if open measurement is present : * `bidrequest.imp[].api = 7` * `bidrequest.source.ext.omidpn` (string): OM SDK partner name. * `bidrequest.source.ext.omidpv` (string): OM SDK version * `bidrequest.imp[].ext.gpid`
✅ Recommended * `bidrequest.site.ext.pagetype` * `bidrequest.site.ext.category` * `bidrequest.imp[].metric` * `bidrequest.imp[].instl` * `bidrequest.imp[].exp` * for video: * `bidrequest.imp[].displaymanager` * `bidrequest.imp[].displaymanagerver` * `bidrequest.device.*`: *all sub-fields are considered as bringing value to the demand* * `bidrequest.geo.*`: *all sub-fields are considered as bringing value to the demand* {% hint style="info" %} In addition, see [Supported Extensions](/adagio-documentation/openrtb-s2s-endpoint/supported-extensions.md) to maximize even more your revenue. {% endhint %}
### Bid Request Sample for Web {% hint style="info" %} **Adagio supports both multi imps and multi mediatypes (Banner, Video and Native).** {% endhint %} {% tabs %} {% tab title="Banner" %} ```json { "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" } } ``` {% endtab %} {% tab title="Video" %} ```json { "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" } } ``` {% endtab %} {% tab title="Native" %} ```json { "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" } } ``` {% endtab %} {% endtabs %}
--- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://adagio-io.gitbook.io/adagio-documentation/openrtb-s2s-endpoint/editor/bid-request-fields-for-web-inventory.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.