AdMob Mediation
The HyprMX Android AdMob Adapter allows you to integrate HyprMX in your AdMob rewarded, interstitial, and banner waterfalls.
This adapter is compatible with AdMob 20.6.0 and above.

Upgrade Instructions - HyprMX SDK AdMob Adapter 5.0+ to 6.0.2.0

NOTE: Remove the hyprmx maven url in your top-level build.gradle dependencies. HyprMX is distributed with Maven Central.
Update the following dependency version in your app's build.gradle file:
dependencies {
implementation 'com.hyprmx.android:HyprMX-AdMob:6.0.2.0'
}

AdMob Dashboard

Update your custom events to use the following classnames:
AdMob Ad Format
Class Name
com.hyprmx.android.HyprMXCustomEventRewarded
com.hyprmx.android.HyprMXCustomEventInterstitial
Banner
com.hyprmx.android.HyprMXCustomEventBanner

User ID & User Consent

If you are using mediation extras to pass in user ID and/or user consent, follow the instructions in Optional: User ID & User Consent. HyprMXMediationExtras has been removed and replaced with HyprMXAdapterConfiguration

Setup Instructions

The following section details how to use the Android HyprMX AdMob Adapter. This guide assumes you already have your gradle-based project up and running in Android Studio with AdMob Mediation.
  • Open your existing application in Android Studio
  • Add the following dependency to your app's build.gradle file:
dependencies {
implementation 'com.hyprmx.android:HyprMX-AdMob:6.0.1.0'
}
In order to maximize fill rates, we recommend adding the following permissions to the AndroidManifest:
<uses-permission android:name="android.permission.VIBRATE" />

Integrating HyprMX On The AdMob Dashboard Using Custom Events

  1. 1.
    Create your Mediation Group on the AdMob dashboard. If you are integrating Interstitial and Rewarded Video, follow these steps for both.
  2. 2.
    In the Ad Sources section, select Add Custom Event.
  3. 3.
    In the popup, enter HyprMX in the label field and set the default eCPM (e.g. $15.00).
  4. 4.
    Click 'Continue'.
  5. 5.
    Set the adapter classname:
    AdMob Ad Format
    Class Name
    com.hyprmx.android.HyprMXCustomEventRewarded
    com.hyprmx.android.HyprMXCustomEventInterstitial
    Banner
    com.hyprmx.android.HyprMXCustomEventBanner
  6. 6.
    In the parameter field, enter the distributor ID and placement name assigned to you by your HyprMX account manager. Please reach out to your account manager with what placements you'd like to use in your app and whether they will be rewarded or interstitial. The example below will assume that your account manager has created a "REWARDED" placement.
    { "distributorId": "YOUR_DISTRIBUTOR_ID", "placementName": "REWARDED" }
  7. 7.
    Click 'Done' and then 'Save'.

Optional: Tag for Child Directed Treatment

Tagging for child directed treatment 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.
For instructions on how to tag the ad request as child directed, please follow the AdMob's child-directed setting documentation.

Optional: User ID & User Consent

If your app relies on server-to-server callbacks and requires you to set a static user ID that is publisher-defined for Rewarded Video, pass the user ID as instructed below. Please contact your HyprMX account services representative if you would like to implement a postback.
The user ID should not contain personal information such as an email address, screen name, or Google's Advertising Identifier (GAID).
HyprMX also allows you to set the user's consent status for jurisdictions that require passing consent using the setHasUserConsent API. Options are true for consent given or false for consent declined. Not setting consent will leave the status as UKNOWN.
Pass the user ID and consent status with the HyprMXAdapterConfiguration before initializing AdMob.
Java
Kotlin
String userId = "REPLACE_WITH_CUSTOM_USER_ID";
HyprMXAdapterConfiguration.INSTANCE.setUserId(userId);
// Consent is optional. Not setting leaves the consent status as unknown.
// Consent has been given
HyprMXAdapterConfiguration.INSTANCE.setHasUserConsent(true);
// Consent has been declined
HyprMXAdapterConfiguration.INSTANCE.setHasUserConsent(false);
MobileAds.initialize(activity);
val userId = "REPLACE_WITH_CUSTOM_USER_ID"
HyprMXAdapterConfiguration.userId = userID
// Consent is optional. Not setting leaves the consent status as unknown.
// Consent has been given
HyprMXAdapterConfiguration.setHasUserConsent(true)
// Consent has been declined
HyprMXAdapterConfiguration.setHasUserConsent(false)
MobileAds.initialize(activity)

License

By integrating the HyprMX SDK, you are agreeing to the End User License Agreement.