Kampanj-ID

Den här sidan innehåller datainsamling för variabeln Kampanj-ID. Se Kampanj-ID för motsvarande rapporteringsdimension.

Kampanj-ID-variabeln identifierar annonskampanjen som den kreativa tillhör. Valfritt strängvärde (vanligtvis ett kampanj-ID från din annonsserverplattform) accepteras. Använd variabeln för att samla engagemanget hos flera olika kreatörer som delar en kampanj.

Egenskap
Värde
Kontextdatavariabel
a.media.ad.campaign
XDM-samlingsfält
xdm.mediaCollection.advertisingDetails.campaignID
Audience Manager trait
c_contextdata.a.media.ad.campaign
Krävs
Nej
Skickat med
Lägg till start, och stäng

Rekommenderade implementeringstyper

SDK för webben

Ange campaignID i xdm.mediaCollection.advertisingDetails vid anrop till sendEvent:

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

Skicka kampanj-ID som en metadatanyckel i HashMap-argumentet till trackEvent(AdStart). Använd 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

Skicka kampanj-ID som en metadatanyckel i HashMap-argumentet till trackEvent(AdStart). Använd 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

Ange campaignID i xdm.mediaCollection.advertisingDetails vid anrop av sendMediaEvent för media.adStart:

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

Anropa slutpunkten adStart med campaignID inuti xdm.mediaCollection.advertisingDetails:

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
      }
    }
  }]
}

Äldre implementeringstyper (endast analys)

Media SDK JS 3.x

Skicka kampanj-ID:t i objektet contextData med ADB.Media.AdMetadataKeys.CampaignId:

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

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

Ange kampanj-ID med ADBMobile.media.AdMetadataKeys.CAMPAIGN_ID i standardmetadataobjektet för annonsering:

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

Inkludera media.ad.campaignId i objektet params:

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

Se API-händelseferensen för mediainsamling för den fullständiga strukturen för begäran.

recommendation-more-help
media-analytics-help