DocumentationAnalyticsStreaming Media Collection Guide

Chapter parameters chapter-parameters

Last update: Thu Oct 03 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • User
  • Admin
  • Developer

This topic presents a list of chapter and/or segment data, including context data values, that Adobe collects via solution variables.

Table data description:

  • Implementation: Information on implementation values and requirements

    • Key - Variable, set either manually in your app, or automatically by the Adobe Media SDK.
    • Required - Indicates whether the parameter is required for basic video tracking.
    • Type - Specifies the type of the variable to be set, string or number.
    • Sent With - Indicates when the data is sent: Media Start is the analytics call sent on media start, Ad Start is the analytics call sent on ad start, and so on; the Close calls are the compiled analytics calls sent directly from the heartbeat server to the analytics server at the end of the media session, or the end of the ad, chapter, etc. The close calls are not available in network packet calls.
    • Min. SDK Version - Indicates which SDK version you would need to access the parameter.
    • Sample Value - Provides example of common variable usage.

  • Network Parameters: Displays the values that are passed to Adobe Analytics or Heartbeat servers. This column shows the names of the parameters that are seen in the network calls generated by Adobe Media SDKs.

  • Reporting: Information on how to view and analyze the video data.

    • Available - Indicates whether the data is available in reporting by default (Yes), or requires custom set-up (Custom)
    • Reserved Variable - Indicates whether the data is captured as an event, eVar, prop, or classification in a reserved variable.
    • Report Name - Name of Adobe Aanlytics report for variable
    • Context Data - Name of the Adobe Analytics context data passed to the reporting server and used in processing rules.
    • Data Feed - Column name for variable found in Clickstream or Live Stream data feeds
    • Audience Manager - Trait name found in Adobe Audience Manager
IMPORTANT
Do not change the classification names for any variables listed below that are described under Reporting/Reserved Variable as “classification”.
The media classifications are defined when a report suite is enabled for media tracking. From time to time, Adobe adds new properties, and, when this occurs, customers must re-enable their report suites to get access to the new media properties. During the update process Adobe determines whether the classifications are enabled by checking the names of the variables. If any of them is missing, Adobe adds the missing ones again.

Chapter Metadata chapter-metadata

Chapter Name

Implementation
Network Parameters
Reporting
  • SDK Key:
    name
  • API Key:
    media.chapter.friendlyName
  • Required:
    No
  • Type:
    string
  • Sent with:
    Chapter Close
  • Min. SDK Version: 1.3
  • Sample Value:
    “The Big Bang Chapter 2 - Dating”
  • Description:
    The name of the chapter and/or segment.
  • Adobe Analytics:
    (a.media.chapter.
    friendlyName)
  • Heartbeat:
    (s:stream:chapter_name)
  • Available:
    Created by default…
  • Reserved Variable:
    Classification
  • Report Name:
    Chapter Name
  • Context Data:
    (a.media.chapter.
    friendlyName)
  • Data Feed:
    N/A
  • Audience Manager:
    (c_contextdata.
    a.media.chapter.
    friendlyName)
  • XDM Field Path:
    media.mediaTimed.mediaChapter.
    chapterAssetReference.dc:title
  • Collection XDM Field Path:
    mediaCollection.chapterDetails.friendlyName
  • Reporting XDM Field Path:
    mediaReporting.chapterDetails.friendlyName

Chapter Position

Implementation
Network Parameters
Reporting
  • SDK Key:
    position
  • API Key:
    media.chapter.index
  • Required:
    SDK: No; API: Yes.
  • Type:
    number
  • Sent with:
    Chapter Close
  • Min. SDK Version: 1.3
  • Sample Value:
    2
  • Description:
    The position (index, integer) of the chapter inside the content.
  • Adobe Analytics:
    (a.media.chapter.
    position)
  • Heartbeat:
    (l:stream:chapter_pos)
  • Available:
    Yes
  • Reserved Variable:
    Classification
  • Report Name:
    Chapter Position
  • Context Data:
    (a.media.chapter.
    position)
  • Data Feed:
    N/A
  • Audience Manager:
    (c_contextdata.
    a.media.chapter.
    position)
  • XDM Field Path:
    media.mediaTimed.mediaChapter.
    chapterAssetViewDetails.index
  • Collection XDM Field Path:
    mediaCollection.chapterDetails.index
  • Reporting XDM Field Path:
    mediaReporting.chapterDetails.index

Chapter Offset

Implementation
Network Parameters
Reporting
  • SDK Key:
    startTime
  • API Key:
    media.chapter.offset
  • Required:
    SDK: No; API: Yes.
  • Type:
    number
  • Sent with:
    Chapter Close
  • Min. SDK Version: 1.3
  • Sample Value:
    58
  • Description:
    The offset of the chapter inside the content (in seconds) from the start.
  • Adobe Analytics:
    (a.media.chapter.
    offset)
  • Heartbeat:
    (l:stream:chapter_offset)
  • Available:
    Yes
  • Reserved Variable:
    Classification
  • Report Name:
    Chapter Offset
  • Context Data:
    (a.media.chapter.
    offset)
  • Data Feed:
    N/A
  • Audience Manager:
    (c_contextdata.
    a.media.chapter.
    offset)
  • XDM Field Path:
    media.mediaTimed.mediaChapter.
    chapterAssetViewDetails.offset
  • Collection XDM Field Path:
    mediaCollection.chapterDetails.offset
  • Reporting XDM Field Path:
    mediaReporting.chapterDetails.offset

Chapter Length

Implementation
Network Parameters
Reporting
  • SDK Key:
  • API Key:
    media.chapter.length
  • Required:
    SDK: No; API: Yes.
  • Type:
    number
  • Sent with:
    Chapter Close
  • Min. SDK Version: 1.3
  • Sample Value:
    486
  • Description:
    The length of the chapter, in seconds.
  • Adobe Analytics:
    (a.media.chapter.
    length)
  • Heartbeat:
    (l:stream:chapter_length)
  • Available:
    Yes
  • Reserved Variable:
    Classification
  • Report Name:
    Chapter Length
  • Context Data:
    (a.media.chapter.
    length)
  • Data Feed:
    N/A
  • Audience Manager:
    (c_contextdata.
    a.media.chapter.
    length)
  • XDM Field Path:
    media.mediaTimed.mediaChapter.
    chapterAssetReference.xmpDM:duration
  • Collection XDM Field Path:
    mediaCollection.chapterDetails.length
  • Reporting XDM Field Path:
    mediaReporting.chapterDetails.length

Chapter

Implementation
Network Parameters
Reporting
  • SDK Key:
    Automatically set
  • API Key:
    N/A
  • Required:
    No
  • Type:
    string
  • Sent with:
    Chapter Close
  • Min. SDK Version: 1.3
  • Sample Value:
  • Description:
    The auto-generated ID of the chapter.
  • Adobe Analytics:
    (a.media.chapter.
    name)
  • Heartbeat:
    (s:stream:chapter_id)
  • Available:
    Yes
  • Reserved Variable:
    eVar
  • Expiration:
    On HIT
  • Report Name:
    Chapter
  • Context Data:
    (a.media.chapter.
    name)
  • Data Feed:
    videochapter
  • Audience Manager:
    (c_contextdata.
    a.media.chapter.
    name)
  • XDM Field Path:
    media.mediaTimed.mediaChapter.
    chapterAssetReference.@id
  • Reporting XDM Field Path:
    mediaReporting.chapterDetails.ID

Chapter Metrics chapter-Metrics

Chapter Start

Implementation
Network Parameters
Reporting
  • SDK Key:
    Automatically set
  • API Key:
    N/A
  • Required:
    Yes
  • Type:
    string
  • Sent with:
    Chapter Close
  • Min. SDK Version: 1.3
  • Sample Value:
    TRUE
  • Description:
    The number of chapter starts. Important: If this event is set, the only possible value is TRUE. If this event is not set, no value is sent.
  • Adobe Analytics:
    (a.media.chapter.
    view)
  • Heartbeat:
    (s:event:
    type=chapter_start)
  • Available:
    Yes
  • Reserved Variable:
    event
  • Report Name:
    Chapter Starts
  • Context Data:
    (a.media.chapter.
    view)
  • Data Feed:
    N/A
  • Audience Manager:
    (c_contextdata.
    a.media.chapter.
    view)
  • XDM Field Path:
    media.mediaTimed.chapterCount.
    value > 0 => “TRUE”
  • Reporting XDM Field Path:
    mediaReporting.chapterDetails.isStarted

Chapter Complete

Implementation
Network Parameters
Reporting
  • SDK Key:
    Automatically set
  • API Key:
    N/A
  • Required:
    Yes
  • Type:
    string
  • Sent with:
    Chapter Close
  • Min. SDK Version: 1.3
  • Sample Value:
    TRUE
  • Description:
    The number of chapter completes. Important: If this event is set, the only possible value is TRUE. If this event is not set, no value is sent.
  • Adobe Analytics:
    (a.media.chapter.
    complete)
  • Heartbeat:
    (s:event:
    type=chapter_complete)
  • Available:
    Yes
  • Reserved Variable:
    event
  • Report Name:
    Chapter Completes
  • Context Data:
    (a.media.chapter.
    complete)
  • Data Feed:
    N/A
  • Audience Manager:
    (c_contextdata.
    a.media.chapter.
    complete)
  • XDM Field Path:
    media.mediaTimed.mediaChapter.
    completes.value
  • Reporting XDM Field Path:
    mediaReporting.chapterDetails.isCompleted

Chapter Time Spent

Implementation
Network Parameters
Reporting
  • SDK Key:
    Automatically set
  • API Key:
    N/A
  • Required:
    Yes
  • Type:
    number
  • Sent with:
    Chapter Close
  • Min. SDK Version: 1.3
  • Sample Value:
  • Description:
    The time spent on the chapter. The value will be displayed in the time format (HH:MM:SS) in Analysis Workspace and Reports & Analytics. In Data Feeds, Data Warehouse, and Reporting APIs the values will be displayed in seconds.
    Release Date: 09/13/18
  • Adobe Analytics:
    (a.media.chapter.
    timePlayed)
  • Heartbeat:
  • Available:
    Yes
  • Reserved Variable:
    event
  • Report Name:
    Chapter Time Spent
  • Context Data:
    (a.media.chapter.
    timePlayed)
  • Data Feed:
    N/A
  • Audience Manager:
    (c_contextdata.
    a.media.chapter.
    timePlayed)
  • XDM Field Path:
    media.mediaTimed.mediaChapter.
    timePlayed.value
  • Reporting XDM Field Path:
    mediaReporting.chapterDetails.timePlayed
recommendation-more-help
c8eee520-cef5-4f8c-a38a-d4952cfae4eb