The Android Ads SDK exists to allow Android developers to integrate Adblade ads into their apps easily. It is compatible with Android 2.3.3 and newer. Currently, the SDK supports 3 types of ads: banner, interstitial, and native.
This is an example Android app that uses the Adiant Ads SDK to display ads.
Javadocs are hosted on GitHub.
Currently, the SDK's binaries are hosted on Adiant's Maven repository.
Add Adiant's Maven repository to your project:
repositories {
maven {
url 'http://ftp.adiant.com/artifactory/libs-release'
}
}And add the SDK's aar to your project's dependencies
dependencies {
compile 'com.adiant.android.ads:ads:1.1.1@aar'
}Add Adiant's Maven repository to your project:
<repositories>
<repository>
<id>adiant-repo</id>
<url>http://ftp.adiant.com/artifactory/libs-release</url>
</repository>
</repositories>And add the SDK's aar to your project's dependencies
<dependencies>
<dependency>
<groupId>com.adiant.android.ads</groupId>
<artifactId>ads</artifactId>
<version>1.1.1</version>
<type>aar</type>
</dependency>
</dependencies>This information is also available on our wiki.
For all types of ads, an app must require the INTERNET and ACCESS_NETWORK_STATE permissions in its manifest:
<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
package="com.example.android.app">
<!-- ... -->
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<!-- ... -->
</manifest>Add an AdView element to your layout XML. Be sure to replace the ad unit ID with your ID, and choose the size of the ads you want. Add the adiant namespace as well.
<RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:adiant="http://schemas.android.com/apk/res-auto"
<!-- ... -->
<com.adiant.android.ads.AdView
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:id="@+id/adViewBannerAd"
adiant:adunitid="13325-2514722925"
adiant:adsize="AD_728_90"
adiant:smart="true" />
<!-- ... -->Get a reference to the AdView element, set your ad unit ID and ad size (if you did not specify them in the XML), and load an ad:
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
// load banner ad
final AdView adView = (AdView) findViewById(R.id.adViewBannerAd);
adView.loadAd();
// rest of your code ...
}| Name | Width | Height |
|---|---|---|
| AD_300_250 | 300 px | 250 px |
| AD_728_90 | 728 px | 90 px |
| AD_320_50 | 320 px | 50 px |
| AD_320_100 | 320 px | 100 px |
| AD_468_60 | 468 px | 60 px |
Add the AdActivity to your AndroidManifest.xml:
<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
package="com.example.android.app" >
<!-- ... -->
<activity android:name="com.adiant.android.ads.AdActivity"
android:configChanges="keyboard|keyboardHidden|orientation|screenLayout|uiMode|screenSize|smallestScreenSize"
android:theme="@android:style/Theme.Translucent" />
<!-- ... -->
</manifest>In your activity, instantiate the InterstitialAd class, and give it your ad unit ID. Load an ad in the background, and show the add when the user proceeds forward in your app.
private InterstitialAd interstitial;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
// create interstial ad
interstitial = new InterstitialAd(this);
interstitial.setAdUnitId("13323-2709803565");
interstitial.setAdListener(new AdListener() {
@Override
public void onAdClosed() {
doTheNextThing();
}
});
// load our first ad in the background
interstitial.loadAd();
// button listener to show ad
final Button nextButton = (Button) findViewById(R.id.buttonNext);
nextButton.setOnClickListener(new OnClickListener() {
@Override
public void onClick(View v) {
if (interstitial.isLoaded()) {
interstitial.show();
} else {
// handle case where as has not loaded
doTheNextThing();
}
}
});
// rest of your code ...
}Add a hook to clean-up resources in the the activity's onDestroy() method.
@Override
protected void onDestroy() {
if (interstitial != null) {
interstitial.destroy();
}
super.onDestroy();
}The Ads SDK supports displaying native ads with your custom layout in a ListView or GridView.
Create a layout for native ads, e.g. list_item_native_ad.xml:
<RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android"
android:layout_width="match_parent" android:layout_height="wrap_content"
android:paddingLeft="@dimen/list_item_horizontal_margin"
android:paddingRight="@dimen/list_item_horizontal_margin"
android:paddingTop="@dimen/list_item_vertical_margin"
android:paddingBottom="@dimen/list_item_vertical_margin">
<ImageView
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:paddingRight="@dimen/list_item_horizontal_margin"
android:id="@+id/imageView"
android:layout_centerVertical="true"
android:contentDescription="@string/ads_description" />
<TextView
android:text="@string/interstitial_intro"
android:textAppearance="?android:attr/textAppearanceMedium"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_toRightOf="@+id/imageView"
android:id="@+id/textViewTitle" />
<TextView
android:text="@string/interstitial_intro"
android:textAppearance="?android:attr/textAppearanceSmall"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_below="@+id/textViewTitle"
android:layout_toRightOf="@+id/imageView"
android:id="@+id/textViewDescription" />
</RelativeLayout>- Create a NativeAdFactory instance as early as possible, and preload ads to show in the list.
- Be sure to use your ad unit ID with the NativeAdFactory.
- Wrap your list adapter within a NativeAdAdapter.
- Create a NativeAdInflater that will create the view for each native ad.
@Override
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
// create ad factory
NativeAdFactory adFactory = new NativeAdFactory(getActivity(), "13325-2514722925", new NativeAdArbiter());
// estimate total items shown
adFactory.init(10);
ListAdapter adapter;
// setup your adapter ...
// create a view binder that sets the resource IDs for each
ViewBinder binder = new ViewBinder.Builder()
.setImageId(R.id.imageView)
.setTitleId(R.id.textViewTitle)
.setDescriptionId(R.id.textViewDescription)
.setDisplayNameId(R.id.textViewDisplayName)
.create();
// create ad inflater with the resource ID for your native ad layout
NativeAdInflater adInflater = new NativeAdInflater(getActivity(), binder, R.layout.list_item_native_ad);
// wrap adapter inside adapter that inserts native ads
adapterWithAds = new NativeAdAdapter(adapter, adInflater, adFactory);
// use the adapter
setListAdapter(adapterWithAds);
}Add a hook to clean-up resources in the the fragment's onDestroy() method. This is necessary only for Android 2.3.3 (API level 10) and lower.
@Override
public void onDestroy() {
if (adapterWithAds != null) {
adapterWithAds.destroy();
}
super.onDestroy();
}If you encounter issues with the SDK or with this example app, please open an issue on GitHub.
- Support for mediation via MoPub SDK
- Rich-media ads
- Slide-show ads (ScrollRoll)
- Dynamic banner ads
- Initial version
- Static banner ads
- Static interstitial ads
- Native ad adapter