PlayerAnalyticsApi

@objc(BPAPlayerAnalyticsApi)
public protocol PlayerAnalyticsApi : Sendable

Provides an API to interact with the Analytics Collector of a Player

  • The impressionId of the current playback session

    For more information, seeCollector.impressionId

    Declaration

    Swift

    var impressionId: String? { get }

  • The userId that is sent with each analytics sample.

    Used for session tracking in the Analytics Dashboard The value for this field is either a random uuid or a constant uuid See AnalyticsConfig.randomizeUserId for more information

    For more information, seeCollector.userId

    Declaration

    Swift

    var userId: String { get }

  • The AnalyticsSsaiApi for interactions regarding SSAI tracking.

    For more information, see Collector.SsaiApi

    Declaration

    Swift

    var ssai: AnalyticsSsaiApi { get }

  • Sends CustomData to the analytics backend

    The provided CustomData will be merged with previously set CustomData

    For more information, seeCollector.sendCustomDataEvent(customData:)

    Declaration

    Swift

    func sendCustomDataEvent(customData: CustomData)

    Parameters

    customData

    The CustomData object which will be used for the Event