サポート問い合わせ先| システムステータス
ページコンテンツ

    概要:Data Collection APIv2

    このトピックでは、Analytics Data Collection API v2の概要を説明します。これにより、Brightcoveがイベントを直接追跡できない状況で、Video CloudAnalyticsデータにイベントを追加できます。

    入門

    アナリティクスデータは、ネイティブプレーヤー SDK によって提供されるものを含め、ブライトコーブプレーヤーによって自動的に送信されます。Video Cloud 動画の配信に Brightcove Player を使用していない場合は、データコレクターにデータを送信するのに使用しているプレーヤーを計測する必要があります。

    Data Collection APIv2が現在の標準です。v1バージョンは非推奨です。v1を実装している場合は、 v1からの変更以下のセクション。

    この概要とAPIリファレンス、これも参照してくださいサンプル実装

    Analytics Data Collection APIは、リアルタイム分析イベントのエンドポイントです。イベントデータは、次のようなHTTPリクエストを介して送信された一連のパラメータを介してBrightcoveに送信されます。

      http://metrics.brightcove.com/v2/tracker?event=video_view&domain=videocloud&account=123&video=789
      
      

    これらのパラメータは、事実イベントが発生したときのシステムの状態について。上記の例は、video_viewビデオでイベントが発生しました789アカウント用123(または:ユーザーがアカウントの視聴を開始しました123のビデオ789。見る未満追跡されている現在の分析イベントの説明について)。

    サイズ

    ディメンションは、イベントが発生したときのシステムの状態に関する定性的な事実です。たとえば、リクエストが次の場合:

      http://metrics.brightcove.com/tracker
      ?event=video_view&session=581136_2018-07-03T18:34:46.214Z
      &domain=videocloud&account=123
      &video=789
      
      

    ビデオID(789)およびアカウントID(123)、およびリクエスト自体から収集されたデバイスと場所の情報はすべて、video_viewイベント。分析システムはそれを記録しますvideo_viewこのリクエストが行われたときに、これらのディメンションでイベントが発生しました。

    イベントとドメインのパラメータ

    ザ・eventパラメータは、発生したイベントを記述します。ザ・domainパラメータは、イベントの名前空間を提供します。ザ・eventdomain、およびsession必須パラメータです(の値domain常にvideocloud)。

    追加のパラメーター

    Analyticsシステムがイベントを正常に分析できるように、特定のパラメーターをイベントに含める必要があります

    応答タイプ

    分析Data Collection APIリクエストへの応答には、HTTP応答コードと人間が読めるメッセージが含まれます。

    HTTPステータスコード 説明
    200 リクエストはコレクターによって正常に受信され、永続化されています。 (1x1ピクセルの透明なGIF画像を返します)
    400 クライアントから送信されたリクエストに必要なパラメータがありません:domainaccountまたはevent。(ドメイン固有のパラメーターが欠落している場合、このステータスは返されません。) "Invalid 'event' parameter"
    50x これはエラーコードであり、サーバー側に問題があることを示しています。イベントは、分析システムによって正常に記録されている場合とされていない場合があります。 "Server-side failure, please retry."

    VODとライブイベント

    ライブイベント

    Data Collection APIがイベントを次のように分類するには、次の条件を満たす必要があります。住む

    • リクエストする必要がありますない video_durationパラメータがあります。
    • リクエストにはアカウントパラメータが必要です。
    • リクエストにはビデオパラメータが必要です。
    • イベントタイプは、次のいずれかである必要があります。
      • video_impression
      • video_view
      • video_engagement
      • alive_ss_ad_start
    • アカウントは、ライブビデオストリーミングのBrightcoveサポートによって有効にされている必要があります。

    VOD

    を含むリクエストvideo_durationパラメータは次のように分類されますVOD

    最小限のデータ

    少なくとも、送信する必要がありますsession idとvideo_viewセッション中に再生されるすべてのビデオのイベント。NS video_view送信する必要があります プレロール広告が完了します。

    session

    これはセッション識別子です。ザ・session本質的には、プレーヤーが含まれているページまたはアプリビューの1つのビューであり、それが続く限りです。値は、セッションの間一定である必要があり、すべてのイベントに送信。グローバル一意識別子(GUID)にできるだけ近い必要があります。衝突が発生した場合、2つのセッションを解くことができないと、無効として破棄される可能性があります。

    JavaScriptでGUIDを作成するためのさまざまなスキームがあります。一例はこのGitHubリポジトリ。サードパーティのスクリプトはBrightcoveではサポートされていないことに注意してください。

    パフォーマンスの最小限のデータ(プレイレートとエンゲージメントスコア)

    イベント

    • video_impression
    • video_view
    • video_engagement

    属性(すべてのイベント)

    • account
    • video

    追加の属性(video_engagementイベントのみ)

    VOD
    • range
    • video_duration
    ライブ
    • video_seconds_viewed

    HTTPヘッダー

    • User-Agent -デバイスレポートに必要

    ベストプラクティス

    コレクターに正しいデータを送信していることを確認するには、データ収集スクリプトを一般的にデプロイする前にテストする必要があります。おすすめ:

    1. プレーヤーのデータ収集スクリプトを作成します。
    2. 制御された環境で少なくとも1日テストします。
    3. 分析モジュールまたは分析モジュールを介して分析データを確認します。 Analytics API収集されたものがあなたの期待に一致することを保証するため。

    リクエストの送信-CORSの問題の回避

    ジャンクデータ

    一般に、コレクターに送信されたデータは、分析システムによって真実として記録されます。イベントに不適切または不正確な情報が含まれている場合、Analyticsシステムはデータを誤って解釈します。

    たとえば、誤ってタイムスタンプをビデオIDとして送信した場合、分析データは全体的な要約に影響を与える方法で歪められます。

    URI エンコード

    スペースや特殊文字を含む可能性のあるData Collection APIに送信する文字列URIエンコードする必要がありますリクエストが成功するために。JavaScriptを介してリクエストを送信する場合は、encodeURI()メソッドは、リクエスト文字列をエンコードします。例は次のとおりです。

      urlStr += "&video=" + currentVideo.id + "&video_name=" + encodeURI(currentVideo.video_name);
      
      

    イベント

    以下にリストされているイベントは、Analyticsシステムによって処理されます。

    player_load
    意図/意味

    プレーヤーセッションがエンドユーザーによって開始されました。これは分析セッションの開始を示し、他のイベントの前に送信する必要があります。

    http://metrics.brightcove.com/tracker
      ?event=player_load
      &session=581136_2018-07-03T18:34:46.214Z
      &destination=http%3A-%2F%2Fsup-port.brightcove.com%2F
      &source=http%3A-%2F%2Fwww.google.com
      %2Furl%3Fsa%3D-t%26rct%3Dj%26q%3D%26esrc%3Ds%26source
      %253A-%252F%252Fsupport.brightcove.com%252F%26ei%3D
      OdxWZSGdJ-pL7WJaEeUJVlnw%26bvm%3Dbv.51156542%2Cd.dmg
      &domain=videocloud
      &account=1749339200
      &time=1377191644796
    error
    意図/意味

    再生体験を妨げる致命的なエラーが発生したときに送信されます。

    http://metrics.brightcove.com/tracker
      ?event=error
      &error_code=MEDIA_ERR_SRC_NOT_SUPPORTED
      &session=581136_2018-07-03T18:34:46.214Z
      &destination=http%3A-%2F%2Fsup-port.brightcove.com%2F
      &source=http%3A-%2F%2Fwww.google.com
      %3Dhttp%253A-%252F%252Fsupport.brightcove.com
      %26usgWZSGdJ-pL7WJaEeUJVlnw%26bvm%3Dbv.51156542%2Cd.dmg
      &domain=videocloud
      &account=1749339200
      &time=1377191644796
    catalog_request
    意図/意味

    ビデオクラウドPlayback APIへのリクエストが行われたときに送信されます。

    http://metrics.brightcove.com/tracker
      ?event=catalog_request
      &session=581136_2018-07-03T18:34:46.214Z
      &catalog_url=https%3A%2F%2Fedge.api.brightcove.com%2Fplayback
      &destination=http%3A-%2F%2Fsup-port.brightcove.com%2F
      &source=http%3A-%2F%2Fwww.google.com
      %3Dhttp%253A-%252F%252Fsupport.brightcove.com
      WZSGdJ-pL7WJaEeUJVlnw%26bvm%3Dbv.51156542%2Cd.dmg
      &domain=videocloud&account=1749339200
      &time=1377191644796
    catalog_response
    意図/意味

    前への応答時に送信されますcatalog_request受け取ります。

    http://metrics.brightcove.com/tracker
      ?event=catalog_response
      &session=581136_2018-07-03T18:34:46.
      &catalog_url=https%3A%2F%2Fedge.api.brightcove.com%2Fp2F23823423800
      &response_time_ms=243
      &destination=http%3A-%2F%2Fsup-port.brightcove.com%2F
      &source=http%3A-%2F%2Fwww.google.com
      53A-%252F%252Fsupport.brightcove.com%252F%2Tzn-oCgCQ
      AFQjCNJaEeUJVlnw%26bvm%3Dbv.51156542%2Cd.dmg
      &domain=videocloud
      &account=1749339200
      &time=1377191644796
    play_request
    意図/意味

    ユーザーが明示的に再生ボタンをクリックしたときに再生が開始されたとき、またはプラットフォームが自動再生シナリオで再生をトリガーしたときに自動的に送信されます。複数のことに注意してくださいplay_request視聴者がビデオを一時停止および再開した場合、1回の視聴セッション中にイベントが送信されることがあります。

    http://metrics.brightcove.com/tracker
      ?event=play_request
      &session=581136_2018-07-03T18:34:46.214Z
      &destination=http%3A-%2F%2Fsup-port.brightcove.com%2F
      &source=http%3A-%2F%2Fwww.google.com
      %3Dhttp%253A-%252F%252Fsupport.brightcove.com%252F%2
      dJ-pL7WJaEeUJVlnw%26bvm%3Dbv.51156542%2Cd.dmg
      &domain=videocloud
      &account=1749339200
      &time=1377191644796
    ad_mode_begin
    意図/意味

    再生プラットフォームによってコントロールが広告エージェントに引き渡されたときに送信されます。

    http://metrics.brightcove.com/tracker
      ?event=ad_mode_begin
      &session=581136_2018-07-03T18:34:46.214Z
      &destination=http%3A-%2F%2Fsup-port.brightcove.com%2F
      &source=http%3A-%2F%2Fwww.google.com
      %3Dhttp%253A-%252F%252Fsupport.brightcove.com%252
      %26usg%3DAFQjCNEtLod%3Dbv.51156542%2Cd.dmg
      &domain=videocloud
      &account=1749339200
      &time=1377191644796
    ad_mode_complete
    意図/意味

    再生プラットフォームによってコントロールが広告エージェントに引き渡されたときに送信されます。

    http://metrics.brightcove.com/tracker
      ?event=ad_mode_complete
      &session=581136_2018-07-03T18:34:46.214Z
      &destination=http%3A-%2F%2Fsup-port.brightcove.com%2F
      &source=http%3A-%2F%2Fwww.google.com
      %3Dhttp%253A-%252F%252Fsupport.brightcove.com%252F%2
      WZSGdJ-pL7WJaEeUJVlnw%26bvm%3Dbv.51156542%2Cd.dmg
      &domain=videocloud
      &account=1749339200
      &time=1377191644796
    video_impression
    意図/意味

    プレーヤーに追加されたビデオのメタデータの読み込みが完了し、プレーヤーは自動再生またはユーザー操作のいずれかを介してビューイベントをトリガーする準備ができています。

    http://metrics.brightcove.com/tracker
      ?event=video_impression
      &session=581136_2018-07-03T18:34:46.214Z
      &destination=http%3A%2F%2Fwww.current-times.com%2F
      &time=1377191644801
      &source=http%3A%2F%2Fwww.google.com
      %252-F%26ei%3DoEYWUtCgEIXq9ATznoCgCQ
      %26usg%3DAFQjCNEtLod-Odx6bvm%3Dbv.5115-6542%2Cd.dmg
      &video=2621468623001
      &video_name=Democratic-Rivals%20Target%20Bill
      &domain=videocloud
      &account=1749339200
    video_view
    意図/意味

    ビデオの再生が開始されました(ロード後の自動再生、またはユーザーの操作による)。1つだけであることに注意してくださいvideo_viewイベントは、視聴者がビデオを停止して再起動または再生した場合でも、視聴セッション中に記録されます。

    http://metrics.brightcove.com/tracker
      ?event=video_view
      &session=581136_2018-07-03T18:34:46.214Z
      &destination=http%3A%2F%2Fwww.current-times.com%2F
      &video=2621468623001
      &video_name=Debate-2
      &video_duration=189
      &time=1377191666432
      &source=http%3A%2F%2Fwww.google.com%2Furl%
      %252F%26ei%3DoEYWUtCgEIXq9ATznoCgCQ%26us-g
      %3DAFQjCNEtv.51156542%2Cd.dmg
      &domain=videocloud
      &account=1749339200
    video_engagement
    意図/意味

    ユーザーが動画のタイムラインの秒の範囲を視聴しました。このイベントは、動画エンゲージメントを追跡するためのハートビートであり、ユーザーの操作と動画の長さによっては、再生中に何回も送信されます。再生が中断されない場合、Brightcoveプレーヤーインストルメンテーションはこのイベントを10秒ごとに送信します。20秒を超える範囲を説明するイベントは、Analyticsシステムによって破棄されます。

    http://metrics.brightcove.com/tracker
      ?event=video_engagement
      &session=581136_2018-07-03T18:34:46.214Z
      &destination=http%3A%2F%2Fwww.current-times.com%2F
      &video=2621468623001
      &video_name=Debate-2
      &video_duration=189
      &time=1377191676589
      &range=0..9
      &source=http%3A%2F%2Fwww.google.com
      %2Furl%3Fsa%3Dt-%26rct%3Dj%26q%3D%26esrc%3Ds
      %26source%3Dweb%26cd%3D1%26ved%3D0CDYQFjAA
      %26url%3Dhttp%253A%252F%252Fwww.current-times.com
      %252F%26ei%3DoEYWUtC-gEIXq9ATznoCgCQ
      %26usg%3DAFQjCNEtLodOdxWZSGdJpL7WJ.51156542%2Cd.dmg
      &domain=videocloud
      &account=1749339200

    すべてのイベントのパラメーター

    これらのイベントのパラメーターには、イベントが発生したときのシステムの現在の状態に関連する情報を含める必要があり、可能な限り具体的にする必要があります。このセクションでは、すべてのイベントで送信できるパラメーターについて詳しく説明します。次のセクションでは、特定のイベントのパラメーターを示します。

    フィールド タイプ 説明
    account 文字列

    アカウント ID

    domain 文字列

    常に等しいvideocloud

    許容値:"videocloud"

    session 文字列 可能な限り普遍的に一意であるセッションID-を参照してください最小限のデータ詳細については、上記のセクション
    device_osオプション 文字列

    ユーザーエージェントが信頼できない場合(デバイスOSとデバイスタイプの両方が含まれていない場合、または送信された値がここに表示されている値のリストにない場合は無視されます)、イベントを発生させたデバイスのOSを指定するようにオーバーライドします。通常は含まれません )

    許容値:"android""bada""ios""linux""mac""tv""os_x""rim""sybian""windows""other"

    device_os_versionオプション 文字列

    デバイスで使用されている OS のバージョン。指定されていない場合、これは追跡要求のユーザーエージェント文字列を解析することによって計算されます

    device_typeオプション 文字列

    ユーザーエージェントが信頼できない場合(デバイスOSとデバイスタイプの両方が含まれていない場合、または送信された値がここに表示されている値のリストにない場合は無視されます)、イベントを発生させたデバイスのタイプを指定するようにオーバーライドします。通常は含まれません )

    許容値:"mobile""tablet""tv""desktop""other"

    event 文字列

    イベントタイプ

    許容値:"player_load""catalog_request""catalog_response""play_request""ad_mode_begin""ad_mode_complete""video_impression""video_view""video_engagement""error"

    destinationオプション 文字列

    イベントを発生させたURI

    sourceオプション 文字列

    エンドユーザーをに送信したURI destination URI

    timeオプション 数値

    エポック時間でのイベントのタイムスタンプ(ミリ秒)

    countryオプション 文字列

    ISO-3166(アルファ2)リージョンcISO-3166(アルファ2)リージョンコード(システムがIPアドレスから地理情報を検出できない場合にオーバーライド)通常は含まれません

    country_nameオプション 文字列

    人間が読める国の名前(システムがIPアドレスから地理情報を検出できない場合は上書きします)通常は含まれません

    regionオプション 文字列

    ISO-3166(アルファ2)地域コード(システムがIPアドレスから地理情報を検出できない場合にオーバーライド)通常は含まれません

    region_nameオプション 文字列

    人間が読める地域名(システムがIPアドレスから地理情報を検出できない場合にオーバーライド)通常は含まれません

    cityオプション 文字列

    市の名前通常は含まれません

    userオプション 文字列

    一意のユーザー識別子-提供されていないか空白の場合、VideoCloudはフォールバック方式を使用してSource IP address + the User-Agent一意の識別子としての文字列。 Brightcoveは、この情報を一意のユーザーの計算にのみ使用することに注意してください。APIまたはAnalyticsモジュールを介してユーザーデータ自体を取得することはできません

    ユーザーパラメータ

    • プレーヤー/クライアントアプリケーションが一意のビューアを追跡する場合は、ユーザーパラメータとしてユーザーの一意のIDをコレクタに送信する必要があります。
    • の場合user提供されていないか空白の場合は、フォールバック方式を使用します。Source IP address + the User-Agent String一意の識別子として。
    • ユーザーパラメータの値がログ/データベースに保存されることはなく、ハッシュ(SHA-256を使用)のみが保存されます。
    • コレクターによってCookieは設定されません。

    ユニークユーザー

    Brightcove Playerのプラグイン機能を使用して、レポートされた分析に固有のビデオビューアデータを追加できます。これを行うには、一意の識別子をに追加しますsettings分析機能のオブジェクト。

    もちろん、一意のユーザーIDを取得する方法はアプリケーションごとに異なりますが、たとえば、このコードは、次のような一意のユーザーデータを含むログインURLが取得されることを前提としています。 http://exampledomain.com/users/912389123。この一意のURLはプラグインに渡されます。

    以下のプラグインのコードは、次のタスクを実行します。

    • 標準構文を使用して、プラグイン名が次のように定義されたBrightcovePlayerプラグインを作成します。uniqueUserForAnalyticsPlugin。プラグインは、optionsプラグインに渡されたデータを含むオブジェクト。
    • ザ・myPlayer変数には、プレーヤーへの参照が割り当てられます。同様に、他の2つの変数が作成されます。
    • ザ・userPath変数には、プラグインに渡されるパスが割り当てられます。optionsオブジェクト。
    • ザ・uniqueViewer変数には、解析されたバージョンのuserPath、したがって、ユーザーIDの数字のみが変数に割り当てられます。
    • ユーザープロパティがAnalyticsプラグインに追加されますsettingsオブジェクト。
      videojs.registerPlugin('uniqueUserForAnalyticsPlugin', function(options) {
      var myPlayer = this,
      userPath = '',
      uniqueViewer = '';
      //Assign uniqueViewer a value according to your app and business rules
      //In this example, parsing the path passed to the plugin in the options object
      userPath = options.path;
      uniqueViewer = userPath.substring( userPath.lastIndexOf('/') + 1 );
      //Assign a user variable to Analytic's settings object
      myPlayer.bcAnalytics.client.user(USER) = uniqueViewer;
      });
      
      

    このコードは、アプリケーションロジックに合わせて変更し、インターネットでアクセス可能なURLに保存する必要があります。

    Studioから、プラグイン示されているように、プレーヤーにプラグインをロードするセクション。

    Studio Plugin Section
    スタジオプラグインセクション

    次のJSONの代わりに、ユーザーデータを含む文字列をプラグインに渡します。もちろん、一意のユーザーIDを抽出するには、それに応じてプラグインコードを更新する必要があります。

      {
      "path": "http://exampledomain.com/users/912389123"
      }
      
      

    プラグイン開発の詳細については、ステップバイステップ:プラグイン開発資料。

    device_typedevice_osdevice_os_versiondevice_manufacturer、およびbrowser_typeパラメーター

    デフォルトでは、AnalyticsシステムはUser-AgentヘッダーからデバイスタイプとOS情報を検出しようとします。場合どちらもdevice_typeそしてdevice_osが送信されると、User-Agentヘッダーからの情報は無視され、device_typeそしてdevice_osほとんどの場合、デバイス、OS、およびブラウザーの情報を送信する必要はありません。 -このオーバーライドは、User-Agentが信頼できないか、そうでなければ利用できない場合にのみ使用する必要があります。

    分析システムは記録しますotherリクエストにデバイスパラメータオーバーライドの認識されない値が含まれている場合。

    地理データパラメータ

    デフォルトでは、AnalyticsシステムはリモートIPアドレスから地理情報を検出しようとします。この動作は、渡すことでオーバーライドできますcountrycountry_nameregionregion_namecityそしてdmaパラメーター。ほとんどの場合、これらのパラメーターは必要ありません -このオーバーライドは、リモートIPアドレスが信頼できない場合、またはその他の方法で使用できない場合にのみ使用する必要があります。

    分析システムは記録しますZZまたはunknownリクエストにオーバーライドの認識されない値が含まれている場合。

    宛先およびソースパラメータ

    ザ・destinationそしてsourceパラメータは、イベントを発生させたURIを提供します(destination)およびユーザーをそこに送信したURI(source)。

    ザ・sourceパラメータは、トラフィックソース情報を決定するために使用されます。場合source指定されていない場合、Analyticsシステムはイベントを直接トラフィックによって開始されたものとして扱います。

    ザ・destinationパラメータは、トラフィックの宛先情報、つまりビデオが視聴されている場所を決定するために使用されます。URI に権限が含まれていない場合、API はを記録しませんdestination_domaindestination_pathは URI のパスとして記録されます。

    Web再生中、ビデオが再生されているページのアドレスバーのURLはdestination、 そしてそのsourceリファラーです(top.document.referrer)。

    たとえば、Brightcoveサポートサイトで「ライブストリーミングワイヤーキャスト」を検索し、結果に表示されるビデオを見る場合、次のようになります。

    パラメーター
    source
      https://support.brightcove.com/en/video-cloud/search/live%20streaming%20wirecast
      
      
    destination
      https://support.brightcove.com/en/video-cloud/training-videos/live-streaming-wirecast
      
      

    URLがない場合(たとえば、ネイティブ再生の場合など)、両方destinationそしてsourceビデオが再生されている場所とユーザーがそこに到達した方法をそれぞれ識別する有効なURIである必要があります。

    と仮定してdestination有効なURI

      <scheme name> : <hierarchical part> [ ? <query> ] [ # <fragment> ]
      ex. https://www.example.com/foo/bar/baz
     
    ---
    -----------/----------/
      |             |
      authority        path
     
    ---
    /   
    ---
    ----------------------/
      |                |
      scheme       hierarchical part
      
      

    Analyticsシステムはそれを次のように処理します。

    URIにが含まれている場合権限、API応答は、その権限をdestination_domainおよびとして提供されるパスdestination_path。URI に権限が含まれていない場合、API はを記録しませんdestination_domaindestination_pathは URI のパスとして記録されます。A destination階層部分がない場合(たとえば、スキームのみ)は、スキームがない場合と同様に無効と見なされます。

    特定のイベントのパラメーター

    エラーイベントパラメータ

    次のパラメータを一緒に送信する必要がありますerrorイベント。

    フィールド タイプ 説明
    error_codeオプション 数値

    イベントに関連付けられたプラットフォーム固有のエラーコード

    catalog_requestイベントパラメータ

    次のパラメータを一緒に送信する必要がありますcatalog_requestイベント。

    フィールド タイプ 説明
    catalog_urlオプション 文字列

    catalog_requestイベントに関連付けられた宛先URL

    catalog_responseイベントパラメータ

    次のパラメータを一緒に送信する必要がありますcatalog_responseイベント。

    フィールド タイプ 説明
    catalog_urlオプション 文字列

    この応答を開始したcatalog_requestイベントに関連付けられた宛先URL

    response_time_msオプション 数値

    catalog_requestイベントとcatalog_responseイベントの間のミリ秒単位の時間

    video_impressionイベントパラメータ

    次のパラメータを一緒に送信する必要がありますvideo_impressionイベント。

    フィールド タイプ 説明
    videoオプション 文字列

    動画ID

    video_nameオプション 文字列

    動画の名前

    video_viewイベントパラメータ

    次のパラメータを一緒に送信する必要がありますvideo_viewイベント。

    フィールド タイプ 説明
    videoオプション 文字列

    動画ID

    video_nameオプション 文字列

    動画の名前

    start_time_msオプション 文字列

    再生の開始からレンダリングされるビデオの最初のフレームまでの時間(ミリ秒単位)。これはエクスペリエンスによって異なる場合があります。たとえば、プレロール広告が設定されていない場合、この測定値はplay_requestそしてvideo_viewイベント。プレロール広告がある場合、その間の時間ad_mode_beginそしてad_mode_complete含めるべきではありません

    video_engagementイベントパラメータ

    次のパラメータを一緒に送信する必要がありますvideo_engagementイベント。

    フィールド タイプ 説明
    videoオプション 文字列

    動画ID

    video_nameオプション 文字列

    動画の名前

    rangeオプション 文字列

    視聴されたビデオの範囲video_engagement形式のイベントStartSecond..EndSecond(StartSecondとEndSecondの値は整数[整数]である必要があります)-範囲はエンゲージメントイベントから除外して、イベントの対象期間中に視聴アクティビティがなかったことを示すことができます。 (たとえば、再バッファリングアクティビティのみがある場合)

    rendition_urlオプション 文字列

    最後に選択したレンディションへの URL。たとえば、HLSストリームの場合、これは最後に選択されたバリアントへのURLになります

    rendition_indicated_bpsオプション 文字列

    最近選択されたレンディションの表示されたビットレート(ビット/秒)

    rendition_mime_typeオプション 文字列

    最近選択されたレンディションのmimeタイプ

    rendition_heightオプション 文字列

    ビデオレンディションのエンコードされた高さ(ピクセル単位)

    rendition_widthオプション 文字列

    ビデオレンディションのエンコードされた幅(ピクセル単位)

    rebuffering_secondsオプション 文字列

    エンゲージメント期間中の要求されていない遅延のために、ユーザーがビデオの再生を待機するのに費やした秒数

    rebuffering_countオプション 文字列

    エンゲージメント期間中の表されたエンゲージメント期間の遅延中に再バッファリングが原因で再生が停止した回数

    forward_buffer_secondsオプション 文字列

    現在転送バッファにあるビデオの秒数

    measured_bpsオプション 文字列

    最近ダウンロードされたセグメントに含まれるビット数と、そのセグメントのダウンロードに費やされた時間の比率(ビット/秒)

    player_widthオプション 文字列

    エンゲージメント範囲の終了時のプレーヤーの現在のピクセル幅

    player_heightオプション 文字列

    エンゲージメント範囲の終了時のプレーヤーの現在のピクセルの高さ

    dropped_framesオプション 文字列

    dropped_frames

    video_durationオプション 数値

    秒単位のビデオの長さ

    video_seconds_viewedオプション 数値

    の最後の更新以降に監視された秒数video_engagementイベント

    ザ・video_engagementイベントは、動画の再生中に動画のエンゲージメントを追跡する手段であり、再生中に何度も送信される可能性があります。(再生が中断されない場合、Flash / HTML5プレーヤーインストルメンテーションはこのイベントを10秒ごとに送信します。)現在、20秒を超える範囲を表すイベントは、Analyticsシステムによって破棄されるため、これらのイベントをより頻繁に送信する必要があります。

    2つの形式がありますvideo_engagementイベントは取ることができます(簡潔にするために他のパラメーターは省略されています):

    意味
      event=video_engagement&video=123&video_duration=75&range=0..9
      
      
    ビデオ123 75秒の長さで0から9秒まで再生されました(合計10秒が表示されました)。
    event=video_engagement&video=123&video_seconds_viewed=10 10秒のビデオ123見られました。

    どちらのバージョンも視聴秒数を追跡しますが、video_durationそしてrange追加のエンゲージメントデータを計算するために必要な情報も含まれています。推奨される方法送信するvideo_engagement分析システムへのイベントデータ。ライブストリームの場合、または再生中にビデオのタイムラインが継続的に変更される場合、またはその他の点で信頼性が低い場合は、video_seconds_viewed利用可能な唯一のデータになります。VODの場合、duration利用できません、video_engagementイベントには含める必要がありますvideo_durationそしてrange

    パラメーター 派生エンゲージメント指標(API)
    video_durationrange video_seconds_viewedvideo_percent_viewedengagement_score ;エンゲージメントカーブデータ
    video_seconds_viewed video_seconds_viewed

    3つのパラメータすべての場合(video_durationrangeそしてvideo_seconds_viewed)と一緒に送信されますvideo_engagementイベントの場合、分析システムはからエンゲージメント指標を計算しますvideo_duration + rangeパラメーター。

    V2の変更

    このセクションでは、v1を使用しているユーザー向けに、データコレクターのv1からv2への変更の概要を示します。

    トラッカーのベースURL

      http(s)://metrics.brightcove.com/v2
      
      

    すべてのイベントでサポートされる追加のフィールド:

    device_os_version:デバイスで使用されている OS のバージョン。指定されていない場合、これは追跡要求のユーザーエージェント文字列を解析することによって計算されます。

    platform_version:指定されたプラットフォームの新しいリリースがイベントの送信に使用されていることを示すために使用されます。

    V2の新しいイベント

    catalog_request:videocloudカタログAPIへのリクエストが行われたときに送信されます-このイベントは内部使用のためであり、AnalyticsモジュールまたはAnalytics APIを介して公開されないことに注意してください。

    • catalog_url :に関連付けられているリンク先URL catalog_requestイベント-このイベントは内部使用のためであり、AnalyticsモジュールまたはAnalytics APIを介して公開されないことに注意してください。

    catalog_response:前への応答時に送信されますcatalog_request受信-このイベントは内部使用のためであり、AnalyticsモジュールまたはAnalytics APIを介して公開されないことに注意してください。

    • catalog_url :に関連付けられているリンク先URL catalog_requestこの応答を開始したイベント-このイベントは内部使用のためであり、AnalyticsモジュールまたはAnalytics APIを介して公開されないことに注意してください。
    • response_time_ms:ミリ秒単位の時間catalog_requestイベントとcatalog_responseイベント-このイベントは内部使用のためであり、AnalyticsモジュールまたはAnalytics APIを介して公開されないことに注意してください。

    play_request:ユーザーが明示的に再生ボタンをクリックしたときに再生が開始されたとき、またはプラットフォームが自動再生シナリオで再生をトリガーしたときに自動的に送信されます。

    ad_mode_begin:[置換ad_start ]再生プラットフォームから広告代理店にコントロールが渡されたときに送信されます。

    ad_mode_complete:[置換ad_end ]広告代理店から再生プラットフォームに制御が戻されたときに送信されます。

    エラー:再生体験を妨げる致命的なエラーが発生したときに送信されます。

    • エラーコード:イベントに関連付けられたプラットフォーム固有のエラーコード。

    V2の更新されたイベント

    video_view:新しいレイテンシ測定が含まれています

    • load_time_ms:ビデオのデータロードを開始してからビデオが再生可能になるまでの時間(ミリ秒単位)。
    • start_time_ms:再生の開始からレンダリングされるビデオの最初のフレームまでの時間(ミリ秒単位)。これはエクスペリエンスによって異なる場合があります。たとえば、プレロール広告が設定されていない場合、この測定値は 'play_request間の時間です。' とvideo_viewイベント。プレロール広告がある場合、その間の時間ad_mode_beginそしてad_mode_complete含まれるべきではありません。

    video_engagement:追加のレンディション選択、ビットレート測定、およびバッファリング情報が含まれます。ビデオエンゲージメントにも微妙な変更が加えられ、エンゲージメント期間中に視聴が発生しなかった場合でも定期的に送信する必要があります。この変更は、ユーザーが再生を待機する原因となる再バッファリングの遅延とカウントを追跡できるようにするためのものです。

    • 範囲:範囲パラメーターはオプションになりました。範囲をエンゲージメントイベントから除外して、イベントの対象期間中に視聴アクティビティがなかったことを示すことができます。 (たとえば、再バッファリングアクティビティのみがある場合)
    • rendition_url:最後に選択したレンディションへの URL。たとえば、HLSストリームの場合、これは最後に選択されたバリアントへのURLになります。
    • rendition_indicated_bps:最後に選択されたレンディションの、示されたビットレート(ビット/秒)。
    • rendition_mime_type:最近選択されたレンディションのmimeタイプ。
    • rendition_height:ビデオレンディションのエンコードされた高さ(ピクセル単位)
    • rendition_width:ビデオレンディションのエンコードされた幅(ピクセル単位)
    • rebuffering_seconds:エンゲージメント期間中の要求されていない遅延のために、ユーザーがビデオの再生を待機するのに費やした秒数。
    • rebuffering_count:表示されたエンゲージメント期間中に再バッファリングが原因で再生が停止した回数。
    • forward_buffer_seconds:現在フォワードバッファにあるビデオの秒数。
    • Measurement_bps:最近ダウンロードされたセグメントに含まれるビット数と、そのセグメントのダウンロードに費やされた時間の比率(ビット/秒)。
    • player_widthエンゲージメント範囲の終了時のプレーヤーの現在のピクセル幅。
    • player_heightエンゲージメント範囲の終了時のプレーヤーの現在のピクセルの高さ。
    • dropped_frames:このエンゲージメント期間中にビデオ再生からドロップされたフレーム数

    ページの最終更新日22 Sep 2021