Additional SDK Settings

Set UserID

If you’re using server-to-server callbacks to reward your users with ironSource SDK rewarded ad units, or using Ad Quality user journey, you must define a unique identifier for each user (“UserID”), using the setUserID method.

Set the UserID before the init request, to make sure you avoid any data losses, related to the user. Use a unique identifier, with up to 64 alphanumeric characters (String format for Android; NSString format for iOS). 

IronSource.Agent.setUserId(YOUR_USER_ID);

Define Segments

You can now easily tailor the way you serve your ads to fit a specific audience! You’ll need to inform our servers of the users’ details so the SDK will know to serve ads according to the segment the user belongs to.

ironSource SDK supports three methods to convey data to our servers to outline the user segment, namely:

• Device Properties: the ironSource SDK collects certain standard parameters that pertain to the users’ device automatically such as device model, device manufacturer, app version, OS, etc. You do not need to convey this data to us 
• User Properties: user data which is not collected by our SDK, such as age, gender, creation date, etc. (see full list of supported segment properties with descriptions below) must be relayed through the API. Follow the instructions to send us these details so our SDK can apply the relevant ad settings to the segments you defined on the LevelPlay platform
• Custom Segments: you can create a custom segment without conveying user details to our servers and tailor ad settings for that user segment

Pass User Properties

Once you’ve defined segments on the LevelPlay platform, you’ll need to inform our servers of the user’s particulars.

Define what properties to send to our servers on which to base the segments. You can transmit this information through one of the following methods:

1. If you are familiar with the segment that the user belongs to, enter the segment name:

   IronSourceSegment segment = new IronSourceSegment ();
           segment.segmentName = "nameOfSegment";
   

2. Send us the user details. ironSource provides a range of standard user properties that you can set to attribute a user to a segment in the API.  Scroll down for a table of the support user segment properties.

   // Create segment object
   IronSourceSegment segment = new IronSourceSegment ();
   // Set user age
   segment.age = age;
   // Set user gender
   segment.gender = "gender";
   // Set user's level
   segment.level = levelnumber;
   // Set user creation date
   segment.userCreationDate=creationData
   // Set user's total in-app purchases
   segment.iapt = numberOfInAppPurchases;
   // Set user's paying status, 1 is yes 0 is no
   segment.isPaying = payingStatus;

   In addition, you can set up to 5 custom user properties per segment:

   // Set custom parameters (up to 5)
   Dictionary<string,string> customParams = new Dictionary<string,string> ();
   customParams.Add ("customKey", "value");
   segment.customs = customParams;
          
   

Next, to serve your ad units based on segments, call the following function complete with either the segment name or user properties:

IronSource.Agent.setSegment (segment);

Supported User Segment Properties

Register to the following callback to receive the segment name that your user belongs to. If the callback string (segment name) returns empty, there were no correlating segments found for the user in the ironSource Segment module.

 IronSourceEvents.onSegmentReceivedEvent += SegmentReceivedEvent;

Custom Parameters for Unity

The ironSource SDK supports custom parameters for Rewarded Video. You can pass custom parameters upon the initialization of the ad unit and receive the parameters upon a user’s completion event.
You can now pass custom parameters for all mediation networks on the LevelPlay mediation platform.

Implementation Code

Rewarded Video

IronSource.Agent.setRewardedVideoServerParams(Dictionary<string, string> parameters);
IronSource.Agent.clearRewardedVideoServerParams();

You will then receive a corresponding callback as exemplified below:

Pause Game

The API setPauseGame is introduced as part of the ironSource Unity SDK 7.2.4, and is relevant for iOS apps only.

When setting your PauseGame status to “true”, all your Unity 3D game activities will be paused (Except the ad callbacks). The game activity will be resumed automatically when the ad is closed.

You should call the setPauseGame API once in your session, before or after initializing the ironSource SDK, and as it affects all ads (Rewarded Video and Interstitial ads) in the session.

IronSource.Agent.SetPauseGame(true);

IronSource.Agent.SetPauseGame(false);

Price limitations using waterfall configuration (beta)

Set Waterfall Configuration is an API that can be used to dynamically set limits for the waterfall: price ceiling and price floor. You can use it to set limits and dynamically affect the WF returned per user, resulting in reduced load times and latency. 

Limits include, and can be any combination of these parameters:

Create a waterfall configuration

The WaterfallConfiguration class represents a configuration object for customizing or filtering a waterfall. 

In order to create a waterfall configuration, define a WaterfallConfigurationBuilder:

// Build the WaterfallConfiguration and add data to constrain or control a waterfall
WaterfallConfiguration config = WaterfallConfiguration.Builder()
            .SetCeiling(ceiling)
            .SetFloor(floor)
            .Build();
// set a configuration for an ad unit
IronSource.Agent.SetWaterfallConfiguration(config, AdFormat.adFormat);

Clearing a Waterfall Configuration

It is possible to change the waterfall configuration during the session. To clear the configuration for a given ad unit, use the WaterfallConfiguration.Empty() function:

IronSource.Agent.SetWaterfallConfiguration(WaterfallConfiguration.Empty(), AdFormat.adFormat);

Overwriting a Waterfall Configuration

A built WaterfallConfiguration is immutable, you must create a new Waterfall Configuration to change the existing configuration from a previous one. One may also inline the builder and set definitions in keeping with the builder pattern.

...
IronSource.Agent.SetWaterfallConfiguration(waterfallconfiguration, AdFormat.RewardedVideo);
WaterfallConfiguration waterfallConfiguration2 = WaterfallConfiguration.Builder()
  .SetFloor(ceiling)
  .SetCeiling(floor)
  .Build();
IronSource.Agent.SetWaterfallConfiguration(waterfallConfiguration2, AdFormat.RewardedVideo);

ironSource SDK Error Codes

ironSource provides an error feedback mechanism to provide explanation for any failure in the SDK integration. You will receive these errors when something went wrong or an aspect of the integration wasn’t completed correctly.

The ironSource Error object contains an error code and message. These are all the possible errors and their message based on their functions: