Setting up the SDK

Before integrating

Check our "known issues" section if you encounter any integration issue.

Adjoe Sdk 2.0.5 fully support Androidx and targetSdkVersion 31. If you still use pre-androidx then please refer to 1.5.1.

Make sure you set targetSdkVersion 31

Before you can integrate and test the SDK, you must request an SDK hash and set up your devices for testing.

Requesting the SDK hash

The SDK hash is a 32 character hexadecimal string (e.g. 1234567890abcdefgh1234567890abcd). It uniquely identifies your app to the adjoe SDK and must therefore be kept secret. You can obtain it by requesting it from your adjoe contact person.

Setting up test devices

IMPORTANT: This step must be executed before the SDK is initialized for the first time on the affected device! Note that you can always add more devices as test devices in the future, but only if you haven't initialized the SDK on the device before.

To easily test your integration of the adjoe SDK on a certain device, you can set it up as a test device. This device will then receive more apps to install and the rewards are reached faster, making it less cumbersome for you to test the integration.

To set up a device as a test device for adjoe, simply send the device's Google Advertising ID to your adjoe contact person and wait for the confirmation. You can obtain the Google Advertising ID (GAID) of your device by going to Settings > Google > Ads > My Ad-ID.

Note: When you reset the GAID, you must again register the device as a test device with the new GAID.

Add the SDK to your app

Add the SDK to your app-level build.gradle. When using the default project structure, this is typically located at frameworks/runtime-src/proj.android-studio/app/build.gradle.

repositories {
    mavenCentral()
    maven {
        url "https://releases.adjoe.io/maven"
    }
    google()
    jcenter()
}

dependencies {
    ...
    implementation 'io.adjoe:adjoe-sdk-android:2.0.5'
    ...
}

Add LUA Bindings

You need to add the bindings for our C++ functions, so that they can be called from LUA. In your AppDelegate.cpp, typically located at frameworks/runtime-src/Classes/AppDelegate.cpp, add the following header:

#include "AdjoeDelegate.h"

Then, add the call to bind the functions to your applicationDidFinishLaunching function.

bool AppDelegate::applicationDidFinishLaunching()
{
    ...
    lua_State* L = engine->getLuaStack()->getLuaState();
    lua_module_register(L);
    adjoe::bind_adjoe_lua_functions(L);
    ...
}

Add Android JNI Bindings

You need to add the bindings for our C++ functions, so that they can be called from Java. In your Android.mk file, typically located at frameworks/runtime-src/proj.android-studio/app/jni/Android.mk, modify LOCAL_SRC_FILES and add the following:

LOCAL_SRC_FILES := \
<Existing Sources>
../../../Classes/AdjoeDelegate.cpp \
adjoe/adjoe_jni.cpp