Documentation Analytics Streaming Media Collection Guide

Set up Mobile SDK v3.x for Chromecast set-up-chromecast

Last update: Tue Jun 25 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Topics:
Media Analytics

CREATED FOR:

User
Admin
Developer

This section describes the prerequisites for setting up a Chromecast installation for the Streaming Media Collection Add-on.

Prerequisites

Obtain valid configuration parameters

These parameters can be obtained from an Adobe representative after you set up your media analytics account.
Include the following APIs in your media player
- An API to subscribe to player events - The Media SDK requires that you call a set of simple APIs when events occur in your player.
- An API that provides player information - This information includes details such as the media name and the play head position.

Adobe Mobile services provides a new UI that brings together mobile marketing capabilities for mobile applications from across the Adobe Marketing Cloud. Initially, the Mobile service provides seamless integration of app analytics and targeting capabilities for the Adobe Analytics and Adobe Target solutions. Learn more at Adobe Mobile Services documentation.

The Adobe Mobile Library for Chromecast v3.x for Experience Cloud Solutions lets you measure Chromecast applications written in JavaScript, leverage and collect audience data through audience management, and measure video engagement.

Mobile Library / SDK Implementation

Add your downloaded Chromecast library to your project.

The AdobeMobileLibrary-Chromecast-[version] zip file consists of the following software components:
- adbmobile-chromecast.min.js:
  
  This library file will be included in your Chromecast app source folder.
- ADBMobileConfig config
  
  This SDK configuration file is customized for your app. A sample ADBMobileConfig implementation is provided with the SDK (under samples/). Obtain the proper settings from an Adobe representative.

Add the library file to your index.html file, and create the ADBMobileConfig global variable as follows (the global variable used to configure Adobe Mobile for Media Analytics has an exclusive key named mediaHeartbeat):

code language-js

code language-js
<script> var ADBMobileConfig = { "marketingCloud": { "org": "972C898555E9F7BC7F000101@AdobeOrg" }, "target": { "clientCode": "", "timeout": 5 }, "audienceManager": { "server": "obumobile5.demdex.net" }, "analytics": { "rsids": "example.sample.player", "server": "example.sc.omtrc.net", "ssl": true, "offlineEnabled": false, "charset": "UTF-8", "lifecycleTimeout": 300, "privacyDefault": "optedin", "batchLimit": 0, "timezone": "MDT", "timezoneOffset": -360, "referrerTimeout": 0, "poi": [] }, "mediaHeartbeat": { "server": "example.hb-api.omtrdc.net", "publisher": "972C898555E9F7BC7F000101@AdobeOrg", "channel": "test-channel-chromecast", "ssl": true, "ovp": "chromecast-player", "sdkVersion": "chromecast-sdk", "playerName": "Chromecast" } }; </script> <script type="text/javascript" src="script/lib/adbmobile-chromecast.min.js"></script>

<script>
    var ADBMobileConfig = {
      "marketingCloud": {
        "org": "972C898555E9F7BC7F000101@AdobeOrg"
      },
      "target": {
        "clientCode": "",
        "timeout": 5
      },
      "audienceManager": {
        "server": "obumobile5.demdex.net"
      },
      "analytics": {
        "rsids": "example.sample.player",
        "server": "example.sc.omtrc.net",
        "ssl": true,
        "offlineEnabled": false,
        "charset": "UTF-8",
        "lifecycleTimeout": 300,
        "privacyDefault": "optedin",
        "batchLimit": 0,
        "timezone": "MDT",
        "timezoneOffset": -360,
        "referrerTimeout": 0,
        "poi": []
      },
      "mediaHeartbeat": {
        "server": "example.hb-api.omtrdc.net",
        "publisher": "972C898555E9F7BC7F000101@AdobeOrg",
        "channel": "test-channel-chromecast",
        "ssl": true,
        "ovp": "chromecast-player",
        "sdkVersion": "chromecast-sdk",
        "playerName": "Chromecast"
      }
    };
  </script>
<script type="text/javascript" src="script/lib/adbmobile-chromecast.min.js"></script>

note important
IMPORTANT
If `mediaHeartbeat` is incorrectly configured, the media module enters an error state and will stop sending tracking calls.

ADBMobile Config Parameters for mediaHeartbeat key:

table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2
Config Parameter	Description
`server`	String that represents the URL of the tracking endpoint on the backend.
`publisher`	String that represents the content publisher unique identifier.
`channel`	String that represents the name of the content distribution channel.
`ssl`	Boolean that represents whether SSL should be used for tracking calls.
`ovp`	String that represents the name of the video player provider.
`sdkversion`	String that represents the current version of the app/SDK.
`playerName`	String that represents the name of the player.

Configure Experience Cloud Visitor ID.

The Experience Cloud Visitor ID service provides a universal Visitor ID across Experience Cloud solutions. The Visitor ID service is required by Media Analytics and other Marketing Cloud integrations.

Verify that your ADBMobileConfig config contains your marketingCloud organization ID.

code language-none
`"marketingCloud": { "org": "YOUR-MCORG-ID" }`

Experience Cloud organization IDs uniquely identify each client company in the Adobe Marketing Cloud and appear similar to the following value: 016D5C175213CCA80A490D05@AdobeOrg.

note important
IMPORTANT
Ensure that you include `@AdobeOrg`.

After the configuration is complete, an Experience Cloud Visitor ID is generated and is included on all hits. Other Visitor IDs, such as custom and automatically-generated, continue to be sent with each hit.

Experience Cloud Visitor ID Service Methods

note tip
TIP
Experience Cloud Visitor ID methods are prefixed with `visitor`.

table 0-row-2 1-row-2 2-row-2
Method	Description
`getMarketingCloudID()`	Retrieves the Experience Cloud Visitor ID from the Visitor ID service. `ADBMobile.visitor.getMarketingCloudID();`
`syncIdentifiers()`	With the Experience Cloud Visitor ID, you can set additional customer IDs that can be associated with each visitor. The Visitor API accepts multiple customer IDs for the same visitor and a customer type identifier to separate the scope of the different customer IDs. This method corresponds to `setCustomerIDs()` in the JavaScript library. For example: `var identifiers = {};` `identifiers["idType"] = "idValue";` `ADBMobile.visitor.syncIdentifiers(identifiers);`

For tracking media, implement MediaDelegate protocol

code language-js

code language-js
`var delegate = { // Replace <currentPlaybackTime> with the video player current playback time getCurrentPlaybackTime = function() { return <currentPlaybackTime>; }, // Replace <bitrate>, <startuptime>, <fps> and <droppeFrames> with the current playback QoS values. getQoSObject = function() { return ADBMobile.media.createQoSObject(<bitrate>, <startupTime>, <fps>, <droppedFrames>); } } ADBMobile.media.setDelegate(delegate); }`

 var delegate = {
   // Replace <currentPlaybackTime> with the video player current playback time
   getCurrentPlaybackTime = function() {
     return <currentPlaybackTime>;
   },
   // Replace <bitrate>, <startuptime>, <fps> and <droppeFrames> with the current playback QoS values.
   getQoSObject = function() {
      return ADBMobile.media.createQoSObject(<bitrate>, <startupTime>, <fps>, <droppedFrames>);
   }
 }

 ADBMobile.media.setDelegate(delegate);
}

recommendation-more-help

c8eee520-cef5-4f8c-a38a-d4952cfae4eb