pillarbox-analytics/ch.srgssr.pillarbox.analytics/AnalyticsConfig

AnalyticsConfig

data class AnalyticsConfig(val vendor: AnalyticsConfig.Vendor, val appSiteName: String, val sourceKey: String, val nonLocalizedApplicationName: String? = null, val userConsent: UserConsent = UserConsent(), val comScorePersistentLabels: Map<String, String>? = null, val commandersActPersistentLabels: Map<String, String>? = null)

Represents the configuration for analytics tracking for SRG SSR applications. This should be used in conjunction with SRGAnalytics.initSRGAnalytics or SRGAnalytics.init.

This class holds the necessary information for configuring analytics tracking, including the vendor, application details, user consent, and persistent labels.

Constructors

Link copied to clipboard
constructor(vendor: AnalyticsConfig.Vendor, appSiteName: String, sourceKey: String, nonLocalizedApplicationName: String? = null, userConsent: UserConsent = UserConsent(), comScorePersistentLabels: Map<String, String>? = null, commandersActPersistentLabels: Map<String, String>? = null)

Types

Link copied to clipboard
object Companion
Link copied to clipboard
enum Vendor : Enum<AnalyticsConfig.Vendor>

Represents the different vendors supported by the application.

Properties

Link copied to clipboard
val appSiteName: String

The name of the app/site being tracked, given by the analytics team.

Link copied to clipboard
val commandersActPersistentLabels: Map<String, String>?

The initial persistent labels for Commanders Act analytics.

Link copied to clipboard
val comScorePersistentLabels: Map<String, String>?

The initial persistent labels for ComScore analytics.

Link copied to clipboard
val nonLocalizedApplicationName: String?

The non-localized name of the application. By default, the application name defined in the manifest is used.

Link copied to clipboard
val sourceKey: String

The CommandersAct source key. Production apps should use SOURCE_KEY_SRG_PROD, and apps in development should use SOURCE_KEY_SRG_DEBUG.

Link copied to clipboard
val userConsent: UserConsent

The user consent to transmit to ComScore and CommandersAct.

Link copied to clipboard
val vendor: AnalyticsConfig.Vendor

The vendor to which the application belongs to.