First digital date

This page covers data collection for the First digital date variable. See First digital date for the corresponding reporting dimension.

The first digital date variable is the date the content first aired on any digital platform. Any date format is accepted but Adobe recommends YYYY-MM-DD for consistency. Use alongside First air date to compare digital release timing with original broadcast.

Web SDK

Set firstDigitalDate inside mediaCollection.sessionDetails when calling sendEvent:

alloy("sendEvent", {
  xdm: {
    eventType: "media.sessionStart",
    mediaCollection: {
      sessionDetails: {
        firstDigitalDate: "2016-01-25"
      },
      playhead: 0
    }
  }
});

Mobile SDK

Pass the first digital date as a metadata key in the HashMap argument to trackSessionStart. Use MediaConstants.VideoMetadataKeys.FIRST_DIGITAL_DATE.

iOS (Swift)

var metadata: [String: String] = [:]
metadata[MediaConstants.VideoMetadataKeys.FIRST_DIGITAL_DATE] = "2016-01-25"

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

Android (Kotlin)

val metadata = HashMap<String, String>()
metadata[MediaConstants.VideoMetadataKeys.FIRST_DIGITAL_DATE] = "2016-01-25"

tracker.trackSessionStart(mediaInfo, metadata)

Roku (BrightScript)

Use createMediaSession to set firstDigitalDate inside sessionDetails:

m.aepSdk.createMediaSession({
    "xdm": {
        "eventType": "media.sessionStart",
        "mediaCollection": {
            "sessionDetails": {
                "firstDigitalDate": "2016-01-25"
            },
            "playhead": 0
        }
    }
})

Media Edge API

Call the sessionStart endpoint with firstDigitalDate inside mediaCollection.sessionDetails:

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

Media SDK

Pass the first digital date in the contextData object using ADB.Media.VideoMetadataKeys.FirstDigitalDate:

var contextData = {};
contextData[ADB.Media.VideoMetadataKeys.FirstDigitalDate] = "2016-01-25";

tracker.trackSessionStart(mediaInfo, contextData);

Media Collection API

Include media.firstDigitalDate in the params object:

{
  "playerTime": { "playhead": 0, "ts": 1699523820000 },
  "eventType": "sessionStart",
  "params": {
    "media.firstDigitalDate": "2016-01-25"
  }
}

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