Integrate SDK

You can use our demo app as a reference project.

1. Prepare your app

Set up the following keys in info.plist of your app:

In order to serve ads, the SDK requires you to allow arbitrary loads.

1. Go to your info.plist file, then press Add+ anywhere in the first column of the key list.

2. Add App Transport Security Settingskey and set its type to Dictionary in the second column.

3. Press Add+ at the end of the name App Transport Security Settingskey and choose Allow Arbitrary loads. Set its type to Boolean and its value to Yes.

You can also add the key to your info.plist directly, using this code:

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

<key>GADApplicationIdentifier</key>
<string>YOUR_ADMOB_APP_ID</string>

2. Choose your integration type

Fat and CocoaPods 2.8.1-Beta versions work in pure Obj-C, in pure Swift, in mixed Obj-C, Swift projects.

sudo gem install cocoapods

rm -rf "${HOME}/Library/Caches/CocoaPods"
rm -rf "`pwd`/Pods/"
pod update

source 'https://github.com/appodeal/CocoaPods.git'
source 'https://cdn.cocoapods.org/'

3. Known issues

1. AdColony presentation issue

AdColony always checks, if the key window’s rootViewController matches the passed rootViewController. Otherwise, Adcolony fails to present the ad. If your app has multiple independent windows, you can get a message with this or similar text:

It means, that the rootViewController that was used in showAd, doesn't belong to the first window in the array. 

2. GoogleMobileAds issue

GoogleMobileAds will play music during ad downloading, if someone wants to change UserAgent on their custom UserAgent. The issue was detected in v. 7.33.1. This problem has not appeared in newer versions of the Google SDK (starting with v. 7.35.0), but then ads almost stop filling. 

Since GoogleMobileAds were updated to 7.42.0, you should add GADApplicationIdentifier in your's Info.plist. If you forget about it your application will fail with error:

3. AVAudioSession issue

If you use video or audio sessions in your app (usually for music players), you may encounter a problem with incorrect audio playback when loading an AdMob ad.
To solve this problem, add the following method to Your AppDelegate:

import GoogleMobileAds

final class AppDelegate ... {
    func application(_ application: UIApplication, 
                     didFinishLaunchingWithOptions launchOptions:[UIApplication.LaunchOptionsKey: Any]?) -> Bool {
        GADMobileAds.sharedInstance().audioVideoManager.audioSessionIsApplicationManaged = true
        return true
    }
}

#import <GoogleMobileAds/GoogleMobileAds.h>

@implementation AppDelegate
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    GADMobileAds.sharedInstance.audioVideoManager.audioSessionIsApplicationManaged = true;
    return YES;
}
@end

More info you can find here: https://developers.google.com/admob/ios/global-settings#changing_audio_session

4. Initialise SDK

Import Appodeal into AppDelegate (AppDelegate.m) class and initialize the SDK:

import Appodeal

#import <Appodeal/Appodeal.h>

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
        Appodeal.initialize(withApiKey: "YOUR_API_KEY", types: adTypes, hasConsent: consent)
        return true
    }

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    [Appodeal initializeWithApiKey:@"YOUR_API_KEY" types:(AppodealAdType)types hasConsent:consent];
    return YES;
}

consent is boolean, with 'false' meaning that the user declines to give the consent. Read our guide on collecting consent here.

Some of ad networks (eg Smaato, AmazonAd) can use IAB Consent framework 

Appodeal SDK does not modify any CMP keys in NSUserDefaults.


let report = STKConsentManager.shared().consent!
Appodeal.initialize(withApiKey: YOUR_APPODEAL_APP_KEY, types: adTypes, consentReport: report)

id<STKConsent> report = STKConsentManager.sharedManager.consent;
[Appodeal initializeWithApiKey:APP_KEY types:types consentReport:report];

Appodeal.initialize(withApiKey: YOUR_APPODEAL_APP_KEY, types: adTypes, hasConsent: consent)

[Appodeal initializeWithApiKey:APP_KEY types:types hasConsent:consent];

Publish your app

Before submitting your app to the App Store, you need to check the following settings.

1. Update Your IDFA Settings

When you submit your application to the App you need to update its "Advertising Identifier (IDFA)" settings in order to comply with Apple advertising policy.

1. Go to the Advertising Identifier section.

2. Set Yes on the right panel.

3. Tick Serve advertisements within the app.

4. Tick confirmation box under Limit Ad tracking setting in iOS.

2. Add usage descriptions to info.plist

If your app gets rejected by the App Store due to missing usage descriptions, add them to your info.plist file:

<key>NSLocationWhenInUseUsageDescription</key>
<string><App Name> needs your location for analytics and advertising purposes</string>
<key>NSCalendarsUsageDescription</key>
<string><App Name> needs your calendar to provide personalised advertising experience tailored to you</string>

It’s done!

You are ready to use Appodeal and implement ad types. If you have any questions, check out our FAQ or contact the support team.