This guide provides comprehensive instructions for integrating the Smaato NextGen SDK into your Android application.

Integration Guide for Publishers with AdMob as a Primary Ad Server

(Android NextGen SDK version 23.2.1)

Assumptions

Important Details About GDPR

As a publisher, you should integrate a Consent Management Platform (CMP) and request for vendor and purpose consents as outlined in IAB Europe’s Mobile In-App CMP API v1.0: Transparency & Consent Framework or IAB Tech Lab - CMP API v2.

You can find a reference implementation of a web-based CMP and the corresponding native wrappers here in the IAB’s GDPR-Transparency-and-Consent-Framework.

You can find a reference implementation how is a CMP used in-app here in the IAB's Consent Management Platform API.

If you are embedding your own custom CMP, the collected end-user consent information needs to be stored in SharedPreferences using the following keys:

Transparency and Consent Framework v2 :

Sample of GDPR Saving in SharedPreferences

import android.content.SharedPreferences;
import android.preference.PreferenceManager;
 
...
// User is not subject to GDPR
SharedPreferences sharedPref = PreferenceManager.getDefaultSharedPreferences(context_here);
SharedPreferences.Editor editor = sharedPref.edit();
editor.putString("IABTCF_gdprApplies", 0);
editor.commit();
// Use this example above to set values for the rest of the GDPR keys

Important Details About CCPA

The California Consumer Privacy Act (CCPA) was created to provide California consumers with greater transparency and control over their personal information. In many ways, the CCPA is a first of its kind regulation in the United States that seeks to create broad privacy and data protection rules that apply to all industries doing business in the jurisdiction of California, rather than focusing on a single sector or specific data collection and use practices.

For more information about the CCPA regulation, please check out the Smaato FAQ. You can also review the IAB’s U.S. Privacy String documentation.

For Publishers with California- Based Users

As a publisher, you need to make sure to request consent from California-based users (to give or refuse consent / to opt-out or opt-in ) about private data transfer. This answer should be saved in SharedPreferences with key “IABUSPrivacy_String” in the US Privacy String format (CCPA Opt-Out Storage Format).

The Smaato NextGen SDK reads this value in the key “IABUSPrivacy_String” if it exists and uses this as an optional parameter for all ad requests. You can use SmaatoSdk#getUsPrivacyString method to get a value which is currently stored under the "IABUSPrivacy_String" key. Note that default value is an empty string.

Sample of US Privacy String Saving in SharedPreferences

SharedPreferences sharedPref = PreferenceManager.getDefaultSharedPreferences(context)
SharedPreferences.Editor editor = sharedPref.edit();
editor.putString("IABUSPrivacy_String", "iab string");
editor.commit();

Currently, only the Interstitial Multi-Ad Format is compatible for Fullscreen Adspaces with Smaato NextGen SDK. In order to monetize your fullscreen Adspaces in SPX with Smaato NextGen SDK, you need to select the option for Interstitial (Display & Video). All other Fullscreen options will not work at this time.

Please check if the Interstitial (Display & Video) feature is enabled in your SPX account. If you do not see the option for Interstitial (Display & Video) in the Ad Format dropdown, please contact your Smaato Account Manager to enable this.

• When creating your Fullscreen Adspaces in SPX, choose the Interstitial (Display & video) option as the Ad format. (see Figure 1)

  

• For the Creative Type you will have three options to choose from (see Figure 2):

  • Display Only for Rich Media Ads.
  • Video Only for Video Ads.
  • Display and Video will support either Rich Media or Video Ads.

Ad Format dropdown selection

Ads for Testing Purposes

Publisher ID: 1100042525

Demo App for Sample Integration

Download latest Demo App Apk from here.

AdMob Dashboard Setup

1. Go to the AdMob Dashboard. – https://apps.admob.com/v2/mediation/groups/list
2. Click on Create Mediation Group.
3. Select your Ad format.
   1. Your options are Banner, Interstitial, and Rewarded Video.
4. In the next tab, select your desired parameter settings.
5. For the Add Ad unit option under Ad unit, select the Ad unit that needs to be targeted with the mediation.
6. Under Ad sources, click on ADD CUSTOM EVENT.
   1. Then provide a Label and your desired eCPM.
   2. Under Configure Ad units, provide the class name details:
      1. For Banner: com.smaato.sdk.adapters.admob.banner.SMAAdMobSmaatoBannerAdapter
      2. For Interstitial: com.smaato.sdk.adapters.admob.interstitial.SMAAdMobSmaatoInterstitialAdapter
      3. Rewarded Video: com.smaato.sdk.adapters.admob.rewarded.SMAAdMobSmaatoRewardedVideoAdapter
      4. Native: com.smaato.sdk.adapters.admob.nativead.SMAAdMobSmaatoNativeAdapter
   3. Pass parameter for the SPX Adspace ID:

      • For SDK versions below v23.1.0, use the adSpaceId parameter:

        adSpaceId=<YOUR_SPX_ADSPACE_ID>

        Example: adSpaceId=133149964

      • Starting with SDK v23.1.0, use both the adSpaceId and publisher_v2 parameters:

        adSpaceId=<YOUR_SPX_ADSPACE_ID>&publisher_v2=<PUBLISHER_ID_v2>

        Example: adSpaceId=133149964&publisher_v2=aavvccddjdhdklsjd

SDK Integration

Configure your Android project
Add the following repository setup to your project’s main build.gradle file:

allprojects {  
    repositories {  
        google()  
        jcenter()  
        maven {  
            url "<https://s3.amazonaws.com/smaato-sdk-releases/">  
        }  
    }  
}

Set the compile options to Java 8, (i.e. place the following line into your application module build.gradle file):

android {  
    compileOptions {  
        sourceCompatibility JavaVersion.VERSION_1_8  
        targetCompatibility JavaVersion.VERSION_1_8  
    }  
}

Integration options

Version 23.1.0 and onwards supports AdMob/GAM version 25.0.0 or above.

Due to the modular SDK structure, you can select the integration option that matches your required ad format.

Here are some configuration examples, which should be added into your build.gradle

Banner (with Rich Media support) build.gradle

implementation 'com.smaato.android.sdk:admob-banner-adapter:23.2.1'

Interstitial (with Video & Rich Media support) build.gradle

implementation 'com.smaato.android.sdk:admob-interstitial-adapter:23.2.1'

implementation 'com.smaato.android.sdk:admob-interstitial-adapter:23.2.1'
 {
  exclude module: "module-video"
 }

implementation 'com.smaato.android.sdk:admob-interstitial-adapter:23.2.1' 
{
exclude module: "module-richmedia"
 }

Rewarded Video build.gradle

implementation 'com.smaato.android.sdk:admob-rewarded-video-adapter:23.2.1'

Native build.gradle

implementation 'com.smaato.android.sdk:admob-native-adapter:23.2.1'

Handling onDestroy for Ads in GAM version 20.3 onwards :
As Google Ad Manager and AdMob has removed support for destroying Ads by overriding the onDestory() callback hence we have introduced our own method to handle that part for publishers – SMAAdMobAdapter.onDestroy()

This needs to be called in onDestroy of the activity containing the Ad.

Example given below :

public override fun onDestroy() {  
    super.onDestroy()  
    SMAAdMobAdapter.onDestroy()  
}

Permissions

Add the following permissions to your application AndroidManifest.xml file:

Mandatory permissions:

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

Optional permissions:

<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />

If your application targets Android 5.0 (API level 21) or higher, then add the following line to your application AndroidManifest.xml file:

<uses-feature android:name="android.hardware.location.network" />

Optional Configuration:

i) If your application targets Android 9 Pie (API level 28) or higher, in order to send HTTP requests (using the unencrypted HTTP protocol instead of HTTPS, so that more Ads can be shown), then you need to configure the networkSecurityConfig attribute in the application tag in AndroidManifest.xml:

android:networkSecurityConfig="@xml/network_security_config"

ii) Now create the network_security_config.xml in the XML resource directory with:

android:networkSecurityConfig="@xml/network_security_config"  
<code>?xml version="1 0" encoding="utf-8"?<network-security-config>  
    <base-config cleartextTrafficPermitted="true" />  
</network-security-config>

For more details regarding the Network security configuration, please see the official Google documentation: https://developer.android.com/training/articles/security-config

Proguard Configuration

If you’re using Proguard in your project, please add the following lines to your Proguard config file, as per your requirements:

keep public class com.smaato.sdk.** { \*; }  
    -keep public interface com.smaato.sdk.** { \*; }

SDK initialization

Add to your Application.OnCreate() method the following line, which initializes the Smaato SDK.

SmaatoSdk.init(this, config, publisher_v2);

Optional configuration You can configure additional parameters for the SDK by passing the Config parameter to the init method.

Config config = Config.builder()  
        .setLogLevel(LogLevel.INFO)  
        .setHttpsOnly(false)  
        .build();
SmaatoSdk.init(this, config, publisher_v2);

Additionally, it is recommended to configure the SDK with user information. This is an optional step and can be implemented at a later time using the following configurations:

SmaatoSdk.setKeywords(...);
SmaatoSdk.setSearchQuery(...);
SmaatoSdk.setGender(...);
SmaatoSdk.setAge(...);
SmaatoSdk.setLatLng(...);
SmaatoSdk.setRegion(...);
SmaatoSdk.setLanguage(...);
SmaatoSdk.setZip(...);
SmaatoSdk.setCoppa(...);
SmaatoSdk.setGPSEnabled(...);
SmaatoSdk.setWatermarkEnabled(...);

GPSEnabled flag allows to get user's location by Smaato SDK automatically and put it inside ad requests.

Supported Callbacks

Banners

Interstitials

Rewarded Video