Native Android SDK instrumentation

Implementation Guides Platform
,
1

Installation

To configure your project, follow these steps:

Add the following repository to your settings.gradle file. Read more about declaring repositories:

maven {
    url "https://repositories.mrf.io/nexus/repository/mvn-marfeel-public/"
}

Depending on your application’s use, include one of the following dependencies in your build.gradle within the dependencies section:

  1. If you are using Jetpack Compose
dependencies {
  implementation ‘com.marfeel.compass:compose:1.9.0’
}
  1. If you are using XML views:
dependencies {
  implementation ‘com.marfeel.compass:views:1.9.0’
}

Setup

To begin tracking pages, initialize the SDK using its initialize method and provide your unique Marfeel Account Id as follows:

CompassTracking.initialize(context: Context, /* AccountId */)
We also offer a sample playground application to demonstrate how our SDKs can be used. You can access the GitHub repositories here: Android App

Page Technology

The default value for the Page Technology dimension is set to Android App , represented by the value 4 . However, you can modify this default value using the initialize method, which allows you to specify a different page technology as a parameter.

CompassTracking.initialize(context: Context, accountId: String, pageTechnology: Int)
Custom Page Technologies have IDs above 100 and must be declared at the Organization Settings

Usage

All tracking features are made available through a CompassTracking instance:

val tracker = CompassTracking.getInstance()

Page Tracking

CompassTracker automatically monitors user time on a page. When a user begins reading a new page, you should provide the page’s canonical URL.

tracker.trackNewPage(url: String)

CompassTracker will continue tracking reading time until the trackNewPage method is called again with a different URL or until the developer explicitly invokes the stopTracking() method.

tracker.stopTracking()
tracker.startTracking() has been deprecated in favor of tracker.trackNewPage()

If you want to track a screen instead of a new page, particularly when your view doesn’t have a real URI, you can utilize the trackScreen method. This method accepts a raw name instead of an actual URI for tracking purposes.

tracker.trackScreen(screen: String)

Scroll Tracking

To track scroll depth, you can provide a view that implements the ScrollingView interface, such as NestedScrollView, ScrollView, or RecyclerView, to both the trackNewPage and trackScreen methods.

tracker.trackNewPage(url: String, scrollView: ScrollingView)
tracker.trackNewPage(url: String, scrollView: ScrollView)
tracker.trackNewPage(url: String, scrollView: RecyclerView)

tracker.trackScreen(screen: String, scrollView: ScrollingView)
tracker.trackScreen(screen: String, scrollView: ScrollView)
tracker.trackScreen(screen: String, scrollView: RecyclerView)

When working with Jetpack Compose, you should use either trackNewPage(url: String) or trackNewScreen(screen: String) along with the composable function:

CompassScrollTrackerEffect(scrollState: ScrollState)

User Identification

To track a userId instead of the default Marfeel one you can use the method setSiteUserId.
​

setSiteUserId(userId: String)
tracker.setUserId() has been deprecated in favor of tracker.setSiteUserId()

On the other hand, if you need to retrieve marfeel user id for forwarding it to one of our apis, the method you need to use is getUserId()

getUserId(): String

User Journey

You can specify the type of user with the options below. By default, if not specified, the user will be tracked as Anonymous.

  • ANONYMOUS: for anonymous users
  • LOGGED: for registered users
  • PAID: for subscribers
  • CUSTOM. For custom types you should provide a numeric identifier defined in the Marfeel User Journey UI
// kotlin syntax
tracker.setUserType(UserType.Anonymous)
tracker.setUserType(UserType.Logged)
tracker.setUserType(UserType.Paid)
tracker.setUserType(UserType.Custom(9))

// java syntax
tracker.setUserType(UserType.Anonymous.INSTANCE)
tracker.setUserType(UserType.Logged.INSTANCE)
tracker.setUserType(UserType.Paid.INSTANCE)
tracker.setUserType(new UserType.Custom(9))
TIP:
It's recommended to first provide the user ID and the user journey information before initiating the tracking of the first pageview.

User RFV

If you want to access the RFV of the user within a session, you can retrieve it using the getRFV method.
​

tracker.getRFV { rfv ->
    // callback
}

There’s also a synchronous version of this function available. It should be called from a separate thread.
​

Conversions tracking

You can track conversions calling the trackConversion(conversion: String) method:

tracker.trackConversion("subscription")

Consent tracking

In order to mark if the current visit has consent approved or not, sdk offers the following method to use:

tracker.setConsent(true)

User Custom Dimensions

Page vars

tracker.setPageVar("name", "value")

Session vars

tracker.setSessionVar("name", "value")

User vars

tracker.setUserVar("name", "value")

User segments

Adds a new persistent user segment

tracker.addUserSegment("segment")

Replaces existing user segments

tracker.setUserSegments(listOf("segment1", "segment2"))

Removes existing user segment

tracker.removeUserSegment("segment")

Clears all user segments

tracker.clearUserSegments()

Multimedia tracking

All multimedia tracking features are made available through a MultimediaTracking instance:

val multimediaTracker = MultimediaTracking.getInstance()

Exposed interfaces

interface MultimediaTracking {
    /**
     * Registers multimedia item for tracking
     * @param id The item identifier
     * @param provider The multimedia provider
     * @param providerId The multimedia provider identifier
     * @param type The multimedia type
     * @param metadata The multimedia metadata
     */
    fun initializeItem(id: String, provider: String, providerId: String, type: Type, metadata: MultimediaMetadata)

    /**
     * Tracks an event for the item matching the provided id.
     * @param id The item identifier
     * @param event The event to track
     * @param eventTime The time when the event has occurred
     */
    fun registerEvent(id: String, event: Event, eventTime: Int)

    companion object {
        /**
         *
         * @return The singleton instance of the MultimediaTracking interface
         */
        fun getInstance(): MultimediaTracking = MultimediaTracker
    }
}

enum class Type(val id: String) {
    AUDIO("audio"),
    VIDEO("video")
}

enum class Event(val id: String) {
    PLAY("play"),
    PAUSE("pause"),
    END("end"),
    UPDATE_CURRENT_TIME("updateCurrentTime"),
    AD_PLAY("adPlay"),
    MUTE("mute"),
    UNMUTE("unmute"),
    FULL_SCREEN("fullscreen"),
    BACK_SCREEN("backscreen"),
    ENTER_VIEWPORT("enterViewport"),
    LEAVE_VIEWPORT("leaveViewport")
}

data class MultimediaMetadata(
    val isLive: Boolean? = false,
    val title: String? = null,
    val description: String? = null,
    val url: String? = null,
    val thumbnail: String? = null,
    val authors: String? = null,
    val publishTime: Long? = null,
    val duration: Int? = null
)

To initialize a new media

multimediaTracker.initializeItem(
    "videoId", // mandatory
    "youtube", // mandatory
    "abcaXala", // mandatory
    Type.VIDEO, // mandatory
    MultimediaMetadata(
        false,
        "video-title",
        "video-description",
        "http://url/to/video",
        "http://url/to/thumbnail",
        "John, Doe",
        1683196435676, // timestamp
        125 // time en seconds
     )
)

To track a new event

multimediaTracker.registerEvent("videoId", Event.PAUSE, 25)