DokumentationAnalyticsAnvändarhandbok för insamling av direktuppspelade medier

Översikt overview

Last update: Thu Jul 18 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Ämnen:

Skapat för:

  • Användare
  • Administratör
  • Utvecklare

Följande anvisningar ger vägledning vid implementering med SDK:er för 2.x.

IMPORTANT
Om du implementerar en 1.x-version av SDK kan du hämta 1.x-utvecklarhandböcker här: Hämta SDK:er.

Annonsuppspelning inkluderar spårning av annonsbrytningar, start, slutförande av annonser och hopp för annonser. Använd mediespelarens API för att identifiera viktiga spelarhändelser och för att fylla i obligatoriska och valfria annonsvariabler. Se den omfattande listan med metadata här: Lägg till parametrar.

Spelarhändelser player-events

Vid start av annonsbrytning

NOTE
Inklusive pre-roll

  • Skapa en adBreak-objektinstans för annonsbrytningen. Exempel: adBreakObject.

  • Ring trackEvent för att annonsbrytningen ska börja med din adBreakObject.

Alla annonsresurser börjar

  • Skapa en annonsobjektinstans för annonsresursen. Exempel: adObject.
  • Fyll i annonsmetadata, adCustomMetadata.
  • Ring trackEvent för att starta annonsen.

Alla annonser är slutförda

  • Anropa trackEvent för att få annonsen klar.

I annonshoppa

  • Anropa trackEvent för annonshoppa.

On ad break complete

  • Anropa trackEvent för att annonsbrytningen har slutförts.

Implementera annonsspårning implement-ad-tracking

Konstanter för annonsspårning

Konstantnamn
Beskrivning
AdBreakStart
Konstant för spårning av AdBreak-starthändelse
AdBreakComplete
Konstant för spårning av AdBreak Complete-händelse
AdStart
Konstant för spårning av Ad Start-händelse
AdComplete
Konstant för spårning av Ad Complete-händelse
AdSkip
Konstant för spårning av Ad Skip-händelse

Implementeringssteg

  1. Identifiera när annonsbrytningsgränsen börjar, inklusive pre-roll, och skapa en AdBreakObject med hjälp av annonsbrytningsinformationen.

    AdBreakObject-referens:

    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
    Variabelnamn Beskrivning Obligatoriskt
    name Annonsbrytningsnamn som för-, för- och efterrullning. Ja
    position Annonsens nummerposition i innehållet, med början på 1. Ja
    startTime Spelhuvudets värde i början av annonsbrytningen. Ja

  2. Anropa trackEvent() med AdBreakStart i MediaHeartbeat-instansen för att börja spåra annonsbrytningen.

  3. Identifiera när annonsen startar och skapa en AdObject-instans med annonsinformationen.

    AdObject-referens:

    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
    Variabelnamn Beskrivning Obligatoriskt
    name Annonsens namn. Ja
    adId Unik identifierare för annonsen. Ja
    position Annonsens nummerposition inom annonsbrytningen, med början på 1. Ja
    length Annonslängd Ja

  4. Du kan också bifoga standard- och/eller annonsmetadata till spårningssessionen via kontextdatavariabler.

    • Standardannonsmetadata - För standardannonsmetadata skapar du en ordlista med nyckelvärdepar för standardannonsmetadata med hjälp av tangenterna för din plattform.
    • Anpassade annonseringsmetadata - Skapa ett variabelobjekt för anpassade datavariabler och fyll i med data för den aktuella annonsen för anpassade metadata.

  5. Anropa trackEvent() med händelsen AdStart i instansen MediaHeartbeat för att börja spåra annonsuppspelningen.

    Ta med en referens till din anpassade metadatavariabel (eller ett tomt objekt) som den tredje parametern i händelseanropet.

  6. När annonsuppspelningen når slutet av annonsen anropar du trackEvent() med händelsen AdComplete.

  7. Om annonsuppspelningen inte slutfördes eftersom användaren valde att hoppa över annonsen, ska du spåra AdSkip-händelsen.

  8. Om det finns ytterligare annonser i samma AdBreak upprepar du steg 3 till 7 igen.

  9. När annonsbrytningen är klar använder du händelsen AdBreakComplete för att spåra den.

IMPORTANT
Kontrollera att du INTE ökar spelhuvudet för innehållsspelaren (l:event:playhead) under annonsuppspelning (s:asset:type=ad). Om du gör det påverkas Content Time Spent-måtten negativt.

I följande exempelkod används JavaScript 2.x SDK för en mediespelare i HTML 5.

/* 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