LevelPlay SDK for Android Advanced Settings

https://docs.unity.com/en-us/grow/levelplay/sdk/android/advanced-settings
Admin
This document details advanced settings for the LevelPlay SDK on Android, covering user segments,...
Tokens:2,666
Snippets:42
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Configure Price Floor for Banner Ads (Java)

Source: https://docs.unity.com/en-us/grow/levelplay/sdk/android/advanced-settings

Set a price floor for a banner ad unit by defining a configuration with a bid floor value. This configuration must be applied when creating the ad object and affects all subsequent loads for that object. Requires Min SDK 8.9.0.

```java
// 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);
```

--------------------------------

### Configure Price Floor for Rewarded Ads (Kotlin)

Source: https://docs.unity.com/en-us/grow/levelplay/sdk/android/advanced-settings

Set a price floor for a rewarded ad unit by defining a configuration with a bid floor value. This configuration must be applied when creating the ad object and affects all subsequent loads for that object. Requires Min SDK 8.9.0.

```kotlin
// 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)
```

--------------------------------

### Configure Price Floor for Interstitial Ads (Java)

Source: https://docs.unity.com/en-us/grow/levelplay/sdk/android/advanced-settings

Set a price floor for an interstitial ad unit by defining a configuration with a bid floor value. This configuration must be applied when creating the ad object and affects all subsequent loads for that object. Requires Min SDK 8.9.0.

```java
// 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);
```

--------------------------------

### Set Custom User Properties

Source: https://docs.unity.com/en-us/grow/levelplay/sdk/android/advanced-settings

Add up to 5 custom key-value pairs to further define user segments. Keys and values should be alphanumeric and up to 32 characters.

```java
// Set custom parameters (up to 5)
mLPSegment.setCustom(key, value);
```

--------------------------------

### Set User Properties for Segmentation

Source: https://docs.unity.com/en-us/grow/levelplay/sdk/android/advanced-settings

Configure standard user properties to attribute users to segments. This includes setting the user's level, creation date, total in-app purchases, and paying status.

```java
// Create segment object
mLPSegment = new LevelPlaySegment();
// Set user's level
mLPSegment.setLevel(level);
// Set user creation date
mLPSegment.setUserCreationDate(date);
// Set user's total in-app purchases
mLPSegment.setIAPTotal(iapt);
// Set user's paying status
mLPSegment.setIsPaying(isPaying);
```

--------------------------------

### Apply Segmentation to Ad Units

Source: https://docs.unity.com/en-us/grow/levelplay/sdk/android/advanced-settings

Call this function with either a segment name or user properties to tailor ad units to the user's segment. This affects the next loaded ad.

```java
LevelPlay.setSegment(mLPSegment);
```

--------------------------------

### Set Custom User Properties

Source: https://docs.unity.com/en-us/grow/levelplay/sdk/android/advanced-settings

Add up to 5 custom key-value pairs to further define user properties for segmentation.

```APIDOC
## Set Custom User Properties

### Description
Set up to 5 custom key-value pairs to further define user properties for segmentation.

### Method
```java
// Set custom parameters (up to 5)
mLPSegment.setCustom(key, value);
```

### Parameters
- **key** (String) - The key for the custom property (alphanumeric up to 32 letters).
- **value** (String) - The value for the custom property (alphanumeric up to 32 letters).
```

--------------------------------

### Set Custom Parameters for Rewarded Server-to-Server Callbacks (Kotlin)

Source: https://docs.unity.com/en-us/grow/levelplay/sdk/android/advanced-settings

Pass custom parameters to server-to-server callbacks for rewarded ads using the setMetaData API. Custom parameters can be updated multiple times and will override previous values. Ensure you are using LevelPlay SDK 8.11.0 or higher. Maximum of 2,048 characters are allowed.

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

--------------------------------

### Set User Properties

Source: https://docs.unity.com/en-us/grow/levelplay/sdk/android/advanced-settings

Set standard user properties to attribute a user to a segment. These include level, creation date, IAP total, and paying status.

```APIDOC
## Set User Properties

### Description
Set standard user properties to attribute a user to a segment. This includes user's level, creation date, total in-app purchases, and paying status.

### Method
```java
// Create segment object
mLPSegment = new LevelPlaySegment();
// Set user's level
mLPSegment.setLevel(level);
// Set user creation date
mLPSegment.setUserCreationDate(date);
// Set user's total in-app purchases
mLPSegment.setIAPTotal(iapt);
// Set user's paying status
mLPSegment.setIsPaying(isPaying);
```

### Parameters
- **level** (int) - The user's level in the app.
- **date** (long) - The user creation date in milliseconds.
- **iapt** (double) - The total amount of money the user has spent on in-app purchases.
- **isPaying** (boolean) - True if the user has made any in-app purchases, False otherwise.
```

--------------------------------

### Receive Segment Name Callback

Source: https://docs.unity.com/en-us/grow/levelplay/sdk/android/advanced-settings

Register this listener to receive the segment name associated with the current user. An empty string indicates no matching segments were found.

```java
SegmentListener onSegmentReceived(String segment){}
```

--------------------------------

### Set Custom Parameters for Rewarded Server-to-Server Callbacks (Java)

Source: https://docs.unity.com/en-us/grow/levelplay/sdk/android/advanced-settings

Pass custom parameters to server-to-server callbacks for rewarded ads using the setMetaData API. Custom parameters can be updated multiple times and will override previous values. Ensure you are using LevelPlay SDK 8.11.0 or higher. Maximum of 2,048 characters are allowed.

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

--------------------------------

### Set Segment Name

Source: https://docs.unity.com/en-us/grow/levelplay/sdk/android/advanced-settings

Inform the SDK about the user's segment by providing the predefined segment name.

```APIDOC
## Set Segment Name

### Description
Set the segment name for the user if you are familiar with the segment they belong to.

### Method
```java
mLPSegment.setSegmentName(name);
```

### Parameters
- **name** (String) - The name of the segment defined on the LevelPlay platform.
```

--------------------------------

### Set Segment

Source: https://docs.unity.com/en-us/grow/levelplay/sdk/android/advanced-settings

Apply the defined segment (either by name or user properties) to the LevelPlay SDK for ad serving.

```APIDOC
## Set Segment

### Description
Apply the defined segment to the LevelPlay SDK. This function should be called with either a segment name or user properties object to tailor the ad experience.

### Method
```java
LevelPlay.setSegment(mLPSegment);
```

### Parameters
- **mLPSegment** (LevelPlaySegment) - An object containing the segment name or user properties.
```

--------------------------------

### Dynamic Segmentation

Source: https://docs.unity.com/en-us/grow/levelplay/sdk/android/advanced-settings

Change segmentation during a session using the LevelPlaySegment API to affect the next loaded ad.

```APIDOC
## Dynamic Segmentation

### Description
If using LevelPlay SDK 7.2.0+, you can use the `LevelPlaySegment` API to change segmentation during the session. This affects the next loaded ad and can be called before loading each ad unit.

### Method
```java
LevelPlay.setSegment(mLPSegment);
```

### Usage
Call `LevelPlay.setSegment(mLPSegment)` before loading each ad unit to dynamically affect the waterfall based on the updated segmentation.
```

--------------------------------

### Segment Received Callback

Source: https://docs.unity.com/en-us/grow/levelplay/sdk/android/advanced-settings

Register a callback to receive the segment name that your user belongs to.

```APIDOC
## Segment Received Callback

### Description
Register to receive the segment name that your user belongs to. If the callback returns an empty string, no correlating segments were found.

### Method Signature
```java
SegmentListener onSegmentReceived(String segment)
```

### Parameters
- **segment** (String) - The name of the segment the user belongs to, or an empty string if no segment is found.
```

--------------------------------

### Set Segment Name

Source: https://docs.unity.com/en-us/grow/levelplay/sdk/android/advanced-settings

Use this method when the user's segment is already known. Ensure the segment name is alphanumeric and up to 32 characters.

```java
mLPSegment.setSegmentName(name);
```
Tokens:
Raw