Release version: 2.14.2 | Release date: 11 .06.2021

HIGH-LEVEL Integration steps:
     Step 1: Import SDK
     Step 2: Project configuration
     Step 3: Initialize SDK
     Step 4: Configure ad types  

Use these instructions to integrate the Appodeal SDK with your application. 

Step 1. Import SDK

1.1 Download Appodeal SDK 2.14.2  that includes the newest Android and iOS Appodeal SDK with major improvements.

Unity Plugin 2.14.2

1.2 To import the Appoeal Unity plugin, double-click on the Appodeal-Unity-Plugin-2.14.2-11.06.2021 .unitypackage , or go to   Assets → Import Package → Custom Package . Keep all the files in the Importing Package window selected, and click Import .

Step 2. Project configuration

2.1 Android configuration

1. Gradle Settings 

1.1 Enable flag Custom Gradle Template for Unity 2017.4 - Unity 2019.2 versions or Custom Base Gradle Template for Unity 2019.3 or higher versions in Player Settings/Publishing Settings

1.2  Change classpath 'com.android.tools.build:gradle:3.4.0' to 'com.android.tools.build:gradle:3.4.3' in Custom Gradle Template file (path - Assets/Plugins/Android/mainTemplate.gradle) for Unity 2017.4 - Unity 2019.4 versions.

      Change classpath 'com.android.tools.build:gradle:3.6.0' to 'com.android.tools.build:gradle:3.6.4' in Custom Base Gradle Template file (path - Assets/Plugins/Android/baseProjectTemplate.gradle) for Unity 2020.1 or higher versions.
      

2. External Dependency Manager (Play Services Resolver)

Appodeal plugin includes External Dependency Manager package.  You need to complete these following steps to resolve Appodeal's dependencies:

1. After the import Appodeal Unity Plugin, in the Unity editor select File → Build Settings → Android.

2. Add flag Custom Gradle Template (Build Settings → Player Settings → Publishing settings).

3. Enable the setting "Patch mainTemplate.gradle" (Assets → External Dependency Manager → Android Resolver → Settings).

4. Enable the setting "Use Jetifier" (Assets → External Dependency Manager → Android Resolver → Settings).

5. Then run Assets → External Dependency Manager → Android Resolver and press Resolve or Force Resolve.

6. As a result, the modules, that are required for the Appodeal SDK support, will be imported to project's mainTemplate.gradle file.

3. Configure AndroidManifest.xml

For the Appodeal SDK to work correctly, you need to add permissions to AndroidManifest.
We distinguish 2 sets of permissions: required permissions, without which the Appodeal SDK cannot work, and optional permissions, which are needed to improve targeting.For more information about the purpose of each of the permissions, see the  FAQ  section.

• Add required permissions to your AndroidManifest.xml file under manifest tag:

<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.INTERNET" />

• Add optional permissions to your  AndroidManifest.xml  file under  manifest  tag to improve ad targeting:

<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
<uses-permission android:name="android.permission.VIBRATE" />

<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION"
	tools:node="remove" />
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION"
	tools:node="remove" />

4. Request runtime permissions in Android Marshmallow (API 6.0+)

Extend your class with IPermissionGrantedListener :

YourClassName : IPermissionGrantedListener;

Appodeal.requestAndroidMPermissions(this);

public void writeExternalStorageResponse(int result) { 
  if(result == 0) {
    Debug.Log("WRITE_EXTERNAL_STORAGE permission granted"); 
  } else {
    Debug.Log("WRITE_EXTERNAL_STORAGE permission grant refused"); 
  }
}
public void accessCoarseLocationResponse(int result) { 
  if(result == 0) {
    Debug.Log("ACCESS_COARSE_LOCATION permission granted"); 
  } else {
    Debug.Log("ACCESS_COARSE_LOCATION permission grant refused"); 
  }
}

5. Disable permissions check

You can disable the check of optional permissions to avoid displaying in the logs that the permissions were not granted.

To disable toast message "ACCESS_COARSE_LOCATION permission is missing", use the following method before the SDK initialization:

Appodeal.disableLocationPermissionCheck();

Appodeal.disableWriteExternalStoragePermissionCheck();

6. Multidex support

• If you are using Unity 2019.2 and versions below you need to add multidex support to your project. Follow this guide to add Multidex.

2.2 iOS configuration

1. Play Services Resolver

Appodeal plugin includes Play Services Resolver package.  You need to complete these following steps to resolve Appodeal's dependencies:

1. After the import Appodeal Unity Plugin, in the Unity editor select File → Build Settings → iOS.

2. During build a project the modules, that are required for the Appodeal SDK support, will be imported to your project. You can edit them or add other modules in the Assets → Appodeal → Editor → AppodealDependencies.xml file.

2. Add SKAdNetworkIds

Ad networks used in Appodeal mediation support conversion tracking using Apple's SKAdNetwork , which means ad networks are able to attribute an app install even when IDFA is unavailable. To enable this functionality, you will need to update the SKAdNetworkItems key with an additional dictionary in your  Info.plist .

1. Select Info.plist in the Project navigator in Xcode
2. Click the Add button (+) beside a key in the property list editor and press Return
3. Type the key name SKAdNetworkItems
4. Choose an Array  type
5. Add Key-Value pair where the key is SKAdNetworkIdentifier and the value is the ad network identifier

There is SKAdNetworks IDs in  Info.plist format:

3. Configure App Transport Security Settings

In order to serve ads, the SDK requires you to allow arbitrary loads. Set up the following keys in info.plist of your app:

1. Go to your info.plist  file, then press  Add+ anywhere in the first column of the key list.
2. Add App Transport Security Settings key  and set its type to  Dictionary in the second column.
3. Press Add+  at the end of the name  App Transport Security  Settingske y 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>

4. Other feature usage descriptions

To improve ad performance the the following entries should be added:

1. GADApplicationIdentifier - When including AdMob in your project you must also add your AdMob app ID to your info.plist . Use the key GADApplicationIdentifier with the value being your AdMob app ID. (Will be added automatically during the next step “Admob Configuration”.)
2. NSUserTrackingUsageDescription - As of iOS 14 using IDFA requires permission from the user. The following entry must be added in order to improve ad performance.
3. NSLocationWhenInUseUsageDescription - Entry is required if your application allows Appodeal SDK to use location data.
4. NSCalendarsUsageDescription - Recommended by some ad networks.
   
   

<key>GADApplicationIdentifier</key> 
<string>YOUR_ADMOB_APP_ID</string>
<key>NSUserTrackingUsageDescription</key>
<string><App Name> needs your advertising identifier to provide personalised advertising experience tailored to you</string>
<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>

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.3 Admob configuration 

Add AdMob App Ids from the Unity Menu bar Appodeal → Appodeal Settings tool for each platform. 

AdMob App ID is the unique ID assigned to your app. 
To find the AdMob App ID in your AdMob account, go to Apps → your application → app settings and copy the AdMob App ID

Step 3. Initialize SDK

Before starting to load ads, you need to initialize the Appodeal SDK, as follows:

1. Import the namespaces:

using AppodealAds.Unity.Api;
using AppodealAds.Unity.Common;

2.  Add the following code within the  Start()  method of your main scene’s MonoBehavior:  

Appodeal.initialize("YOUR_APPODEAL_APP_KEY", adTypes, consentValue);

Use the type codes below to set the preferred ad format:

• Appodeal.INTERSTITIAL for interstitial.
• Appodeal.REWARDED_VIDEO for rewarded videos.
• Appodeal.NON_SKIPPABLE_VIDEO for non-skippable videos.
• Appodeal.BANNER for banners.
• Appodeal.MREC for 300*250 banners.

Step 4. Configure ad types

For completing implementation integrate showing of ad types to your application.