ID de campagne

Cette page traite de la collecte de données pour la variable Identifiant de campagne. Voir Identifiant de campagne pour la dimension de reporting correspondante.

La variable d’identifiant de campagne identifie la campagne publicitaire à laquelle le contenu publicitaire appartient. Toute valeur de chaîne (généralement un identifiant de campagne de votre plateforme de serveur de publicités) est acceptable. Utilisez la variable pour cumuler l’engagement de plusieurs créatifs qui partagent une campagne.

Propriété
Valeur
Variable de données contextuelles
a.media.ad.campaign
champ de collection XDM
xdm.mediaCollection.advertisingDetails.campaignID
Caractéristique
c_contextdata.a.media.ad.campaign
Obligatoire
Non
Envoyé avec
Début de la publicité, fin de la publicité

Types d’implémentation recommandés

SDK Web

campaignID à l’intérieur des xdm.mediaCollection.advertisingDetails lors de l’appel de sendEvent :

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

Transmettez l’identifiant de campagne en tant que clé de métadonnées dans l’argument HashMap à trackEvent(AdStart). Utilisez 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

Transmettez l’identifiant de campagne en tant que clé de métadonnées dans l’argument HashMap à trackEvent(AdStart). Utilisez 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

campaignID à l’intérieur des xdm.mediaCollection.advertisingDetails lors de l’appel de sendMediaEvent pour media.adStart :

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

Appelez le point d’entrée adStart avec campaignID à l’intérieur du 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
      }
    }
  }]
}

Types d’implémentation hérités (Analytics uniquement)

Media SDK JS 3.x

Transmettez l’identifiant de campagne dans l’objet contextData à l’aide de 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

Définissez l’identifiant de campagne à l’aide de ADBMobile.media.AdMetadataKeys.CAMPAIGN_ID dans l’objet de métadonnées publicitaire standard :

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 Media Collection

Incluez media.ad.campaignId dans l’objet params :

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

Consultez la référence des événements de l’API Media Collection pour obtenir la structure complète des requêtes.

recommendation-more-help
media-analytics-help