Merge pull request #117 from bitmovin-engineering/PW-20703_add_config…

…_to_opt_out_of_ad_engagment

Add config option to opt in to ad engagement feature and disable it by default

CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## Develop
 
+### Added
+- Add `ssaiEngagementTrackingEnabled` flag to bitmovin analytics config to enable ad engagement tracking
+
+### Changed
+- Ad engagement is no longer tracked by default
+
 ## v2.9.1
 
 ### Fixed

collectorCore/collectorCore.brs

@@ -341,6 +341,9 @@ function getMetadataFromAnalyticsConfig(config)
   if config.DoesExist("isLive")
     metadata.isLive = config.isLive
   end if
+  if config.DoesExist("ssaiEngagementTrackingEnabled")
+    metadata.ssaiEngagementTrackingEnabled = config.ssaiEngagementTrackingEnabled
+  end if
   return metadata
 end function
 

collectorCore/ssaiService.brs

@@ -82,9 +82,12 @@ sub adStart(adMetadata = invalid)
     }
   end if
 
-  adStartedEngagementSample = getSsaiAdSample()
-  adStartedEngagementSample.append({ started: 1 })
-  sendAnalyticsSampleOnce(adStartedEngagementSample, m.AnalyticsRequestTypes.AD_ENGAGEMENT)
+  adEngagementEnabled = m.analyticsConfig.ssaiEngagementTrackingEnabled
+  if adEngagementEnabled <> invalid and adEngagementEnabled = true
+    adStartedEngagementSample = getSsaiAdSample()
+    adStartedEngagementSample.append({ started: 1 })
+    sendAnalyticsSampleOnce(adStartedEngagementSample, m.AnalyticsRequestTypes.AD_ENGAGEMENT)
+  end if
 end sub
 
 sub adBreakEnd()
@@ -170,7 +173,11 @@ function adQuartileFinished(adQuartile, adQuartileMetadata = invalid)
   adSample.append(quartileFlag)
   adSample.append(failedBeaconFlag)
 
-  sendAnalyticsSampleOnce(adSample, m.AnalyticsRequestTypes.AD_ENGAGEMENT)
+  adEngagementEnabled = m.analyticsConfig.ssaiEngagementTrackingEnabled
+  if adEngagementEnabled <> invalid and adEngagementEnabled = true
+    sendAnalyticsSampleOnce(adSample, m.AnalyticsRequestTypes.AD_ENGAGEMENT)
+  end if
+
   markQuartileAsReported(adQuartile)
 
   return adSample
@@ -195,6 +202,10 @@ sub onError(errorCode, errorMessage)
   adSample.errorCode = errorCode
   adSample.errorMessage = errorMessage
 
-  sendAnalyticsSampleOnce(adSample, m.AnalyticsRequestTypes.AD_ENGAGEMENT)
+  adEngagementEnabled = m.analyticsConfig.ssaiEngagementTrackingEnabled
+  if adEngagementEnabled <> invalid and adEngagementEnabled = true
+    sendAnalyticsSampleOnce(adSample, m.AnalyticsRequestTypes.AD_ENGAGEMENT)
+  end if
+
   m.hasErrorBeenReportedForCurrentAd = true
 end sub