Advanced Settings

Set User ID

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 loses, related to the user. Use a unique identifier, with up to 64 alphanumeric characters.

IronSource.setUserId("UserID");

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 location, device model, device manufacturer, app version, OS, etc. You do not need to convey this data to us.
• User Properties: comprehensive user data 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 your user’s details so our SDK can categorize your different users based on 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:
   

   mIronSegment.setSegmentName(name);

2. Send us the user details. ironSource SDK 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
   mIronSegment = IronSourceSegment();
   // Set user age
   mIronSegment.setAge(age);
   // Set user gender
   mIronSegment.setGender(gender);
   // Set user's level
   mIronSegment.setLevel(level);
   // Set user creation date
   mIronSegment.setUserCreationDate(date);
   // Set user's total in-app purchases
   mIronSegment.setIAPTotal(iapt);
   // Set user's paying status
   mIronSegment.setIsPaying(isPaying);
   

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

   // Set custom parameters (up to 5)
   mIronSegment.setCustom(key,value);
   

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

   IronSource.setSegment(mIronSegment);
   

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.

SegmentListener onSegmentReceived(String segment){}

Custom Parameters for Rewarded server to server callbacks

LevelPlay reward-based ad units support server-side events to notify you of rewards that must be granted to your users after successful ad completion events. You can learn more here.

In addition to the server params, you can share run-time custom parameters through the client. To implement this, simply pass custom parameters to LevelPlay_Rewarded_Server_Params using the setMetadata API. Custom parameters can be updated several times throughout a session overriding previous values. 

To reset the custom parameters, set LevelPlay_Rewarded_Server_Params to an empty array.

Example implementation Code

LevelPlay.setMetaData("LevelPlay_Rewarded_Server_Params", List.of("key1=value1", "key2=value2"));

LevelPlay.setMetaData("LevelPlay_Rewarded_Server_Params", listOf("key1=value1", "key2=value2"))

You will then receive a corresponding callback as exemplified below:

http://www.mydomain.com/rewardsCallback?appUserId=[USER_ID]&rewards=[REWARDS]&eventId=[EVENT_ID]&itemName=[ITEM_NAME]&custom_key1=value1&custom_key2=value2

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. Implement the following to create a waterfall configuration:

// 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.setWaterfallConfiguration(config, adUnit);

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.setWaterfallConfiguration(WaterfallConfiguration.empty(), adUnit);

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.setWaterfallConfiguration(waterfallconfiguration, IronSourceAdUnit.RewardedVideo);
WaterfallConfiguration waterfallConfiguration2 = WaterfallConfiguration.builder()
  .SetFloor(ceiling)
  .SetCeiling(floor)
  .Build();
IronSource.setWaterfallConfiguration(waterfallConfiguration2, IronSourceAdUnit.RewardedVideo);

Price Floor Configuration

The Floor Configuration API lets you set a price floor for a specific ad unit. By setting a price floor for each user, you can improve targeting efficiency, reduce latency, and optimize ad performance.

The price floor must be assigned when creating the ad object, and it applies to all subsequent loads for that object. 

Interstitial ads example

// Define a price floor configuration
var adConfig = new LevelPlayInterstitialAd.Config.Builder()
 .setBidFloor(1.23) // Set the price floor in USD
 .build();
// Apply the configuration to an interstitial ad unit
var interstitialAd = new LevelPlayInterstitialAd("adUnitId", adConfig);

// Define a price floor configuration
val adConfig = LevelPlayInterstitialAd.Config.Builder()
    .setBidFloor(1.23) // Set the price floor in USD
    .build()
// Apply the configuration to an interstitial ad unit
val interstitialAd = LevelPlayInterstitialAd("adUnitId", adConfig)

Full interstitial implementation is available here.

Rewarded ads example

// Define a price floor configuration
val adConfig = LevelPlayRewardedAd.Config.Builder()
 .setBidFloor(1.23) // Set the price floor in USD
 .build()
// Apply the configuration to a rewarded ad unit
val rewardedAd = LevelPlayRewardedAd("adUnitId", adConfig)

// Define a price floor configuration
val adConfig = LevelPlayRewardedAd.Config.Builder()
 .setBidFloor(1.23) // Set the price floor in USD
 .build()
// Apply the configuration to a rewarded ad unit
val rewardedAd = LevelPlayRewardedAd("adUnitId", adConfig)

Full rewarded ads implementation is available here.

Banner ads example

// Define a price floor configuration
var adConfig = new LevelPlayBannerAd.Config.Builder()
 .setBidFloor(1.23) // Set the price floor in USD
 .build();
// Apply the configuration to a banner ad unit
var bannerAd = new LevelPlayBannerAdView(context, "adUnitId", adConfig);

// Define a price floor configuration
val adConfig = LevelPlayBannerAdView.Config.Builder()
 .setBidFloor(1.23) // Set the price floor in USD
 .build()
// Apply the configuration to a banner ad unit
val bannerAd = LevelPlayBannerAdView(context, "adUnitId", adConfig)

Full banner ads implementation is available here.

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: