Download the SDK

• You can download our SDK from the Download Page.

SDK Integration Instructions:

Dashboard Integration Guide

NEW: The Tapjoy Dashboard now has a built-in Integration Guide that will walk you through the steps of a Tapjoy integration. You can still use this Getting Started Guide document as a reference if you wish. You can go directly to the Integration Guide for your most recent app, or you can go to the Tapjoy Dashboard, select your app,  go to the "Support" menu in the upper-right, and click "How to Integrate".

Manual Integration

If you want to do the integration purely from the documentation (or you are using Adobe AIR, for which we do not have a Dashboard Integration Guide), you may find the docs for each platform here:

• iOS

• Android

• Unity

• Air

• Cocos2d-x

Note: To find your Tapjoy SDK Key please see this link.

PPE (Pay Per Engagement) Integrations

If you are an advertiser running a PPE campaign, you must first do a standard advertiser integration (iOS, Android, Unity, AIR), and then follow these additional instructions to instrument the action on which you wish the engagement to trigger.

Release Notes:

SDK 11.12.0:

Released March 29, 2018. 

iOS

• Removed requirement for CoreLocation framework.
• Removed deprecated "Tapjoy Platform Mediation" functionality. This was a specialized form of mediation that Tapjoy has not supported for almost a year. If you are still using platform mediation, you should not update to this version of the SDK, and we recommend switching to industry-standard adapter mediation. Regular adapter mediation functionality (such as video and interstitial mediation provided by Mopub, ironSource, Fyber, Appodeal, and other mediators) is unaffected by this change.
• Bug fixes:
  • Fixed some bugs involving video freezing when interrupted by headphone unplug, Siri, or alert pop-up.
  • Fixed infrequent crash involving  UIColor colorFromHexString.
• Fixed infrequent issue where audio from a Tapjoy video could play for a few seconds after an app is restored from the background.

Android

• Tapjoy’s SDK will no longer trigger the following permissions:
  • ACCESS_FINE_LOCATION
  • ACCESS_COARSE_LOCATION
  • WRITE_EXTERNAL_STORAGE
• Removed deprecated "Tapjoy Platform Mediation" functionality. This was a specialized form of mediation that Tapjoy has not supported for almost a year. If you are still using platform mediation, you should not update to this version of the SDK, and we recommend switching to industry-standard adapter mediation. Regular adapter mediation functionality (such as video and interstitial mediation provided by Mopub, ironSource, Fyber, Appodeal, and other mediators) is unaffected by this change.
• Bug Fixes:
  • Removed an incorrect error message when Tapjoy video content played from cache and there is no network connection.
  • Fixed an issue where after returning from Tapjoy content, the offerwall or application would be shown in the incorrect orientation.

Unity

• Removed an incorrect "Error while downloading Asset Bundle" error message when building for Unity Android.
• All fixes and features from the iOS and Android SDK updates

AIR

• All fixes and features from the iOS and Android SDK updates

 

 

SDK 11.11.1:

Released November 8, 2017. 

iOS

• The setAppDataVersion method has been deprecated.
• Removed App Transport Security (ATS) settings from EasyApp info.plist, as these are no longer required.
• Added documentation for the EasyApp Tapjoy sample application included in the SDK.
• Bug fixes:
  • Fixed a crash when placement was called with placement name = NIL.
  • Fixed duplicate observers crash when "All Exceptions" are enabled in Xcode.

Android

• Tapjoy SDK no longer collects IMEI, which removes the need for the READ_PHONE_STATE permission.
• The setAppDataVersion method has been deprecated.
• Added documentation for the EasyApp Tapjoy sample application included in the SDK.
• Bug Fixes:
  • Fixed an infrequent crash that happened when app tries to show the same content request multiple times.
  • Fixed an issue where content cache could get corrupted, leading to video playback errors.

Unity

• Added the GetUserTags API, which exists in iOS and Android but had been missing from the Unity plugin.
• Added documentation for the EasyApp Tapjoy sample application included in the SDK.
• All fixes and features from the iOS and Android SDK updates

AIR

• All fixes and features from the iOS and Android SDK updates

SDK 11.11.0:

Released June 19, 2017. 

iOS

• Changed video player from HTML 5 player to native video player.
• ATS (App Transport Security) settings are no longer required in the info.plist. The SDK no longer caches video using localhost, so these ATS exceptions are no longer required.
• WebKit.framework is now required.
• SDK size reduction: The arm64 slice size has been reduced by 16% to 1.01MB (vs. 1.2MB in 11.10.2). The total SDK size has been reduced by 20% to 1.89MB (vs. 2.35MB in 11.10.2).
• Removed a legacy API: enablePaidAppWithActionID 
• Bug fixes:
  • Fixed a number of infrequent crashes that happened on ARM64 devices running iOS 8.

Android

• Removed a legacy API: enablePaidAppWithActionID
• Bug Fixes:
  • This version of the Android SDK avoids use of Timer class, which on some Android Lollipop (5.x) devices results in significant memory usage.
  • Fixed an infrequent crash where TJAdUnit$a.onPageFinished caused a NullPointerException.

Unity

• All fixes and features from the iOS and Android SDK updates

AIR

• All fixes and features from the iOS and Android SDK updates

SDK 11.10.2:

Released May 17, 2017. This is a minor bug-fix release. There is no new functionality.

iOS

• Bug fixes:
  • Fixed a bug where UnityAds SDK 2.1.0 conflicted with Tapjoy’s SDK, resulting in distorted or obscured Tapjoy content.

Android

• Bug Fixes:
  • Fixed an infrequent crash in onActivityStart when activity intent is null.
  • Improved ability for SDK to switch to streaming video playback if cached version fails.

Unity

• Bug Fixes:
  • Fixed an Android session tracking bug.
• All fixes and features from the iOS and Android SDK updates

AIR

• Bug Fixes:
  • Fixed an Android session tracking bug.

  All fixes and features from the iOS and Android SDK updates

SDK 11.10.1:

Released April 13, 2017. This is a minor bug-fix release. There is no new functionality.

iOS

• Bug fixes:
  • Small memory leak related to webview fixed.
  • Bug that was causing crashes during Xcode unit tests fixed.

Android

• Bug Fixes:
  • Fixed two infrequent crashes related to TJAdUnitActivity.
  • Fixed an infrequent bug where closing the offerwall resulted in closing the main application.

Unity

• Google Play Services has been removed from the distributed Tapjoy .unitypackage. (Most apps already include Google Play Services for other reasons.)
• All fixes and features from the iOS and Android SDK updates

AIR

• All fixes and features from the iOS and Android SDK updates

SDK 11.10.0:

Released February 23, 2017

iOS

• Support for animated .gif files in Native to Earn.
• Bug fixes:
  • Offerwall bug where users could scroll non-scrollable parts of the interface fixed.
  • Timeout bug with multiple placement calls fixed.
  • Bug where rotation prevented a Native to Earn button from disappearing after the allotted time fixed.

Android

• Support for animated .gif files in Native to Earn.
• EasyApp sample application now supports gradle
• SDK 11.10.0 method count reduced by about 500 (a 9% reduction) compared to SDK 11.9.1.
• Bug Fixes:
  • Native to Earn not displaying after a context change fixed.
  • Issue with some videos getting stuck in infinite loop in low memory situations fixed.

Unity

• All fixes and features from the iOS and Android SDK updates
• Bug Fixes:
  • Scope issue where Unity Android placement declarations declared locally functioned only intermittently fixed.
  • Native to Earn not showing in the AppLaunch placement fixed.

AIR

• All fixes and features from the iOS and Android SDK updates

SDK 11.9.1:

Released December 15, 2016

iOS

• Updated the sample "EasyApp" to the latest recommended ATS settings for iOS 10
• Fixed bug where debug mode could not be turned off.
• Fixed several infrequent crashes:
  •  objc_msgSend() selector name: trackTimedOutContentRequested:contentReady:
  • [TJWebViewJavascriptBridge _flushMessageQueue]
  • crash related to redirecting the user to the app store when the application does not support portrait orientation
  • NSInvalidArgumentException crash in [TJCUtil genericParameters]

Android

• No changes except for incrementing the version number to 11.9.1

Unity

• No longer requires EventKit or EventKitUI frameworks for the iOS build
• Fixed a performance issue in TapjoyComponent where Unity garbage collection (cleaning up unused data in memory) was being triggered more frequently than necessary
• Fixed an issue where the Google Play Services library was marked for inclusion in iOS builds. If you are updating and are using Unity 5.4 or higher, you will see a "Fix" button that will allow you to correct this error. New integrations can simply use the 11.9.1 plugin and do not need the "Fix" button and will not see it.
• All fixes and features from the iOS and Android SDK updates

AIR

• All fixes and features from the iOS and Android SDK updates

SDK 11.9.0:

Released November 14, 2016

iOS

• CoreLocation.framework is now optional, for those publishers who do not wish to include it in their application.
• MessageUI.framework is no longer required.
• Starting with iOS 10, Apple is asking app developers to justify accessing certain frameworks with a text string in the info.plist file. This string is shown to the user when the app asks for access to this functionality (e.g. location, accelerometer, etc.). This requirement extends to frameworks used by 3rd-party SDKs, such as Tapjoy. For your convenience, we have provided a table of .plist keys and strings to use for the frameworks that Tapjoy uses.
• Fixed a bug where marketing message content appeared without dimming the background.

Android

• Fixed an infrequent crash: java.lang.NullPointerException: Attempt to invoke virtual method ‘byte[] java.lang.String.getBytes()’ on a null object reference
• There is a new factory pattern API for creating placement objects. The old constructor still works.

Unity

• Unity Android now has a push opt-out API.
• All fixes and features from the iOS and Android SDK updates

AIR

• Google Play Services (GPS) is now no loger bundled in the Tapjoy ANE file. It is provided in a separate ANE file.
  • Both ANE files will need to be used ("linked") when building to Android via Flash builder.
  • If another ANE file you are linking already includes Google Play Services, you do not need to include the Google Play Services ANE provided by Tapjoy. Indeed, doing so will result in a duplication error.
  • You do not need the Google Play Services ANE file when building to iOS.
• All fixes and features from the iOS and Android SDK updates

SDK 11.8.2:

Released October 6, 2016

iOS

• Fixed  bugs involving how the Push-to-Earn feature interacted with the video and offerwall content units.

Android

• Made the GET_ACCOUNTS permission optional for API level 16 and higher. You will still need the GET_ACCOUNTS permission to use push notifications on API level 15 and earlier.

Unity

• All fixes and features from the iOS and Android SDK updates

AIR

• All fixes and features from the iOS and Android SDK updates

SDK 11.8.1:

iOS

Released September 14, 2016

• iOS SDK no longer requires EventKit and EventKitUI frameworks. These can be removed if not needed by other parts of your app. Removing these frameworks can solve the App Store rejection associated with NSCalendarsUsageDescription. For more information on this, and how to get around it for versions of Tapjoy prior to 11.8.1, see this article.
• Fixed a memory leak.
• Added setDefaultViewController function for Push to Earn and default placements.
• Fixed a rare ad rotation issue found with one mediation partner.

Android

Released September 19, 2016

• Decreased SDK size by 372Kb (9% decrease from previous version).

Unity

Released September 19, 2016

• All fixes and features from the iOS and Android SDK updates

AIR

Released September 19, 2016

• All fixes and features from the iOS and Android SDK updates

SDK 11.6.0:

• Released April 26, 2016
• New Feature (iOS, Android, Unity): Fyber Platform Mediation. Take advantage of Fyber Mediation with the power of the Tapjoy Platform.
• New Feature (all platforms): Default Placements BETA. If you are creating a new application, two placements will be created for you automatically: AppLaunch and InsufficientCurrency. These placements are triggered by the Tapjoy SDK automatically, without code work required from the publisher. (InsufficientCurrency will only trigger if you are using Tapjoy Managed Currency, otherwise Tapjoy’s SDK can’t tell when the user has insufficient currency.) If you wish to be included in the beta, please contact your Tapjoy account manager or support@tapjoy.com.

iOS

• Bug fix: Video content now responds correctly when showContent is called with no network connection.

Android

• Bug fix: Improved asset caching,
• Bug fix: Fixed problem where creating a placement before connect succeeds results in a bad request URL.

Unity

• Note that the file structure of the Tapjoy Unity plugin has changed. If you are upgrading an older, pre-11.6.0 version of the plugin, you will have to delete some files. We have a doc explaining which files need to be deleted. New Tapjoy Unity Plugin integrations are unaffected by this.
• New Editor window UI: Added some more functionality to monitor file changes, added "?" link to documentation.
• Bug fixes inherited from the iOS and Android SDK updates

AIR

• Bug fixes inherited from the iOS and Android SDK updates

SDK 11.5.1:

• Released March 23, 2016.
• The only change from 11.5.0 (March 7 2016) to 11.5.1 is the inclusion of the Fyber Adapter in the Tapjoy SDK. If you are using Fyber Adapter Mediation and wish to use Tapjoy features in 11.5, such as Native to Earn and User Tags, you will have to use Tapjoy SDK 11.5.1 and follow our special Fyber Adapter Integration instructions. The reason for this is that the Fyber Adapter package available on the Fyber website incorporates the 11.3.0 version of the Tapjoy SDK.
• For those not using Fyber Adapter Mediation, there is no reason to upgrade from 11.5.0 to 11.5.1.

SDK 11.5.0:

• Released March 7, 2016.
• Added support for the Native to Earn feature. This feature allows you to use a button that matches your native interface to drive your users to Tapjoy’s various monetization products. [Note: The Tapjoy dashboard UI necessary for this feature will be released March 9 2016, Pacific Time.]
• Added support for the User Tags feature. You can now use SDK calls to add tags to your users, and then target Tapjoy monetization content at users who have or don’t have specific tags. [Note: The Tapjoy dashboard UI necessary for this feature will be released the evening of March 7 2016, Pacific Time.]

SDK 11.4 & 11.4.1:

• Released February 8, 2016. Download here.

• Added support for Mediation:
  • Fyber Adapter Mediation
  • AerServ LTV Platform Mediation
  • Mopub LTV Platform Mediation (Mobpub Adapter Mediation continues to be supported as well.)
  • AerServ Adapter Mediation

• Deprecated Currency Display Multiplier SDK call (e.g. setCurrencyMultiplier:). This call still functions, but it will be removed in future versions of the SDK. If you wish to individualize the amount of currency users get for various offers, we recommend using the Personalized Currency Sale feature on the Tapjoy Dashboard instead:
  
• The initial release of 11.4.0 had an Android bug related to push notifications. This bug has been corrected in the 11.4.1 release for Android, Unity, and AIR. This did not apply to the iOS version, so the latest iOS version remains 11.4.0 .

SDK 11.3:

• Released December 8, 2015. Download here.

Android

• Removed showOffers call. To display an OfferWall, publisher now must use the more powerful and flexible placements system. If you need to switch your application, please see our "Switching from showOffers to Placements" guide.
• Improved support for Android 6.0 "Marshmallow" (API level 23). Workarounds are no longer needed when supporting Marshmallow with Tapjoy SDK 11.3.
• OS required: The minimum OS required to support Tapjoy is now Android 2.3 "Gingerbread" (API level 9) or above. (For 11.2.2 this was Android 2.2 "Froyo" (API level 8).
• Minor bug fixes:
  • Fixed: Bug where on some kinds of offers, user had to tap the close button twice.
  • Fixed: Edge-case crash on Android 5.x "Lollipop" where WebView updates at the same time the SDK attempts to show content.

iOS

• Removed showOffers call. To display an OfferWall, publisher now must use the more powerful and flexible placements system. If you need to switch your application, please see our "Switching from showOffers to Placements" guide.
• Support for IPv6. Starting in early 2016, Apple will require all apps submitted to the App Store to support IPv6.
• An issue with Bitcode support was fixed. All submissions to the iTunes App Store that use bitcode should update to the 11.3 version of the SDK.
• Issue where the status of the "Don’t Show Today" button was inherited by IAP Promotion content units from content units above it in the placement waterfall was fixed.

 

Unity

• Removed showOffers call. To display an OfferWall, publisher now must use the more powerful and flexible placements system. If you need to switch your application, please see our "Switching from showOffers to Placements" guide.
• All Android and iOS changes mentioned above.

 

Air

• Removed showOffers call. To display an OfferWall, publisher now must use the more powerful and flexible placements system. If you need to switch your application, please see our "Switching from showOffers to Placements" guide.
• Minimum AIR version is now 18.
• All Android and iOS changes mentioned above.

 

SDK 11.2.2:

• Released October 8, 2015. Download here.

Android

• Fixed issue where Tapjoy.setUserID  was, in certain rare conditions, not getting set correctly. This resulted in users not getting rewarded. Now, this call will work regardless of whether the Connect Call has succeeded yet or not.
• Fixed two infrequent crashes:

  • java.lang.NullPointerException: Attempt to invoke virtual method 'void com.tapjoy.mraid.view.BasicWebView.setBackgroundColor(int)' on a null object reference at
    com.tapjoy.TJAdUnit$2.run(SourceFile:390)

  • java.lang.NullPointerException
    at com.tapjoy.TJAdUnit$2.run(SourceFile:390)

iOS

• Due to iOS 9 Bitcode support (see below), Tapojoy iOS SDK 11.2.2 no longer supports iOS 5. Newer versions of the iOS SDK will also not support iOS 5. (Less than 0.04% of Tapjoy users are on iOS 5, and this number is decreasing.
• Bitcode support (see Apple’s documentation). Bitcode optimizes the installation of iOS by tailoring app delivery to the user’s particular device.
• Fixed "Unexpected CFBundleExecutable Key" error that happened on app submission.
• Automatic retry of the Connect Call: If the Connect Call  fails, the SDK will now automatically retry the Connect Call.

Unity

• All the changes listed for iOS and Android above.
• Manual Connect Call: By default, the Tapjoy SDK will attempt its Connect Call when your Unity application starts. If you wish, starting with SDK 11.2.2 you can override this and make the Connact Call manually.

AIR

• All the changes listed for iOS and Android above.

SDK 11.2.1:

• Released September 9, 2015. Download here.
• This update is to handle iOS 9 and changed "App Transport Security" requirements.
• See the document "Preparing for iOS 9" for more information.

SDK 11.2.0:

• Released August 18, 2015. Download here.

Dashboard

• Creating a test device is now easier: we now require only the advertising ID (iOS: IDFA, Android: GAID), instead of both the advertising ID and the Tapjoy device ID. If you previously set up a test device with only the Tapjoy device ID, please re-setup the device using the advertising ID.  
• You can now select multiple cohorts in the Future Value Map
• You can now select multiple countries (up to 5) or referrers in the "Retention" section of the dashboard.

Android

• • Added support for IAP receipt validation with a new API method. 
    • void Tapjoy.trackPurchase(String, String, String, String)
    • IAP receipt validation is for the Google Play store only.
    • If you do not include a receipt parameter, Tapjoy will assume that you did receipt validation on your own and will accept the purchase as valid.
  • Improved connectivity to Tapjoy servers.
    • Auto retry to connect
  • Fixed support for targeting a content unit to be shown only to users who installed the app through a specific store
  • Videos will now support both landscape left and landscape right orientations, rather than always playing in a fixed landscape orientation. 
  • Video performance improvements

 

• Introduced new TJAdUnitActivity to be added to the AndroidManifest.xml (be sure to include the < and > around the activity):

 

• • • activity android:name="com.tapjoy.TJAdUnitActivity" android:configChanges="orientation|keyboardHidden|screenSize" android:hardwareAccelerated="true" android:theme="@android:style/Theme.Translucent.NoTitleBar.Fullscreen" /
  • Removed TJAdUnitView, TJCOffersWebView, and TapjoyVideoView Activity classes. These have been replaced by theTJAdUnitActivity described above. 
  • TapjoyVideoStatus.java renamed to TJVideoStatus.java. If your are referencing this in your TJVideoListener code, please make the necessary changes.

 

iOS

• Added support for IAP receipt validation.
  • [Tapjoy trackPurchase:@"productIdentifier" currencyCode:@"USD" price:1.99 campaignId:@"CampaignID(can be nil)" transactionId:@"The iTunes Receipt Goes Here"];
  • If you do not include a receipt parameter, Tapjoy will assume that you did receipt validation on your own and will accept the purchase as valid.
• Fixed the display size of the marketing messages (Announcement, Reward, IAP Promotion) on iPad.
• Video performance improvements

C++ API

• Added API methods to track IAP with receipt validation. The final parameter is the receipt.
  • void Tapjoy::trackPurchaseInGooglePlayStore(const char*, const char*, const char*, const char*)
  • void Tapjoy::trackPurchaseInAppleAppStore(const char*, const char*, double, const char*, const char*)
  • On Android, IAP receipt validation is for the Google Play store only.

Unity

• Added support for IAP receipt validation with new API methods (the last parameter is where the receipt goes).
  • void Tapjoy.TrackPurchaseInGooglePlayStore(string, string, string, string = null)
  • void Tapjoy.TrackPurchaseInAppleAppStore(string, string, double, string, string = null)
  • On Android, IAP receipt validation is for the Google Play store only.
  • If you do not include a receipt parameter, Tapjoy will assume that you did receipt validation on your own and will accept the purchase as valid.
• All Android and iOS changes mentioned above.
• Android Manifest changes described in Android section.
• Fixed following API to work correctly:
  • void Tapjoy.ShowDefaultEarnedCurrencyAlert()

AIR

• Added support for IAP receipt validation with new API methods. (The final parameter is the receipt)
  • TapjoyAIR.trackPurchaseInGooglePlayStore(:String, :String, :String, :String):void
  • TapjoyAIR.trackPurchaseInAppleAppStore(:String, :String, :Number, :String, :String):void
  • On Android, IAP receipt validation is for the Google Play store only.
  • If you do not include a receipt parameter, Tapjoy will assume that you did receipt validation on your own and will accept the purchase as valid.
• All Android and iOS changes mentioned above.
• Android Manifest changes described in Android section.

SDK 11.1:

• Released June 9, 2015.

Android

• Added support for the "No more today" option on marketing message content units.
• Added API methods to let users opt out of push notifications:
  • boolean Tapjoy.isPushNotificationDisabled()
  • void Tapjoy.setPushNotificationDisabled(boolean)
• Improved device location detection for content units.
• Fixed tracking for clicks on recurring push notifications.

C++ API

• Added API methods to let users opt out of push notifications:
  • bool Tapjoy::isPushNotificationDisabled()
  • void Tapjoy::setPushNotificationDisabled(bool)
• Fixed placement implementation in C++ API.

iOS

• Added support for the "No more today" option on marketing message content units.

Unity

• Added support for the "No more today" option on marketing message content units.
• Added Tapjoy.Connect method to C# API.
  • With this API, users can try connect later, when initial connect was not successful
• Improved placement memory management.
• Fixed issue with placement reuse on iOS.
• Added Tapjoy.ActionComplete method to C# API. This is the API for use with PPA/PPE campaigns.
• (Android) Improved device location detection for content units.
• (Android) Fixed tracking for clicks on recurring push notifications.
• (iOS) Fixed issue with iOS post-build script which caused compatibility issues with other 3rd-party library post-build scripts.

AIR

• Added support for the "No more today" option on marketing message content units.
• (Android) Improved device location detection for content units.
• (Android) Fixed tracking for clicks on recurring push notifications.
• (iOS) Fixed duplicate iOS bundle in plugin issue.

SDK 11.0.3:

• Released April 2, 2015.

Android

• Reduced the DEX method count of library by half.
• Fixed the TJPlacementListener.onContentDismiss callback invocation.
• Fixed video receiver not registered crash on rare devices
• Fixed user properties in requests for placement content.

iOS

• Fix issue where MM content could be shown more than once
• Fix initWithObjects:forKeys:count crash

Unity

• Supports Unity 5.
• Incorporates iOS and Android 11.0.3 fixes.

Air

• Incorporates iOS and Android 11.0.3 fixes.

SDK 11.0.2:

• Released March 2, 2015.
• Fixed an issue in iOS push that might prevent a user who had only opened the app a single time from receiving a push notification.

SDK 11.0.1:

• Released March 2, 2015.
• Adds powerful analytics to Tapjoy’s marketing and messaging capabilities
• If you are an existing Tapjoy SDK user updating to SDK 11, please see the appropriate Migration Guide (iOS, Android, Unity, AIR)  as a number of important calls have been re-worked and the old "events" concept has been replaced by a "placements" concept.

Legacy Documentation

• If you are looking for documentation for older versions of the Tapjoy SDK, please see the legacy Tapjoy Documentation.
• For the old 5rocks product, see the 5rocks documentation.