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, navigate to the Developer Dashboard and select the Operate tab:
      unity-1
    2. Then add a new project:
      unity-2
    3. Name your new project and enter the store IDs you wish to publish on (Apple App Store or Google Play). If the game hasn’t been published yet you can always add the IDs later.
      unity-3
      Note: You will need a unique UnityAds application per platform (iOS + Android) just like you do with your ironSource account.
  2. Create Placement
    UnityAds creates two default placements: one for Video (Interstitial on the ironSource Dashboard) and on for Rewarded Video. To view your placements or create new placements to run with ironSource‘s Mediation:

    1. From Operate tab of the Developer Dashboard, select your Project:
      unity-4
    2. Select Platforms from the left navigation bar to view a list of your Project’s active platforms:
      unity-5
    3. Then, select the platform you want to create Placements for:
      unity-6
    4. Click on ‘ADD NEW PLACEMENT’
      unity-7
    5. The below window will appear and you must fill in the following info:
      1. Check Rewarded video to make the ads displayed through this Placement unskippable.
      2. Select the ad Type to display through this Placement (currently, Video is the only option).
      3. Name the Placement. The Placement ID, which you call in your code implementation, automatically populates based on your entry.
      4. Check mute audio if you want the ad to default to muted audio.
      5. If you did not check Rewarded video, you can specify the number of seconds to Allow skip after for ads displayed through this Placement.
        unity-8

      6. After clicking ‘Save‘, you should see your manually added placement under your default placements:
        unity-9

      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.
      Placement 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 Operate tab and select your Project, then select Platforms from the left navigation bar. You will then see a list of all added apps in that project as well as their respective Game IDs:
      unity-10

    2. Placement ID
      Go to Operate tab and select your Project, then select Platforms from the left navigation bar. Choose the platform you want to see placements for:

      unity-11

      Select the relevant application from the available list and under the ‘Ad Placements‘ tab you will see the placement IDs for all your placements. Choose the ID of the default ad type (Rewarded video, video or one of the placements you created)

    3. API Key
      Navigate to the main monetization dashboard and click on API KEYS. You will then see your API Key.
      unity-12

    Configure UnityAds’s Parameters into ironSource Account

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

    • Go to ‘Monetize‘ ➣ ‘SDK Networks‘ ➣ ‘Available Networks‘.

      unity-13

    • Select UnityAds from the list of available Ad Networks and input the UnityAds ‘API Key‘ in the relevant fields.
      unity-14
    • Click ‘Save‘. UnityAds will then be enabled in the Available Ad Networks table
    • Make sure you choose the app you want to integrate from the apps list on the left side of the SDK networks page.
    • Click on the unity ads’ Setup button and enter the ‘Game ID‘ and ‘Placement ID‘ under the relevant Ad Unit Settings:
      unity-last
    • You will then see UnityAds as Active for Mediation on your Setup Dashboard.
    • 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','4.1.1.4'

    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.

     Note: if you are using Facebook Audience Network’s server-to-server callbacks and are leveraging the DynamicUserID parameter to verify AdRewarded events, you will see this parameter reflected in their server-side callbacks. In addition, you can also see this parameter in the ironSource server-to-server callbacks.

    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