DocumentaçãoAnalyticsGuia da Coleção de mídia de transmissão

Configurar o JavaScript 2.x set-up-javascript

Last update: Thu Jul 18 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Tópicos:

Criado para:

  • undefined
  • undefined
  • undefined

Pré-requisitos

  • Obter parâmetros de configuração válidos
    Esses parâmetros podem ser obtidos de um representante da Adobe após a configuração da sua conta do Analytics.

  • Implementar AppMeasurement para JavaScript no aplicativo de mídia
    Para obter mais informações sobre a documentação do SDK do Adobe Mobile, consulte Implementar o Analytics usando JavaScript.

  • Forneça os seguintes recursos no player de mídia:

    • Uma API para assinar eventos do player - O SDK de mídia exige que você chame um conjunto de APIs simples quando eventos ocorrem no player.
    • Uma API que fornece informações sobre o player - Essas informações incluem detalhes como o nome da mídia e a posição do indicador de reprodução.

  1. Adicione a biblioteca baixada ao projeto. Para conveniência, crie referências locais para as classes.

    1. Expanda o arquivo MediaSDK-js-v2.*.zip que você baixou.

    2. Verifique se o arquivo MediaSDK.min.js existe no diretório libs:

    3. Hospede o arquivo MediaSDK.min.js.

      Esse arquivo JavaScript principal deve ser hospedado em um servidor da Web acessível a todas as páginas do site. Você precisa do caminho para esses arquivos para a próxima etapa.

    4. Referencie MediaSDK.min.js em todas as páginas do site.

      Inclua MediaSDK para o JavaScript ao adicionar a seguinte linha de código na tag <head> ou <body> em cada página. Por exemplo:

      code language-none 
      <script type="text/javascript"
src="https://INSERT-DOMAIN-AND-PATH-TO-CODE-HERE/MediaSDK.min.js"></script>

    5. Para verificar rapidamente se a biblioteca do foi importada com sucesso, exemplifique a classe ADB.va.MediaHeartbeatConfig.

      note note
      NOTE
      A partir da versão 2.1.0, o SDK do JavaScript é compatível com as especificações dos módulos AMD e CommonJS e VideoHeartbeat.min.js também pode ser usado com carregadores de módulo compatíveis.

  2. Para obter acesso fácil às APIs, crie uma referência local para as classes MediaHeartbeat.

    code language-js 
    var MediaHeartbeat = ADB.va.MediaHeartbeat;
var MediaHeartbeatConfig = ADB.va.MediaHeartbeatConfig;
var MediaHeartbeatDelegate = ADB.va.MediaHeartbeatDelegate;

  3. Crie uma instância MediaHeartbeatConfig.

    Essa seção ajuda você a entender os parâmetros de configuração do MediaHeartbeat e definir corretamente os valores de configuração na sua instância MediaHeartbeat, de modo a permitir um rastreamento preciso.

    Aqui está uma amostra de inicialização MediaHeartbeatConfig:

    code language-js 
    //Media Heartbeat initialization
var mediaConfig = new MediaHeartbeatConfig();
mediaConfig.trackingServer = Configuration.HEARTBEAT.TRACKING_SERVER;
mediaConfig.playerName = Configuration.PLAYER.NAME;
mediaConfig.channel = Configuration.HEARTBEAT.CHANNEL;
mediaConfig.debugLogging = true;
mediaConfig.appVersion = Configuration.HEARTBEAT.SDK;
mediaConfig.ssl = false;
mediaConfig.ovp = Configuration.HEARTBEAT.OVP;

  4. Implemente o protocolo MediaHeartbeatDelegate.

    code language-js 
    var mediaDelegate = new MediaHeartbeatDelegate();

// Replace <currentPlaybackTime> with the video player current playback time
mediaDelegate.getCurrentPlaybackTime = function() {
    return <currentPlaybackTime>;
};

// Replace <bitrate>, <startuptime>, <fps> and <droppeFrames> with the current playback QoS values.
mediaDelegate.getQoSObject = function() {
    return MediaHeartbeat.createQoSObject(<bitrate>, <startuptime>, <fps>, <droppedFrames>);
};

  5. Crie a instância MediaHeartbeat.

    Use MediaHeartbeatConfig e MediaHeartbeatDelegate para criar a instância MediaHeartbeat.

    code language-js 
    this.mediaHeartbeat = new MediaHeartbeat(mediaDelegate, mediaConfig, appMeasurement);
    note important
    IMPORTANT
    Certifique-se de que a instância do MediaHeartbeat possa ser acessada e não seja desalocada até o final da sessão de mídia. Essa instância será usada para todos os eventos de rastreamento a seguir.
    note tip
    TIP
    MediaHeartbeat exige uma instância do AppMeasurement para enviar chamadas para o Adobe Analytics. A seguir, há um exemplo de uma instância AppMeasurement:
    code language-js 
    var appMeasurement = new AppMeasurement();
appMeasurement.visitor = visitor;
appMeasurement.trackingServer = "<visitor_namespace>.sc.omtrdc.net";
appMeasurement.account = <rsid>;
appMeasurement.pageName = <page_name>;
appMeasurement.charSet = "UTF­8";

Migrar do JavaScript 1.x para o 2.x

Na versão 2.x, todos os métodos públicos foram consolidados na classe ADB.va.MediaHeartbeat para facilitar o trabalho dos desenvolvedores. Além disso, todas as configurações foram consolidadas na classe ADB.va.MediaHeartbeatConfig

Para obter informações sobre a migração da versão 1.x para a 2.x, consulte a documentação de Implementação herdada.

recommendation-more-help
c8eee520-cef5-4f8c-a38a-d4952cfae4eb