Online Display Campaigns are Campaigns that are meant to be used in order to display an overlay (image) on the target platform (web, mobile or smarttv).
Each Online Display Campaign specifies its target platform and contains a Creative (which in turn contains an image to display along with possible other information such as a targetUrl).
The target platform specifies what platform this campaign is supposed to be displayed on. The creator of the Campaign should make sure to select a platform-appropriate Creative for it.
| Value | Name |
|---|---|
| 0 | Web |
| 1 | Mobile |
| 2 | SmartTV |
Each Online Display must have a Creative of type Flexi associated with them.
A Flexi creative is a Creative that can have an image of unspecified dimensions, so it is up to the user to make sure that the image of the Creative is appropriate for the target platform.
Online Display Campaigns are returned by the Campaign API's (https://api.icareus.com/api/campaign/v5) getActiveCampaigns action.
The getActiveCampaigns action also accepts a campaignType parameter in which you can specify the value onlinedisplay in order to only fetch active Online Display Campaigns.
The Campaign API returns Online Display Campaigns in the following format (notice the comments in the following JSON):
|
A deviceId can be generated by making an API call to https://icareus-cache.secure2.footprint.net/api/devices/?organizationId=<ORGANIZATION-ID>
This can be done by making an API call to https://api.icareus.com/api/campaign/v5?action=getActiveCampaigns&organizationId=<ORGANIZATION-ID>&campaignType=onlinedisplay
Please note that the campaignType parameter is optional, but if you leave it out you will have to make sure to manually check each of the Campaigns returned by the API to see if the type of the Campaign is "onlinedisplay".
If you are working on a mobile client, you should only process Online Display Campaigns where targetPlatform == 1. See the listing under "Target Platforms" above for reference.
Each Online Display Campaign returned by the getActiveCampaigns API call contains an advert object, which in turn contains an image object that has a url pointing to an image. This image is what you should render in the application.
Optionally the advert object might also contain a targetUrl, make sure to check whether this is present or not.
If targetUrl is present (and not an empty string), then it should be used as the target when a user clicks the overlay image.
The tracking object contains URLs that are used to send analytics events back to us. Please note that the deviceId should always be appended as a parameter to these tracking URLs. So if campaign.tracking.impression contains the following URL: https://audience.icareus.com/pixel/adverts/?organizationId=6877582&eventName=ad_impression&campaignId=236821220&suiteChannelId=0&serviceObject={}&externalEventData={}, you should append the deviceId to it, so that the final URL becomes: https://audience.icareus.com/pixel/adverts/?organizationId=6877582&eventName=ad_impression&campaignId=236821220&suiteChannelId=0&serviceObject={}&externalEventData={}&deviceId=<DEVICE-ID>
Each Online Display Campaign also contains a tracking object, which always contains a URL under the key impression, a request to this URL should be made when the user has seen the overlay.
When targetUrl is present and not empty, the tracking object should also contain a URL under the key click. A request to this URL should be made when the user clicks the overlay.
This section explains when the request to the URL provided in campaign.tracking.impression should be made. It should be made when the user has seen the overlay (ad), but what is considered "seen"?
An impression is considered a viewable impression when it has appeared within a user’s browser and had the opportunity to be seen. The Interactive Advertising Bureau (IAB) defines a viewable impression as an ad that meets the following criteria: