Integrating Tapjoy with Mediation

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

Supported formats and platforms

The AdMob mediation adapter for Tapjoy 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 8.3 or later
  • To deploy on iOS:
    • Xcode 6.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 Tapjoy

Sign up and log in to your Tapjoy dashboard.

Add app

Add your app to the Tapjoy dashboard by going to the apps list on the top right and clicking Add App button. You will be prompted to enter details about your app.

Fill out the form and click the Create Now button to add your app to Tapjoy dashboard.

If your app supports both platforms, choose Both as the platform.

You can skip the integration steps presented by Tapjoy and can move on to creating placements to be used with AdMob mediation.

Android

iOS

Placement, virtual currency and content

Placement

Navigate to Monetization > Placements and click the Create Placement button in the top right corner. Even if you have an existing placement, it's best to create a new one for AdMob, so it can be tracked and reported on separately.

Enter a Name for your placement, check the Mediation checkbox, and select AdMob from the drop down list. Click Create when done.

The Placement Name entered here will be used to set up your AdMob Ad Unit for mediation in the next section. "AdMob Mediation" has been used in this example, but you can call your placement whatever you like.

Virtual currency

Navigate to Monetization > Virtual Currency and click the Create Virtual Currency button in the top right corner.

Fill the form and click Create now. Use NO_CALLBACK as the Callback URL. This ensures that the Tapjoy SDK avoids an unnecessary call to your server.

If your app supports both platforms, you need to create two virtual currencies, one for each.

Android

iOS

Content

Navigate to Monetization > Create Content to create Content to be shown with the placements.

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

If your app supports both platforms, you need to create two contents, one for each.

Interstitial Android

Click the Create button for the Interstitial Content.

Provide a Name for the Content and choose Android as the platform.

Select the virtual currency created earlier as the Virtual Currency.

Select the Interstitial placement created earlier. Click the Save button at the bottom when finished to create your Content.

Interstitial iOS

Click the Create button for the Interstitial Content.

Provide a Name for the Content and choose iOS as the platform.

Select the virtual currency created earlier as the Virtual Currency.

Select the Interstitial placement created earlier. Click the Save button at the bottom when finished to create your Content.

Rewarded Video Ads Android

Click the Create button for Video Content.

Provide a Name for the Content and choose Android as the platform.

Select the virtual currency created earlier as the Virtual Currency.

Select the rewarded video placement created earlier. Click the Save button at the bottom when finished to create your Content.

Rewarded Video Ads iOS

Click the Create button for Video Content.

Provide a Name for the Content and choose iOS as the platform.

Select the virtual currency created earlier as the Virtual Currency.

Select the rewarded video placement created earlier. Click the Save button at the bottom when finished to create your Content.

SDK and reporting keys

In addition to the Placement Name you also need the SDK Key, Publisher OAuth Key, and Mediation Key for setting up your AdMob ad unit.

Navigate to Settings > App Settings

SDK key

Your SDK Key can be obtained from your App Info under the Application Platforms tab.

Android

iOS

Publisher oauth key

Your Publisher OAuth Key can be obtained in the same page under the API Keys tab.

Mediation Key

Your AdMob Mediation Key can be obtained in the same page under the Mediation Keys tab under the Reporting API Key column.

Step 2: Configure AdMob ad unit

You need to add Tapjoy to the mediation configuration for your Ad Unit. First sign into 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 Tapjoy as an ad source.

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

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.

Ad units selection overlay.

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 as shown below:

Add Tapjoy as an ad source

In the Ad Sources card, select Add Ad Network.

Select Tapjoy and enable the Optimize switch. Enter your Publisher OAuth Key and Mediation Key obtained in the previous section to set up ANO for Tapjoy. Then enter an eCPM value for Tapjoy and click Continue.

Next, enter the SDK Key and Placement Name 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 Tapjoy as an ad source.

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

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.

Ad units selection overlay.

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 as shown below:

Add Tapjoy as an ad source

In the Ad Sources card, select Add Ad Network.

Select Tapjoy and enable the Optimize switch. Enter your Publisher OAuth Key and Mediation Key obtained in the previous section to set up ANO for Tapjoy. Then enter an eCPM value for Tapjoy and click Continue.

Next, enter the SDK Key and Placement Name 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.

If you don't override the reward, the Tapjoy adapter defaults to a reward of type "" (empty string) with value 1. The Tapjoy SDK does not provide specific reward values for its rewarded video ads.

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

Step 3: Import the Tapjoy SDK and adapter

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

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

Step 4: Additional code required

Android

Modify Android manifest

Activities

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

<activity
    android:name="com.tapjoy.TJAdUnitActivity"
    android:configChanges="orientation|keyboardHidden|screenSize"
    android:hardwareAccelerated="true"
    android:theme="@android:style/Theme.Translucent.NoTitleBar.Fullscreen" />

<activity
    android:name="com.tapjoy.mraid.view.ActionHandler"
    android:configChanges="orientation|keyboardHidden|screenSize" />

<activity
    android:name="com.tapjoy.mraid.view.Browser"
    android:configChanges="orientation|keyboardHidden|screenSize" />

<activity
    android:name="com.tapjoy.TJContentActivity"
    android:configChanges="orientation|keyboardHidden|screenSize"
    android:theme="@android:style/Theme.Translucent.NoTitleBar"
    android:hardwareAccelerated="true" />

iOS

No additional code is required for Tapjoy integration.

Step 5: Test your implementation

Test ads can be enabled on the Tapjoy dashboard under Settings > App Settings > Test Devices. Create a new test device using the device's Advertising ID as shown below:

Android

Your device's Advertising ID can be located by navigating to Google > Ads in your device Settings.

iOS

To get your device's advertising ID, add the following code in your app. Make sure to import AdSupport framework into your app before using the code below.

NSString *advertisingId = [[[ASIdentifierManager sharedManager]
advertisingIdentifier] UUIDString];
NSLog(@"Advertising ID: %@", advertisingId);

Next, modify the Content you created earlier.

To modify your content, first navigate to Monetization > Placements and click the User Initiated tab. Next, select the drop down for the content you want to edit, and choose Edit.

Under the Content's Basic section, check the Only for Test Devices checkbox. Then click Save at the bottom of the page.

That's it! You now have a working mediation integration with Tapjoy.

Android

iOS

Optional steps

Android

Permissions

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

<uses-permission android:name="android.permission.READ_PHONE_STATE" />
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />

iOS

No additional steps required for iOS integration.

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

The Google Mobile Ads mediation plugin for Tapjoy version 1.1.1 includes the Tapjoy.SetUserConsent() and Tapjoy.SubjectToGDPR() methods. The following sample code shows how to pass consent information to the Tapjoy SDK. If you choose to call this method, it is recommended that you do so prior to requesting ads via the Google Mobile Ads SDK.

using GoogleMobileAds.Api.Mediation.Tapjoy;
// ...
// 0 - User did not consent
// 1 - User does consent
Tapjoy.SetUserConsent("1");

Additionally, there is an optional flag that can be set to indicate whether the user is subject to GDPR.

Tapjoy.SubjectToGDPR(true);

See Tapjoy's release notes for more information.

Send feedback about...

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