Adobe Media Analytics för ljud- och videotillägg - översikt

NOTE
Adobe Experience Platform Launch har omklassificerats som en serie datainsamlingstekniker i Adobe Experience Platform. Som ett resultat av detta har flera terminologiska förändringar införts i produktdokumentationen. Se följande dokument för en konsoliderad hänvisning till terminologiska förändringar.

Använd den här dokumentationen om du vill ha information om hur du installerar, konfigurerar och implementerar tillägget Adobe Media Analytics för ljud och video (tillägget Media Analytics). Här finns alternativ som är tillgängliga när du använder det här tillägget för att skapa en regel, tillsammans med exempel och länkar till exempel.

Tillägget Media Analytics (MA) lägger till JavaScript Media SDK (Media 2.x SDK). Det här tillägget innehåller funktioner för att lägga till MediaHeartbeat spårningsinstans till en taggplats eller ett projekt. MA-tillägget kräver ytterligare två tillägg:

IMPORTANT
Ljudspårning kräver Analytics Extension v1.6 eller senare.

När du har inkluderat alla tre av tilläggen som nämns ovan i taggprojektet kan du fortsätta på ett av två sätt:

  • Använd MediaHeartbeat API:er från ditt webbprogram
  • Inkludera, eller bygg, ett spelarspecifikt tillägg som mappar specifika mediespelarhändelser till API:erna på MediaHeartbeat spårarinstans. Den här instansen visas genom MA-tillägget.

Installera och konfigurera MA-tillägget

  • Installera - Om du vill installera MA-tillägget öppnar du tilläggsegenskapen och väljer Extensions > Catalog, hovra över Adobe Media Analytics for Audio and Video och markera Install.

  • Konfigurera - Konfigurera MA-tillägget genom att öppna Extensions hovra över tillägget och välj Configure:

Konfiguration av MA-tillägg

Konfigurationsalternativ:

Alternativ
Beskrivning
Spårningsserver
Definierar servern för spårning av mediefärger (detta är inte samma server som analysspårningsservern)
Programversion
Versionen av mediespelarappen/SDK
Spelarnamn
Namnet på den mediespelare som används (t.ex. "AVPlayer", "HTML5 Player", "My Custom VideoPlayer")
Kanal
Egenskapen Kanalnamn
Onlinevideoprovider
Namnet på onlinevideoplattformen som innehållet distribueras via
Felsökningsloggning
Aktivera eller inaktivera loggning
Aktivera SSL
Aktivera eller inaktivera sändning av ping via HTTPS
Exportera API:er till Window-objekt
Aktivera eller inaktivera export av Media Analytics-API:er till globalt omfång
Variabelnamn
En variabel som du använder för att exportera Media Analytics-API:er under window object

Påminnelse: MA-tillägget kräver Analyser och EXPERIENCE CLOUD ID tillägg. Du måste också lägga till dessa tillägg i tilläggsegenskapen och konfigurera dem.

Använda MA-tillägget

Använda från en webbsida/JS-app

MA-tillägget exporterar MediaHeartbeat-API:er i det globala fönsterobjektet genom att aktivera inställningen Exportera API:er till Window-objekt i dialogrutan Configuration sida. Den exporterar API:erna under det konfigurerade variabelnamnet. Om till exempel variabelnamnet är konfigurerat att ADB kan MediaHeartbeat användas av window.ADB.MediaHeartbeat.

IMPORTANT
MA-tillägget exporterar bara API:erna när window["CONFIGURED_VARIABLE_NAME"] är odefinierad och åsidosätter inte befintliga variabler.
  1. Skapa MediaHeartbeat-instans:  window["CONFIGURED_VARIABLE_NAME"].MediaHeartbeat.getInstance

    Parametrar: Ett giltigt delegatobjekt som visar dessa funktioner.

    table 0-row-2 1-row-2 2-row-2 1-align-left 2-align-left 4-align-left 5-align-left 7-align-left 8-align-left
    Metod Beskrivning
    getQoSObject() Returnerar theMediaObject -instans som innehåller aktuell QoS-information. Den här metoden anropas flera gånger under en uppspelningssession. Spelarimplementeringen måste alltid returnera de senast tillgängliga QoS-data.
    getCurrentPlaybackTime() Returnerar spelhuvudets aktuella position. För VOD-spårning anges värdet i sekunder från mediaobjektets början. För LIVE/LIVE-spårning anges värdet i sekunder från programmets början.

    Returvärde: Ett löfte som antingen löses med en MediaHeartbeat eller avvisar med ett felmeddelande.

  2. Åtkomst till MediaHeartbeat-konstanter:  window["CONFIGURED_VARIABLE_NAME"].MediaHeartbeat

    Då visas alla konstanter och statiska metoder från MediaHeartbeat klassen.

    Du kan hämta exempelspelaren här: MA Sample Player. Exempelspelaren fungerar som en referens för att visa hur man använder MA-tillägget för att stödja Media Analytics direkt från en webbapp.

  3. Skapa spårningsinstansen för MediaHeartbeat enligt följande:

    code language-javascript
    var MediaHeartbeat = window["CONFIGURED_VARIABLE_NAME"].MediaHeartbeat;
    
    var delegate = {
        getCurrentPlaybackTime: this._getCurrentPlaybackTime.bind(this),
        getQoSObject: this._getQoSObject.bind(this),
    };
    
    var config = {
        playerName: "Custom Player",
        ovp: "Custom OVP",
        channel: "Custom Channel"
    };
    
    var self = this;
    MediaHeartbeat.getInstance(delegate, config).then(function(instance) {
        self._mediaHeartbeat = instance;
        // Do Tracking using the MediaHeartbeat instance.
    }).catch(function(err){
        // Getting MediaHeartbeat instance failed.
    });
    

Använda från andra tillägg

MA-tillägget visar get-instance och media-heartbeat delade moduler till andra tillägg. (Mer information om delade moduler finns i Dokumentation för delade moduler.)

IMPORTANT
Delade moduler kan bara nås från andra tillägg. Det innebär att en webbsida/JS-app inte kan komma åt de delade modulerna eller använda turbine (se kodexempel nedan) utanför ett tillägg.
  1. Skapa MediaHeartbeat-instans:  get-instance Delad modul

    Parametrar:

    • Ett giltigt delegatobjekt som visar dessa funktioner:

      table 0-row-2 1-row-2 2-row-2 1-align-left 2-align-left 4-align-left 5-align-left 7-align-left 8-align-left
      Metod Beskrivning
      getQoSObject() Returnerar MediaObject -instans som innehåller aktuell QoS-information. Den här metoden anropas flera gånger under en uppspelningssession. Spelarimplementeringen måste alltid returnera de senast tillgängliga QoS-data.
      getCurrentPlaybackTime() Returnerar spelhuvudets aktuella position. För VOD-spårning anges värdet i sekunder från mediaobjektets början. För LIVE/LIVE-spårning anges värdet i sekunder från programmets början.
    • Ett valfritt config-objekt som visar dessa egenskaper:

      table 0-row-3 1-row-3 2-row-3 3-row-3 1-align-left 2-align-left 3-align-left 5-align-left 6-align-left 7-align-left 9-align-left 10-align-left 11-align-left 13-align-left 14-align-left 15-align-left
      Egenskap Beskrivning Obligatoriskt
      Onlinevideoprovider Namnet på onlinevideoplattformen som innehållet distribueras via. Nej. Om det finns åsidosätter det värde som definierats under tilläggskonfigurationen.
      Spelarnamn Namnet på den mediespelare som används (t.ex. "AVPlayer", "HTML5 Player", "My Custom VideoPlayer") Nej. Om det finns åsidosätter det värde som definierats under tilläggskonfigurationen.
      Kanal Egenskapen Kanalnamn Nej. Om det finns åsidosätter det värde som definierats under tilläggskonfigurationen.

    Returvärde: Ett löfte som antingen löses med en MediaHeartbeat eller avvisar med ett felmeddelande.

  2. Åtkomst till MediaHeartbeat-konstanter:  media-heartbeat Delad modul

    Den här modulen visar alla konstanter och statiska metoder från den här klassen: https://adobe-marketing-cloud.github.io/media-sdks/reference/javascript/MediaHeartbeat.html.

  3. Skapa spårningsinstansen för MediaHeartbeat enligt följande:

    code language-javascript
    var getMediaHeartbeatInstance =
      turbine.getSharedModule('adobe-video-analytics', 'get-instance');
    
    var MediaHeartbeat =
      turbine.getSharedModule('adobe-video-analytics', 'media-heartbeat');
      ...
    
    var delegate = {
        getCurrentPlaybackTime: this._getCurrentPlaybackTime.bind(this),
        getQoSObject: this._getQoSObject.bind(this),
    }
    
    var config = {
        playerName: "Custom Player",
        ovp: "Custom OVP",
        channel: "Custom Channel"
    }
    ...
    
    var self = this;
    getMediaHeartbeatInstance(delegate, config).then(function(instance) {
        self._mediaHeartbeat = instance;
        ...
        // Do Tracking using the MediaHeartbeat instance.
    }).catch(function(err){
        // Getting MediaHeartbeat instance failed.
    });
    
    ...
    
  4. Använd instansen Media Heartbeat för att följa Media SDK JS-dokumentation och JS API-dokumentation för att implementera mediespårning.

NOTE
Testning: För att testa tillägget i den här versionen måste du överföra det till Plattform, där du har tillgång till alla beroende tillägg.
recommendation-more-help
12b4e4a9-5028-4d88-8ce6-64a580811743