HTML and MRAID Creatives Submission Guidelines

Vungle Agent

August 05, 2024 17:35

Use the guidelines in this article to serve HTML and MRAID creative on Vungle Exchange.

HTML Ads: Supported Formats and File Types

HTML creative can be served in all banner ad formats, such as 320x50 and MREC, as well as in companion ads (endcards) for full screen ad experiences. For more information about endcards, refer to Vungle Exchange OpenRTB 2.5 EndCard Integration.

HTML Ad Markup

HTML ad markup can take these forms:

Full HTML documents
Snippets of JavaScript code
Snippets of HTML code

Creative File Types

Creative file types can include:

PNG
JPG/JPEG
GIF (animated GIFs will be displayed as static images)
Video

For more information, refer to the Vungle Exchange OpenRTB 2.5 Integration Guide's Banner Object section.

MRAID Click Requirements

To take a user to the clickthrough destination (for example, an app store, an app, or an external web site), open the destination URL using mraid.open (preferred) or window.open. Do not use window.location. The user may only be taken to an external destination following an interaction with the creative.

MRAID Ads: Supported Formats and Features

For full screen MRAID ads, the Vungle Exchange supports the following:

We DO support We do NOT Support

✓ Static and interactive ads in the MRAID 2.0 standard

✓ Playable ads without video in the MRAID 2.0 standard

🚫 MRAID video (use VAST video)

🚫 Custom close buttons; calling useCustomClose() or setting useCustomClose to 'true' in the expandProperties object are both ignored

🚫 Custom privacy icon images and URLs

🚫 MRAID ads containing iFrames are likely to cause technical issues

Requirements to Submit an MRAID Creative

Bidders must comply with the Vungle Exchange OpenRTB 2.5 Integration Guide.

To serve an MRAID creative, add the following field:value pairing to the seatbid.bid.ext object of your bid response: "crtype": "MRAID 2.0".
To serve an MRAID interactive ad, in addition to passing "crtype": "MRAID 2.0", you must also include "attr": [13] in the seatbid.bid.attr, as per the IAB OpenRTB API Specification Version 2.5. This will ensure your interactive creatives are eligible for our rewarded video supply.

Identify Impressions That Allow MRAID Playables

For bid requests containing both a banner object and a video object, a DSP can return an MRAID playable.

If the impression opportunity is	And if the Bid Request contains	Then the Bid Response Accepts
Full screen rewarded	Video + banner objects AND `battr` is not '13'	VAST video Full screen MRAID
Full screen interstitial	Video + banner objects AND `battr` is not '13'	VAST video Full screen MRAID
Full screen rewarded	Video object only	VAST video only
Full screen interstitial	Video object only	VAST video only

Identify Impressions That Allow Rewarded Video

Vungle Exchange currently uses the following field in the Bid Request to indicate whether an ad opportunity is rewarded.

"ext": {
          "skip": 0,
          "videotype": "rewarded",
          "rewarded": 1
}

Refer to Vungle Exchange OpenRTB 2.5 Integration Guide for more details.

Bid Request Example

{
  "id": "6142f149d8a5c775b2c9c146",
  "imp": [
    {
      "id": "1",
      "banner": {
        "format": [
          {
            "w": 828,
            "h": 1792
          }
        ],
        "pos": 7,
        "api": [
          5
        ],
        "vcm": 1
      },
      "video": {
        "mimes": [
          "video/mp4"
        ],
        "minduration": 0,
        "maxduration": 46,
        "protocols": [
          2,
          5
        ],
        "w": 828,
        "h": 1792,
        "placement": 5,
        "linearity": 1,
        "minbitrate": 250,
        "maxbitrate": 15000,
        "boxingallowed": 1,
        "playbackmethod": [
          1,
          2,
          3,
          4
        ],
        "delivery": [
          2,
          1
        ],
        "pos": 7,
        "api": [
          7
        ],
        "companiontype": [
          1,
          2
        ],
        "ext": {
          "skip": 0,
          "videotype": "rewarded",
          "rewarded": 1
        }
      },
      "displaymanager": "Vungle",
      "displaymanagerver": "6.11.0",
      "instl": 1,
      "tagid": "THIRD_PARTY_PLAYABLE_REWARDED_ATTR_13",
      "bidfloor": 1,
      "bidfloorcur": "USD",
      "secure": 1,
      "ext": {
        "openrtb25x": {
          "skip": 0
        },
        "metric": [
          {
            "type": "viewability",
            "vendor": "moat"
          }
        ],
        "skadn": {
          "version": "2.2",
          "versions": [
            "2.0",
            "2.2"
          ],
          "sourceapp": "1131184101",
          "skadnetids": []
        },
        "deeplink": 1
      }
    }
  ],
  "app": {
    "id": "59786bc2a43b3a08620026b1",
    "name": "彩红竞猜1",
    "bundle": "1131184101",
    "storeurl": "https://itunes.apple.com/cn/app/id1131184101",
    "cat": [
      "IAB1",
      "IAB9"
    ],
    "ver": "369",
    "privacypolicy": 1,
    "publisher": {
      "id": "597565c6c5511a1b62000990",
      "cat": [
        "IAB1",
        "IAB9"
      ]
    },
    "keywords": "app,account,managed"
  },
  "device": {
    "ua": "Mozilla/5.0 (iPhone; CPU iPhone OS 12_4 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E148",
    "geo": {
      "lat": -33.8591,
      "lon": 151.2002,
      "type": 2,
      "ipservice": 3,
      "country": "AUS",
      "region": "NSW",
      "city": "Sydney",
      "zip": "2000"
    },
    "dnt": 0,
    "lmt": 0,
    "ip": "45.117.100.153",
    "devicetype": 4,
    "make": "Apple",
    "model": "iPhone",
    "os": "iOS",
    "osv": "14.5",
    "hwv": "SE (2nd generation)",
    "h": 1792,
    "w": 828,
    "language": "en",
    "carrier": "T-Mobile",
    "connectiontype": 2,
    "ifa": "4423DD36-2738-46DC-84D1-02A47F95320D1",
    "dpidsha1": "5187c3f5db2870fd13455ff40d84235788c8750a"
  },
  "user": {
    "ext": {
      "consent": 1
    }
  },
  "at": 1,
  "tmax": 1500,
  "cur": [
    "USD"
  ],
  "bcat": [
    "IAB7-3",
    "IAB7-5",
    "IAB7-28",
    "IAB7-29",
    "IAB7-30",
    "IAB7-39",
    "IAB7-41",
    "IAB7-42",
    "IAB8-5",
    "IAB8-18",
    "IAB9-9",
    "IAB11",
    "IAB14-2",
    "IAB14-3",
    "IAB14-4",
    "IAB14-8",
    "IAB18-2",
    "IAB23",
    "IAB25-1",
    "IAB25-2",
    "IAB25-3",
    "IAB25-4",
    "IAB25-5",
    "IAB25-6",
    "IAB26"
  ],
  "badv": [
    "domain2.com",
    "domain3.com",
    "domain4.com"
  ],
  "bapp": [
    "618783545"
  ],
  "source": {
    "ext": {
      "schain": {
        "complete": 1,
        "nodes": [
          {
            "asi": "vungle.com",
            "sid": "597565c6c5511a1b62000990",
            "rid": "6142f149d8a5c775b2c9c146",
            "name": "乐世胜豪",
            "hp": 1
          }
        ],
        "ver": "1.0"
      }
    }
  },
  "regs": {
    "coppa": 1,
    "ext": {
      "gdpr": 0,
      "us_privacy": "1-N-"
    }
  },
  "ext": {
    "schain": {
      "complete": 1,
      "nodes": [
        {
          "asi": "vungle.com",
          "sid": "597565c6c5511a1b62000990",
          "rid": "6142f149d8a5c775b2c9c146",
          "name": "乐世胜豪",
          "hp": 1
        }
      ],
      "ver": "1.0"
    },
    "moat_sdk": 1
  }
}

Bid Response Example (MRAID Playable)

Include "crtype": "MRAID 2.0" in the seatbid.bid.ext, and include an MRAID 2.0 standard ad markup in the adm field.

{
  "id": "614abfbfc92e1f61f41c712c",
  "seatbid": [
    {
      "bid": [
        {
          "id": "8",
          "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": "",
          "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}"
            ],
            "crtype": "MRAID 2.0"
          }
        }
      ]
    }
  ],
  "bidid": "8",
  "cur": "USD"
}