TapResearch Unity Integration Guide

The latest SDK v2.1.1 isn't backward comptiable with v2.0.x. Please follow the upgrade section

Getting Started


TapResearch only supports Unity v5.0 and above.

Download the SDK

You can download the latest version of the TapResearch Unity SDK on GitHub.

Integrate TapResearch

Inside the TapResearchSDK directory, you will find Tapresearch.unitypackage. You can import the package by selecting Assets > Import Package > Custom Package… through the Unity menu.

Library Dependencies

The SDK uses External Dependency Manager for Unity to integrate the native library dependencies. If the dependency manager is already installed on your app, you can remove the Dependency Manager files when importing the SDK. For the Android build, make sure the dependencies have been resolved by going to Assets => External Dependency Manager => Android Resolver => Resolve. For iOS, the plugin will add CocoaPods to the project and will import the dependencies in the XCode project.

Initialize TapResearch

Initialize the TapResearchSDK as early as possible so TapResearch can start getting surveys ready for your users. The Configure() method only needs to be called once on app launch. Also, your iOS and Android apps have different API tokens – use preproccessor directives so Unity knows which API token to use when you build your app.

  using TapResearch;

    const String ApiToken = "ios_api_token";
    const String ApiToken = "android_api_token";

  public class MyMainController : MonoBehaviour {
      public void Awake()

Next step will be to send a unique user identifier, please note that without a unique identifier the survey wall won't be available.

  TapResearchSDK.SetUniqueUserIdentifier ("<UNIQUE_USER_IDENTIFIER>");


A placement is the allocated section in your application where you want to provide access to TapResearch's survey wall, like an action button or a list item. To create a placement, navigate to the app settings in the supplier dashboard click settings and add the placement. The placement is encapsulated by the TRPlacement object which contains the placement metadata and the method to display the survey wall.

Initialize a placement

To initialize a placement, it is best practice to call the SDK as late as possible before displaying the placement in the app. For example, you can initialize it in the Start method of the scene where the placement will be visible

  public TRPlacement tapresearchPlacement;

  void Start ()
    TapResearchSDK.OnPlacementReady = this.OnPlacementReady;

  void OnPlacementReady(TRPlacement placement)
    myPlacement = placement;
    if (placement.PlacementCode != TRPlacement.PLACEMENT_CODE_SDK_NOT_READY)
      if (tapresearchPlacement.IsSurveyWallAvailable)
        //Display the placement
      //Placement initialized before the SDK was ready

Notice that the survey wall may or may not be available to a specific user and it's important to check survey availability before displaying the placement.

Please note that if the placement request was fired before that SDK is ready the OnPlacementReady will be called twice. The first time PlacementCode will return TRPlacement.PLACEMENT_CODE_SDK_NOT_READY indicating that the request was fired before the SDK was ready, the second call will return the latest placement from the server.

Display the survey wall

To display the survey wall, call the ShowSurveyWall on your TRPlacement object.


Please Note: A placement can only show the survey wall one time. Once the survey wall is dismissed, you'll have to initialize a new TRPlacement object if you wish to keep the placement visible in the app.

Hot Survey

hasHotSurvey is a placement attribute that indicates a special, high yield survey is available for this user. When this attribute is true, the user should be shown a special call to action to encourage them to take advantage of this opportunity. These special survey opportunities may only be available for a few minutes, so initPlacement should be called whenever the parent view is loaded. If you want to use Hot Survey please contact developers@tapresearch.comdevelopers@tapresearch.com.

Reward notifications

Depending on your preferences the rewards notification will be posted to a url or will trigger an in-game game callback. Please follow the instructions below for server postback or in-game callback implementation

Server to server postback

To opt in for server to server postbacks, navigate to the supplier dashboard. Please visit API docs to learn about postbacks integration.

    const String ApiToken = "ios_api_token";
    const String ApiToken = "android_api_token";

  public class MyMainController : MonoBehaviour {
      public void Awake() {
          TapResearchSDK.Configure (API_TOKEN);
          TapResearchSDK.SetUniqueUserIdentifier ("<UNIQUE_USER_IDENTIFIER>");

In-Game callback

Add a reward listener so we can notify you when a user completes a survey. The quantity value will automatically be converted to your virtual currency based on the exchange rate you specified in your app settings. It is important to note that this method may be called back to back if the player completed multiple surveys in one session.

  public class MyMainController : MonoBehaviour {
      public void Awake() {
          TapResearchSDK.Configure (ApiToken);
          TapResearchSDK.OnReceiveReward = this.OnReceiveReward;

      private void OnReceiveReward(TRReward reward) {
        Debug.Log ("You've earned " + reward.RewardAmount + " " + reward.CurrencyName + ". " + reward.TransactionIdentifier);

Survey callback (Optional)

Assign a delegate if you want to be notified when the survey wall status changed

  public class MyMainController : Application {
      public void Start() {
        TapResearch.OnSurveyWallOpened = this.OnSurveyWallOpened;
        TapResearch.OnSurveyWallDismissed = this.OnSurveyWallDismissed;

      private void OnSurveyWallOpened () {
        // Stop music, timers, etc.

      private void OnSurveyWallDismissed () {
        // Start music, timer, etc.

Customise the survey wall

If you wish to customise the look of the survey wall modal to fit with the rest of your game use the following:

  TapResearchSDK.SetNavigationBarText ("Title");
  TapResearchSDK.SetNavigationBarTextColor ("#00ffff");
  TapResearchSDK.SetNavigationBarColor ("#ff7f50");

Android Debug Console Output

To output debug info to logcat when generating Android build use the following

    TapResearchSDK.SetDebugMode (true);

Upgrade to v2.1

  • In every file that will reference the SDK add using TapResearch. All the SDK classes are under the TapResearch namespace.
  • The SDK API class was changed from TapResearch to TapResearchSDK. e.g. TapResearch.Configure is now TapResearchSDK.Configure
  • Delete the following files from the previous SDK
    • TapResearch.cs
    • Assets/Plugins/Android/tapresearch.aar
    • Assets/Plugins/Android/unitybridge.aar
    • Assets/Plugins/Android/play-services-ads-lite-10.2.6
    • Assets/Plugins/Android/play-services-basement-10.2.6
    • Assets/Plugins/iOS/TapResearchSDK.framework
  • Check the library dependency manager section for more info about library dependencies.

Upgrade to v2.0

The following methods and callbacks were removed from the SDK

  TapResearch.ShowSurvey(String identifier)


Upgrade from version v1.1.2

In Assets > Plugins > Android please delete the following:

  • apresearch.jar
  • unitybridge.jar
  • google-play-services_lib
  • Remove <activity android:name="com.tapr.internal.c.TRSurveyActivity"... from AndroidManifest.xml

Test Devices

Before you are ready to go live, it is important that your reward callback is working properly. Navigate to your dashboard and click the Add Devices button. Add a device name and your Google Advertising ID. Now, when you enter our survey flow through your app, you will be able to complete a test survey and receive a test reward when you re-open your app.


Survey wall isn't available

If placement.IsSurveyWallAvailable is false please reference the android or ios integration guides for further steps


Please send all questions, concerns, or bug reports to developers@tapresearch.com