Panoramica

L’API Media Collection è un’alternativa RESTful di Adobe all’SDK Media lato client. Con l’API Media Collection, il lettore può tenere traccia degli eventi audio e video utilizzando chiamate RESTful HTTP.

L'API Media Collection è essenzialmente un adattatore che agisce come versione lato server dell'SDK Media. Ciò significa che alcuni aspetti della documentazione Media SDK sono pertinenti anche all’API Media Collection. Ad esempio, entrambe le soluzioni utilizzano gli stessi parametri multimediali in streaming e i dati di tracciamento dei file multimediali in streaming raccolti portano allo stesso Reporting and Analysis.

Flussi di dati di tracciamento dei file multimediali

Un lettore multimediale che implementa l’API Media Collection effettua chiamate di tracciamento RESTful API direttamente al server back-end di tracciamento dei contenuti multimediali, mentre un lettore che implementa l’SDK Media effettua chiamate di tracciamento alle API SDK all’interno dell’app di lettore. Un effetto dell’esecuzione di chiamate sul web è che il lettore che implementa l’API Media Collection deve gestire in modo automatico alcune delle elaborazioni gestite dall’SDK Media. (Dettagli in Implementazione di Media Collection.)

I dati di tracciamento acquisiti con l’API Media Collection vengono inviati e inizialmente elaborati in modo diverso rispetto ai dati di tracciamento acquisiti in un lettore Media SDK, ma lo stesso motore di elaborazione sul back-end viene utilizzato per entrambe le soluzioni.

Panoramica API

URI: recupera questo messaggio dal rappresentante di Adobe.

Metodo HTTP: POST, con il corpo della richiesta JSON.

Chiamate API

  • sessions- Stabilisce una sessione con il server e restituisce un ID sessione utilizzato nelle events chiamate successive. L’app la chiama una volta all’inizio di una sessione di tracciamento.

    {uri}/api/v1/sessions
    
  • events- invia i dati di tracciamento dei contenuti multimediali.

    {uri}/api/v1/sessions/{session-id}/events
    

Corpo della richiesta

{
    "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 - Obbligatorio per tutte le richieste.

  • eventType - Obbligatorio per tutte le richieste.

  • params - Obbligatorio per alcuni eventTypes; controlla lo schema di convalida JSON per determinare quali tipi di evento sono obbligatori e quali sono facoltativi.

  • qoeData - Facoltativo per tutte le richieste.

  • customMetadata - Facoltativo per tutte le richieste, ma solo per i tipi di sessionStart, adStart e chapterStart evento.

Per ogni eventType, è disponibile al pubblico Schema di convalida JSON da utilizzare per verificare i tipi di parametro e se un parametro è facoltativo o obbligatorio per un particolare evento.

Tipi di evento

  • sessionStart
  • play
  • ping
  • pauseStart
  • bufferStart
  • adStart
  • adComplete
  • adSkip
  • adBreakStart
  • adBreakComplete
  • chapterStart
  • chapterSkip
  • chapterComplete
  • sessionEnd
  • sessionComplete

In questa pagina