Link Search Menu Expand Document

PDF

ironSource Mobile App VAST Integration

Publishers

Last updated on July 30, 2020


If you are using the OpenX Ad Exchange and ironSource as a mobile ad server, you can create OpenX VAST ad tags to integrate with ironSource and pass various parameters from custom apps on Android and iOS devices.

The tag you generate by creating a mobile app linear video ad unit in the OpenX user interface (UI) comes with some ironSource macros already appended.

You can include additional ironSource macros in OpenX ad tags to automatically capture other user-specific parameters. However, if you want to define additional inventory-specific parameters, you must do so manually with URL-encoded values.


Sample VAST Ad Tag with ironSource Macros

To view your VAST ad tag, find the linear video ad unit you created in your site Ad Units tab and click the name of the ad unit. You will see the VAST URI for your tag:

VAST URI

http://your-instance.openx.net/v/1.0/av?auid=0123456789&url=[APP_STORE_URL]&ifa=[IFA]&lmt=[LAT]&app.bundle=[APP_BUNDLE_ID]&app.name=[APP_NAME]&ip=[IP]&dr=true&vwd=[WIDTH]&vht=[HEIGHT]&crr=[CARRIER]&cb=[RANDOM]&ua=[UA]

Macro Definitions

The table below summarizes the ironSource macros that OpenX pairs with those parameters. See ironSource’s documentation for macro details (Appendix A).

ParameterMacroThis macro dynamically inserts…
url[APP_STORE_URL]The app’s App Store or Google Play Store URL.
ifa[IFA]The Google Advertiser Device Identifier or Apple IDFA or from the users’ device.
lmt[LAT]The setting from the user’s device that indicates if private browsing is enabled (if the user has requested not to be tracked).
app.bundle[APP_BUNDLE_ID]The app’s Bundle ID.
app.name[APP_NAME]The app’s display name.
ip[IP]The IP address from the user’s device.
vwd[WIDTH]The desired ad width.
vht[HEIGHT]The desired ad height.
crr[CARRIER]The service provider of the user’s device.
cb[RANDOM]A random integer to avoid browser caching.
ua[UA]The device user agent, which typically indicates the app or browser making the request.

Next Steps

  1. Paste your new tag into the appropriate location, as described by ironSource’s documentation.
  2. Set up OpenX selling rules.