AnalyticsSsaiApi

@objc(BPAAnalyticsSsaiApi)
public protocol AnalyticsSsaiApi : Sendable

  • Indicates the start of an ad break. Must be called before adStart otherwise, calls to adStart will be no-op.

    For more information, see CoreCollector.SsaiApi.adBreakStart()

    Declaration

    Swift

    func adBreakStart()

  • Indicates the start of an ad break with the given metadata. Must be called before adStart otherwise, calls to adStart will be no-op.

    For more information, see CoreCollector.SsaiApi.adBreakStart(adBreakMetadata: SsaiAdBreakMetadata)

    Declaration

    Swift

    func adBreakStart(adBreakMetadata: SsaiAdBreakMetadata)

    Parameters

    adBreakMetadata

    The SsaiAdBreakMetadata object providing metadata for the adBreak

  • Indicates the start of an ad. No-op if called outside of ad break. Implicitly closes tracking of an ad and starts tracking of a new ad.

    For more information, see CoreCollector.SsaiApi.adStart()

    Declaration

    Swift

    func adStart()

  • Indicates the start of an ad with the given metadata. No-op if called outside of ad break. Implicitly closes tracking of an ad and starts tracking of a new ad.

    For more information, see CoreCollector.SsaiApi.adStart(adMetadata: SsaiAdMetadata)

    Declaration

    Swift

    func adStart(adMetadata: SsaiAdMetadata)

    Parameters

    adMetadata

    The SsaiAdMetadata object providing metadata for the ad

  • Indicates the end of the ad break and wraps up the ad data collection. No-op if no ad break is currently active. Implicitly closes tracking of the last ad.

    Declaration

    Swift

    func adBreakEnd()

  • Indicates that the end of a certain quartile of the ad was reached. No-op if no ad break is currently active. No-op if called twice for the same ad and quartile

    For more information, see CoreCollector.SsaiApi.adQuartileFinished(adQuartile: SsaiAdQuartile)

    Declaration

    Swift

    func adQuartileFinished(adQuartile: SsaiAdQuartile)

    Parameters

    adQuartile

    The SsaiAdQuartile value indicating the finished quartile

  • Indicates that the end of a certain quartile of the ad was reached. No-op if no ad break is currently active. No-op if called twice for the same ad and quartile

    For more information, see CoreCollector.SsaiApi.adQuartileFinished(adQuartile: adQuartileMetadata: SsaiAdQuartileMetadata)

    Declaration

    Swift

    func adQuartileFinished(adQuartile: SsaiAdQuartile, adQuartileMetadata: SsaiAdQuartileMetadata)

    Parameters

    adQuartile

    The SsaiAdQuartile value indicating the finished quartile
    adQuartileMetadata

    The SsaiAdQuartileMetadata object providing metadata for the finished ad quartile