Rewarded
This creative template is being phased out because it is compatible with SDK 7 only. The SDK 8 does not support this creative template.
Overview
Formerly named "Smart Video-Rewarded + End Card SDK" / "RTB+ Smart Video-Rewarded SDK". The "Rewarded" creative template displays a video ad users can choose to watch in exchange for a reward.
For a thorough understanding of the technical implementation, including the reward process itself, check out the technical documentation of Equativ's in-app SDKs.
Demo
Rewarded demo available in these apps:
Compliancy
| Criterion | Compliancy |
|---|---|
| MRAID 1.0 | ✅ |
| MRAID 2.0 | ✅ |
| RTB (without End Card) | ✅ |
Creatives
This section applies for the direct creative template only. This creative template uses the same creatives for both portrait and landscape orientation. You can either upload the video creative or paste the URL of a remote VAST 2.0 / VAST 3.0 creative into the field "VAST URL" (see "Creative template parameters" below).
Keep in mind 360°/3D Videos are supported only on iOS >= 8.0 and Android >= 4.4.
The added creatives will be used as follows:
- Creative #1 (optional): a video file, mp4 format; only if no VAST file is provided
- Creative #2 (optional): a script or a script URL used for the end card
- Creative #3 (optional): a background image; Note: If the Video blurred background creative template parameter is enabled, this creative will be used as an overlay
- Creative #4 (optional): a poster image
If a creative is not provided (video file and/or end card), the subsequent creatives move up in the list accordingly. For instance, if you do not provide any end card (Creative #2), the background image becomes Creative #2 and the poster image becomes Creative #3.
Supported file formats:
- Video
- mp4, mov, 3gp
- VPAID javascript file without ad parameters; VPAID ad parameters are usually passed in the VAST file where the VPAID creative is wrapped. When passing a bare VPAID js file as a creative, it must not expect to have ad parameters.
- VAST 2.0 or VAST 3.0
- Background / poster image
- jpg
- gif
- png
The video is automatically adapted to the width of the screen. The height is adjusted to preserve the aspect ratio of the video.
Creative template parameters
| Parameter | Description | Default value |
|---|---|---|
| 360° Video | iOS versions >= 9.0 disabled - the video will be displayed by a regular video player enabled - the video will be displayed by a 360° video player | Disabled |
| App link URL (iOS only) | If available, the SDK will try to open directly the app corresponding to this URL. The target app will be presented only if it's installed on the device (iOS 10 and higher) or allowlisted by the app referral. If it can't be opened the SDK will try to open the Click URL as a fallback. | |
| Audio mode |
muted - the video will be muted by default. auto - the video will be muted or unmuted depending on the status of the phone silent switch (or ring volume for devices without silent switch). on - the video will be unmuted by default (user music playback will stop). |
muted |
| Auto close when video ends | If enabled, the interstitial will close as soon as the video is finished. Make sure you enable the close button if you disable the auto close feature! | Disabled |
| Autoplay video |
If enabled, the video will start as soon as the interstitial is displayed. Note: autoplay is enforced to true for VPAID creatives for compatibility reasons. |
Enabled |
| Background color | The color that will be displayed under the creative if it does not fit the display area. | #000000 |
| Click URL | If you provide a click URL, it will override any click URL available in the VAST file. | |
| Close appearance countdown | Displays a countdown before showing the close button (the close appearance delay must be greater than 0 seconds). | Enabled |
| Close appearance delay | (in seconds) Number of seconds before the close button appears; set it to 0 for no delay at all | |
| Close button position | Position of the close button | Top right |
| Redirect to third party (iOS only) |
disabled - the SDK will always attempt to open the creative click URL in-app (Safari modal, Store modal etc.) enabled - the SDK will always open the creative click URL outside the app (Safari, App Store, etc.) |
Disabled |
| Resize policy for background image |
cover - the image will cover the entire container even if it has to crop it in width or height contain - the image will be resized to be contained in the screen (without modifying the aspect ratio) 100% - the image will be stretched to match both the device width and height |
Cover |
| Reward amount | The reward amount used for the rewarded video. | 0 |
| Reward currency | The reward currency used for the rewarded video. | |
| Swipe to close |
disabled - the interstitial can only be closed using the close button. enabled - the interstitial can be closed by swiping it down as soon as the close button is enabled. |
Disabled |
| Third party impression pixels | Comma separated list of URLs that will be called when the impression is counted by the SDK. | |
| Third party tracking script for End Card | (SDK >= 6.7) This javascript tracking script will be automatically injected in the End Card creative and executed by the SDK. | |
| Use VAST companion as background image | If a companion image is found with your video creative in the VAST File, it will be used as the background image of the interstitial. | Disabled |
| VAST URL | The URL of the VAST file that will be used by the insertion. If a VAST URL is provided, the optional End Card HTML URL/Script will be Creative #1, the background image will be Creative #2 and the poster image will be Creative #3. In case of no End Card creative, the background image will be Creative #1 and the poster image will be Creative #2. | |
| Vertical position for video | The vertical position of the video when the device is in portrait orientation. In landscape orientation, the video will always be centered vertically. | Top |
| Video blurred background | If enabled, add a dynamic blurred effect behind the video. The blur will replace any background color. This effect will not be applied on VPAID creatives. | Disabled |
| Video blurred background blur radius | The radius of the background blur that will be applied to the interstitial background; set it to 0 to disable blur | 15 |
| Video blurred background tint color | The tint color of the blurred background. | #ffffff |
| Video blurred background tint color opacity |
The opacity to apply to the tint color of the blurred effect in percent (0-100 %). Note: 100% will completely mask the effect. |
0 |
| Video is skippable |
Used to override the skip configuration found in the VAST file: Yes - the video will always be skippable. No - the video will never be skippable. Keep VAST setting - use the configuration found in the VAST file. |
Yes |
| RTB options (only for the RTB template) | ||
| Acceptable sizes | Acceptable creative sizes retrieved from RTB; format: comma-separated list of width*height pairs (no spaces). Example: 250*300,320*250 | |
| Confirm before exiting (iOS option) | (for iOS only) An alert view will be displayed before redirecting the user to a third party app if enabled. | Disabled |
| Height | Height of the video player in device independent pixels (DIPS). | |
| Maximum bit rate | Maximum bit rate in kbps | |
| Maximum video duration (s) | The maximum duration in seconds for RTB video ads. | 60 |
| Minimum bit rate | Minimum bit rate in kbps | |
| Minimum video duration (s) | The minimum duration in seconds for RTB video ads. | 1 |
| Playback method | The playback methods for video ads that will be retrieved from RTB. | All |
| Width | Width of the video player in device independent pixels (DIPS). | |
Limitations
360°/3D Videos are supported only on iOS >= 8.0 and Android >= 4.4.
Known issues
n/a
Release notes
- 2019-02-18 - Updated labels / tooltips / doc