Android Setup Guide

Include the SDK

The Kotlin SDK for TelemetryDeck is available from Maven Central at the following coordinates:

// `app/build.gradle.kts`
dependencies {
    implementation("com.telemetrydeck:kotlin-sdk:6.0.1")
}

Permission for internet access

Sending events requires access to the internet so the following permission should be added to the app’s AndroidManifest.xml

<uses-permission android:name="android.permission.INTERNET" />

Your TelemetryDeck App ID

A quick way to start is by adding your App ID to the application section of the app’s AndroidManifest.xml:

<application>
    ...

    <meta-data android:name="com.telemetrydeck.appID"
        android:value="XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" />

</application>

And that’s it! Your app is now ready to use TelemetryDeck. Hit the build button to check if everything is working – if not, check out the troubleshooting section below.

Feel free to browse the TelemetryDeck SDK’s source code as well. It’s tiny and you’ll see for yourself how TelemetryDeck is hashing user identifiers before they ever reach the server. Privacy, yay!

Verify your setup

Build and run your app to verify that TelemetryDeck is properly integrated. The SDK automatically tracks user activity when the app starts or returns from the background.

Open the TelemetryDeck Dashboard, navigate to “Explore > Recent Signals” and make sure “Test Mode” is enabled. You should see automatic signals appear after launching your app.

Privacy Policy

You don’t need to update your privacy policy, but we recommend you do it anyway.

Enhancing your analytics (optional)

While basic session tracking provides valuable information, sending custom events lets you answer questions specific to how users engage with your app.

Sending custom events

Navigate to a Kotlin file and add the following code at the top:

import com.telemetrydeck.sdk.TelemetryDeck

Then, in an appropriate function, you can send your first custom event:

TelemetryDeck.signal("pizzaOrderConfirmed")

You can also add a user identifier and parameters to your events:

TelemetryDeck.signal("pizzaOrderConfirmed", myUser.emailAddress, mapOf("pizzaType" to "hawaii"))

For more advanced configuration options, programmatic usage and information about signals, parameters and all other aspects of the SDK, check out the README file.

Troubleshooting

• Could not find method implementation() for arguments on object of type org.gradle.api.internal.artifacts.dsl.dependencies.DefaultDependencyHandler. – Make sure you’re adding the entries to android/app/build.gradle, not android/build.gradle. More Info

SDK requirements

The TelemetryDeck SDK requires Android SDK 21 or later. For a complete list of requirements, see the Requirements section of the README.

What to do next

Now that you’ve integrated TelemetryDeck, learn how to use the analytics platform to gain valuable insights about your users: