This SDK creates an interface for you to use the SDK of different advertising agencies so that you do not need to change your code that you have implemented within your game logic if you need to change your advertising agency. This SDK currently supports 3 different advertising agencies (AdMob, Tapsell and TapsellPlus)

Advantages:

1. Designing an interface for the entire Ad Agencies so that the maximum possibilities of these services are covered and at the same time everyone follows a single interface
2. Minimize code changes when replacing Ad Agency
3. Integrate multiple Ad Agencies with just one implementation
4. Can be used in Distributed Build System to use different Ad Agencies for different releases

This system has three stages in its life cycle, which I will explain in order:

Build --> Initial --> GetAdUnit

In this step you need to create an object of type IAdManager through the AdBuilder class to access the Ad Agency API through this object.

You must first provide Ad information to the AdBuilder class, as in the following code example:

public class AdsTest: MonoBehaviour {

  private IAdManager _adManager = null;
  
  //...

  private void InitialAdManager() {
      var builder = new AdBuilder();

      _adManager = builder
          .SetAppId(AdAgency.AdMob         , "<AdMobAppId>")
          .SetAppId(AdAgency.Tapsell       , "<TapsellAppId>")
          .SetAppId(AdAgency.TapsellPlus   , "<TapsellPlusAppId>")

          .SetZoneId(AdAgency.AdMob,      TEST_ZONE_NAME, "<AdMobZoneId>")
          .SetZoneId(AdAgency.Tapsell,    TEST_ZONE_NAME, "<TapsellZoneId>")
          .SetZoneId(AdAgency.TapsellPlus,TEST_ZONE_NAME, "<TapsellPlusZoneId>")

          .Build();
  }

//...
}

Notice 1-1:

The Build stage only needs to happen once when the game is run and after calling AdBuilder.Build(), you create a IAdManager component whose reference is stored in the static variable AdBuilder.CurrentAdManager.

//This static variable is set after calling AdBuilder.Build()
AdBuilder.CurrentAdManager

Notice 1-2:

It is better to perform this step in a separate Scene that is loaded only once in the game.

Before using any of the IAdManager object methods, We must first initialize the ad manager via the IAdManager.Init() method. after initializing analytics services you can get basic metrics (such as retuntion or session length) in any analytics you initialized.

public class AdsTest: MonoBehaviour {

    private IAdManager _adManager = null;
    
    void Start() {
      _adManager = AdBuilder.CurrentAdManager;
      _adManager.Init();
    }
}

There are several ways to display ads, including Rewarded Video Ad, Interstitial Ad and Native Banner, each of which we call Ad Unit. This section teaches how to implement each of these Ad Units.

Only two types of Rewarded video ads and Interstitial ads are supported in this SDK.

Get an IRewardedAd Object:

IAdManager adManager = AdBuilder.CurrentAdManager;
IRewardedAd rewardedAd = adManager.GetRewardedAd("ZoneName");

IRewardedAd Methods:

// Sends request to get rewarded ad and load it
void Load();

// Show loaded ad
void Show();

IRewardedAd Events:

// Fired after ad loaded successfully
event EventHandler<EventArgs>           OnLoaded;

// Fired after ad starts playing
event EventHandler<EventArgs>           OnStarted;

// Fired after ad playing ad closed by user
event EventHandler<EventArgs>           OnClosed;

// Fired after fails to load or show ads
event EventHandler<AdErrorEventArgs>    OnError;

// Fired after leaving the application by the user in the middle of the ad play (only works on AdMob)
event EventHandler<EventArgs>           OnLeavingApplication;

// Fired after the end of the rewarded ad by the user
event EventHandler<AdRewardEventArgs>   OnEarnedReward;

Get an IInterstitialAd Object:

IAdManager adManager = AdBuilder.CurrentAdManager;
IInterstitialAd interstitialAd = adManager.GetInterstitialAd("ZoneName");

IInterstitialAd Methods:

// Sends request to get interstitial ad and load it
void Load();

// Show loaded ad
void Show();

IInterstitialAd Events:

// Fired after ad loaded successfully
event EventHandler<EventArgs>           OnLoaded;

// Fired after ad starts playing
event EventHandler<EventArgs>           OnStarted;

// Fired after ad playing ad closed by user
event EventHandler<EventArgs>           OnClosed;

// Fired after fails to load or show ads
event EventHandler<AdErrorEventArgs>    OnError;

// Fired after leaving the application by the user in the middle of the ad play (only works on AdMob)
event EventHandler<EventArgs>           OnLeavingApplication;

In the Sample Directory there is a complete example of how to use the SDK that you can use.

In this SDK, a common interface is designed for several advertising agencies, to activate each of these advertising agencies, you must do the following two steps.

In this step, you must first configure the SDK of the desired advertising agency, which you can do through the following links:

AdMob Configuration

Tapsell Configuration

Tapsell Plus Configuration

Notice:

This step is only related to import Unity Package and resolve the required android plugins and you do not need to write any code, the codes are already implemented in the SDK.

First, go to the following path in the Unity engine:

File > Build Settings > Player Settings > Player > Other Settings > Scripting Define Symbols

Then in this path, define the specific symbol of that ad agency according to the table:

This step causes only the code related to that release to be used in your final build.