University
Webinars
Community
Help Center
Technical Docs
Contentsquare Platform

From Contentsquare SDK to CSQ SDK

View as Markdown ↗ View this page as plain text Open in ChatGPT ↗ Ask questions about this page
This guide provides a step-by-step upgrade process from your current installation of Contentsquare Mobile SDK to the latest version of the CSQ SDK.
Contentsquare SDK

Contentsquare SDK

→
CSQ SDK

CSQ SDK

The latest version of our SDK provides a unified set of APIs for Product Analytics, Experience Analytics, and Experience Monitoring, eliminating redundant APIs that perform the same actions.

Upgrading to the latest version ensures you benefit from all our newest features and product enhancements.

Dependency upgrades

Section titled Dependency upgrades

Upgrade your dependency based on your current SDK.

CSQ SDK

Upgrade to the latest CSQ SDK version:

build.gradle.kts
implementation("com.contentsquare.android:sdk:0.7.1")
implementation("com.contentsquare.android:sdk-compose:0.7.1")
implementation("com.contentsquare.android:sdk:1.0.1")
implementation("com.contentsquare.android:sdk-compose:1.0.1")

Contentsquare SDK

Replace Contentsquare SDK dependencies with the CSQ SDK:

build.gradle.kts
implementation("com.contentsquare.android:library:4.39.1")
implementation("com.contentsquare.android:compose:4.39.1")
implementation("com.contentsquare.android:sdk:1.0.1")
implementation("com.contentsquare.android:sdk-compose:1.0.1")

Library imports

Section titled Library imports

Replace the Contentsquare SDK import with a CSQ SDK import.

import com.contentsquare.android.Contentsquare
import com.contentsquare.CSQ

SDK start

Section titled SDK start

Start the CSQ SDK manually using CSQ.start() — unlike earlier versions, it no longer starts automatically.

MyApplication.kt
import android.app.Application
import com.contentsquare.CSQ


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


    CSQ.start(this)
  }
}
Section titled Get user consent

The CSQ SDK treats users as opted-out by default.

CSQ.start(context)
// ...
val optinButton: Button = ...
optinButton.setOnClickListener {
    CSQ.optIn(it.context)
    // Then finish initialization and move to the next screen...
}

Implement the optIn() API to forward user consent to the SDK and generate a user ID.

Transactions

Section titled Transactions

  1. Update your transaction imports:

    import com.contentsquare.android.api.model.Transaction
    import com.contentsquare.api.model.Transaction

  2. Update your currency imports:

    import com.contentsquare.android.api.Currencies
    import com.contentsquare.api.model.Currency

  3. Replace the currency type from Int to Currency enum:

    val currency: Int = Currencies.USD
    val currency: Currency = Currency.USD

  4. Replace Transaction.builder by Transaction and Contentsquare.send() by CSQ.trackTransaction():

    val builder = Transaction.builder(100f, Currency.EUR).id("optionalId")
    Contentsquare.send(builder.build())
    val transaction = Transaction(100f, Currency.EUR, "optionalId")
    CSQ.trackTransaction(transaction)

Update APIs

Section titled Update APIs

Search and replace all legacy SDK API calls in your app to the latest CSQ APIs using the following mappings. Updating your API calls ensures continued functionality without disruption.

In most cases, this process consists in updating the namespace and method names, with no changes to parameters.

Contentsquare.start(this)
CSQ.start(this)

For more information on SDK methods, see the SDK API reference.

GDPR / Identification

Contentsquare SDKCSQ SDK
Contentsquare.optIn(context: Context)CSQ.optIn(context: Context)
Contentsquare.optOut(context: Context)CSQ.optOut()
Contentsquare.getUserId()CSQ.metadata.userId
Contentsquare.getProjectId()CSQ.metadata.projectId
Contentsquare.getSessionNumber()CSQ.metadata.sessionId
Contentsquare.sendUserIdentifier(identifier: String)CSQ.sendUserIdentifier(identifier: String)

Property tracking

Contentsquare SDKCSQ SDK
Contentsquare.send(key: String, value: Long)CSQ.addDynamicVar(key: String, value: Long)
Contentsquare.send(key: String, value: String)CSQ.addDynamicVar(key: String, value: String)

View tracking

Contentsquare SDKCSQ SDK
Contentsquare.excludeFromExposureMetric(view: View)CSQ.excludeFromExposureMetric(view: View)

Interoperability

Contentsquare SDKCSQ SDK
Contentsquare.onSessionReplayLinkChange(callback: Consumer<String>)CSQ.metadata.onChanged(metadata: Metadata)
CsWebViewManager.injectEventTrackingInterface(webView: WebView)CSQ.registerWebView(webView: WebView)
CsWebViewManager.removeEventTrackingInterface(webView: WebView)CSQ.unregisterWebView(webView: WebView)

Event tracking

Contentsquare SDKCSQ SDK
Contentsquare.send(transaction: Transaction)CSQ.trackTransaction(transaction: Transaction)
Contentsquare.send(screenName: String) / Contentsquare.send(screenName: String, customVars: Array<CustomVar>)CSQ.trackScreenview(name: String, customVars: List<CustomVar>)
Contentsquare.consumeEvent(motionEvent: MotionEvent)CSQ.trackMotionEvent(motionEvent: MotionEvent)
Jetpack compose
Contentsquare SDKCSQ SDK
import com.contentsquare.android.compose.analytics.TriggeredOnResume

TriggeredOnResume(block: () -> Unit)		import com.contentsquare.api.compose.screen.TriggeredOnResume

TriggeredOnResume(block: () -> Unit)

Error tracking

Contentsquare SDKCSQ SDK
ErrorAnalysis.setUrlMaskingPatterns(patterns: List<String>)CSQ.setUrlMaskingPatterns(patterns: List<String>)
import com.contentsquare.android.error.analysis.ErrorAnalysisimport com.contentsquare.api.model.NetworkMetric
ErrorAnalysis.getInstance().newNetworkMetric(url: String, httpMethod: HttpMethod)NetworkMetric(url: String, httpMethod: HttpMethod)
networkMetric.stop()CSQ.trackNetworkMetric(NetworkMetric)

Personal Data Handling and Masking

Contentsquare SDKCSQ SDK
Contentsquare.doNotTrack(vararg activitiesClasses: Class<Activity?>)CSQ.ignoreInteractions(view: View)
Contentsquare.setDefaultMasking(masked: Boolean)CSQ.setDefaultMasking(masked: Boolean)
Contentsquare.mask(view: View)CSQ.mask(view: View)
Contentsquare.mask(type: Class<*>)CSQ.mask(type: Class<*>)
Contentsquare.unMask(view: View)CSQ.unmask(view: View)
Contentsquare.unmask(type: Class<*>)CSQ.unmask(type: Class<*>)

Jetpack compose

Contentsquare SDKCSQ SDK
Modifier.sessionReplayMask(enableMasking: Boolean)@Composable
CsqMask(enable: Boolean) { }
Modifier.excludeFromGestureRecognition()@Composable
CsqIgnoreInteraction(ignore: Boolean)

SDK initialization and manipulation

Contentsquare SDKCSQ SDK
Contentsquare.start(context: Context)CSQ.start(context: Context)
Contentsquare.stopTracking()CSQ.pauseTracking()
Contentsquare.resumeTracking()CSQ.resumeTracking()

Checklist

Section titled Checklist

Congratulations! You’re all set. Use this checklist to ensure everything is correctly updated.

Ensure that your build files no longer reference com.contentsquare.android, com.contentsquare.android:library, or com.contentsquare.android:sdk-compose.

Your import com.contentsquare.android.Contentsquare declarations have been updated to import com.contentsquare.CSQ.

You no longer have references to Contentsquare. methods in your codebase.

All calls to the CSQ SDK use the CSQ.namespace.