Edit

Integrating and initializing the SDK

Rokt partners can use the Android SDK to display overlay or embedded placements, while Rokt brands can use it to record conversions for their campaigns. The Rokt Android SDK is deployed using Maven and Gradle.

Note: The Rokt Android SDK for Android contains ProGuard rules and does not require additional configuration.

All use cases of the SDK follow the same initial steps to integrate and initialize the SDK. At a high level, these steps are:

  1. Set up a workspace and enable the Rokt Gradle repository
  2. Add the Rokt Placement plugin
  3. Add the Rokt Android SDK module
  4. Initialize the Rokt Android SDK

Following these steps, the execute method of the SDK can then be used in various ways to suit the required use case.

Before you begin

This guide assumes that you are familiar with Gradle and know how to install a plugin for Android development.

Setting up the Android SDK

  1. Set up a workspace and enable the Rokt Gradle repository. To set up a repository, follow Gradle's instructions.
  2. Add the Rokt Widget plugin repository URL in the build.gradle file for the project.
 // file => build.gradle (Project: ....)

allprojects {  
    repositories {      
        google()      
        jcenter()      
        maven {              
            url "https://rokt-eng-us-west-2-mobile-sdk-artefacts.s3.amazonaws.com"      
        } 
    }
}
  1. Add the Rokt Android SDK module to build.gradle for the module.
 // file => build.gradle (Module: ...)

dependencies {
    ...
    // Note: 3.4.0 reflects the latest version of the Rokt Android SDK.
    implementation 'com.rokt:roktsdk:3.4.0'
    ...
}
  1. Initialize the Rokt SDK prior to using it in any activity. We recommend calling the init method from the LauncherActivity class.

Note: Contact Rokt to get the Rokt Tag ID associated with your account. To test your integration, you can use the Rokt Tag ID below, but you need to replace it with your unique Rokt Tag ID before launching in production.

Test Integration tag ID: 222

Kotlin

import com.rokt.roktsdk.Rokt
  
public class LauncherActivity: Activity {
    override fun onCreate(savedInstanceState: Bundle?) {   
        ...
        // The following will reveal a demo integration. To view your integration:
        // 1) Replace the integration test tag ID (222) with your unique Rokt Tag ID 
        // 2) Replace Y.Y.Y with the application version
        Rokt.init("222", "Y.Y.Y", this@LauncherActivity)
        ...
    }
}

Java

import com.rokt.roktsdk.Rokt;
  
public class LauncherActivity extends Activity {
    override fun onCreate(savedInstanceState: Bundle?) {   
        ...
        // The following will reveal a demo integration. To view your integration:
        // 1) Replace the integration test tag ID (222) with your unique Rokt Tag ID 
        // 2) Replace Y.Y.Y with the application version
        Rokt.INSTANCE.init("222", "Y.Y.Y", LauncherActivity.this) 
        ...
    } 
}

Next steps

The subsequent steps depend on your use case for integration. Check out these topics for more:

← VersionLaunching an overlay placement →