IronSource Plugin

This plugin allows you use IronSource ads and mediation

Platforms:

works on Android and iOS

Setup:

Go to Iron Source website (https://www.ironsrc.com) and create account. Then go to apps and create an app for android and/or iOS

If you want to setup mediation go here and setup each network https://platform.ironsrc.com/partners/monetize/mediation/setup

Functions:

ironSource.init(listener, params)

— init function

listener(function) returns and event in the Events section bellow

params(table) androidAppKey = app key for android(string), iOSAppKey = app key for iOS(string), clientSideCallback= boolean (default is false), GDPR = boolean (default is false)

ironSource.load(type, params)

— load ad

type(string) “banner”(note show banners before loading), “interstitial”

params (table) on “banner”, the param “placement” can be added, also tablet(boolean)(default if false), can be added.

ironSource.show(type, params)

— show ads

type(string) “banner”, “interstitial”, “offerwall”, “rewardedVideo”

params (table) on “banner” position(string)= “top” or “bottom”. On “interstitial”, “offerwall”, “rewardedVideo” the param “placement” can be added

ironSource.hide(type)

— hides banners until .show is called again

type(string) “banner”

ironSource.isLoaded(type)

— returns boolean

type(string) “banner”, “interstitial”, “offerwall”, “rewardedVideo”

ironSource.setProperties(properties)

— properties(table) key values pairs can be

type(string) “banner”, “interstitial”, “offerwall”, “rewardedVideo”

age = number,

dynamicUserId (“The Dynamic UserID is a parameter that can be changed throughout the session and will be received in the server-to-server ad rewarded callbacks.”) = string ,

gender = “male”, “female”, “unknown”,

userId = string,

mediationSegment = string,

mediationType = string

ironSource.getRewardVideoPlacementInfo(placement)

— returns table with rewardAmount(number), rewardName(string), isRewardedVideoPlacementCapped(boolean)

placement(string)

ironSource.getOfferwallCredits()

ironSource.getSize()

— gets size of banners (note banner must be showing and loaded to get size) returns height(number)

ironSource.getAdId()

return ad id for testing (string)

ironSource.destroyBanner()

— destroy banner

Events:

return in lis function on .init()

Banner:

phase == “adLoaded”, isError == false, type == “banner”

phase == “adLoadedFailed”,isError == true,error == error message(string),type == “banner”

phase == “adClicked”, isError == false, type == “banner”

phase == “adScreenPresented”, isError == false, type == “banner”

phase == “adScreenDismissed”, isError == false, type == “banner”

phase == “adLeftApplication”, isError == false, type == “banner”

Interstitial:

phase == “adReady”,isError == false,type == “interstitial”

phase == “adLoadFailed”, isError == true, error == error message(string), type == “interstitial”

phase == “adOpened”, isError == false, type == “interstitial”

phase == “adClosed”, isError == false, type == “interstitial”

phase == “adShowSucceeded”, isError == false, type == “interstitial”

phase == “adShowFailed”, isError == false, type == “interstitial”, error == error message(string)

phase == “adClicked”, isError == false, type == “interstitial”

Offerwall:

phase == “wallAvailable”, isError == false, available == boolean(could be false or true), type == “offerwall”

phase == “wallOpened”, isError == false, type == “offerwall”

phase == “wallShowFailed”, isError == true, type == “offerwall”, error == error message(string)

phase == “wallCredited”, isError == false, type == “offerwall”, credits == (number) credits user has earned, totalCredits == (number) total credits user has earned, totalCreditsFlag == (boolean) if credits will be equal to total credits

phase == “wallCreditsFailed”, isError == true, type == “offerwall”, error == error message(string)

phase == “wallClosed”, isError == false, type == “offerwall”

Reward Video:

phase == “availabilityChanged”, isError == false, type == “rewardedVideo”, available == boolean(could be false or true)

phase == “adClosed”, isError == false, type == “rewardedVideo”

phase == “adOpened”, isError == false, type == “rewardedVideo”

phase == “adStarted”, isError == false, type == “rewardedVideo”

phase == “adEnded”, isError == false, type == “rewardedVideo”

phase == “adRewarded”, isError == false, type == “rewardedVideo”, rewardName == reward name from video ad(string), rewardAmount == reward amount from video ad(number)

phase == “adShowError”, isError == true, type == “rewardedVideo”, error == error message(string)

phase == "didClickRewardedVideo", isError == false, type == “rewardedVideo”

Build Settings:

Helpful Links:

Get Plugin

Example

Support