Firebase Analytics

The AmpFirebase plugin offers a quick and escalable way to integrate AmpPlayer with Google Firebase. This plugin enables the reporting of data collected by AMP in your application to your own instance of Firebase, efectively tracking your video activity. It will provide you the liberty of tracking the events you are interested in, keeping your logs with only the important information.

You can check out our basic implementation, please refer to our application samples:

AMP Firebase application sample for iOS.

Adding the Plugin to the Xcode project

Manual Installation

To manually install the plugin you’ll need to download our latest distribution. You will be using AmpFirebase.xcframework and the AmpCore.xcframework to integrate this plugin.

You will also need the Firebase which you can download it on the release page.

This plugin will only work on iOS.

The latest version of the Firebase used by this plugin is 10.29.0 , newer versions may be used, but you may run into unexpected errors until an update is released.

After acquiring the frameworks you can just drag them to you Xcode project directory.

The last step, is to mark every imported framework for Embed & Sign in the project’s general tab.

CocoaPods

If you don’t have CocoaPods installed, refer to the CocoaPods documentation. To use CocoaPods, first create a Podfile in the directory containing the Xcode project. For the AmpFirebase plugin, the Podfile should look like this:

target "ProjectName" do

  use_frameworks!

  pod 'AmpCore'
  pod 'AmpFirebase'
  pod 'FirebaseAnalytics'

end

Once you have added the Podfile just run the command pod install --repo-update in the directory it’s located. Once the command has been completed you should se a new .xcworkspace file in your folder. Now you can start integrating the library.

Implementation

You need a working implementation of the AmpPlayer before using this plugin. If you need the implementation guide for AmpPlayer please refer to our documentation.

Configuration File

First is to create and add to your project a configuration file GoogleService-Info.plist for Firebase to work. Please follow this guide to do so.

Firebase Setup

After adding the configuration file to your project you’ll need to call the configure method on Firebase during your app launch to make sure the configuration has been loaded.

public func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
    // Override point for customization after application launch.
    FirebaseApp.configure()
    return true
}

Import

Next you need to import the AmpCore, AmpFirebase, and Firebase plugins.

import AmpCore
import AmpFirebase
import FirebaseCore
import FirebaseAnalytics

Picking the important event

After importing the libraries to the file, the next step is to define the events you want to track. You will have to create a list of the events you are insterested in.

var trackingList: [AmpTracking] = [.playback, .ads]

Complete list of events

There are plenty of events you can track as well as complete categories of events that contain several events.

Creating a new instance

Create an instance of the manager to link your preferences on the events to be tracked with the player.

AmpFirebaseManager(player:ampPlayer, trackingList:trackingList)

Add custom log information

You can also expand on the usual behaviour of the arguments logged in Firebase.

class firebaseArgs: AmpFirebaseArgs {
    override func getGlobalArgs() -> [String : Any] {
        return [ CUSTOM_KEY : VOD_STREAM_NAME ]
    }
}

You can override as many methods as you want and even add your own logic on how the information changes across time. There are ways to add additional arguments for every event, for a single category or even for a specific event.

Additional Information

This guide was written on 7/26/2024 and it’s last revision was made on 7/26/2024. If you need any additional support please contact us through our offical support email.