MVPD

This page covers data collection for the MVPD variable. See MVPD for the corresponding reporting dimension.

The MVPD (multichannel video programming distributor) variable is the cable, satellite, or virtual-MVPD provider through which the user authenticated (for example, "Comcast", "DirecTV", or "YouTubeTV"). Set it when content is gated behind Adobe Pass or TV-Everywhere authentication. Pair with Authorized to track which sessions completed authentication.

Property
Value
Context data variable
a.media.pass.mvpd
XDM collection field
mediaCollection.sessionDetails.mvpd
Audience Manager trait
c_contextdata.a.media.pass.mvpd
Required
No
Sent with
Session start, session close

Web SDK

Set mvpd inside mediaCollection.sessionDetails when calling sendEvent:

alloy("sendEvent", {
  xdm: {
    eventType: "media.sessionStart",
    mediaCollection: {
      sessionDetails: {
        mvpd: "Comcast"
      },
      playhead: 0
    }
  }
});

Mobile SDK

Pass the MVPD as a metadata key in the HashMap argument to trackSessionStart. Use MediaConstants.VideoMetadataKeys.MVPD.

iOS (Swift)

var metadata: [String: String] = [:]
metadata[MediaConstants.VideoMetadataKeys.MVPD] = "Comcast"

tracker.trackSessionStart(info: mediaObject, metadata: metadata)

Android (Kotlin)

val metadata = HashMap<String, String>()
metadata[MediaConstants.VideoMetadataKeys.MVPD] = "Comcast"

tracker.trackSessionStart(mediaInfo, metadata)

Roku (BrightScript)

Use createMediaSession to set mvpd inside sessionDetails:

m.aepSdk.createMediaSession({
    "xdm": {
        "eventType": "media.sessionStart",
        "mediaCollection": {
            "sessionDetails": {
                "mvpd": "Comcast"
            },
            "playhead": 0
        }
    }
})

Media Edge API

Call the sessionStart endpoint with mvpd inside mediaCollection.sessionDetails:

{
  "events": [{
    "xdm": {
      "eventType": "media.sessionStart",
      "mediaCollection": {
        "sessionDetails": {
          "name": "video-123",
          "length": 128,
          "contentType": "vod",
          "playerName": "HTML5 Player",
          "channel": "Sports",
          "mvpd": "Comcast"
        },
        "playhead": 0
      }
    }
  }]
}

Media SDK

Pass the MVPD in the contextData object using ADB.Media.VideoMetadataKeys.MVPD:

var contextData = {};
contextData[ADB.Media.VideoMetadataKeys.MVPD] = "Comcast";

tracker.trackSessionStart(mediaInfo, contextData);

Media Collection API

Include media.pass.mvpd in the params object:

{
  "playerTime": { "playhead": 0, "ts": 1699523820000 },
  "eventType": "sessionStart",
  "params": {
    "media.pass.mvpd": "Comcast"
  }
}

See the Media Collection API sessions reference for the full request structure.

recommendation-more-help
media-analytics-help