Install Media Analytics with Experience Platform Edge
Adobe Experience Platform Edge allows you to send data destined to multiple products to a centralized location. Experience Edge forwards the appropriate information to the desired products. This concept allows you to consolidate implementation efforts, especially spanning multiple data solutions.
The following graphic illustrates how a Media Analytics implementation can use Experience Platform Edge to make data available in Analysis Workspace, either in Adobe Analytics or Customer Journey Analytics:
For an overview of all implementation options, including implementation methods that don’t use Experience Platform Edge, see Implement Streaming Media for Adobe Analytics or Customer Journey Analytics.
Regardless of whether you use the Mobile SDK or the API to implement Streaming Media with Experience Edge, you must first complete the following sections:
Set up the schema in Adobe Experience Platform
To standardize data collection for use across applications that leverage Adobe Experience Platform, Adobe has created the open and publicly documented standard, Experience Data Model (XDM).
To create and set up a schema:
-
In Adobe Experience Platform, begin creating the schema as described in Create and edit schemas in the UI.
When creating the schema, choose XDM ExperienceEvent from the Create schema drop-down menu.
-
In the Composition area, in the Field groups section, select Add, then search for and add the following new field groups to the schema:
Adobe Analytics ExperienceEvent Template
Implementation Details
MediaAnalytics Interaction Details
After you add the field groups, they should display in the Field groups section, as follows:
-
Select Confirm to save your changes.
-
(Optional) You can hide certain fields that are not used by the Media Edge API. Hiding these fields makes the schema easier to read and understand, but it is not required. These fields refer only to those in the
MediaAnalytics Interaction Details
fieldgroup.accordion Expand here to view instructions on fields that you can hide. -
In the Structure area, select the
Media Collection Details
field, select Manage related fields, then update the schema as follows:-
In the
Media Collection Details
field, hide theList Of States
field. -
In the
Media Collection Details
>Advertising Details
field, hide the following reporting fields:Ad Completed
,Ad Started
, andAd Time Played
. -
In the
Media Collection Details
>Advertising Pod Details
field, hide the following reporting field:Ad Break ID
-
In the
Media Collection Details
>Chapter Details
field, hide the following reporting fields:Chapter ID
,Chapter Completed
,Chapter Started
, andChapter Time Played
. -
In the
Media Collection Details
>Qoe Data Details
field, hide the following reporting fields:Average Bitrate
,Average Bitrate Bucket
,Bitrate Changes
,Buffer Events
,Total Buffer Duration
,Errors
,External Error IDs
,Bitrate Change Impacted Streams
,Buffer Impacted Streams
,Dropped Frame Impacted Streams
,Error Impacted Streams
,Stalling Impacted Streams
,Drops Before Starts
,Media SDK Error IDs
,Player SDK Error IDs
,Stalling Events
, andTotal Stalling Duration
. -
In the
Media Collection Details
>Session Details
field, hide the following reporting fields:Media Session ID
,Ad Count
,Average Minute Audience
,Chapter Count
,Estimated Streams
,Pause Impacted Streams
,10% Progress Marker
,25% Progress Marker
,50% Progress Marker
,75% Progress Marker
,95% Progress Marker
,Media Segment Views
,Content Completes
,Media Downloaded Flag
,Federated Data
,Content Starts
,Media Starts
,Pause Events
,Total Pause Duration
,Media Session Server Timeout
,Video Segment
,Content Time Spent
,Media Time Spent
,Unique Time Played
,Pev3
, andPccr
. -
In the
Media Collection Details
>List Of States End
andMedia Collection Details
>List Of States Start
field, hide the following reporting fields:Player State Count
,Player State Set
, andPlayer State Time
.
-
-
Select Confirm to save your changes.
-
In the Structure area, select the
List Of Media Collection Downloaded Content Events
field, select Manage related fields, then update the schema as follows:-
In the
List Of Media Collection Downloaded Content Events
>Media Details
field, hide theList Of States
field. -
In the
List Of Media Collection Downloaded Content Events
>Media Details
>Advertising Details
field, hide the following reporting fields:Ad Completed
,Ad Started
, andAd Time Played
. -
In the
List Of Media Collection Downloaded Content Events
>Media Details
>Advertising Pod Details
field, hide the following reporting field:Ad Break ID
-
In the
List Of Media Collection Downloaded Content Events
>Media Details
>Chapter Details
field, hide the following reporting fields:Chapter ID
,Chapter Completed
,Chapter Started
, andChapter Time Played
. -
In the
List Of Media Collection Downloaded Content Events
>Media Details
>Qoe Data Details
field, hide the following reporting fields:Average Bitrate
,Average Bitrate Bucket
,Bitrate Changes
,Buffer Events
,Total Buffer Duration
,Errors
,External Error IDs
,Bitrate Change Impacted Streams
,Buffer Impacted Streams
,Dropped Frame Impacted Streams
,Error Impacted Streams
,Stalling Impacted Streams
,Drops Before Starts
,Media SDK Error IDs
,Player SDK Error IDs
,Stalling Events
, andTotal Stalling Duration
. -
In the
List Of Media Collection Downloaded Content Events
>Media Details
>Session Details
field, hide the following reporting fields:Media Session ID
,Ad Count
,Average Minute Audience
,Chapter Count
,Estimated Streams
,Pause Impacted Streams
,10% Progress Marker
,25% Progress Marker
,50% Progress Marker
,75% Progress Marker
,95% Progress Marker
,Media Segment Views
,Content Completes
,Media Downloaded Flag
,Federated Data
,Content Starts
,Media Starts
,Pause Events
,Total Pause Duration
,Media Session Server Timeout
,Video Segment
,Content Time Spent
,Media Time Spent
,Unique Time Played
,Pev3
, andPccr
. -
In the
List Of Media Collection Downloaded Content Events
>Media Details
>List Of States End
andMedia Collection Details
>List Of States Start
field, hide the following reporting fields:Player State Count
,Player State Set
, andPlayer State Time
. -
In the
List Of Media Collection Downloaded Content Events
>Media Details
field, hide theMedia Session ID
field.
-
-
Select Confirm to save your changes.
-
In the Structure area, select the
Media Reporting Details
field, select Manage related fields, then update the schema as follows:- In the
Media Reporting Details
field, hide the following fields:Error Details
,List Of States End
,List of States Start
, andMedia Session ID
.
- In the
-
Select Confirm > Save to save your changes.
-
-
Continue with Create a dataset in Adobe Experience Platform.
Create a dataset in Adobe Experience Platform
-
Ensure that you set up a schema as described in Set up the Schema in Adobe Experience Platform.
-
In Adobe Experience Platform, begin creating the dataset as described in Datasets UI guide.
When selecting a schema for your dataset, choose the schema that you previously created, as described in Set up the Schema in Adobe Experience Platform.
-
Continue with Configure a datastream in Customer Journey Analytics.
Configure a datastream in Adobe Experience Platform
-
Ensure that you created a dataset as described in Create a dataset in Adobe Experience Platform.
-
Create a new datastream as described in Configure a datastream.
When creating the datastream, ensure that you make the following configuration selections:
-
In the Event Schema field when creating the datastream, ensure that you select the schema that you created in Set up the schema in Adobe Experience Platform. Select Save.
note important IMPORTANT Do not select Save and Add Mapping because doing so will result in mapping errors for the Timestamp field. -
Add either of the following services to the datastream, depending on whether you are using Adobe Analytics or Customer Journey Analytics:
-
Adobe Analytics (if using Adobe Analytics)
If you are using Adobe Analytics, make sure you define a report suite, as described in the section Define a report suite in this article.
-
Adobe Experience Platform (if using Customer Journey Analytics)
For information about how to add a service to a datastream, see the “Add services to a datastream” section in Configure a datastream.
-
-
Expand Advanced Options, then enable the Media Analytics option.
-
-
Continue with Create a connection in Customer Journey Analytics.
Create a connection in Customer Journey Analytics
-
Ensure that you created a datastream as described in Configure a datastream in Customer Journey Analytics.
-
In Customer Journey Analytics, create a connection as described in Create a connection.
When creating the connection, the following configuration selections are required for implementing Streaming Media:
-
Select the dataset that you previously created, as described in Create a dataset in Adobe Experience Platform.
-
Ensure that the Import all new data setting is enabled.
-
-
Continue with Create a data view in Customer Journey Analytics.
Create a data view in Customer Journey Analytics
-
Ensure that you created a connection in Customer Journey Analytics as described in Create a connection in Customer Journey Analytics.
-
In Customer Journey Analtyics, create a data view as described in Create or edit a data view.
When creating the data view, the following configuration selections are required for implementing Streaming Media:
-
In the Connection field, select the connection that you previously created, as described in Create a connection in Customer Journey Analytics.
It can take up to 15 minutes before the connection that you created is available to select.
-
On the Components tab, in the Schema fields section, search for each component listed in the tables below and drag it into the Metrics panel. If multiple fields of the same name exist, use the XDM path to ensure that it’s the correct field.
Main content - Content metrics
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 8-row-2 9-row-2 Component name XDM path Media Starts mediaReporting.sessionDetails.isViewed Media Segment Views mediaReporting.sessionDetails.hasSegmentView Content Starts mediaReporting.sessionDetails.isPlayed Content Completes mediaReporting.sessionDetails.isCompleted Content Time Spent mediaReporting.sessionDetails.timePlayed Media Time Spent mediaReporting.sessionDetails.totalTimePlayed Unique Time Played mediaReporting.sessionDetails.uniqueTimePlayed 10% Progress Marker mediaReporting.sessionDetails.hasProgress10 Average Minute Audience mediaReporting.sessionDetails.averageMinuteAudience Chapter & Ads - Chapter & Ads metrics
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 Component name XDM path Chapter Started mediaReporting.chapterDetails.isStarted Chapter Completed mediaReporting.chapterDetails.isCompleted Chapter Time Played mediaReporting.chapterDetails.timePlayed Ad Started mediaReporting.advertisingDetails.isStarted Ad Completed mediaReporting.advertisingDetails.isCompleted Ad Time Played mediaReporting.advertisingDetails.timePlayed QoE - QoE metrics
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 8-row-2 9-row-2 10-row-2 Component name XDM path Time To Start mediaReporting.qoeDataDetails.timeToStart Drops Before Starts mediaReporting.qoeDataDetails.isDroppedBeforeStart Buffer Impacted Streams mediaReporting.qoeDataDetails.hasBufferImpactedStreams Bitrate Change Impacted Streams mediaReporting.qoeDataDetails.hasBitrateChangeImpactedStreams Bitrate Changes mediaReporting.qoeDataDetails.bitrateChangeCount Average Bitrate mediaReporting.qoeDataDetails.bitrateAverage Dropped Frames mediaReporting.qoeDataDetails.droppedFrames Errors mediaReporting.qoeDataDetails.errorCount Error Impacted Streams mediaReporting.qoeDataDetails.hasErrorImpactedStreams Dropped Frame Impacted Streams mediaReporting.qoeDataDetails.hasDroppedFrameImpactedStreams Player state - Player state metrics
table 0-row-2 1-row-2 2-row-2 3-row-2 Component name XDM path Player State Set mediaReporting.states.isSet Player State Count mediaReporting.states.count Player State Time mediaReporting.states.time -
Update the labels (in the Context labels drop-down menu) for the components in the following table. Search for and drag any components that are not already in the metrics panel into the panel.
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 Component name Context label Media Session Server Timeout Media: Seconds Since Last Call Media Time Spent Media: Media Time Spent Total Buffer Duration Media: Total Buffer Duration Time to Start Media: Time To Start Total Pause Duration Media: Total Pause Duration -
To add breakdowns to your Customer Journey Analytics project, add the following dimensions to the Dimensions panel:
table 0-row-2 1-row-2 2-row-2 XDM path Component name mediaReporting.states.name Player State Name mediaReporting.sessionDetails.ID Media Session ID In addition to the dimensions in this table, you can add in any other dimensions that you want to make available to filter data by in Customer Journey Analytics projects.
-
-
Select Save and continue > Save and finish to save your changes.
-
Continue with Create and configure a project in Customer Journey Analytics.
Create and configure a project in Customer Journey Analytics
-
Ensure that you created a data view in Customer Journey Analytics as described in Create a data view in Customer Journey Analytics.
-
In Customer Journey Analytics, in the Workspace tab, in the Projects area, select Create project.
-
Select Blank project > Create.
-
In the new project, select the data view that you previously created.
When creating panels in your project, you can use any components that you added to your data view, as described in Create a data view in Customer Journey Analytics.
The following 4 panels are examples of panels that you could create:
-
Select the Panels icon in the left rail, then drag in the Media concurrent viewers panel and the Media playback time spent panel.
The 2 panels should look like this:
-
Share the project as described in Share projects.
note note NOTE If the users you want to share with are not available, make sure the users have user and admin access to Customer Journey Analytics in the Adobe Admin Console. -
Continue with Send data to Experience Platform Edge.
Send data to Experience Platform Edge using AEP Mobile SDK
You can use the Adobe Experience Platform mobile SDK to send mobile data to Experience Platform Edge.
Use the following documentation resources to complete the implementation for both iOS and Android:
Alternatively, you could use a custom implementation of the Edge APIs using the following resources: