Dexus-Forks / cordova-plugin-ironSource

ironSource Mobile ads - aka supersonic
MIT License
5 stars 2 forks source link

IronSource Ads Cordova Plugin

Greenkeeper badge

Add support for IronSource Ads to your Cordova and Phonegap based mobile apps.

How do I install it?

If you're like me and using CLI:

cordova plugin add cordova-plugin-ironsource

or

cordova plugin add https://github.com/blakgeek/cordova-plugin-ironSource

or

phonegap local plugin add https://github.com/blakgeek/cordova-plugin-ironSource

How do I use it?

document.addEventListener('deviceready', function() {

    var isAds = new IronSourceAds("yo_app_key", "some_unique_userid");

    // show a rewarded ad
    isAds.showRewardedAd();

    // show a rewarded ad for placement RightHere
    isAds.showRewardedAd("RightHere");

    // show an offerwall
    isAds.showOfferWall();

    // show an interstitial
    isAds.showInterstitial();

    // launch in Android Studio/Xcode mediation integration verification
    isAds.validateIntegration();

    // Check is a rewarded video is available to show
    isAds.isRewardedVideoAvailable(function () {
        alert('Yes');
    }, function () {
        alert('No');
    });

    // Check is an interstitial is available to show
    isAds.isInterstitialAdAvailable(function () {
        alert('Yes');
    }, function () {
        alert('No');    
    });

    // give em some credit
    window.addEventListener("offerwallCreditReceived", function(e) {

        var credit = e.credit;

        // The number of credits the user has earned.
        console.log(credit.amount);

        // The total number of credits ever earned by the user.
        console.log(credit.total):

        // estimated flag is the same as totalCreditsFlag 
        // In some cases, we won’t be able to provide the exact
        // amount of credits since the last event (specifically if the user clears
        // the app’s data). In this case the ‘credits’ will be equal to the ‘totalCredits’,
        // and this flag will be ‘true’.
        console.log(credit.estimated);

    }, false);

    // reward your users
    window.addEventListener("rewardedVideoRewardReceived", function(e) {

        var placement = e.placement;
        console.log(placement.id); // only available on android
        console.log(placement.name);
        console.log(placement.reward);
        console.log(placement.amount);
    }, false);

}, false);

Can I just see a working example?

Yep. Check out the demo project. It runs on both Android and iOS.

What events are supported?

Interstitial

  1. onInterstitialAdClicked
  2. onInterstitialAdClosed
  3. onInterstitialAdLoadFailed
  4. onInterstitialAdOpened
  5. onInterstitialAdReady
  6. onInterstitialAdShowFailed
  7. onInterstitialAdShowSucceeded

Offerwall

  1. onOfferwallAdCredited
  2. onGetOfferwallCreditsFailed
  3. onOfferwallAvailable
  4. onOfferwallClosed
  5. onOfferwallOpened
  6. onOfferwallShowFailed

Rewarded Video

  1. onRewardedVideoAdClosed
  2. onRewardedVideoAdEnded
  3. onRewardedVideoAdOpened
  4. onRewardedVideoAdRewarded
  5. onRewardedVideoAdShowFailed
  6. onRewardedVideoAdStarted
  7. onRewardedVideoAvailabilityChanged