Quickstart

1. Dashboard Integration Guide

The Tapjoy Dashboard has a built-in Integration Guide that will walk you through the steps of a Tapjoy integration. You can use this Getting Started Guide document as a reference if you prefer or you can go directly to the Integration Guide for your most recent app.

2. SDK Integration

A. Cocoapods (recommended)

CocoaPods is a dependency manager for Objective-C and Swift. We highly recommend using CocoaPods to keep the Tapjoy SDK up-to-date.

To use Tapjoy simply add it to your podfile:

    platform :ios, '9.0'
    source 'https://github.com/CocoaPods/Specs.git'

    use_frameworks!

    target 'MyApp' do
        pod 'TapjoySDK'
    end

B. Swift

To use Tapjoy in Swift you need to create a bridging header.

  1. Create a new header file and name it: "[ProjectName]-Bridging-Header.h"
  2. Add #import "Tapjoy/Tapjoy.h to the bridginer header.
  3. Finally go to your targets build settings, search for "bridging header" and set the file path. You can do this easily by dragging and dropping the file from your project navigation hierarchy into the text field.

3. Connect to Tapjoy

The next step is to add the Tapjoy connect code to your application. This key bit of code "turns on" the Tapjoy SDK in your application.

The Tapjoy connect call is extremely important, as none of Tapjoy’s products or functionality will work if it is not implemented correctly.

To implement the Tapjoy connect call, you will need your Tapjoy SDK Key for the application you are integrating. To find this, navigate to your application in the Tapjoy dashboard, and click the "Settings" button on the top navigation bar. Navigate to "App Settings" and you will find the SDK Key at the bottom of the page.

Now, place the following snippet of code into the application:didFinishLaunchingWithOptions method in your application’s app delegate file:

Objective-C
Swift
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
    [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(tjcConnectSuccess:) name:TJC_CONNECT_SUCCESS object:nil];
    [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(tjcConnectFail:) name:TJC_CONNECT_FAILED object:nil];

    //Turn on Tapjoy debug mode
    [Tapjoy setDebugEnabled:YES]; //Only enable debug mode for development. Disable it before publishing your app.

    //If you are using Self-Managed currency, you would set your own user ID here.
    [Tapjoy setUserID:@"A_UNIQUE_USER_ID"];
    
    //The Tapjoy connect call
    [Tapjoy connect:@"SDK_KEY_GOES_HERE"];

    return YES;
}

The method’s setDebugEnabled and setUserID should be defined before the connect call. Setting a user ID prior to connect allows for the AppLaunch placement to retrieve the correct user ID when called, and is also required for Push2Earn placements.

More information can be found in our SDK references: Objective C and C++.

Connect Notifications

To receive a notification when Tapjoy has finished connecting (or failed to connect) you need to implement the methods we previously set as selectors:

Objective-C
Swift
- (void)tjcConnectSuccess:(NSNotification *)notifyObj 
{
    NSLog(@"Tapjoy connect succeeded");
}

- (void)tjcConnectFail:(NSNotification *)notifyObj 
{
    NSLog(@"Tapjoy connect failed");
}

Now compile and run your application. If you have done everything correctly, you should see output on the console log similar to the following:

        2020-01-29 16:01:55.422 App Name[25869:1433019] [TJLog level: 4] Connect success with type:0

In the Tapjoy Dashboard, if you click on "Analytics" in the top navigation bar and then the "Real-time" tab in the navigation bar on the left, you should see some activity from your application moments after you run it.

Congratulations! You now have Tapjoy working in your application.