クローズドキャプション

このページでは、クローズドキャプション​プレーヤー状態のデータ収集について説明します。 対応するレポート指標について、​ クローズドキャプションの影響を受けるストリーム ​​ クローズドキャプション数、および​ クローズドキャプション合計期間を参照してください。

クローズドキャプションプレーヤーの状態は、ビューアがキャプションのオンとオフを切り替えると追跡されます。 キャプションが有効になっている場合は状態開始イベントを起動し、キャプションが無効になっている場合は状態終了イベントを起動します。 バックエンドでは、これらのイベントから、影響を受けるストリーム、状態エントリの数、状態の合計時間という3つの指標を計算します。

プロパティ
コンテキストデータ変数
a.media.states.closedcaptioning.set, a.media.states.closedcaptioning.count, a.media.states.closedcaptioning.time
XDM コレクションフィールド
xdm.mediaCollection.statesStart[]およびxdm.mediaCollection.statesEnd[]name: "closedCaptioning"を含むエントリ)
Audience Manager特性
c_contextdata.a.media.states.closedcaptioning.set, c_contextdata.a.media.states.closedcaptioning.count, c_contextdata.a.media.states.closedcaptioning.time
必須
いいえ
様が​様と共に送信されました
状態開始状態終了

推奨される実装タイプ

Web SDK

sendEventを使用して、状態がstatesStartに追加されたmedia.statesUpdate イベントを送信します:

code language-javascript
alloy("sendEvent", {
  xdm: {
    eventType: "media.statesUpdate",
    mediaCollection: {
      statesStart: [{ name: "closedCaptioning" }],
      sessionID: "{sid}",
      playhead: 60
    }
  }
});

ビューアがキャプションを無効にした場合、statesEndの状態で別のイベントを送信します。

code language-javascript
alloy("sendEvent", {
  xdm: {
    eventType: "media.statesUpdate",
    mediaCollection: {
      statesEnd: [{ name: "closedCaptioning" }],
      sessionID: "{sid}",
      playhead: 90
    }
  }
});
iOS

tracker.trackPlayerStateStart()tracker.trackPlayerStateEnd()MediaConstants.PlayerState.CLOSED_CAPTION定数と共に使用します。

code language-swift
let stateObject = Media.createStateObjectWith(stateName: MediaConstants.PlayerState.CLOSED_CAPTION)

tracker.trackPlayerStateStart(info: stateObject)
tracker.trackPlayerStateEnd(info: stateObject)
Android

tracker.trackPlayerStateStart()tracker.trackPlayerStateEnd()MediaConstants.PlayerState.CLOSED_CAPTION定数と共に使用します。

code language-kotlin
val stateObject = Media.createStateObject(MediaConstants.PlayerState.CLOSED_CAPTION)

tracker.trackPlayerStateStart(stateObject)
tracker.trackPlayerStateEnd(stateObject)
Roku

sendMediaEventを使用して、状態がstatesStartに追加されたmedia.statesUpdate イベントを送信します:

code language-brightscript
m.aepSdk.sendMediaEvent({
    "xdm": {
        "eventType": "media.statesUpdate",
        "mediaCollection": {
            "statesStart": [{ "name": "closedCaptioning" }],
            "playhead": 60
        }
    }
})

ビューアがキャプションを無効にした場合、statesEndの状態で別のイベントを送信します。

code language-brightscript
m.aepSdk.sendMediaEvent({
    "xdm": {
        "eventType": "media.statesUpdate",
        "mediaCollection": {
            "statesEnd": [{ "name": "closedCaptioning" }],
            "playhead": 90
        }
    }
})
Media Edge API

statesUpdate エンドポイントをstatesStartclosedCaptioningで呼び出します(ビューアがキャプションを無効にした場合はstatesEnd)。

code language-json
{
  "events": [{
    "xdm": {
      "eventType": "media.statesUpdate",
      "mediaCollection": {
        "statesStart": [{ "name": "closedCaptioning" }],
        "sessionID": "{sid}",
        "playhead": 60
      }
    }
  }]
}

従来の実装タイプ (Analyticsのみ)

Media SDK JS 3.x

ADB.Media.createStateObjectADB.Media.PlayerState.ClosedCaptioning定数を使用:

code language-javascript
var stateObject = ADB.Media.createStateObject(ADB.Media.PlayerState.ClosedCaptioning);

tracker.trackPlayerStateStart(stateObject);
tracker.trackPlayerStateEnd(stateObject);
Chromecast

ChromecastにはPlayerStateという名前の定数がないので、ADBMobile.media.createStateObject"closedCaptioning"文字列で直接使用します。

code language-javascript
var stateObject = ADBMobile.media.createStateObject("closedCaptioning");
ADBMobile.media.trackEvent(ADBMobile.media.Event.StateStart, stateObject);
// When the viewer disables captions:
ADBMobile.media.trackEvent(ADBMobile.media.Event.StateEnd, stateObject);
Media Collection API

キャプションが有効になっている場合はstateStart POST リクエストを送信し、無効になっている場合はstateEnd POST リクエストを送信します。

code language-json
{
  "playerTime": { "playhead": 60, "ts": 1699523820000 },
  "eventType": "stateStart",
  "params": {
    "media.state.name": "closedCaptioning"
  }
}

完全なリクエスト構造については、Media Collection API イベントのリファレンス ​を参照してください。

recommendation-more-help
media-analytics-help