Sorry, this entry is only available in English. For the sake of viewer convenience, the content is shown below in the alternative language. You may click the link to switch the active language.
From 3.6.0
1. Initialising VMaxAdSDK
Beginning with 3.6.0 for rewarded interstitials, it is mandatory to initialise the newly introduced VMaxAdSDK. This needs to be done as early as possible in the application lifecycle. The VMaxAdSDK asynchronously gratifies rewards via the VMaxAdSDKDelegate. Thus it is necessary to conform to the VMaxAdSDKDelegate protocol to receive rewards and further gratify users of your app. Attempt to request rewarded interstitial ads only on successful initialization of the VMaxAdSDK.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 |
@interface AppDelegate ()<VMaxAdSDKDelegate> @end @implementation AppDelegate - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { // Override point for customization after application launch. [VMaxAdSDK initWithAccountKey:@"YOUR_ACCOUNT_KEY" delegate:self onCompletion:^(NSError *error) { if(error) { NSLog(@"VMAX SDK Initialisation failed"); } else { // SDK init succeeded NSLog(@"VMAX SDK Initialised"); // Request rewarded interstitial ads } }]; return YES; } #pragma mark VMaxAdSDKDelegate - - (void)onAdReward:(NSInteger)reward { NSLog(@"reward: %ld", (long)reward); } |
2. Adding Firebase dependencies
You are also required to add Firebase dependencies to your project. You can download them from Firebase’ official site or add them from the VMAX iOS SDK zip file by dragging & dropping them into your Xcode project.
The following files & frameworks are required:
- FirebaseAnalytics.framework
- FirebaseCore.framework
- FirebaseInstanceID.framework
- GoogleInterchangeUtilities.framework
- GoogleSymbolUtilities.framework
- GoogleToolboxForMac.framework
- FirebaseAuth.framework
- GTMSessionFetcher.framework
- FirebaseDatabase.framework
- Firebase.h
Requesting Rewarded Interstitial ads
After completing the prerequisites to request rewarded interstitial ads, you are required to initialise an adview with the initWithRewardedInterstitialAdspotID:viewController:withAdUXType initializer. Do not attempt to initialise using the standard initWithAdspotID:viewController:withAdUXType initializer as it will have adverse effects and result in ad failure.
Create an instance of the VMaxAdView and conform to the delegate.
Creating the Ad View
|
1 2 3 4 5 6 7 8 |
// Put your Rewarded Interstitial Adsopt id here. Also provide the Topmost view controller in order to present the full screen ads. adView = [[VMaxAdView alloc] initWithRewardedInterstitialAdspotID:YOUR_ADSPOT_ID viewController: self withAdUXType: kVMaxAdUX_Interstitial]; // Set the delegate to class which confirms to VMaxAdDelegate protocol. adView.delegate = self; // Make ad request. [adView cacheAd]; |
Requesting Rewarded Video ads
Create an instance of the VMaxAdView and conform to the delegate.
Creating the Ad View
|
1 2 3 4 5 6 7 8 |
// Put your Rewarded Video Adspot id here. Also provide the Topmost view controller in order to present the full screen ads. adView = [[VMaxAdView alloc] initWithAdspotID:YOUR_ADSPOT_ID viewController: self withAdUXType: kVMaxAdUX_Interstitial]; // Set the delegate to class which confirms to VMaxAdDelegate protocol. adView.delegate = self; // Make ad request. [adView cacheAd]; |
It is recommended to check for ad states before calling show ad.
|
1 2 3 4 5 6 7 |
- (void)onAdReady:(VMaxAdView *)theAdView { if(theAdView.getAdState == kVMaxAdState_Ad_Ready) { [theAdView showAd]; } } |
Before 3.6.0
Note: Some partners like Chartboost support incent pre-roll and post-roll messages via their interface. So make sure to turn OFF pre-roll and post-roll messages while using VMAX Rewarded Video Incent Ads.
Initializing Wallet with Rewarded Video Ads
Import the header files for Rewarded Videos.
|
1 2 3 |
#import "VMaxRewardedVideo.h" #import "VMaxWallet.h" |
Creating walletElement instance
The VMAX SDK allows you to pass extra data to identify users for serving targeted campaign ads. Read more.
|
1 2 3 4 5 6 7 8 9 |
//Global Wallet initialization VMaxWallet *wallet =[VMaxWallet sharedVMaxWallet]; //Initialize with Currency Name self.walletElement = [wallet walletElementWithCurrency:@"Gold Coins"]; //Currency icon (optional) [self.walletElement setCurrencyImage:[UIImage imageNamed:@"gold_coin"]]; //Conform to Wallet Element Delegate to get callbacks self.walletElement.delegate = self; |
|
1 2 3 4 5 6 7 8 9 |
//Global Wallet initialization let wallet:VMaxWallet = VMaxWallet.sharedVMaxWallet() //Initialize with Currency Name let walletElement : VMaxWalletElement = VMaxWallet.sharedVMaxWallet().walletElementWithCurrency("Gold Coin") //Currency icon (optional) walletElement.currencyImage = UIImage(named: "gold_coin") //Conform to Wallet Element Delegate to get callbacks walletElement.delegate = self |
Wallet Delegates
Implement following delegate methods in your Wallet delegate
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 |
// This will give update over wallet element changes - (void)didUpdateWalletElement:(VMaxWalletElement*)walletElement withCurrencyBalance:(NSInteger)currency; // Obj-C func didUpdateWalletElement(walletElement: VMaxWalletElement!, withCurrencyBalance currency: Int) // Swift // This will give failure error message if in case wallet Element could not update - (void)didFailtoUpdateWalletElement:(VMaxWalletElement*)walletElement withError:(NSError*)error; // Obj-C func didFailtoUpdateWalletElement(walletElement: VMaxWalletElement!, withError error: NSError!) // Swift // Other API's // This will return total currency remaning in wallet element [self.walletElement getTotalCurrency]; // Obj-C walletElement.getTotalCurrency() // Swift // This will spend/deduct virtual currency of that wallet element [self.walletElement spendVirtualCurrency:<"any long data type value as virtual currency to spend">]; // Obj-C walletElement.spendVirtualCurrency(<"any long data type value as virtual currency to spend">) // Swift // This will add/award virtual currency of that wallet Element [self.walletElement awardVirtualCurrency:<"any long data type value as virtual currency to award">]; // Obj-C walletElement.awardVirtualCurrency(<"any long data type value as virtual currency to spend">) // Swift |
Create Rewarded Video instance
The VMAX SDK allows you to pass extra data that is then available in a postback URL. Visit the VMAX Control Panel and enter the postback URL in Settings >> Apps and Adspots >> Rewarded Video Adspots. Once you define the key value pairs here, and configure the postback URL, you will get these keys and values as additional URL parameters on your server.
|
1 2 3 4 5 6 7 8 |
//Initialization self.rewardedVideo = [[VMaxRewardedVideo alloc] initWithWalletElement:self.walletElement]; [self.rewardedVideo setCustomData:[NSDictionary dictionaryWithObjectsAndKeys:@"value",@"key", nil]]; //Conform to delegates self.rewardedVideo.delegate = self; //Set rewarded video object to the adview (MUST!). This should be done before calling loadAd() and cacheAd() [adView setRewardedVideo:rewardedVideo]; |
|
1 2 3 4 5 6 7 |
//Conform to delegates let rewardedVideo : VMaxRewardedVideo = VMaxRewardedVideo(walletElement: walletElement) // init rewardedVideo.delegate = self self.rewardedVideo?.setCustomData(["key":"value"]); //Set rewarded video object to the adview (MUST!). This should be done before calling loadAd() and cacheAd() adView?.setRewardedVideo(rewardedVideo) |
Rewarded Video Callbacks
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 |
// Called when reward video was interrupted - (void)adView:(VMaxAdView *)theAdView didInterruptRewardVideo:(NSString *)message; // Obj-C func adView(theAdView: VMaxAdView!, didInterruptRewardVideo message: String!) // Swift // Called when RewardVideo Failed to Playback with Error - (void)adView:(VMaxAdView *)theAdView didFailedToPlaybackRewardVideo:(NSError*)error; // Obj-C func adView(theAdView: VMaxAdView!, didFailedToPlaybackRewardVideo error: NSError!) // Swift // Called when Reward Video completed play back - (void)adView:(VMaxAdView *)theAdView didCompleteRewardVideo:(NSInteger)rewardAmount; // Obj-C func adView(theAdView: VMaxAdView!, didCompleteRewardVideo rewardAmount: Int) // Swift // Called before showing Prepopup - (void)willShowRewardedVideoPrepopUp; // Obj-C func willShowRewardedVideoPrepopUp() // Swift // Called before showing Postpopup - (void)willShowRewardedVideoPostpopUp; // Obj-C func willShowRewardedVideoPostpopUp() // Swift // Called before showing FillpopUp - (void)willShowRewardedVideoNoFillpopUp; // Obj-C func willShowRewardedVideoNoFillpopUp() // Swift // Called before showing ImpressionCappopUp - (void)willShowRewardedVideoImpressionCappopUp; // Obj-C func willShowRewardedVideoImpressionCappopUp() // Swift // Called before showing InterruptedpopUp - (void)willShowRewardedVideoAdInterruptedpopUp; // Obj-C func willShowRewardedVideoAdInterruptedpopUp() // Swift |
Enable or disable rewarded video popup
|
1 2 3 4 5 6 7 |
rewardedVideo.shouldShowNoFillPopup // NoFillPopup rewardedVideo.shouldShowPostPopup // PostPopup rewardedVideo.shouldShowPrePopup // PrePopup rewardedVideo.shouldShowInterruptPopup // InterruptPopup rewardedVideo.shouldShowMaxImpressionCapPopup // Impression popup Note:By default all pop-ups are enabled. |
Customise a rewarded video popup
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 |
// Set custom title & message to rewarded video pre-dialog [rewardedVideo setPrePopUpWithTitle:@"Watch Video" message:@"Watch video and get <rewardAmt> <currencyName>"] // Obj-C rewardedVideo.setPrePopUpWithTitle(title: "Watch Video", message: "Watch video and get <rewardAmt> <currencyName>") // Swift // Set custom title & message to rewarded video post-dialog [rewardedVideo setPostPopUpWithTitle:@"Video Complete" message:@"You have received <rewardAmt> <currencyName>"] // Obj-C rewardedVideo.setPostPopUpWithTitle(title: "Video Complete", message: "You have received <rewardAmt> <currencyName>") // Swift // Set custom title & message to rewarded video interrupt-dialog [rewardedVideo setInterruptPopUpWithTitle:@"Video Interrupted" message:@"You might lose your reward. Are you sure you want to skip?"]; // Obj-C rewardedVideo.setInterruptPopUpWithTitle(title: "Video Interrupted", message: "You might lose your reward. Are you sure you want to skip?") // Swift // Set custom title & message to rewarded video no-fill-dialog [rewardedVideo setNoFillPopUpWithTitle:@"No Fill" message:@"No Video available at the moment!"]; // Obj-C rewardedVideo.setNoFillPopUpWithTitle(title: "No Fill", message: "No Video available at the moment!") // Swift // Set custom title & message to rewarded video max-impression-cap-dialog [rewardedVideo setMaxImpressionCapPopUpWithTitle:@"Max Impression" message:@"Impression Cap Reached"]; // Obj-C rewardedVideo.setMaxImpressionCapPopUpWithTitle(title: "Max Impression", message: "Impression Cap Reached") // Swift |
Postback URL for rewarded videos
To add the postback URL for rewarded videos, visit Settings >> Apps and Adspots >> Rewarded Video Adspots