Docs

# Mediation Guides

# AdMob

# 1. Create an app

a) First, login to your AdMob account and add Alx SDK to your mediation. Please refer to the instructions from this integration doc: https://apps.admob.com/ . After, you need to create a new app. If you don’t have one, below is an example of how to create a test app:

admob_doc_01

admob_doc_02

b) Create an ad unit – once you have an app, you need to create an ad unit. See the steps below:

admob_doc_03 admob_doc_04 admob_doc_05

# 2. Create a Mediation Group

a) Create Alx mediatioin group

admob_doc_06

b) Create an Alx ad unit. We currently support the following: Rewarded Video, Interstitial ads, and Banner ads. Below is an example showing how to add a Rewarded Video ad unit:

  • In the name box, fill in the following: “Alx_RewardedVideo”, then use “Rewarded” as the ad unit format.

admob_doc_07

c) Once done, click “ADD AD UNITS” and select the corresponding app and ad unit.

admob_doc_08

d) Click “DONE”. Then add custom event and fill in the name and minimum ecpm

admob_doc_09 admob_doc_10

e) (IMPORTANT!) Click ”Continue” and fill in the Ad unit parameter below:

Class Name: com.admob.custom.adapter.AlxRewardVideoAdapter(RewardVideo) Other Adapter Class Name: RewardVideo: com.admob.custom.adapter.AlxRewardVideoAdapter Banner: com.admob.custom.adapter.AlxBannerAdapter Interstitial: com.admob.custom.adapter.AlxInterstitialAdapter

You need to apply for an “appid”, “unitid”,“ token”, and “sid” at AlgoriX SSP first. Ask your AM for help.

{
    "appid": "acfe79f8aa3e36c8129ccf95a6f16f2fzJ",
    "unitid": "171998",
    "token": "bec2b4898ec3c60124339b44d4d9b95d8v",
    "isdebug": "false",
    "sid": "60188"
}
1
2
3
4
5
6
7

appid refers to appid at ssp token refers to Token at ssp sid refers to ID at ssp unitid refers to Placement ID at ssp

admob_doc_11 admob_doc_12 admob_doc_13

f) Click DONE

admob_doc_14 admob_doc_15

g) After you click” SAVE” and go back to the home page, you’re all set!

admob_doc_16

# IronSource

# What is a custom adapter?

Custom adapters enable you to integrate any SDK network you want in your mediation stack through ironSource mediation. This means you can serve ads from any other networks that are right for your audience, in addition to all the networks available through the ironSource mediation.

Your new network will look like a native part of the ironSource platform on the SDK Networks Setup, Mediation Management page, and in your monetization reports. You can also use the same features you use for certified networks for your new network, including segments, A/B testing, sort by eCPM, and more.

The minimum supported ironsource mediation sdk versions is 7.1.14.

# Step 1: AlgoriX SDK Custom Adapter Integration

1.Download the SDK at AlgoriX Documentation Center. Unzip the package and find the AlgoriX custom adapter file under this path.

irs_doc_18

2.Copy the adapter java file under the path: com.ironsource.adapters.custom.algorix
Please make sure the adapter files are placed under the correct path in your app.

irs_doc_06

3.AAR/JAR library file integration
Copy the alx...*.aar from the SDK compression package to Application Module/libs folder (If not exist, create manually), then add the following codes to build.gradle in your Moudle app：

//In Unity, the application folder is exported as unityLibrary
repositories {
   flatDir {
       dirs 'libs'
   }
}
depedencies {
   compile(name: 'alx.*.*.*', ext: 'aar') //replace with the specific sdk version number 

}
1
2
3
4
5
6
7
8
9
10

4.ProGuad Configuration(recommend)
Add to the following codes to the .pro file under the APP folder (for Android, the file is usually exported as proguard-rules.pro，for Unity, the file is exported as proguard-unity.txt)：
-keep class com.alxad.** {*;}
-keep class admob.custom.adapter.** {*;}
-keep class anythink.custom.adapter.** {*;}
-keep class com.mopub.mobileads.** {*;}
-keep class com.tradplus.ads.** {*;}
-keep class com.ironsource.adapters.** {*;}

# Step 2: Register AlgoriX as your custom adapter

Register AlgoriX as your custom adapter and get the network key.
ironSource | Custom adapter registration

irs_doc_15

irs_doc_16

Some information required by the register form.

  • Network Contact Person: Your AlgoriX account manager
  • Contact Email:sdk_support@algorix.co
  • Company Name:ALGORIX TECHNOLOGY PTE LTD
  • Company Address: Lazada One, #06-01, 51 Bras Basah Road, Singapore 189554
  • Country:Singapore
  • Account level:sid, token
  • App level:appid
  • Instance level:unitid
  • Reporting API endpoint:https://ssp.svr-algorix.com/api/report/v1/is

Once you submit the form，you will get the below information immediately on the page. Make sure you save it since it includes important information for you to set up your adapters. The new network key might need several minutes before taking effect. irs_doc_17

# Step 3: Account and App set up at AlgoriX

Before adding the AlgoriX ad network to your ironSource mediation, please log in to your AlgoriX SSP account to set up your app/ad placements and get related parameters, which are defined by AlgoriX and required by ironSource's ad network set up (see below).

Below are the parameters you'll need:

Parameter Required by Ironsource Parameter Defined by AlgoriX
Account Level Parameter sid ID
Account Level Parameter token Token
App Level Parameter appid APP ID
Ad Instance Parameter unitid Placement ID

Please refer to the following steps to create app/ad placements and get your ID, Token, APP ID, and Placement ID.
*Note: If you don't have an AlgoriX SSP account, please get in touch with your AlgoriX account manager to help you create one.

  • Log-in to your AlgoriX SSP account

irs_doc_01

  • Go to Account➣Profile to get your ID and Token

irs_doc_02

  • Here you will see your ID and Token

irs_doc_03

  • Create APP: Go to "Apps" to create an app. Click the ID under the app name to copy the APP ID

irs_doc_04

  • Create Ad Placement: On the last page, click "placements" to create an ad placements under the app and get the placement ID.

irs_doc_05

# Step 4: Configure the ad network account settings at ironSource

  1. Log in to your ironSource account and go to Monetize ➣ Setup ➣ SDK Networks. Website: ironSource (is.com)
  2. Click Manage Networks and select Custom Adapter at the end of the list.（If not visible, please contact your ironSource account manager to enable this for you)

irs_doc_07

  1. Enter the AlgoriX network key you just applied.

irs_doc_08

  1. Once the network key is recognized, you’ll be able to see AlgoriX in the name field. Enter the required account level parameters such as sid and token, which are defined by AlgoriX.

irs_doc_09

# Step 5: App level setup

On the left-hand side of the SDK Networks Setup page, you will see the list of apps in your ironSource account. Select the relevant app, and scroll down to the Custom section to find the newly defined network. Click Setup to complete the network’s configuration.

  1. Configure the network’s app and ad unit you want to serve based on your network’s settings.

irs_doc_10

  1. Make sure to define Mediation Groups and Rate for each instance.
    Use Mediation Groups to define specific instances per specific countries.
    Use Rate to assign a price to an instance to make sure it delivers in the order you want in your waterfall. Learn more about rate here.

Enter appid and unitid

irs_doc_11

  • Once done, you'll see AlgoriX is added. Make sure the status is "Active."

irs_doc_12

# Step 6: Testing

The last step is testing if the AlgoriX adapter is working well.
Place the AlgoriX instance at the proper place within your mediation and make sure AlgoriX has a chance to receive ad requests

irs_doc_13

If you need to test with the test device, please follow the ironSource integration testing process especially for the mediation testing part.
Integration Testing - IronSource Knowledge Center

irs_doc_14

# Done!

You’ve completed your custom adapters setup on the ironSource platform. If you have any questions about setting up the custom adapter, please contact your AlgoriX account manager.

# Max

This integration guide gives you step-by-step instructions to show you how to enable AlgoriX custom SDK network as an ad network on your Max SDK.

The minimum supported Max SDK version is 11.0.0.

You can find more details about Max Custom SDK Network Integration Guide on this page.

And AlgoriX SDK Adapter only support Andorid so far.

# Step 1: Configure the ad network account settings at Max

  1. Login your Max account and create app/ad unit for testing use according to Max integratioin doc.Applovin｜Everything you need to grow your mobile apps(applovin.com)

max_sdk_11

max_sdk_12

max_sdk_13

max_sdk_14

  1. Go to MAX > Mediation > Manage > Networks and click Click here to add a Custom Network

max_sdk_15

  1. Choose Network Type as SDK, enter the network name and enter Android Adapter Class Name as com.applovin.mediation.adapters.AlgorixMediationAdapter

Click ✓ Save

Please double confirm to make sure the class name is correct

max_sdk_16

# Step 2: AlgoriX SDK Custom Adapter Integration

  1. Download the SDK at AlgoriX Documentation Center. Unzip the package and find the AlgoriX custom adapter file under this path.

max_sdk_21

  1. Copy the adapter java file under this path. Please make sure the adapter files are placed under the correct path in your app.

max_sdk_22

  1. AAR/JAR library file integration

Copy the alx...*.aar from the SDK compression package to Application Module/libs folder (If not exist, create manually), then add the following codes to build.gradle in your Moudle app：

//In Unity, the application folder is exported as unityLibrary
repositories {
   flatDir {
       dirs 'libs'
   }
}
depedencies {
   compile(name: 'alx.*.*.*', ext: 'aar') //replace with the specific sdk version number 

}
1
2
3
4
5
6
7
8
9
10
  1. ProGuad Configuration(recommend)

Add to the following codes to the .pro file under the APP folder (for Android, the file is usually exported as proguard-rules.pro，for Unity, the file is exported as proguard-unity.txt)：

-keep class com.alxad.** {*;}

-keep class admob.custom.adapter.** {*;}

-keep class anythink.custom.adapter.** {*;}

-keep class com.mopub.mobileads.** {*;}

-keep class com.applovin.mediation.adapters.** {*;}

# Step 3: Account and App set up at AlgoriX

Before setting up ad units on Max, please log in to your AlgoriX SSP account to set up your app/ad placements and get related custom parameters, which are defined by AlgoriX and required by Max ad network set up (see below).

Below are the parameters you'll need:

Parameter Required by Max Parameter Defined by Algorix
Account Level Parameter sid ID
Account Level Parameter token Token
App Level Parameter appid APP ID
Ad Instance Parameter unitid Placement ID

Please refer to the following steps to create app/ad placements and get your ID, Token, APP ID, and Placement ID.

*Note: If you don't have an AlgoriX SSP account, please get in touch with your AlgoriX account manager to help you create one.

  • Log-in to your AlgoriX SSP account

max_sdk_31

  • Go to Account➣Profile to get your ID and Token

max_sdk_32

  • Here you will see your ID and Token

max_sdk_33

  • Create APP: Go to "Apps" to create an app. Click the ID under the app name to copy the APP ID

max_sdk_34

  • Create Ad Placement: On the last page, click "placements" to create an ad placements under the app and get the placement ID.

max_sdk_35

# Step 4: Enable the Custom Network

  1. Go to MAX > Mediation > Manage > Ad Units and select an ad unit where you want to add the AlgoriX network.

max_sdk_41

  1. Enable AlgoriX Custom Network

max_sdk_42

  1. Fill in the related parameters that you get from AlgoriX SSP

max_sdk_43

Custom Parameters Format Sample

{
    "appid": "acfe79f8aa3e36c8129ccf95a6f16f2fzJ",
    "unitid": "171998",
    "token": "bec2b4898ec3c60124339b44d4d9b95d8v",
    "isdebug": "false",
    "sid": "60188"
}
1
2
3
4
5
6
7

You can copy your "Custom Parmeters" from the AlgoriX SSP Dashboard.

max_sdk_46

  1. Click Save and done

max_sdk_45

Suggestion:

It's suggested to set up relatively high CPM when testing to make sure AlgoriX SDK adapter has the chance to receive requests. When officially go live, CPM at Max should be consistent with "Bid Floor" set up at AlgoriX SSP.

# MoPub

# 1. Create an app

Login in to your MoPub account and create a new app as shown below: MoPub - Apps

mopub_doc_01

# 2. Create an Ad Unit

mopub_doc_02 mopub_doc_03

# 3. Add a Network

mopub_doc_04

# 4. Choose a Custom SDK Network

mopub_doc_05

# 5. Fill Out the Custom SDK Network Setting

In the Name field, fill in “AlgoriX Network.”

mopub_doc_06

# 6. Fill in the Custom Event Class

mopub_doc_07

Fill in the “Custom event class”

Adapter type supported:

  • Rewarded Video: com.mopub.mobileads.AlxRewardVideoAdapter
  • Banner: com.mopub.mobileads.AlxBannerAdapter
  • Interstitial：com.mopub.mobileads.AlxInterstitialAdapter

# 7. Fill in the Custom Event Class Data

Fill in the ad unit information as below:

{
    "appid": "acfe79f8aa3e36c8129ccf95a6f16f2fzJ",
    "unitid": "171998",
    "token": "bec2b4898ec3c60124339b44d4d9b95d8v",
    "sid": "60188",
    "isdebug": "false"
}
1
2
3
4
5
6
7

NOTE: You need to apply for the “appid, unitid, token, sid” at the AlgoriX SSP dashboard. To apply, do the following:

  1. Ask your AlgoriX account manager to create an AlgoriX SSP dashboard account for you so you can access https://ssp.svr-algorix.com/
  2. In the dashboard, create an app and ad unit
  3. Then, you can find the information as shown below:
sid=ID
token=Token
appid= App ID
unitid=Placement ID
1
2
3
4

mopub_doc_08 mopub_doc_09 mopub_doc_10

# 8. Enable AlgoriX Ad Network

Go to “Segments” → “Global Segment”. Under your app, you can find your newly added AlgoriX Network. Enable the AlgoriX Network and confirm that the status shows it’s “Running”.

mopub_doc_11

You’re now done setting up!

# TopOn - Android

# 1. TopOn SDK Integration

Please refer to the following link to access the TopOn SDK integration documentation: https://docs.toponad.com/#/en-us/android/GetStarted/TopOn_Get_Started

a) On the TopOn platform, click "Network," and fill-in the required information. b) Please take note of the following adapter class names and corresponding ad formats:

com.anythink.custom.adapter.alxrewardvideoadapter (rewarded videos)

The platform currently supports four advertising formats. The specific adapter class names are as follows:

  • Rewarded videos: com.anythink.custom.adapter.AlxRewardVideoAdapter
  • Banner ads: com.anythink.custom.adapter.AlxBannerAdapter
  • Interstitial ads: com.anythink.custom.adapter.AlxInterstitialAdapter
  • Native ads: com.anythink.custom.adapter.AlxNativeAdapter

topon_adr_doc_01 topon_adr_doc_02

# 2. AlgoriX SDK - Android Integration

a) Open your SDK package and copy alx.1...aar to the Application Module/libs folder. If the folder doesn't exist, you can manually create one. Then, add the following code to the build.grade of your app's (game) module app.

topon_adr_doc_03

b) You'll find the adapter code in the com directory. Place it in the app's (game) Android engineering code src/main/java source code directory. Note that the entire package path needs to be copied. The full package path is com.anythink.custom.adapter

See the screenshot below for details:

topon_adr_doc_04

# 3. Android ProGuard Configuration

If you're displaying splash screen ads on Android, you need to add the following in the package:

topon_adr_doc_05

# TopOn - Unity

# 1. TopOn SDK Integration

Please refer to the following link to access the TopOn SDK integration documentation: https://docs.toponad.com/#/en-us/android/GetStarted/TopOn_Get_Started

a) On the TopOn platform, click "Add Advertising Platform" and configure the advertising adapter parameter information.

b) Fill-in the ad unit parameter information: com.anythink.custom.adapter.alxrewardvideoadapter (rewarded videos)

The platform currently supports four advertising formats. The specific adapter class names are as follows:

  • Rewarded videos: com.anythink.custom.adapter.AlxRewardVideoAdapter
  • Banner ads: com.anythink.custom.adapter.AlxBannerAdapter
  • Interstitial ads: com.anythink.custom.adapter.AlxInterstitialAdapter
  • Native ads: com.anythink.custom.adapter.AlxNativeAdapter

topon_unt_doc_01 topon_unt_doc_02

# 2. AlgoriX SDK - Unity Integration

a) First, you need to put Alx's aar package into the following directory: /Assets/Plugins/Android/libs

b) Second, you need to put the adapter source code folder "anythink" under /Assets/Plugins/Android/ or /Assets/Plugins/

For example, see the photo below:

topon_unt_doc_03

# 3. Android ProGuard Configuration

If you're displaying splash screen ads on Android, you need to add the following in the package:

topon_unt_doc_03

←