Nom de la coupure publicitaire

Cette page couvre la collecte de données pour la variable Nom de la coupure publicitaire. Voir Nom de la capsule pour la dimension de rapport correspondante.

La variable de nom de coupure publicitaire est le nom convivial de la coupure publicitaire (par exemple, "pre-roll", "mid-roll-1", "post-roll"). La valeur est définie sur l’objet de coupure publicitaire et non sur des publicités individuelles.

Propriété
Valeur
Variable de données contextuelles
a.media.ad.podFriendlyName
champ de collection XDM
xdm.mediaCollection.advertisingPodDetails.friendlyName
Caractéristique
c_contextdata.a.media.ad.podFriendlyName
Obligatoire
Oui (Mobile SDK) ; Non (Edge, API Media Collection)
Envoyé avec
Début de la coupure publicitaire, fin de la publicité

Types d’implémentation recommandés

SDK Web

friendlyName à l’intérieur des xdm.mediaCollection.advertisingPodDetails lors de l’appel de sendEvent pour media.adBreakStart :

code language-javascript
alloy("sendEvent", {
  xdm: {
    eventType: "media.adBreakStart",
    mediaCollection: {
      advertisingPodDetails: {
        friendlyName: "pre-roll",
        index: 1,
        offset: 0
      },
      sessionID: "{sid}",
      playhead: 0
    }
  }
});
iOS

Transmettez le nom de la coupure publicitaire comme premier argument (name) à createAdBreakObject, puis suivez l’événement de démarrage de la coupure publicitaire avant l’événement de démarrage de la publicité.

code language-swift
let adBreakObject = Media.createAdBreakObjectWith(name: "pre-roll",
                                              position: 1,
                                             startTime: 0)

tracker.trackEvent(event: MediaEvent.AdBreakStart, info: adBreakObject, metadata: nil)
Android

Transmettez le nom de la coupure publicitaire comme premier argument (name) à createAdBreakObject, puis suivez l’événement de démarrage de la coupure publicitaire avant l’événement de démarrage de la publicité.

code language-kotlin
val adBreakObject = Media.createAdBreakObject("pre-roll",
                                              1L,
                                              0.0)

tracker.trackEvent(Media.Event.AdBreakStart, adBreakObject, null)
Roku

friendlyName à l’intérieur des xdm.mediaCollection.advertisingPodDetails lors de l’appel de sendMediaEvent pour media.adBreakStart :

code language-brightscript
m.aepSdk.sendMediaEvent({
    "xdm": {
        "eventType": "media.adBreakStart",
        "mediaCollection": {
            "advertisingPodDetails": {
                "friendlyName": "pre-roll",
                "index": 1,
                "offset": 0
            },
            "playhead": 0
        }
    }
})
API Media Edge

Appelez le point d’entrée adBreakStart avec friendlyName à l’intérieur du xdm.mediaCollection.advertisingPodDetails :

code language-json
{
  "events": [{
    "xdm": {
      "eventType": "media.adBreakStart",
      "mediaCollection": {
        "advertisingPodDetails": {
          "friendlyName": "pre-roll",
          "index": 1,
          "offset": 0
        },
        "sessionID": "{sid}",
        "playhead": 0
      }
    }
  }]
}

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

Media SDK JS 3.x

Transmettez le nom de la coupure publicitaire comme premier argument à ADB.Media.createAdBreakObject :

code language-javascript
var adBreakInfo = ADB.Media.createAdBreakObject(
  "pre-roll",
  1,
  0
);

tracker.trackEvent(ADB.Media.Event.AdBreakStart, adBreakInfo, null);
Chromecast

Transmettez le nom de la coupure publicitaire comme premier argument à ADBMobile.media.createAdBreakObject :

code language-javascript
var adBreakInfo = ADBMobile.media.createAdBreakObject(
  "pre-roll",
  1,
  0
);
ADBMobile.media.trackEvent(ADBMobile.media.Event.AdBreakStart, adBreakInfo);
API Media Collection

Incluez media.ad.podFriendlyName dans l’objet params de votre adBreakStart requête POST :

code language-json
{
  "playerTime": { "playhead": 0, "ts": 1699523820000 },
  "eventType": "adBreakStart",
  "params": {
    "media.ad.podFriendlyName": "pre-roll"
  }
}

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