このセクションの記事

もっと見る

プレイヤーイベントのご利用方法

Avatar
更新

プレーヤーイベントはビデオグプレイヤーをお客様ページにiframeで埋め込む場合に、埋め込み先のお客様ページ（以後「埋込ページ」とする）で、分析に役立つ各種イベントを取得できる機能です。

 

〇目次

 

 

◯注意事項

プレーヤーイベントはWebMessagingというブラウザの機能により、iframeに操作の通知を行うことで動作します。この仕組みに対応していないブラウザではご利用になれません。

 

◯通知データ

イベントハンドラに渡されるMessageEventオブジェクトのdata属性には以下のような文字列が渡されます。

signature=videog_player_event&name=timeupdate&value_position={再生秒数}&hash={ハッシュ}&mymedia_num={動画番号}
  • 署名(signature) : "videog_player_event" ※全プレイヤーイベント共通
  • イベント名(name) : "timeupdate"
  • データ(value) : 再生秒数 ※プレイヤーバージョンがv2.1.x以下
  • データ(value_position) : 再生秒数 ※プレイヤーバージョンがv2.2.x以下
  • 動画ハッシュ(hash) : 動画固有のハッシュ
  • 動画番号(mymedia_num) : 管理画面上での動画番号


※パラメーターの順番は順不同です。

 

◯取得できるプレイヤーイベント

・プレイヤー関連

  1. 再生秒数
  2. 再生開始
  3. シーク時
  4. シーク後
  5. 一時停止
  6. 再生完了
  7. 再生位置
  8. ボリューム
  9. 倍速再生率

・動画広告関連

  1. 広告再生開始
  2. 広告一時停止
  3. 広告スキップ
  4. 広告再生完了

 

◯サンプル

プレイヤー関連

再生秒数

プレイヤーバージョンv2.1.x以下

値 説明 タイプ
value ※今後廃止予定  現在の再生位置（秒） 数値

コーディング例：

 

プレイヤーバージョンv2.2.x以上

値 説明 タイプ
value ※今後廃止予定  現在の再生位置（秒） 数値
value_position 現在の再生位置（秒） 数値

コーディング例：

 

再生開始

プレイヤーバージョンv2.1.x以下

  • 発火タイミング
    • 初回再生時
    • 一時停止後再生時。
      • playボタンをクリックした時
      • キーボードでseekする時
      • シークバーをクリックした時
      • ポインタをドラッグ＆ドロップで移動させた時
    • 再生完了後再生時
      • playボタンをクリックした時
値 説明 タイプ
なし なし なし

コーディング例(プレイヤーバージョンv2.1.x以下)：

 

プレイヤーバージョンv2.2.x以上

  • 発火タイミング
    • 初回再生時
    • 一時停止後再生時。
      • playボタンをクリックした時
      • キーボードでseekする時
      • シークバーをクリックした時
      • ポインタをドラッグ＆ドロップで移動させた時
    • 再生完了後再生時
      • playボタンをクリックした時
      • 再生完了後にシークバーをクリックでseekした時
      • 再生完了後にキーボード左キーでseekした時
      • 再生完了後にシークバーのポインタをドラッグ＆ドロップで移動させた時
値 説明 タイプ
value_position 現在の再生位置（秒） 数値

コーディング例(プレイヤーバージョンv2.2.x以上)：

 

シーク時

プレイヤーバージョンv2.1.x以下

値 説明 タイプ
なし なし なし

コーディング例(プレイヤーバージョンv2.1.x以下)：

 

プレイヤーバージョンv2.2.x以上

値 説明 タイプ
value_position シーク前の再生位置（秒） 数値
value_offset シーク後の再生位置（秒） 数値

コーディング例(プレイヤーバージョンv2.2.x以上)：

 

 

シーク後

プレイヤーバージョンv2.2.0以上

値 説明 タイプ
value_position シーク後の再生位置（秒） 数値

コーディング例：

 

一時停止

プレイヤーバージョンv2.1.x以下

値 説明 タイプ
なし なし なし

コーディング例(プレイヤーバージョンv2.1.x以下)：

 

プレイヤーバージョンv2.2.x以上

値 説明 タイプ
value_position 現在の再生位置（秒） 数値

コーディング例(プレイヤーバージョンv2.2.x以上)：

 

再生完了

プレイヤーバージョンv2.1.x以下

値 説明 タイプ
なし なし なし

コーディング例(プレイヤーバージョンv2.1.x以下)：

プレイヤーバージョンv2.2.x以上

値 説明 タイプ
value_position 現在の再生位置（秒） 数値

コーディング例(プレイヤーバージョンv2.2.x以上)：

 

再生位置

※本イベントをご利用の際はプレイヤーコマンドのgetPostionを合わせてご利用ください。

プレイヤーバージョンv2.2.0以上

値 説明 タイプ
value_position 現在の再生位置（秒） 数値

コーディング例：

 

ボリューム

プレイヤーバージョンv2.2.0以上

値 説明 タイプ
value_volume 現在のボリューム（%） 数値

コーディング例：

 

倍速再生率

プレイヤーバージョンv2.2.0以上

値 説明 タイプ
playbackRate 現在の速度（%）

数値

コーディング例：

 

広告関連

広告再生開始

値 説明 タイプ
なし 新しい再生速度の値（0.25 , 0.5 , 0.75 , 1 , 1.25 , 1.5 , 2） number

コーディング例：

 

 

広告一時停止

値 説明 タイプ
なし なし なし

コーディング例：

 

広告スキップ

値 説明 タイプ
なし なし なし

コーディング例：

 

広告再生完了

値 説明 タイプ
なし なし なし

コーディング例：

関連記事