Début de la session

L’événement de début de session ouvre une session de suivi multimédia. Il doit s’agir du premier événement envoyé pour toute lecture. La réponse renvoie un ID de session que tous les événements suivants d’une même session doivent inclure.

Une session expire automatiquement si aucun événement n’est reçu pendant 10 minutes ou s’il n’y a aucun mouvement du curseur de lecture pendant 30 minutes. Si une session expire, vous devez appeler à nouveau le démarrage de la session pour obtenir un nouvel ID de session.

  • Conditions préalables : aucun ; toujours le premier événement
  • Mesure associée : Le média commence

Types d’implémentation recommandés

SDK Web

Appelez sendEvent avec les eventType: "media.sessionStart" et les sessionDetails requises. La réponse inclut l’ID de session dans handle[].payload[].sessionId (type media-analytics:new-session). Stockez cette valeur et transmettez-la comme sessionID dans tous les événements suivants.

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"
      },
      playhead: 0
    }
  }
});
iOS

Appelez trackSessionStart avec un objet média et des métadonnées facultatives.

code language-swift
let mediaObject = Media.createMediaObjectWith(name: "video-123",
                                               id: "video-id-123",
                                           length: 128,
                                       streamType: MediaConstants.StreamType.VOD,
                                        mediaType: MediaType.Video)

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

Appelez trackSessionStart avec un objet média et des métadonnées facultatives.

code language-kotlin
val mediaObject = Media.createMediaObject("video-123",
                                          "video-id-123",
                                          128,
                                          MediaConstants.StreamType.VOD,
                                          Media.MediaType.Video)

tracker.trackSessionStart(mediaObject, null)
Roku

Appelez createMediaSession avec les détails de session requis :

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"
            },
            "playhead": 0
        }
    }
})
API Media Edge

Appelez le point d’entrée sessionStart. La réponse inclut l’ID de session dans handle[].payload[].sessionId (type media-analytics:new-session).

code language-sh
curl -X POST "https://edge.adobedc.net/ee/va/v1/sessionStart?configId={datastreamID}" \
--header 'Content-Type: application/json' \
--data '{
  "events": [{
    "xdm": {
      "eventType": "media.sessionStart",
      "mediaCollection": {
        "sessionDetails": {
          "name": "video-123",
          "playerName": "HTML5 Player",
          "contentType": "VOD",
          "length": 128,
          "channel": "Sports"
        },
        "playhead": 0
      }
    }
  }]
}'

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

Media SDK JS 3.x

Appelez trackSessionStart avec un objet média créé à l’aide de ADB.Media.createMediaObject :

code language-javascript
var mediaObject = ADB.Media.createMediaObject(
  "video-123",                  // name
  "video-id-123",               // media ID
  128,                          // length (seconds)
  ADB.Media.StreamType.VOD,     // stream type
  ADB.Media.MediaType.Video     // media type
);

tracker.trackSessionStart(mediaObject, null);
Chromecast

Appelez trackSessionStart avec un objet média créé à l’aide de ADBMobile.media.createMediaObject :

code language-javascript
var mediaInfo = ADBMobile.media.createMediaObject(
  "video-123",                        // name
  "video-id-123",                     // media ID
  128,                                // length (seconds)
  ADBMobile.media.StreamType.VOD,
  ADBMobile.media.MediaType.Video
);

ADBMobile.media.trackSessionStart(mediaInfo, null);
API Media Collection

Envoyez une sessionStart POST au point d’entrée sessions. L’en-tête du Location de réponse contient l’ID de session à utiliser dans toutes les requêtes d’événement ultérieures.

code language-json
{
  "playerTime": { "playhead": 0, "ts": 1699523820000 },
  "eventType": "sessionStart",
  "params": {
    "media.channel": "Sports",
    "media.playerName": "HTML5 Player",
    "media.contentType": "vod",
    "media.length": 128,
    "media.id": "video-123"
  }
}

Reprise d’une session

Lors de la reprise d’une session précédemment fermée (par exemple, après un transfert entre appareils ou après la restauration de l’état de lecture enregistré par l’application), définissez l’indicateur de reprise au début de la session. Analytics incrémente ainsi les reprises de contenu plutôt que les démarrages de média.

Types d’implémentation recommandés

SDK Web

Ajouter des hasResume: true à sessionDetails :

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",
        hasResume: true
      },
      playhead: 0
    }
  }
});
iOS

Définissez la clé resumed sur l’objet média avant d’appeler trackSessionStart :

code language-swift
var mediaObject = Media.createMediaObjectWith(name: "video-123",
                                               id: "video-id-123",
                                           length: 128,
                                       streamType: MediaConstants.StreamType.VOD,
                                        mediaType: MediaType.Video)

mediaObject[MediaConstants.MediaObjectKey.resumed] = true
tracker.trackSessionStart(info: mediaObject, metadata: nil)
Android

Définissez la clé RESUMED sur l’objet média avant d’appeler trackSessionStart :

code language-kotlin
val mediaObject = Media.createMediaObject("video-123", "video-id-123", 128,
                                          MediaConstants.StreamType.VOD,
                                          Media.MediaType.Video)

mediaObject[Media.MediaObjectKey.RESUMED] = true
tracker.trackSessionStart(mediaObject, null)
Roku

Ajouter des "hasResume": true à sessionDetails :

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",
                "hasResume": true
            },
            "playhead": 0
        }
    }
})
API Media Edge

Ajouter des "hasResume": true à sessionDetails :

code language-sh
curl -X POST "https://edge.adobedc.net/ee/va/v1/sessionStart?configId={datastreamID}" \
--header 'Content-Type: application/json' \
--data '{
  "events": [{
    "xdm": {
      "eventType": "media.sessionStart",
      "mediaCollection": {
        "sessionDetails": {
          "name": "video-123",
          "playerName": "HTML5 Player",
          "contentType": "VOD",
          "length": 128,
          "channel": "Sports",
          "hasResume": true
        },
        "playhead": 0
      }
    }
  }]
}'

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

Media SDK JS 3.x

Définissez la clé MediaResumed sur l’objet média :

code language-javascript
var mediaObject = ADB.Media.createMediaObject(
  "video-123", "video-id-123", 128,
  ADB.Media.StreamType.VOD, ADB.Media.MediaType.Video
);

mediaObject[ADB.Media.MediaObjectKey.MediaResumed] = true;
tracker.trackSessionStart(mediaObject, null);
Chromecast

Définissez la clé MediaResumed sur l’objet média :

code language-javascript
var mediaObject = ADBMobile.media.createMediaObject(
  "video-123", "video-id-123", 128,
  ADBMobile.media.StreamType.VOD, ADBMobile.media.MediaType.Video
);

mediaObject[ADBMobile.media.MediaObjectKey.MediaResumed] = true;
ADBMobile.media.trackSessionStart(mediaObject, null);
API Media Collection

Ajoutez des "media.resume": true à l’objet params :

code language-json
{
  "playerTime": { "playhead": 0, "ts": 1699523820000 },
  "eventType": "sessionStart",
  "params": {
    "media.channel": "Sports",
    "media.playerName": "HTML5 Player",
    "media.contentType": "vod",
    "media.length": 128,
    "media.id": "video-123",
    "media.resume": true
  }
}
recommendation-more-help
media-analytics-help