AmpMediaAnalyticsManager
public class AmpMediaAnalyticsManager: NSObject, PlayerEventObserver
Class in charge of managing the integration between the AMP SDK and the Media Analytics SDK
-
The AmpPlayer associated with an AmpMediaAnalyticsManager
Declaration
Swift
public weak var ampPlayer: AmpPlayer?
-
The url used for retrieving the Media Analytics configuration
Declaration
Swift
public let configUrl: String?
-
Constructor
Declaration
Swift
public init(ampPlayer: AmpPlayer, configurationUrl: String, dimensions: [String:String] = [:], viewerId: String = "AMP IOS")
Parameters
ampPlayer
The AmpPlayer associated with an AmpMediaAnalyticsManager.
configurationUrl
The url used for retrieving the Media Analytics configuration.
dimensions
The custom dimensions that should be sent to Media Analytics. Default: Empty dictionary.
Return Value
A configured instance of an AmpMediaAnalyticsManager.
-
Constructor
Declaration
Swift
public init?(ampPlayer: AmpPlayer)
Parameters
ampPlayer
The AmpPlayer associated with an AmpMediaAnalyticsManager.
-
Sets social share data in Media Analytics.
Declaration
Swift
public func addSocialShareData(shareKey: SocialShareKey, value: String)
Parameters
shareKey
The social share type.
value
The social share value.
-
Add a custom dimension.
Declaration
Swift
public func addDimension(key: String, value: String)
Parameters
key
The dimension’s name.
value
The dimension’s value.
-
Enable Media Analytics logs.
Declaration
Swift
public func enableLogging()
-
Disable Media Analytics logs.
Declaration
Swift
public func disableLogging()
-
Stop the module entirely.
Declaration
Swift
public func stop()