Android SDK

git clone https://github.com/e-planning/mobile-sdk-android.git

include ':app', ':sdk'

dependencies {
    compile project(":sdk")
}

<!-- Android: XML to include recommended permissions -->
<manifest xmlns:android="http://schemas.android.com/apk/res/android">

<!-- Add the permissions here... -->
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />

### Proguard settings to support Android Advertiser ID
-keep class com.google.android.gms.ads.identifier.AdvertisingIdClient {
    com.google.android.gms.ads.identifier.AdvertisingIdClient$Info getAdvertisingIdInfo(android.content.Context);
}
-keep class com.google.android.gms.ads.identifier.AdvertisingIdClient$Info {
    java.lang.String getId();
    boolean isLimitAdTrackingEnabled();
}

// Android: XML to configure the banner ad view (optional)
xmlns:opensdk="https://schemas.android.com/apk/res/com.example.SimpleBanner"

// Android: XML to declare banner ad view (optional)
<net.eplanning.opensdk.BannerAdView
    android:id="@+id/banner"
    android:layout_width="wrap_content"
    android:layout_height="wrap_content"
    opensdk:publisher_id=YOUR PUBLISHER ID
    opensdk:placement_id="YOUR PLACEMENT ID"
    opensdk:auto_refresh_interval="60000"
    opensdk:adWidth="320"
    opensdk:adHeight="50"
    opensdk:should_reload_on_resume="true"
    opensdk:opens_native_browser="true"
    android:expands_to_fit_screen_width="false"
    />

// Android: Java to show a banner ad
package eplanning.example.kotlinsample

import android.os.Bundle
import android.util.Log
import android.widget.LinearLayout
import android.widget.Toast
import androidx.appcompat.app.AppCompatActivity
import net.eplanning.opensdk.AdListener
import net.eplanning.opensdk.AdView
import net.eplanning.opensdk.BannerAdView
import net.eplanning.opensdk.NativeAdResponse
import net.eplanning.opensdk.ResultCode

class BannerActivity : AppCompatActivity(), AdListener {

    private lateinit var banner: BannerAdView
    private lateinit var layout: LinearLayout

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_banner)
        layout = findViewById(R.id.linearLayout)

        banner = BannerAdView(this)
        banner.setPublisherId(123456) // PublisherID
        banner.placementID = "17058950" // PlacementID
        banner.setAdSize(300, 250) // Size
        banner.adListener = this // AdListener
        banner.loadAd()
        layout.addView(banner)
    }

    override fun onAdLoaded(ad: AdView?) {
        log("Banner Ad Loaded")
    }

    override fun onAdLoaded(nativeAdResponse: NativeAdResponse?) {
        log("Native Ad Loaded")
    }

    override fun onAdClicked(adView: AdView?) {
        log("Ad Clicked")
    }

    override fun onAdClicked(adView: AdView?, clickUrl: String?) {
        log("Ad Clicked with URL: $clickUrl")
    }

    override fun onAdExpanded(adView: AdView?) {
        log("Ad Expanded")
    }

    override fun onAdCollapsed(adView: AdView?) {
        log("Ad Collapsed")
    }

    override fun onAdRequestFailed(adView: AdView?, resultCode: ResultCode?) {
        log("Ad Failed: " + resultCode?.message)
    }

    override fun onLazyAdLoaded(adView: AdView?) {
        log("Ad onLazyAdLoaded")
    }

    override fun onAdImpression(adView: AdView?) {
        log("Ad onAdImpression")
    }

    private fun log(msg: String){
        Log.d("BannerActivity",msg)
        Toast.makeText(this.applicationContext, msg, Toast.LENGTH_LONG).show()
    }

    override fun onDestroy() {
        if (banner != null) {
            banner.activityOnDestroy()
        }
        super.onDestroy()
    }
    
}

// Android: Java code to show an interstitial ad
package com.example.simpleinterstitial;
import android.os.Bundle;
import android.app.Activity;
import android.view.Menu;
import android.util.Log;
import net.eplanning.opensdk.AdListener
import net.eplanning.opensdk.AdView
import net.eplanning.opensdk.BannerAdView
import net.eplanning.opensdk.NativeAdResponse
import net.eplanning.opensdk.ResultCode

public class MainActivity extends Activity implements AdListener {
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        
        InterstitialAdView iav = new InterstitialAdView(this);
        iav.setPublisherID(123456);
        iav.setPlacementID("1326299");
        iav.setAdListener(this);
        // Fetch an ad from the server.  If this works, `onAdLoaded' will
        // be called, and we can show the ad.
        iav.loadAd();
    }
        @Override
        protected void onDestroy() {
        if (iav != null) {
                iav.activityOnDestroy();
        }
        super.onDestroy();
        }
    @Override
    public void onAdLoaded(AdView av) {
        Log.d("onAdLoaded", "The ad has loaded, now we can show it...");
        // Now that the ad has loaded, we can show it to the user.
        InterstitialAdView iav = (InterstitialAdView) av;
        iav.show();
    }
 
    @Override
    public void onAdLoaded(NativeAdResponse nativeAdResponse) {
        // JUST ignore it. This callback is for Native in Banner. 
    }
    @Override
    public void onAdRequestFailed(AdView av, ResultCode rc) {
        Log.d("onAdRequestFailed", "Not sure why the ad request failed; try again? Return code ==> " + rc);
    }
    @Override
    public void onAdClicked(AdView av) {
        Log.d("onAdClicked", "The user clicked your ad.  Congrats!");
    }
    @Override
    public void onAdClicked(AdView adView, String clickUrl) {
        // This will be getting called if you have set setClickThroughAction(ANClickThroughAction.RETURN_URL);
        // Handle the URL appropriately
    }
    @Override
    public void onAdCollapsed(AdView av) {
        // Do something here.
    }
    @Override
    public void onAdExpanded(AdView av) {
        // Do something here as well.
    }
}

// Android: Java code to show interstitial ads in sizes other than the defaults (optional)
InterstitialAdView iav = new InterstitialAdView(this);
iav.setPublisherId(123456);
iav.setPlacementID("1326299");
AdSize test_size1 = new AdSize(320,480);
AdSize test_size2 = new AdSize(768,1024);
ArrayList test_array_list = new ArrayList() {};
test_array_list.add(test_size1);
test_array_list.add(test_size2);
iav.setAllowedSizes(test_array_list);

// This will show an interstitial ad, wait for 10 seconds, then auto close it.
interstitialAdView.showWithAutoDismissDelay(10);

// Create a VideoAd instance
VideoAd videoAd = new VideoAd(this);
videoAd.setPublisherID(123456);
videoAd.setPlacementID("1326299");
// Set the (optional) VideoAdLoadListener.
videoAd.setAdLoadListener( new VideoAdLoadListener() {
  @Override
   public void onAdLoaded(VideoAd videoAd) {
        Log.d(TAG,  "onAdLoaded" );
   }
   @Override
     public void onAdRequestFailed(VideoAd videoAd, ResultCode errorCode) {
        Log.d(TAG,  "onAdRequestFailed" );
     }
  });
// At this point you can set targeting parameters, the ad landing
// page, and many other options before calling `loadAd()`.  For
// details, see the SDK documentation.
// Load the VideoAd.
videoAd.loadAd();

/ Set the (mandatory) PlayBack Listener.
videoAd.setVideoPlaybackListener( new VideoAdPlaybackListener() {   
  @Override
  public void onAdPlaying( final VideoAd videoAd) {
    Log.d(TAG,  "onAdPlaying::" );
  }
  @Override
  public void onQuartile(VideoAd view, Quartile quartile) {
    Log.d(TAG,  "onQuartile::" + quartile);
  }
  // Resume your VideoPlayer with the 'onAddCompleted' notification.
  @Override
  public void onAdCompleted(VideoAd view, PlaybackCompletionState playbackState) {
    Log.d(TAG,  "onAdCompleted::playbackState" + playbackState);
    videoPlayer.start();
    // The 'videoPlayer' here is your Application Content Video Player.
  }
  @Override
  public void onAdMuted(VideoAd view,  boolean isMute) {
    Log.d(TAG,  "isAudioMute::" + isMute);
  }
  @Override
  public void onAdClicked(VideoAd adView) {
    Log.d(TAG,  "onAdClicked" );
  }           
  @Override
  public void onAdClicked(VideoAd videoAd, String clickUrl) {
    Log.d(TAG,  "onAdClicked" );
  }
});

// This is important because it's used to resume the ad after an interruption by user activity.
@Override
public void onResume() {
     super .onResume();
     videoAd.activityOnResume();
}
@Override
public void onPause() {
     super .onPause();
     videoAd.activityOnPause();
}
// Used to clear the memory footprint of the VideoAd instance.
@Override
public void onDestroy() {
     super .onDestroy();
     videoAd.activityOnDestroy();
}

if (videoAd.isReady()) {
     // Pause your app's video player.
     videoPlayer.pause();
     // Play the Ad by passing the container. The container here is a
     // FrameLayout/RelativeLayout, on top of which the ad will be
     // displayed.
     videoAd.playAd(baseContainer);
}

public void resumeAd();
public void pauseAd();

public String getVastURL()  //Provide the VAST content URL
public int getVideoAdDuration()  //Provide the duration of the video
public String getVastXML()  //Provide the VAST content as an XML string
public String getCreativeURL()  //Provide the actual creative loaded
public VideoOrientation getVideoOrientation()  //Provide the Orientation of the Video rendered. Possible video orientations can be square, portrait, landscape or none

public void getAdPlayElapsedTime(ResultCallback<String> resultCallback)