Offerwall Integration for Unity Plugin

Get up and running with the Offerwall Ad Unit in 4 easy steps:

1. Implement the Offerwall Listener
2. Initialize the Offerwall Unit
3. Present the Offerwall
4. Reward the User

Step 1. Implement the Offerwall Listener

The ironSource Unity Plugin fires several events to inform you of ad availability. To receive these events, create an empty game object in each of your unity scenes and drag SupersonicEvents.cs into it.

Add the following code to register to the events:

public class VideoScript : MonoBehaviour {
void OnEnable() 
{
  SupersonicEvents.onOfferwallInitSuccessEvent += OfferwallInitSuccessEvent;
  
  SupersonicEvents.onOfferwallInitFailEvent += OfferwallInitFailEvent;
  
  SupersonicEvents.onOfferwallOpenedEvent += OfferwallOpenedEvent;
  
  SupersonicEvents.onOfferwallAdCreditedEvent += OfferwallAdCreditedEvent;
  
  SupersonicEvents.onOfferwallClosedEvent += OfferwallClosedEvent;
  
  SupersonicEvents.onOfferwallShowFailEvent += OfferwallShowFailEvent;
  
  SupersonicEvents.onGetOfferwallCreditsFailEvent += GetOfferwallCreditsFailEvent;
  }
}
view raw

Add the following code to stop listening to the events:

public class VideoScript : MonoBehaviour {
void OnDisable() 
{
  SupersonicEvents.onOfferwallInitSuccessEvent -= OfferwallInitSuccessEvent;
  
  SupersonicEvents.onOfferwallInitFailEvent -= OfferwallInitFailEvent;
  
  SupersonicEvents.onOfferwallOpenedEvent -= OfferwallOpenedEvent;
  
  SupersonicEvents.onOfferwallAdCreditedEvent -= OfferwallAdCreditedEvent;
  
  SupersonicEvents.onOfferwallClosedEvent -= OfferwallClosedEvent;
  
  SupersonicEvents.onOfferwallShowFailEvent -= OfferwallShowFailEvent;
  
  SupersonicEvents.onGetOfferwallCreditsFailEvent -= GetOfferwallCreditsFailEvent;
  }
}

The Plugin will notify the Listener of all possible events listed below:

/**
 * Invoked when the Offerwall is prepared an ready to be shown to the user
 */ 
void OfferwallInitSuccessEvent();
/**
 * Invoked when the Offerwall does not load for the user
 */ 
void OfferwallInitFailEvent(SupersonicError error);
/**
 * Invoked when the Offerwall successfully loads for the user.
 */ 
void OfferwallOpenedEvent();
/**
 * Invoked when the method 'showOfferWall' is called and the OfferWall fails to load.  //@param desc - A string which represents the reason of 'showOfferwall' failure.
 */
void OfferwallShowFailEvent(SupersonicError error);
/**
  * Invoked each time the user completes an Offer.
  * Award the user with the credit amount corresponding to the value of the ‘credits’ 
  * parameter.
  * @param dict - A dictionary which holds the credits and the total credits.   
  */
void OfferwallAdCreditedEvent(Dictionary<string,object> dict){
  Debug.Log ("I got OfferwallAdCreditedEvent, current credits = "dict["credits"] + "totalCredits = " + dict["totalCredits"]);
}
/**
  * Invoked when the method 'getOfferWallCredits' fails to retrieve 
  * the user's credit balance info.
  * @param desc - A string object which represents the reason of 'getOffereallCredits' failure. 
  */
void GetOfferwallCreditsFailEvent(SupersonicError error);
/**
  * Invoked when the user is about to return to the application after closing 
  * the Offerwall.
  */
void OfferwallClosedEvent();

Step 2. Initialize the Offerwall Unit

Once the Offerwall Ad Unit is initialized, you will able to call functions on it. We recommend initializing the Offerwall on application launch.

public class MyApp : MonoBehaviour {
void Start() 
  {
  Supersonic.Agent.start();
  //Set the unique id of your end user.
  string uniqueUserId = "APPLICATION_USER_ID_HERE"; 
  string appKey = "YOUR_APPLICATION_KEY";
  //Init Rewarded Video
  Supersonic.Agent.initOfferwall(appKey,uniqueUserId);
  }
}

Step 3. Present the Offerwall

After you receive the onOfferwallInitSuccessEvent you are ready to show the Offerwall to your user.

When you want to show the Offerwall (typically done after a user clicks on some in-app button),you do so by calling the following method in your application activity:

//show offerwall when user clicks the offerwall button 
Supersonic.Agent.showOfferwall();

New! Placements for Offerwall

With ironSource’s Ad Placements, you can customize and optimize the Offerwall experience. This tool enables you to present the Offerwall to your users in various places, i.e. in your in-app store, between levels, in the main menu,  etc. You can use the below function to define the exact Placement to show the Offerwall. Navigate to the Ad Placement document for more details.

Supersonic.Agent.showOfferwall("placementName");

Step 4. Reward the User

ironSource supports two methods to reward your users. Select one of the following:

1. Server-Side Callbacks
2. Client-Side Callbacks

We recommend turning on server-to-server callbacks for Offerwall instead of client-side callbacks, as the authenticity of the callback can be verified. With server-to-server callbacks, you will have better control over the rewarding process as the user navigates out of your app to complete the offer.

Method 2: Client-Side Callbacks

• Proactive Polling API

You may call the function getOWCredits at any point during the user’s engagement with the app. You will then receive information on the user’s total credits and any new credits the user has earned.
See Step 1 for instructions on how to implement the protocol and receive callbacks for the following method:

Supersonic.Agent.getOfferwallCredits();

• Automatic Client-Side Events

You can receive client-side events automatically within your application by registering to the Offerwall listener and setting the use of client-side callbacks. Setting automatic client-side callbacks will make sure that you’re notified about the user’s credit status at specific points in the Offerwall’s lifecycle. To do so:

Important! This code MUST be implemented before calling the initOWWithAppKey.

SupersonicConfig.Instance.setClientSideCallbacks(true);

Done!
You are now all set to deliver Offerwall Ad Units in your application.

First Time Integration Tip

If this is a new integration for your application, your app will by default be in ‘Test Mode‘ on your ironSource dashboard. While your app is in Test Mode, the ironSource SDK will print more logs to the console in order to provide greater visibility into the SDK processes. To test your ad inventory, set up your Test Devices. Until you turn on live ad inventory, you will receive test campaigns that don’t generate revenue. Make sure to select Go Live! on the Ad Units page when your app is ready for live ad inventory.