ドキュメントAnalyticsストリーミングメディアサービスガイド

キャンペーン ID

最終更新日： 2026年5月29日

作成対象：

  • Developer

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

style
shade-box

キャンペーン ID変数は、クリエイティブが属する広告キャンペーンを識別します。 任意の文字列値（通常は、広告サーバープラットフォームのキャンペーン ID）を使用できます。 この変数を使用して、キャンペーンを共有する複数のクリエイター間でエンゲージメントをロールアップします。

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

推奨される実装タイプ

Web SDK

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

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

キャンペーン IDをHashMap引数のメタデータキーとしてtrackEvent(AdStart)に渡します。 MediaConstants.AdMetadataKeys.CAMPAIGN_ID.を使用します。

code language-swift 
var metadata: [String: String] = [:]
metadata[MediaConstants.AdMetadataKeys.CAMPAIGN_ID] = "fall-2024"

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

キャンペーン IDをHashMap引数のメタデータキーとしてtrackEvent(AdStart)に渡します。 MediaConstants.AdMetadataKeys.CAMPAIGN_ID.を使用します。

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

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

media.adStartのsendMediaEventを呼び出す場合、xdm.mediaCollection.advertisingDetails内にcampaignIDを設定します：

code language-brightscript 
m.aepSdk.sendMediaEvent({
    "xdm": {
        "eventType": "media.adStart",
        "mediaCollection": {
            "advertisingDetails": {
                "name": "ad-2125",
                "campaignID": "fall-2024"
            },
            "playhead": 0
        }
    }
})
Media Edge API

xdm.mediaCollection.advertisingDetails内のcampaignIDでadStart エンドポイントを呼び出します：

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

従来の実装タイプ （Analyticsのみ）

Media SDK JS 3.x

ADB.Media.AdMetadataKeys.CampaignIdを使用してcontextData オブジェクトにキャンペーン IDを渡します：

code language-javascript 
var contextData = {};
contextData[ADB.Media.AdMetadataKeys.CampaignId] = "fall-2024";

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

標準広告メタデータオブジェクトのADBMobile.media.AdMetadataKeys.CAMPAIGN_IDを使用してキャンペーン IDを設定します。

code language-javascript 
var adInfo = ADBMobile.media.createAdObject("Ford F-150", "ad-2125", 1, 30);
var standardAdMetadata = {};
standardAdMetadata[ADBMobile.media.AdMetadataKeys.CAMPAIGN_ID] = "fall-2024";
adInfo[ADBMobile.media.MediaObjectKey.StandardAdMetadata] = standardAdMetadata;
ADBMobile.media.trackEvent(ADBMobile.media.Event.AdStart, adInfo, null);
Media Collection API

params オブジェクトにmedia.ad.campaignIdを含めます：

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

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

recommendation-more-help
media-analytics-help