Unity Plugin Integration

Table of Contents

 

 

1. Unity Integration

---

 

 

 

Download Unity Plugin

Download InMobi iOS Mediation SDK

Download InMobi Android Mediation SDK

 

1. Open your project in the Unity editor.

2. Select Assets > Import Package > Custom Package, and then find the aerserv-unity-plugin.unitypackage file you downloaded.

3. Make sure all the files are selected, and then click Import.

 

 

1. Create a new Unity project.
2. Import the AerServ Unity platform plugin.

3. Open File > Build Settings and add DemoAppStart, ASIntegration and InmobiIntegration scenes in Scenes In Build section.

4. Continue to Step 2: Building the Project for iOS to build the Sample App for iOS.
5. Continue to Step 3: Building the Project for Android to build the Sample App for Android.

 

 

You must initialize our SDK.  We recommend that you invoke this initialization routine at least 10 seconds before you intend to show your first ad.

To initialize the SDK, invoke the following: 

    private void SDKInit()
    {
        // Initialize the SDK with siteID and gdpr Consent
        ASSdk.InitSDK(SITE_ID, true);
        // Set the log level to see logs
        ASSdk.EnableDebugLogs(true);

        MonoBehaviour.print("SDK Initialised. The version of the SDK is " + ASSdk.GetSdkVersion());
    }

 

The second parameter is a GDPR consent, please check Setting GDPR Information section for more information.

How to obtain the app ID:

1. Log on to the AerServ platform.
2. Go to the 'Inventory' tab in the top navigation bar.
3. Click the 'Edit' icon next to the app whose ID you wish to obtain.
4. You will find the app ID at the very top of the page.

 

 

Create Banner

The first step toward displaying a banner is to create a ASBannerAd object in a C# script attached to a GameObject.

.....
using InMobiAds.Api;
...
public class AerServDemoIntegrationScript : MonoBehaviour
{
    private ASBannerAd aSBannerAd;

    private void RequestBanner()
    {
        String plId;

        #if UNITY_ANDROID
            plId = <ANDROID_PLC_ID>;
        #elif UNITY_IPHONE
            plId = <IOS_PLC_ID>;
        #endif

        // Create a 320x50 banner at the top of the screen.
        int width = 320;
        int height = 50;

        this.aSBannerAd = new ASBannerAd(plId, new AdSize(width, height), AdPosition.BottomCenter);

        // Turn on the banner refresh
        this.aSBannerAd.SetRefreshEnabled(true);

        // Set the refresh time interval
        this.aSBannerAd.SetRefreshInterval(20);

        // Load the banner ad
        this.aSBannerAd.Load();

        // Show the banner ad
        this.aSBannerAd.Show();
    }
}

 

Where adPosition is a predefined set of banner ad positions on the screen. You can only pass values available under AdPosition enum. Currently, we support:

• AdPosition.TopCenter
• AdPosition.BottomCenter
• AdPosition.TopLeft
• AdPosition.TopRight
• AdPosition.BottomLeft
• AdPosition.BottomRight
• AdPosition.Center

If you need to position banner ad at custom coordinates then you can use the below API to create a banner ad object.

this.aSBannerAd = new ASBannerAd(plId, new AdSize(width, height), positionX, positionY);

You can also set other properties like pubKeywords and debug like these:

this.aSBannerAd.SetDebug(true);
Dictionary<string, string> keywordsDictionary = new Dictionary<string, string>();
keywordsDictionary.Add("KEY",”VALUE”);
this.aSBannerAd.SetPubKeywords(keywordsDictionary);

Ad Events

To further customize the behavior of your ad, you can hook into a number of events in the ad's lifecycle: loading, opening, closing, and so on. Listen for these events by registering a delegate for the appropriate EventHandler, as shown below.

.....
using InMobiAds.Api;
...
public class AerServDemoIntegrationScript : MonoBehaviour
{
    private ASBannerAd aSBannerAd;

    private void RequestBanner()
    {
        String plId;

        #if UNITY_ANDROID
            plId = <ANDROID_PLC_ID>;
        #elif UNITY_IPHONE
            plId = <IOS_PLC_ID>;
        #endif

        // Create a 320x50 banner at the top of the screen.
        int width = 320;
        int height = 50;

        this.aSBannerAd = new ASBannerAd(plId, new AdSize(width, height), AdPosition.BottomCenter);

         // Set ad event listeners
         // Called when an ad successfully loaded
        aSBannerAd.OnAdLoadSucceeded += this.HandleOnAdLoadSucceeded; 
         // Called when an ad failed to load
        aSBannerAd.OnAdLoadFailed += this.HandleAdLoadFailed;
         // Called when the ad sends an ad impression
        aSBannerAd.OnAdImpression += this.HandleAdImpression;
         // Called when an ad is first fetched with the transaction information (buyer price, buyer name etc.). 
        aSBannerAd.OnAdLoadWithTransaction += this.HandleAdLoadWithTransaction;
        // Called when an ad is successfully shown, this method provides the transaction information (buyer price, buyer name etc.) of the Ad being shown.
        aSBannerAd.OnAdShowWithTransaction += this.HandleAdShowWithTransaction;
        // Called when an ad expanded to fullScreen.
        aSBannerAd.OnAdExpanded += this.HandleAdExpanded;
        // Called when an ad collapsed from fullScreen.
        aSBannerAd.OnAdCollapsed += this.HandleAdCollapsed;
        // Called when an ad is clicked.
        aSBannerAd.OnAdClicked += this.HandleAdClicked;
        // Called when the ad click caused the user to leave the application.
        aSBannerAd.OnUserLeftApplication += this.HandleUserLeftApplication;


        // Set the refresh time interval 
        this.aSBannerAd.SetRefreshInterval(20);

        // Load the banner ad
        this.aSBannerAd.Load();

        // Show the banner ad
        this.aSBannerAd.Show();

    }

    public void HandleOnAdLoadSucceeded(object sender, EventArgs args)
    {
        MonoBehaviour.print("AdLoadSucceeded");
    }

    public void HandleAdLoadFailed(object sender, AdLoadFailedEventArgs args)
    {
        MonoBehaviour.print("AdLoadFailed " + args.Error);
    }

    public void HandleAdImpression(object sender, EventArgs args)
    {
        MonoBehaviour.print("AdImpression");
    }

    public void HandleAdLoadWithTransaction(object sender, AdTransactionArgs args)
    {
        foreach (KeyValuePair<string, string> transactionDictionary in args.Transaction)
        {
            MonoBehaviour.print("transactionDictionary = " + transactionDictionary.Key + " and " + transactionDictionary.Value);
        }
    }

    public void HandleAdShowWithTransaction(object sender, AdTransactionArgs args)
    {
        foreach (KeyValuePair<string, string> transactionDictionary in args.Transaction)
        {
            MonoBehaviour.print("transactionDictionary = " + transactionDictionary.Key + " and " + transactionDictionary.Value);
        }
    }

    public void HandleAdExpanded(object sender, EventArgs args)
    {
        MonoBehaviour.print("AdExpanded");
    }

    public void HandleAdCollapsed(object sender, EventArgs args)
    {
        MonoBehaviour.print("AdCollapsed");
    }

    public void HandleAdClicked(object sender, EventArgs args)
    {
        MonoBehaviour.print("AdClicked");
    }

    public void HandleUserLeftApplication(object sender, EventArgs args)
    {
        MonoBehaviour.print("UserLeftApplication");
    }
}

Clean up banner ads

When you create the ASBannerAd object the banner is added into the view hierarchy, so when the object is not required anymore and you want to remove from view hierarchy then you need to call kill() on the banner object as follow.

 private void KillBanner()
 {
        this.aSBannerAd.Kill();
 }

 

Interstitial ads are full page ads placed at natural break points in the app flow. With 10 times the real estate as compared to banner ads, Interstitials are guaranteed to catch your user's’ eye and drive higher revenue for your mobile business.

Create an interstitial ad

ASInterstitialAd class allows you to create and display interstitial ads with the specified parameters. Please follow the below steps to integrate the Interstitial.

.....
using InMobiAds.Api;
...
public class AerServDemoIntegrationScript : MonoBehaviour
{
    private ASInterstitialAd aSInterstitialAd;

    private void RequestInterstitial()
    {
        String plId;

        #if UNITY_ANDROID
            plId = <ANDROID_PLC_ID>;
        #elif UNITY_IPHONE
            plId = <IOS_PLC_ID>;
        #endif

        //Create interstitial object
        this.aSInterstitialAd = new ASInterstitialAd(plId);

        // Load the interstitial ad.
        this.aSInterstitialAd.Load();
    }

}

 

You can set other properties like pubKeywords and debug as follows.

this.aSInterstitialAd.SetDebug(true);
Dictionary<string, string> keywordsDictionary = new Dictionary<string, string>();
keywordsDictionary.Add("KEY",”VALUE”);
this.aSInterstitialAd.SetPubKeywords(keywordsDictionary);

 

Ad events

To further customize the behavior of your ad, you can hook into a number of events in the ad's lifecycle: loading, opening, closing, and so on. Listen for these events by registering a delegate for the appropriate EventHandler, as shown below.

.....
using InMobiAds.Api;
...
public class AerServDemoIntegrationScript : MonoBehaviour
{
    private ASInterstitialAd aSInterstitialAd;

    private void RequestInterstitial()
    {
        String plId;

        #if UNITY_ANDROID
            plId = <ANDROID_PLC_ID>;
        #elif UNITY_IPHONE
            plId = <IOS_PLC_ID>;
        #endif
        
         //Create interstitial object
        this.aSInterstitialAd = new ASInterstitialAd(plId);

         
        // Called when an ad successfully loaded
        aSInterstitialAd.OnAdLoadSucceeded += this.HandleOnAdLoadSucceeded; 
        // Called when an ad failed to load
        aSInterstitialAd.OnAdLoadFailed += this.HandleAdLoadFailed;
        // Called when the ad sends an ad impression
        aSInterstitialAd.OnAdImpression += this.HandleAdImpression;
        // Called when an ad is first fetched with the transaction information (buyer price, buyer name etc.).
        aSInterstitialAd.OnAdLoadWithTransaction += this.HandleAdLoadWithTransaction;
        // Called when an ad is successfully shown, this method provides the transaction information (buyer price, buyer name etc.) of the Ad being shown.
        aSInterstitialAd.OnAdShowWithTransaction += this.HandleAdShowWithTransaction;
        // Called when an ad dismissed from fullScreen.
        this.aSInterstitialAd.OnAdDismissed += this.HandleAdDismissed;
        // Called when an ad is clicked.
        aSInterstitialAd.OnAdClicked += this.HandleAdClicked;
        // Called when the ad click caused the user to leave the application.
        aSInterstitialAd.OnUserLeftApplication += this.HandleUserLeftApplication;
        // Called when an ad with a virtual currency reward has loaded with reward information
        this.aSInterstitialAd.OnDidVirtualCurrencyLoad += this.HandleVirtualCurrencyLoaded;
        // Called when an ad with a virtual currency reward has been rewarded, it passes the reward information with the callback
        this.aSInterstitialAd.OnDidVirtualCurrencyReward += this.HandleVirtualCurrencyRewarded;

        // Load the interstitial ad.
        this.aSInterstitialAd.Load();

    }


    public void HandleOnAdLoadSucceeded(object sender, EventArgs args)
    {
        MonoBehaviour.print("AdLoadSucceeded");
    }

    public void HandleAdLoadFailed(object sender, AdLoadFailedEventArgs args)
    {
        MonoBehaviour.print("AdLoadFailed " + args.Error);
    }

    public void HandleAdImpression(object sender, EventArgs args)
    {
        MonoBehaviour.print("AdImpression");
    }

    public void HandleAdLoadWithTransaction(object sender, AdTransactionArgs args)
    {
        foreach (KeyValuePair<string, string> transactionDictionary in args.Transaction)
        {
            MonoBehaviour.print("transactionDictionary = " + transactionDictionary.Key + " and " + transactionDictionary.Value);
        }
    }

    public void HandleAdShowWithTransaction(object sender, AdTransactionArgs args)
    {
        foreach (KeyValuePair<string, string> transactionDictionary in args.Transaction)
        {
            MonoBehaviour.print("transactionDictionary = " + transactionDictionary.Key + " and " + transactionDictionary.Value);
        }
    }

    public void HandleAdExpanded(object sender, EventArgs args)
    {
        MonoBehaviour.print("AdExpanded");
    }

    public void HandleAdCollapsed(object sender, EventArgs args)
    {
        MonoBehaviour.print("AdCollapsed");
    }

    public void HandleAdClicked(object sender, EventArgs args)
    {
        MonoBehaviour.print("AdClicked");
    }

    public void HandleUserLeftApplication(object sender, EventArgs args)
    {
        MonoBehaviour.print("UserLeftApplication");
    }

    public void HandleAdDismissed(object sender, EventArgs args)
    {
        MonoBehaviour.print("AdDismissed");
    }

    public void HandleVirtualCurrencyLoaded(object sender, AdRewardsArgs args)
    {
        foreach (KeyValuePair<string, string> rewardDictionary in args.Reward)
        {
            MonoBehaviour.print("VirtualCurrencyLoaded RewardDictionary = " + rewardDictionary.Key + " and " + rewardDictionary.Value);
        }
    }

    public void HandleVirtualCurrencyRewarded(object sender, AdRewardsArgs args)
    {
        foreach (KeyValuePair<string, string> rewardDictionary in args.Reward)
        {
            MonoBehaviour.print("VirtualCurrencyRewarded RewardDictionary = " + rewardDictionary.Key + " and " + rewardDictionary.Value);
        }
    }
}

 

Show the Interstitial Ad

 

IOS

For good practice we recommended to show the interstitial ad after OnAdLoadSucceeded.

public void HandleOnAdLoadSucceeded(object sender, EventArgs args)
    {
        #if (UNITY_5 & UNITY_IOS) || UNITY_IPHONE
             this.aSInterstitialAd.Show();
        }
        #endif
        MonoBehaviour.print("AdLoadSucceeded");
    }

 

Android

For good practice we recommended to show the interstitial ad after AdLoadWithTransaction.

 public void HandleAdLoadWithTransaction(object sender, AdTransactionArgs args)
    {
        #if UNITY_ANDROID
             this.aSInterstitialAd.Show();
        }
        #endif

        
        foreach (KeyValuePair<string, string> transactionDictionary in args.Transaction)
        {
           MonoBehaviour.print("transactionDictionary = " + transactionDictionary.Key + " and " + transactionDictionary.Value);
        }

    }

 

 

The plugin expects the publisher to collect user consent from the consent gathering mechanism of his own, and the plugin provides these APIs to pass on this information to the SDK.

For setting GDPR and updating GDPR on AerServ SDK you can one of the following methods:

 

• At the time of initialization, you can set GDPR consent this way:

  
      ASSdk.InitSDK(siteId, true);
                    OR
      ASSdk.InitSDK(siteId, false);
      

  The second parameter of this method denotes the GDPR consent.

• After initialization of the SDK, you can update the GDPR consent this way:

  
      ASSdk.UpdateGdpr(true);
                    OR
      ASSdk.UpdateGdpr(false);
      

Note: If the user consent is available, then the publisher has to call the API with either a true value, or a false value. This is applicable for both these methods.

 

2. Building the Project for iOS

---

 

 

This can be done by going to File > Build Settings and select iOS as the platform. Click build and this should start Xcode.

 

 

In the project add InMobiSDK.framework with the following path  Frameworks/Plugins/iOS/Frameworks/InMobiSDK/InMobiSDK.framework.

From inside Xcode, add the [Project Path]/Plugins/iOS directory into Target > Build Setting > Framework Search Path.

 

 

Add the following libraries and frameworks to Target > Build Phases > Link Binary With Libraries:

• InMobiSDK.framework
• libxml2.2.tbd
• WebKit.framework

 

 

Turn bitcode off by going to Target > Build Settings > Bitcode Enabled and setting that to NO.

 

 

Add the following linker flags to Target > Build Settings > Linking > Other Linker Flags:

• -ObjC

 

 

Add the following entries to your Application’s info.plist: 

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

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

 

 

3. Building the Project for Android

---

  

 

Build the apk by going to File > Build Settings, select Android and click build. 

Follow Multidex support if required. 

  

 

4. Third Party Mediation Support in Unity

---

 

Only complete the following step as needed for third-party SDK mediation.