広告 ID

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

広告ID変数は、各広告を一意に識別します。 プレーヤーが追跡するすべての広告に必要です。 media.adStart イベントごとに設定します。

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

推奨される実装タイプ

Web SDK

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

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

広告IDをadId引数としてcreateAdObjectに渡します。 最初の引数(name)はフレンドリ名、2番目の引数はIDです。

code language-swift
let adObject = Media.createAdObjectWith(name: "Ford F-150",
                                          id: "ad-2125",
                                    position: 0,
                                      length: 15)

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

広告IDをadId引数としてcreateAdObjectに渡します。 最初の引数(name)はフレンドリ名、2番目の引数はIDです。

code language-kotlin
val adObject = Media.createAdObject("Ford F-150",
                                    "ad-2125",
                                    0L,
                                    15.0)

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

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

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

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

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

広告IDを2番目の引数としてADB.Media.createAdObjectに渡します:

code language-javascript
var adInfo = ADB.Media.createAdObject(
  "Ford F-150",   // name (friendly name)
  "ad-2125",      // ad ID
  0,              // position in pod
  15              // length (seconds)
);

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

広告IDを2番目の引数としてADBMobile.media.createAdObjectに渡します:

code language-javascript
var adInfo = ADBMobile.media.createAdObject(
  "Ford F-150",
  "ad-2125",
  1,
  30
);
ADBMobile.media.trackEvent(ADBMobile.media.Event.AdStart, adInfo, null);
Media Collection API

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

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

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

recommendation-more-help
media-analytics-help