OpenRTB API Specification Version 2.3 RTB Project
Page iii
Table of Contents
Getting Started ...................................................................................................................... 1
Integration Checklist .............................................................................................................. 2
1. Introduction .................................................................................................................... 3
1.1 Mission / Overview ........................................................................................................................................... 3
1.2 History of OpenRTB .......................................................................................................................................... 3
1.3 Version History ................................................................................................................................................... 4
1.4 Resources .............................................................................................................................................................. 4
1.5 Terminology ......................................................................................................................................................... 5
2. OpenRTB Basics ............................................................................................................... 6
2.1 Transport .............................................................................................................................................................. 6
2.2 Security .................................................................................................................................................................. 7
2.3 Data Format ......................................................................................................................................................... 7
2.4 OpenRTB Version HTTP Header .................................................................................................................. 7
2.5 Privacy by Design ............................................................................................................................................... 8
2.6 Relationship to IAB Quality Assurance Guidelines .............................................................................. 8
2.7 Customization and Extensions ..................................................................................................................... 8
3. Bid Request Specification ................................................................................................. 9
3.1 Object Model ........................................................................................................................................................ 9
3.2 Object Specifications ...................................................................................................................................... 10
3.2.1 Object: BidRequest ................................................................................................................................. 11
3.2.2 Object: Imp ................................................................................................................................................ 12
3.2.3 Object: Banner ......................................................................................................................................... 13
3.2.4 Object: Video ............................................................................................................................................. 14
3.2.5 Object: Native ........................................................................................................................................... 15
3.2.6 Object: Site ................................................................................................................................................. 16
3.2.7 Object: App ................................................................................................................................................ 16
3.2.8 Object: Publisher ..................................................................................................................................... 17
3.2.9 Object: Content ........................................................................................................................................ 17
3.2.10 Object: Producer ..................................................................................................................................... 18
3.2.11 Object: Device ........................................................................................................................................... 19
3.2.12 Object: Geo ................................................................................................................................................. 20
3.2.13 Object: User ............................................................................................................................................... 21
3.2.14 Object: Data .............................................................................................................................................. 21
3.2.15 Object: Segment ...................................................................................................................................... 22
3.2.16 Object: Regs ............................................................................................................................................... 22
3.2.17 Object: Pmp ............................................................................................................................................... 22
3.2.18 Object: Deal ............................................................................................................................................... 22
4. Bid Response Specification ............................................................................................. 24
4.1 Object Model ...................................................................................................................................................... 24
4.2 Object Specifications ...................................................................................................................................... 25
4.2.1 Object: BidResponse .............................................................................................................................. 25
4.2.2 Object: SeatBid ........................................................................................................................................ 26
4.2.3 Object: Bid.................................................................................................................................................. 26
4.3 Ad Serving Options .......................................................................................................................................... 27
4.3.1 Markup Served on the Win Notice .................................................................................................. 27
