Spåra annonser med JavaScript 3.x track-ads-on-javascript

Följande instruktioner ger vägledning vid implementering med 3.x SDK:er.

IMPORTANT
Om du implementerar en tidigare version av SDK kan du hämta utvecklarhandboken här: Hämta SDK:er.

Konstanter för annonsspårning

Konstantnamn
Beskrivning
AdBreakStart
Konstant för spårning av AdBreak-starthändelse
AdBreakComplete
Konstant för spårning av AdBreak Complete-händelse
AdStart
Konstant för spårning av Ad Start-händelse
AdComplete
Konstant för spårning av Ad Complete-händelse
AdSkip
Konstant för spårning av Ad Skip-händelse

Implementeringssteg

  1. Identifiera när annonsbrytningsgränsen börjar, inklusive pre-roll, och skapa en AdBreakObject med hjälp av annonsbrytningsinformationen.

    AdBreakObject-referens:

    table 0-row-3 1-row-3 2-row-3 3-row-3
    Variabelnamn Typ Beskrivning
    name string En sträng som inte är tom och som betecknar adbreak name (pre-roll, mid-roll och post-roll).
    position tal Annonsbrytningens nummerposition med början på 1.
    startTime tal Spelhuvudets värde i början av annonsbrytningen.

    Skapa brytningsobjekt:

    code language-js
    var adBreakObject =
      ADB.Media.createAdBreakObject(<ADBREAK_NAME>,
                                       <POSITION>,
                                       <START_TIME>);
    
  2. Anropa trackEvent() med AdBreakStart i MediaHeartbeat-instansen för att börja spåra annonsbrytningen:

    code language-js
    tracker.trackEvent(ADB.Media.Event.AdBreakStart, adBreakObject);
    
  3. Identifiera när annonsen startar och skapa en AdObject-instans med annonsinformationen.

    AdObject-referens:

    table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3
    Variabelnamn Typ Beskrivning
    name string En sträng som inte är tom betecknar annonsnamnet.
    adId string En sträng som inte är tom betecknar annonsidentifierare.
    position tal Annonsens sifferposition inom reklamen, med början på 1.
    length tal Positivt nummer som anger annonsens längd.

    Skapa annonsobjekt:

    code language-js
    var adObject =
      ADB.Media.createAdObject.createAdObject(<AD_NAME>,
                                    <AD_ID>,
                                    <POSITION>,
                                    <LENGTH>);
    
  4. (Valfritt) Koppla standard- och/eller annonsmetadata till mediespårningssessionen via kontextdatavariabler.

    • Implementera standardannonsmetadata på JavaScript

    • Anpassade annonseringsmetadata - För anpassade metadata skapar du ett variabelobjekt för anpassade datavariabler och fyller i med data för den aktuella annonsen:

      code language-js
      /* Set context data */
      // Standard metadata keys provided by adobe.
      adMetadata[ADB.Media.AdMetadataKeys]  ="Sample Advertiser";
      adMetadata[ADB.Media.AdMetadataKeys] = "Sample Campaign";
      
      // Custom metadata keys
      adMetadata["affiliate"] = "Sample affiliate";
      adMetadata["campaign"] = "Sample ad campaign";
      adMetadata["creative"] = "Sample creative";
      
  5. Anropa trackEvent() med händelsen AdStart i instansen MediaHeartbeat för att börja spåra annonsuppspelningen.

    Ta med en referens till din anpassade metadatavariabel (eller ett tomt objekt) som den tredje parametern i händelseanropet:

    code language-js
    _onAdStart = function() {
        tracker.trackEvent(ADB.Media.Event.AdStart, adObject, adMetadata);
    };
    
  6. När annonsuppspelningen når slutet av annonsen anropar du trackEvent() med händelsen AdComplete:

    code language-js
    _onAdComplete = function() {
        tracker.trackEvent(ADB.Media.Event.AdComplete);
    };
    
  7. Om annonsuppspelningen inte slutfördes eftersom användaren valde att hoppa över annonsen, ska du spåra AdSkip-händelsen:

    code language-js
    _onAdSkip = function() {
        tracker.trackEvent(ADB.Media.Event.AdSkip);
    };
    
  8. Om det finns ytterligare annonser i samma AdBreak upprepar du steg 3 till 7 igen.

  9. När annonsbrytningen är klar använder du händelsen AdBreakComplete för att spåra:

    code language-js
    _onAdBreakComplete = function() {
        tracker.trackEvent(ADB.Media.Event.AdBreakComplete);
    };
    

Mer information finns i spårningsscenariot VOD-uppspelning med förhandsgranskningsannonser.

Detaljerad annonshantering

Standardintervallet för annonsväxling är 10 seconds.

Du kan konfigurera detaljerad annonsspårning för att aktivera annonsspårning för 1 second.

IMPORTANT
Den här informationen måste anges när en spårningssession startas.

Syntax

ADB.Media.MediaObjectKey = {
   GranularAdTracking: "media.granularadtracking"
   }

Exempel

var mediaObject = ADB.Media.createMediaObject("media-name", "media-id", 60, ADB.Media.StreamType.VOD, ADB.Media.MediaType.Video);

// Enable granular ad tracking
mediaObject[ADB.Media.MediaObjectKey.GranularAdTracking] = true;

tracker.trackSessionStart(mediaObject);
recommendation-more-help
c8eee520-cef5-4f8c-a38a-d4952cfae4eb