营销活动 ID

本页介绍​ 促销活动ID ​变量的数据收集。 查看相应报表维度的促销活动ID

促销活动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作为哈希映射参数中的元数据键传递给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作为哈希映射参数中的元数据键传递给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中包含campaignIDadStart终结点:

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.CampaignIdcontextData对象中传递营销活动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);
媒体收集API

params对象中包括media.ad.campaignId

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

有关完整请求结构,请参阅媒体收集API事件引用

recommendation-more-help
media-analytics-help