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 Automatic data collection, and how to integrate the Tapjoy SDK and adapter into an Android app.

Supported formats and platforms

The Ad Manager mediation adapter for Tapjoy has the following capabilities:

Formats
Banners
Interstitials
Rewarded Video
Rewarded Video (new APIs)
Native Ads - Custom Rendering
Features
Smart Banners
Automatic data collection

Requirements

• Android API level 16 or higher

• Latest Google Mobile Ads SDK

Step 1: Set up Tapjoy

Sign up or 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 the 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.

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

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 Ad Manager, 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 Ad Manager Ad Unit for mediation in the next section. "Ad Manager Mediation" has been used in this example, but you can call your placement whatever you like.

Note: Create a new placement for each Ad Manager interstitial or rewarded video ad unit that you want to mediate to Tapjoy.

Virtual currency

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

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

Note: The currency value and name will not be forwarded by the Tapjoy adapter. So, any generic values can be chosen for your Currency name and amount. See the Using Rewarded Video Ads section of this guide for more details.

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.

Interstitial

Click the Create button for the Interstitial 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 Interstitial placement created earlier. Click the Save button at the bottom when finished to create your content.

Rewarded Video

Click the Create button for Rewarded 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 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 Ad Manager ad unit.

Navigate to Settings > App Settings:

SDK key

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

Publisher OAuth key

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

Mediation Key

Your Mediation Key can be obtained in the same page under the Mediation Keys tab under the Reporting API Key column. It will be labeled as "AdMob." Google Ad Manager publishers should still use this value, despite the name mismatch.

Step 2: Configure mediation settings for your Ad Manager ad unit

Sign in to your Ad Manager account. Navigate to Delivery > Yield groups and click the New yield group button.

Enter a unique Name for your yield group, set the Status to Active, select your Ad Format, and set the Inventory type to Mobile App. Under the Targeting > Inventory section, select the Ad Unit ID to which you want to add mediation.

Next, click the Add yield partner button.

If you already have a Yield partner for Tapjoy, you can simply select it. Otherwise, select Create a new yield partner.

Select Tapjoy as the Ad network and enter a unique Name. Enable Mediation and turn on Automatic data collection, and enter the Publisher OAuth Key and Mediation Key obtained in the previous section. You don't need to enter a Username and Password. Click Save when done.

Once the Yield partner is selected, choose Mobile SDK mediation as the Integration type, Android as the Platform, and Active as the Status. Enter the SDK Key and the Placement Name obtained in the previous section and a Default CPM value.

Click Save at the bottom of the page when done.

Note: Automatic data collection takes a few days to gather data before it can accurately calculate a Dynamic CPM value for a mediation network. Once the eCPM can be calculated, it will be automatically updated on your behalf.

Using rewarded video ads

In the settings for your rewarded video ad unit, provide values for the reward amount and reward type. Then, to ensure you provide the same reward to the user no matter which ad network is served, check the Override reward settings from third-party ad networks when using mediation box.

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

Step 3: Import the Tapjoy SDK and adapter

Android Studio integration (recommended)

Add the following implementation dependency with the latest version of the Tapjoy SDK and adapter in the app-level build.gradle file:

repositories {
    jcenter()
}

...
dependencies {
    implementation 'androidx.appcompat:appcompat:1.0.2'
    implementation 'com.google.ads.mediation:tapjoy:12.7.0.0'
}
...

Manual integration

Download the Tapjoy Android SDK and extract the tapjoyconnectlibrary.jar under the Libraries folder and add it to your project.

Download the latest Tapjoy adapter .aar file from Bintray, and add it to your project.

Step 4: Additional code required

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:

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

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.

Optional steps

EU consent and GDPR

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.

In Tapjoy SDK version 11.12.2, Tapjoy added a user consent API. The following sample code sets user consent to "1" on 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.

Note: Your app must reference Tapjoy adapter 11.12.2.0 or higher and Tapjoy SDK 11.12.2 or higher to use the code below.

import com.tapjoy.Tapjoy;
// ...

Tapjoy.setUserConsent("1"); //user does consent

See Tapjoy's Release Notes for more information.

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"/>

Network-specific parameters

The Tapjoy adapter supports an additional request parameter which can be passed to the adapter using the TapjoyExtrasBundleBuilder class. The TapjoyExtrasBundleBuilder includes the following method:

• setDebug(bool) - Enabling debug mode on Tapjoy SDK enables you to see various Tapjoy actions in the Tapjoy Developer Console. This param is supported for all ad formats.

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

JAVA

Bundle extras = new TapjoyAdapter.TapjoyExtrasBundleBuilder()
          .setDebug(true)
          .build();
PublisherAdRequest adRequest = new PublisherAdRequest.Builder()
          .addNetworkExtrasBundle(TapjoyAdapter.class, extras)
          .build());

KOTLIN

val extras = TapjoyExtrasBundleBuilder()
          .setDebug(true)
          .build()
val adRequest = PublisherAdRequest
          .addNetworkExtrasBundle(TapjoyAdapter::class.java, extras)
          .build()

Tapjoy Android Mediation Adapter Changelog

Version 12.7.0.0

• Fixed an issue where the adapter returns an incorrect version string.
• Updated the minimum required Google Mobile Ads SDK version to 19.4.0.

Built and tested with:

• Google Mobile Ads SDK version 19.4.0.
• Tapjoy SDK version 12.7.0

Version 12.6.1.0

• Verified compatibility with Tapjoy SDK version 12.6.1.
• Loading multiple interstitial ads with the same Tapjoy placement name at once now results in a load error for the second request. This behavior now matches existing behavior for rewarded ads.

Built and tested with:

• Google Mobile Ads SDK version 19.2.0.
• Tapjoy SDK version 12.6.1.

Version 12.6.0.0

• Verified compatibility with Tapjoy SDK version 12.6.0.
• Updated the minimum required Google Mobile Ads SDK version to 19.2.0.

Built and tested with:

• Google Mobile Ads SDK version 19.2.0.
• Tapjoy SDK version 12.6.0.

Version 12.4.2.1

• Added descriptive error codes and reasons for adapter load/show failures.
• Updated the minimum required Google Mobile Ads SDK version to 19.0.1.

Built and tested with:

• Google Mobile Ads SDK version 19.0.1.
• Tapjoy SDK version 12.4.2.

Version 12.4.2.0

• Verified compatibility with Tapjoy SDK version 12.4.2.

Built and tested with:

• Google Mobile Ads SDK version 18.3.0.
• Tapjoy SDK version 12.4.2.

Version 12.4.1.0

• Verified compatibility with Tapjoy SDK version 12.4.1.

Built and tested with:

• Google Mobile Ads SDK version 18.3.0.
• Tapjoy SDK version 12.4.1.

Version 12.4.0.0

• Verified compatibility with Tapjoy SDK version 12.4.0.

Built and tested with:

• Google Mobile Ads SDK version 18.3.0.
• Tapjoy SDK version 12.4.0.

Version 12.3.4.0

• Verified compatibility with Tapjoy SDK version 12.3.4.
• Updated the minimum required Google Mobile Ads SDK version to 18.3.0.

Built and tested with:

• Google Mobile Ads SDK version 18.3.0.
• Tapjoy SDK version 12.3.4.

Version 12.3.3.0

• Verified compatibility with Tapjoy SDK version 12.3.3.

Version 12.3.2.0

• Verified compatibility with Tapjoy SDK version 12.3.2.
• Updated the minimum required Google Mobile Ads SDK version to 18.2.0.

Version 12.3.1.1

• Tapjoy Adapter now only requests a single ad for every placement.

Version 12.3.1.0

• Updated the adapter to invoke 'onClick()' ad event.
• Verified compatibility with tapjoy SDK version 12.3.1.
• Updated the minimum required Google Mobile Ads SDK version to 17.2.1.

Version 12.2.1.1

• Added open bidding capability to the adapter for interstitial and rewarded ads.

Version 12.2.1.0

• Verified compatibility with tapjoy SDK version 12.2.1.

Version 12.2.0.1

• Updated adapter to support new open-beta Rewarded API.
• Updated the minimum required Google Mobile Ads SDK version to 17.2.0.

Version 12.2.0.0

• Verified compatibility with tapjoy SDK version 12.2.0.

Version 12.1.0.0

• Verified compatibility with tapjoy SDK versiobn 12.1.0.

Version 12.0.0.1

• Updated the adapter to invoke the onRewardedVideoComplete() ad event.

Version 12.0.0.0

• Verified compatibility with tapjoy SDK versiobn 12.0.0.

Version 11.12.2.0

• Verified compatibility with tapjoy SDK versiobn 11.12.2.

Version 11.12.1.0

• Verified compatibility with tapjoy SDK versiobn 11.12.1.

Version 11.12.0.0

• Verified compatibility with tapjoy SDK versiobn 11.12.0.

Version 11.11.1.0

• Verified compatibility with Tapjoy SDK version 11.11.1.

Version 11.11.0.0

• Updated the adapter to make it compatible with Tapjoy SDK version 11.11.0.

Version 11.10.2.0

• Updated the default reward amount to 1.
• Verified compatibility with Tapjoy SDK version 11.10.2.

Version 11.10.1.0

• Verified compatibility with Tapjoy SDK version 11.10.1.

Version 11.10.0.0

• Verified compatibility with Tapjoy SDK version 11.10.0.

Version 11.9.1.0

• Initial release. Supports reward-based video ads and interstitial ads.