Open RTB 2.3 Examples

Document created by pubmatic-archivist on Mar 27, 2017Last modified by catherine.racette on Sep 3, 2017
Version 9Show Document
  • View in full screen mode

OpenRTB 2.3 Documentation 

OpenRTB 2.3 Introduction 

OpenRTB 2.3 Integration Plan 

OpenRTB Bid Request Objects and Parameters 

OpenRTB Bid Response Objects and Parameters 

OpenRTB 2.3 PubMatic Extensions 

Open RTB 2.3 Examples 

OpenRTB Ad Server API Cookie Sync 

OpenRTB 2.3 Click Tracking 

OpenRTB 2.3 Win/Loss Notification 

OpenRTB 2.3 API Performance 

OpenRTB 2.3 Known Limitations & Reference 

Display + Rich Media Request

{
    "id": "E7D23F2F-32D0-4267-B56B-45B0DC9253EF",
    "imp": [
        {
            "id": "1",
            "tagid": "77948",
            "iframebuster": [
                "pr",
                "dc"
            ],
            "banner": {
                "w": 728,
                "h": 90,
                "pos": 1,
                "topframe": 1,
                "expdir": [
                    1
                ],
                "battr": [
                    1,
                    2,
                    3,
                    4,
                    5,
                    6,
                    7,
                    8
                ]
            }
        }
    ],
    "site": {
        "id": "44100",
        "domain": "samplepub",
        "pagecat": [
            "IAB1",
            "IAB2"
        ],
        "page": "samplepub.com",
        "ref": "refererpage.com",
        "mobile": 1,
        "publisher": {
            "id": "36515"
        },
        "ext": {
            "bsc": {
                "drg": 2000,
                "off": 2000,
                "hat": 2000,
                "adt": 2000,
                "dlm": 2000,
                "alc": 2000,
                "sam": 1000
            }
        }
    },
    "device": {
        "ip": "172.172.172.172",
        "ua": "Mozilla/5.0 (Windows NT 6.1; WOW64; rv:38.0) Gecko/20100101 Firefox/38.0",
        "carrier": "AT&T Services",
        "language": "en",
        "js": 1,
        "geo": {
            "country": "USA",
            "region": "MA",
            "city": "Hampden",
            "metro": "543",
            "lat": -89.8787842,
            "lon": -98.8989868,
            "type": 1,
            "zip": "01036",
            "utcoffset": 330
        },
        "ext": {
            "xff": "12.26.26.10",
            "res": "1366x768",
            "freq": 0,
            "pf": 2
        }
    },
    "user": {
        "id": "1699-uid:A4D5B857237FF2FD758E199A770CCDD",
        "buyeruid": "dspuserid",
        "yob": 1999,
        "gender": "M",
        "keywords": "Reading",
        "geo": {
            "lat": -89.8787842,
            "lon": -98.8989868,
            "type": 1,
            "country": "IND",
            "region": "MAH",
            "city": "PUNE",
            "zip": "6272",
            "metro": "214",
            "utcoffset": 330
        },
        "ext": {
            "inc": "$100"
        }
    },
    "bcat": [
        "IAB1-1",
        "IAB1-2",
        "IAB1-3",
        "IAB1-4",
        "IAB1-5",
        "IAB1-6",
        "IAB1-7",
        "IAB1-8",
        "IAB1-9"
    ],
    "ext": {
        "bidguidefloor": 5
    }
}

PMP Request

{
    "id": "E7D23F2F-32D0-4267-B56B-45B0DC9253EF",
    "imp": [
        {
            "id": "1",
            "tagid": "77948",
            "banner": {
                "w": 728,
                "h": 90,
                "pos": 1,
                "topframe": 1,
                "expdir": [
                    5
                ],
                "battr": [
                    1,
                    2,
                    3,
                    4
                ]
            },
            "pmp": {
                "private_auction": 0,
                "deals": [
                    {
                        "id": "MX-AGR-1017-13",
                        "bidfloor": 0,
                        "wseat": [
                            "1",
                            "3"
                        ],
                        "at": 3
                    },
                    {
                        "id": "VK-AGR-0718-05",
                        "bidfloor": 4.6,
                        "wseat": [
                            "3"
                        ],
                        "at": 2
                    },
                    {
                        "id": "VK-AGR-0718-08",
                        "bidfloor": 4.6,
                        "wseat": [
                            "3"
                        ],
                        "at": 2
                    },
                    {
                        "id": "VK-AGR-0718-09",
                        "bidfloor": 4.6,
                        "wseat": [
                            "3"
                        ],
                        "at": 2
                    }
                ]
            }
        }
    ],
    "site": {
        "id": "44100",
        "domain": "someadomain",
        "pagecat": [
            "IAB1",
            "IAB2"
        ],
        "page": "http://somedomain.com",
        "ref": "http://refererpage.com",
        "mobile": 1,
        "publisher": {
            "id": "36515"
        }
    },
    "device": {
        "ip": "172.172.172.172",
        "ua": "Mozilla/5.0(WindowsNT6.1;WOW64;rv:38.0)Gecko/20100101Firefox/38.0",
        "carrier": "AT&TServices",
        "language": "en",
        "js": 1,
        "geo": {
            "country": "USA",
            "region": "MA",
            "city": "Hampden",
            "metro": "543",
            "lat": -89.8787842,
            "lon": -98.8989868,
            "type": 1,
            "zip": "01036",
            "utcoffset": 330
        },
        "ext": {
            "xff": "172.173.174.175",
            "res": "1366x768",
            "freq": 0,
            "pf": 2
        }
    },
    "user": {
        "id": "1699-uid:A4D5B857237FF2FD758E199A770CCDD",
        "buyeruid": "dspbuyerid",
        "yob": 1999,
        "gender": "F",
        "geo": {
            "lat": -89.8787842,
            "lon": -98.8989868,
            "type": 1,
            "country": "IND",
            "region": "MAH",
            "city": "PUNE",
            "zip": "6272",
            "metro": "2147483647",
            "utcoffset": 330
        }
    },
    "bcat": [
        "IAB1-1",
        "IAB1-2",
        "IAB1-3",
        "IAB1-4"
    ],
    "ext": {
        "bidguidefloor": 5
    }
}

Video Request

{
    "id": "D32F9C38-CF43-4A70-92AE-A7F555E569B8",
    "imp": [
        {
            "id": "1",
            "tagid": "78256",
            "video": {
                "mimes": [
                    "video/mp4",
                    "application/x-shockwave-flash",
                    "video/h264"
                ],
                "linearity": 1,
                "minduration": 1,
                "maxduration": 23,
                "protocols": [
                    2,
                    5
                ],
                "startdelay": -1,
                "minbitrate": 300,
                "maxbitrate": 200,
                "playbackmethod": [
                    2
                ],
                "companionad": [
                    {
                        "w": 230,
                        "h": 400
                    }
                ],
                "api": [
                    2
                ],
                "h": 360,
                "w": 720,
                "pos": 1,
                "ext": {
                    "wndh": 602,
                    "wndw": 1366,
                    "adh": 360,
                    "adw": 720,
                    "depth": 0,
                    "wndurl": "someurl",
                    "ploc": "514x204",
                    "skip": 1,
                    "skipdelay": 10,
                    "noskipadlen": 0
                }
            }
        }
    ],
    "site": {
        "id": "17934",
        "domain": "somedomain",
        "page": "www.somedomain.com/a",
        "ref": "sampleref",
        "mobile": 0,
        "publisher": {
            "id": "586"
        }
    },
    "device": {
        "ip": "172.172.172.172",
        "ua": "Mozilla/5.0(WindowsNT6.1;WOW64;rv:38.0)Gecko/20100101Firefox/38.0",
        "language": "en",
        "js": 1,
        "geo": {
            "utcoffset": 330
        },
        "ext": {
            "res": "1366x768",
            "pf": 1
        }
    },
    "user": {
        "geo": {
            "utcoffset": 330
        }
    },
    "badv": [
        "baddomain.com"
    ]
}

App Request

{
    "id": "EF1FCDEE-30AF-4747-9304-34477A397E3E",
    "at": 1,
    "imp": [
        {
            "id": "1",
            "tagid": "76964",
            "banner": {
                "w": 320,
                "h": 50,
                "topframe": 1,
                "api": [
                    3,
                    5
                ]
            }
        }
    ],
    "app": {
        "id": "284815942",
        "name": "someapp",
        "ver": "3.2.1",
        "bundle": "com.google.someapp",
        "domain": "http://someapp.com",
        "cat": [
            "IAB15",
            "IAB15-10",
            "IAB12"
        ],
        "paid": 0,
        "storeurl": "https://itunes.apple.com/in/app/someapp/id284815942?mt=8",
        "publisher": {
            "id": "31400"
        },
        "ext": {
            "pmid": "32506"
        }
    },
    "device": {
        "ip": "172.172.172.172",
        "ua": "Mozilla/5.0(iPhone;CPUiPhoneOS7_1_1likeMacOSX)AppleWebKit/537.51.2(KHTML,likeGecko)Version/7.0Mobile/11D257Safari/9537.53",
        "language": "en",
        "make": "Apple",
        "model": "iPhone",
        "os": "iOS",
        "osv": "7",
        "js": 1,
        "devicetype": 1,
        "dpidsha1": "9AEF8",
        "geo": {
            "utcoffset": 330
        },
        "ext": {
            "res": "1366x768",
            "pf": 4
        }
    },
    "user": {
        "geo": {
            "utcoffset": 330
        }
    },
    "ext": {
        "wli": {
            "rId": "191C7C83-CB0E-4334-A059-B625C39E0C51",
            "bCur": "USD",
            "wBid": 3.5,
            "csa": 1,
            "bInfo": [
                {
                    "bId": "abc123",
                    "st": 0
                }
            ]
        }
    }
}

Native Request

{
    "id": "1B790E1F-F6C0-408B-9E84-E5938E894134",
    "imp": [
        {
            "id": "1",
            "tagid": "76964",
            "native": {
                "request": "{\"layout\":3,\"assets\":[{\"id\":1,\"title\":{\"len\":100}},{\"id\":2,\"img\":{\"type\":1}},{\"id\":3,\"data\":{\"type\":3}},{\"id\":4,\"data\":{\"type\":12}}]}",
                "ver": "1.0"
            }
        }
    ],
    "app": {
        "id": "284815942",
        "name": "someapp",
        "ver": "3.2.1",
        "bundle": "com.google.someapp",
        "domain": "http://someapp.com",
        "cat": [
            "IAB15",
            "IAB15-10",
            "IAB12"
        ],
        "paid": 0,
        "storeurl": "https://itunes.apple.com/in/app/someapp/id284815942?mt=8",
        "publisher": {
            "id": "31400"
        },
        "ext": {
            "pmid": "32506"
        }
    },
    "device": {
        "ip": "172.172.172.172",
        "ua": "Mozilla/5.0(WindowsNT6.1;WOW64;rv:38.0)Gecko/20100101Firefox/38.0",
        "language": "en",
        "js": 1,
        "geo": {
            "lat": 42.0619965,
            "lon": -72.4989014,
            "type": 2,
            "utcoffset": -300
        },
        "ext": {
            "res": "320x480",
            "pf": 4
        }
    },
    "user": {
        "geo": {
            "utcoffset": -300
        }
    },
    "badv": [
        "badadv.com"
    ]
}

Native Response

{
    "id": "865FD1A4-CC85-4C17-B7C3-D72F5BC4F7A7",
    "bidid": "abc123",
    "cur": "USD",
    "seatbid": [
        {
            "seat": "511",
            "bid": [
                {
                    "id": "1",
                    "impid": "1",
                    "price": 3.5,
                    "adm": "{\"native\":{\"assets\":[{\"title\":{\"text\":\"NativeTestTitle\"},\"id\":1},{\"img\":{\"w\":80,\"h\":80,\"url\":\"http:\\/\\/test.net\\/native_ads\\/PM-Native-Ad-80x80.png\"},\"id\":2},{\"data\":{\"value\":\"4.5\"},\"id\":3},{\"data\":{\"value\":\"clickhere\"},\"id\":4}],\"link\":{\"fallback\":\"http:\\/\\/example.com\\/fallback\",\"clicktrackers\":[\"http:\\/\\/clicktracker.com\\/main\\/9bde02d0-6017-11e4-9df7-005056967c35\"],\"url\":\"http:\\/\\/ads.test.com\\/1\\/redir\\/9bde02d0-6017-11e4-9df7-005056967c35\\/0\\/1\"},\"imptrackers\":[\"http:\\/\\/imptracker.com\\/main\\/9bde02d0-6017-11e4-9df7-005056967c35\"],\"jstracker\":\"

Attachments

    Outcomes