Rewarded ads integration for Flutter

Prerequisites

• Ensure that you integrate the Flutter Plug-in into your app.
• Ensure that you initialize the SDK using LevelPlay Initialization API.
• Find the AdUnitID in LevelPlay dashboard.

Create Rewarded and Register to Events

onInitSuccess

final LevelPlayRewardedAd _rewardedAd = LevelPlayRewardedAd(adUnitId: [YOUR_AD_UNIT_ID]);@overridevoid initState() {    super.initState();    _rewardedAd.setListener(this);}// LevelPlayRewardedAdListener methods@overridevoid onAdLoaded(LevelPlayAdInfo adInfo) {}@overridevoid onAdLoadFailed(LevelPlayAdError error) {} @overridevoid onAdDisplayed(LevelPlayAdInfo adInfo) {}@overridevoid onAdDisplayFailed(LevelPlayAdError error, LevelPlayAdInfo adInfo) {}@override void onAdClosed(LevelPlayAdInfo adInfo) {}@overridevoid onAdClicked(LevelPlayAdInfo adInfo) {} @overridevoid onAdInfoChanged(LevelPlayAdInfo adInfo) {}@overridevoid onAdRewarded(LevelPlayReward reward, LevelPlayAdInfo adInfo) {}

LevelPlay Rewarded Ad Callbacks

• onAdLoaded

  : Provided when the ad is successfully loaded

• onAdLoadFailed

  : Provided when the ad fails to load. Ad Unit information is included

• onAdDisplayed

  : Provided when the ad is displayed. This is equivalent to an impression

• onAdDisplayFailed

  (optional): Provided when the ad fails to be displayed

• onAdRewarded

  : Provided when the ad is rewarded. Ad Unit info and the reward info are included.

• onAdClicked

  (optional): Provided when the user clicks on the ad

• onAdClosed

  : Provided when the ad is closed

• onAdInfoChanged

  (optional): Provided when the ad info is updated. Available when another ad has loaded, and includes a higher CPM/Rate

Get Rewarded ad details

Prerequisites

• SDK Initialization: Call initSDK and wait for the onInitializationSuccess callback to ensure the reward data has been cached.
• Ad Object Instance: Instantiate a Rewarded Ad object with a valid Ad Unit ID before calling the API.
• Minimum SDK Version: Use LevelPlay SDK version 8.1.0 or higher (Native or Unity package).

Best practices

• Call on initialization success: The best time to call getReward is immediately inside your initialization success listener. This ensures your UI is ready the moment the user enters a screen.
• Check for empty states: Always validate that amount > 0 before you update your UI. This ensures a smooth user experience if a network error occurs during initialization.
• Placement precision: Ensure the string used in getReward("placementName") exactly matches the name defined in the LevelPlay dashboard.

API structure

getReward

• placementName

  : The unique identifier for the placement as defined in the LevelPlay dashboard. Pass

  null

  to retrieve the default reward for the ad unit.

Initial setup

• Integrated feature: Because the reward data is retrieved during the initial SDK setup, the API call is instantaneous and doesn't require a network request.
• Editor configuration: After your app is integrated with the LevelPlay SDK, the API is available for use immediately. No additional assets or plugins are required to test this functionality.

Understand reward selection logic

• Placement level: If a valid placement name is provided in the call, the SDK returns the specific reward configured for that placement in the dashboard.
• Ad Unit level: If the placement name is null or not found, the SDK falls back to the default reward defined for the Ad Unit.
• Fallback state: If the API is called before initialization is complete, it returns a reward object with an empty string name and an amount of 0.

Update your UI dynamically

• Validate amount: Always verify that reward.amount > 0 before updating your UI components.
• Event-Driven updates: Call the API inside your initialization success listener to ensure the UI is accurate the moment a user enters a screen.
• Case sensitivity: Ensure the placement name string in your code matches the LevelPlay dashboard exactly; mismatched strings will trigger the Ad Unit fallback.

Troubleshooting getReward API implementation

• Reward amount returns 0: This usually occurs if the API is called before the onInitializationSuccess callback. Ensure the SDK is fully ready before querying rewards.
• Wrong reward type shown: Check if you have multiple placements. If the placement name is misspelled, the SDK will default to the primary ad unit reward instead of the specific placement reward.

Load Rewarded Ad

_rewardedAd.loadAd();

Show Rewarded Ad

// Show ad without placement_rewardedAd.showAd();// Show ad with placement_rewardedAd.showAd(placement: [YOUR_PLACEMENT]);

Check ad ready

• isAdReady

  : Returns true if ad loads successfully and ad unit isn't capped, or false otherwise.

• isPlacementCapped

  : Returns true when a valid placement is capped. If the placement isn't valid, or not capped, this API will return false.

// Check that ad is ready and that the placement is not capped if(_rewardedAd.isAdReady() && !LevelPlayRewardedAd.isPlacementCapped([YOUR_PLACEMENT])) {     _rewardedAd.showAd(placement:[YOUR_PLACEMENT]);}

Dynamic UserId

• The string value must be 1 to 64 alphanumeric characters.
• You will receive a

  dynamicUserId

  parameter in the callback URL with the reward details.

LevelPlay.setDynamicUserId("userId");

Reward the User

onAdRewarded

onAdRewarded

onAdClosed

onAdRewarded

onAdClosed

@overridevoid onAdRewarded(LevelPlayReward reward, LevelPlayAdInfo adInfo) {    // Implement logic to grant the reward to the user}

Multiple Ad Unit Rewarded APIs

IronSource

LevelPlayRewardedAd

loadRewardedVideo

loadAd

showRewardedVideo

showAd

isRewardedVideoPlacementCapped

isPlacementCapped

isRewardedVideoAvailable

isAdReady

placement.getRewardName

reward.name

placement.getRewardAmount

reward.amount

Full Implementation Example of Rewarded Ad

final LevelPlayRewardedAd _rewardedAd = LevelPlayRewardedAd(adUnitId: 'YOUR_AD_UNIT_ID');@overridevoid initState() {    super.initState();    _rewardedAd.setListener(this);    _rewardedAd.loadAd();}@overridevoid onAdRewarded(LevelPlayReward reward, LevelPlayAdInfo adInfo) {    // Implement your logic here...}@overridevoid onAdClicked(LevelPlayAdInfo adInfo) {    // Implement your logic here...}@overridevoid onAdClosed(LevelPlayAdInfo adInfo) {    // Implement your logic here...}@overridevoid onAdDisplayFailed(LevelPlayAdError error, LevelPlayAdInfo adInfo) {    // Implement your logic here...}@overridevoid onAdDisplayed(LevelPlayAdInfo adInfo) {    // Implement your logic here...}@overridevoid onAdInfoChanged(LevelPlayAdInfo adInfo) {    // Implement your logic here...}@overridevoid onAdLoadFailed(LevelPlayAdError error) {    // Implement your logic here...}@overridevoid onAdLoaded(LevelPlayAdInfo adInfo) {    // Implement your logic here, for example showing the ad    _rewardedAd.showAd();}// Rest of the widget// End of widget...