Overzicht overview

De volgende instructies bieden richtlijnen voor implementatie met behulp van de 2.x SDK's.

IMPORTANT
Als u een 1.x-versie van de SDK implementeert, kunt u hier de 1.x-handleidingen voor ontwikkelaars downloaden: SDK's downloaden.

Het afspelen van advertenties omvat het bijhouden en afbreken, het starten, voltooien en het overslaan van advertenties. Gebruik de API van de mediaspeler om toetsspelergebeurtenissen te identificeren en de vereiste en optionele advertentievariabelen te vullen. Zie de uitgebreide lijst met metagegevens hier: Toegevoegde parameters.

Gebeurtenissen van Player player-events

Bij starten van advertentie-einde

NOTE
Met inbegrip van voorrol
  • Een adBreak -objectinstantie voor het ad-einde. Bijvoorbeeld, adBreakObject.

  • Bellen trackEvent voor het afbreken van de advertentie begint u met uw adBreakObject.

Bij elke advertentie-asset start

  • Maak een instantie van een advertentieobject voor het advertentie-element. Bijvoorbeeld, adObject.
  • De metagegevens van de advertentie invullen, adCustomMetadata.
  • Bellen trackEvent voor het begin van de advertentie.

Op elke advertentie compleet

  • Bellen trackEvent voor de advertentie is voltooid.

Op advertentie slaat u over

  • Bellen trackEvent voor de advertentie.

Bij voltooiing van advertentie

  • Bellen trackEvent voor het advertentieeinde is voltooid.

Toevoegen en bijhouden implement-ad-tracking

Constanten voor bijhouden van advertenties

Naam van constante
Beschrijving
AdBreakStart
Constante voor het bijhouden van de gebeurtenis AdBreak Start
AdBreakComplete
Constante voor het bijhouden van de gebeurtenis AdBreak Complete
AdStart
Constante voor het bijhouden van de gebeurtenis Ad Start
AdComplete
Constante voor het bijhouden van de gebeurtenis Advertentie voltooid
AdSkip
Constante voor het bijhouden van de gebeurtenis Advertentie overslaan

Uitvoeringsstappen

  1. Identificeer wanneer de grens van de advertentie begint, met inbegrip van pre-rol, en creeer een AdBreakObject met behulp van de informatie over het advertentieeinde.

    AdBreakObject referentie:

    table 0-row-3 1-row-3 2-row-3 3-row-3 3-align-center 7-align-center 11-align-center 15-align-center
    Naam variabele Beschrijving Vereist
    name De naam van het invoegpunt, zoals pre-roll, mid-roll en post-roll. Ja
    position De getalpositie van het advertentierak binnen de inhoud, beginnend met 1. Ja
    startTime Waarde van afspeelkop aan het begin van het advertentieeinde. Ja
  2. Bellen trackEvent() with AdBreakStart in de MediaHeartbeat -instantie om het ad-einde te volgen.

  3. Identificeer wanneer de advertentie begint en creeer AdObject -instantie die de advertentiegegevens gebruikt.

    AdObject referentie:

    table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 3-align-center 7-align-center 11-align-center 15-align-center 19-align-center
    Naam variabele Beschrijving Vereist
    name Vriendelijke naam van de advertentie. Ja
    adId De unieke id voor de advertentie. Ja
    position De numerieke positie van de advertentie binnen het advertentiespoor, beginnend met 1. Ja
    length Ad-lengte Ja
  4. Voeg desgewenst standaard- en/of advertentiemetagegevens toe aan de volgende sessie via de variabelen van de contextgegevens.

    • Standaard en metagegevens - Voor standaard- en metagegevens maakt u een woordenboek van standaard- en metagegevenssleutelwaardeparen met de toetsen voor uw platform.
    • Aangepaste en metagegevens - Voor aangepaste metagegevens maakt u een variabelenobject voor de aangepaste gegevensvariabelen en vult u de gegevens voor de huidige advertentie in.
  5. Bellen trackEvent() met de AdStart in de MediaHeartbeat -instantie om het afspelen van de advertentie te volgen.

    Neem een verwijzing naar de aangepaste metagegevensvariabele (of een leeg object) op als de derde parameter in de gebeurtenisaanroep.

  6. Wanneer het afspelen van de advertentie het einde van de advertentie heeft bereikt, roept u trackEvent() met de AdComplete gebeurtenis.

  7. Als het afspelen van de advertentie niet is voltooid omdat de gebruiker de advertentie heeft overgeslagen, voert u de AdSkip gebeurtenis.

  8. Als er extra advertenties zijn binnen dezelfde AdBreakHerhaal stap 3 tot en met 7 opnieuw.

  9. Wanneer het advertentieeinde is voltooid, gebruikt u de AdBreakComplete om de gebeurtenis te volgen.

IMPORTANT
Zorg ervoor dat u de afspeelkop van de inhoudsspeler NIET verhoogt (l:event:playhead) tijdens het afspelen van advertenties (s:asset:type=ad). Als u dat wel doet, hebben de meetgegevens voor Tijd van inhoud een negatief effect.

In de volgende voorbeeldcode wordt de JavaScript 2.x SDK gebruikt voor een HTML5-mediaspeler.

/* Call on ad break start */

if (e.type == "ad break start") {
    var adBreakObject = MediaHeartbeat.createAdBreakObject("mid-roll", 2, 500);
    this.mediaHeartbeat.trackEvent(MediaHeartbeat.Event.AdBreakStart, adBreakObject);
};

/* Call on ad start */
if (e.type == "ad start") {
    var adObject = MediaHeartbeat.createAdObject("PepsiOne", "123456ab", 1, 30);
    /* Set custom context data */
    var adCustomMetadata = {
        affiliate:"Sample affiliate",
        campaign:"Sample ad campaign",
        creative:"Sample creative"
    }
    this.mediaHeartbeat.trackEvent(MediaHeartbeat.Event.AdStart, adObject, adCustomMetadata);
};

/* Call on ad complete */
if (e.type == "ad complete") {
    this.mediaHeartbeat.trackEvent(MediaHeartbeat.Event.AdComplete);
};

/* Call on ad skip */
if (e.type == "ad skip") {
    this.mediaHeartbeat.trackEvent(MediaHeartbeat.Event.AdSkip);
};

/* Call on ad break complete */
if (e.type == "ad break complete") {
    this.mediaHeartbeat.trackEvent(MediaHeartbeat.Event.AdBreakComplete);
};
recommendation-more-help
c8eee520-cef5-4f8c-a38a-d4952cfae4eb