Integrating AdColony with Mediation

This guide is intended for publishers who want to use the Google Mobile Ads SDK to load and display ads from AdColony via mediation. It covers how to add AdColony to an ad unit's mediation configuration, how to set up Ad Network Optimization (ANO), and how to integrate the AdColony SDK and adapter into an Android app.

Supported ad formats and features

The AdMob mediation adapter for AdColony has the following capabilities:

Formats
Banners
Interstitials
Rewarded Video
Native Advanced
Features
Smart Banners
Ad Network Optimization (ANO)

Requirements

  • Android SDK 4.0 (API level 14) or later
  • Google Play services 9.8.0 or later

Step 1: Set up AdColony

Sign up and log in to your AdColony account. Add your app to the AdColony publisher dashboard by clicking the Setup New App button.

AdColony setup new app

Fill out the form and click Create at the bottom of the page to add your app to AdColony.

AdColony create app

Once your app is created you can obtain your App ID by navigating to Monetization > Apps under your app's Basic App Information section.

AdColony app id

Next, create a new Ad Zone by clicking the Setup New Ad Zone button in the Ad Zones section of your App's page. We recommend creating a new Ad Zone for mediation with AdMob even if you already have one.

AdColony setup zone

For additional instructions on creating an ad placement, select the tab corresponding to your preferred ad format.

Interstitial

  1. Set Zone is Active? to Yes.
  2. Enter a Name for your Ad Zone.

  3. Choose Preroll/Interstitial as the Zone Type.

  4. Enter a value for the Daily play cap.

Rewarded Video

  1. Set Zone is Active? to Yes.
  2. Enter a Name for your Ad Zone.

  3. Choose Value Exchange/V4VC as the Zone Type.

  4. Set Client Side Only? to Yes and enter a Virtual Currency Name, Daily Max Videos per User and Reward Amount.

  5. Enter a value for the Daily play cap.

Click the Create button when finished to create the Ad Zone.

Once the Ad Zone is created, you can locate your Zone ID under the Integration section of the Ad Zone.

AdColony zone id

In addition to the App ID and the Zone ID you will also need your AdColony API Key for setting up your AdMob Ad Unit ID. Navigate to Account Settings in your AdColony publisher dashboard to locate your API Key.

AdColony settings

Step 2: Configure mediation settings for your AdMob ad unit

You need to add AdColony to the mediation configuration for your ad unit. First sign in to your AdMob account.

Next, navigate to the Mediation tab. If you have an existing mediation group you'd like to modify, click the name of that mediation group to edit it, and skip ahead to Add AdColony as an ad source.

To create a new mediation group, select Create Mediation Group.

AdMob Beta mediation tab

Enter your ad format and platform, then click Continue.

Give your mediation group a name, and select locations to target. Next, set the mediation group status to Enabled. Then click Add Ad Units, which will open up the ad unit selection overlay.

New mediation group 2

Associate this mediation group with your existing AdMob ad unit. Then click Done.

Select ad unit

You should now see the ad units card populated with the ad units you selected.

Mediation group ad units

Add AdColony as an ad source

In the Ad Sources card, select Add Ad Network. Then select AdColony.

Enable the Optimize switch. Enter your API Key obtained in the previous section to set up ANO for AdColony. Then enter an eCPM value for AdColony and click Continue.

Next, enter the App ID and Zone ID obtained in the previous section. Then click Done.

Configure AdColony ad unit

Finally, click Save.

Using rewarded video ads

In the settings for your rewarded video ad unit, check the Override reward settings from third-party ad networks when using AdMob mediation so that you provide the same reward to the user no matter which ad network is served.

If you don't override the reward, the AdColony adapter passes back the reward specified in the AdColony dashboard.

For more information on setting reward values for AdMob ad units, see Create an ad unit.

Step 3: Import the AdColony SDK and adapter

Add the following maven repository and the implementation dependency with the latest version of the AdColony SDK and adapter in the app-level build.gradle file:

repositories {
    jcenter()

    maven {
      url  "https://adcolony.bintray.com/AdColony"
    }
}

...
dependencies {
    implementation fileTree(dir: 'libs', include: ['*.jar'])
    implementation 'com.android.support:appcompat-v7:xx.x.x'
    implementation 'com.google.android.gms:play-services-ads:15.0.1'
    implementation 'com.adcolony:sdk:3.3.5'
    implementation 'com.android.support:support-annotations:xx.x.x'
    implementation 'com.google.ads.mediation:adcolony:3.3.5.1'
}
...

Manual integration

Download the AdColony Android SDK and extract the adcolony.jar under the Library folder and add it to your project.

The AdColony SDK depends on the Annotations Support Library. See Improve Code Inspection with Annotations for details on how to add the Annotations Support Library to your project.

Download the latest AdColony adapter from Bintray located under the Files tab add it to your project.

Step 4: Additional code required

Modify Android manifest

Activities

Include the following Activities in your AndroidManifest.xml under the application tag:

<activity android:name="com.adcolony.sdk.AdColonyInterstitialActivity"
    android:configChanges="keyboardHidden|orientation|screenSize"
    android:hardwareAccelerated="true"/>

<activity android:name="com.adcolony.sdk.AdColonyAdViewActivity"
    android:configChanges="keyboardHidden|orientation|screenSize"
    android:hardwareAccelerated="true"/>

Step 5: Test your implementation

To enable test ads on AdColony, go to your AdColony dashboard and navigate to Monetization > Apps. Select your Zone for which you would like to enable test ads under the Ad Zones section of your app. Test ads can be enabled by checking Yes to Show test ads only? under the Development section.

AdColony test

Optional steps

Under the Google EU User Consent Policy, you must ensure that certain disclosures are given to, and consents obtained from, users in the European Economic Area (EEA) regarding the use of device identifiers and personal data. This policy reflects the requirements of the EU ePrivacy Directive and the General Data Protection Regulation (GDPR). When seeking consent, you must identify each ad network in your mediation chain that may collect, receive, or use personal data and provide information about each network's use. Google currently is unable to pass the user's consent choice to such networks automatically.

The section below shows you how to enable or disable personalized ads for AdColony.

In version 3.3.4.0, the AdColony adapter added the setGdprRequired() and setGdprConsentString() methods to the AdColonyBundleBuilder class. The following sample code demonstrates how to pass these parameters to the AdColony adapter, which are then used in AdColony’s initialization method.

import com.jirbo.adcolony.AdColonyBundleBuilder;
//...


AdColonyBundleBuilder.setGdprConsentString("1");
AdColonyBundleBuilder.setGdprRequired(true);

AdRequest request = new AdRequest.Builder()
   .addNetworkExtrasBundle(AdColonyAdapter.class,AdColonyBundleBuilder.build())
   .build();

See AdColony’s GDPR implementation details for more information about what values may be provided in these methods.

Permissions

For optimal performance, AdColony recommends adding the following optional permissions to your app's AndroidManifest.xml file:

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

Using interstitial and rewarded video ads

Network-specific parameters

The AdColony adapter supports additional request parameters which can be passed to the adapter using the AdColonyBundleBuilder class. The AdColonyBundleBuilder includes the following methods:

  • setUserId(String) - Sets the User ID to the AdColony SDK that provides further analytics to the AdColony Ad Server.
  • setShowPrePopup(boolean) - Sets whether or not to show a popup before showing an ad. Set to false for no popup before ad shows.
  • setShowPostPopup(boolean) - Sets whether or not to show a popup after showing an ad. Set to false for no popups after ad shows.

Here's a code example of how to set these ad request parameters:

JAVA

AdColonyBundleBuilder.setUserId("USER_ID");
AdColonyBundleBuilder.setShowPrePopup(true);
AdColonyBundleBuilder.setShowPostPopup(true);
AdRequest request = new AdRequest.Builder()
   .addNetworkExtrasBundle(AdColonyAdapter.class, AdColonyBundleBuilder.build())
   .build();
rewardedInterstitialAd.loadAd(request);

KOTLIN

AdColonyBundleBuilder.setUserId("USER_ID")
AdColonyBundleBuilder.setShowPrePopup(true)
AdColonyBundleBuilder.setShowPostPopup(true)
val request = AdRequest.Builder()
   .addNetworkExtrasBundle(AdColonyAdapter::class.java, AdColonyBundleBuilder.build())
   .build()
rewardedInterstitialAd!!.loadAd(request)

Optimizations

To ensure AdColony video ads are available as early as possible, you can optionally initialize the AdColony SDK at the beginning of the application lifecycle. To do so, insert the following code into your main Activity's onCreate method:

JAVA

AdColony.configure(this,           // activity context
        "YOUR_ADCOLONY_APP_ID",
        "ZONE_ID_1", "ZONE_ID_2"); // list of all your zones set up on the AdColony Dashboard

KOTLIN

AdColony.configure(this,           // activity context
        "YOUR_ADCOLONY_APP_ID",
        "ZONE_ID_1", "ZONE_ID_2")  // list of all your zones set up on the AdColony Dashboard

Send feedback about...

Google Mobile Ads SDK for Android
Google Mobile Ads SDK for Android
Need help? Visit our support page.