広告の読み込みタイプ

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

広告読み込みタイプ変数は、セッションの開始時に読み込まれた広告のタイプを識別します。 この値は、組織の内部広告配信システムによって定義され、標準的な列挙に制限されません。 実装に意味のある任意の文字列("linear""dynamic""programmatic"など)を使用できます。

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

推奨される実装タイプ

Web SDK

createMediaSessionの呼び出し時にxdm.mediaCollection.sessionDetails内にadLoadを設定:

code language-javascript
alloy("createMediaSession", {
  xdm: {
    eventType: "media.sessionStart",
    mediaCollection: {
      sessionDetails: {
        name: "video-123",
        friendlyName: "My Video",
        length: 300,
        contentType: "vod",
        playerName: "HTML5 Player",
        channel: "Sports",
        adLoad: "linear"
      },
      playhead: 0
    }
  }
});
iOS

広告読み込みタイプをディクショナリ引数のメタデータキーとしてtrackSessionStartに渡します。 MediaConstants.VideoMetadataKeys.AD_LOAD.を使用します。

code language-swift
var videoMetadata: [String: String] = [:]
videoMetadata[MediaConstants.VideoMetadataKeys.AD_LOAD] = "linear"

tracker.trackSessionStart(info: mediaObject, metadata: videoMetadata)
Android

広告の読み込みタイプをHashMap引数のメタデータキーとしてtrackSessionStartに渡します。 MediaConstants.VideoMetadataKeys.AD_LOAD.を使用します。

code language-kotlin
val videoMetadata = HashMap<String, String>()
videoMetadata[MediaConstants.VideoMetadataKeys.AD_LOAD] = "linear"

tracker.trackSessionStart(mediaInfo, videoMetadata)
Roku

createMediaSessionを使用してsessionDetails内にadLoadを設定します:

code language-brightscript
m.aepSdk.createMediaSession({
    "xdm": {
        "eventType": "media.sessionStart",
        "mediaCollection": {
            "sessionDetails": {
                "adLoad": "linear"
            },
            "playhead": 0
        }
    }
})
Media Edge API

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

code language-json
{
  "events": [{
    "xdm": {
      "eventType": "media.sessionStart",
      "mediaCollection": {
        "sessionDetails": {
          "name": "video-123",
          "length": 300,
          "contentType": "vod",
          "playerName": "HTML5 Player",
          "channel": "Sports",
          "adLoad": "linear"
        },
        "playhead": 0
      }
    }
  }]
}

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

Media SDK JS 3.x

ADB.Media.VideoMetadataKeys.AdLoadを使用して、contextData オブジェクトで広告読み込みタイプを渡します:

code language-javascript
var contextData = {};
contextData[ADB.Media.VideoMetadataKeys.AdLoad] = "linear";

tracker.trackSessionStart(mediaInfo, contextData);
Chromecast

ADBMobile.media.VideoMetadataKeys.AD_LOADを使用して、trackSessionStartを呼び出す前に、メディアオブジェクトのStandardMediaMetadata プロパティで広告読み込みタイプを設定します。

code language-javascript
var mediaInfo = ADBMobile.media.createMediaObject("My Video", "video-123", 300,
  ADBMobile.media.StreamType.VOD, ADBMobile.media.MediaType.Video);
var standardMetadata = {};
standardMetadata[ADBMobile.media.VideoMetadataKeys.AD_LOAD] = "linear";
mediaInfo[ADBMobile.media.MediaObjectKey.StandardMediaMetadata] = standardMetadata;
ADBMobile.media.trackSessionStart(mediaInfo, null);
Media Collection API

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

code language-json
{
  "playerTime": { "playhead": 0, "ts": 1699523820000 },
  "eventType": "sessionStart",
  "params": {
    "media.adLoad": "linear"
  }
}

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

recommendation-more-help
media-analytics-help