├── README.md ├── brandscreen ├── example-response-mobile.json ├── example-response-pc-win-notifadm.json ├── example-request-pc-single.json ├── example-request-pc-multi.json ├── example-response-pc-multi.json └── example-request-mobile.json ├── rubiconproject ├── example-request-web-safari.json ├── example-request-web-ie8.json ├── example-request-web-iphone.json ├── example-request-app-android-1.json └── example-request-app-android-2.json └── spotxchange ├── example-video-response-single_vast_inline_simple.md ├── example-video-request-single_impr.md ├── example-video-response-multiple_vast_inline_simple.md └── example-video-request-multiple_impr.md /README.md: -------------------------------------------------------------------------------- 1 | # OpenRTB examples 2 | 3 | Some OpenRTB example requests + responses, with notes. 4 | 5 | * [Brandscreen](https://github.com/openrtb/examples/blob/master/brandscreen/example-request-mobile.json) 6 | * [Rubicon Project](https://github.com/openrtb/examples/blob/master/rubiconproject/example-request-app-android-1.json) 7 | * [Spotxchange](https://github.com/openrtb/examples/blob/master/spotxchange/example-video-request-multiple_impr.md) 8 | -------------------------------------------------------------------------------- /brandscreen/example-response-mobile.json: -------------------------------------------------------------------------------- 1 | { 2 | "id": "IxexyLDIIk", 3 | "seatbid": [ 4 | { 5 | "bid": [ 6 | { 7 | "id": "1", 8 | "impid": "1", 9 | "price": 0.751371, 10 | "adid": "52a5516d29e435137c6f6e74", 11 | "nurl": "http://ads.com/win/112770_1386565997?won=${AUCTION_PRICE}", 12 | "adm": "\"Advertisement\"", 13 | "adomain": [ 14 | "ads.com" 15 | ], 16 | "iurl": "http://ads.com/112770_1386565997.jpeg", 17 | "cid": "52a5516d29e435137c6f6e74", 18 | "crid": "52a5516d29e435137c6f6e74_1386565997", 19 | "attr": [] 20 | } 21 | ], 22 | "seat": "2" 23 | } 24 | ], 25 | "cur": "USD" 26 | } 27 | -------------------------------------------------------------------------------- /brandscreen/example-response-pc-win-notifadm.json: -------------------------------------------------------------------------------- 1 | { 2 | "id": "BID-4-ZIMP-4b309eae-504a-4252-a8a8-4c8ceee9791a", 3 | "seatbid": [ 4 | { 5 | "bid": [ 6 | { 7 | "id": "32a69c6ba388f110487f9d1e63f77b22d86e916b", 8 | "impid": "32a69c6ba388f110487f9d1e63f77b22d86e916b", 9 | "price": 0.065445, 10 | "adid": "529833ce55314b19e8796116", 11 | "nurl": "http://ads.com/win/529833ce55314b19e8796116?won=${AUCTION_PRICE}", 12 | "adm": "", 13 | "adomain": [ 14 | "ads.com" 15 | ], 16 | "cid": "529833ce55314b19e8796116", 17 | "crid": "529833ce55314b19e8796116_1385706446", 18 | "attr": [] 19 | } 20 | ], 21 | "seat": "772" 22 | } 23 | ], 24 | "cur": "USD" 25 | } 26 | -------------------------------------------------------------------------------- /rubiconproject/example-request-web-safari.json: -------------------------------------------------------------------------------- 1 | { 2 | "id": "5d394bed0104ca857c702982fe8d95e408820ea2", 3 | "at": 2, 4 | "tmax": 152, 5 | "imp": [{ 6 | "id": "1", 7 | "tagid": "61653", 8 | "banner": { 9 | "w": 728, 10 | "h": 90, 11 | "battr": [3, 9, 1, 14018, 14014, 14, 13, 10, 14015, 8, 14019, 2, 5], 12 | "api": [] 13 | }, 14 | "iframebuster": [] 15 | }], 16 | "site": { 17 | "id": "17945", 18 | "domain": "http://addictinggames.com", 19 | "name": "Addicting Games", 20 | "cat": ["IAB9"], 21 | "page": "http://www.addictinggames.com/", 22 | "publisher": { 23 | "id": "9705" 24 | } 25 | }, 26 | "device": { 27 | "ua": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_6_8) AppleWebKit/534.59.10 (KHTML, like Gecko) Version/5.1.9 Safari/534.59.10", 28 | "ip": "192.168.1.1", 29 | "language": "en", 30 | "devicetype": 2, 31 | "js": 1, 32 | "geo": { 33 | "country": "USA", 34 | "region": "NY" 35 | } 36 | }, 37 | "user": { 38 | "id": "3f234f9a06ab82120afdbf1e12df919b2e388cab", 39 | "ext": { 40 | "sessiondepth": 1 41 | } 42 | } 43 | } 44 | -------------------------------------------------------------------------------- /brandscreen/example-request-pc-single.json: -------------------------------------------------------------------------------- 1 | { 2 | "id": "80ce30c53c16e6ede735f123ef6e32361bfc7b22", 3 | "imp": [ 4 | { 5 | "id": "1", 6 | "banner": { 7 | "h": 250, 8 | "w": 300, 9 | "pos": 0 10 | }, 11 | "bidfloor": 0.03 12 | } 13 | ], 14 | "site": { 15 | "id": "102855", 16 | "domain": "http://www.usabarfinder.com", 17 | "cat": "IAB3-1", 18 | "page": "http://eas.usabarfinder.com/eas?cu=13824;cre=mu;target=_blank", 19 | "publisher": { 20 | "id": "8953", 21 | "name": "local.com", 22 | "cat": "IAB3-1", 23 | "domain": "local.com" 24 | } 25 | }, 26 | "device": { 27 | "ua": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_6_8) AppleWebKit/537.13 (KHTML, like Gecko) Version/5.1.7 Safari/534.57.2", 28 | "ip": "123.145.167.*" 29 | }, 30 | "user": { 31 | "id": "55816b39711f9b5acf3b90e313ed29e51665623f" 32 | }, 33 | "at": 1, 34 | "cur": [ 35 | "USD" 36 | ], 37 | "regs": { 38 | "coppa": 1 39 | }, 40 | "pmp": { 41 | "private_auction": 1, 42 | "deals": [ 43 | { 44 | "id": "DX-1985-010A", 45 | "bidfloor": 2.5, 46 | "at": 2 47 | } 48 | ] 49 | } 50 | } 51 | -------------------------------------------------------------------------------- /brandscreen/example-request-pc-multi.json: -------------------------------------------------------------------------------- 1 | { 2 | "id": "8652a8680db33faabbf3fa76150f35df50a67060", 3 | "imp": [ 4 | { 5 | "id": "121-dt1", 6 | "banner": { 7 | "h": 250, 8 | "w": 300, 9 | "pos": 1 10 | }, 11 | "bidfloor": 0.05 12 | }, 13 | { 14 | "id": "121-dt2", 15 | "banner": { 16 | "h": 728, 17 | "w": 90, 18 | "pos": 0 19 | }, 20 | "bidfloor": 0.12 21 | } 22 | ], 23 | "site": { 24 | "id": "15047", 25 | "domain": "dailymotion.com", 26 | "cat": "IAB1", 27 | "page": "http://www.dailymotion.com/video/xxeauj_www-dramacafe-tv-hd-yyyy-yy-yyyyyyy-2012-yyyy_shortfilms", 28 | "publisher": { 29 | "id": "8796", 30 | "name": "dailymotion", 31 | "cat": "IAB3-1", 32 | "domain": "dailymotion.com" 33 | } 34 | }, 35 | "user": { 36 | "id": "518c3da3717203f34019b038", 37 | }, 38 | "device": { 39 | "ua": "Mozilla/4.0 (compatible; MSIE 8.0; Windows NT 6.1; Trident/4.0; GTB7.4; (R1 1.6); SLCC2; .NET CLR 2.0.50727; .NET CLR 3.5.30729; .NET CLR 3.0.30729; Media Center PC 6.0)", 40 | "ip": "123.145.167.189" 41 | }, 42 | "at": 1, 43 | "cur": [ 44 | "USD" 45 | ] 46 | } 47 | -------------------------------------------------------------------------------- /rubiconproject/example-request-web-ie8.json: -------------------------------------------------------------------------------- 1 | { 2 | "id": "df472a5ca259ef79fec1567f17160ff545a80fbe", 3 | "at": 2, 4 | "tmax": 129, 5 | "imp": [{ 6 | "id": "1", 7 | "tagid": "70821", 8 | "banner": { 9 | "w": 728, 10 | "h": 90, 11 | "battr": [9, 1, 2, 14018, 14014, 3, 5, 14, 13, 14005, 10, 14015, 8, 14019], 12 | "api": [] 13 | }, 14 | "iframebuster": [] 15 | }], 16 | "site": { 17 | "id": "15756", 18 | "domain": "http://zoopla.co.uk", 19 | "name": "Zoopla", 20 | "cat": ["IAB21"], 21 | "page": "http://www.zoopla.co.uk/for-sale/details/31611794?search_identifier=e12d33a11efeb568768a845e59d51dfc", 22 | "publisher": { 23 | "id": "9208" 24 | } 25 | }, 26 | "device": { 27 | "ua": "Mozilla/4.0 (compatible; MSIE 8.0; Windows NT 5.1; Trident/4.0; .NET CLR 1.1.4322; .NET CLR 2.0.50727; .NET CLR 3.0.4506.2152; .NET CLR 3.5.30729; InfoPath.3; .NET4.0C; .NET4.0E; MS-RTC LM 8)", 28 | "ip": "192.168.1.1", 29 | "language": "en", 30 | "devicetype": 2, 31 | "js": 1, 32 | "geo": { 33 | "country": "GBR", 34 | "region": "HNS" 35 | } 36 | }, 37 | "user": { 38 | "id": "64c017a3d756e2566596cc1499294d1b602c88a3", 39 | "buyeruid": "7be2ed3d-a245-4045-af05-f15c9771a73e", 40 | "ext": { 41 | "sessiondepth": 5 42 | } 43 | } 44 | } 45 | -------------------------------------------------------------------------------- /rubiconproject/example-request-web-iphone.json: -------------------------------------------------------------------------------- 1 | { 2 | "id": "6f622d2df52952faba8784932d180d93ec25604d", 3 | "at": 2, 4 | "tmax": 151, 5 | "imp": [{ 6 | "id": "1", 7 | "tagid": "85869", 8 | "iframebuster": ["ALL"], 9 | "banner": { 10 | "w": 728, 11 | "h": 90, 12 | "pos": 1, 13 | "battr": [9, 1, 14018, 14014, 3, 14005, 10, 8, 14, 14019, 14015, 5], 14 | "api": [], 15 | "topframe": 1 16 | } 17 | }], 18 | "site": { 19 | "id": "15427", 20 | "domain": "http://www.oprah.com", 21 | "name": "Oprah Winfrey Network (OWN)", 22 | "cat": ["IAB7", "IAB9", "IAB1"], 23 | "page": "http://www.oprah.com/own-where-are-they-now/Barry-Williams-on-Brady-Bunch-Backstage-Romances-Video", 24 | "publisher": { 25 | "id": "9115" 26 | } 27 | }, 28 | "device": { 29 | "make": "Apple", 30 | "model": "iPhone", 31 | "os": "iOS", 32 | "osv": "7.0", 33 | "ua": "Mozilla/5.0 (iPhone; CPU iPhone OS 7_0 like Mac OS X) AppleWebKit/536.26 (KHTML, like Gecko) GSA/3.2.0.25255 Mobile/11A465 Safari/8536.25", 34 | "ip": "192.168.1.1", 35 | "language": "en", 36 | "devicetype": 2, 37 | "js": 1, 38 | "geo": { 39 | "country": "USA", 40 | "region": "NY" 41 | } 42 | }, 43 | "user": { 44 | "id": "6ea4bd0143830a4f2b3c415627fa349043a6321d", 45 | "ext": { 46 | "sessiondepth": 1 47 | } 48 | } 49 | } 50 | -------------------------------------------------------------------------------- /rubiconproject/example-request-app-android-1.json: -------------------------------------------------------------------------------- 1 | { 2 | "id": "7979d0c78074638bbdf739ffdf285c7e1c74a691", 3 | "at": 2, 4 | "tmax": 143, 5 | "imp": [{ 6 | "id": "1", 7 | "tagid": "76334", 8 | "iframebuster": ["ALL"], 9 | "banner": { 10 | "w": 300, 11 | "h": 250, 12 | "pos": 1, 13 | "battr": [9, 1, 14014, 3, 13, 10, 8, 14], 14 | "api": [3, 1000], 15 | "topframe": 1 16 | } 17 | }], 18 | "app": { 19 | "id": "20625", 20 | "cat": ["IAB1"], 21 | "name": "com.cheezburger.icanhas", 22 | "domain": "http://cheezburger.com", 23 | "privacypolicy": 1, 24 | "publisher": { 25 | "id": "8428" 26 | }, 27 | "ext": { 28 | "storerating": 1, 29 | "appstoreid": "457637357" 30 | } 31 | }, 32 | "device": { 33 | "make": "Samsung", 34 | "model": "SCH-I535", 35 | "os": "Android", 36 | "osv": "4.3", 37 | "ua": "Mozilla/5.0 (Linux; U; Android 4.3; en-us; SCH-I535 Build/JSS15J) AppleWebKit/534.30 (KHTML, like Gecko) Version/4.0 Mobile Safari/534.30", 38 | "ip": "192.168.1.1", 39 | "language": "en", 40 | "devicetype": 1, 41 | "js": 1, 42 | "connectiontype": 3, 43 | "dpidsha1": "F099E6D1C485756C45D1EEACB33C73B55C4BC499", 44 | "carrier": "Verizon Wireless", 45 | "geo": { 46 | "country": "USA", 47 | "region": "PA", 48 | "type": 3, 49 | "ext": { 50 | "latlonconsent": 1 51 | } 52 | } 53 | }, 54 | "user": { 55 | "id": "bd5adc55dcbab4bf090604df4f543d90b09f0c88", 56 | "ext": { 57 | "sessiondepth": 207 58 | } 59 | } 60 | } 61 | -------------------------------------------------------------------------------- /rubiconproject/example-request-app-android-2.json: -------------------------------------------------------------------------------- 1 | { 2 | "id": "b615143e4bf949bcfeef1e009ffba5e93ac9376e", 3 | "at": 2, 4 | "tmax": 144, 5 | "imp": [{ 6 | "id": "1", 7 | "tagid": "112728", 8 | "iframebuster": ["ALL"], 9 | "banner": { 10 | "w": 320, 11 | "h": 50, 12 | "pos": 1, 13 | "battr": [9, 1, 14018, 14014, 3, 13, 10, 8, 14, 14019, 2], 14 | "api": [3, 1000], 15 | "topframe": 1 16 | } 17 | }], 18 | "app": { 19 | "id": "27994", 20 | "cat": ["IAB1"], 21 | "name": "theCHIVE", 22 | "domain": "http://thechive.com", 23 | "privacypolicy": 1, 24 | "publisher": { 25 | "id": "8739" 26 | }, 27 | "ext": { 28 | "storerating": 1, 29 | "appstoreid": "com.thechive" 30 | } 31 | }, 32 | "device": { 33 | "make": "Samsung", 34 | "model": "SGH-I747M", 35 | "os": "Android", 36 | "osv": "4.3", 37 | "ua": "Mozilla/5.0 (Linux; U; Android 4.3; en-ca; SGH-I747M Build/JSS15J) AppleWebKit/534.30 (KHTML, like Gecko) Version/4.0 Mobile Safari/534.30", 38 | "ip": "192.168.1.1", 39 | "language": "en", 40 | "devicetype": 1, 41 | "js": 1, 42 | "connectiontype": 3, 43 | "carrier": "Other", 44 | "geo": { 45 | "country": "CAN", 46 | "region": "ON", 47 | "lat": 13.519004709972312, 48 | "lon": -44,23060478189526, 49 | "type": 2, 50 | "ext": { 51 | "latlonconsent": 1 52 | } 53 | } 54 | }, 55 | "user": { 56 | "id": "e39b9569730f62c4a53c977fd590f6940fe9256d", 57 | "ext": { 58 | "sessiondepth": 41 59 | } 60 | } 61 | } 62 | -------------------------------------------------------------------------------- /brandscreen/example-response-pc-multi.json: -------------------------------------------------------------------------------- 1 | { 2 | "id": "BID-4-ZIMP-4b309eae-504a-4252-a8a8-4c8ceee9791a", 3 | "seatbid": [ 4 | { 5 | "bid": [ 6 | { 7 | "id": "24195efda36066ee21f967bc1de14c82db841f07", 8 | "impid": "24195efda36066ee21f967bc1de14c82db841f07", 9 | "price": 1.028428, 10 | "adid": "52a12b5955314b7194a4c9ff", 11 | "nurl": "http://ads.com/win/52a12b5955314b7194a4c9ff?won=${AUCTION_PRICE}", 12 | "adm": "", 13 | "adomain": [ 14 | "ads.com" 15 | ], 16 | "cid": "52a12b5955314b7194a4c9ff", 17 | "crid": "52a12b5955314b7194a4c9ff_1386294105", 18 | "attr": [], 19 | "dealid": "DX-1985-010A" 20 | } 21 | ], 22 | "seat": "42" 23 | }, 24 | { 25 | "bid": [ 26 | { 27 | "id": "24195efda36066ee21f967bc1de14c82db841f08", 28 | "impid": "24195efda36066ee21f967bc1de14c82db841f08", 29 | "price": 0.04958, 30 | "adid": "527c9fdd55314ba06815f25e", 31 | "nurl": "http://ads.com/win/527c9fdd55314ba06815f25e?won=${AUCTION_PRICE}", 32 | "adm": "", 33 | "adomain": [ 34 | "ads.com" 35 | ], 36 | "cid": "527c9fdd55314ba06815f25e", 37 | "crid": "527c9fdd55314ba06815f25e_1383899102", 38 | "attr": [] 39 | } 40 | ], 41 | "seat": "772" 42 | } 43 | ], 44 | "cur": "USD" 45 | } 46 | -------------------------------------------------------------------------------- /brandscreen/example-request-mobile.json: -------------------------------------------------------------------------------- 1 | { 2 | "id": "IxexyLDIIk", 3 | "imp": [ 4 | { 5 | "id": "1", 6 | "banner": { 7 | "w": 728, 8 | "h": 90, 9 | "pos": 1, 10 | "btype": [ 11 | 4 12 | ], 13 | "battr": [ 14 | 14 15 | ], 16 | "api": [ 17 | 3 18 | ] 19 | }, 20 | "instl": 0, 21 | "tagid": "agltb3B1Yi1pbmNyDQsSBFNpdGUY7fD0FAw", 22 | "bidfloor": 0.5 23 | } 24 | ], 25 | "app": { 26 | "id": "agltb3B1Yi1pbmNyDAsSA0FwcBiJkfIUDA", 27 | "name": "Yahoo Weather", 28 | "cat": [ 29 | "weather", 30 | "IAB15", 31 | "IAB15-10" 32 | ], 33 | "ver": "1.0.2", 34 | "bundle": "628677149", 35 | "publisher": { 36 | "id": "agltb3B1Yi1pbmNyDAsSA0FwcBiJkfTUCV", 37 | "name": "yahoo", 38 | "domain": "www.yahoo.com" 39 | }, 40 | "storeurl": "https://itunes.apple.com/id628677149" 41 | }, 42 | "device": { 43 | "dnt": 0, 44 | "ua": "Mozilla/5.0 (iPhone; CPU iPhone OS 6_1 like Mac OS X) AppleWebKit/534.46 (KHTML, like Gecko) Version/5.1 Mobile/9A334 Safari/7534.48.3", 45 | "ip": "123.145.167.189", 46 | "geo": { 47 | "country": "USA", 48 | "lat": 35.012345, 49 | "lon": -115.12345, 50 | "city": "Los Angeles", 51 | "metro": "803", 52 | "region": "CA", 53 | "zip": "90049" 54 | }, 55 | "dpidsha1": "AA000DFE74168477C70D291f574D344790E0BB11", 56 | "dpidmd5": "AA003EABFB29E6F759F3BDAB34E50BB11", 57 | "carrier": "310-410", 58 | "language": "en", 59 | "make": "Apple", 60 | "model": "iPhone", 61 | "os": "iOS", 62 | "osv": "6.1", 63 | "js": 1, 64 | "connectiontype": 3, 65 | "devicetype": 1 66 | }, 67 | "user": { 68 | "id": "ffffffd5135596709273b3a1a07e466ea2bf4fff", 69 | "yob": "1984", 70 | "gender": "M" 71 | }, 72 | "at": 2, 73 | "bcat": [ 74 | "IAB25", 75 | "IAB7-39", 76 | "IAB8-18", 77 | "IAB8-5", 78 | "IAB9-9" 79 | ], 80 | "badv": [ 81 | "apple.com", 82 | "go-text.me", 83 | "heywire.com" 84 | ] 85 | } 86 | -------------------------------------------------------------------------------- /spotxchange/example-video-response-single_vast_inline_simple.md: -------------------------------------------------------------------------------- 1 | # Video Bid Response With Inline VAST, Non-VPAID 2 | 3 | Following is an example of a bid response that returns the VAST 4 | document inline to be served. A few notes about specific fields 5 | in the example: 6 | 7 | - The bid for this impression is a $3.00 CPM. 8 | - Note that since there both a win notice URL and an inline VAST document, the adm attribute is used for the VAST ad markeup. 9 | 10 | ```json 11 | { 12 | "id": "123", 13 | "seatbid": [ 14 | { 15 | "bid": [ 16 | { 17 | "id": 12345, 18 | "impid": 2, 19 | "price": 300, 20 | "nurl": "http://example.com/winnoticeurl", 21 | "adm": "%3C%3Fxml%20version%3D%221.0%22%20encoding%3D%22utf-8%22%3F%3E%0A%3CVAST%20version%3D%222.0%22%3E%0A%20%20%20%20%3CAd%20id%3D%2212345%22%3E%0A%20%20%20%20%20%20%20%20%3CInLine%3E%0A%20%20%20%20%20%20%20%20%20%20%20%20%3CAdSystem%20version%3D%221.0%22%3ESpotXchange%3C%2FAdSystem%3E%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%3CAdTitle%3E%3C!%5BCDATA%5BSample%20VAST%5D%5D%3E%3C%2FAdTitle%3E%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%3CImpression%3Ehttp%3A%2F%2Fsample.com%3C%2FImpression%3E%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%3CDescription%3E%3C!%5BCDATA%5BA%20sample%20VAST%20feed%5D%5D%3E%3C%2FDescription%3E%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%3CCreatives%3E%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%3CCreative%20sequence%3D%221%22%20id%3D%221%22%3E%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%3CLinear%3E%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%3CDuration%3E00%3A00%3A30%3C%2FDuration%3E%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%3CTrackingEvents%3E%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%3C%2FTrackingEvents%3E%20%20%20%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%3CVideoClicks%3E%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%3CClickThrough%3E%3C!%5BCDATA%5Bhttp%3A%2F%2Fsample.com%2Fopenrtbtest%5D%5D%3E%3C%2FClickThrough%3E%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%3C%2FVideoClicks%3E%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%3CMediaFiles%3E%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%3CMediaFile%20delivery%3D%22progressive%22%20bitrate%3D%22256%22%20width%3D%22640%22%20height%3D%22480%22%20type%3D%22video%2Fmp4%22%3E%3C!%5BCDATA%5Bhttp%3A%2F%2Fsample.com%2Fvideo.mp4%5D%5D%3E%3C%2FMediaFile%3E%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%3C%2FMediaFiles%3E%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%3C%2FLinear%3E%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%3C%2FCreative%3E%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%3C%2FCreatives%3E%0A%20%20%20%20%20%20%20%20%3C%2FInLine%3E%0A%20%20%20%20%3C%2FAd%3E%0A%3C%2FVAST%3E", 22 | "ext": null 23 | } 24 | ] 25 | } 26 | ] 27 | } 28 | ``` 29 | -------------------------------------------------------------------------------- /spotxchange/example-video-request-single_impr.md: -------------------------------------------------------------------------------- 1 | # Video Request for a Single Impression with a Private Deal 2 | 3 | The following example illustrates a bid request for a video impression 4 | with two companion ad slots (1 expandable). Additionally, the video 5 | content itself is described in the "content" object. 6 | 7 | *A few notes about specific fields in the example:* 8 | 9 | - `protocol`: Only VAST 2.0 and 3.0 are allowed. Note that a wrapper response is not allowed in this example. 10 | - `sequence`: it is not explicitly included so the default of '1' should be assumed. 11 | - `battr`: User interactive and alert type ads (value '13' and '14', respectively) are explicitly being blocked for both the video and its companions. 12 | - `pos`: Indicates this opportunity is "above the fold". 13 | - `api`: Indicates that VPAID 1.0 containers are explicitly supported. As such, the mime types supported for VPAID are only `application/x-shockwave-flash` and `application/javascript`. Note that there is an implicit resitrction as to which protocol is allowed in which mimetype. JavaScript support was not specificed until VPAID 2.0, while Flash supports both VPAID 1.0 and 2.0. 14 | - `companiontype`: Indicates only static or HTML resources are allowed. 15 | - `pmp`: This is a private auction and restricted to only the deals enumerated. 16 | - `ext`: an exchange-specific deals extension is passed to inform the bidder of the priority assigned deals. 17 | 18 | ```json 19 | { 20 | "id": "1234567893", 21 | "at": 2, 22 | "tmax": 120, 23 | "imp": [ 24 | { 25 | "id": "1", 26 | "bidfloor": 0.03, 27 | "pmp": { 28 | "private_auction":1, 29 | "deals": [ 30 | { 31 | "id":"1452f.eadb4.7aaa", 32 | "bidfloor":2.5, 33 | "at":1, 34 | "wseats":[], 35 | "ext": { 36 | "priority":1, 37 | "wadvs":[] 38 | } 39 | } 40 | ] 41 | }, 42 | 43 | "video": { 44 | "mimes": [ 45 | "video/x-flv", 46 | "video/mp4", 47 | "application/x-shockwave-flash", 48 | "application/javascript" 49 | ], 50 | 51 | "battr": [13,14], 52 | "boxingallowed": true, 53 | "delivery": [2], 54 | "h": 480, 55 | "linearity": 1, 56 | "maxbitrate": 1500, 57 | "maxduration": 30, 58 | "maxextended": 30, 59 | "minbitrate": 300, 60 | "minduration": 5, 61 | "playbackmethod": [1,3], 62 | "pos": 1, 63 | "protocol": [2,3], 64 | "startdelay": 0, 65 | "w": 640, 66 | 67 | "companionad": [ 68 | { 69 | "id": "1234567893-1", 70 | "w": 300, 71 | "h": 250, 72 | "pos": 1, 73 | "battr": [13,14], 74 | "expandable": [2,4] 75 | }, 76 | { 77 | "id": "1234567893-2", 78 | "w": 728, 79 | "h": 90, 80 | "pos": 1, 81 | "battr": [13,14] 82 | } 83 | ], 84 | "companiontype": [1,2], 85 | "api": [1,2] 86 | } 87 | } 88 | ], 89 | "site": { 90 | "id": "1345135123", 91 | "name": "Site ABCD", 92 | "domain": "siteabcd.com", 93 | "cat": [ 94 | "IAB2-1", 95 | "IAB2-2" 96 | ], 97 | "page": "http://siteabcd.com/page.htm", 98 | "ref": "http://referringsite.com/referringpage.htm", 99 | "privacypolicy": true, 100 | "publisher": { 101 | "id": "pub12345", 102 | "name": "Publisher A" 103 | }, 104 | "content": { 105 | 106 | "cat": ["IAB2-2"], 107 | "episode": 23, 108 | "id": "1234567", 109 | "keyword": ["keyword a", "keyword b", "keyword c"], 110 | "season": 2, 111 | "series": "All About Cars", 112 | "title": "Car Show" 113 | 114 | } 115 | }, 116 | "device": { 117 | "ip": "64.124.253.1", 118 | "ua": "Mozilla/5.0 (Mac; U; Intel Mac OS X 10.6; en-US; rv:1.9.2.16) Gecko/20140420 Firefox/3.6.16", 119 | "os": "OS X", 120 | "flashversion": "10.1", 121 | "js": 1 122 | }, 123 | "user": { 124 | "uid": "456789876567897654678987656789", 125 | "buyeruid": "545678765467876567898765678987654", 126 | "data": [ 127 | { 128 | "id": "6", 129 | "name": "Data Provider 1", 130 | "segment": [ 131 | { 132 | "id": "12341318394918", 133 | "name": "auto intenders" 134 | }, 135 | { 136 | "id": "1234131839491234", 137 | "name": "auto enthusiasts" 138 | } 139 | ] 140 | } 141 | ] 142 | } 143 | } 144 | ``` 145 | -------------------------------------------------------------------------------- /spotxchange/example-video-response-multiple_vast_inline_simple.md: -------------------------------------------------------------------------------- 1 | # Video Bid Response With Inline VAST, Non-VPAID 2 | 3 | Following is an example of a bid response that returns multiple 4 | Seat Bid objects in response to a Bid Request containing multiple 5 | impressions. A few notes about the example: 6 | 7 | ### Seat 164 8 | This bidder is presenting a group to be taken as a whole or not at 9 | all. Impression IDs 1 and 2 are associated with a deal, while 3 10 | is not. Also, all Bid objects will return VAST ad markup via their 11 | win notice URL. 12 | 13 | ### Seat 45 14 | This bidder is bidding on only Impression ID 2 and has associated 15 | it with a deal. They provide both a win notice URL and the VAST 16 | ad markup inline. 17 | 18 | ### Seat 33 19 | They are providing bids for 3 Impressions and will accept any or 20 | all be selected. Also, all Bid objects will return VAST ad markup 21 | via their win notice URL. 22 | 23 | With these three seats bidding across all impressions, the exchange 24 | could choose to: 25 | 26 | - Take **all** of Seat 165's bids, 27 | - Take **all** of Seat 33's bids, or 28 | - **Mix** Seat 145's Impression ID 2 bid with Seat 33's Impression ID 29 | 1 and 3 bids, since Seat 145 indicated they would be willing to pay 30 | more for Impression ID 2 than Seat 145 did. 31 | 32 | It should be noted that for all VAST documents returned via win 33 | notices that the exchange will be making extra HTTP round trips 34 | during playback. Given that VAST documents can be substantial and 35 | video assets as well, each exchange should be sure to take this 36 | into account for user experience timing. 37 | 38 | ```json 39 | { 40 | "id": "123", 41 | "seatbid": [ 42 | { 43 | "seat": "165", 44 | "group": 1, 45 | "bid": [ 46 | { 47 | "id": "12345-1", 48 | "impid": "1", 49 | "price": 600, 50 | "dealid": "1452f.eadb4.7aaa", 51 | "nurl": "http://example165.com/win/12345-1?won=${AUCTION_PRICE}" 52 | }, 53 | { 54 | "id": "12345-2", 55 | "impid": "2", 56 | "price": 300, 57 | "dealid": "1452f.eadb4.f9bc", 58 | "nurl": "http://example165.com/win/12345-2?won=${AUCTION_PRICE}" 59 | }, 60 | { 61 | "id": "12345-3", 62 | "impid": "3", 63 | "price": 300, 64 | "nurl": "http://example165.com/win/12345-3?won=${AUCTION_PRICE}" 65 | } 66 | ] 67 | }, 68 | 69 | { 70 | "seat": "45", 71 | "bid": [ 72 | { 73 | "id": "0123456789ABCDEF0123456789ABCDEF", 74 | "impid": "2", 75 | "price": 300, 76 | "dealid": "1452f.eadb4.7aaa", 77 | "nurl": "http://example45.com/win/0123456789ABCDEF0123456789ABCDEF?won=${AUCTION_PRICE}", 78 | 79 | "adm": "%3C%3Fxml%20version%3D%221.0%22%20encoding%3D%22utf-8%22%3F%3E%0A%3CVAST%20version%3D%222.0%22%3E%0A%20%20%20%20%3CAd%20id%3D%2212345%22%3E%0A%20%20%20%20%20%20%20%20%3CInLine%3E%0A%20%20%20%20%20%20%20%20%20%20%20%20%3CAdSystem%20version%3D%221.0%22%3ESpotXchange%3C%2FAdSystem%3E%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%3CAdTitle%3E%3C!%5BCDATA%5BSample%20VAST%5D%5D%3E%3C%2FAdTitle%3E%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%3CImpression%3Ehttp%3A%2F%2Fsample.com%3C%2FImpression%3E%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%3CDescription%3E%3C!%5BCDATA%5BA%20sample%20VAST%20feed%5D%5D%3E%3C%2FDescription%3E%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%3CCreatives%3E%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%3CCreative%20sequence%3D%221%22%20id%3D%221%22%3E%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%3CLinear%3E%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%3CDuration%3E00%3A00%3A30%3C%2FDuration%3E%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%3CTrackingEvents%3E%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%3C%2FTrackingEvents%3E%20%20%20%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%3CVideoClicks%3E%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%3CClickThrough%3E%3C!%5BCDATA%5Bhttp%3A%2F%2Fsample.com%2Fopenrtbtest%5D%5D%3E%3C%2FClickThrough%3E%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%3C%2FVideoClicks%3E%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%3CMediaFiles%3E%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%3CMediaFile%20delivery%3D%22progressive%22%20bitrate%3D%22256%22%20width%3D%22640%22%20height%3D%22480%22%20type%3D%22video%2Fmp4%22%3E%3C!%5BCDATA%5Bhttp%3A%2F%2Fsample.com%2Fvideo.mp4%5D%5D%3E%3C%2FMediaFile%3E%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%3C%2FMediaFiles%3E%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%3C%2FLinear%3E%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%3C%2FCreative%3E%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%3C%2FCreatives%3E%0A%20%20%20%20%20%20%20%20%3C%2FInLine%3E%0A%20%20%20%20%3C%2FAd%3E%0A%3C%2FVAST%3E" 80 | } 81 | ] 82 | }, 83 | 84 | { 85 | "seat": "33", 86 | "bid": [ 87 | { 88 | "id": "388f110487f9d1e63f77b22d86e916b", 89 | "impid": "1", 90 | "price": 600, 91 | "dealid": "1452f.eadb4.7aaa", 92 | "nurl": "http://example33.com/win/DECAFBAD?won=${AUCTION_PRICE}" 93 | }, 94 | { 95 | "id": "388f110487f9d1e63f77b22d86e916c", 96 | "impid": "2", 97 | "price": 260, 98 | "dealid": "1452f.eadb4.f9bc", 99 | "nurl": "http://example33.com/win/CAFEBABE?won=${AUCTION_PRICE}" 100 | }, 101 | { 102 | "id": "388f110487f9d1e63f77b22d86e916d", 103 | "impid": "3", 104 | "price": 300, 105 | "nurl": "http://example33.com/win/DEADBEEF?won=${AUCTION_PRICE}" 106 | } 107 | ] 108 | } 109 | ] 110 | } 111 | ``` 112 | -------------------------------------------------------------------------------- /spotxchange/example-video-request-multiple_impr.md: -------------------------------------------------------------------------------- 1 | # Video Request for Multiple Impressions with a Private Deal 2 | 3 | The following example illustrates a bid request for multiple video 4 | impressions, possibly for long-form content, with no companion ad 5 | slot. It includes requests for pre, mid and post-roll impressions. 6 | Additionally, the video content itself is described in the "content" 7 | object. A few notes about specific fields in the example: 8 | 9 | ## Bid Request Object 10 | - `at`: This is a second-price auction. 11 | 12 | ## For all Impression objects 13 | - `api`: Indicates that VPAID 1.0 containers are explicitly supported. As such, the mime types supported for VPAID are only "application/x-shockwave-flash" and "application/javascript". *Note that there is an implicit restriction as to which protocol is allowed in which mimetype. JavaScript support was not specified until VPAID 2.0, while Flash supports both VPAID 1.0 and 2.0.* 14 | - `battr`: User interactive and alert type ads (value '13' and '14', respectively) are explicitly being blocked for both the video and its companions. 15 | - `delivery`: Progressive download is only supported. 16 | - `linearity`: All video impressions are linear. 17 | - `maxextended`: This is not included meaning no extended video ad duration is allowed. 18 | - `playbackmethod`: Only auto-play with sound on is allowed. 19 | - `pos`: Indicates this opportunity is "above the fold". 20 | - `protocol`: Only VAST 2.0 and 3.0 are allowed. *Note that a wrapper response is not allowed in this example.* 21 | - `sequence`: Included and showing the progression of the impression opportunities available. 22 | 23 | ## For the Pre-Roll Impression Object (id 1) 24 | 25 | - `bidfloor`: Specified per deal. 26 | - `startdelay`: This is 0 indicating the pre-roll. 27 | - `pmp`: This is a private auction restricted to one deal, but that deal is not restricted in seats that can bid. 28 | - `ext`: an exchange-specific deals extension is passed to inform the bidder of the priority assigned deals. 29 | 30 | ## For the Mid-Roll Impression Object (id 2) 31 | 32 | - `bidfloor`: Specified per deal. 33 | - `startdelay`: This is 300 indicating the mid-roll starts 5 minutes into the content. 34 | - `pmp`: This is a private auction restricted to two deals, with the second deal restricted to only certain seats. 35 | - `ext`: an exchange-specific deals extension is passed to inform the bidder of the priority assigned deals. 36 | 37 | ## For the Post-Roll Impression Object (id 3) 38 | 39 | - `bidfloor`: Set at $2.00 CPM. 40 | - `startdelay`: This is -2 indicating the post-roll. 41 | - `pmp`: There are no private marketplace restrictions and all deals and seats are allowed to participate. 42 | 43 | ```json 44 | { 45 | "id": "0123456789ABCDEF0123456789ABCDEF", 46 | "at": 2, 47 | "tmax": 120, 48 | "imp": [ 49 | { 50 | "id": "1", 51 | "pmp": { 52 | "private_auction":1, 53 | "deals": [{ 54 | "id":"1452f.eadb4.7aaa", 55 | "bidfloor":5.3, 56 | "at":1, 57 | "wseats":[], 58 | "ext": { 59 | "priority":1, 60 | "wadvs":[] 61 | } 62 | } 63 | ] 64 | }, 65 | "video": { 66 | "mimes": [ 67 | "video/x-flv", 68 | "video/mp4", 69 | "application/x-shockwave-flash", 70 | "application/javascript" 71 | ], 72 | 73 | "api": [1,2], 74 | "battr": [13,14], 75 | "boxingallowed": true, 76 | "delivery": [2], 77 | "h": 480, 78 | "linearity": 1, 79 | "maxbitrate": 1500, 80 | "maxduration": 30, 81 | "minbitrate": 300, 82 | "minduration": 5, 83 | "playbackmethod": [1], 84 | "pos": 1, 85 | "protocol": [2,3], 86 | "sequence": 1, 87 | "startdelay": 0, 88 | "w": 640 89 | } 90 | }, 91 | { 92 | "id": "2", 93 | "pmp": { 94 | "private_auction":1, 95 | "deals": [ 96 | { 97 | "id":"1452f.eadb4.7aaa", 98 | "bidfloor":3.5, 99 | "at":1, 100 | "wseats":[], 101 | "ext": { 102 | "priority":1, 103 | "wadvs":[] 104 | } 105 | }, 106 | { 107 | "id":"1452f.eadb4.f9bc", 108 | "bidfloor":2.5, 109 | "at":1, 110 | "wseats":["45","165","33"], 111 | "ext": { 112 | "priority":2, 113 | "wadvs":[] 114 | } 115 | } 116 | ] 117 | }, 118 | "video": { 119 | "mimes": [ 120 | "video/x-flv", 121 | "video/mp4", 122 | "application/x-shockwave-flash", 123 | "application/javascript" 124 | ], 125 | 126 | "api": [1,2], 127 | "battr": [13,14], 128 | "boxingallowed": true, 129 | "delivery": [2], 130 | "h": 480, 131 | "linearity": 1, 132 | "maxbitrate": 1500, 133 | "maxduration": 60, 134 | "minbitrate": 300, 135 | "minduration": 30, 136 | "playbackmethod": [1], 137 | "pos": 1, 138 | "protocol": [2,3], 139 | "sequence": 2, 140 | "startdelay": 300, 141 | "w": 640 142 | } 143 | }, 144 | { 145 | "id": "3", 146 | "bidfloor": 2.00 147 | "video": { 148 | "mimes": [ 149 | "video/x-flv", 150 | "video/mp4", 151 | "application/x-shockwave-flash", 152 | "application/javascript" 153 | ], 154 | 155 | "api": [1,2], 156 | "battr": [13,14], 157 | "boxingallowed": true, 158 | "delivery": [2], 159 | "h": 480, 160 | "linearity": 1, 161 | "maxbitrate": 1500, 162 | "maxduration": 60, 163 | "minbitrate": 300, 164 | "minduration": 30, 165 | "playbackmethod": [1], 166 | "pos": 1, 167 | "protocol": [2,3], 168 | "sequence": 3, 169 | "startdelay": -2, 170 | "w": 640 171 | } 172 | } 173 | ], 174 | "site": { 175 | "id": "1345135123", 176 | "name": "Site ABCD", 177 | "domain": "siteabcd.com", 178 | "cat": [ 179 | "IAB2-1", 180 | "IAB2-2" 181 | ], 182 | "page": "http://siteabcd.com/page.htm", 183 | "ref": "http://referringsite.com/referringpage.htm", 184 | "privacypolicy": true, 185 | "publisher": { 186 | "id": "pub12345", 187 | "name": "Publisher A" 188 | }, 189 | "content": { 190 | 191 | "cat": ["IAB2-2"], 192 | "episode": 23, 193 | "id": "1234567", 194 | "keyword": ["keyword a", "keyword b", "keyword c"], 195 | "season": 2, 196 | "series": "All About Cars", 197 | "title": "Car Show" 198 | 199 | } 200 | }, 201 | "device": { 202 | "ip": "64.124.253.1", 203 | "ua": "Mozilla/5.0 (Mac; U; Intel Mac OS X 10.6; en-US; rv:1.9.2.16) Gecko/20140420 Firefox/3.6.16", 204 | "os": "OS X", 205 | "flashversion": "10.1", 206 | "js": 1 207 | }, 208 | "user": 209 | { 210 | "uid": "456789876567897654678987656789", 211 | "buyeruid": "545678765467876567898765678987654", 212 | "data": [ 213 | { 214 | "id": "6", 215 | "name": "Data Provider 1", 216 | "segment": [ 217 | { 218 | "id": "12341318394918", 219 | "name": "auto intenders" 220 | }, 221 | { 222 | "id": "1234131839491234", 223 | "name": "auto enthusiasts" 224 | } 225 | ] 226 | } 227 | ] 228 | } 229 | } 230 | ``` 231 | --------------------------------------------------------------------------------