広告ブレーク名

このページでは、Ad break name​変数のデータ収集について説明します。 対応するレポートディメンションについては、Pod nameを参照してください。

広告ブレーク名変数は、広告ブレークのわかりやすい名前です(例:"pre-roll""mid-roll-1""post-roll")。 値は、個々の広告ではなく、広告分割オブジェクトに設定されます。

プロパティ
コンテキストデータ変数
a.media.ad.podFriendlyName
XDM コレクションフィールド
xdm.mediaCollection.advertisingPodDetails.friendlyName
Audience Manager特性
c_contextdata.a.media.ad.podFriendlyName
必須
はい(モバイル SDK)、いいえ(Edge、Media Collection API)
様が​様と共に送信されました
広告ブレーク開始、広告クローズ

推奨される実装タイプ

Web SDK

media.adBreakStartsendEventを呼び出す場合、xdm.mediaCollection.advertisingPodDetails内にfriendlyNameを設定します:

code language-javascript
alloy("sendEvent", {
  xdm: {
    eventType: "media.adBreakStart",
    mediaCollection: {
      advertisingPodDetails: {
        friendlyName: "pre-roll",
        index: 1,
        offset: 0
      },
      sessionID: "{sid}",
      playhead: 0
    }
  }
});
iOS

広告ブレーク名を最初の(name)引数としてcreateAdBreakObjectに渡し、広告ブレーク開始イベントを広告ブレーク開始イベントの前に追跡します。

code language-swift
let adBreakObject = Media.createAdBreakObjectWith(name: "pre-roll",
                                              position: 1,
                                             startTime: 0)

tracker.trackEvent(event: MediaEvent.AdBreakStart, info: adBreakObject, metadata: nil)
Android

広告ブレーク名を最初の(name)引数としてcreateAdBreakObjectに渡し、広告ブレーク開始イベントを広告ブレーク開始イベントの前に追跡します。

code language-kotlin
val adBreakObject = Media.createAdBreakObject("pre-roll",
                                              1L,
                                              0.0)

tracker.trackEvent(Media.Event.AdBreakStart, adBreakObject, null)
Roku

media.adBreakStartsendMediaEventを呼び出す場合、xdm.mediaCollection.advertisingPodDetails内にfriendlyNameを設定します:

code language-brightscript
m.aepSdk.sendMediaEvent({
    "xdm": {
        "eventType": "media.adBreakStart",
        "mediaCollection": {
            "advertisingPodDetails": {
                "friendlyName": "pre-roll",
                "index": 1,
                "offset": 0
            },
            "playhead": 0
        }
    }
})
Media Edge API

xdm.mediaCollection.advertisingPodDetails内のfriendlyNameadBreakStart エンドポイントを呼び出します。

code language-json
{
  "events": [{
    "xdm": {
      "eventType": "media.adBreakStart",
      "mediaCollection": {
        "advertisingPodDetails": {
          "friendlyName": "pre-roll",
          "index": 1,
          "offset": 0
        },
        "sessionID": "{sid}",
        "playhead": 0
      }
    }
  }]
}

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

Media SDK JS 3.x

広告ブレーク名を最初の引数としてADB.Media.createAdBreakObjectに渡します:

code language-javascript
var adBreakInfo = ADB.Media.createAdBreakObject(
  "pre-roll",
  1,
  0
);

tracker.trackEvent(ADB.Media.Event.AdBreakStart, adBreakInfo, null);
Chromecast

広告ブレーク名を最初の引数としてADBMobile.media.createAdBreakObjectに渡します:

code language-javascript
var adBreakInfo = ADBMobile.media.createAdBreakObject(
  "pre-roll",
  1,
  0
);
ADBMobile.media.trackEvent(ADBMobile.media.Event.AdBreakStart, adBreakInfo);
Media Collection API

adBreakStart POST リクエストのparams オブジェクトにmedia.ad.podFriendlyNameを含めます:

code language-json
{
  "playerTime": { "playhead": 0, "ts": 1699523820000 },
  "eventType": "adBreakStart",
  "params": {
    "media.ad.podFriendlyName": "pre-roll"
  }
}

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

recommendation-more-help
media-analytics-help