Setting up the SDK

Before integrating
Check our "known issues" section if you encounter any integration issue.
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 Adjoe's repository to your root build.gradle (project level):
1
allprojects {
2
    repositories {
3
        ...
4
        maven {
5
            url  "https://releases.adjoe.io/maven"
6
        }
7
    }
8
}
Copied!
Add the adjoe dependency to your app's build.gradle (module level):
1
dependencies {
2
    ...
3
    implementation 'io.adjoe:adjoe-sdk-android:1.5.1'
4
}
Copied!
AndroidX
If you want to use your application with the adjoe SDK with the AndroidX features, simply enable AndroidX for your project as described here: Migrating to AndroidX. This will automatically replace the android.support.* imports in your compiled dependencies (also the adjoe SDK) with the corresponding androidx.* import. You don't need a special version of the adjoe SDK for this.

Adjoe SDK

Initialize the SDK

Last modified 3mo ago

Copy link

Contents

Before integrating

Requesting the SDK hash

Setting up test devices

Add the SDK to your app

AndroidX