Adobe Analytics (Omniture) Plugin

Use the Player V4 Adobe Analytics plugin (omniture.min.js) to track Adobe Marketing Cloud analytics for your V4 Ooyala Player. This integration uses the Adobe Heartbeat SDK to publish video-related events, such as video plays, quartile video completion rates, and content metadata to your instance of Adobe Marketing Cloud.

Run-time Flow During Playback

During playback, a playback event triggers notification about the event to the Adobe Marketing Cloud.

Required Adobe Plugins

To use the Player V4 Adobe Analytics plugin (omniture.min.js), you must load several Adobe plugins related to the Adobe Heartbeat SDK.

  • VideoHeartbeat.min.js is the main library that gathers analytics for video playback.
  • AppMeasurement.js and VisitorAPI.js send account and tracking information to the Video Heartbeat SDK.

Supported Players

For this release, the Player V4 Adobe Analytics plugin supports integrating Adobe Analytics with the Ooyala HTML5 web player versions 4.4.8 and above.

Prerequisites

Prior to using the Player V4 Adobe Analytics plugin you must contact your Adobe representative and request the following account information for your integration with Ooyala Player V4:
  • Report Suite ID
  • Tracking Server
  • Marketing Cloud Organization ID
  • Publisher ID
You will pass this information to Ooyala along with other player parameters.

Step 1: Get the Adobe Analytics Plugins

Note: This applies only if you are self-hosting player resources, as described in Hosting Player V4 Resources.
  1. Download the latest version of the following plugins. For the download URLs, see the Ooyala Player V4 Release Notes.
    • VideoHeartbeat.min.js
    • AppMeasurement.js
    • VisitorAPI.js
    • omniture.min.js
  2. Host the above plugins as described in Hosting Player V4 Resources.

Step 2: Load the Plugin Scripts

On the page where you want to run the player, add the following scripts:
  • VideoHeartbeat.min.js is the main Adobe Heartbeat library that gathers analytics for video playback.
  • AppMeasurement.js and VisitorAPI.js send account and tracking information to the Video Heartbeat SDK.
  • omniture.min.js must be loaded last.
Be sure to load all of these plugins after you load core.min.js, and in the order specified.
Note: Wherever you see url_where_hosted in sample code, replace this (in your code) with the URL that points to where the resource is hosted. For a list of Ooyala-hosted paths, see Ooyala-hosted Player V4 Resources. The URL can point to a location on the same host (internal link) or on a separate host (prefixed with http:// or https://). If you host resources yourself (see Hosting Player V4 Resources), be sure to check for any path dependencies within the files.
<script src="url_where_hosted/VideoHeartbeat.min.js"></script>
<script src="url_where_hosted/AppMeasurement.js"></script>
<script src="url_where_hosted/VisitorAPI.js"></script>
<script src="url_where_hosted/omniture.min.js"></script>                 

Step 3: Specify Page-level Parameters

As with other Player V4 plugins, on the page where you want to run the player, you can specify page-level parameters within the playerparams variable that is passed in during player creation (see Page-level Parameters for Player V4).

Required Parameters

Specify the following required page-level parameters as a child of the omniture parameter. You will need to get the values of these parameters from your Adobe representative. Go to the following Adobe topic for details: Implement the Marketing Cloud ID Service for Analytics.
Parameter Description
marketingCloudOrgId Your Adobe Marketing Cloud Organization ID. Go to https://marketing.adobe.com/resources/help/en_US/mcvid/mcvid-requirements.html for details.
visitorTrackingServer Your standard or secure tracking server domain (without the "http" or "https" prefix).
appMeasurementTrackingServer Your standard or secure tracking server domain (without the "http" or "https" prefix).
reportSuiteId The report suite or report suites (multi-suite tagging) that you wish to track.
heartbeatTrackingServer Your standard or secure tracking server domain (without the "http" or "https" prefix).
publisherId Your publisher ID.
pageName Specify a name for your page
visitorId Unique identifier for each visitor.

Optional Parameters

Specify the following optional page-level parameters. You can get the values of these parameters from your Adobe representative. Go to https://marketing.adobe.com/resources/help/en_US/mcvid/mcvid-setup-analytics.html for additional details.
Parameter Description
debug Enable (YES) or disable (NO) debugging information.
channel Specify a name for your channel.
props Traffic variables you can use to report on custom dimensions. Keys in props must be of the form "prop#". Go to https://marketing.adobe.com/resources/help/en_US/sc/implement/props_vs_eVars.html for details.
eVars Conversion variables you can use to report on custom dimensions. Keys in eVars must be of the form "eVar#". Go to https://marketing.adobe.com/resources/help/en_US/sc/implement/props_vs_eVars.html for details.

Example

The following example shows how to load the Adobe Analytics plugins and use the page plugins. You will need to modify all items in bold with your data for this example to run.

<html>
<head>
    <title>Adobe Analytics Example</title>
    <!-- V4 JS core is required. Plugins such as skin, discovery and Advertising need to be loaded separately -->
    <script src="url_where_hosted/core.min.js"></script>
    <script src="url_where_hosted/html5-skin.min.js"></script>
    <link rel="stylesheet" href="url_where_hosted/html5-skin.min.css" />
    <!-- A Video Plugin is required. This example shows the Main Video Plugin -->
    <script src="url_where_hosted/main_html5.min.js"></script>
    <!-- Analytics Plugins -->
    <script src="url_where_hosted/VideoHeartbeat.min.js"></script>
    <script src="url_where_hosted/AppMeasurement.js"></script>
    <script src="url_where_hosted/VisitorAPI.js"></script>
    <script src="url_where_hosted/omniture.min.js"></script>
</head>
<body>
    <div id="container" style="width:640px; height:360px;"></div>
    <script>
        var playerParam = {
            "pcode": "YOUR_PCODE",
            "playerBrandingId": "YOUR_PLAYER_ID",
            "skin": {
                // Config contains the configuration setting for player skin. Change to your local config when necessary.
                "config": "url_where_hosted/skin.json"
            },
            "omniture": {
                "marketingCloudOrgId": "YOUR_MARKETING_CLOUD_ORG_ID",
                "visitorTrackingServer": "TEST.sc.TEST.net",
                "appMeasurementTrackingServer": "TEST.sc.TEST.net",
                "reportSuiteId": "YOUR_REPORT_SUITE_ID",
                "pageName": "Test Page Name",
                "visitorId": "test-vid",
                "debug": true,
                "channel": "Test Heartbeat Channel",
                "heartbeatTrackingServer": "TEST.en.TEST.net",
                "publisherId": "YOUR_PUBLISHER_ID",
                "props": {
                    "prop1": "sports",
                    "prop25": "football"
                },
                "eVars": {
                    "eVar9": "en"
                }
            }
        };
        OO.ready(function() {
            window.pp = OO.Player.create("container", "YOUR_ASSET_ID", playerParam);
        });
    </script>
    <body>
</html>
            

Was this article helpful?