メディアのダウンロード済みフラグ

このページでは、メディア ダウンロード フラグ​変数のデータ収集について説明します。 対応するレポートディメンションについては、​ ダウンロードされたメディア ​を参照してください。

メディアダウンロード済みフラグは、セッションが、インターネットからのライブストリームではなく、以前にダウンロードしたオフラインコンテンツの再生であることを示します。 トラッカー(モバイル SDK)を初期化する際に設定するか、sessionStart ペイロード(Edge / Media Collection API)に含めます。 このフラグを使用すると、レポートでストリーミングセッションからオフライン再生を分離できます。

プロパティ
コンテキストデータ変数
a.media.downloaded
XDM コレクションフィールド
xdm.mediaCollection.sessionDetails.isDownloaded
Audience Manager特性
c_contextdata.a.media.downloaded
必須
いいえ
様が​様と共に送信されました
​ セッション開始、セッション終了

推奨される実装タイプ

Web SDK

sendEventの呼び出し時にxdm.mediaCollection.sessionDetails内のisDownloadedtrueに設定:

code language-javascript
alloy("sendEvent", {
  xdm: {
    eventType: "media.sessionStart",
    mediaCollection: {
      sessionDetails: {
        name: "video-123",
        length: 128,
        contentType: "vod",
        playerName: "HTML5 Player",
        channel: "Sports",
        streamType: "video",
        isDownloaded: true
      },
      playhead: 0
    }
  }
});
iOS

MediaConstants.TrackerConfig.DOWNLOADED_CONTENTを使用してトラッカーを作成する際に、トラッカー設定でダウンロード済みコンテンツ フラグを設定します。

code language-swift
var config: [String: Any] = [:]
config[MediaConstants.TrackerConfig.PLAYER_NAME] = "HTML5 Player"
config[MediaConstants.TrackerConfig.CHANNEL] = "Sports"
config[MediaConstants.TrackerConfig.DOWNLOADED_CONTENT] = true

Media.createTrackerWith(config: config) { tracker in
    self.tracker = tracker
}
Android

MediaConstants.TrackerConfig.DOWNLOADED_CONTENTを使用してトラッカーを作成する際に、トラッカー設定でダウンロード済みコンテンツ フラグを設定します。

code language-kotlin
val config = HashMap<String, Any>()
config[MediaConstants.TrackerConfig.PLAYER_NAME] = "HTML5 Player"
config[MediaConstants.TrackerConfig.CHANNEL] = "Sports"
config[MediaConstants.TrackerConfig.DOWNLOADED_CONTENT] = true

val tracker = Media.createTracker(config)
Roku

createMediaSessionの呼び出し時にxdm.mediaCollection.sessionDetails内のisDownloadedtrueに設定:

code language-brightscript
m.aepSdk.createMediaSession({
    "xdm": {
        "eventType": "media.sessionStart",
        "mediaCollection": {
            "sessionDetails": {
                "name": "video-123",
                "length": 128,
                "contentType": "vod",
                "playerName": "Roku Player",
                "channel": "Sports",
                "streamType": "video",
                "isDownloaded": true
            },
            "playhead": 0
        }
    }
})
Media Edge API

デバイスがオンラインに戻った後、​ ダウンロード済み エンドポイントを呼び出し、mediaDownloadedEvents内で完全なオフラインセッションをバッチ処理します。 Adobeは自動的にisDownloadedtrueに設定し、セッション IDを割り当てます。ペイロードに含めないでください。

code language-json
{
  "events": [{
    "xdm": {
      "eventType": "media.downloaded",
      "mediaDownloadedEvents": [
        {
          "mediaEventTimestamp": "YYYY-09-26T15:52:24+00:00",
          "mediaEventType": "media.sessionStart",
          "mediaCollection": {
            "sessionDetails": {
              "name": "video-123",
              "length": 128,
              "contentType": "vod",
              "playerName": "HTML5 Player",
              "channel": "Sports"
            },
            "playhead": 0
          }
        },
        {
          "mediaEventTimestamp": "YYYY-09-26T15:54:32+00:00",
          "mediaEventType": "media.sessionComplete",
          "mediaCollection": {
            "playhead": 128
          }
        }
      ]
    }
  }]
}

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

Media SDK JS 3.x

トラッカーを作成する前に、ADB.MediaConfigdownloadedContentを設定します:

code language-javascript
var mediaConfig = new ADB.MediaConfig();
mediaConfig.trackingServer = "your.tracking.server";
mediaConfig.playerName = "HTML5 Player";
mediaConfig.channel = "Sports";
mediaConfig.downloadedContent = true;

var tracker = ADB.Media.getInstance(mediaConfig);
Chromecast

trackSessionStartを呼び出す前に、メディア情報オブジェクトにMediaDownloadedを設定します:

code language-javascript
var mediaInfo = ADBMobile.media.createMediaObject("My Video", "video-123", 128,
  ADBMobile.media.StreamType.VOD, ADBMobile.media.MediaType.Video);
mediaInfo[ADBMobile.media.MediaObjectKey.MediaDownloaded] = true;
ADBMobile.media.trackSessionStart(mediaInfo, null);
Media Collection API

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

code language-json
{
  "playerTime": { "playhead": 0, "ts": 1699523820000 },
  "eventType": "sessionStart",
  "params": {
    "media.downloaded": true
  }
}

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

recommendation-more-help
media-analytics-help