Advanced Settings

Set UserID

If you’re using server-to-server callbacks to reward your users with LevelPlay 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 a format of 64 characters NSString. 

[LevelPlay setUserId:YOUR_USERID];

LevelPlay.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 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 ironSource platform
• Custom Segments: you can create a custom segment with predefined conditions without conveying user details to our servers and tailor ad settings for that user segment on the ironSource platform

Pass User Properties

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

First, init the segment:

ISSegment *segment = [[ISSegment alloc]init];

let segment: ISSegment = ISSegment()

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:

   [segment setSegmentName:YOUR_SEGMENT_NAME];

   segment.segmentName = "YOUR_SEGMENT_NAME"

2. Send us the user details. LevelPlay provides a range of standard user properties that you can set to attribute a user to a segment in the API. See table below for descriptions.

   // Set user level
   [segment setLevel:USER_LEVEL];
   // Set user's paying status
   [segment setPaying:USER_PAYING];
   // Set user's total in-app purchase history
   [segment setIapTotal:YOUR_IAP_TOTAL];
   // Set user creation date
   [segment setUserCreationDate:YOUR_DATE];

   // Set user's total in-app purchases
   segment.iapTotal = USER_IAP_TOTAL
   // Set user's level
   segment.level = USER_LEVEL
   // Set user's paying status
   segment.paying = USER_PAYING_STATUS
   // Set user creation date
   segment.userCreationDate = NSDate() as Date!

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

   [segment setCustomValue:YOUR_CUSTOM_VALUE forKey:YOUR_CUSTOM_KEY];

   segment.setCustomValue("CUSTOM_VALUE", forKey: "CUSTOM_KEY")

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

   [LevelPlay setSegment:YOUR_SEGMENT];

   LevelPlay.setSegment(YOUR_SEGMENT);

Supported Segment Properties

Obtain the User’s Segment Name

1. Adopt this interface in your class to conform to the Segment Name protocol and enable the receipt of the segment name ISSegmentDelegate
2. Register to the following delegate to receive the segment name that your user belongs to. The SDK will then notify your delegate of the event.

   [LevelPlay setSegmentDelegate:self];

   LevelPlay.setSegmentDelegate(self)

3. (void)didReceiveSegement:(NSString *)segment

   func didReceiveSegement(_ segment: String!)

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 setMetaDataWithKey:@"LevelPlay_Rewarded_Server_Params" values: [[NSMutableArray alloc] initWithObjects:@"key1=value1", @"key2=value2", nil]];

LevelPlay.setMetaDataWithKey("LevelPlay_Rewarded_Server_Params", values: ["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 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.

Note: Min SDK version for this feature is 8.9.0.

Interstitial ads example

// Define a price floor configuration
LPMInterstitialAdConfig *adConfig = [[[LPMInterstitialAdConfigBuilder new] setBidFloor: 1.23] build]; // Set the price floor in USD
// Apply the configuration to an interstitial ad unit
LPMInterstitialAd *interstitialAd = [[LPMInterstitialAd alloc] initWithAdUnitId:@"adUnitId" config:adConfig];

// Define a price floor configuration
let adConfig = LPMInterstitialAdConfigBuilder()
 .set(bidFloor: 1.23) // Set the price floor in USD
 .build()
// Apply the configuration to an interstitial ad unit
let interstitialAd = LPMInterstitialAd(adUnitId: "adUnitId", config: adConfig)

Full interstitial implementation is available here.

Rewarded ads example

// Define a price floor configuration
LPMRewardedAdConfig *adConfig = [[[LPMRewardedAdConfigBuilder new] setBidFloor: 1.23] build]; // Set the price floor in USD
// Apply the configuration to a rewarded ad unit
LPMRewardedAd *rewardedAd = [[LPMRewardedAd alloc] initWithAdUnitId:@"adUnitId" config: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
LPMBannerAdViewConfig *adConfig = [[[LPMBannerAdViewConfigBuilder new] setBidFloor: 1.23] build]; // Set the price floor in USD
// Apply the configuration to a banner ad unit
LPMBannerAdView *bannerAd = [[LPMBannerAdView alloc] initWithAdUnitId:@"adUnitId" config:adConfig];

// Define a price floor configuration
let adConfig = LPMBannerAdViewConfigBuilder()
 .set(bidFloor: 1.23) // Set the price floor in USD
 .build()
// Apply the configuration to a banner ad unit
let bannerAd = LPMBannerAdView(adUnitId: "adUnitId", adConfig)

Full banner ads implementation is available here.

LevelPlay SDK Error Codes

LevelPlay provides an error feedback mechanism to provide an 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 LevelPlay Error object contains an error code and message. These are all the possible errors and their message based on their functions: