Überblick
Erstellt für:
- Benutzende
- Admin
- Entwickler
Mit den folgenden Anweisungen können Sie die Implementierung unter Verwendung der 2.x-SDKs vornehmen.
Die Wiedergabe von Anzeigen beinhaltet das Tracking von Werbeunterbrechungen, Anzeigenstarts, -beendigungen und übersprungenen Anzeigen. Verwenden Sie die API des Medienplayers, um wichtige Player-Ereignisse zu ermitteln und die erforderlichen und optionalen Anzeigenvariablen hinzuzufügen. Sehen Sie hier die umfassende Liste der verfügbaren-Metadaten: Anzeigenparameter.
Player-Ereignisse
Beim Start einer Werbeunterbrechung
-
Erstellen Sie eine
adBreak
-Objektinstanz für die Werbepause. Beispiel,adBreakObject
. -
Rufen Sie
trackEvent
für den Start einer Werbeunterbrechung mit IhremadBreakObject
auf.
Bei jedem Start eines Anzeigen-Assets
- Erstellen Sie eine Anzeigenobjektinstanz für das Anzeigen-Asset. Beispiel,
adObject
. - Fügen Sie die Anzeigenmetadaten hinzu:
adCustomMetadata
. - Rufen Sie
trackEvent
für den Anzeigenstart auf.
Bei jedem Ende einer Anzeige:
- Rufen Sie
trackEvent
auf, um die Anzeige zu beenden.
Beim Überspringen einer Anzeige:
- Rufen Sie
trackEvent
für das Überspringen einer Anzeige auf.
Beim Abschluss einer Werbeunterbrechung:
- Rufen Sie
trackEvent
für das Ende der Werbeunterbrechung auf.
Implementieren des Anzeigen-Trackings
Anzeigen-Tracking-Konstanten
AdBreakStart
AdBreakComplete
AdStart
AdComplete
AdSkip
Implementierungsschritte
-
Ermitteln Sie, wann die Werbeunterbrechung beginnt, einschließlich Pre-Roll, und erstellen Sie ein
AdBreakObject
mithilfe dieser Pauseninformationen.AdBreakObject
-Referenz:VariablennameBeschreibungerforderlichname
Name der Werbeunterbrechung, z. B. Pre-Roll, Mid-Roll oder Post-Roll.Japosition
Positionsnummer der Werbeunterbrechung innerhalb des Inhalts, beginnend bei 1.JastartTime
Abspielpositionswert bei Start der Werbeunterbrechung.Ja -
Rufen Sie
trackEvent()
mitAdBreakStart
in derMediaHeartbeat
-Instanz auf, um das Tracking der Werbeunterbrechung zu starten. -
Ermitteln Sie, wann die Anzeige startet und erstellen Sie die
AdObject
-Instanz mithilfe dieser Anzeigeninformationen.AdObject
-Referenz:VariablennameBeschreibungerforderlichname
Der Anzeigename der Werbeanzeige.JaadId
Eindeutige Kennung für die Anzeige.Japosition
Positionsnummer der Anzeige in der Werbeunterbrechung, beginnend bei 1.Jalength
AnzeigenlängeJa -
Optional können Standard- und/oder Werbemetadaten über Kontextdatenvariablen an die Tracking-Sitzung angehängt werden.
- Metadaten für Standardanzeigen: Erstellen Sie für Metadaten für Standardanzeigen ein Wörterbuch der Schlüsselwertepaare für Standardanzeigenmetadaten unter Verwendung der Schlüssel für Ihre Plattform.
- Anwenderspezifische Anzeigenmetadaten: Erstellen Sie für anwenderdefinierte Metadaten ein variables Objekt für die anwenderspezifischen Datenvariablen und füllen Sie es mit den Daten für aktuelle Anzeigen.
-
Rufen Sie
trackEvent()
mit demAdStart
-Ereignis in derMediaHeartbeat
-Instanz auf, um das Tracking der Anzeigenwiedergabe zu starten.Fügen Sie als dritten Parameter im Ereignisaufruf eine Referenz auf Ihre anwenderdefinierte Metadatenvariable (oder ein leeres Objekt) ein.
-
Wenn die Wiedergabe der Anzeige das Ende der Anzeige erreicht, rufen Sie
trackEvent()
mit demAdComplete
-Ereignis auf. -
Wenn die Anzeigenwiedergabe nicht abgeschlossen wurde, weil der Benutzer die Anzeige überspringt, verfolgen Sie das
AdSkip
-Ereignis. -
Wiederholen Sie die Schritte 3 bis 7, wenn dieselbe
AdBreak
weitere Anzeigen enthält. -
Wenn die Werbeunterbrechung abgeschlossen ist, verwenden Sie zu deren Tracking das
AdBreakComplete
-Ereignis.
l:event:playhead
) des Inhaltsplayers während der Wiedergabe der Anzeige NICHT erhöhen (s:asset:type=ad
). In diesem Fall werden die Metriken zur Besuchszeit für Inhalte negativ beeinflusst.Der folgende Beispielcode nutzt das JavaScript 2.x-SDK für einen HTML5-Medienplayer.
/* 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);
};