DocumentationAnalyticsStreaming media services guide

App version

Last update: June 4, 2026

CREATED FOR:

  • Developer

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

style
shade-box

The app version variable identifies the version of your media player application. Set it once during SDK initialization; the value is automatically included in every subsequent session start request. Use a version string that matches your application’s release cycle (for example, "2.1.0" or "prod-YYYY-03-15").

NOTE
This field captures the version of your media player application, not Adobe’s SDK library. Adobe’s own SDK library version is collected automatically as a separate internal field.
Property
Value
XDM collection field
xdm.mediaCollection.sessionDetails.appVersion
Media Collection API param
media.sdkVersion
Required
No
Sent with
Session start
Web SDK

Set appVersion in the streamingMedia configuration object when calling configure:

code language-javascript 
alloy("configure", {
  streamingMedia: {
    channel: "Sports Channel",
    playerName: "HTML5 Player",
    appVersion: "2.1.0",
    mainPingInterval: 10,
    adPingInterval: 10
  }
});
iOS

Set edgeMedia.appVersion in the app configuration before initializing the media tracker:

code language-swift 
var config: [String: Any] = [:]
config["edgeMedia.channel"] = "sample_channel"
config["edgeMedia.playerName"] = "player_name"
config["edgeMedia.appVersion"] = "2.1.0"
MobileCore.updateConfiguration(config)
Android

Set edgeMedia.appVersion in the app configuration before initializing the media tracker:

code language-kotlin 
val config: Map<String, Any> = mapOf(
    "edgeMedia.channel" to "sample_channel",
    "edgeMedia.playerName" to "player_name",
    "edgeMedia.appVersion" to "2.1.0"
)
MobileCore.updateConfiguration(config)
Roku

Set the app version in the SDK configuration using ADB_CONSTANTS.CONFIGURATION.MEDIA_APP_VERSION:

code language-brightscript 
ADB_CONSTANTS = AdobeAEPSDKConstants()
configuration = {}
configuration[ADB_CONSTANTS.CONFIGURATION.EDGE_CONFIG_ID] = "<YOUR_CONFIG_ID>"
configuration[ADB_CONSTANTS.CONFIGURATION.MEDIA_CHANNEL] = "channel_name"
configuration[ADB_CONSTANTS.CONFIGURATION.MEDIA_PLAYER_NAME] = "player_name"
configuration[ADB_CONSTANTS.CONFIGURATION.MEDIA_APP_VERSION] = "2.1.0"
m.aepSdk.updateConfiguration(configuration)
Media Edge API

Include appVersion in the sessionDetails object of the sessionStart request:

code language-json 
{
  "events": [{
    "xdm": {
      "eventType": "media.sessionStart",
      "mediaCollection": {
        "sessionDetails": {
          "name": "video-123",
          "length": 300,
          "contentType": "vod",
          "playerName": "HTML5 Player",
          "channel": "Sports",
          "appVersion": "2.1.0"
        },
        "playhead": 0
      }
    }
  }]
}

Legacy implementation types (Analytics-only)

Media SDK JS 3.x

Set appVersion on the MediaConfig object before calling ADB.Media.configure:

code language-javascript 
var mediaConfig = new ADB.MediaConfig();
mediaConfig.playerName = "player_name";
mediaConfig.channel = "sample_channel";
mediaConfig.appVersion = "2.1.0";
ADB.Media.configure(mediaConfig, appMeasurement);
Chromecast

Set sdkVersion in the mediaHeartbeat section of the ADBMobile configuration. This field captures your player application version, not the Chromecast SDK library version.

code language-javascript 
var ADBMobileConfig = {
  "mediaHeartbeat": {
    "server": "obumobile5.hb-api.omtrdc.net",
    "publisher": "<YOUR_PUBLISHER_ID>@AdobeOrg",
    "channel": "sample-channel",
    "ssl": true,
    "playerName": "Chromecast Player",
    "sdkVersion": "2.1.0"
  }
};
Media Collection API

Include media.sdkVersion in the params object of your sessionStart POST request:

code language-json 
{
  "playerTime": { "playhead": 0, "ts": 1699523820000 },
  "eventType": "sessionStart",
  "params": {
    "media.playerName": "sample-html5-api-player",
    "media.sdkVersion": "2.1.0",
    "media.channel": "sample-channel"
  }
}

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

recommendation-more-help
media-analytics-help