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 a Unity app.

Supported ad formats and features

The AdMob mediation adapter for AdColony has the following capabilities:

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

Requirements

  • Unity 4 or higher
  • To deploy on Android
    • Android SDK 4.0 (API level 14) or later
    • Google Play services 9.8.0 or later
  • To deploy on iOS
    • Xcode 7.0 or higher
    • iOS Deployment target of 7.0 or higher
    • Minimum required Google Mobile Ads SDK 7.10.1 or higher
  • A working Unity project configured with Google Mobile Ads SDK. See the Quick Start Guide for details.

Step 1: Set up AdColony

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

If your app supports both Android and iOS platforms, you need to set up each one of them separately.

AdColony setup new app

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

Android

AdColony create app

iOS

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.

Android

AdColony app id

iOS

AdColony app id

Next, create a new Ad Zone to be used with AdMob mediation. We recommend creating a new Ad Zone for mediation with AdMob even if you already have one. To create a new Ad Zone click the Setup New Ad Zone button in the Ad Zones section of your app's page.

Android

AdColony setup zone

iOS

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.

When finished, click the Create button to create the Ad Zone.

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

AdColony zone id

In addition to the App ID and Zone ID you will also need your AdColony API Key to set 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 the AdMob UI.

If you're deploying your Unity app to both Android and iOS, you need two AdMob ad units, one for each platform.

Android

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 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.

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.

Finally, click Save.

iOS

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.

Enter your ad format and platform, then click Continue.

New mediation group 2

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.

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.

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 (recommended approach).

Mediation override reward

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

Download the latest version of Google Mobile Ads mediation plugin for AdColony and extract the GoogleMobileAdsAdColonyMediation.unitypackage from the zip file.

In your Unity project editor, select Assets > Import Package > Custom Package and find the GoogleMobileAdsAdColonyMediation.unitypackage file you downloaded. Make sure all the files are selected and click Import.

Step 4: Additional code required

No additional code is required for AdColony integration.

Step 5: Test your implementation

To enable test ads on AdColony, go to your AdColony dashboard and navigate to Monetization > Apps. Select the 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

Android

Permissions

For optimal performance, AdColony recommends adding the following optional permissions into the AndroidManifest.xml file located under the Assets/Plugins/Android/GoogleMobileAdsPlugin directory of your Unity project.

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

iOS

No additional steps are required for iOS integration.

Network-specific parameters

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

SetUserId(string)
Sets the User ID for the AdColony SDK that provides further analytics to the AdColony Ad Server.
SetZoneId(string)
Sets the Zone ID for the AdColony SDK.
SetShowPrePopup(bool)
Sets whether or not to show a popup before showing an ad. Set to false if you don't want to show a popup before ads display.
SetShowPostPopup(bool)
Sets whether or not to show a popup after showing an ad. Set to false if you don't want to show a popup after ads display.
SetTestMode(bool)
Sets whether or not to enable test mode for the AdColony SDK.

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

AdColonyMediationExtras extras = new AdColonyMediationExtras();
extras.SetUserId("user_id");
extras.SetZoneId("zone_id");
extras.SetShowPrePopup(true);
extras.SetShowPostPopup(true);
extras.SetTestMode(true);

AdRequest request = new AdRequest.Builder()
        .AddMediationExtras(extras)
        .Build();

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.

The Google Mobile Ads mediation plugin for AdColony version 1.0.2 added the SetGDPRRequired() and SetGDPRConsentString() methods to the AdColonyUnityExtrasBuilder class, allowing you to pass consent to AdColony. The following sample code demonstrates how to pass these parameters to the AdColony adapter, which are then used in AdColony's initialization method.

using GoogleMobileAds.Api.Mediation.AdColony;
// ...

AdColonyMediationExtras extras = new AdColonyMediationExtras();
extras.SetGDPRRequired(true);
extras.SetGDPRConsentString("1");

AdRequest adRequest = new AdRequest.Builder()
    .AddMediationExtras(extras)
    .Build();

See AdColony's GDPR article for more information.

Send feedback about...

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