sessiondetails.schema.md

Session details information Schema

https://ns.adobe.com/xdm/datatypes/sessionDetails

Session details information.

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	Yes	Experimental	No	Forbidden	Permitted	datatypes/sessiondetails.schema.json

Session details information Example

{
  "xdm:ID": "1482236761294786918253",
  "xdm:name": "123456789",
  "xdm:length": 100,
  "xdm:contentType": "VOD",
  "xdm:playerName": "playerName",
  "xdm:channel": "channel"
}

Session details information Properties

Property	Type	Required	Defined by
xdm:ID	string	Optional	Session details information (this schema)
xdm:adCount	integer	Optional	Session details information (this schema)
xdm:adLoad	string	Optional	Session details information (this schema)
xdm:album	string	Optional	Session details information (this schema)
xdm:appVersion	string	Optional	Session details information (this schema)
xdm:artist	string	Optional	Session details information (this schema)
xdm:assetID	string	Optional	Session details information (this schema)
xdm:author	string	Optional	Session details information (this schema)
xdm:averageMinuteAudience	number	Optional	Session details information (this schema)
xdm:channel	string	Optional	Session details information (this schema)
xdm:chapterCount	integer	Optional	Session details information (this schema)
xdm:contentType	string	Optional	Session details information (this schema)
xdm:dayPart	string	Optional	Session details information (this schema)
xdm:episode	integer	Optional	Session details information (this schema)
xdm:estimatedStreams	number	Optional	Session details information (this schema)
xdm:feed	string	Optional	Session details information (this schema)
xdm:firstAirDate	string	Optional	Session details information (this schema)
xdm:firstDigitalDate	string	Optional	Session details information (this schema)
xdm:friendlyName	string	Optional	Session details information (this schema)
xdm:genre	string	Optional	Session details information (this schema)
xdm:hasPauseImpactedStreams	boolean	Optional	Session details information (this schema)
xdm:hasProgress10	boolean	Optional	Session details information (this schema)
xdm:hasProgress25	boolean	Optional	Session details information (this schema)
xdm:hasProgress50	boolean	Optional	Session details information (this schema)
xdm:hasProgress75	boolean	Optional	Session details information (this schema)
xdm:hasProgress95	boolean	Optional	Session details information (this schema)
xdm:hasResume	boolean	Optional	Session details information (this schema)
xdm:hasSegmentView	boolean	Optional	Session details information (this schema)
xdm:isAuthorized	boolean	Optional	Session details information (this schema)
xdm:isCompleted	boolean	Optional	Session details information (this schema)
xdm:isDownloaded	boolean	Optional	Session details information (this schema)
xdm:isFederated	boolean	Optional	Session details information (this schema)
xdm:isPlayed	boolean	Optional	Session details information (this schema)
xdm:isViewed	boolean	Optional	Session details information (this schema)
xdm:label	string	Optional	Session details information (this schema)
xdm:length	integer	Optional	Session details information (this schema)
xdm:mvpd	string	Optional	Session details information (this schema)
xdm:name	string	Optional	Session details information (this schema)
xdm:network	string	Optional	Session details information (this schema)
xdm:originator	string	Optional	Session details information (this schema)
xdm:pauseCount	integer	Optional	Session details information (this schema)
xdm:pauseTime	integer	Optional	Session details information (this schema)
xdm:playerName	string	Optional	Session details information (this schema)
xdm:publisher	string	Optional	Session details information (this schema)
xdm:rating	string	Optional	Session details information (this schema)
xdm:season	integer	Optional	Session details information (this schema)
xdm:secondsSinceLastCall	number	Optional	Session details information (this schema)
xdm:segment	string	Optional	Session details information (this schema)
xdm:show	string	Optional	Session details information (this schema)
xdm:showType	string	Optional	Session details information (this schema)
xdm:station	string	Optional	Session details information (this schema)
xdm:streamFormat	string	Optional	Session details information (this schema)
xdm:streamType	enum	Optional	Session details information (this schema)
xdm:timePlayed	integer	Optional	Session details information (this schema)
xdm:totalTimePlayed	integer	Optional	Session details information (this schema)
xdm:uniqueTimePlayed	integer	Optional	Session details information (this schema)
*	any	Additional	this schema allows additional properties

xdm:ID

Media Session ID

This identifies an instance of a content stream unique to an individual playback.

xdm:ID

• is optional
• type: string
• defined in this schema

xdm:ID Type

string

xdm:adCount

Ad Count

The number of ads started during the playback.

xdm:adCount

• is optional
• type: integer
• defined in this schema

xdm:adCount Type

integer

xdm:adLoad

Ad Load Type

The type of ad loaded as defined by each customer's internal representation.

xdm:adLoad

• is optional
• type: string
• defined in this schema

xdm:adLoad Type

string

xdm:album

Album

The name of the album that the music recording or video belongs to.

xdm:album

• is optional
• type: string
• defined in this schema

xdm:album Type

string

xdm:appVersion

Version

The SDK version used by the player. This could have any custom value that makes sense for your player.

xdm:appVersion

• is optional
• type: string
• defined in this schema

xdm:appVersion Type

string

xdm:artist

Artist

The name of the album artist or group performing the music recording or video.

xdm:artist

• is optional
• type: string
• defined in this schema

xdm:artist Type

string

xdm:assetID

Asset ID

This is the unique identifier for the content of the media asset, such as the TV series episode identifier, movie asset identifier, or live event identifier. Typically these IDs are derived from metadata authorities such as EIDR, TMS/Gracenote, or Rovi. These identifiers can also be from other proprietary or in-house systems.

xdm:assetID

• is optional
• type: string
• defined in this schema

xdm:assetID Type

string

xdm:author

Author

Name of the media author.

xdm:author

• is optional
• type: string
• defined in this schema

xdm:author Type

string

xdm:averageMinuteAudience

Average Minute Audience

Describes the average content time spent for a specific media item - i.e. the total content time spent divided by the length for all of the playback sessions.

xdm:averageMinuteAudience

• is optional
• type: number
• defined in this schema

xdm:averageMinuteAudience Type

number

xdm:channel

Content Channel

Distribution channel from where the content was played.

xdm:channel

• is optional
• type: string
• defined in this schema

xdm:channel Type

string

xdm:chapterCount

Chapter Count

The number of chapters started during the playback.

xdm:chapterCount

• is optional
• type: integer
• defined in this schema

xdm:chapterCount Type

integer

xdm:contentType

Broadcast Content Type

The type of the stream delivery. Available values per Stream Type: Audio: “song”, “podcast”, “audiobook”, “radio”; Video: “VoD”, “Live”, “Linear”, “UGC”, “DVoD”. Customers can provide custom values for this parameter.

xdm:contentType

• is optional
• type: string
• defined in this schema

xdm:contentType Type

string

xdm:contentType Known Values

Value	Description
VOD	Video-on-demand
Live	Live streaming
Linear	Linear playback of the media asset
UGC	User-generated content
DVOD	Downloaded video-on-demand
Radio	Radio show
Podcast	Audio podcast
Audiobook	Audiobook
Song	Song

xdm:dayPart

Day Part

A property that defines the time of the day when the content was broadcast or played. This could have any value set as necessary by customers.

xdm:dayPart

• is optional
• type: string
• defined in this schema

xdm:dayPart Type

string

xdm:episode

Episode Number

The number of the episode.

xdm:episode

• is optional
• type: integer
• defined in this schema

xdm:episode Type

integer

• minimum value: 0

xdm:estimatedStreams

Estimated Streams

The estimated number of video or audio streams per each individual content.

xdm:estimatedStreams

• is optional
• type: number
• defined in this schema

xdm:estimatedStreams Type

number

xdm:feed

Feed Type

The type of feed, which can either represent actual feed-related data such as EAST HD or SD, or the source of the feed like a URL.

xdm:feed

• is optional
• type: string
• defined in this schema

xdm:feed Type

string

xdm:firstAirDate

First Air Date

The date when the content first aired on television. Any date format is acceptable, but Adobe recommends: YYYY-MM-DD.

xdm:firstAirDate

• is optional
• type: string
• defined in this schema

xdm:firstAirDate Type

string

xdm:firstDigitalDate

First Digital Date

The date when the content first aired on any digital channel or platform. Any date format is acceptable but Adobe recommends: YYYY-MM-DD.

xdm:firstDigitalDate

• is optional
• type: string
• defined in this schema

xdm:firstDigitalDate Type

string

xdm:friendlyName

Content Name

This is the “friendly” (human-readable) name of the content.

xdm:friendlyName

• is optional
• type: string
• defined in this schema

xdm:friendlyName Type

string

xdm:genre

Genre

Type or grouping of content as defined by content producer. Values should be comma delimited in variable implementation.

xdm:genre

• is optional
• type: string
• defined in this schema

xdm:genre Type

string

xdm:hasPauseImpactedStreams

Pause Impacted Streams

Indicates if one or more pauses occurred during the playback of a single media item.

xdm:hasPauseImpactedStreams

• is optional
• type: boolean
• defined in this schema

xdm:hasPauseImpactedStreams Type

boolean

xdm:hasProgress10

10% Progress Marker

Indicates that the playhead passed the 10% marker of media based on stream length. The marker is only counted once, even if seeking backwards. If seeking forward, markers that are skipped are not counted.

xdm:hasProgress10

• is optional
• type: boolean
• defined in this schema

xdm:hasProgress10 Type

boolean

xdm:hasProgress25

25% Progress Marker

Indicates that the playhead passed the 25% marker of media based on stream length. Marker only counted once, even if seeking backwards. If seeking forward, markers that are skipped are not counted.

xdm:hasProgress25

• is optional
• type: boolean
• defined in this schema

xdm:hasProgress25 Type

boolean

xdm:hasProgress50

50% Progress Marker

Indicates that the playhead passed the 50% marker of media based on stream length. Marker only counted once, even if seeking backwards. If seeking forward, markers that are skipped are not counted.

xdm:hasProgress50

• is optional
• type: boolean
• defined in this schema

xdm:hasProgress50 Type

boolean

xdm:hasProgress75

75% Progress Marker

Indicates that the playhead passed the 75% marker of media based on stream length. Marker only counted once, even if seeking backwards. If seeking forward, markers that are skipped are not counted.

xdm:hasProgress75

• is optional
• type: boolean
• defined in this schema

xdm:hasProgress75 Type

boolean

xdm:hasProgress95

95% Progress Marker

Indicates that the playhead passed the 95% marker of media based on stream length. Marker only counted once, even if seeking backwards. If seeking forward, markers that are skipped are not counted.

xdm:hasProgress95

• is optional
• type: boolean
• defined in this schema

xdm:hasProgress95 Type

boolean

xdm:hasResume

Resume

Marks each playback that was resumed after more than 30 minutes of buffer, pause, or stall period.

xdm:hasResume

• is optional
• type: boolean
• defined in this schema

xdm:hasResume Type

boolean

xdm:hasSegmentView

Media Segment Views

Indicates when at least one frame, not necessarily the first has been viewed.

xdm:hasSegmentView

• is optional
• type: boolean
• defined in this schema

xdm:hasSegmentView Type

boolean

xdm:isAuthorized

Media Authorized

The user has been authorized via Adobe authentication.

xdm:isAuthorized

• is optional
• type: boolean
• defined in this schema

xdm:isAuthorized Type

boolean

xdm:isCompleted

Content Completes

Indicates if a timed media asset was watched to completion, this does not necessarily mean the viewer watched the whole video; viewer could have skipped ahead.

xdm:isCompleted

• is optional
• type: boolean
• defined in this schema

xdm:isCompleted Type

boolean

xdm:isDownloaded

Media Downloaded Flag

The stream was played locally on the device after being downloaded.

xdm:isDownloaded

• is optional
• type: boolean
• defined in this schema

xdm:isDownloaded Type

boolean

xdm:isFederated

Federated Data

Set to true when the hit is federated (i.e., received by the customer as part of a federated data share, rather than their own implementation).

xdm:isFederated

• is optional
• type: boolean
• defined in this schema

xdm:isFederated Type

boolean

xdm:isPlayed

Content Starts

First frame of media is consumed. If the user drops during ad, buffering, etc., then there would be no “Content Start” event.

xdm:isPlayed

• is optional
• type: boolean
• defined in this schema

xdm:isPlayed Type

boolean

xdm:isViewed

Media Starts

Load event for the media. (This occurs when the viewer clicks the Play button). This would count even if there are pre-roll ads, buffering, errors, and so on.

xdm:isViewed

• is optional
• type: boolean
• defined in this schema

xdm:isViewed Type

boolean

xdm:label

Record Label

Name of the record label.

xdm:label

• is optional
• type: string
• defined in this schema

xdm:label Type

string

xdm:length

Media Content Length

Clip Length/Runtime - This is the maximum length (or duration) of the content being consumed (in seconds).

xdm:length

• is optional
• type: integer
• defined in this schema

xdm:length Type

integer

xdm:mvpd

MVPD Identifier

MVPD provided via Adobe authentication.

xdm:mvpd

• is optional
• type: string
• defined in this schema

xdm:mvpd Type

string

xdm:name

Content ID

Content ID of the content, which can be used to tie back to other industry / CMS IDs.

xdm:name

• is optional
• type: string
• defined in this schema

xdm:name Type

string

All instances must conform to this regular expression (test examples here):

^.{1,}$

xdm:network

Broadcast Network

The network/channel name.

xdm:network

• is optional
• type: string
• defined in this schema

xdm:network Type

string

xdm:originator

Creator Name

Creator of the content.

xdm:originator

• is optional
• type: string
• defined in this schema

xdm:originator Type

string

xdm:pauseCount

Pause Events

The number of pause periods that occurred during playback.

xdm:pauseCount

• is optional
• type: integer
• defined in this schema

xdm:pauseCount Type

integer

xdm:pauseTime

Total Pause Duration

Describes the duration in seconds in which playback was paused by the user.

xdm:pauseTime

• is optional
• type: integer
• defined in this schema

xdm:pauseTime Type

integer

xdm:playerName

Content Player Name

Name of the content player.

xdm:playerName

• is optional
• type: string
• defined in this schema

xdm:playerName Type

string

xdm:publisher

Publisher

Name of the audio content publisher.

xdm:publisher

• is optional
• type: string
• defined in this schema

xdm:publisher Type

string

xdm:rating

Rating Value

Rating as defined by TV Parental Guidelines.

xdm:rating

• is optional
• type: string
• defined in this schema

xdm:rating Type

string

xdm:season

Season Number

The season number the show belongs to. Season Series is required only if the show is part of a series.

xdm:season

• is optional
• type: integer
• defined in this schema

xdm:season Type

integer

• minimum value: 0

xdm:secondsSinceLastCall

Media Session Server Timeout

Indicates the amount of time, in seconds, that passed between the user's last known interaction and the moment the session was closed.

xdm:secondsSinceLastCall

• is optional
• type: number
• defined in this schema

xdm:secondsSinceLastCall Type

number

xdm:segment

Video Segment

The interval that describes the part of the content that has been viewed in minutes.

xdm:segment

• is optional
• type: string
• defined in this schema

xdm:segment Type

string

xdm:show

Series Name

Program/Series Name. Program Name is required only if the show is part of a series.

xdm:show

• is optional
• type: string
• defined in this schema

xdm:show Type

string

xdm:showType

Show Type

The type of content for example, trailer or full episode.

xdm:showType

• is optional
• type: string
• defined in this schema

xdm:showType Type

string

xdm:station

Radio Station

The radio station name on which the audio is played.

xdm:station

• is optional
• type: string
• defined in this schema

xdm:station Type

string

xdm:streamFormat

Stream Format

Format of the stream (HD, SD).

xdm:streamFormat

• is optional
• type: string
• defined in this schema

xdm:streamFormat Type

string

xdm:streamType

Stream Type

The type of the media stream.

xdm:streamType

• is optional
• type: enum
• defined in this schema

The value of this property must be equal to one of the known values below.

xdm:streamType Known Values

Value	Description
video	Video
audio	Audio

xdm:timePlayed

Content Time Spent

Sums the event duration (in seconds) for all events of type PLAY on the main content.

xdm:timePlayed

• is optional
• type: integer
• defined in this schema

xdm:timePlayed Type

integer

xdm:totalTimePlayed

Media Time Spent

Describes the total amount of time spent by a user on a specific timed media asset, which includes time spent watching ads.

xdm:totalTimePlayed

• is optional
• type: integer
• defined in this schema

xdm:totalTimePlayed Type

integer

xdm:uniqueTimePlayed

Unique Time Played

Describes the sum of the unique intervals seen by a user on a timed media asset - i.e. the length playback intervals viewed multiple times are only counted once.

xdm:uniqueTimePlayed

• is optional
• type: integer
• defined in this schema

xdm:uniqueTimePlayed Type

integer