Adobe Media Analytics for Audio and Video-Erweiterung – Übersicht

NOTE
Adobe Experience Platform Launch wurde als eine Suite von Datenerfassungstechnologien in Adobe Experience Platform umbenannt. Infolgedessen wurden in der gesamten Produktdokumentation mehrere terminologische Änderungen eingeführt. Eine konsolidierte Übersicht der terminologischen Änderungen finden Sie im folgenden Dokument.

In dieser Dokumentation finden Sie Informationen zum Installieren, Konfigurieren und Implementieren der „Adobe Media Analytics für Audio und Video“-Erweiterung (Media Analytics-Erweiterung). Darin enthalten sind neben Beispielen und Links zu Mustern die verfügbaren Optionen bei Verwendung dieser Erweiterung zum Erstellen einer Regel.

Durch die Media Analytics (MA)-Erweiterung wird das JavaScript-Media-SDK (Media 2.x-SDK) hinzugefügt. Diese Erweiterung bietet die Funktionalität zum Hinzufügen der MediaHeartbeat-Tracker-Instanz zu einer Tag-Site oder einem Projekt. Für die MA-Erweiterung sind zwei weitere Erweiterungen erforderlich:

IMPORTANT
Für das Audio-Tracking ist die Analytics-Erweiterung Version 1.6 oder höher erforderlich.

Nachdem Sie alle drei der zuvor erwähnten Erweiterungen in Ihr Tag-Projekt eingefügt haben, haben Sie zwei Möglichkeiten, den Vorgang fortzusetzen:

  • Verwenden Sie MediaHeartbeat-APIs aus Ihrer Web-Anwendungserweiterung
  • Integrieren oder erstellen Sie eine Player-spezifische Erweiterung, die bestimmte Medienplayer-Ereignisse den APIs der MediaHeartbeat-Tracker-Instanz zuordnet. Diese Instanz wird über die MA-Erweiterung offengelegt.

Installieren und Konfigurieren der MA-Erweiterung

  • Installieren: Um die MA-Erweiterung zu installieren, öffnen Sie die Erweiterungseigenschaft, wählen Sie Erweiterungen > Katalog aus, bewegen Sie den Mauszeiger über die Erweiterung Adobe Media Analytics für Audio und Video und wählen Sie Installieren aus.

  • Konfigurieren: Um die MA-Erweiterung zu konfigurieren, öffnen Sie die Registerkarte Erweiterungen, bewegen Sie den Mauszeiger über die Erweiterung und klicken Sie dann auf Konfigurieren:

Konfigurieren der MA-Erweiterung

Konfigurationsoptionen:

Option
Beschreibung
Tracking Server
Definiert den Server für das Tracking von Medientakten (dies ist nicht derselbe Server wie Ihr Analyse-Tracking-Server)
Application Version
Medienplayer-App-/Medienplayer-SDK-Version
Player Name
Name des verwendeten Medienplayers, z. B. „AVPlayer“, „HTML5-Player“, „Mein anwenderspezifischer Player“.
Kanal
Kanalnamen-Eigenschaft
Online Video Provider
Name der Online-Videoplattform, über die der Inhalt verteilt wird
Debug Logging
Aktivieren oder Deaktivieren der Protokollierung
Enable SSL
Aktivieren oder Deaktivieren des Sendens von Pings über HTTPS
Export APIs to Window Object
Aktivieren oder Deaktivieren des Exports von Media Analytics-APIs für einen globalen Umfang
Variable Name
Eine Variable, die Sie zum Exportieren von Media Analytics-APIs unter dem window-Objekt verwenden

Erinnerung: Für die MA-Erweiterung sind die Analytics- und Experience Cloud ID-Erweiterungen erforderlich. Sie müssen diese Erweiterungen auch Ihrer Erweiterungseigenschaft hinzufügen und konfigurieren.

Verwenden der MA-Erweiterung

Verwendung auf einer Webseite/JS-App

Die MA-Erweiterung exportiert die MediaHeartbeat-APIs im globalen Fensterobjekt, indem sie die Einstellung „Exportieren von APIs in das Fensterobjekt“ auf der Seite Konfiguration aktiviert. Die APIs werden unter dem konfigurierten Variablennamen exportiert. Wenn der Variablenname beispielsweise als ADB konfiguriert ist, ist der MediaHeartbeat-Zugriff über window.ADB.MediaHeartbeat möglich.

IMPORTANT
Die MA-Erweiterung exportiert die APIs nur, wenn window["CONFIGURED_VARIABLE_NAME"] nicht definiert ist, und vorhandene Variablen werden nicht überschrieben.
  1. MediaHeartbeat-Instanz erstellen: window["CONFIGURED_VARIABLE_NAME"].MediaHeartbeat.getInstance

    Parameter: Ein gültiges Delegationsobjekt, das diese Funktionen offenlegt.

    table 0-row-2 1-row-2 2-row-2 1-align-left 2-align-left 4-align-left 5-align-left 7-align-left 8-align-left
    Methode Beschreibung
    getQoSObject() Gibt die theMediaObject-Instanz zurück, die aktuelle Informationen zur Servicequalität enthält. Diese Methode wird mehrmals während einer Wiedergabesitzung aufgerufen. Die Player-Implementierung muss stets die aktuellsten verfügbaren Servicequalitätsdaten zurückgeben.
    getCurrentPlaybackTime() Gibt die aktuelle Position der Abspielleiste zurück. Bei VOD-Tracking wird der Wert in Sekunden ab Beginn des Medienelements angegeben. Beim Tracking von LIVE-Assets wird der Wert in Sekunden ab Beginn des Programms angegeben.

    Wert zurückgeben: Eine Zusage, die entweder mit einer MediaHeartbeat-Instanz aufgelöst oder mit einer Fehlermeldung zurückgewiesen wird.

  2. Auf MediaHeartbeat-Konstanten zugreifen: window["CONFIGURED_VARIABLE_NAME"].MediaHeartbeat

    Dadurch werden alle Konstanten und statischen Methoden aus der MediaHeartbeat-Klasse bereitgestellt.

    Sie können den Beispielplayer hier abrufen: MA Sample Player. Der Beispiel-Player dient als Referenz zur Verwendung der MA-Erweiterung zur Unterstützung von Media Analytics direkt über eine Webapp.

  3. Erstellen Sie die MediaHeartbeat-Tracker-Instanz wie folgt:

    code language-javascript
    var MediaHeartbeat = window["CONFIGURED_VARIABLE_NAME"].MediaHeartbeat;
    
    var delegate = {
        getCurrentPlaybackTime: this._getCurrentPlaybackTime.bind(this),
        getQoSObject: this._getQoSObject.bind(this),
    };
    
    var config = {
        playerName: "Custom Player",
        ovp: "Custom OVP",
        channel: "Custom Channel"
    };
    
    var self = this;
    MediaHeartbeat.getInstance(delegate, config).then(function(instance) {
        self._mediaHeartbeat = instance;
        // Do Tracking using the MediaHeartbeat instance.
    }).catch(function(err){
        // Getting MediaHeartbeat instance failed.
    });
    

Verwendung in anderen Erweiterungen

Die MA-Erweiterung legt die get-instance und die freigegebenen media-heartbeat-Module für andere Erweiterungen offen. (Weitere Informationen zu freigegebenen Modulen finden Sie in der Dokumentation zu freigegebenen Modulen.)

IMPORTANT
Der Zugriff auf freigegebene Module ist nur über andere Erweiterungen möglich. Das heißt, eine Webseite/JS-App kann nicht außerhalb einer Erweiterung auf die freigegebenen Module zugreifen oder turbine verwenden (siehe Code-Beispiel unten).
  1. MediaHeartbeat-Instanz erstellen: Freigegebenes get-instance-Modul

    Parameter:

    • Ein gültiges Delegatobjekt, das die folgenden Funktionen zur Verfügung stellt:

      table 0-row-2 1-row-2 2-row-2 1-align-left 2-align-left 4-align-left 5-align-left 7-align-left 8-align-left
      Methode Beschreibung
      getQoSObject() Gibt die MediaObject-Instanz zurück, die die aktuellen Informationen zur Servicequalität enthält. Diese Methode wird mehrmals während einer Wiedergabesitzung aufgerufen. Die Player-Implementierung muss stets die aktuellsten verfügbaren Servicequalitätsdaten zurückgeben.
      getCurrentPlaybackTime() Gibt die aktuelle Position der Abspielleiste zurück. Bei VOD-Tracking wird der Wert in Sekunden ab Beginn des Medienelements angegeben. Beim Tracking von LIVE-Assets wird der Wert in Sekunden ab Beginn des Programms angegeben.
    • Ein optionales Konfigurationsobjekt, das die folgenden Eigenschaften zur Verfügung stellt:

      table 0-row-3 1-row-3 2-row-3 3-row-3 1-align-left 2-align-left 3-align-left 5-align-left 6-align-left 7-align-left 9-align-left 10-align-left 11-align-left 13-align-left 14-align-left 15-align-left
      Eigenschaft Beschreibung Erforderlich
      Online Video Provider Name der Online-Videoplattform, über die der Inhalt verteilt wird. Nein. Überschreibt den während der Erweiterungskonfiguration definierten Wert, sofern vorhanden.
      Player Name Name des verwendeten Medienplayers, z. B. „AVPlayer“, „HTML5-Player“, „Mein anwenderspezifischer Player“. Nein. Überschreibt den während der Erweiterungskonfiguration definierten Wert, sofern vorhanden.
      Kanal Kanalnamen-Eigenschaft Nein. Überschreibt den während der Erweiterungskonfiguration definierten Wert, sofern vorhanden.

    Wert zurückgeben: Eine Zusage, die entweder mit einer MediaHeartbeat-Instanz aufgelöst oder mit einer Fehlermeldung zurückgewiesen wird.

  2. Auf MediaHeartbeat-Konstanten zugreifen: Freigegebenes media-heartbeat-Modul

    Dieses Modul legt alle Konstanten und statischen Methoden dieser Klasse offen: https://adobe-marketing-cloud.github.io/media-sdks/reference/javascript/MediaHeartbeat.html.

  3. Erstellen Sie die MediaHeartbeat-Tracker-Instanz wie folgt:

    code language-javascript
    var getMediaHeartbeatInstance =
      turbine.getSharedModule('adobe-video-analytics', 'get-instance');
    
    var MediaHeartbeat =
      turbine.getSharedModule('adobe-video-analytics', 'media-heartbeat');
      ...
    
    var delegate = {
        getCurrentPlaybackTime: this._getCurrentPlaybackTime.bind(this),
        getQoSObject: this._getQoSObject.bind(this),
    }
    
    var config = {
        playerName: "Custom Player",
        ovp: "Custom OVP",
        channel: "Custom Channel"
    }
    ...
    
    var self = this;
    getMediaHeartbeatInstance(delegate, config).then(function(instance) {
        self._mediaHeartbeat = instance;
        ...
        // Do Tracking using the MediaHeartbeat instance.
    }).catch(function(err){
        // Getting MediaHeartbeat instance failed.
    });
    
    ...
    
  4. Verwenden Sie die Media Heartbeat-Instanz und befolgen Sie die Medien-SDK-JS- und die JS-API-Dokumentation, um das Medien-Tracking zu implementieren.

NOTE
Testen:  Um Ihre Erweiterung zu testen, müssen Sie sie in Platform hochladen, wo Sie Zugriff auf alle abhängigen Erweiterungen haben.
recommendation-more-help
12b4e4a9-5028-4d88-8ce6-64a580811743