Overzicht overview
De volgende instructies bieden richtlijnen voor implementatie met behulp van de 2.x SDK's.
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 uitvoerige lijst van meta-gegevens hier: Advertentieparameters.
Gebeurtenissen van Player player-events
Bij starten van advertentie-einde
-
Maak een
adBreak-objectinstantie voor het ad-einde. BijvoorbeeldadBreakObject. -
Roep
trackEventaan voor het begin van het advertentieeinde met uwadBreakObject.
Bij elke advertentie-asset start
- Maak een instantie van een advertentieobject voor het advertentie-element. Bijvoorbeeld
adObject. - Vul de metagegevens van de advertentie in,
adCustomMetadata. - Roep
trackEventaan voor het starten van de advertentie.
Op elke advertentie compleet
- Roep
trackEventaan voor de advertentie is voltooid.
Op advertentie slaan
- Roep
trackEventaan voor de advertentie.
Bij voltooiing van advertentie
- Roep
trackEventaan voor het advertentieeinde is voltooid.
Toevoegen en bijhouden implement-ad-tracking
Constanten voor bijhouden van advertenties
AdBreakStartAdBreakCompleteAdStartAdCompleteAdSkipImplementatiestappen
-
Bepaal wanneer de grens van de advertentieruimte begint, met inbegrip van pre-rol, en creeer
AdBreakObjectdoor de informatie van de advertentierak te gebruiken.AdBreakObjectreference: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 nameDe naam van het invoegpunt, zoals pre-roll, mid-roll en post-roll. Ja positionDe getalpositie van het advertentierak binnen de inhoud, beginnend met 1. Ja startTimeWaarde van afspeelkop aan het begin van het advertentieeinde. Ja -
Roep
trackEvent()aan metAdBreakStartin deMediaHeartbeat-instantie om het ad-einde te volgen. -
Bepaal wanneer de advertentie begint en creeer een
AdObjectinstantie gebruikend de advertentieinformatie.AdObjectreference: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 nameVriendelijke naam van de advertentie. Ja adIdDe unieke id voor de advertentie. Ja positionDe numerieke positie van de advertentie binnen het advertentiespoor, beginnend met 1. Ja lengthAd-lengte Ja -
Voeg desgewenst standaard- en/of advertentiemetagegevens toe aan de volgende sessie via de variabelen van de contextgegevens.
- Standaard en meta-gegevens - voor norm en meta-gegevens, creeer een woordenboek van standaard en de waardeparen van de meta-gegevens zeer belangrijke gebruikend de sleutels voor uw platform.
- Douane en meta-gegevens - voor douanemetagegevens, creeer een veranderlijk voorwerp voor de variabelen van douanegegevens en bevolk met de gegevens voor de huidige advertentie.
-
Roep
trackEvent()aan met de gebeurtenisAdStartin de instantieMediaHeartbeatom 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.
-
Wanneer het afspelen van de advertentie het einde van de advertentie heeft bereikt, roept u
trackEvent()aan met de gebeurtenisAdComplete. -
Als het afspelen van de advertentie niet is voltooid omdat de gebruiker de advertentie heeft overgeslagen, houdt u de gebeurtenis
AdSkipbij. -
Herhaal stap 3 tot en met 7 opnieuw als er extra advertenties binnen dezelfde
AdBreakzijn. -
Wanneer het ad-einde is voltooid, gebruikt u de gebeurtenis
AdBreakCompleteom het bij te houden.
l:event:playhead) NIET verhoogt tijdens het afspelen van de advertentie (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);
};