Tapjoy Mediation Integration Guide

This guide will instruct you step-by-step on how to set Tapjoy 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 Tapjoy Account

  1. Create an account with Tapjoy. You can do so here.
  2. Click on the link in the confirmation email to verify your account. Once your account has been verified, you can log in to their partner login here.

Step 2. Create an Application in Tapjoy

To gain access to Tapjoy’s inventory within ironSource‘s Mediation platform, you must first add your app and set up Ad Zones in your Tapjoy account.

  1. Add Your App

    1. Log into your Tapjoy account.
      1. If you are a new user on Tapjoy you will be presented with this window, and can simply select ‘Create App‘:
        Tapjoy 1
      2. If you are a registered user, add an app by clicking on the top-right corner and select ‘+Add App‘:
        Tapjoy 9
    2. Define App Settings

      1. Platform – iOS or Android or both
        Note: While Tapjoy allows you to create your app with both platforms, you will need a unique Tapjoy SDK Key per platform (iOS + Android) to enable it in your ironSource account. If you use a combined Dashboard on Tapjoy it will give you both an iOS and Android SDK key.
      2. App Name
      3. Orientation 
      4. Time Zone
      5. Currency
      6. Select ‘Create Now’ to finish.
        Tapjoy 2

 

Step 3. Add Placement, Virtual Currency and Content

  1. Ad Placement

    Once your application has been added, Tapjoy will create default placements for you. Placements are the ad zones to which Tapjoy delivers ads. This will thus be the placement in your app where Tapjoy’s Video or Interstitial will be triggered through ironSource‘s Mediation.
    Important! Placements must be user-initiated to work in conjunction with ironSource‘s Mediation platform.

    1. Go to the Monetization tab in the top menu and in the left side bar select ‘Placements‘.
      Click on the settings icon on one of the default placements:
      Tapjoy 6
    2. If you are using the auto created placements, you can rename the placement if you wish. Note that the placement name must later be inserted on the ironSource Dashboard. If you are serving both Tapjoy’s Video and Interstitial, you will need two separate placements, one for Rewarded Video and another for Interstitial.
      ironSource TJ Auto Placement
      Next, set the placement Type to ‘a fixed location outside of gameplay (in-app store, settings etc.)‘. This will ensure this ad placement is user-initiated. Click ‘Save‘.
      Tapjoy 7
    3. If you decide to create a new placement to work in conjunction with ironSource‘s mediation platform, select ‘Create Placement’ on the right-hand side.
      ironSource TJ Create Placement
    4. Enter the name and description for this placement. Set the placement Type to ‘a fixed location outside of gameplay (in-app store, settings etc.)‘. This will ensure this ad placement is user-initiated. Click ‘Create‘.
      ironSource TJ Create New Placement
  2. Virtual Currency

    Next, you need to add a virtual currency to your Tapjoy account. All content units on Tapjoy must be associated with a virtual currency. Learn more on creating a Tapjoy Virtual currency on the Tapjoy Knowledge Center.

    1. In the Monetization tab, navigate to the Virtual Currency section.
      ironSource TJ Create Virtual Currency
    2. Select the ‘Create Virtual Currency’ button on the top right.
      ironSource TJ VIrtual Currency Button
    3. The below window will appear. Tapjoys recommends the Tapjoy Managed currency but if you choose to use the Self Managed option, we recommend inserting “NO_CALLBACK” in the “Callback URL or NO_CALLBACK” field, as this will avoid unnecessary currency calls as the ironSource SDK handles the rewarding for ads served through our mediation.
      1. Fill in the relevant details:
        1. Platform: iOS or Android
        2. Currency Name, e.g. coins, gold, chips, etc.
        3. Currency Usage Description
        4. Default Exchange Rate
        5. Callback URL or No_Callback (Self Managed currency only)
          We recommend inserting NO_CALLBACK 
        6. Initial Balance, the currency amount your user is given when s/he starts using your app.
        7. In-app virtual currency exchange to real world resources: no
          You can disregard the other steps as they are not required fields; leave them as is.
          ironSource TJ Managed Virtual Currencyscreen-shot-2017-08-24-at-1-50-24-pm
    4. Click ‘Create Now‘ and you will see your defined virtual currency as Enabled on your Virtual Currency dashboard.
      ironSource TJ Enabled Virtual Currency
  3. Content Unit

    Lastly, you must add the relevant content card to the placement. Our mediation platform supports both Rewarded Video and Interstitial content for Tapjoy.

    1. To add content to your placements, go to ‘Monetization‘ on the top menu bar. Navigate to ‘Create Content‘ on the left sidebar. You will then see the list of Tapjoy’s Monetization products. Supersonic TJ Mediation Content Creation
    2. Next, select the relevant ad unit you want to serve through ironSource‘s Mediation platform.
      1. To serve Rewarded Video, select Video by clicking ‘Create‘.
        Do not select Mediated Video, as this is geared to Tapjoy’s communication within their mediation SDK.
        Supersonic TJ Mediation Video
      2. To serve Interstitial, select Interstitial by clicking ‘Create‘.
        ironSource TJ Interstitial
    3. Next, fill out the following form:
      1. Content Name & Description
      2. Platform– if your app supports both platforms, create two separate content units for each platform.
        Mediation TJ Basic Info
      3. Targeting– leave this section as is.
      4. Placement– select the relevant placement created to run in conjuction with ironSource’s Mediation.
        Supersonic Mediation TJ Placements Info
      5. Schedule & Frequency– leave this section as is.
      6. Virtual Currency– select the virtual currency created in the former step.
        Note: Tapjoy Content Units must be associated with a virtual currency, even if you are using ironSource rewards to reward your users. Learn more on creating a Tapjoy Virtual currency on the Tapjoy Knowledge Center.
      7. Reward Options
        When serving Tapjoy’s Rewarded Video or Interstitials through the ironSource Mediation platform, you should set the Tapjoy reward to zero and hide the reward message.

        1. For Rewarded Video, this will ensure you don’t award the user twice and will prevent user confusion when seeing a Tapjoy generated message with a different reward amount.
        2. For Interstitial, Interstitials you serve through our Mediation are non-incentivized so you just need to ensure you configure these settings in Tapjoy’s dashboard.
          To do this simply set the Reward Type to Fixed Rewards, enter 0 for the Reward Amount and check the box to Hide Rewards:
          ironsource-tj-rv-rewards
      8. Click ‘Save‘.

 

Step 4. Activate Tapjoy on ironSource SDK Networks Module

There are a few pieces of data from your Tapjoy account which need to be inserted into your ironSource Network Setup Module in order for Tapjoy to work correctly in connection with ironSource:

SDK Key This is the unique identifier of your application in Tapjoy’s system.
Reporting API Key This is the unique identifier for the Supersonic (by ironSource) Mediation platform in Tapjoy’s system.
Placement Name This is the unique zone which Tapjoy will deliver ads through.

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

  1. SDK Key

    Navigate to the ‘Settings‘ tab on the top menu and choose App Settings from the dropdown. On the App Info page, scroll down to the bottom of the page. Under Application Platforms, you’ll find the SDK Key for the app you want to run Tapjoy’s Video ads with on the ironSource Mediation platform:

    Tapjoy 8

  2. Reporting API Key

    On the same page as the SDK Key, simply navigate to the ‘Mediation Keys’ tab. There you will find a dedicated API Key for Supersonic (by ironSource):
    tapjoy-credentials-mediation-api-key

  3. Placement Name

    Under ‘Monetization‘, navigate to ‘Placements‘ ➣ User Initiated tab. There you will see the Placement Name.

    ironsource-tj-mediation-placement-name

 

Configure Tapjoy Parameters into ironSource Account

  • Once you have all of these parameters, log in to your ironSource account and in the left sidebar, navigate to ‘Monetize‘ ➣ ‘Mediation‘ ➣ ‘Network Setup‘. There you will see a list of all supported mediation networks.ironsource-platform-mediation-network-setup
  • Select Tapjoy from the list of Available Ad Networks and click on ‘Activate‘ and then ‘Save‘.  Tapjoy will then be enabled in the Available Ad Networks table.
    ironsource-mediation-platform-tapjoy-activeironsource-mediation-platform-tapjoy-activated
  • Make sure to select the app on which you’d like to run ironSource’s Mediation with Tapjoy. Next, go to Tapjoy in the Setup list of Ad Networks and click on the ‘Define‘ icon.
    ironsource-mediation-platform-define-tj
  • Insert the ‘SDK Key‘ and ‘Placement Name’ for the relevant ad unit. Set status to Active and click ‘Save’.
    ironsource-mediation-platform-settings-tj
  • You will then see Tapjoy as Active for the defined app and ad unit on your Mediation Setup dashboard.
    ironsource-mediation-platform-tj-live
  • 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 5. Add the Tapjoy Adapter to Your Build

 

iOS

ironSource supports both Cocoapods and Manual download mechanisms.

Cocoapods

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

pod 'IronSourceTapjoyAdapter','4.0.0.4'

Manual Download

  1. Download the Tapjoy Adapter:
    Add the Tapjoy Adapter to your build. You can find the latest Tapjoy Adapter here.
    Important! The Tapjoy Adapter also contains the Tapjoy SDK and bundle file. You DON’T need to add these manually.
  2. Add the Tapjoy frameworks to your Project:
    After you download the Adapter, drop the Adapter Folder into your Xcode Project, i.e. drop the entire ISTapjoyAdapter Folder into your Xcode project. The folder contains the framework and the required resources.
    Note: Make sure you add the folder as a group (yellow folder) and not as a reference (blue folder) to your project.  
  3. Open Target ➣ Build Settings ➣ Architectures and confirm that your Xcode Project uses Base SDK version 6.0 or greater and that it does not use armv6 architecture.
  4. Adding Required Frameworks:
    Go to Targets ➣ Build Phases ➣ Link Binary With Libraries.
    Click ‘+’ to add the following frameworks:

    libc++

    ios_frameworks

    1. Linker Flags: Add two separate linker flags to Target ➣ Build Settings ➣ Linking ➣ Other Linker Flags:
      ObjC
      fobjc-arc (this allows Tapjoy to use ARC even if your Project does not)
      Ic++
    2. Add the following the your app’s Info.plist file in your Xcode project:
      <key>NSAppTransportSecurity</key>
      <dict>
        <key>NSExceptionDomains</key>
         <dict>
             <key>localhost</key>
             <dict>           
                 <key>NSExceptionAllowsInsecureHTTPLoads</key>
                 <true/>
             </dict>
         </dict>
      </dict>

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 Tapjoy Ads within your application!


What’s Next?

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