UnityAds Mediation Integration Guide

 

This guide will instruct you step-by-step on how to set UnityAds live as an Ad Network on the ironSource Mediation platform.

Before You Start

Make sure you have correctly integrated ironSource‘s Rewarded Video or Interstitial into your application. 

Step 1. Create an UnityAds Account

  1. Create an account with UnityAds. You can do so here.
  2. Once your account has been verified you can log in at their partner login here.

Step 2. Create an Application and Placement in UnityAds

Follow these steps to create your UnityAds application:

  1. Create Application
    1. Once you login, click on ‘+Add New Project‘:

      ironSource UnityAds Dashboard New Project
    2. Define the settings of your app:
      1. Enter your app’s name under Project Name.
      2. Choose your app’s platform and enter the AppStore or Google Play URL of your application under Select Platforms. If your app is not live yet, you can also enter a name manually.
      3. Platform – iOS or Android
      4. App URL – enter the AppStore or Google Play URL of your application. If your app is not live yet, you can also enter a name manually.
      5. Target Age – check the box if your app is directed to users under the age of 13.
      6. Once you have filled in all the information, click ‘Continue‘ on the top right to finish.
        Note: You will need a unique UnityAds application per platform (iOS + Android) just like you do with your ironSource account.
        ironSource UnityAds Dashboard Add New Project
    3. Skip the Instructions by clicking ‘OK, got it!‘:
      ironSource Unityads Skip Instructions
  2. Create Placement
    UnityAds creates two default placements: one for Video (Interstitial on the ironSource Dashboard) and Rewarded Video. The default placements comply with the ironSource‘s Mediation platform. To view your placements or create a designated placement to run with ironSource‘s Mediation:

    1. Go to your main dashboard and select the relevant project:
      ironSource Unityads Select Project
    2. Click on the app with which you wish to run UnityAds with ironSource‘s Mediation.
      ironSource UnityAds Placement Click App
    3. Next, you will see a summary of your default placements with all their information under the Ad Placement tab. If you’d like to add another placement other then the default units, click on ‘Add a New Placement’:
      Supersonic UnityAds Add New Placement
    4. The below window will appear and you must fill in the following info:
      1. Select Ad Type:
        1. If you’d like to serve UnityAds’ Rewarded Video ads through ironSource‘s Mediation, select Rewarded Video.
        2. If you’d like to serve UnityAds’ Video Interstitial ads through ironSource‘s Mediation, select Skippable Video.
      2. Enter a name for this specific placement (for example, Between Levels), and click ‘Save‘.
        ironSource UnityAds Placement Info
    5. After clicking ‘Save‘, you should see your manually added placement under your default placements:
      ironSource UA Placement Dashboard

    Step 3. Activate UnityAds on ironSource Network SDK Setup

    Immediately after you confirm your application, you will be redirected to a summary page open to the ‘Monetization Settings’ tab. There you will find 3 pieces of Data from your UnityAds account which need to be input into your ironSource Network Setup Module in order for UnityAds to work correctly in connection with ironSource:

    Game ID This is the unique identifier of your Application in UnityAd’s system.
    Integration
    ID 
    This is the unique identifier of your Ad Placement in UnityAd’s system. Two Ad Placements are created by default for your application; a Rewarded and Non-Rewarded placement.
    API Key This is a unique identifier for your UnityAds account, which allows your ironSource Mediation Platform to import performance data from your UnityAds account to use in reporting & optimization.

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

  1. Game ID

    Go to your main monetization dashboard and select the relevant project in which you’ve added the app that you’d like to serve UnityAds through the ironSource Mediation platform.

    ironSource Unityads Select Project
    You will then see a list of all added apps in that project as well as their respective Game IDs:
    ironSource UnityAds Game ID

  2. Integration ID
    Navigate to your main monetization dashboard and select the relevant project in which you’ve added the app that you’d like to serve UnityAds through the ironSource Mediation platform.

    ironSource Unityads Select Project

    Select the relevant application from the available list and under the ‘Ad Placements‘ tab you will see the Integration IDs for all your placements. Choose the ID of the default ad type ( Rewarded Video or Skippable Video for Video Interstitials ) or of the placement you added manually.
    ironSource UA Integration ID

  3. API Key
    Navigate to the main monetization dashboard and you click on API KEYS. You will then see your API Key.
    ironSource UA API Keys

Configure UnityAds’s Parameters into ironSource Account

Once you have all of these parameters, log in to your ironSource account.

  • Go to ‘Monetize‘ ➣ ‘Mediation‘ ➣ ‘Network Setup‘.
    ironsource-platform-mediation-network-setup
  • Select UnityAds from the list of available Ad Networks and input the UnityAds ‘API Key‘ in the relevant fields.
    ironsource-platform-mediation-account-settings-ua
  • Click ‘Save‘. UnityAds will then be enabled in the Available Ad Networks table.
  • Make sure you select the app on which you’d like to run ironSource’s Mediation with UnityAds.ironsource-platform-select-app-ua
  • Scroll down to UnityAds on the Setup list and click on the ‘Define‘ icon.
    ironsource-platform-define-ua
  • Enter the ‘Game ID‘ and ‘Integration ID‘ under the relevant Ad Unit Settings and set the status to ‘Active‘. Then click ‘Save‘.
    ironsource-platform-app-settings-ua
  • You will then see UnityAds as Active for Mediation on your Setup Dashboard.
    ironsource-platform-mediation-active-ua
  • New! Verify your integration with the Reporting API; this column will check your integration through the Reporting API and return three possible responses: Verified, Failed and No Response. Double check your integration and the information you entered above; then click ‘Retry‘ until you see ‘Verified’.

Step 4. Add the UnityAds Adapter to Your Build

iOS


ironSource
supports both Cocoapods and Manual download mechanisms.

Download the UnityAds Adapter with Cocoapods

To integrate the UnityAds SDK with Cocoapods, enter the following line in your podfile and you’re good to go!

pod 'IronSourceUnityAdsAdapter','3.2.1.9'

Manual Download

  1. Download the UnityAds Adapter:
    Add theUnityAds Adapter to your build. You can find the latest UnityAds Adapter here.
    Important! The UnityAds Adapter also contains the UnityAds SDK. You DON’T need to add the UnityAds SDK directly.
  2. Add the UnityAds frameworks to your Project:
    After you download the Adapter, drop the Adapter framework into your Xcode Project, i.e. drop ISUnityAdsAdapter.framework into your Xcode project.

 

Evaluate Your Ad Network Integration

  • Verify your ad network integration with our Integration Helper. The ironSource SDK provides a tool to ensure you’ve successfully integrated our SDK as well as any additional network adapters.
  • Manage the debug logs for your integrated mediation ad networks with this boolean

    [IronSource setAdaptersDebug:YES];

    When set to YES, this line of code will enable debug logs to help you troubleshoot issues with all of your mediation ad networks. Remove this code before your app goes live with our ad units! Supported for SDK versions 6.5.2 and up.

Done!
You are now all set to deliver UnityAds Ads within your application!


What’s Next?

To leverage additional ad networks through ironSource Mediation, integrate the adapters and follow our integration guides