Vungle Exchange OpenRTB 2.5 Native Ad Integration

Use this article to integrate native ads into your bid responses following the Vungle Exchange OpenRTB 2.5 specifications. 

Native Ad File Types

  Image (Liftoff Monetize SDK v.6.11) Video (TBD)
File type - JPG
- PNG
- MP4
- MOV
File Size N/A N/A
Platform - iOS
- Android
N/A

Supported Features

We DO support We do NOT Support

native.eventtrackers for impression tracking (preferred, as per the IAB OpenRTB Dynamic Native Ads API
Specification Version 1.2, section 5.8)

native.imptrackers[] for impression tracking

response.link.click trackers[] for multi-party click trackers

🚫 native.jstracker for impression tracking

🚫 viewability trackers

🚫 native.link.fallback for deep link fallback; currently, we only support link.url

🚫 GIF animation for the main image asset (you can pass a GIF, but Vungle Exchange will render it as a static image)

Technical Requirements for Bidders

Asset

Asset Type Required? Comments
Main Image JPG or PNG Yes

1.91:1 dimension (417x800 and higher)

App Title/Brand Text Yes 25-character truncation
App Icon/Logo JPG or PNG Yes 80x80 minimum
App Text Text Yes 90-character truncation
CTA text Text No 15-character truncation
CTA destination URL No  
Star Ratings String No Float number as a string (e.g., “4.3”)
Sponsored Text Text No 25-character truncation
Privacy Icon JPG or PNG No  
Privacy URL URL No  

Asset ID

The asset ID is assigned by Vungle Exchange in the bid request. DSPs must respond with the asset ID value received in the bid request.

Asset ID Required? Description
1 Yes Main image
3 No CTA button URL
4 No CTA text
5 Yes App icon
6 Yes App title
7 Yes App text
8 No App rating
9 No Privacy icon
10 No Privacy URL
11 No Sponsored by

Image URL

The image URL must contain the correct file extensions. 

Valid example:

Valid example, with correct file extension
"img\": {\"url\": \"https://s3.amazonaws.com/vungle2-cdn-qa/assets/525ec4576ca69a3b4100000d/69ae9b8bf69e08a5a9d29051083a5319.jpg\"}

Invalid example:

Invalid example, without file extension
"img\":{\"url\":\"https://p0.ipstatp.com/origin/ad-site-i18n-sg/202108265d0d6c301e92a3d3409abeb6\",\"w\":1200,\"h\":627}

Clickthrough URL (Destination URL)

As per the IAB OpenRTB Dynamic Native Ads API Specification Version 1.2, section 5.1, always include the clickthrough URL (or destination URL) in the response.link object:

Field Required Type Description
link Yes Object

Destination Link. This is default link object for the ad. Individual assets can also have a link object which applies if the asset is activated (clicked). If the asset doesn’t have a link object, the parent link object applies.

Vungle Exchange also supports clickthrough URL (or destination URL) via Asset ID = '3' (CTA button URL). 
The clickthrough URL (or destination URL) passed via other assets, such as Image, App Icon, or App Titile, will be ignored.

Bid Request and Bid Response Examples

Bid Request Example

Bid Request Example
{
    "id": "",
    "imp": [{
            "Id": "",
            "Native": {
                "Request": "{
                "Ver": "1.2",
                "Context": 1,
                "Assets": [{
                    "id": 1,
                    "required": 1,
                    "img": {
                        "type": 3
                    }
                }, {
                    "id": 3,
                    "required": 1,
                    "data": {
                        "type": 11
                    }
                }, {
                    "id": 4,
                    "required": 1,
                    "data": {
                        "type": 12,
                        "len": 15
                    }
                }, {
                    "id": 5,
                    "required": 1,
                    "img": {
                        "type": 1,
                        "wmin": 80,
                        "hmin": 80
                    }
                }, {
                    "id": 6,
                    "required": 1,
                    "title": {
                        "len": 25
                    }
                }, {
                    "id": 7,
                    "data": {
                        "type": 2,
                        "len": 90
                    }
                }, {
                    "id": 8,
                    "data": {
                        "type": 3
                    }
                }, {
                    "id": 9,
                    "required": 1,
                    "img": {
                        "type": 1,
                        "w": 120,
                        "h": 120
                    }
                }, {
                    "id": 10,
                    "required": 1,
                    "data": {
                        "type": 11
                    }
                }, {
                    "id": 11,
                    "required": 1,
                    "data": {
                        "type": 1,
                        "len": 25
                    }
                }],
                "Eventtrackers": [{
                    "event": 1,
                    "methods": [1, 2]
                }],
                "Privacy": 1
            }
            ",
            "api": [
                5
            ],
            "battr": [
                5
            ]
        }, "bidfloor": 0
    }], "at": 0
}

Bid Response Example

Bid Response Example
{
    "id": "61764c49a49aded968c7ef0d",
    "seatbid": [{
        "bid": [{
            "id": "12193",
            "impid": "1",
            "price": 98,
            "nurl": "http://kraken-ext1-apiqa-kraken.apiqa.svc.cluster.local:7700/win?price=${AUCTION_PRICE}",
            "burl": "http://kraken-apiqa-kraken.apiqa.svc.cluster.local:7700/win?aid=kraken-test-aid&impid=kraken-test-impid&price=100.001",
            "lurl": "http://kraken-qa1-apiqa-kraken.apiqa.svc.cluster.local:7700/lurl",
            "adm": "{"
            native ": {"
            link ": {"
            url ": "
            https: //itunes.apple.com/app/autorap-by-smule/id524299475?uo=5"},"assets": [{"id": 1,"required": 1,"img": {"url": "https://s3.amazonaws.com/vungle2-cdn-qa/assets/525ec4576ca69a3b4100000d/69ae9b8bf69e08a5a9d29051083a5319.gif"},"link": {"url": "https://itunes.apple.com/app/autorap-by-smule/id524299475?uo=5"}},{"id": 3,"required": 1,"data": {"value": "https://itunes.apple.com/app/autorap-by-smule/id524299475?uo=5"}},{"id": 4,"required": 1,"data": {"value": "cta text"}},{"id": 6,"required": 1,"title": {"text": "My App"}},{"id": 5,"required": 1,"img": {"url": "https://cdn-lb.vungle.com/assets/525ec4576ca69a3b4100000d/icon.png"},"link": {"url": "https://itunes.apple.com/app/autorap-by-smule/id524299475?uo=5"}},{"id": 7,"required": 1,"data": {"value": "my App text."}},{"id": 9,"required": 1,"img": {"url": "http://www.myads.com/privacy-icon.png"}},{"id": 10,"required": 1,"data": {"value": "PRIVACY_URL"}},{"id": 11,"required": 1,"data": {"value": "SPONSORED_BY"}},{"id": 8,"required": 1,"data": {"value": "APP_RATING."}}],"privacy": "http://www.myprivacyurl.com","eventtrackers":[{"event":1,"method":2,"url":"https://www.mytracker.com/tracker.js"}]}}",
                "adomain": ["domain1.com"],
            "bundle": "bundleid",
            "cat": ["Movies", "Music"],
            "api": 7,
            "ext": {
                "skadn": {
                    "version": "2.0",
                    "network": "cDkw7geQsH.skadnetwork",
                    "campaign": "45",
                    "itunesitem": "880047117",
                    "nonce": "473b1a16-b4ef-43ad-9591-fcf3aefa82a7",
                    "sourceapp": "123456789",
                    "timestamp": "1594406341",
                    "signature": "MEQCIEQlmZRNfYzK",
                    "ext": {}
                },
                "deeplink": "zalora://my//seg_s/m/",
                "imptrackers": ["https://us-event.app-install.bid/rtb/impr?id=123", "https://us-event.app-install.bid/rtb/impr?id=YnRyAgMAAAF6dACeAwAGRREAAAAwHZlv1LjyQ6eKNFvVILh75gACdXMB&price=${AUCTION_PRICE}"]
            }
        }]
    }],
    "bidid": "12193",
    "cur": "USD"
}
Powered by Creativity Driven by Performance Sign Up Here

Questions?

Need further assistance, feel free to reach out to us, we’re here to help!

Was this article helpful?