JavaScript 2.x のセットアップ set-up-javascript
前提条件
-
有効な設定パラメーターを取得 これらのパラメーターは、Analytics アカウントの設定後、アドビの担当者から取得できます。
-
JavaScript 向け
AppMeasurementをメディアアプリケーションに実装 Adobe Mobile SDK のドキュメントについて詳しくは、JavaScript を使用した Analytics の実装を参照してください。 -
メディアプレーヤーで以下の機能を設定します。
- プレーヤーイベントをサブスクライブするための API - メディア SDK では、プレーヤーでイベントが発生する際に、シンプルな API のセットを呼び出す必要があります。
- プレーヤー情報を提供する API - メディア名や再生ヘッドなどの情報がこれに該当します。
-
ダウンロードしたライブラリをプロジェクトに追加します。利便性のために、クラスへのローカル参照を作成します。
-
ダウンロードした
MediaSDK-js-v2.*.zipファイルを展開します。 -
libsディレクトリにMediaSDK.min.jsファイルが存在することを確認します。 -
MediaSDK.min.jsファイルをホストします。このコア JavaScript ファイルは、サイトのすべてのページから参照可能な Web サーバーでホストする必要があります。次の手順で、これらのファイルへのパス情報が必要になります。
-
サイトのすべてのページから
MediaSDK.min.jsを参照します。各ページの
<head>タグまたは<body>タグに以下のコードを追加して、JavaScript 用のMediaSDKを含めます。次に例を示します。code language-none <script type="text/javascript" src="https://INSERT-DOMAIN-AND-PATH-TO-CODE-HERE/MediaSDK.min.js"></script> -
ライブラリが正しくインポートされたことをすばやく確認するには、
ADB.va.MediaHeartbeatConfigクラスをインスタンス化します。note note NOTE バージョン 2.1.0 以降の JavaScript SDK は、AMD および CommonJS モジュールの仕様に準拠しており、互換性のあるモジュールローダーと共に VideoHeartbeat.min.jsを使用することもできます。
-
-
API に簡単にアクセスできるように、
MediaHeartbeatクラスへのローカル参照を作成します。code language-js var MediaHeartbeat = ADB.va.MediaHeartbeat; var MediaHeartbeatConfig = ADB.va.MediaHeartbeatConfig; var MediaHeartbeatDelegate = ADB.va.MediaHeartbeatDelegate; -
MediaHeartbeatConfigインスタンスを作成します。ここでは、
MediaHeartbeat設定パラメーターと、正確な追跡のためにMediaHeartbeatインスタンスに正しい設定値を設定する方法について説明します。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; -
MediaHeartbeatDelegateプロトコルを実装します。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>); }; -
MediaHeartbeatインスタンスを作成します。MediaHeartbeatConfigおよびMediaHeartbeatDelegateを使用して、MediaHeartbeatインスタンスを作成します。code language-js this.mediaHeartbeat = new MediaHeartbeat(mediaDelegate, mediaConfig, appMeasurement);note important IMPORTANT MediaHeartbeatインスタンスがアクセス可能であることと、メディアセッションの終わりまで解放されないことを確認します。このインスタンスは、以下のすべてのトラッキングイベントに使用されます。note tip TIP MediaHeartbeatが Adobe Analytics に呼び出しを送信するためには、AppMeasurementのインスタンスが必要です。以下に、AppMeasurementインスタンスの例を示します。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 = "UTF8";
JavaScript 1.x から 2.x への移行
バージョン 2.x では、すべてのパブリックメソッドは、開発をより簡単にするために、ADB.va.MediaHeartbeat クラスに統合されています。また、すべての設定は、ADB.va.MediaHeartbeatConfig クラスに統合されました。
1.x から 2.x への移行について詳しくは、レガシー実装のドキュメントを参照してください。