Översikt overview
Följande anvisningar ger vägledning vid implementering med SDK:er för 2.x.
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
-
Skapa en
adBreak-objektinstans för annonsbrytningen. Exempel:adBreakObject. -
Ring
trackEventför att annonsbrytningen ska börja med dinadBreakObject.
Alla annonsresurser börjar
- Skapa en annonsobjektinstans för annonsresursen. Exempel:
adObject. - Fyll i annonsmetadata,
adCustomMetadata. - Ring
trackEventför att starta annonsen.
Alla annonser är slutförda
- Anropa
trackEventför att få annonsen klar.
I annonshoppa
- Anropa
trackEventför annonshoppa.
On ad break complete
- Anropa
trackEventför att annonsbrytningen har slutförts.
Implementera annonsspårning implement-ad-tracking
Konstanter för annonsspårning
AdBreakStartAdBreakCompleteAdStartAdCompleteAdSkipImplementeringssteg
-
Identifiera när annonsbrytningsgränsen börjar, inklusive pre-roll, och skapa en
AdBreakObjectmed 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 nameAnnonsbrytningsnamn som för-, för- och efterrullning. Ja positionAnnonsens nummerposition i innehållet, med början på 1. Ja startTimeSpelhuvudets värde i början av annonsbrytningen. Ja -
Anropa
trackEvent()medAdBreakStartiMediaHeartbeat-instansen för att börja spåra annonsbrytningen. -
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 nameAnnonsens namn. Ja adIdUnik identifierare för annonsen. Ja positionAnnonsens nummerposition inom annonsbrytningen, med början på 1. Ja lengthAnnonslängd Ja -
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.
-
Anropa
trackEvent()med händelsenAdStarti instansenMediaHeartbeatfö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.
-
När annonsuppspelningen når slutet av annonsen anropar du
trackEvent()med händelsenAdComplete. -
Om annonsuppspelningen inte slutfördes eftersom användaren valde att hoppa över annonsen, ska du spåra
AdSkip-händelsen. -
Om det finns ytterligare annonser i samma
AdBreakupprepar du steg 3 till 7 igen. -
När annonsbrytningen är klar använder du händelsen
AdBreakCompleteför att spåra den.
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 HTML5-mediespelare.
/* 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);
};