Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
tree: f66e28336b
Fetching contributors…

Cannot retrieve contributors at this time

196 lines (142 sloc) 6.807 kb

TapIt Android SDK

Version 1.7.5

This is the Android SDK for the TapIt! mobile ad network. Go to http://tapit.com/ for more details and to sign up.

/dist Library files to be included in your app
/src SDK and example project source

Usage:

To install, extract the SDK archive(https://github.com/tapit/TapIt-Android-SDK-Source/raw/master/dist/TapItSDK-android.zip) into your project's /lib folder, and add TapItAdView.jar into the project's build path:

Add TapItAdView.jar to Build Path

Set TapItAdView.jar to be exported as part of your apk file:

Export TapItAdView.jar

<uses-permission android:name="android.permission.INTERNET"></uses-permission>
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"></uses-permission>
<uses-permission android:name="android.permission.READ_PHONE_STATE"></uses-permission>

<!-- Optional permissions to enable ad geotargeting
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION"></uses-permission>
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION"></uses-permission>
-->

<!-- inside of the application tag: -->
<activity
    android:name="com.tapit.adview.AdActivity"
    android:configChanges="keyboard|keyboardHidden|orientation" />

Your manifest should look something like this:

Example manifest

See https://github.com/tapit/TapIt-Android-SDK-Source/blob/master/src/example/AndroidManifest.xml for an example manifest file.

NOTE: Zones correspond to a specific ad type, which is specified through the TapIt dashboard. Please ensure that you use the correct Zone ID for your ad units or you may experience un-expected results.

A sample project is included in this repo. See https://github.com/tapit/TapIt-Android-SDK-Source/tree/master/src/example for a live demo.

AdPrompt Usage

AdPrompts are a simple ad unit designed to have a native feel. The user is given the option to download an app, and if they accept, they are taken to the app within the app marketplace.

AdPrompt adPrompt = new AdPrompt(this, "YOUR_ZONE_ID");
adPrompt.showAdPrompt();

Sample implementation can be found here: https://github.com/tapit/TapIt-Android-SDK-Source/blob/master/src/example/src/com/yourcompany/TapItTestActivity.java#L178

Banner Usage

<!-- Add banner to your layout xml -->
<com.tapit.adview.AdView
    android:id="@+id/bannerAd"
    android:layout_width="fill_parent"
    android:layout_height="wrap_content"
    android:layout_alignParentBottom="true"
    zone="YOUR_ZONE_ID" />
import com.tapit.adview.AdView;
// ...
private AdView bannerAd;
// ...
bannerAd = (AdView)findViewById(R.id.bannerAd);

// you can optionally register a listener to be notified of banner lifecyle events:
bannerAd.setOnAdDownload(new OnAdDownload() {
    // anonymous listener

    public void begin(AdViewCore adView) {
        // fired before banner download begins.
    }

    public void end(AdViewCore adView) {
        // fired after banner content fully downloaded.
    }

    public void error(AdViewCore adView, String error) {
        // fired after fail to download content.
    }

    public void clicked(AdViewCore adView) {
        // fired after a user taps the ad.
    }

    public void willPresentFullScreen(AdViewCore adView) {
        // fired just before an ad takes over the screen.
    }

    public void didPresentFullScreen(AdViewCore adView) {
        // fired once an ad takes over the screen.
        // Stop updating your UI to allow for a smooth ad experience
    }

    public void willDismissFullScreen(AdViewCore adView) {
        // fired just before an ad dismisses it's full screen view.
    }

    public void willLeaveApplication(AdViewCore adView) {
        // fired just before the app will be sent to the background.
    }
});

Sample implementation can be found here: https://github.com/tapit/TapIt-Android-SDK-Source/blob/master/src/example/src/com/yourcompany/TapItTestActivity.java#L59

Interstitial Usage

Interstitials are best used at discrete stopping points in your app's flow, such as at the end of a game level, or when the player dies.

Simple Implementation

AdInterstitialView interstitialAd; // class property

...

interstitialAd = new AdInterstitialView(this, "YOUR_ZONE_ID");
interstitialAd.load(); // request an ad from the server, to be displayed later...

... // some time passes as your app continues normally

// when you're ready to display interstitial,
if(interstitialAd.isLoaded()) {
    // interstitial was loaded successfully, show it!
    interstitialAd.showInterstitial();
}

Advanced Implementation

For more control of the interstitial lifecycle, listen for OnInterstitialAdDownload events

AdInterstitialView interstitialAd; // class property

...

interstitialAd = new AdInterstitialView(this, "YOUR_ZONE_ID");
// register a listener to be notified on interstitial state changes
interstitialAd.setOnInterstitialAdDownload(new OnInterstitialAdDownload() {
    // anonymous listener

    public void willLoad(AdViewCore adView) {
        // fired before banner download begins.
    }

    public void ready(AdViewCore adView) {
        // fired after banner content is fully downloaded.
        // you can show the interstitial at any time after receiving this event.

        // in this example, we show the interstitial as soon as it's ready
        interstitialAd.showInterstitial();
    }

    public void willOpen(AdViewCore adView) {
        // fired just before an action is fired.
        // Stop updating your UI to allow for a smooth ad experience
    }

    public void didClose(AdViewCore adView) {
        // fired after an interstitial closes and your app is again visible.
        // Start updating your UI again.
    }

    public void error(AdViewCore adView, String error) {
        // fired if the interstitial request fails to return an ad.
        // Throw this interstitial object away.
    }

    public void clicked(AdViewCore adView) {
        // fired after a user taps the ad.
    }

    public void willLeaveApplication(AdViewCore adView) {
        // fired just before the app will be sent to the background.
    }
});
interstitialAd.load(); // request an ad from the server, to be displayed later...

Sample implementation can be found here: https://github.com/tapit/TapIt-Android-SDK-Source/blob/master/src/example/src/com/yourcompany/TapItTestActivity.java#L191

Jump to Line
Something went wrong with that request. Please try again.