pillarbox-analytics/ch.srgssr.pillarbox.analytics/SRGAnalytics

SRGAnalytics

SRG Analytics entry point.

This object provides a facade for interacting with both Commanders Act and ComScore analytics services. It allows for sending page views, events, and managing persistent labels for both services.

Before using any functionality, SRGAnalytics must be initialized in your Application's onCreate() method using either the initSRGAnalytics() or the init() method and providing an AnalyticsConfig instance.

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

         val config = AnalyticsConfig(
             vendor = AnalyticsConfig.Vendor.SRG,
             appSiteName = "Your AppSiteName here",
             sourceKey = AnalyticsConfig.SOURCE_KEY_SRG_DEBUG,
             nonLocalizedApplicationName = "Your non-localized AppSiteName here",
         )

         initSRGAnalytics(config)
         // or
         SRGAnalytics.init(this, config)
     }
}

Properties

commandersAct

val commandersAct: CommandersAct

Provides access to the CommandersAct instance.

comScore

val comScore: ComScore

Provides access to the ComScore instance.

Functions

getCommandersActPersistentLabel

fun getCommandersActPersistentLabel(label: String): String?

Retrieves the Commanders Act persistent label associated with the given label.

getComScorePersistentLabel

fun getComScorePersistentLabel(label: String): String?

Retrieves the ComScore persistent label associated with the given label.

init

@Synchronized

@JvmStatic

fun init(application: Application, config: AnalyticsConfig)

Initializes the SRGAnalytics instance.

initSRGAnalytics

fun Application.initSRGAnalytics(config: AnalyticsConfig)

Initializes the SRGAnalytics instance.

putPersistentLabels

fun putPersistentLabels(commandersActLabels: Map<String, String>, comScoreLabels: Map<String, String>)

Puts persistent labels for both Commanders Act and ComScore. These labels will be included in all subsequent tracking events until they are overwritten.

removePersistentLabel

fun removePersistentLabel(label: String)

Removes a persistent label from both Commanders Act and ComScore.

removePersistentLabels

fun removePersistentLabels(labels: List<String>)

Removes the specified persistent labels from both Commanders Act and ComScore.

sendEvent

fun sendEvent(event: CommandersActEvent)

Sends an event to Commanders Act.

sendPageView

fun sendPageView(commandersAct: CommandersActPageView, comScore: ComScorePageView)

Sends a page view event to both Commanders Act and ComScore.

setUserConsent

fun setUserConsent(userConsent: UserConsent)

Sets the user consent for both Commanders Act and ComScore.