Android SDK+ Integration Guide

Platform

WebiOSAndroidFlutterReact NativeMAUICordova

Language

For Rokt Ecommerce partners. This complete guide is for ecommerce businesses integrating Rokt into transaction experiences they own. It is not an advertiser implementation guide. Advertisers should use the Rokt Ads integration guides.

This page explains how to implement the Rokt Ecommerce Android SDK+. The SDK+ passes user and transaction data to Rokt on configured screens so Rokt can render relevant experiences, such as offers on confirmation screens.

1. Add the Rokt SDK+ to Your Android App#

Rokt SDK+ requires a minimum Android API level of 21+ (Android 5.0 Lollipop).

Update your Gradle file to include the necessary dependencies:

build.gradle.kts dependencies

dependencies {
  implementation("com.mparticle:android-rokt-kit:6.0.0")
  implementation("com.mparticle:android-core:6.0.0")
}

build.gradle dependencies

dependencies {
  implementation "com.mparticle:android-rokt-kit:6.0.0"
  implementation "com.mparticle:android-core:6.0.0"
}

2. Initialize the Rokt SDK+#

Insert the following initialization snippet in the onCreate() method of your Application class. The SDK+ must be initialized before any other SDK+ API calls. Replace your-key and your-secret with the key and secret provided by your Rokt team.

Application.onCreate initialization

import com.mparticle.MParticle
import com.mparticle.MParticleOptions
import com.mparticle.networking.NetworkOptions

class YourApplicationClass : Application() {
  override fun onCreate() {
      super.onCreate()

      // Identify the current user:
      // If you do not have the user's email address, you can pass in a null value
      val identifyRequest = IdentityApiRequest.withEmptyUser()
          // Preferred: pass the customer's raw, unhashed email via .email().
          // If you can only provide a SHA-256-hashed email, remove .email() and use .userIdentity(Other) instead — do not pass both.
          .email("j.smith@example.com")
          .userIdentity(MParticle.IdentityType.Other, "SHA-256 hashed email")  // only if raw email unavailable
          // If you can only provide a SHA-256-hashed mobile number, use 'other2' instead of MobileNumber — do not pass both.
          .userIdentity(MParticle.IdentityType.Other2, "SHA-256 hashed mobile number")  // only if raw mobile unavailable
          // Customer phone number in E.164 format.
          .userIdentity(MParticle.IdentityType.MobileNumber, "+13125551515")
          // Partner's internal customer/account identifier (if the user is logged in).
          .customerId("cust_10482")
          .build()

      // If the user is identified with their email address, set additional user attributes.
      val identifyTask = BaseIdentityTask()
          .addSuccessListener { identityApiResult ->
              val user = identityApiResult.user
              user.setUserAttribute("example attribute key", "example attribute value")
          }

      // Enter your custom subdomain if you are using a first-party domain configuration (optional)
      val networkOptions = NetworkOptions.builder()
          .setCustomBaseURL("https://rkt.example.com")
          .build()

      val options: MParticleOptions = MParticleOptions.builder(this)
          .credentials(
              "your-key",   // The key provided by your Rokt account manager
              "your-secret" // The secret provided by your Rokt account manager
          )
          // Specify the data environment with environment:
          // Set it to Development if you are still testing your integration.
          // Set it to Production if your integration is ready for production data.
          // The default is AutoDetect which attempts to detect the environment automatically.
          .environment(MParticle.Environment.Development)
          .networkOptions(networkOptions)
          .identify(identifyRequest)
          .identifyTask(identifyTask)
          .build()

      MParticle.start(options)
  }
}

When inserting the initialization snippet into your Application class, you will see customizable fields for:

1Entering your Rokt key and secret#

Set your-key and your-secret inside credentials to the key and secret values provided by your Rokt account manager.

2Setting your data environment#

Set environment to MParticle.Environment.Development while testing to route data to the Development environment, and MParticle.Environment.Production to send live customer activity to Production.

3Entering a custom first-party domain#

Follow the instructions in First-Party Domain Configuration, and set customBaseURL on NetworkOptions to your custom subdomain. Routing the Rokt SDK+ through your own domain reduces the risk of ad blockers and browsers from blocking ads or data. Omit networkOptions to send traffic to Rokt's default endpoints.

4Identifying your user and setting attributes#

In identifyRequest, pass the user's raw, un-hashed email via .email(). For hashed emails and other identifiers, see Supported User Identifiers. Once identified, use the identifyTask success listener to set additional user attributes — see User Attributes for the recommended list.

identifyTask success listener

val identifyTask = BaseIdentityTask()
  .addSuccessListener { identityApiResult ->
      val user = identityApiResult.user
      user.setUserAttribute("example attribute key", "example attribute value")
  }

note

Always include identifyRequest in the initialization snippet. If you don't have the user's email at initialization, omit the .email() call — the SDK+ will still initialize, and you can identify the user later via 3. Identify the User. See Error Handling for how to handle the addFailureListener callback — without error handling you may see data consistency issues at scale.

Initializing with fonts

Instead of or in addition to supplying fonts on One Platform, you may use fonts already bundled with your application. This removes the potential for fonts to be downloaded at initialization time, reducing network utilization and the chance of download errors.

Using font assets

Pass a map to the roktOptions builder method that maps font PostScript names to their filepath in the assets directory. Check with your account manager if you are unsure of the PostScript names being used in your layout.

Font assets

import com.mparticle.MParticle
import com.mparticle.MParticleOptions

class YourApplication : Application() {
  override fun onCreate() {
      super.onCreate()
      val options: MParticleOptions = MParticleOptions.builder(this)
          .credentials("your-key", "your-secret")
          .environment(MParticle.Environment.Development)
          .roktOptions(RoktOptions(fontFilePathMap = mapOf("Arial-Bold" to "fonts/arialbold.otf")))
          .build()
      MParticle.start(options)
  }
}

3. Identify the User#

The SDK+ initialization script identifies the current user using the identifiers you provided in the script's identifyRequest object. After SDK initialization, you should keep the user's identity in sync whenever they log in, log out, or otherwise provide an identifier (for example, during checkout) using the appropriate method as described below.

Supported user identifiers

Show supported user identifiers

Field	Type	Description
email	string	Pass the customer's raw, unhashed email address via .email("j.smith@example.com").
mobile	string	Pass the customer's phone number in E.164 format via .userIdentity(MParticle.IdentityType.MobileNumber, "+13125551515").
customerid	string	Pass your internal customer/account identifier via .customerId("cust_10482"). Send on every screen for logged-in users.
other	string	Pass a SHA-256-hashed email via .userIdentity(MParticle.IdentityType.Other, "hashed email"). Only use when the raw email cannot be provided.
other2	string	Pass a SHA-256-hashed mobile number via .userIdentity(MParticle.IdentityType.Other2, "hashed mobile").

To identify the user:

1Create an identifyRequest object#

Create an identifyRequest object to contain the user's identifiers. You should integrate the user's raw, unhashed email address into the email field.

2Create an identityCallback#

To set additional user attributes, create an identityCallback. If the identifyRequest succeeds, then any user attributes you set inside the callback are assigned to the identified user.

3Send the request using the method that matches the user's action#

Pass the identifyRequest (and optional identityCallback) to the method that matches the user's action:

• MParticle.getInstance()?.Identity()?.login: call when the user logs in or creates an account.
• MParticle.getInstance()?.Identity()?.identify: call when you obtain the user's email mid-session without a login transition (for example, a guest enters their email at checkout).
• MParticle.getInstance()?.Identity()?.logout: call when the user logs out.

Calling these methods transitions the SDK's record of the current user's state. The login and logout methods also automatically log a corresponding event to improve Rokt's attribution.

For example, to identify a user named Jane Smith with the email address j.smith@example.com, mobile number +13125551515, and customer ID cust_10482:

Identify Jane Smith

// 1. Create the identifyRequest object
val identifyRequest = IdentityApiRequest.withEmptyUser()
  // Preferred: pass the customer's raw, unhashed email via .email().
  // If you can only provide a SHA-256-hashed email, remove .email() and use .userIdentity(Other) instead — do not pass both.
  .email("j.smith@example.com")
  .userIdentity(MParticle.IdentityType.Other, "SHA-256 hashed email")  // only if raw email unavailable
  // If you can only provide a SHA-256-hashed mobile number, use 'other2' instead of MobileNumber — do not pass both.
  .userIdentity(MParticle.IdentityType.Other2, "SHA-256 hashed mobile number")  // only if raw mobile unavailable
  .userIdentity(MParticle.IdentityType.MobileNumber, "+13125551515")
  .customerId("cust_10482")
  .build()

// 2. Optionally set user attributes once the request succeeds.
val identityCallback = BaseIdentityTask()
  .addSuccessListener { identityApiResult ->
      val user = identityApiResult.user
      user.setUserAttribute("firstname", "Jane")
      user.setUserAttribute("lastname", "Smith")
  }

// 3. Call one of the following methods that best matches the user's action:
MParticle.getInstance()?.Identity()?.login(identifyRequest, identityCallback) // Call when the user logs in or creates an account
MParticle.getInstance()?.Identity()?.identify(identifyRequest, identityCallback) // Call when you obtain the user's email mid-session, but not during a login
MParticle.getInstance()?.Identity()?.logout() // Call when the user logs out

4. Set User Attributes#

Set user attributes progressively as the user navigates your app, not just at checkout. The more attributes you set, the better Rokt can resolve the customer and deliver relevant offers.

Set User Attributes

import com.mparticle.MParticle

// Retrieve the current user. This will only succeed if you have identified the user during SDK+ initialization or by calling the identify method.
val currentUser = MParticle.getInstance()?.Identity()?.currentUser

// Once you have successfully set the current user to `currentUser`, you can set user attributes with:
currentUser?.setUserAttribute("custom-attribute-name", "custom-attribute-value")
// Note: all user attributes (including list attributes and tags) must have distinct names.

// Rokt recommends setting as many of the following user attributes as possible:
currentUser?.setUserAttribute("firstname", "John")
currentUser?.setUserAttribute("lastname", "Doe")
// Phone numbers can be formatted either as '1234567890', or '+1 (234) 567-8901'
currentUser?.setUserAttribute("mobile", "3125551515")
currentUser?.setUserAttribute("age", "33")
currentUser?.setUserAttribute("gender", "M")
currentUser?.setUserAttribute("billingcity", "Brooklyn")
currentUser?.setUserAttribute("billingstate", "NY")
currentUser?.setUserAttribute("billingzipcode", "123456")
currentUser?.setUserAttribute("dob", "yyyymmdd")
currentUser?.setUserAttribute("title", "Mr")
currentUser?.setUserAttribute("language", "en")
currentUser?.setUserAttribute("predictedltv", "136.23")

// You can create a user attribute to contain a list of values
currentUser?.setUserAttributeList("favorite-genres", listOf("documentary", "comedy", "romance", "drama"))

// To remove a user attribute, call removeUserAttribute and pass in the attribute name. All user attributes share the same key space.
currentUser?.removeUserAttribute("attribute-to-remove")

User attributes

Set as many of the following as you can collect:

Show all user attributes

Field	Type	Description
firstname	string	Customer's first name. Used for personalization.
lastname	string	Customer's last name. Used for personalization.
mobile	string	Phone number formatted as 1112345678 or +1 (222) 345-6789. Used for identity resolution and relevance.
birthyear	integer	Customer's birth year (e.g. 1990). Preferred date-of-birth field. Alternates: dob, age. Used for eligibility and relevance.
age	integer	Customer's age. Alternate to dob. Used for eligibility and relevance.
dob	string	Date of birth, yyyymmdd. Alternate to age. Used for eligibility and relevance.
gender	string	Customer's gender. For example, M, F, Male, or Female. Used for relevance.
title	string	Honorific. For example, Mr, Mrs, Ms. Used for personalization.
language	string	ISO 639-1 language code associated with the purchase. Used for relevance.
billingaddress1	string	Street address (e.g. 123 Main St). Used for identity resolution and relevance.
billingaddress2	string	Apartment/unit (e.g. Apt 4B). Used for identity resolution.
billingcity	string	Billing city. Used for relevance.
billingstate	string	Billing state / province / region. Used for relevance and eligibility.
billingzipcode	string	Full ZIP or postcode (US preference is ZIP+4). Used for identity resolution and relevance.
country	string	ISO 3166-1 alpha-2 country code (e.g. US, GB, AU). Used for eligibility and relevance.
newcustomer	boolean	Whether this is a first-time buyer. Used for relevance.
customertype	string	Whether the user is authenticated (guest / logged_in). Used for relevance.
loyaltytier	string	Partner loyalty program tier. Used for relevance and eligibility.
loyaltyid	string	Loyalty program member ID. Used for identity resolution.
predictedltv	decimal	Predicted total lifetime value, typically from a partner ML model. Used for relevance.
subscriptionstatus	string	Subscription state if applicable (active, trial, churned, paused, none). Used for relevance and eligibility.
customersegment	string	Partner internal segmentation (e.g. vip, at_risk, new, reactivated). Used for relevance.
acquisitionchannel	string	How the customer was originally acquired. Used for relevance.

All user attributes (including list attributes) must have distinct names.

5. Log Events#

Track screen views, commerce events, and custom events so Rokt can understand where each customer is in their journey.

Event category

Call MParticle.getInstance()?.logScreen() with the name of the screen (e.g. "homepage", "product_detail_page"). Include any additional custom attributes in the info map.

Log a screen view

MParticle.getInstance()?.logScreen(
  "homepage",
  mapOf("custom-attribute" to "custom-value")
)

6. Show a Placement#

Call selectPlacements on every payment and confirmation screen you want Rokt to render content on. Include one of the following page identifiers to specify the screen type and whether it's for testing or production:

• stg.rokt.conf: A confirmation screen in a staging (or testing) environment.
• prod.rokt.conf: A confirmation screen in a production environment.
• stg.rokt.payments: A payments screen in a staging (or testing) environment.
• prod.rokt.payments: A payments screen in a production environment.

Placement attributes

Pass these attributes in the attributes map of selectPlacements. Always supply the most recent value — attributes passed here override any earlier setUserAttribute calls.

Show all placement attributes

Field	Type	Description
email	string	Customer email (unhashed). Used for identity resolution.
firstname	string	Customer first name. Used for personalization.
lastname	string	Customer last name. Used for personalization.
mobile	string	Customer mobile number in E.164 format. Used for identity resolution.
confirmationref	string	Order / confirmation reference number. Used for relevance and deduplication.
currency	string	Transaction currency (ISO 4217, e.g. USD, GBP, AUD). Used for relevance.
country	string	ISO 3166-1 alpha-2 country code. Used for eligibility and relevance.
language	string	Customer's preferred language (ISO 639-1). Used for relevance.
totalprice	decimal	Total cart value including tax and shipping. Used for relevance.
amount	decimal	Cart subtotal before tax and shipping. Distinct from totalprice. Used for relevance.
cartItems	array	Structured array of cart-line objects. Must be camelCase. Used for relevance.
couponcode	string	Promo code applied to the order, if any. Used for relevance.
newcustomer	boolean	Whether this is a first-time buyer. Used for relevance.
customertype	string	guest or logged_in. Used for relevance.
value	decimal	Customer's cumulative purchase value. Used for relevance.
subscriptionstatus	string	Subscription state if applicable (active, trial, churned, paused, none). Used for relevance and eligibility.
customersegment	string	Partner internal segmentation (e.g. vip, at_risk, new, reactivated). Used for relevance.
paymenttype	string	Payment method selected (credit_card, paypal, apple_pay, etc.). Used for Pay+ eligibility.
paymentServiceProvider	string	Comma-separated list of payment methods accepted on the screen (e.g. applepay,paypal,cardpayment). Values must be lowercase with no spaces. See Payment Service Provider for the full list of accepted values. Used for Pay+ eligibility.
ccbin	string	Credit card BIN (6-8 digits). Used for relevance.
billingaddress1	string	Billing street address. Used for identity resolution and relevance.
billingaddress2	string	Billing apartment / unit. Used for identity resolution.
billingcity	string	Billing city. Used for relevance.
billingstate	string	Billing state or province. Used for relevance.
billingzipcode	string	Billing ZIP / postcode. Used for identity resolution and relevance.
billingname	string	Full cardholder name on the billing address. Used for identity resolution.
shippingmethod	string	Shipping method selected (standard, express, next_day). Used for relevance.
shippingname	string	Full recipient name on the shipping address. Used for relevance.
shippingaddress1	string	Shipping street address. Used for relevance.
shippingcity	string	Shipping city. Used for relevance.
shippingstate	string	Shipping state or province. Used for relevance.
shippingzipcode	string	Shipping ZIP or postcode. Used for relevance.
shippingcountry	string	Shipping country (ISO 3166-1 alpha-2). Used for relevance.
partnerpaymentreference	string	Non-guessable identifier for the customer's vaulted payment method. Used for Shoppable Ads card forwarding.
last4digits	string	Last 4 digits of the card used. Used for identity resolution.
plcc	string	"yes" or "no" — whether the customer has a private-label credit card. Used for Pay+ relevance.
discountamount	decimal	Order-level discount applied. Used for Pay+ relevance.
prescreen	string	"yes" or "no" — whether the customer has pre-qualified for a credit offer. Used for Pay+ relevance.
adsexperience	string	Pass "shoppable" when targeting a Shoppable Ads experience.

Placement position

Overlay placements render on top of your confirmation screen in a Rokt-managed container, requiring no changes to your app's existing layout.

To insert an overlay placement, call selectPlacements once the confirmation screen loads:

Overlay placement

import com.mparticle.MParticle
import com.mparticle.rokt.RoktConfig

val attributes = mapOf(
  // Identity
  "email" to "j.smith@example.com",
  "firstname" to "Jenny",
  "lastname" to "Smith",
  "mobile" to "+13125551515",

  // Transaction
  "confirmationref" to "54321",
  "currency" to "USD",
  "country" to "US",
  "language" to "en",
  "totalprice" to "149.99",
  "couponcode" to "SUMMER20",

  // Customer context
  "newcustomer" to "false",
  "customertype" to "logged_in",
  "value" to "2340.00",
  "subscriptionstatus" to "active",
  "customersegment" to "vip",

  // Payment (include paymenttype and paymentServiceProvider for Pay+)
  "paymenttype" to "credit_card",
  "paymentServiceProvider" to "cardpayment",
  "ccbin" to "411112",

  // Billing address
  "billingaddress1" to "123 Main St",
  "billingcity" to "Brooklyn",
  "billingstate" to "NY",
  "billingzipcode" to "11201",

  // Shipping
  "shippingmethod" to "express",
  "shippingaddress1" to "175 Varick St",
  "shippingcity" to "New York",
  "shippingstate" to "NY",
  "shippingzipcode" to "10014",
  "shippingcountry" to "US"
)

val roktConfig = RoktConfig.Builder().colorMode(RoktConfig.ColorMode.LIGHT).build()

MParticle.getInstance()?.Rokt()?.selectPlacements(
  identifier = "RoktExperience",
  attributes = attributes,
  config = roktConfig
)

Optional functions

Function	Purpose
Rokt.close()	Auto-close overlay placements.

Additional configuration

Pass optional parameters such as RoktConfig to customize the placement UI (e.g. dark/light mode, caching). Font typefaces can also be supplied as a map of PostScript names to Typeface objects.

selectPlacements with RoktConfig and font typefaces

val fontTypefaces: MutableMap<String, WeakReference<android.graphics.Typeface>> = HashMap()
fontTypefaces["Arial-Bold"] = WeakReference(yourTypefaceObject)

val roktConfig = RoktConfig.Builder().colorMode(RoktConfig.ColorMode.LIGHT).build()

MParticle.getInstance()?.Rokt()?.selectPlacements(
  identifier = "RoktExperience",
  attributes = attributes,
  fontTypefaces = fontTypefaces,
  config = roktConfig
)

note

If you want to update the identifier RoktExperience or embedded identifier RoktEmbedded1 with a different value, contact your Rokt account manager to ensure Rokt placements are configured consistently.

Events API

The SDK+ provides placement lifecycle events as a stream through the MParticle.getInstance()?.Rokt()?.events API. Use Kotlin Flow to consume events produced by the SDK+.

Subscribe to Placement Events

import com.mparticle.MParticle

// owner: LifecycleOwner
owner.lifecycleScope.launch {
  owner.lifecycle.repeatOnLifecycle(Lifecycle.State.CREATED) {
      MParticle.getInstance()?.Rokt()?.events("RoktExperience")?.collect { roktEvent ->
          // Handle the event
      }
  }
}

Standard events

Show all standard events

Event	Description	Params
ShowLoadingIndicator	Triggered before the SDK+ calls the Rokt backend.
HideLoadingIndicator	Triggered when the SDK+ receives a success or failure from the Rokt backend.
PlacementInteractive	Triggered when a placement has been rendered and is interactable.	placementId: String
PlacementReady	Triggered when a placement is ready to display but has not rendered content yet.	placementId: String
OfferEngagement	Triggered when the user engages with the offer.	placementId: String
PositiveEngagement	Triggered when the user positively engages with the offer.	placementId: String
FirstPositiveEngagement	Triggered when the user positively engages with the offer for the first time.	placementId: String, fulfillmentAttributes: FulfillmentAttributes
OpenUrl	Triggered when the user presses a URL that is configured to be sent to the partner app.	placementId: String, url: String
PlacementClosed	Triggered when a placement is closed by the user.	placementId: String
PlacementCompleted	Triggered when the offer progression reaches the end and no more offers are available to display. Also triggered when cache is hit but the retrieved placement will not be displayed as it has previously been dismissed.	placementId: String
PlacementFailure	Triggered when a placement could not be displayed due to some failure or when no placements are available to show.	placementId: String (optional)
CartItemInstantPurchase	Triggered when the catalog item purchase is initiated by the user.	placementId: String, cartItemId: String, catalogItemId: String, currency: String, description: String, linkedProductId: String, totalPrice: Double, quantity: Int, unitPrice: Double

Global events

Use Rokt.globalEvents() to subscribe to SDK+-level events that are not tied to a specific placement.

Subscribe to global events

import com.rokt.roktsdk.RoktEvent

// owner: LifecycleOwner
owner.lifecycleScope.launch {
  Rokt.globalEvents().collect { event ->
      if (event is RoktEvent.InitComplete) {
          // SDK+ initialization is complete
      }
  }
}

7. Appendix#

Appendix A: App configuration

Applications can pass configuration settings through RoktConfig so the Android SDK+ uses your app's custom configuration instead of system defaults.

ColorMode object

Value	Description
LIGHT	Application is in Light Mode
DARK	Application is in Dark Mode
SYSTEM	Application defaults to System Color Mode

EdgeToEdgeDisplay

Value	Description
true (default)	Application supports Edge to Edge display mode
false	Application does not support Edge to Edge display mode

RoktConfig with ColorMode and EdgeToEdgeDisplay

import com.mparticle.MParticle
import com.mparticle.rokt.RoktConfig

val roktConfig = RoktConfig.Builder()
    .colorMode(RoktConfig.ColorMode.LIGHT)
    .edgeToEdgeDisplay(true)
    .build()

MParticle.getInstance()?.Rokt()?.selectPlacements(
    identifier = "RoktExperience",
    attributes = attributes,
    config = roktConfig
)

CacheConfig object

Parameter	Description
cacheDurationInSeconds	Optional duration in seconds for which the Rokt SDK+ should cache the experience. Maximum allowed value is 90 minutes; default is 90 minutes if not provided or invalid.
cacheAttributes	Optional attributes to be used as cache key. If null, all attributes sent in selectPlacements will be used as the cache key.

Cache for 1200 seconds

import com.mparticle.rokt.CacheConfig
import com.mparticle.rokt.RoktConfig

// Cache the experience for 1200 seconds, using email and orderNumber as the cache key.
val roktConfig = RoktConfig.Builder()
    .cacheConfig(CacheConfig(
        cacheDurationInSeconds = 1200,
        cacheAttributes = mapOf("email" to "j.smith@example.com", "orderNumber" to "123")
    ))
    .build()

MParticle.getInstance()?.Rokt()?.selectPlacements(
    identifier = "RoktExperience",
    attributes = attributes,
    config = roktConfig
)

Appendix B: Jetpack Compose support with RoktLayout

For screens implemented using Jetpack Compose, the SDK+ provides the RoktLayout composable for a modern, declarative integration of Rokt placements. RoktLayout supports Overlay, BottomSheet, and Embedded placement types without manually invoking selectPlacements.

Jetpack Compose placement with RoktLayout

import com.mparticle.kits.RoktLayout
import com.mparticle.MpRoktEventCallback
import com.mparticle.UnloadReasons

@Composable
fun MainScreen(modifier: Modifier = Modifier) {
    Column(
        modifier = modifier
            .background(Color.LightGray)
            .padding(8.dp),
    ) {
        val attributes = mapOf(
            "email" to "j.smith@example.com",
            "firstname" to "Jenny",
            "lastname" to "Smith",
            "billingzipcode" to "90210",
            "confirmationref" to "54321"
        )
        val callbacks = object : MpRoktEventCallback {
            override fun onLoad() = println("View loaded")
            override fun onUnload(reason: UnloadReasons) = println("View unloaded due to: $reason")
            override fun onShouldShowLoadingIndicator() = println("Show loading indicator")
            override fun onShouldHideLoadingIndicator() = println("Hide loading indicator")
        }
        val roktConfig = RoktConfig.Builder()
            .colorMode(RoktConfig.ColorMode.DARK)
            .cacheConfig(CacheConfig(
                cacheDurationInSeconds = 1200,
                cacheAttributes = mapOf("email" to "j.smith@example.com")
            ))
            .build()

        RoktLayout(
            sdkTriggered = true,
            identifier = "RoktExperience",
            attributes = attributes,
            location = "RoktEmbedded1",
            modifier = Modifier
                .fillMaxWidth()
                .background(Color.Black),
            mpRoktEventCallback = callbacks,
            config = roktConfig
        )
    }
}

Parameters

Parameter	Type	Description
sdkTriggered	Boolean	Controls when the placement should be triggered.
identifier	String	The identifier of the Rokt experience (e.g. "RoktExperience").
location	String?	Optional location name for embedded placements (e.g. "RoktEmbedded1").
attributes	Map<String, String>	Map of attributes to pass to the placement.
modifier	Modifier	Compose Modifier to customize layout, styling, and UI behavior.
mpRoktEventCallback	MpRoktEventCallback	Optional callback to handle placement events (load, unload, loading state).
config	RoktConfig?	Optional configuration for color mode, caching, etc.

Appendix C: Error handling

The IDSync API is intended to be central to your app's state and is designed to be fast and highly-available. Similar to how your app may prevent users from logging in, logging out, or modifying their state without an internet connection — treat these APIs as gating operations to maintain a consistent user state. The SDK+ will not retry API calls automatically, but provides callback APIs so you can do so according to your business logic.

If you do not implement error handling, you may see data consistency issues at scale.

The SDK+ always returns the HTTP status and body of the underlying HTTP response. For client-side issues (device out of coverage, client-side timeout, invalid identity requests), the SDK+ returns IdentityApi.UNKNOWN_ERROR along with an informative error message.

IDSync error handling

MParticle.getInstance()?.Identity()?.identify(identifyRequest)
    ?.addFailureListener { identityHttpResponse ->
        if (identityHttpResponse?.httpCode == IdentityApi.UNKNOWN_ERROR) {
            // Device is likely offline — retry the request
        } else if (identityHttpResponse?.httpCode == IdentityApi.THROTTLE_ERROR) {
            // Throttled (429) — retry with backoff
        }
    }
    ?.addSuccessListener { identityApiResult ->
        // Proceed with the identified user
    }

IDSync error handling

MParticle.getInstance().Identity().identify(identifyRequest)
    .addFailureListener(new TaskFailureListener() {
        @Override
        public void onFailure(IdentityHttpResponse identityHttpResponse) {
            if (identityHttpResponse.getHttpCode() == IdentityApi.UNKNOWN_ERROR) {
                // Device is likely offline — retry the request
            } else if (identityHttpResponse.getHttpCode() == IdentityApi.THROTTLE_ERROR) {
                // Throttled (429) — retry with backoff
            }
        }
    })
    .addSuccessListener(new TaskSuccessListener() {
        @Override
        public void onSuccess(IdentityApiResult identityApiResult) {
            // Proceed with the identified user
        }
    });

Appendix D: Passing session ID from web to native

When a user journey spans both web and native platforms, you can maintain a consistent Rokt session by passing the session ID from the Web SDK+ to the Android SDK+. This is useful for hybrid flows where users complete an action in a WebView (such as a payment page) and return to the native app for confirmation.

Getting the session ID from Web SDK+

After calling selectPlacements, the session ID is available on the selection context:

Retrieve sessionId from the selection context

const selection = await launcher.selectPlacements({
    identifier: "checkout",
    attributes: {
        email: "user@example.com",
        // ... other attributes
    }
});

const sessionId = await selection.context.sessionId;

note

The session ID is a unique GUID assigned to the current user journey. It is useful for debugging and for correlating a user's activity across your web and native surfaces.

Passing to native app via deep link

Pass the session ID to your native app using a deep link:

Deep-link to native app

const deepLink = `myapp://confirmation?sessionId=${encodeURIComponent(sessionId)}`;
window.location.href = deepLink;

Setting the session ID

Extract the session ID from the deep link and pass it to the SDK+ before calling selectPlacements.

Handle deep link and set sessionId

override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)

    intent.data?.getQueryParameter("sessionId")?.let { sessionId ->
        MParticle.getInstance()?.Rokt()?.setSessionId(sessionId)
    }

    // Proceed with your confirmation flow
}

Handle deep link and set sessionId

@Override
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

    Uri data = getIntent().getData();
    if (data != null) {
        String sessionId = data.getQueryParameter("sessionId");
        if (sessionId != null) {
            MParticle.getInstance().Rokt().setSessionId(sessionId);
        }
    }

    // Proceed with your confirmation flow
}

Notes

• Call setSessionId before selectPlacements to ensure the session is used.
• Empty strings are ignored and will not update the session.
• Always URL-encode the session ID when passing as a query parameter.

8. Test Your Integration#

To confirm the SDK+ initializes and events log correctly:

1Enable verbose SDK+ logging#

Enable verbose SDK+ logging before initialization so you can see what's being sent.

Enable verbose SDK+ logging

MParticle.setLogLevel(MParticle.LogLevel.VERBOSE)

2Build and run your app#

Build and run your app with environment = MParticle.Environment.Development.

3Trigger selectPlacements#

Trigger selectPlacements on the screen where the placement should render and confirm the placement loads.

4Verify events#

Verify the events are logged and the identifyRequest call succeeds.

Troubleshooting

If the placement doesn't render or events don't appear, check the Android Logcat for Rokt SDK+ errors. Common issues:

Initialization errors

• Confirm credentials key and secret match the values from your Rokt account manager.
• Confirm MParticle.start(options) runs in Application.onCreate() before any selectPlacements or logEvent call.

Identity errors

If the identifyTask failure listener fires, see Error Handling for the IdentityApi error codes and retry guidance. Without error handling you may see data consistency issues at scale.

Placement not rendering

• Confirm the placement identifier (e.g. RoktExperience) matches what your Rokt account manager configured.
• For embedded placements, confirm the embedded view identifier (e.g. RoktEmbedded1) matches the layout configuration.
• Check that the attributes map contains at least email, firstname, lastname, billingzipcode, and confirmationref.

SSL handshake errors when using a proxy

While testing in your development environment, you might hit SSL handshake errors when an HTTP debugging proxy like Charles or Proxyman is running, or when you're behind a corporate network proxy. This is expected: the SDK+ pins its SSL certificate, and a proxy intercepts HTTPS by presenting its own certificate, which fails the pin.

To let the proxy inspect SDK+ traffic, disable pinning in your development build by adding setPinningDisabledInDevelopment(true) to the NetworkOptions builder in your SDK+ initialization script.

Disable SSL pinning for proxy debugging

val networkOptions = NetworkOptions.builder()
  // Only takes effect in the development environment; production builds stay pinned.
  .setPinningDisabledInDevelopment(true)
  .build()