Jivox Standard APIs
You can design an HTML ad that leverages the Jivox standard API. Using these APIs, you can monitor events and trigger actions to integrate with Jivox ad rendering technology. You can also create an HTML widget with actions that are available to users to create interactions in Ad Studio while designing an ad. For example, you could enable configuration options for a count down start number, register a Play event, and a Reset action.
The commonly used Standard APIs are shown below:
| Jivox API Name | Description | Sample Usage |
|---|---|---|
| openClickThrough | This API allows user to invoke ad click through. It will also record click through event when used. This API will invoke mraid.open if the ad is rendered with in MRAID environment. The parameter URL is optional | jvxAd.openClickThrough(URL); |
| openURL | Use this API to open a url in the new tab. This API will invoke mraid.open if the ad is rendered with in MRAID environment | jvxAd.openURL("http://www.jivox.com"); |
| recordEventByName | Use this API to record an event with a custom name. To tag events as interactive (for e.g. viewer plays video), the second parameter value passed should be 1. For non-interactive events (for e.g. city of viewer), the value should be passed as 0. You can also pass in additional event parameters as an object. | jvxAd.recordEventByName("New_Event", 1, {"a":"1","b":"2","c":"3"}); will record a custom event named "New Event", which is tagged as interactive. |
You can design an HTML ad that leverages the Jivox standard API. Using these APIs, you can monitor events and trigger actions to integrate with Jivox ad rendering technology. You can also create an HTML widget with actions that are available to users to create interactions in Ad Studio while designing an ad. For example, you could enable configuration options for a count down start number, register a Play event, and a Reset action.
The complete documentation for the Jivox API is available here: http://slate.jivox.com/studio/api.php.