API-overzicht van mediagroep overview

De API van de Inzameling van Media is RESTful alternatief aan de cliënt-zijMedia SDK. Met de Media Collection API kan uw speler audio en videogebeurtenissen volgen gebruikend vraag RESTful van HTTP.

De API voor mediaverzamelingen is in wezen een adapter die fungeert als een serverversie van de SDK van Media. Dit betekent dat sommige aspecten van de documentatie van SDK van Media ook relevant voor de Inzameling API van Media zijn. Beide oplossingen gebruiken bijvoorbeeld hetzelfde Streaming mediaparametersen de verzamelde gegevens voor het bijhouden van streaming media leiden tot hetzelfde Rapportage en analyse.

Gegevensstromen voor het bijhouden van media media-tracking-data-flows

Een mediaspeler die de Media Collection API implementeert, maakt RESTful API-traceringsaanroepen rechtstreeks naar de back-endserver voor mediatracering, terwijl een speler die de Media SDK implementeert, traceeraanroepen uitvoert naar de SDK API's in de speler-app. Één effect van het maken van vraag over het Web is dat de speler die de API van de Inzameling van Media uitvoert enkele verwerking moet behandelen die de Media SDK automatisch behandelt. (Details in Implementatie van media-collectie.)

De volggegevens die met de Media Collection API worden gevangen worden verzonden en aanvankelijk verwerkt verschillend dan de volggegevens die in een speler van SDK van Media worden gevangen, maar de zelfde verwerkingsmotor op het achterste eind wordt gebruikt voor beide oplossingen.

API-overzicht api-overview

URI: Vraag dit aan uw Adobe-vertegenwoordiger.

HTTP-methode: POST, met de JSON-aanvraaginstantie.

API-aanroepen mc-api-calls

  • sessions- Hiermee wordt een sessie met de server ingesteld en wordt een sessie-id geretourneerd die in de volgende sessies wordt gebruikt events oproepen. Uw app roept dit eenmaal aan het begin van een volgende sessie aan.

    {uri}/api/v1/sessions

  • events- Hiermee verzendt u gegevens voor het bijhouden van media.

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

Verzoek 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 - Verplicht voor alle verzoeken.

  • eventType - Verplicht voor alle verzoeken.

  • params - Verplicht voor bepaalde eventTypes; controleren JSON-validatieschema om te bepalen welke eventTypes verplicht zijn, en die facultatief zijn.

  • qoeData - Optioneel voor alle aanvragen.

  • customMetadata - Optioneel voor alle aanvragen, maar alleen verzonden met sessionStart, adStart, en chapterStart gebeurtenistypen.

Voor elke eventTypeer een openbaar JSON-validatieschema die u moet gebruiken om parametertypen te verifiëren en of een parameter optioneel of vereist is voor een bepaalde gebeurtenis.

Gebeurtenistypen mc-api-event-types

  • sessionStart
  • play
  • ping
  • pauseStart
  • bufferStart
  • adStart
  • adComplete
  • adSkip
  • adBreakStart
  • adBreakComplete
  • chapterStart
  • chapterSkip
  • chapterComplete
  • sessionEnd
  • sessionComplete
recommendation-more-help
c8eee520-cef5-4f8c-a38a-d4952cfae4eb