Before Starting

Starting from version 8.0.0 of the DT Exchange SDK a single library is required and it is no longer necessary to choose any modules, as everything is packed together.

For versions older than 8.0.0, Integrating the Android SDK begins once you decide which of the modules you want to integrate. You can choose from the following:

• ia-sdk-core (Required for all)
• ia-mraid-kit (HTML/MRAID content)
• ia-video-kit (Rendering/Video content)

Step 1: Integrating the SDK in your App

DT supports both Maven Central dependencies or manual download to integrate our SDK. 
Select which option you want to use to integrate the SDK:

allprojects {
  repositories {
    // add this
    mavenCentral()
  }
  // ...
}

def fyberMarketplaceVersion = '8.0.0'

dependencies {
     // ...
    implementation "com.fyber:marketplace-sdk:${fyberMarketplaceVersion}"
    // ...
}

// Define the Fyber Marketplace version as a variable for easier upgrades
def fyberMarketplaceVersion = '7.8.4'

dependencies {
    // ...

    // add the relevant fyber marketplace libraries
    implementation "com.fyber.vamp:core-sdk:${fyberMarketplaceVersion}"
    implementation "com.fyber.vamp:video-kit:${fyberMarketplaceVersion}"
    implementation "com.fyber.vamp:mraid-kit:${fyberMarketplaceVersion}"
  
    // ...
}

repositories { 
    // ...
 
    // Add a flat dir repository
    flatDir {
        dirs 'libs'
    }
}

def fyberMarketplaceVersion = "8.2.1" // OR 7.8.4, details below

dependencies {
  // Add the fyber marketplace AAR libraries
  // 8.0.0 and above -
  implementation (name:"fyber-marketplace-${fyberMarketplaceVersion}", ext:'aar') 
  // add open measurement sdk - fyber marketplace 8.1.0 and above -
  implementation (name:"omsdk-android-1.3.25-release", ext:'aar') 
  // prior to 8.0.0 -
  implementation (name:"ia-sdk-core-release-${fyberMarketplaceVersion}", ext:'aar')
  implementation (name:"ia-video-kit-release-${fyberMarketplaceVersion}", ext:'aar')
  implementation (name:"ia-mraid-kit-release-${fyberMarketplaceVersion}", ext:'aar')
}

Step 2: Integrating Google Play Services

We recommend using the Google Play Services, otherwise we are unable to access your Google Advertising ID. This leads to limited ad inventory, as an increasing number of advertising campaigns require the identifier. This ID is also essential for tracking daily active users (DAU) on your app.

1. Add the following to your build.gradle dependencies section for Google Play Services:

Adding Dependencies

dependencies  {
    implementation ('com.google.android.gms:play-services-base:Version#')
    // use only the ads identifier library
    implementation ('com.google.android.gms:play-services-ads-identifier:x.y.z') // or implementation ('com.google.android.gms:play-services-ads:x.y.z')
}

2. Apps that update their target API level to 31 (Android 12) must declare a Google Play Services permission in the manifest file as follows, unless the app uses a recent version of Google Mobile Ads SDK:

<uses-permission android:name="com.google.android.gms.permission.AD_ID"/>

Click the box below, for important information.

New Google Advertising ID Restrictions

Google Advertising ID (GAID) is a unique string identifier, which identifies a device anonymously for advertising purposes.

This Advertising ID is provided by Google Play Services and enables users to opt-out of personalized ads in apps, or reset their identifier. When a user resets their identifier, it is not allowed to be connected to a previous identifier.

Opt-Out Behavior Change

Until late 2021, even when a user opted-out, the advertising ID was still available for developers. The restriction meant that an opt-out ID could not be used for creating user profiles for advertising purposes, or for targeting users. The allowed activities for opted-out users were contextual advertising, frequency capping, reporting and fraud detection.

Google announced that starting in late 2021, when a user opts-out of personalized ads, the Advertising ID will not be available anymore. Instead, a string of zeros is received.

This update will rollout with apps running on Android 12 phones, and is expected to expand to all apps running on devices that support Google Play in early 2022.

Android 12	Android 11

Android 12 Permission Change

Google also announced here, a behavior change for apps targeting Android 12 (API 31). 

For developers to be able to receive the Advertising ID, a new permission must be added to the manifest file, unless the app uses a recent version of Google Mobile Ads SDK (see details below):

<uses-permission android:name="com.google.android.gms.permission.AD_ID"/>

The permission is included in recent versions of Google Mobile Ads SDK (play-services-ads v20.4.0 and higher, or play-services-ads-identifier v17.1.0 and higher). If the app uses these SDKs as dependencies, then the AD_ID permission from the SDK’s library manifest is merged with your app’s main manifest by default, and the advertising ID will be available.

Google will enforce the AD_ID permission for all devices, starting from early 2022.

For more information about Google Play Services, click here.

Step 3: Adding Mandatory Permissions - Android Manifest File

1. Add the following mandatory permissions into your application's AndroidManifest.xml:

Adding Mandatory Permissions

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

2. Add the following permissions to enable your app to get richer and broader demand

Recommended permissions for better targeting

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

Step 4: Initializing the SDK

Follow these steps to initialize the SDK

Google Play Families Ads API

This optional API indicates to the FMP SDK that the user is a child, enabling participation in the Google Play Families Ads program.

Using the API

InneractiveAdManager.currentAudienceIsAChild();

Once you have added all your Android Manifest information and are ready to start requesting ads, you must initialize the Inneractive Ads SDK :

1. Call InneractiveAdManager.initialize(context, <"appID">), and pass on your Activity or application context:

Pass Your Activity Context 

public class MainActivity extends Activity {
 
   @Override
   protected void onCreate(Bundle savedInstanceState) {
      super.onCreate(savedInstanceState);
      setContentView(R.layout.activity_main);
      InneractiveAdManager.initialize(this, "Enter_Your_Fyber_AppID"); 
   }
 
   @Override
   protected void onDestroy() {
      if (isFinishing()) {
           //Optionally destroy the SDK after the activity has been destroyed
           InneractiveAdManager.destroy();
      }
   } 
}

Optionally, when you're finished using the library and do not intend to display more ads, call InneractiveAdManager.destroy() to release any resources being used by the SDK.

Locating the App ID

Follow the steps below to locate your App ID:

1. Click Apps on the left menu

   

2. The App Management window opens. Next to each app, appears the corresponding App ID.

   

Initialization Callback

Starting from DT Exchange SDK version 7.5.4, it is possible to add an initialization callback which notifies you about the initialization status of the SDK.

The callback can be optionally passed to the InneractiveAdManager in the following manner:

InneractiveAdManager.initialize(context, appId, new OnFyberMarketplaceInitializedListener() {
           @Override
           public void onFyberMarketplaceInitialized(FyberInitStatus status) {
               // ...
           }
});

Where the Status being returned in the initialized callback is:

• SUCCESSFULLY - when the SDK has been successfully initialized.
• FAILED_NO_KITS_DETECTED - when only the “core” DT Exchange library has been detected. When this is the status, check your dependencies and add the “video-kit”, “mraid-kit” to it. 
• FAILED - When the SDK has failed to communicate with our servers and could not be initialized at this time.
• INVALID_APP_ID -the appId being passed to the initialize is incorrect. Please check your configuration or contact us for assistance. 

Passing a User ID to the SDK (from v.7.7.0)

The following code snippet demonstrates how to set a User ID for this SDK session.

String userId = ...;
//Without reflection, using an import of the InneractiveAdManager class -
InneractiveAdManager.setUserId(userId);

//Optionally, using reflection as an example -
Class FyberInneractiveAdManagerClass = 
Class.forName("com.fyber.inneractive.sdk.external.InneractiveAdManager");
Method setUserIdStaticMethod = 
FyberInneractiveAdManagerClass.getDeclaredMethod("setUserId", String.class);
setUserIdStaticMethod.invoke(null, userId);

You have completed the basic integration of the Android SDK! Now it's time to integrate other ad types.  For details of Android Ad Formats, click here.

Locating your Placement ID

Follow the instructions below to find your Placement ID and make sure you enter the correct credentials.

1. Select the app from the App Management Window.
   

   

2. The Placements window opens, displaying all existing placements
   

   

3. Select Placement Setup
   

   

4. The Placement ID is displayed on the top of the page
   

   

Step 5: Adding User Consent

GDPR

The General Data Protection Regulation of the European Union requires you to scope your user's consent. A user could be within the GDPR scope for your app when one or all of the following apply:

• The user is currently located in the EU
• The user has registered with the app as an EU resident
• The app is specifically targeted to EU users

We recommend that you consult with a legal advisor to determine the best approach for your business. It is also highly recommended to collect user consent with a certified Consent Management Platform (CMP).

For a full list of CMPs, click here.

Once you have collected the user’s consent, you can pass it onto the SDK using the following API:

/**
     * Set the general data protection regulation user consent status
     * @param wasConsentGiven
     */
    public static void setGdprConsent(boolean wasConsentGiven) {…}
    
    // Calling the consent method
    
    InneractiveAdManager.setGdprConsent(true);

    /**
    * Set the general data protection regulation consent string
    * @param gdprConsent the consent string
    */
    public static void setGdprConsentString(String gdprConsent) {…}

    // Calling the consent method

    InneractiveAdManager.setGdprConsentString("consentString");

GdprConsent is a boolean. It is true if you have the user’s consent. If you do not have the user's consent, it is false.
GdprConsentString is a string.

If you don’t pass the user’s consent to the SDK, only contextual ads are shown to that user.

To clear the consent flag and consent data, the following API, use the following API:

InneractiveAdManager.clearGdprConsentData();

It is highly recommended to use the 2nd option of passing a consent string per the IAB's Transparent & Consent Framework by using a valid CMP (Consent Management Platform). This is the most common form of consent communication worldwide and is crucial in order to enjoy ad monetization in the EU. 

We recommend that the first time you gather the user’s consent, you pass it onto the SDK after starting the SDK but before requesting an ad. The SDK then takes the user’s consent into consideration when initializing. In the following sessions, you need only call the API if the user updates their consent.

More information on GDPR can be found under the GDPR Resource Page and FAQs.

CCPA

The intention of the California Consumer Privacy Act of 2018 (CCPA) is to protect the personal information of California residents. CCPA applies to all companies doing business in California. If a California resident uses an app developer’s mobile app, CCPA applies to the developer and every company that processes the personal information of the app’s users.
CCPA came into effect on 1 January 2020.

For more information on DT and CCPA, refer to DT's Resource Page.
For more information about CCPA, refer to the IAB CCPA Compliance Framework.

If you choose to allow users to 'opt-out of the sale of their personal information' then you may use the following:

Once you have obtained a user response to an opt-out option, you can pass it to the SDK using the following API:

CCPA API

/*** Setting the US privacy setting string     
* @param consentString a non empty String     
*/
public static void setUSPrivacyString(String consentString) {…}

// Calling the consent method  		     
InneractiveAdManager.setUSPrivacyString("1YNN"); 
// This is an example value when the user chooses NOT to 'opt-out'

To determine what value to use for the US Privacy String, refer to the IAB document here.
Example values:

• When CCPA does not apply (for example if the user is not a resident of California) you can either skip this API or use the following value 1---
• If the user choses NOT to opt out, and is ok with advertising as usual, you can use 1YNN
• If the user chooses to restrict advertising and opt out, you can use 1YYN

To clear the privacy setting flag and opt-out data use the following API:

CCPA Clear Privacy Settings

InneractiveAdManager.clearUSPrivacyString();

LGPD

The Brazilian General Data Protection Law, the Lei Geral de Proteção de Dados Pessoais (LGPD) requires that you only process personal data for legitimate, specific, explicit and clearly communicated purposes.

Use the following API to enable publishers to set the LGPD consent value: 

InneractiveAdManager.setLgpdConsent(boolean wasConsentGiven)

The accepted values are:

true=consent was given, false=no consent.

If the consent value is not set, the default setting is no consent.

COPPA

The Children's Online Privacy Protection Act of 1998 (COPPA) is a federal law that imposes specific requirements on operators of websites and online services to protect the privacy of children under 13.

COPPA API for Flagging Specific Users

Android SDK 8.2.3+ supports the COPPA API which allows publishers to flag specific end users as children as required under COPPA.  It is the publisher's responsibility to decide whether to use the COPPA API or to treat all users as children.  For instructions on flagging all users as children, click here.

Use the following API to confirm that the target audience of the application applies to COPPA:

InneractiveAdManager.currentAudienceAppliesToCoppa();

Step 6: Configure Parameters

Use the following API to add gender and age parameters:

// For gender values see: InneractiveUserConfig.Gender

InneractiveAdManager.setUserParams(new InneractiveUserConfig()
.setGender(InneractiveUserConfig.Gender.FEMALE)
.setAge(35));

Step 7: app-ads.txt

The simple app-ads.txt standard helps prevent the unauthorized selling of in-app inventory and app domain spoofing.

For details of listing your Developer Website URL in the Google Play Store, click here.

Step 8: Optional - Using the DT Exchange SDK in Secure Only Mode (since version 7.2.1)

InneractiveAdManager.useSecureConnections(boolean useSecureConnnections)

This API described above allows you to control how should the SDK perform any and all network connections.

By invoking this setter with a value of true all outgoing network connections from the DT Exchange SDK will be using ssl/https. The default behaviour is not to use secure connections.