Latest stable Version 2.1
The SDK supports Android 2.2 and higher.
Language Support: Java
Use Android SDK Tools v23 or higher
Dependencies Google Play Services v25 or higher required
The SDK is available as a gradle project.
- Extract and import the SDK (GuJeMSSDK) to your project.
- Add our SDK to you gradle File.
dependencies {
compile project(':GuJeMSSDK')
[...]
}
- Well done!
If you are interested in upgrading the SDK please move forward to Chapter "Upgrading from v1.4.x to v2.0.x". In this chapter we will show you how to add banner ads, interstitial ads, video ads and native ads to your android app.
Before you start with the implementation please make sure that you recieved your Ad Unit Id.
You have two possibilities to add one or more banner ads to your app. The first way is by adding a view to your layout file.
<de.guj.ems.mobile.sdk.views.GuJEMSAdView
android:id="@+id/banner_top"
android:layout_width="match_parent"
android:layout_height="wrap_content"
ems:ems_onAdEmpty="onAdEmpty"
ems:ems_onAdError="onAdError"
ems:ems_onAdSuccess="onAdSuccess"
ems:ems_adUnit="sdktest,1,no" />To get the ems namespace add the following attribute to your Root-View:
xmlns:ems="http://schemas.android.com/apk/res/[your package path]"Let's have a look on the attributes for GuJEMSAdView:
- ems_onAdEmpty : Method which is called, when no ad was found.
- ems_onAdError : Method which is called, when an error occured
- ems_onAdSuccess : Method which is called, when an ad is loaded successfully
- ems_adUnit : [your Ad Unit Id], [Ad Position], [Is index page?]
- ems_geo : [true / false] Add the current geo location if it exists
- ems_kw : [true / false] Allow transmission of keywords
- ems_noRectangle, ems_noBillboard, ems_no[...] : Block special ad sizes for this ad slot
You also have the possibility to add banner ad programmatically:
- Create an separate layout file for your banner ad
- Add a GuJEMSAdView to the file. Example:
<?xml version="1.0" encoding="utf-8"?>
<de.guj.ems.mobile.sdk.views.GuJEMSAdView
xmlns:android="http://schemas.android.com/apk/res/android"
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:id="@+id/banner_top">
</de.guj.ems.mobile.sdk.views.GuJEMSAdView>- Create the view in your code. Example:
/* initialize the GujEMSAdView */
GuJEMSAdView gujView = new GuJEMSAdView(getApplicationContext(), R.id.banner_top, false);
/* set Ad Unit Id and position */
gujView.setAdUnitId("sdktest", 1);
/* Is Index Page? */
gujView.getSettings().addCustomRequestParameter("ind", "no");
/* set event listener call when ad is empty */
gujView.setOnAdEmptyListener(new IOnAdEmptyListener() {
@Override
public void onAdEmpty() {
/* Do something */
}
});
/* set event listener called when error occured */
gujView.setOnAdErrorListener(new IOnAdErrorListener() {
@Override
public void onAdError(String msg) {
/* Do something */
}
@Override
public void onAdError(String msg, Throwable t) {
/* Do something */
}
});
/* block rectangle */
gujView.setNoRectangle(true);
/* set Content URL for Targeting */
gujView.setContentUrl("http://gujmedia.de");
/* load ad */
gujView.load();
/* add adView to Layout */
addView(gujView);The interstitial ad can only create programmatically. Let's have a look on an example:
Intent target = new Intent(getApplicationContext(), <TARGET-ACTIVITY>);
Intent i = new Intent(getActivity(),
InterstitialSwitchReceiver.class);
/* set Ad Unit Id */
i.putExtra("adUnitId", "sdktest");
/* initialize an ListenerEvents object -> class wihich implements IOnAdEmptyListener, etc.) */
ListenerEvents le = new ListenerEvents();
/* set event listener */
i.putExtra("ems_onAdSuccess", le);
i.putExtra("ems_onAdEmpty", le);
i.putExtra("ems_onAdError", le);
/* set target activity */
i.putExtra("target", target);
/* open interstitial */
getActivity().sendBroadcast(i);If the intent “target” is not set, the interstitial closes itself and returns to the previous view. The Class ListenerEvents isn't part of the SDK.
Please have a look at the chapter "Video Advertising".
Please have a look at the chapter "Native Advertisitng".
Please have a look at the chapter "InFlow Ad"
If you are not upgrading please contact us for an additional update you will need.
If you previously used version 1.4.x of this SDK there are several important changes you need to pay attention to.
Under the hood we exchanged the Amobee Ad Server with Googles DoubleClick for Publishers (DFP).
Also we did some cleanup to make the SDK better understandable.
First step during upgrade from 1.4.x is to remove all libraries and files belonging to the old SDK installation. This includes all libraries and manifest files.
Then add the new SDK extract the archive to your workspace and import the existing project.
ems:ems_nkw <!-- Negative keywords are no longer supported -->
ems:ems_uid <!-- Advertiser ID transmission is handled by Google -->
ems:ems_bfSiteId <!-- The backfill site ID is no longer supported -->
ems:ems_bfZoneId <!-- The backfill zone ID is no longer supported -->
ems:ems_gPubId <!-- The Google publisher ID is no longer supported -->All close buttons etc. are handled by the Google SDK
For now the test mode has been removed. We will reintroduce default Google test ads in the next release.
GuJEMSNativeAdView is no longer supported, all display views are handled by the Google SDK GuJEMSNativeListAdView is no longer supported, all display views are handled by the Google SDK org.ormma.Browser no longer exists since we have moved on to MRAID
Providing a target activity / intent to an interstitial is no longer supported. Interstitials will be shown as soon as they are loaded and overlay.
Google interstitials are capable of displaying video by themselves.
Other than the changes mentioned the SDK also incorporates an internal XML file which maps the old ems_zoneId to a new Google doubleclick identifier. This allows the developer to keep the existing implementation and not having to adjust to Google specific features.
The experimental use of video interstitials as a preroll player has been removed. See [Video Advertising] (#video) on how to utilize the integrated video player
The Google publisher ID no longer needs to be set manually
We are now supporting Google's Native Content Ads. See [Native advertising} (#native) on how to utilize native ads an adjust them to your layout.
All permissions that may be revoked by the user are optional and checked for. Your app should work flawlessly in case a user removes, for example, the location permission.
All SDK permissions other than location adn networking have been commented out in the manifest. Please check the manifest if you previously had certain permissions set, e.g. for camera access or vibration
By default the GuJEMSAdViews accept all feasible ad sizes. You can block large ad sizes by either:
- Adding layout attributes to your view
ems:ems_noRectangle="true" <!-- blocks 300x350 ads on smartphones -->
ems:ems_noBillboard="true" <!-- blocks 1024x220 (landscape) and 768x300 (portrait) ads on tablets -->
ems:ems_noDesktopBillboard="true" <!-- blocks 800x250 ads on tablets -->
ems:ems_noLeaderboard="true" <!-- blocks 728x90 and 768x90 ads on both smartphones and tables -->
ems:ems_noTwoToOne="true" <!-- blocks 300x150 ads on smartphones -->- Programmatically supressing them
GuJEMSAdView.setNoRectangle(true)
GuJEMSAdView.setNoBillboard(true)
GuJEMSAdView.setNoDesktopBillboard(true)
GuJEMSAdView.setNoLeaderboard(true)
GuJEMSAdView.setNoTwoToOne(true)This is no longer supported. Set the zone or adunit with the respective setter method for GuJEMSAdView
Providing inventory to the Google Ad Exchange for programmatic advertising is handled internally by the SDK and configured by G+J e|MS via the adserver.
Usage only in ScrollViews!
You have two possibilities to add an InFlow to your app. The first way is by adding a view to your layout file.
<de.guj.ems.mobile.sdk.views.video.GuJEMSInFlowView
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:id="@+id/InFlowPlayer"
app:ems_adUnit="">
</de.guj.ems.mobile.sdk.views.video.GuJEMSInFlowView>- ems_adUnit : [your InFlow Ad Unit Id]
You also have the possibility to add InFlow ad programmatically:
- Add the InFlow View to your layout
<de.guj.ems.mobile.sdk.views.video.GuJEMSInFlowView
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:id="@+id/InFlowPlayer"
</de.guj.ems.mobile.sdk.views.video.GuJEMSInFlowView>- Add the following code to your App:
GuJEMSInFlowView inflow = (GuJEMSInFlowView)rootView.findViewById(R.id.InFlowPlayer);
/** Change the colour of the sound on/off button and the close button -> use Hexcode**/
inflow.setColorToButtons("#00a600");
/** Set AdUnit **/
inflow.setAdUnit(adUnitId);The new SDK comes with the current beta version of the Google IMA3 SDK for Android. A player capable of displaying ads from G+J e|MS is included as well as a view displaying videos with ads: GuJEMSVideoView. Both the view and the player are based on the IMA3 reference implementation.
In your activity's or fragment's layout include the player like this
<de.guj.ems.mobile.sdk.views.video.GuJEMSVideoPlayer
android:id="@+id/ems_sample_video_player"
android:layout_width="match_parent"
android:layout_height="match_parent"
android:layout_gravity="center"
android:gravity="center"
ems:ems_adUnit="[provided_adUnit]">[provided_adUnit] will be a string you receive from G+J e|MS - it reflects the app's name or category in the app where video ads should be displayed when playing video. If you are unable to set the adUnit via xml, here's the programmatic way to do it
// get player view
mVideoPlayerWithAdPlayback = (GuJEMSVideoPlayer)findViewById(R.id.ems_sample_video_player);
// set ad unit
mVideoPlayerWithAdPlayback.setAdUnit("stern/panorama");In your activity or fragment tell the player which content video to load
setContentView(R.layout.video_sample);
// get player view
mVideoPlayerWithAdPlayback = (GuJEMSVideoPlayer)findViewById(R.id.ems_sample_video_player);
// specifiy conent video url
mVideoPlayerWithAdPlayback.getVideoPlayerController().setContentVideo(testContentUrl);Add callbacks to your video player like this
// add callback
mVideoPlayerWithAdPlayback.setOnContentCompleteListener(new OnContentCompleteListener() {
@Override
public void onContentComplete() {
SdkLog.d(TAG, "onContentComplete");
finish();
}
});Tell the player to play and request ads like this
mVideoPlayerWithAdPlayback.requestAndPlayAds();Depending on the lifecyle of your avctivity / fragment, add these
@Override
public void onResume() {
mVideoPlayerWithAdPlayback.resume();
super.onResume();
}
@Override
public void onPause() {
mVideoPlayerWithAdPlayback.pause();
super.onPause();
}Everything else is handled via G+J e|MS and the respective adserver.
The new SDK comes with the current beta version of Google NativeContentAds. These ads are meant to be fully customized and display content in the same style and layout as your app. Native content ads are typically filled with things like a headline, an image, a logo and a call to action.
In your activity's or fragment's layout include the view like this (please not that the view is ONLY capable of displaying native ads and should not replace or be placed instead of normal ad views.
<de.guj.ems.mobile.sdk.views.GuJEMSNativeContentAdView
android:id="@+id/ad24757"
android:layout_width="match_parent"
android:layout_height="wrap_content"
ems:ems_adUnit="[provided_adUnit]"
/> The view accepts all the same additional attributes as GuJEMSAdView. [provided_adUnit] will be a string you receive from G+J e|MS - it reflects the app's name or category in the app where native ads should be displayed. If you are unable to set the adUnit via xml, you can set the ad unit programmatically with setAdUnit.
GuJEMSNativeContentAdView adview = new GuJEMSNativeContentAdView(
getApplicationContext(),
R.layout.layout_native, /* seperate layout file - see banner ad for more informations */
false
);
/* set Ad Unit Id */
adview.setAdUnitId("sdktest");
/* load ad */
adview.load();
addView(adview);The SDK folder contains
R.layout.ems_nativead R.values.ems_nativead_style
These may be adapted to your needs - as long as non of the views's holding content are removed. You may also create copies for large resolutions devices or unified smartphone/tablet apps.
The SDK will take care of filling the view with the corresponding received from the adserver.