> For the complete documentation index, see [llms.txt](https://docs.exoclick.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.exoclick.com/rtb/advertisers/open-rtb/open-rtb-advertiser-code-examples.md). # Open RTB 2.4 Examples ## Open RTB Advertiser Request ### Banner ```json { "id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa", "at":1, "imp": [ { "id": "974090632", "banner": { "w": 300, "h": 250, "mimes": [ "image/jpg", "image/png", "video/mp4", "image/webp" ], "ext": { "image_output": "xml", "video_output": "xml" } } } ], "site": { "id": "12345", "domain": "sitedomain.com", "name": "site domain", "cat": ["IAB25-3"], "page": "https://sitedomain.com/page", "keywords": "lifestyle, humour" }, "device": { "ua": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.63 Safari/537.36", "sua": { "architecture": "x86", "bitness": "64", "model": "Windows", "mobile": 0, "source": 2, "platform": { "brand": "Windows", "version": [ "10", "0", "0" ] }, "browsers": [ { "brand": "Chromium", "version": [ "136", "0", "7103", "93" ] }, { "brand": "Microsoft Edge", "version": [ "136", "0", "3240", "64" ] }, { "brand": "Not.A\/Brand", "version": [ "99", "0", "0", "0" ] } ] }, "ip": "192.0.2.1", "geo": { "country": "IRL" }, "language": "en", "os": "Linux & UNIX", "js": 0, "ext": { "remote_addr": "192.0.2.1", "x_forwarded_for": "", "accept_language": "en-GB;q=0.8,pt-PT;q=0.6,en;q=0.4,en-US;q=0.2,de;q=0.2,es;q=0.2,fr;q=0.2" } }, "user": { "id": "57592f333f8983.043587162282415065" }, "ext": { "sub": 445566 } } ``` ### Direct Links ```json { "id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa", "imp": [ { "id": "974090632", "instl": 0, "el": "dGVzdGVAZW1haWwuY29t" } ], "site": { "id": "12345", "domain": "sitedomain.com", "cat": ["IAB25-3"], "page": "https://sitedomain.com/page", "keyword": "lifestyle", "ext": { "exchangecat": 508, "idzone": 445566 } }, "device": { "ua": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.63 Safari/537.36", "ip": "192.0.2.1", "geo": { "country": "PRT" }, "language": "en", "os": "Linux & UNIX", "js": 0, "ext": { "remote_addr": "192.0.2.1", "x_forwarded_for": "192.0.2.1" } }, "user": { "id": "57592f333f8983.043587162282415065" }, "ext": { "sub": 1221 } } ``` ### Email Clicks ```json { "id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa", "imp": [ { "id": "974090632", "instl": 0, "el": "dGVzdGVAZW1haWwuY29t" } ], "site": { "id": "12345", "domain": "sitedomain.com", "cat": ["IAB25-3"], "page": "https://sitedomain.com/page", "keyword": "lifestyle", "ext": { "exchangecat": 508, "idzone": 445566 } }, "device": { "ua": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.63 Safari/537.36", "ip": "192.168.1.70", "geo": { "country": "PRT" }, "language": "en", "os": "Linux & UNIX", "js": 0, "ext": { "remote_addr": "192.0.2.1", "x_forwarded_for": "192.0.2.1" } }, "user": { "id": "57592f333f8983.043587162282415065" }, "ext": { "sub": 445566 } } ``` ### Fullpage Interstitial (Mobile and Desktop) ```json { "id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa", "at":1, "imp": [ { "id": "974090632", "instl": 1, "banner": { "w": 1600, "h": 900, "mimes": [ "image/jpg", "image/png", "video/mp4", "image/webp" ], "ext": { "image_output": "xml", "video_output": "xml" } } } ], "site": { "id": "12345", "domain": "sitedomain.com", "name": "site domain", "cat": ["IAB25-3"], "page": "https://sitedomain.com/page", "keywords": "lifestyle, humour" }, "device": { "ua": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.63 Safari/537.36", "ip": "192.0.2.1", "geo": { "country": "XXX" }, "language": "en", "os": "Linux & UNIX", "js": 0, "ext": { "remote_addr": "192.0.2.1", "x_forwarded_for": "192.0.2.1" } }, "user": { "id": "57592f333f8983.043587162282415065" }, "ext": { "sub": 1221 } } ``` ### In-Stream ```json { "id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa", "at":1, "imp": [ { "id": "974090632", "video": { "skip": 1, "skipafter": 5, "skipmin": 25, "mimes": [ "video/mp4" ], "protocols": [ 3, 6 ], "linearity": 1, "boxingallowed": 1 }, "bidfloor": 0.5, "bidfloorcur": "USD", "secure": 1 } ], "site": { "id": "12345", "domain": "sitedomain.com", "cat": ["IAB25-3"], "page": "https://sitedomain.com/page", "keyword": "lifestyle", "ext": { "exchangecat": 508, "idzone": 445566 } }, "device": { "ua": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.63 Safari/537.36", "ip": "192.0.2.1", "geo": { "country": "IRL" }, "language": "en", "os": "Linux & UNIX", "js": 0, "ext": { "remote_addr": "192.0.2.1", "x_forwarded_for": "", "accept_language": "en-GB;q=0.8,pt-PT;q=0.6,en;q=0.4,en-US;q=0.2,de;q=0.2,es;q=0.2,fr;q=0.2" } }, "user": { "id": "57592f333f8983.043587162282415065" }, "ext": { "sub": 445566 } } ``` ### Native ```json { "id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa", "at":1, "imp": [ { "id": "90180978", "native": { "request":"{\"native\":{\"ver\":\"1.2\",\"context\":1,\"plcmttype\":4,\"plcmtcnt\":3,\"assets\":[{\"id\":1,\"required\":1,\"img\":{\"type\":3,\"wmin\":100,\"hmin\":100}},{\"id\":2,\"required\":1,\"title\":{\"len\":60}},{\"id\":3,\"required\":1,\"data\":{\"type\":2,\"len\":110}}]}}", "ver": "1.2" }, "secure": 1 } ], "site": { "id": "12345", "domain": "sitedomain.com", "cat": ["IAB25-3"], "page": "https://sitedomain.com/page", "keyword": "lifestyle", "ext": { "exchangecat": 508, "idzone": 445566 } }, "device": { "ua": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.63 Safari/537.36", "ip": "192.0.2.1", "geo": { "country": "IRL" }, "language": "en", "os": "Linux & UNIX", "js": 0, "ext": { "remote_addr": "192.0.2.1", "x_forwarded_for": "", "accept_language": "en-GB;q=0.8,pt-PT;q=0.6,en;q=0.4,en-US;q=0.2,de;q=0.2,es;q=0.2,fr;q=0.2" } }, "user": { "id": "57592f333f8983.043587162282415065" }, "ext": { "sub": 445566 } } ``` ### Popunder ```json { "id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa", "at":1, "imp": [ { "id": "974090632", "instl": 1, "bidfloor": 0.5, "bidfloorcur": "USD", "secure": 1 } ], "site": { "id": "12345", "domain": "sitedomain.com", "cat": ["IAB25-3"], "page": "https://sitedomain.com/page", "keyword": "lifestyle", "ext": { "exchangecat": 508, "idzone": 445566 } }, "device": { "ua": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.63 Safari/537.36", "ip": "192.0.2.1", "geo": { "country": "IRL" }, "language": "en", "os": "Linux & UNIX", "js": 0, "ext": { "remote_addr": "192.0.2.1", "x_forwarded_for": "192.0.2.1", "accept_language": "en-GB;q=0.8,pt-PT;q=0.6,en;q=0.4,en-US;q=0.2,de;q=0.2,es;q=0.2,fr;q=0.2" } }, "user": { "id": "57592f333f8983.043587162282415065" }, "ext": { "sub": 445566 } } ``` ### Push Notifications - 720 x 480 ```json { "id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa", "at":1, "imp": [ { "id": "90180978", "native": { "request":"{\"native\":{\"ver\":\"1.2\",\"plcmttype\":500,\"plcmtcnt\":1,\"assets\":[{\"id\":1,\"required\":1,\"img\":{\"type\":1,\"w\":720,\"h\":480,\"wmin\":720,\"hmin\":480}},{\"id\":2,\"required\":1,\"title\":{\"len\":60}},{\"id\":3,\"required\":1,\"data\":{\"type\":2,\"len\":110}}]}}", "ver": "1.2" }, "secure": 1 } ], "site": { "id": "12345", "domain": "sitedomain.com", "cat": ["IAB25-3"], "page": "https://sitedomain.com/page", "keyword": "lifestyle", "ext": { "exchangecat": 508, "idzone": 445566 } }, "device": { "ua": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.63 Safari/537.36", "ip": "192.0.2.1", "geo": { "country": "IRL" }, "language": "en", "os": "Linux & UNIX", "js": 0, "ext": { "remote_addr": "192.0.2.1", "x_forwarded_for": "", "accept_language": "en-GB;q=0.8,pt-PT;q=0.6,en;q=0.4,en-US;q=0.2,de;q=0.2,es;q=0.2,fr;q=0.2" } }, "user": { "id": "57592f333f8983.043587162282415065" }, "ext": { "sub": 445566 } } ``` ### Push Notifications - 192 x 192 ```json { "id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa", "at":1, "imp": [ { "id": "90180978", "native": { "request":"{\"native\":{\"ver\":\"1.2\",\"plcmttype\":500,\"plcmtcnt\":1,\"assets\":[{\"id\":1,\"required\":1,\"img\":{\"type\":1,\"w\":192,\"h\":192,\"wmin\":192,\"hmin\":192}},{\"id\":2,\"required\":1,\"title\":{\"len\":60}},{\"id\":3,\"required\":1,\"data\":{\"type\":2,\"len\":110}}]}}", "ver": "1.2" }, "secure": 1 } ], "site": { "id": "12345", "domain": "sitedomain.com", "cat": ["IAB25-3"], "page": "https://sitedomain.com/page", "keyword": "lifestyle", "ext": { "exchangecat": 508, "idzone": 445566 } }, "device": { "ua": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.63 Safari/537.36", "ip": "192.0.2.1", "geo": { "country": "IRL" }, "language": "en", "os": "Linux & UNIX", "js": 0, "ext": { "remote_addr": "192.0.2.1", "x_forwarded_for": "", "accept_language": "en-GB;q=0.8,pt-PT;q=0.6,en;q=0.4,en-US;q=0.2,de;q=0.2,es;q=0.2,fr;q=0.2" } }, "user": { "id": "57592f333f8983.043587162282415065" }, "ext": { "sub": 445566 } } ``` ### Banner under DSA ```json { "id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa", "at":1, "imp": [ { "id": "974090632", "instl": 0, "banner": { "w": 300, "h": 250 }, "bidfloor": 0.5, "bidfloorcur": "USD", "secure": 1 } ], "site": { "id": "12345", "domain": "sitedomain.com", "cat": ["IAB25-3"], "page": "https://sitedomain.com/page", "keyword": "lifestyle", "ext": { "exchangecat": 508, "idzone": 445566 } }, "device": { "ua": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.63 Safari/537.36", "ip": "192.0.2.1", "geo": { "country": "IRL" }, "language": "en", "os": "Linux & UNIX", "js": 0, "ext": { "remote_addr": "192.0.2.1", "x_forwarded_for": "", "accept_language": "en-GB;q=0.8,pt-PT;q=0.6,en;q=0.4,en-US;q=0.2,de;q=0.2,es;q=0.2,fr;q=0.2" } }, "user": { "id": "57592f333f8983.043587162282415065" }, "ext": { "sub": 445566 }, "regs": { "ext": { "dsaapply":1, "dsa": { "required": 3, "datatopub": 2 } } } } ``` ## Open RTB Advertiser Response ### Banner / iFrame / Popunder / In-Stream / Push Notifications JSON ```json { "id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa", "seatbid": [{ "bid": [{ "id": "12ab3d", "impid": "90180978", "price": 0.55, "adm": "", "nurl": "https://mysite.com/my_notification_url", "burl": "https://mysite.com/my_billing_notification_url", "ext": { "btype": 1 }, "iurl": "https://examplesite.net/library/4168260c416e688f5c64939044e178a84c00fca2419c2.mp4", "crid": "22334455" }] }] } ``` ### Direct Links JSON ```json { "id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa", "bidid": 123, "seatbid": [{ "bid": [{ "id": "12ab3d", "adid": 1, "impid": "90180978", "price": 0.12, "adm": "", "nurl": "https://mysite.com/my_notification_url", "burl": "https://mysite.com/my_billing_notification_url", "ext":{ "btype": 2 }, "iurl": "https://examplesite.net/library/4168260c416e688f5c64939044e178a84c00fca2419c2.mp4", "crid": "22334455" }] }] } ``` ### Email Clicks JSON ```json { "id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa", "bidid": 123, "seatbid": [{ "bid": [{ "id": "12ab3d", "adid": 1, "impid": "90180978", "price": 0.12, "adm": "", "nurl": "https://mysite.com/my_notification_url", "burl": "https://mysite.com/my_billing_notification_url", "ext":{ "btype": 2 }, "iurl": "https://examplesite.net/library/4168260c416e688f5c64939044e178a84c00fca2419c2.mp4", "crid": "22334455" }] }] } ``` ### Fullpage Interstitial (Mobile and Desktop) JSON ```json { "id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa", "seatbid": [{ "bid": [{ "id": "12ab3d", "impid": "90180978", "price": 0.55, "adm": "", "nurl": "http://mysite.com/win-notification", "burl": "https://mysite.com/my_billing_notification_url", "ext": { "btype": 1 }, "iurl": "https://examplesite.net/library/4168260c416e688f5c64939044e178a84c00fca2419c2.mp4", "crid": "22334455" }] }] } ``` ### Native JSON ```json { "id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa", "seatbid": [ { "bid": [ { "id": "12ab3d", "impid": "90180978", "price": 0.71, "nurl": "https://mysite.com/my_notification_url", "burl": "https://mysite.com/my_billing_notification_url", "adm": "", "ext": { "btype": 1 }, "iurl": "https://examplesite.net/library/4168260c416e688f5c64939044e178a84c00fca2419c2.mp4", "crid": "22334455" } ] }, { "bid": [ { "id": "12ab3e", "impid": "1915966848", "price": 0.62, "nurl": "https://mysite.com/my_notification_url_2", "burl": "https://mysite.com/my_billing_notification_url", "adm": "", "ext": { "btype": 1 }, "iurl": "https://examplesite.net/library/4168260c416e688f5c64939044e178a84c00fca2419c2.mp4", "crid": "22334455" } ] } ] } ``` ### Banner under DSA ```json { "id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa", "seatbid": [{ "bid": [{ "id": "12ab3d", "impid": "90180978", "price": 0.55, "adm": "", "nurl": "https://mysite.com/my_notification_url", "burl": "https://mysite.com/my_billing_notification_url", "ext": { "btype": 1, "dsa": { "behalf": "Advertiser", "paid": "Advertiser", "transparency": [ { "domain": "dsp1domain.com", "params": [1, 2] } ], "adrender": 0 } }, "iurl": "https://examplesite.net/library/4168260c416e688f5c64939044e178a84c00fca2419c2.mp4", "crid": "22334455" }] }] } ``` ## ADM structure examples ### Banner: Image Banner ```xml ``` ### Banner: Video Banner ```xml ``` ### Banner: Iframe ```xml ``` ### Direct Links ```xml ``` ### Email Clicks ```xml ``` ### Fullpage Interstitial Banner ```xml ``` ### Fullpage Interstitial Iframe ```xml ``` ### Popunder ```xml ``` ### In-Stream Ads * Remote VAST ``` {\"instream\":{\"remoteUrl\":\"https:\/\/mysite.com\/vasturl\"}} ``` Based on the following JSON object: ```json { "instream": { "remoteUrl": "https://mysite.com/vasturl" } } ``` * Local VAST ``` {\"instream\":{\"videoUrl\":\"https:\/\/mysite.com\/video.mp4\",\"clickUrl\":\"https:\/\/mysite.com\/clickurl\",\"trackingEvents\":[{\"type\":\"impression\",\"url\":\"https:\/\/mysite.com\/impression\"},{\"type\":\"complete\",\"url\":\"https:\/\/mysite.com\/complete\"},{\"type\":\"progress\",\"offset\":\"00:00:10.000\",\"url\":\"https:\/\/mysite.com\/progress10secs\"}],\"cta\":{\"displayUrl\":\"somedomain.com\",\"text\":\"Click Here\"}}}}} ``` Based on the following JSON object: ```json { "instream": { "videoUrl": "https://mysite.com/video.mp4", "clickUrl": "https://mysite.com/clickurl", "trackingEvents": [ { "type": "impression", "url": "https://mysite.com/impression" }, { "type": "complete", "url": "https://mysite.com/complete" }, { "type": "progress", "offset": "00:00:10.000", "url": "https://mysite.com/progress10secs" } ], "cta": { "displayUrl": "somedomain.com", "text": "Click Here" } } } ``` ### Native Ads ``` {\"native\":{\"link\":{\"url\":\"http:\/\/mysite.com\/landingpages\/mypage\"},\"assets\":[{\"id\":1,\"required\":1,\"img\":{\"url\":\"http:\/\/mysite.com\/images\/myad.jpg\",\"w\":300,\"h\":300,\"ext\":{\"crop_anchor_point\":1}}},{\"id\":2,\"title\":{\"text\":\"Ad Title\"}},{\"id\":3,\"data\":{\"type\":2,\"value\":\"Ad description\"}},{\"id\":4,\"data\":{\"type\":1,\"value\":\"Ad brand\"}}],\"imptrackers\":[\"https://mytracker1.com\"],\"eventtrackers\":[{\"event\":1,\"method\":1,\"url\":\"https://myEventTracker1.com\"}]}} ``` Which is based on the following JSON object: ```json { "native": { "link": { "url": "http://mysite.com/landingpages/mypage" }, "assets": [ { "id": 1, "required": 1, "img": { "url": "http://mysite.com/images/myad.jpg", "w": 300, "h": 300, "ext": { "crop_anchor_point": 1 } } }, { "id": 2, "title": { "text": "Ad Title" } }, { "id": 3, "data": { "type": 2, "value": "Ad description" } }, { "id": 4, "data": { "type": 1, "value": "Ad brand" } } ], "imptrackers": [ "https://mytracker1.com" ], "eventtrackers": [ { "event": 1, "method": 1, "url": "https://myEventTracker1.com" } ] } } ``` ### Push Notification ``` {\"native\":{\"link\":{\"url\":\"http:\/\/mysite.com\/landingpages\/mypage\"},\"assets\":[{\"id\":1,\"required\":1,\"img\":{\"url\":\"http:\/\/mysite.com\/images\/myad.jpg\",\"w\":720,\"h\":480}},{\"id\":2,\"title\":{\"text\":\"Ad Title\"}},{\"id\":3,\"data\":{\"type\":2,\"value\":\"Ad description\"}}],\"imptrackers\":[\"https://mytracker1.com\"]}} ``` Which is based on the following JSON object: ```json { "native": { "link": { "url": "http://mysite.com/landingpages/mypage" }, "assets": [ { "id": 1, "required": 1, "img": { "url": "http://mysite.com/images/myad.jpg", "w": 720, "h": 480 } }, { "id": 2, "title": { "text": "Ad Title" } }, { "id": 3, "data": { "type": 2, "value": "Ad description" } } ], "imptrackers": [ "https://mytracker1.com" ] } } ``` --- # 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://docs.exoclick.com/rtb/advertisers/open-rtb/open-rtb-advertiser-code-examples.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.