HyprMX Integration Guide

This guide will instruct you step-by-step on how to set HyprMX live as an Ad Network on Unity LevelPlay Mediation.

Step 1. Create an HyprMX Account

HyprMX provides a managed service. To create an account with them, contact them directly at integration@hyprmx.com.  Once your account is created, they will help you set up your application and retrieve the required parameters to activate HyprMx in your ironSource account.

Step 2. Activate HyprMX in Your ironSource Network Setup Module

There are 3 pieces of data from the HyprMX account which need to be inserted into your ironSource Network Setup Module in order for HyprMX to work correctly in connection with ironSource:

Once you obtain this information, you must configure HyprMX’s Parameters in your ironSource Account. By adding the above information correctly, you will be able to take full advantage of HyprMX’s ad inventory and reporting data on Unity LevelPlay Mediation.

Configure HyprMX’s Parameters into ironSource Account

• Once you obtain the above parameters, log in to your ironSource account and go to ‘Monetize‘ ➣ ‘SDK Networks‘:
  
• Select HyprMX from the list of available Ad Networks and input the HyprMX  ‘API Key‘.
• Next, select the app on which you’d like to run Unity LevelPlay Mediation with HyprMX and click on the ‘Setup’ button. Then enter the ‘Distributor ID‘ and ‘Placement Name‘ in the relevant fields.
  
• You will then see HyprMX as Active for Mediation on the Setup Dashboard.
  

Step 3. Add the HyprMX Adapter to Your Build

ironSource SDK supports both Gradle dependencies and manual download mechanisms.

Gradle:

1. Make sure the following Maven URL exist in your build.gradle script of your app module.

   repositories {
       mavenCentral()
   }

2. Add the adapter’s Maven name to your build.gradle script of your app module.
   

   dependencies {
       implementation 'com.unity3d.ads-mediation:hyprmx-adapter:4.3.15'
       implementation 'com.hyprmx.android:HyprMX-SDK:6.4.3'
   }

3. Make sure your build.gradle script of your project supports classpath of 3.3.1 or above.

   classpath 'com.android.tools.build:gradle:3.3.1'

Step 4. HyprMX Additional Settings

Age Restricted Users

Unity LevelPlay mediation lets publishers communicate HyprMX ageRestrictedUser settings directly to the HyprMX network. This feature is enabled using ironSource SDK 7.2.4+, HyprMX Android Adapter 4.3.2+.

According to HyprMX, 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.

Set the flag before initializing ironSource SDK.

Use the following syntax, to set HyprMX flag with ageRestrictedUser the parameter True:

IronSource.setMetaData("HyprMX_ageRestricted","true");

Use the following syntax, to set HyprMX flag with ageRestrictedUser the parameter False:

IronSource.setMetaData("HyprMX_ageRestricted","false");

Done!

You are now all set to deliver HyprMX within your application!