アプリバージョン

このページでは、アプリ バージョン​変数のデータ収集について説明します。 対応するレポートディメンションについては、​ アプリバージョン ​を参照してください。

アプリのバージョン変数は、メディアプレーヤーアプリケーションのバージョンを識別します。 SDKの初期化中に1回設定します。この値は、以降のすべてのセッション開始リクエストに自動的に含まれます。 アプリケーションのリリースサイクルに一致するバージョン文字列を使用します(例:"2.1.0"または"prod-YYYY-03-15")。

NOTE
このフィールドは、AdobeのSDK ライブラリではなく、media player アプリケーション​のバージョンをキャプチャします。 Adobe独自のSDK ライブラリバージョンは、個別の内部フィールドとして自動的に収集されます。
プロパティ
XDM コレクションフィールド
xdm.mediaCollection.sessionDetails.appVersion
Media Collection API パラメーター
media.sdkVersion
必須
いいえ
様が​様と共に送信されました
​ セッション開始

推奨される実装タイプ

Web SDK

configureの呼び出し時にstreamingMedia設定オブジェクトにappVersionを設定します:

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

メディアトラッカーを初期化する前に、アプリ設定でedgeMedia.appVersionを設定します。

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

メディアトラッカーを初期化する前に、アプリ設定でedgeMedia.appVersionを設定します。

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

ADB_CONSTANTS.CONFIGURATION.MEDIA_APP_VERSIONを使用して、SDK設定でアプリのバージョンを設定します。

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

sessionStart要求のsessionDetails オブジェクトにappVersionを含めます:

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
      }
    }
  }]
}

従来の実装タイプ (Analyticsのみ)

Media SDK JS 3.x

ADB.Media.configureを呼び出す前に、MediaConfig オブジェクトにappVersionを設定します:

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

ADBMobile設定のmediaHeartbeat セクションでsdkVersionを設定します。 このフィールドは、Chromecast SDK ライブラリのバージョンではなく、Player アプリケーションのバージョンをキャプチャします。

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

sessionStart POST リクエストのparams オブジェクトにmedia.sdkVersionを含めます:

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"
  }
}

完全なリクエスト構造については、Media Collection API セッションのリファレンス ​を参照してください。

recommendation-more-help
media-analytics-help