iOS SDK Integration Version 2.40.1 – AerServ

Requirements

iOS Version 7.0+
Xcode 8

Step 1: Integrating the SDK

AerServ offers 2 options for integration:

1-1. CocoaPods

In the same directory as your YOUR_PROJECT.xcodeproj, create an empty file named Podfile and copy and paste the following:

source 'https://bitbucket.org/aerservllc/ios-sdk-pod.git'

platform :ios, '7.0'
pod 'ios-sdk-pod'

Ensure your project has been closed. Using the terminal, navigate to the directory containing the Podfile and run the command: pod install. Once the installation finishes, use YOUR_PROJECT.xcworkspace to access your project moving forward.

Inside the xcworkspace there should be a Pods directory included with a ios-sdk-pod sub-directory.

Additional Build Settings that need to be configured are as follows:

Set "Enable Bitcode" inside the Build Options section to NO.

Inside your application's Info.plist, add the following keys with short descriptions of usage.

NSLocationWhenInUseUsageDescription: Location is used to help target content to your general area

1-2. Static Integration

Step 2: Initializing AerServSDK

Initializing AerServSDK will update server-side configurations and additionally initialize any mediated ad sources.

Within the AerServ dashboard, click on the inventory tab and edit the specific application that is being integrated. There will be an App ID associated to that application. Use that App ID to call AerServSDK's initializeWithAppID: in the early phases of the application. Suggested place to kick off the initialization process is in the application's AppDelegate inside the application:didFinishLaunchingWithOptions: method.

#import <AerServSDK/AerServSDK.h>
...
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {    
    ...
    // initialize AerServSDK with an App ID
    [AerServSDK initializeWithAppID:@"1000473"]; // replace 1000473 with your appliciation's App ID
    ...
    return YES;
}

Step 3: Display Banner Ads

Create an ASAdView object by passing in a placement setup on the AerServ dashboard as well as the banner's size. Refer to ASAdView.h for AerServSDK's predefined sizes.

#import <AerServSDK/AerServSDK.h>
...
ASAdView *asAdView = [ASAdView viewWithPlacementID:@"1024876" andAdSize:ASBannerSize];

Add the ASAdView object to your application's view.

[self.view addSubview:asAdView];

In the view controller that the ASAdView object is added to, make sure that the view controller adheres to the ASAdViewDelegate protocol. Additionally, add the callback viewControllerForPresentingModalView that will return itself.

@interface ViewController() <ASAdViewDelegate>
...
- (UIViewController*)viewControllerForPresentingModalView {
    return self;
}

Lastly, kick off the ad request by loading the ad.

[asAdView loadAd];

Additional Banner Callbacks

You can additionally assign a delegate to listen for the banner's callback events. A few of the callbacks that can be listened to are:

- (void)adViewDidLoadAd:(ASAdView *)adView;
- (void)adViewDidPreloadAd:(ASAdView *)adView;
- (void)adViewDidFailToLoadAd:(ASAdView *)adView withError:(NSError *)error;
- (void)adWasClicked:(ASAdView *)adView;

Please refer to ASAdView.h for all available callbacks and descriptions of each. Settings for supplying ad targeting key words, specifying the banner refresh time interval, preloading, and more can be found in the ASAdView header as well.

Step 4: Displaying Interstitial Ads

Create an ASInterstitialViewController object with a placement setup on the AerServ dashboard and a delegate that conforms to ASInterstitialViewControllerDelegate.

#import <AerServSDK/AerServSDK.h>
...
@interface ViewController() <ASInterstitialViewControllerDelegate>

@property (nonatomic, strong) ASInterstitialViewController *asInterstitialVC;
...
self.asInterstitialVC = [ASInterstitialViewController viewControllerForPlacementID:@"1000741" withDelegate:self];

Start the ad request by loading an ad with your specified settings.

[self.asInterstitialVC loadAd];

When the ad is ready, a callback event will be triggered. From the callback, the interstitial ad can be shown from a parent view controller.

- (void)interstitialViewControllerAdLoadedSuccessfully:(ASInterstitialViewController *)viewController {
	[viewController showFromViewController:aViewController];
}

Optional Interstitial Steps

Preloading Interstitial Ads

Preloading an ad works in a similar fashion. Before loading the ad, the isPreload flag should be set to YES. Another callback event can be listened to for notification that a preloaded ad is ready to be shown.

@property (nonatomic, assign) BOOL didPreload;
...
self.didPreload = NO;
self.asInterstitialVC.isPreload = YES;
[self.asInterstitialVC loadAd];
...
- (void)interstitialViewControllerDidPreloadAd:(ASInterstitialViewController *)viewController {
	NSLog(@"---- Interstitial View Controller Did Preload Ad");
	self.didPreload = YES;
}
...
if(self.didPreload)
	[self.asInterstitialVC showFromViewController:aViewController];

Additional Interstitial Callbacks

Other callback events that can be listened to are:

- (void)interstitialViewControllerWillAppear:(ASInterstitialViewController *)viewController;
- (void)interstitialViewControllerDidAppear:(ASInterstitialViewController *)viewController;
- (void)interstitialViewControllerWillDisappear:(ASInterstitialViewController *)viewController;
- (void)interstitialViewControllerDidDisappear:(ASInterstitialViewController *)viewController;
- (void)interstitialViewControllerAdWasTouched:(ASInterstitialViewController *)viewController;
- (void)interstitialViewControllerAdFailedToLoad:(ASInterstitialViewController *)viewController withError:(NSError *)error;

Please refer to ASInterstitialViewController.h for all available callbacks and descriptions for each. Settings for supplying ad targeting key words, video player controls, and more can be found in the ASInterstitialViewController header as well.

Additional Settings

Header Bidding Requests

Both banners and interstitials have the ability to initiate header bidding requests.

asAdView.useHeaderBidding = YES;
...
[asAdView loadAd];

asInterstitialVC.useHeaderBidding = YES;
...
[asInterstitialVC loadAd];

Pausing & Resuming Video Ads

Both banners and interstitials have the ability to pause and resume play of VAST video ads.

[asAdView pause];
...
[asAdView play];

[asInterstitialVC pause];
...
[asInterstitialVC play];

Virtual Currency

Once you have setup your placement with virtual currency, there are two additional callbacks that conform to the protocol ASInterstitialViewControllerDelegate. The first callback will notify that the virtual currency data has loaded.

- (void)interstitialViewControllerDidVirtualCurrencyLoad:(ASInterstitialViewController *)viewController vcData:(NSDictionary *)vcData;

The second callback will notify when the virtual currency has been rewarded.

- (void)interstitialViewControllerDidVirtualCurrencyReward:(ASInterstitialViewController *)viewController vcData:(NSDictionary *)vcData;

For both of these callbacks, there is a vcData dictionary object attached that will contain the keys 'name' and 'rewardAmount'. In lieu of 5-2, the dictionary object returned during the virtual currency load also contains the keys 'buyerName' and 'buyerPrice' in regards to the ad's transaction information.

Ad Transaction Information

During the process of showing an ad, the AerServSDK will additionally return information pertaining to the buyer for your ad space and the price that the ad space was bought for. This detailed information can be found from these callbacks:

For banners:

- (void)adView:(ASAdView *)adVidew didShowAdWithTransactionInfo:(NSDictionary *)transcationData;

For interstitials:

- (void)interstitialViewController:(ASInterstitialViewController *)viewController didShowAdWithTransactionInfo:(NSDictionary *)transcationData;

The transactionData dictionary object contains keys for 'buyerName' and 'buyerPrice' that can be accessed for the transaction information values.

As mentioned in 5-1, the transaction information is available for interstitial ads at load if virtual currency is enabled through the virtual currency load callback.

Adding Keyword Tagging

For details about keyword tagging, click here.

Additional keyword tagging to your ad request can be done by assigning an array of strings to the keyWords property. This can be done for both interstitials and banners.

asAdView.keyWords = @[@"banner", @"key", @"word", @"tagging"];
...
asInterstitialVC.keyWords = @[@"interstitial", @"key", @"word", @"tagging"];

Adding Publisher Keys

For details about publisher keys, click here.

Custom revenue reports can be generated via the SDK by assigning a dictionary object with publisher key value pairs to the pubKeys property. This is available for both interstitials and banners.

asInterstitialVC.pubKeys = @{@"channel_category" : @"music", @"content_rating" : @"4 stars"};
...
asAdView.pubKeys = @{@"partner_name" : @"bloomberg", @"episode_id" : @"77889"}

Enabling Geolocation Targeting

If your application already requests permission for geolocation, skip this step.

Enabling geolocation will help target ads relevant to your user's physical location. This can be done by adding key-value pairs to your application's Info.plist. The keys will be NSLocationAlwaysUsageDescription & NSLocationWhenInUseUsageDescription. The value for both will be a string that will be displayed when your application is requesting for geolocation permission.

<key> NSLocationAlwaysUsageDescription </key> 
<string> Location is used to help target content to your general area </string>
<key> NSLocationWhenInUseUsageDescription </key> 
<string> Location is used to help target content to your general area </string>

Disabling App Transport Security for iOS 9+

Select your application's Info.plist, right-click on it and open as source code. Copy the following code into your Info.plist's xml.

<key> NSAppTransportSecurity </key>
<dict>
	<key> NSAllowsArbitraryLoads </key>
        <true/> 
</dict>

Version History

View iOS Version History

Comments