Android Setup Guide

Android HyprMX SDK
SDK Documentation
Search…
Android Setup Guide
Google's Data Safety Questionnaire
Android Setup Guide
This HyprMX SDK is designed to present Fullscreen (Interstitial and Rewarded) and Banner advertisements in your application.
Integrating the SDK
The following section details how to use the Android HyprMX SDK. This guide assumes you already have your Gradle-based project up and running in Android Studio.  
1. Open your existing application in Android Studio.
2. Add the HyprMX SDK to your app's build.gradle file dependencies block:
dependencies {
    implementation 'com.hyprmx.android:HyprMX-SDK:6.0.3'
}
3. Adding Google Play Services Ads Identifier is optional. If the dependency below is included, it is the responsibility of the app developer to ensure compliance with all Google Play policies, including, and not limited to, Families Policies.
dependencies {
	implementation 'com.google.android.gms:play-services-ads-identifier:18.0.1'
}
4. If you are using Kotlin in your application, add the following to your build.gradle inside the android block:
kotlinOptions {
  jvmTarget = "1.8"
  freeCompilerArgs = [
      "-Xjvm-default=compatibility",
  ]
}
​
Usage
Initialization
First, add the following imports to your activity:
Java
Kotlin
import com.hyprmx.android.sdk.core.HyprMX;
import com.hyprmx.android.sdk.core.HyprMXIf;
import com.hyprmx.android.sdk.core.HyprMXErrors;
import com.hyprmx.android.sdk.core.HyprMXState;
import com.hyprmx.android.sdk.placement.Placement;
import com.hyprmx.android.sdk.placement.PlacementListener;
import com.hyprmx.android.sdk.placement.RewardedPlacementListener; 
import com.hyprmx.android.sdk.core.HyprMX
import com.hyprmx.android.sdk.core.HyprMXErrors
import com.hyprmx.android.sdk.core.HyprMXIf
import com.hyprmx.android.sdk.placement.Placement
import com.hyprmx.android.sdk.placement.PlacementListener
import com.hyprmx.android.sdk.placement.RewardedPlacementListener
Initialize the HyprMX SDK in your main Activity inside the onCreate method as shown below. As a best practice, initialize HyprMX as soon as possible (i.e. when your application is loading) so we can begin preloading ads.
The initializer includes a consentStatus parameter for jurisdictions that require passing consent that takes a ConsentStatus value (CONSENT_STATUS_UNKNOWN, CONSENT_GIVEN, or CONSENT_DECLINED) depending on the user consent collected by your app.
The initializer includes an optional ageRestrictedUser parameter. If the user is under the age of 16, set this parameter to true. 
Setting the ageRestrictedUser parameter is recommended for all users within applications that participate in Google Play’s Designed for Families program, are listed in Google Play’s Family section, or include children as one of the target audiences to prevent access to the AAID for end-users flagged as children.
It is the responsibility of the app developer to ensure compliance with all Google Play Family Policies, including, and not limited to, Designing Apps for Children and Families.
Base Initializer (use if your app's target audience does not include children and consent API is not applicable):
Java
Kotlin
String distributorID = "Your Distributor ID";
String userID = "Your User's ID";
HyprMXIf.HyprMXInitializationListener initializationListener;
// Use this initializer if your app's target audience does not include children.  ageRestrictedUser defaults to false.  Consent defaults to UNKNOWN.
HyprMX.INSTANCE.initialize(this, distributorID, userID, initializationListener);
val distributorID = "Your Distributor ID"
val userID = "Your User's ID"
val initializationListener: HyprMXIf.HyprMXInitializationListener = this
// Use this initializer if your app's target audience does not include children.  ageRestrictedUser defaults to false.  Consent defaults to UNKNOWN.
HyprMX.initialize(this, distributorID, userID, initializationListener)
Initializer with Consent API (use if your app's target audience does not include children):
Java
Kotlin
String distributorID = "Your Distributor ID";
String userID = "Your User's ID";
ConsentStatus consentStatus = ConsentStatus.CONSENT_STATUS_UNKNOWN; // If you don't know consent status for the user, set this to CONSENT_STATUS_UNKNOWN
HyprMXIf.HyprMXInitializationListener initializationListener;
// Use this initializer if your app's target audience does not include children.  ageRestrictedUser defaults to false.
HyprMX.INSTANCE.initialize(this, distributorID, userID, consentStatus, initializationListener);
val distributorID = "Your Distributor ID"
val userID = "Your User's ID"
val consentStatus = ConsentStatus.CONSENT_STATUS_UNKNOWN // If you don't have consent status for the user, set this to CONSENT_STATUS_UNKNOWN
val initializationListener: HyprMXIf.HyprMXInitializationListener = this
// Use this initializer if your app's target audience does not include children.  ageRestrictedUser defaults to false.
HyprMX.initialize(this, distributorID, userID, consentStatus, initializationListener)
Initializer with Consent and AgeRestrictedUser API (use if your app's target audience includes children):
Java
Kotlin
String distributorID = "Your Distributor ID";
String userID = "Your User's ID";
ConsentStatus consentStatus = ConsentStatus.CONSENT_STATUS_UNKNOWN; // If you don't have consent status for the user, set this to CONSENT_STATUS_UNKNOWN
HyprMXIf.HyprMXInitializationListener initializationListener;
boolean ageRestrictedUser = true; // Set this to true if the user is under 16
// Use this initializer if your app's target audience includes children.
HyprMX.INSTANCE.initialize(this, distributorID, userID, consentStatus, ageRestrictedUser, initializationListener);
val distributorID = "Your Distributor ID"
val userID = "Your User's ID"
val consentStatus = ConsentStatus.CONSENT_STATUS_UNKNOWN // If you don't have consent status for the user, set this to CONSENT_STATUS_UNKNOWN
val initializationListener: HyprMXIf.HyprMXInitializationListener = this
val ageRestrictedUser = true // Set this to true if the user is under 16
// Use this initializer if your app's target audience includes children.
HyprMX.initialize(this, distributorID, userID, consentStatus, ageRestrictedUser, initializationListener)
The value for distributorID is assigned to your app by HyprMX. If you have not received this ID and your placements information, please reach out to your HyprMX account manager.
The userID is a unique identifier supplied by your application and must be static for each user across sessions. Your userID should not contain any personally identifiable information such as an email address, screen name, Android ID (AID), or Google Advertising ID (GAID). If you don’t already have a static user identifier, you can use the code below to generate one.
Java
Kotlin
private String getUserId() {
  SharedPreferences sharedPreferences = getSharedPreferences("hyprmx_prefs", Context.MODE_PRIVATE);
  String userID = sharedPreferences.getString("hyprUserId", null);
  if (userID == null) {
    userID = UUID.randomUUID().toString();
    sharedPreferences.edit().putString("hyprUserId", userID).apply();
  }
  return userID;
}
  private fun getUserId(): String {
    val sharedPreferences = getSharedPreferences("hyprmx_prefs", Context.MODE_PRIVATE)
    var userID = sharedPreferences.getString("hyprUserId", null)
    if (userID == null) {
      userID = UUID.randomUUID().toString()
      sharedPreferences.edit().putString("hyprUserId", userID).apply()
    }
    return userID
  }
HyprMX also provides a separate setter for consent status. Use this when a user's consent status changes:
Java
Kotlin
HyprMX.INSTANCE.setConsentStatus(consentStatus);
HyprMX.setConsentStatus(ConsentStatus.CONSENT_STATUS_UNKNOWN)
initializationListener
initializationListener is the listener for Initialization Status of the SDK. It will callback to initializationComplete or initializationFailed as below:
Java
Kotlin
HyprMXIf.HyprMXInitializationListener initializationListener = new HyprMXIf.HyprMXInitializationListener() {
  @Override
  public void initializationComplete() {}
​
  @Override
  public void initializationFailed() {}
};
val initializationListener = object : HyprMXIf.HyprMXInitializationListener {
  override fun initializationComplete() {}
  override fun initializationFailed() {}
}
After receiving the initializationDidComplete callback, you are now ready to load and display ads in your application. See our Rewarded Ads, Interstitial Ads, and Banner Ads guides to add these ad types to your app.
License
By integrating the HyprMX SDK, you are agreeing to the End User License Agreement.
Rewarded Ads
Last modified 2mo ago
Copy link
On this page
Integrating the SDK
Usage
Initialization
License