ironsource_mediation

Description:

ironsource mediation

ironSource Flutter Plugin #
A bridge plugin for ironSource SDKs.

ironSource Knowledge Center
Android SDK
iOS SDK

Getting Started #
Installation #
flutter pub get ironsource_mediation
copied to clipboard
Android Configuration #

The ironSource SDK dependency is included in the plugin, so you do not have to add manually to your build.gradle.

Gradle Dependencies Required #

Play Services dependencies must be added to PROJECT_ROOT/android/app/build.gradle.

// PROJECT_ROOT/android/app/build.gradle
dependencies {
...
implementation 'com.google.android.gms:play-services-appset:16.0.2'
implementation 'com.google.android.gms:play-services-ads-identifier:18.0.1'
implementation 'com.google.android.gms:play-services-basement:18.3.0'
}
copied to clipboard
iOS Configuration #

The ironSource SDK pod is included in the plugin, so you do not have to add it to your Podfile.

SKAdNetwork Support #
Add the SKAN ID of ironSource Network on info.plist
<key>SKAdNetworkItems</key>
<array>
<dict>
<key>SKAdNetworkIdentifier</key>
<string>su67r6k2v3.skadnetwork</string>
</dict>
</array>
copied to clipboard
App Transport Security Settings #
Set NSAllowsArbitraryLoads: true on info.plist to allow http as some mediated networks require http calls. (Note: ironSource Network calls are all encrypted.)
Note:

Make sure that your info.plist does not contain other ATS exceptions such as NSAllowsArbitraryLoadsInWebContent.

<key>NSAppTransportSecurity</key>
<dict>
<key>NSAllowsArbitraryLoads</key>
<true/>
</dict>
copied to clipboard
App Tracking Transparency (ATT) Prompt #
TODO: Remove or keep this?
Implement the ATT prompt to request user authorization for app-related data.

Note: This is not part of ironSource SDK but a bridge for AppTrackingTransparency ATTrackingManager.
You have to add NSUserTrackingUsageDescription to your info.plist if you intend to call this API.

Future<void> checkATT() async {
final currentStatus = await ATTrackingManager.getTrackingAuthorizationStatus();
if (currentStatus == ATTStatus.NotDetermined) {
final returnedStatus = await ATTrackingManager.requestTrackingAuthorization();
print('ATTStatus returned: $returnedStatus');
}
return;
}
copied to clipboard
Read more about Apple's ATT and user privacy guideline here.
General Usage #
Implement Listeners #
LevelPlayRewardedVideoListener
class LevelPlayRewardedVideoListenerClass with LevelPlayRewardedVideoListener {
@override
void onAdAvailable(IronSourceAdInfo? adInfo) {
// TODO: implement onAdAvailable
}

@override
void onAdClicked(IronSourceRewardedVideoPlacement? placement, IronSourceAdInfo? adInfo) {
// TODO: implement onAdClicked
}

@override
void onAdClosed(IronSourceAdInfo? adInfo) {
// TODO: implement onAdClosed
}

@override
void onAdOpened(IronSourceAdInfo? adInfo) {
// TODO: implement onAdOpened
}

@override
void onAdRewarded(IronSourceRewardedVideoPlacement? placement, IronSourceAdInfo? adInfo) {
// TODO: implement onAdRewarded
}

@override
void onAdShowFailed(IronSourceError? error, IronSourceAdInfo? adInfo) {
// TODO: implement onAdShowFailed
}

@override
void onAdUnavailable() {
// TODO: implement onAdUnavailable
}
}
copied to clipboard
LevelPlayInterstitialListener
class LevelPlayInterstitialListenerClass with LevelPlayInterstitialListener {
@override
void onAdClicked(IronSourceAdInfo? adInfo) {
// TODO: implement onAdClicked
}

@override
void onAdClosed(IronSourceAdInfo? adInfo) {
// TODO: implement onAdClosed
}

@override
void onAdLoadFailed(IronSourceError? error) {
// TODO: implement onAdLoadFailed
}

@override
void onAdOpened(IronSourceAdInfo? adInfo) {
// TODO: implement onAdOpened
}

@override
void onAdReady(IronSourceAdInfo? adInfo) {
// TODO: implement onAdReady
}

@override
void onAdShowFailed(IronSourceError? error, IronSourceAdInfo? adInfo) {
// TODO: implement onAdShowFailed
}

@override
void onAdShowSucceeded(IronSourceAdInfo? adInfo) {
// TODO: implement onAdShowSucceeded
}
}
copied to clipboard
LevelPlayBannerListener
class LevelPlayBannerListenerClass with LevelPlayBannerListener {

@override
void onAdClicked(IronSourceAdInfo? adInfo) {
// TODO: implement onAdClicked
}

@override
void onAdLeftApplication(IronSourceAdInfo? adInfo) {
// TODO: implement onAdLeftApplication
}

@override
void onAdLoadFailed(IronSourceError? error) {
// TODO: implement onAdLoadFailed
}

@override
void onAdLoaded(IronSourceAdInfo? adInfo) {
// TODO: implement onAdLoaded
}

@override
void onAdScreenDismissed(IronSourceAdInfo? adInfo) {
// TODO: implement onAdScreenDismissed
}

@override
void onAdScreenPresented(IronSourceAdInfo? adInfo) {
// TODO: implement onAdScreenPresented
}
}
copied to clipboard
LevelPlayNativeAdListener
class LevelPlayNativeAdListenerClass with LevelPlayNativeAdListener {
@override
void onAdClicked(LevelPlayNativeAd? nativeAd, IronSourceAdInfo? adInfo) {
// TODO: implement onAdClicked
}

@override
void onAdImpression(LevelPlayNativeAd? nativeAd, IronSourceAdInfo? adInfo) {
// TODO: implement onAdImpression
}

@override
void onAdLoadFailed(LevelPlayNativeAd? nativeAd, IronSourceError? error) {
// TODO: implement onAdLoadFailed
}

@override
void onAdLoaded(LevelPlayNativeAd? nativeAd, IronSourceAdInfo? adInfo) {
// TODO: implement onAdLoaded
}
}
copied to clipboard
Initialize the plugin #
Future<void> initIronSource() async {
final appKey = Platform.isAndroid
? ANDROID_APP_KEY
: Platform.isIOS
? IOS_APP_KEY
: throw Exception("Unsupported Platform");
try {
IronSource.setFlutterVersion('YOUR_FLUTTER_VERSION'); // must be called before init
IronSource.validateIntegration();
// Set listeners
IronSource.setLevelPlayRewardedVideoListener(LevelPlayRewardedVideoListenerClass());
IronSource.setLevelPlayInterstitialListener(LevelPlayInterstitialListenerClass());
IronSource.setLevelPlayBannerListener(LevelPlayBannerListenerClass());

await IronSource.setAdaptersDebug(true);
await IronSource.shouldTrackNetworkState(true);

// Do not use GAID or IDFA for this.
await IronSource.setUserId("unique-application-user-id");
await IronSource.init(appKey: appKey, adUnits: [IronSourceAdUnit.RewardedVideo]);
} on PlatformException catch (e) {
print(e);
}
}
copied to clipboard
Show Ads Example #
LevelPlayRewardedVideo
Future<void> _showRewardedVideoOnClick() async {
if (await IronSource.isRewardedVideoAvailable()) {
IronSource.showRewardedVideo();
}
}
copied to clipboard
LevelPlayInterstitial
void _loadInterstitialOnClick() {
IronSource.loadInterstitial();
}

Future<void> _showInterstitialOnClick() async {
if (await IronSource.isInterstitialReady()) {
IronSource.showInterstitial();
}
}
copied to clipboard
LevelPlayBanner
Future<void> _loadBanner() async { // load will automatically show the ad
await IronSource.loadBanner(
size: size,
position: IronSourceBannerPosition.Bottom,
verticalOffset: -50,
placementName: 'YOUR_PLACEMENT');
}
copied to clipboard
LevelPlayNativeAd
class _LevelPlayNativeAdsSection extends State<LevelPlayNativeAdsSection> with LevelPlayNativeAdListener {
LevelPlayNativeAd? _nativeAd;
LevelPlayNativeAdView? _nativeAdView;

@override
void initState() {
super.initState();
_createNativeAd();
_createNativeAdView();
}

/// Initialize native ad object
void _createNativeAd() {
_nativeAd = LevelPlayNativeAd.builder()
.withPlacementName('YOUR_PLACEMENT_NAME') // Your placement name string
.withListener(LevelPlayNativeAdListenerClass()) // Your level play native ad listener
.build();
}

/// Initialize native ad view widget with native ad
void _createNativeAdView() {
_nativeAdView = LevelPlayNativeAdView(
key: GlobalKey(), // Unique key to force recreation of widget
height: 150, // Your chosen height
width: double.infinity, // Your chosen width
nativeAd: _nativeAd, // Native ad object
templateType: LevelPlayTemplateType.SMALL, // Built-in native ad template(not required when implementing custom template)
templateStyle: LevelPlayNativeAdTemplateStyle( // Level play native ad styling(optional)
callToActionStyle: LevelPlayNativeAdElementStyle(
backgroundColor: Colors.white,
textColor: Colors.lightBlue
)
),
);
}

/// Load native ad
void _loadAd() {
_nativeAd?.loadAd();
}

// Rest of the class
copied to clipboard
Refer to the example app for the more detailed implementation sample.
Note:

Make sure to read the official documents at [ironSource Knowledge Center](TODO: replace with the real KC link) for proper usage.
Some configurations must be done before IronSource.init.

Banner Positioning #
For the native SDKs, a banner view must be implemented directly to the UI component.
This bridge takes care of native level view implementation. Therefore, positioning parameters are provided as below:
Position
enum IronSourceBannerPosition {
Top,
Center,
Bottom,
}
copied to clipboard
Offset
This parameter represents the vertical offset of the banner:

Negative values: Upward offset
Positive values: Downward offset

Unit:

Android: dp
iOS: point

Note:

Offset in the same direction of the position will be ignored. e.g. Bottom & 50, Top & -50
However, the offsets in the opposite direction or both directions on the Center position can go beyond the screen boundaries. e.g. Bottom & -10000
Make sure that a banner presented will be visible

IronSource.loadBanner(
size: IronSourceBannerSize.BANNER,
position: IronSourceBannerPosition.Bottom,
verticalOffset: -50, // adding 50dp/50point margin bottom
placementName: 'YOUR_PLACEMENT');
copied to clipboard
Mediation #

You can use the ironSource LevelPlay's mediation feature by adding adapters/SDKs to your project.
Some networks require additional configurations.
Make sure to use the compatible adapter versions.

Android #
Make sure to follow ironSource Knowledge Center document for additional setup.

Add dependencies to YOUR_PROJECT/android/app/build.gradle
Add required settings to YOUR_PROJECT/android/app/src/main/AndroidManifest.xml

iOS #
Make sure to follow ironSource Knowledge Center document for additional setup.

Add pod dependencies to YOUR_PROJECT/ios/Podfile: target 'Runner'
Add required settings to YOUR_PROJECT/ios/Runner/info.plist

Note:

For Podfile, transitive dependencies error will be thrown with use_frameworks!. The workaround is to add the code below to Podfile:

use_frameworks! :linkage => :static
copied to clipboard