Skip to content

Commit 602dc83

Browse files
authored
Add note about setting playhead to window.md (#1510)
* Add note about setting playhead to window.md This support was added last year after we discovered Adobe requires 1s playheads. Fox has implemented this as per the language above and confirmed it works. You can see this in the integration: https://github.com/segmentio/analytics.js-integrations/blob/master/integrations/adobe-analytics/lib/index.js#L138 and https://github.com/segmentio/analytics.js-integrations/blob/master/integrations/adobe-analytics/lib/index.js#L1253. * fix typo.md
1 parent bffb68f commit 602dc83

File tree

1 file changed

+17
-7
lines changed
  • src/connections/destinations/catalog/adobe-analytics

1 file changed

+17
-7
lines changed

src/connections/destinations/catalog/adobe-analytics/heartbeat.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,27 +10,37 @@ Adobe Heartbeat is an Adobe Analytics add-on that allows you to collect video an
1010
1111
Before you start, complete these required steps.
1212

13-
First, connect your Adobe heartbeat server URL to Segment:
14-
1. Find your Adobe Analytics heartbeat tracking server URL and copy it. If you don’t know where to find your heartbeat tracking server URL, contact your Adobe representative.
13+
First, connect your Adobe Heartbeat Server URL to Segment:
14+
1. Find your Adobe Analytics Heartbeat Tracking Server URL and copy it. If you don’t know where to find your Heartbeat Tracking Server URL, contact your Adobe representative.
1515
2. Log in to your Segment workspace, and go to the Adobe Analytics settings.
1616
If you have multiple sources sending to Adobe Analytics, click the one that you'll be using with Adobe Heartbeat. If you'll be using Heartbeat with more than one source, repeat these steps for each source.
1717
3. Open the **Heartbeat Tracking Server URL** setting, and paste your server URL in the field. Click Save.
1818

19-
**Note**: If you don't specify a tracking server URL, Segment can't send your video events to Adobe Analytics.
19+
**Note**: If you don't specify a Heartbeat Tracking Server URL, Segment can't send your video events to Adobe Heartbeat.
2020

2121
Next, enable Adobe's VisitorID service in your Adobe account. You must do this to track Heartbeat data. See Adobe's documentation for more on enabling the VisitorID service.
2222

23-
## Set up steps for mobile
24-
25-
Then, set up your mobile libraries:
23+
## Set Up Steps for Mobile
2624

2725
For Android:
2826

2927
1. If you haven’t done so already, go to the Adobe Mobile Services UI and follow [these steps](https://docs.adobe.com/content/help/en/mobile-services/android/getting-started-android/requirements.html#section_044C17DF82BC4FD8A3E409C456CE9A46) to download the core `adobeMobileLibrary` and configure in your Android project. Add the `ABDMobileConfig.json` to your project from the downloaded SDK.
3028
2. Download the latest version of the `MediaSDK.jar` file and [include it in your Android project using Adobe's documentation steps](https://docs.adobe.com/content/help/en/media-analytics/using/sdk-implement/setup/set-up-android.html).
3129
3. Follow the [remaining set up steps](https://docs.adobe.com/content/help/en/media-analytics/using/sdk-implement/setup/set-up-android.html) to complete the installation.
3230

33-
For iOS: the Adobe Heartbeat SDK is already included with the Segment-Adobe-Analytics SDK. Ensure you have added the `ABDMobileConfig.json` for your iOS project from the Adobe Mobile Services UI.
31+
For iOS: The Adobe Heartbeat SDK is already included with the Segment-Adobe-Analytics SDK when you add a Heartbeat Tracking Server URL. Ensure you have added the `ABDMobileConfig.json` for your iOS project from the Adobe Mobile Services UI.
32+
33+
## Set Up Steps for Web
34+
35+
The Adobe Heartbeat JS SDK is automatically included with the Segment-Adobe-Analytics integration when you add a Heartbeat Tracking Server URL.
36+
37+
Segment will map your video events to the Adobe methods as outlined below. In order to record video heartbeats to Adobe accurately on web, Adobe's SDK requires a playhead update **at least once per second** for main content. The "Video Content Playing" event updates the playhead using the `position` property. If you do not want to trigger this event every second, you can alternatively set the playhead to the window. This can be done by setting `window._segHBPlayheads` to the key-value pair of the current content's `session_id` and `position`:
38+
39+
```javascript
40+
window._segHBPlayheads = { <session_id>: <position> }
41+
```
42+
43+
The Segment-Adobe-Analytics integration will pick up the playhead(s) you set to `window._segHBPlayheads` and pass this to Adobe's SDK.
3444

3545

3646

0 commit comments

Comments
 (0)