Indicateur de média téléchargé

Cette page couvre la collecte de données pour la variable indicateur téléchargé par Media. Voir Média téléchargé pour la dimension de rapport correspondante.

L’indicateur média téléchargé indique qu’une session est une lecture de contenu hors ligne précédemment téléchargé plutôt qu’un flux en direct depuis Internet. Définissez-le lors de l’initialisation du dispositif de suivi (Mobile SDK) ou incluez-le dans la payload sessionStart (API Edge / Media Collection). Utilisez cet indicateur pour séparer la lecture hors ligne des sessions en flux continu dans les rapports.

Propriété
Valeur
Variable de données contextuelles
a.media.downloaded
champ de collection XDM
xdm.mediaCollection.sessionDetails.isDownloaded
Caractéristique
c_contextdata.a.media.downloaded
Obligatoire
Non
Envoyé avec
Début de session, fermeture de session

Types d’implémentation recommandés

SDK Web

Définissez isDownloaded à true dans xdm.mediaCollection.sessionDetails lors de l’appel de sendEvent :

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

Définissez l’indicateur de contenu téléchargé sur la configuration du dispositif de suivi lors de la création du dispositif de suivi, à l’aide de 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

Définissez l’indicateur de contenu téléchargé sur la configuration du dispositif de suivi lors de la création du dispositif de suivi, à l’aide de 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

Définissez isDownloaded à true dans xdm.mediaCollection.sessionDetails lors de l’appel de createMediaSession :

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
        }
    }
})
API Media Edge

Appelez le point d’entrée téléchargé après le retour en ligne de l’appareil, ce qui met en lot la session hors ligne complète dans mediaDownloadedEvents. Adobe définit automatiquement le isDownloaded sur true et attribue un ID de session ; n’incluez aucun des deux dans la payload.

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

Types d’implémentation hérités (Analytics uniquement)

Media SDK JS 3.x

Définissez downloadedContent sur ADB.MediaConfig avant de créer le dispositif de suivi :

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

Définissez MediaDownloaded sur l’objet d’informations sur le média avant d’appeler trackSessionStart :

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);
API Media Collection

Incluez media.downloaded dans l’objet params de votre sessionStart requête POST :

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

Consultez la référence des sessions de l’API Media Collection pour obtenir la structure complète des requêtes.

recommendation-more-help
media-analytics-help