DocumentationExperience PlatformTags

Adobe Media Analytics (3.x SDK) for Audio and Video extension overview

Last update: Tue Jan 10 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer
NOTE
Adobe Experience Platform Launch has been rebranded as a suite of data collection technologies in Adobe Experience Platform. Several terminology changes have rolled out across the product documentation as a result. Please refer to the following document for a consolidated reference of the terminology changes.

Use this documentation for information on installing, configuring, and implementing the Adobe Media Analytics (3.x SDK) for Audio and Video extension (Media Analytics extension). Included are the options available when using this extension to build a rule, along with examples and links to samples.

The Media Analytics (MA) extension adds the core JavaScript Media SDK (Media 3.x SDK). This extension provides the functionality for adding the Media tracker instance to a tags-enabled site or project. The MA extension requires two additional extensions:

IMPORTANT
This extension deploys with Media 3.x SDK, which is not backward compatible with Media 2.x SDK. Since 2.x has been deprecated, please update to 3.x.

After you have included all three of the extensions mentioned above in your tags-enabled project, you can proceed in one of two ways:

  • Use Media APIs from your web app
  • Include, or build, a player-specific extension that maps specific media player events to the APIs on the Media tracker instance. This instance is exposed through the MA extension.

Install and configure the MA extension

  • Install: To install the MA extension, open your extension property, select Extensions > Catalog, hover over the Adobe Media Analytics (3.x SDK) for Audio and Video extension, and select Install.

  • Configure: To configure the MA extension, open the Extensions tab, hover over the extension, and then select Configure:

MA Extension Configuration

Configuration options:

Option
Description
Collection API Server
Defines the Media Collection API Server (Contact your Adobe representative to get this server)
Application Version
The version of the media player app/SDK
Player Name
Name of the media player in use (e.g., “AVPlayer”, “HTML5 Player”, “My Custom VideoPlayer”)
Channel
Channel name property
Debug Logging
Enable or Disable logging
Enable SSL
Enable or Disable sending pings over HTTPS
Export APIs to Window Object
Enable or Disable exporting Media Analytics APIs to global scope
Variable Name
A variable you use to export Media Analytics APIs under the window object

Reminder: The MA extension requires the Analytics and Experience Cloud ID extensions. You must also add these extensions to your extension property and configure them.

Using the MA extension

Using from a webpage/JS-app

The MA extension exports the Media APIs in the global window object by enabling the “Export APIs to Window Object” setting in the Configuration page. It exports the APIs under the configured variable name. For example, if the variable name is configured to be ADB, then Media APIs can be accessed by window.ADB.Media.

IMPORTANT
The MA extension exports the APIs only when window["CONFIGURED_VARIABLE_NAME"] is undefined and does not override existing variables.

  1. Media APIs:  window["CONFIGURED_VARIABLE_NAME"].Media

    This exposes all the APIs and constants from Media SDK: https://adobe-marketing-cloud.github.io/media-sdks/reference/javascript_3x/APIReference.html

  2. Create Media Tracker Instance:  window["CONFIGURED_VARIABLE_NAME"].Media.getInstance

    Return Value: A Media tracker instance for tracking a media session.

    code language-javascript 
    var Media = window["CONFIGURED_VARIABLE_NAME"].Media;

var tracker = Media.getInstance();

  3. Using the Media tracker instance, follow the JS API documentation to implement media tracking.

You can obtain the sample player here: MA Sample Player. The sample player acts as a reference to showcase how to use the MA extension to support Media Analytics directly from a webapp.

Using from other extensions

The MA extension exposes media as a shared module to other extensions. (For additional information on Shared Modules, see Shared Modules documentation.)

IMPORTANT
Shared Modules can only be accessed from other extensions. That is, a webpage/JavaScript app cannot access the shared modules, or use turbine (see code sample below) outside of an extension.

  1. Media APIs:  media Shared Module

    This exposes all the APIs and constants from Media SDK: https://adobe-marketing-cloud.github.io/media-sdks/reference/javascript_3x/APIReference.html

  2. Create the Media tracker instance as follows:

    Return Value: A Media tracker instance for tracking a media session.

    code language-javascript 
    var Media =
  turbine.getSharedModule('adobe-media-analytics', 'media');

var tracker = Media.getInstance();

  3. Using the Media tracker instance, follow the JS API documentation to implement media tracking.

NOTE
Testing: For this release, to test your extension you must upload it to Platform, where you have access to all dependent extensions.
recommendation-more-help
12b4e4a9-5028-4d88-8ce6-64a580811743