Get Started

Current version: v3.0.0. View Changelog and Migration Guide.

Follow this guide to configure your app to work with the Playtime SDK using any of our supported wrappers.

Step 1. Get Your SDK Hash

Contact your Account Manager to get an SDK hash for your app. Or if you already have access, it can be retrieved from the Publisher Dashboard.

The SDK hash is a unique 32-character code that uniquely identifies your app within adjoe's systems. Each app receives a distinct hash. Remember to keep your hash confidential to prevent unauthorized use.

Step 2. Add Test Devices

Important: Execute this step before the Playtime SDK is accessed on the device for the first time! You can always add more test devices, but only if the SDK hasn't been accessed on them yet.

To fully test the Playtime SDK integration and access all campaign types, configure your physical devices and emulators as test devices. Without this step, the types of available campaigns you get will be limited when using VPNs or emulators.

1. Find Your GAID (Google Advertising ID):

• Open the Settings app or Google settings (depends on your device).

• Go to "Google" > "Ads" in the Services section.

• Your GAID is displayed at the bottom.

1. Register as a Test User:

• With your GAID, go to the Publisher Dashboard. If you don't have dashboard access, contact your Account Manager.

• In the dashboard, find "Test Users" under configuration settings and enter your GAID.

Please note: If you reset your device's GAID, remember to update the test device information in the dashboard with the new GAID before accessing the Playtime SDK again.

Step 3. Add the Playtime SDK Dependency

Kotlin

1. Add adjoe's repository to your root build.gradle (project level):

allprojects {
    repositories {
        ...
        maven {
            url  "https://releases.adjoe.io/maven"
        }
    }
}

1. Add the adjoe dependency to your app's build.gradle (module level):

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

---

If you use Kotlin DSL for adding dependencies, add the repo in the settings.gradle.kts

repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        google()
        mavenCentral()
        maven { url = uri("https://releases.adjoe.io/maven") }
    }
}

Java

1. Add adjoe's repository to the settings.gradle file:

repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        google()
        mavenCentral()
        maven { url = uri("https://releases.adjoe.io/maven") 
        }
    }
}

2. Add the adjoe dependency to your app's build.gradle (module level):

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

React Native

https://github.com/adjoeio/adjoe-react-native-sdk

1. Open your project's package.json file.

2. Add the adjoe as a dependency under the dependencies section. You can change the version number to the desired version of Playtime SDK.

dependencies: {
  "react-native-adjoe-sdk": "https://github.com/adjoeio/adjoe-react-native-sdk#v3.0.0"
}

1. Open your build.gradle file in the android folder and add the following section:

allprojects {
    repositories {
        maven {
            url  "https://releases.adjoe.io/maven"
        }
    }
}

1. Run the command:

npm install

Flutter

https://github.com/adjoeio/adjoe-flutter-sdk

To integrate the adjoe Flutter SDK into your Flutter project, follow these steps:

1. Open your project's pubspec.yaml file.

2. Add the Playtime SDK as a dependency under the dependencies section. You can change the version number to the desired version of Playtime SDK.

dependencies:
  adjoe:
    git:
      url: https://github.com/adjoeio/adjoe-flutter-sdk
      ref: v3.0.0

1. Save the pubspec.yaml

2. In your IDE run either of the the following two commands:

   1. pub get

   2. flutter pub get

Unity

Adjoe 3.0.0 uses the Play Services Resolver, you can download a version of the Playtime SDK which is compatible wit the Play Services Resolver here. It contains only the source code and the AdjoeDependencies.xml file specifying the Playtime SDK: https://pre-releases.adjoe.io/files/playtime/unity/3.0.0/adjoe_sdk_android_unity_3.0.0_psr.unitypackage

1. Add the adjoe SDK to your app by clicking:

Assets > Import package > Custom package....

1. Select adjoe's .unitypackage, click Open and the select Import. This will load the adjoe SDK into Assets/Adjoe.

Cordova

https://github.com/adjoeio/adjoe-cordova-sdk

1. Open your project's package.json file.

2. Add the Playtime SDK as a dependency under the dependencies section. You can change the version number to the desired version of Playtime SDK.

dependencies: {
  "cordova-plugin-adjoe": "https://github.com/adjoeio/adjoe-cordova-sdk#v3.0.0"
}

1. Save the package.json and run the following command:

npm install

You have an option to integrate the dependencies via Groovy or Kotlin. To understand the differences of integrating dependencies via these platforms, refer to the official Android docs.

Step 4: Enable Logs (Native only)

Enabling logging per device within the SDK is crucial for troubleshooting. Turn on logging and include the logs with any bug reports to help us accurately replicate and address issues.

Here’s how to enable logging:

1. Connect the device to your computer and enable ADB.

2. In a terminal window, run the following command to activate logging:

adb shell setprop log.tag.Playtime INFO

You can now filter LogCat using the Playtime tag to monitor relevant log output. If you wish to disable logging, simply execute the command:

adb shell setprop log.tag.Playtime ERROR

This sets the logging level to ERROR, effectively reducing the verbosity of the logs.