ID de campaña

Esta página cubre la recopilación de datos para la variable ID de campaña. Ver ID de campaña para la dimensión de informe correspondiente.

La variable del ID de campaña identifica la campaña de publicidad a la que pertenece el creativo. Cualquier valor de cadena (normalmente un ID de campaña de su plataforma de servidor de publicidad) es aceptable. Utilice la variable para resumir la participación de varios creativos que comparten una campaña.

Propiedad
Valor
Variable de datos de contexto
a.media.ad.campaign
Campo de colección XDM
xdm.mediaCollection.advertisingDetails.campaignID
rasgo de Audience Manager
c_contextdata.a.media.ad.campaign
Requerido
No
Enviado con
Inicio del anuncio, cierre del anuncio

Tipos de implementación recomendados

SDK web

Establecer campaignID dentro de xdm.mediaCollection.advertisingDetails al llamar a sendEvent:

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

Pase el identificador de campaña como clave de metadatos en el argumento HashMap a trackEvent(AdStart). Utilice 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

Pase el identificador de campaña como clave de metadatos en el argumento HashMap a trackEvent(AdStart). Utilice 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

Establecer campaignID dentro de xdm.mediaCollection.advertisingDetails al llamar a sendMediaEvent para media.adStart:

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

Llame al extremo adStart con campaignID dentro de 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
      }
    }
  }]
}

Tipos de implementación heredados (solo Analytics)

Media SDK JS 3.x

Pase el identificador de campaña en el objeto contextData mediante 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

Establezca el ID de campaña usando ADBMobile.media.AdMetadataKeys.CAMPAIGN_ID en el objeto de metadatos de publicidad estándar:

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 de recopilación de medios

Incluir media.ad.campaignId en el objeto params:

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

Consulte la referencia de eventos de API de Media Collection para obtener la estructura de solicitudes completa.

recommendation-more-help
media-analytics-help