1.1 Introduction

Integration of this SDK gives the publisher the capability to call playable ads from ZPLAY Ads into available interstitial iOS inventory globally. This guide is designed for developers who are going to integrate the ZPLAY Ads SDK into their iOS Apps via Xcode.

Please contact support@zplayads.com if you need any assistance in this work.

1.2 Development Environment

1.3 ZPLAY Ads Account Requirements

An account is required on our platform before SDK integration can be completed. The following App specific data items are the minimum needed to proceed.

2.1 Install Cocoapods

sudo gem install cocoapods

2.2 Create Podfile

In Terminal, switch to root folder of your iOS project, and create a Podfile there.

pod init

2.3 Add Playable Ads SDK into your Podfile

pod 'PlayableAds'

2.4 Install Playable Ads SDK

pod install

3.1 Initialize SDK

To pre-load an ad may take several seconds, so it’s recommended to initialize the SDK and load ads as early as possible. When you initialize the SDK, you need to provide your APPID and adUnitID (as previously registered on ZPLAYAds.com) into the marked places.

@import PlayableAds;
@interface ViewController () 

// creat and pre-load ad
- (PlayableAds *)createAndLoadPlayableAds {
    PlayableAds *ad = [[PlayableAds alloc] initWithAdUnitID:@"Your Ad-Unit-ID" appID:@"Your App-ID" rootViewController:self];
    ad.delegate = self;
    [ad loadAd];
    
    return ad;
}

3.2 Ad ready for display?

You can judge the availability of an ad by this callback. Then you’ll be able to manage your game’s settings according to the ad being ready or not.

- (void)playableAdsDidLoad:(PlayableAds *)ads {
    NSLog(@"playable ads did load");
}

3.3 Show Ads

When an ad is ready to display, you can show it using following method.

// Show an ad
- (void)showAd {
    // ad is not ready, do nothing
    if (!self.ad.ready) {
        return;
    }
    
    // show the ad
    [self.ad present];
}

3.4 Obtain Rewards

To use ZPLAY Ads as a rewarded ad, it’s very important to give the reward properly. To do so, please use the following callback code.

#pragma mark - PlayableAdsDelegate
// Give rewards, use this to judge if the reward should be given. 
- (void)playableAdsDidRewardUser:(PlayableAds *)ads {
    NSLog(@"playable ads did reward");
}

#import "ViewController.h"

@import PlayableAds;

@interface ViewController () 

@property (nonatomic) PlayableAds *ad;

@end

@implementation ViewController

- (void)viewDidLoad {
    [super viewDidLoad];
    // Do any additional setup after loading the view, typically from a nib.
    
    // preload ad
    self.ad = [self createAndLoadPlayableAds];
}

- (PlayableAds *)createAndLoadPlayableAds {
    PlayableAds *ad = [[PlayableAds alloc] initWithAdUnitID:@"Your Ad-Unit-ID" appID:@"Your App-ID" rootViewController:self];
    ad.delegate = self;
    [ad loadAd];
    
    return ad;
}

- (void)showAd {
    // ad is not ready, do nothing
    if (!self.ad.ready) {
        return;
    }
    
    // show the ad
    [self.ad present];
}

#pragma mark - PlayableAdsDelegate
- (void)playableAdsDidRewardUser:(PlayableAds *)ads {
    NSLog(@"playable ads did reward");
}

- (void)playableAdsDidLoad:(PlayableAds *)ads {
    NSLog(@"playable ads did load");
}

- (void)playableAdsDidFailToLoadWithError:(NSError *)error {
    NSLog(@"playable ads did fail to load: %@", error);
    
    // preload ad after previous ad request failed for 5 seconds
    __weak typeof(self) weakSelf = self;
    dispatch_after(dispatch_time(DISPATCH_TIME_NOW, (int64_t)(5 * NSEC_PER_SEC)), dispatch_get_main_queue(), ^{
        weakSelf.ad = [weakSelf createAndLoadPlayableAds];
    });
}

- (void)playableAdsWillPresentScreen:(PlayableAds *)ads {
    NSLog(@"playable ads will present screen");
}

- (void)playableAdsDidPresentScreen:(PlayableAds *)ads {
    NSLog(@"playable ads did present screen");
}

- (void)playableAdsDidStartPlaying:(PlayableAds *)ads {
    NSLog(@"playable ads did start playing");
}

- (void)playableAdsDidEndPlaying:(PlayableAds *)ads {
    NSLog(@"playable ads did end playing");
}

- (void)playableAdsDidPresentLandingPage:(PlayableAds *)ads {
    NSLog(@"playable ads did present landing page");
}

- (void)playableAdsWillDismissScreen:(PlayableAds *)ads {
    NSLog(@"playable ads will dismiss screen");
}

- (void)playableAdsDidDismissScreen:(PlayableAds *)ads {
    NSLog(@"playable ads did dismiss screen");
    
    // preload ad right after previous ad is dismissed
    self.ad = [self createAndLoadPlayableAds];
}

- (void)playableAdsLandingPageDidClick:(PlayableAds *)ads {
    NSLog(@"playable ads landing page did click");
}

- (void)playableAdsWillLeaveApplication:(PlayableAds *)ads {
    NSLog(@"playable ads will leave application");
}

@end