Inicio de sesión

El evento de inicio de sesión abre una sesión de seguimiento de contenido. Debe ser el primer evento enviado para cualquier reproducción. La respuesta devuelve un ID de sesión que deben incluir todos los eventos subsiguientes de la misma sesión.

Las sesiones caducan automáticamente si no se reciben eventos durante 10 minutos o si no hay movimiento del cabezal de reproducción durante 30 minutos. Si caduca una sesión, debe volver a llamar al inicio de la sesión para obtener un nuevo ID de sesión.

  • Requisitos previos: Ninguno; siempre es el primer evento
  • Métrica asociada: Inicios de medios

Tipos de implementación recomendados

SDK web

Llamar a sendEvent con eventType: "media.sessionStart" y el sessionDetails requerido. La respuesta incluye el identificador de sesión en handle[].payload[].sessionId (tipo media-analytics:new-session). Almacene este valor y páselo como sessionID en todos los eventos posteriores.

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

Llamar a trackSessionStart con un objeto multimedia y metadatos opcionales.

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

Llamar a trackSessionStart con un objeto multimedia y metadatos opcionales.

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

tracker.trackSessionStart(mediaObject, null)
Roku

Llame a createMediaSession con los detalles de sesión requeridos:

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 de Media Edge

Llame al extremo sessionStart. La respuesta incluye el identificador de sesión en handle[].payload[].sessionId (tipo 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
      }
    }
  }]
}'

Tipos de implementación heredados (solo Analytics)

Media SDK JS 3.x

Llamar a trackSessionStart con un objeto multimedia creado con 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

Llamar a trackSessionStart con un objeto multimedia creado con 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 de recopilación de medios

Enviar una PUBLICACIÓN sessionStart al extremo de sesiones. El encabezado de respuesta Location contiene el identificador de sesión que se utilizará en todas las solicitudes de evento subsiguientes.

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

Reanudación de una sesión

Al reanudar una sesión cerrada anteriormente, por ejemplo, después de un traspaso entre dispositivos o después de que la aplicación restaure el estado de reproducción guardada, establezca el indicador de reanudación al inicio de la sesión. Esto hace que Analytics incremente las reanudaciones de contenido en lugar de los inicios de contenido.

Tipos de implementación recomendados

SDK web

Agregar hasResume: true a 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

Establezca la clave resumed en el objeto de medios antes de llamar a 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

Establezca la clave RESUMED en el objeto de medios antes de llamar a 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

Agregar "hasResume": true a 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 de Media Edge

Agregar "hasResume": true a 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
      }
    }
  }]
}'

Tipos de implementación heredados (solo Analytics)

Media SDK JS 3.x

Establezca la clave MediaResumed en el objeto de medios:

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

Establezca la clave MediaResumed en el objeto de medios:

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 de recopilación de medios

Agregar "media.resume": true al objeto 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