VMAP XMLドキュメントをJavascriptオブジェクトにパースします。 VMAP 1.0.1 仕様に準拠。

Installation

Install with npm

npm install vmap

Usage

The VMAP constructor にパースしたバージョンの XML を提供することです。

以下に記述する API を使用して VMAP プロパティにアクセスします。

import VMAP from 'vmap';// Fetch VMAP as XMLconst xhr = new XMLHttpRequest();xhr.open('GET', vmapURL);xhr.send();xhr.onreadystatechange = function() { if (xhr.readyState === xhr.DONE) { if (xhr.status === 200) { // Get a parsed VMAP object const vmap = new VMAP(xhr.responseXML); } }};

API

VMAP

Properties

• version: VMAP version (should be 1.0).
• adBreaks: VMAPAdBreak オブジェクトの配列.
• extensions:
  • childrenを持つObjectの配列。 Object: この拡張子の子とその名前がキー
  • attribute として格納される。 Object はこの拡張子の属性とその名前をキー
  • value としてすべて含んでいます。 Object CDATA から解析されるか、またはフォールバックとしてこの拡張機能のすべてのテキスト ノードが連結されます

  VMAPAdBreak

  広告ブレークの情報を提供します。

  Properties

  • timeOffset:
  • breakType: アドブレークが「線形」、「非線形」、または「表示」広告を許可するかどうかを識別します。 アドブレークのオプションの文字列識別子です。
  • repeatAfter: アドブレークをリニアタイムラインに沿って互いに等間隔で配布するために使用されるオプションです。
  • adSource。 VMAPAdSource オブジェクト。
  • trackingEvents: トラッキングURLを含むObjectの配列
    • event: 要素のトラッキングするイベント名。 breakStart, breakEnd, errorのいずれかを指定します。
    • uri: トラッカーのURIです。 Object with
      • children の配列です。 Object: この拡張子の子とその名前をキーとして含む
      • attribute: Object はこの拡張子の属性とその名前をキー
      • value としてすべて含んでいます。 Object CDATA からパースされるか、または代替としてこの拡張機能のすべてのテキストノードが連結される

      Methods

      • track(event, errorCode): error イベントのオプションのエラー コード パラメータを使用して、指定されたイベントのトラッカーを呼び出します。

      VMAPAdSource

      インライン広告応答または広告応答への参照をプレーヤーに提供します。

      Properties

      • id 。
      • allowMultipleAds: VAST 広告ポッドまたは複数の広告バフェットを広告ブレークに提供できるかどうかを示します。
      • followRedirects: 動画プレーヤが広告応答内のリダイレクトを尊重すべきかどうかを示します。 埋め込み VAST 応答を含みます。
      • adTagURI。 VAST への URI を含みます。
      • customData: カスタム広告データを含む。

      サポートと互換性

      The library is 100% JavaScript で書かれており、ソース コードは modules, classes, ecc… といった最新の機能を使用しています。

      バンドル済みバージョン

      いくつかのバンドル済みバージョンを提供しています (dist ディレクトリを参照)

      Browser

      バンドル済みの VMAP-jsis バージョンが利用できます。 vmap-js.js.

      スクリプトを直接ページに追加して、VMAPコンストラクタからライブラリにアクセスできます。

      <script src="dist/vmap-js.js"></script>

      var vmap = new VMAP(vmapXML);

      Node

      node用のプレバンドル版も用意されています。 vmap-js-node.js.

      const VMAP = require('vmap')const vmap = new VMAP(vmapXML);

      Build and tests

      Install dependencies with:

      npm install

      The project is bundled using Rollup.このプロジェクトは、Rollup を使ってバンドルされています。 ビルド:

      npm run-script build

      テストの実行:

      npm test

      を使用します。