広告プレーヤー名

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

広告プレーヤー名変数は、各広告をレンダリングしたプレーヤーを識別します(例:"Freewheel""Google IMA")。 広告プレーヤは、サーバサイドの広告挿入サービスによって広告がステッチされる場合、メインコンテンツプレーヤとは異なっていてもよい。 この変数は、広告配信スタック全体の品質と完了率を比較するために使用します。

プロパティ
コンテキストデータ変数
a.media.ad.playerName
XDM コレクションフィールド
xdm.mediaCollection.advertisingDetails.playerName
Audience Manager特性
c_contextdata.a.media.ad.playerName
必須
はい
様が​様と共に送信されました
広告の開始、広告の終了

推奨される実装タイプ

Web SDK

sendEventの呼び出し時にxdm.mediaCollection.advertisingDetails内にplayerNameを設定:

code language-javascript
alloy("sendEvent", {
  xdm: {
    eventType: "media.adStart",
    mediaCollection: {
      advertisingDetails: {
        name: "ad-2125",
        playerName: "Freewheel"
      },
      sessionID: "{sid}",
      playhead: 0
    }
  }
});
iOS

メタデータ HashMap引数のMediaConstants.AdMetadataKeys.AD_PLAYER キーとして広告プレーヤー名をtrackEvent(AdStart)に渡します。

code language-swift
var metadata: [String: String] = [:]
metadata[MediaConstants.AdMetadataKeys.AD_PLAYER] = "Freewheel"

tracker.trackEvent(event: MediaEvent.AdStart, info: adObject, metadata: metadata)
Android

メタデータ HashMap引数のMediaConstants.AdMetadataKeys.AD_PLAYER キーとして広告プレーヤー名をtrackEvent(AdStart)に渡します。

code language-kotlin
val metadata = HashMap<String, String>()
metadata[MediaConstants.AdMetadataKeys.AD_PLAYER] = "Freewheel"

tracker.trackEvent(Media.Event.AdStart, adObject, metadata)
Roku

media.adStartsendMediaEventを呼び出す場合、xdm.mediaCollection.advertisingDetails内にplayerNameを設定します:

code language-brightscript
m.aepSdk.sendMediaEvent({
    "xdm": {
        "eventType": "media.adStart",
        "mediaCollection": {
            "advertisingDetails": {
                "name": "ad-2125",
                "playerName": "Freewheel",
                "length": 15,
                "podPosition": 0
            },
            "playhead": 0
        }
    }
})
Media Edge API

xdm.mediaCollection.advertisingDetails内のplayerNameadStart エンドポイントを呼び出します:

code language-json
{
  "events": [{
    "xdm": {
      "eventType": "media.adStart",
      "mediaCollection": {
        "advertisingDetails": {
          "name": "ad-2125",
          "length": 15,
          "playerName": "Freewheel",
          "podPosition": 0
        },
        "sessionID": "{sid}",
        "playhead": 0
      }
    }
  }]
}

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

Media SDK JS 3.x

ADB.Media.AdMetadataKeys.AdPlayerを使用して、contextData オブジェクトに広告プレーヤー名を渡します:

code language-javascript
var contextData = {};
contextData[ADB.Media.AdMetadataKeys.AdPlayer] = "Freewheel";

tracker.trackEvent(ADB.Media.Event.AdStart, adInfo, contextData);
Chromecast

広告開始イベントをトラッキングする際に、コンテキストメタデータオブジェクトに広告プレーヤー名を渡します。

code language-javascript
var adInfo = ADBMobile.media.createAdObject("Ford F-150", "ad-2125", 1, 30);
var metadata = { "a.media.ad.playerName": "Chromecast Player" };
ADBMobile.media.trackEvent(ADBMobile.media.Event.AdStart, adInfo, metadata);
Media Collection API

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

code language-json
{
  "playerTime": { "playhead": 0, "ts": 1699523820000 },
  "eventType": "adStart",
  "params": {
    "media.ad.playerName": "Freewheel"
  }
}

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

recommendation-more-help
media-analytics-help