DokumentationAnalyticsStreaming Media Collection-Handbuch

Einrichten von JavaScript 2.x set-up-javascript

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

Erstellt für:

  • Benutzende
  • Admin
  • Entwickler

Voraussetzungen

  • Gültige Konfigurationsparameter festlegen: Diese Parameter erhalten Sie nach der Einrichtung Ihres Analytics-Kontos von einem Adobe-Support-Mitarbeiter.

  • AppMeasurement für JavaScript in Ihre Medienanwendung implementieren: Weitere Informationen zur Adobe Mobile-SDK-Dokumentation finden Sie unter Analytics-Implementierung mit JavaScript.

  • Stellen Sie die folgenden Funktionen in Ihrem Medienplayer bereit:

    • Eine API zum Abonnieren von Player-Ereignissen: Das Media SDK erfordert den Aufruf einer Reihe einfacher APIs, wenn im Player Ereignisse auftreten.
    • Eine API, die Player-Informationen bereitstellt: Diese Informationen enthalten Details wie den Mediennamen und die Abspielposition.

  1. Fügen Sie Ihre heruntergeladene Bibliothek zu Ihrem Projekt hinzu. Erstellen Sie aus Gründen der Übersichtlichkeit lokale Referenzen auf die Klassen.

    1. Erweitern Sie die heruntergeladene Datei MediaSDK-js-v2.*.zip.

    2. Stellen Sie sicher, dass die Datei MediaSDK.min.js im Verzeichnis libs vorhanden ist:

    3. Hosten Sie die Datei MediaSDK.min.js.

      Diese Core-JavaScript-Datei muss auf einem Webserver gehostet werden, auf den alle Seiten Ihrer Site zugreifen können. Sie benötigen den Pfad zu diesen Dateien für den nächsten Schritt.

    4. Referenzieren Sie MediaSDK.min.js auf allen Webseiten.

      Integrieren Sie MediaSDK für JavaScript, in dem Sie dem Tag <head> oder <body> auf jeder Seite die folgende Codezeile hinzufügen. Beispiel:

      code language-none 
      <script type="text/javascript"
src="https://INSERT-DOMAIN-AND-PATH-TO-CODE-HERE/MediaSDK.min.js"></script>

    5. Um schnell zu überprüfen, ob die Bibliothek erfolgreich importiert wurde, instanziieren Sie die Klasse ADB.va.MediaHeartbeatConfig.

      note note
      NOTE
      Ab Version 2.1.0 entspricht das JavaScript-SDK den AMD- und CommonJS-Modulspezifikationen und VideoHeartbeat.min.js kann auch mit kompatiblen Module Loaders verwendet werden.

  2. Erstellen Sie lokale Verweise auf die MediaHeartbeat-Klassen, um den Zugriff auf die APIs zu erleichtern.

    code language-js 
    var MediaHeartbeat = ADB.va.MediaHeartbeat;
var MediaHeartbeatConfig = ADB.va.MediaHeartbeatConfig;
var MediaHeartbeatDelegate = ADB.va.MediaHeartbeatDelegate;

  3. Erstellen Sie eine MediaHeartbeatConfig-Instanz.

    In diesem Abschnitt erhalten Sie Informationen zu den MediaHeartbeat-Konfigurationsparametern und zum Festlegen der richtigen Konfigurationswerte für die MediaHeartbeat-Instanz, um Ereignisse genau zu verfolgen.

    Hier finden Sie eine Beispielinitialisierung für MediaHeartbeatConfig:

    code language-js 
    //Media Heartbeat initialization
var mediaConfig = new MediaHeartbeatConfig();
mediaConfig.trackingServer = Configuration.HEARTBEAT.TRACKING_SERVER;
mediaConfig.playerName = Configuration.PLAYER.NAME;
mediaConfig.channel = Configuration.HEARTBEAT.CHANNEL;
mediaConfig.debugLogging = true;
mediaConfig.appVersion = Configuration.HEARTBEAT.SDK;
mediaConfig.ssl = false;
mediaConfig.ovp = Configuration.HEARTBEAT.OVP;

  4. Implementieren Sie das MediaHeartbeatDelegate-Protokoll.

    code language-js 
    var mediaDelegate = new MediaHeartbeatDelegate();

// Replace <currentPlaybackTime> with the video player current playback time
mediaDelegate.getCurrentPlaybackTime = function() {
    return <currentPlaybackTime>;
};

// Replace <bitrate>, <startuptime>, <fps> and <droppeFrames> with the current playback QoS values.
mediaDelegate.getQoSObject = function() {
    return MediaHeartbeat.createQoSObject(<bitrate>, <startuptime>, <fps>, <droppedFrames>);
};

  5. Erstellen Sie die MediaHeartbeat-Instanz.

    Verwenden Sie MediaHeartbeatConfig und MediaHeartbeatDelegate, um die MediaHeartbeat-Instanz zu erstellen.

    code language-js 
    this.mediaHeartbeat = new MediaHeartbeat(mediaDelegate, mediaConfig, appMeasurement);
    note important
    IMPORTANT
    Stellen Sie sicher, dass die MediaHeartbeat-Instanz zugänglich ist und ihre Zuweisung nicht vor Ende der Mediensitzung aufgehoben wird. Diese Instanz wird für alle der folgenden-Tracking-Ereignisse verwendet.
    note tip
    TIP
    MediaHeartbeat erfordert eine AppMeasurement-Instanz, um Aufrufe an Adobe Analytics senden zu können. Beispiel für eine AppMeasurement-Instanz:
    code language-js 
    var appMeasurement = new AppMeasurement();
appMeasurement.visitor = visitor;
appMeasurement.trackingServer = "<visitor_namespace>.sc.omtrdc.net";
appMeasurement.account = <rsid>;
appMeasurement.pageName = <page_name>;
appMeasurement.charSet = "UTF­8";

Migrieren von JavaScript 1.x zu 2.x

In Version 2.x sind alle öffentlichen Methoden in der Klasse ADB.va.MediaHeartbeat konsolidiert, um die Arbeit der Entwickler zu erleichtern. Außerdem sind alle Konfigurationen nun in der ADB.va.MediaHeartbeatConfig-Klasse konsolidiert.

Informationen über die Migration von 1.x auf 2.x finden Sie in der Dokumentation zur Legacy-Implementierung.

recommendation-more-help
c8eee520-cef5-4f8c-a38a-d4952cfae4eb