The iOS / tvOS Collector by Datazoom is an easy to install SDK for your iOS / tvOS Collector applications that makes the following data points automatically collectable in real time. The collector can also be configured to make the data points from the media player extensions listed below automatically collectable.

Integration Instructions

Installation

The preferred way of installing Collector is via the Swift Package Manager.

Swift Package Manager
Add Swift Package Dependency - navigate to File → Add PackagesPaste the repository URL: https://gitlab.com/datazoom/apple/libraries-release/apple_datazoom_base

For Rules, select Branch (with branch set to main) and click Add Package.
On the confirmation dialog click Add Package, again.

Cocoapods

Add the 'DzBase' pod in the podfile

source 'https://gitlab.com/datazoom/pod-specs.git'
pod 'DzBase'

Initialization

 let configBuilder = Config.Builder(configurationId: configId)
 configBuilder.logLevel(logLevel: .verbose)
 configBuilder.isProduction(isProduction: isProduction)
 
 Datazoom.shared.doInit(config: configBuilder.build())

Always set isProduction = true unless directed by Datazoom

Custom Metadata

API looks like
/**
 * Sends metadata
 *
 * - Parameters:
    - metadata: a Dictionary that will be attached to each event being sent from SDK, for more information on this topic, please visit our
 *  documentation.
 */
func setMetadata(metadata: <String, Any>)

Example

Datazoom.shared.setMetadata(
  [
    "property": "custom property",
    "property2": "custom property2",
  ]
)

Media Player Extensions

If your iOS / tvOS application has a media player, Datazoom’s iOS / tvOS Collector can be extended with the following media player extensions.

Amazon IVS IOS Media Player

AVPlayer Media Player

Bitmovin Media Player

Supported Features

Configurable App Session Timeout

Supported Data Points

Events

Discrete occurrences driven by user interactions or system actions

Custom Event
Datazoom Loaded

Metadata

Device

User

Network

Location

System

Custom

Custom Metadata

Fluxdata

Metrics measuring changing parameters over time