Información general sobre la API de Media Collection overview
La API de recopilación de medios es la alternativa RESTful de Adobe al SDK de medios del lado del cliente. Con la API de recopilación de medios, el reproductor puede realizar el seguimiento de eventos de audio y vídeo mediante llamadas HTTP RESTful.
La API de recopilación de medios es esencialmente un adaptador que actúa como una versión del SDK de medios en el lado del servidor. Eso significa que algunos aspectos de la documentación de Media SDK también son pertinentes para la API de recopilación de contenido. Por ejemplo, ambas soluciones usan los mismos Parámetros de Streaming Media, y los datos recopilados de seguimiento de medios llevan a los mismos Informes y análisis.
Flujos de datos del seguimiento de contenidos media-tracking-data-flows
Un reproductor de contenido que implementa la API de recopilación de contenido realiza llamadas de seguimiento de API RESTful directamente al servidor back-end de seguimiento de contenido, mientras que un reproductor que implementa Media SDK hace llamadas de seguimiento a las API de SDK en la aplicación del reproductor. Realizar llamadas a través de la web hace que el reproductor que implementa la API de Media Collection necesite gestionar parte del procesamiento que el Media SDK controla automáticamente. (Detalles de la implementación de recopilación de contenido.)
Los datos de seguimiento capturados con la API de recopilación de contenido se envían y se procesan inicialmente de forma distinta a los datos de seguimiento capturados en un reproductor de Media SDK, pero se utiliza el mismo motor de procesamiento de en el servidor para ambas soluciones.
Información general de API api-overview
URI: Puede obtenerla de su representante de Adobe.
Método HTTP: POST, con el cuerpo de solicitud JSON.
Llamadas de API mc-api-calls
-
sessions- Establece una sesión con el servidor y devuelve un ID de sesión utilizado en las llamadas aeventsposteriores. La aplicación invocará una vez al principio de una sesión de seguimiento.{uri}/api/v1/sessions -
events- Enviar datos de seguimiento de contenidos.{uri}/api/v1/sessions/{session-id}/events
Cuerpo de la solicitud mc-api-request-body
{
"playerTime": {
"playhead": "{playhead position in seconds}",
"ts": "{timestamp in milliseconds}"
},
"eventType": "{event-type}",
"params": {
"{parameter-name}": "{parameter-value}",
"{parameter-name}": "{parameter-value}"
},
"qoeData" : {
"{parameter-name}": "{parameter-value}",
"{parameter-name}": "{parameter-value}"
},
"customMetadata": {
"{parameter-name}": "{parameter-value}",
"{parameter-name}": "{parameter-value}"
}
}
-
playerTime- obligatorio para todas las solicitudes. -
eventType- obligatorio para todas las solicitudes. -
params- obligatorio para determinadoseventTypes. Compruebe el esquema de validación JSON para determinar qué tipos de evento eventTypes son obligatorios y cuáles son opcionales. -
qoeData- opcional para todas las solicitudes. -
customMetadata- opcional para todas las peticiones, pero solo se envía con los tipos de eventosessionStart,adStartychapterStart.
Para cada eventType, hay un esquema de validación JSON disponible públicamente que debe utilizarse para verificar tipos de parámetros y si uno de estos es opcional o necesario para un evento determinado.
Tipos de eventos mc-api-event-types
sessionStartplaypingpauseStartbufferStartadStartadCompleteadSkipadBreakStartadBreakCompletechapterStartchapterSkipchapterCompletesessionEndsessionComplete