Adobe Heartbeat

The following document describes how to implement Adobe HeartBeat module from AMP Android SDK.

Introduction

Before you continue be aware that AMP Android SDK can be integrated with different approaches:

• AMP Basic Integration: AMP Android SDK has a standard API to implement all features. AMP Basic Integration. It requires more code development and gives more freedom. For example: it allows UI control customization, rebuild the UI Controls completely, integration of Server Side Ad Insertion like DAI and Client Side Ad Insertion like IMA at the same time.
• AMP Player Wrapper Integration: AMP Android SDK has a Wrapper module called AmpPlayer module. This module simplifies the implementation even further. It is intended for customers who want a quick integration, with almost no customizations and a default UI. The AMP Player module unifies and coordinates all the different plugins we provide: playback, UI (scrubbar, buttons and events), Close Captions, ads and analytics. With this new module we are saving the developer most integration effort, by providing a single drag and drop plugin that will provide production quality results in a matter of a few minutes.

Reach out to us at amp-sdk-support@akamai.com with any questions or concerns.

Prerequisite

The rest of this guide assumes you have successfully integrated AMP’s Core (you are able to play back a video): Basic Integration.

It also assumes you have started conversations with a Comscore representative, for them to provide you some custom metadata specific to your Android app, that you will need in Point #5 of this guide (AdobeUserId, TrackingServer, Publisher, Channel, Ovp).

Getting started

For reference, check the AMPHeartbeatSample Android Studio sample project in the release package. To integrate the plugin into your app, you need to:

1. Add the following files to your to your project’s /libs folder:

   • adobeMobileLibrary.jar (provided by Adobe)
   • VideoHeartbeat.jar OR MediaSDK.jar (provided by Adobe)
   • amp-analytics-adobe-heartbeat.jar (provided by Akamai Technologies Inc in modules/AnalyticsAdobeHeartbeat/libs)

2. In the Activity where playback is handled, import the following Java packages:

    import com.akamai.amp.analytics.adobeheartbeat.AdobeHeartbeat;
    import com.akamai.amp.analytics.adobeheartbeat.AmpAdobeHeartbeatAnalyticsTracker;
    import com.akamai.amp.config.data.heartbeat.HeartbeatConfigurationData;
    import com.akamai.amp.config.data.heartbeat.HeartbeatData;

1. Add an object of the AmpAdobeHeartbeatAnalyticsTracker type in your Activity’s members:

    private AmpAdobeHeartbeatAnalyticsTracker heartbeatAnalytics;

1. Initialize that object, on the onResourceReady() method from the VideoPlayerContainerCallback:

    private void initAnalytics() {
      ...
      heartbeatAnalytics = AdobeHeartbeat.create(videoPlayerView, buildHeartbeatData());
      ...
    }

1. The buildHeartbeatData() method, returns a com.akamai.amp.config.data.heartbeat.HeartbeatData object. Check all its set() methods, to send the appropriate values. For example:

    HeartbeatConfigurationData data = new HeartbeatConfigurationData();
    data.setTrackingServer(HEARTBEAT_TRACKING_SERVER);
    data.setPublisher(HEARTBEAT_PUBLISHER);
    data.setChannel(HEARTBEAT_CHANNEL);
    data.setOvp(HEARTBEAT_OVP);
    data.setAudienceManagerDpid(AUDIENCE_MANAGER_DPID);
    data.setAudienceManagerDpuuid(AUDIENCE_MANAGER_DPUUID);
    data.setAdobeUserId(ADOBE_USER_ID);

1. If your app integrates ads, it should use the corresponding AMP Plugin for integration with Heartbeat. This example assumes Google IMA Ads. Once the com.akamai.ads.ima.AmpIMAManager is initialized (it has to send the different events to AMP’s Heartbeat object):

    adsManager.addEventsListener(heartbeatAnalytics.getiAdsComponentListener());

1. Reach out to an Adobe representative to get certified. Remember to load place the corresponding ADBMobileConfig.json in main/assets/ folder: ADB Mobile Config

If you have further questions or comments, reach out to us via amp-sdk-support@akamai.com