Visão geral da extensão do Adobe Media Analytics para áudio e vídeo
Use esta documentação para obter informações sobre como instalar, configurar e implementar a extensão Adobe Media Analytics for Audio and Video (extensão do Media Analytics). Estão incluídas as opções disponíveis ao usar esta extensão para criar uma regra, juntamente com exemplos e links para amostras.
A extensão do Media Analytics (MA) adiciona a principal SDK de mídia JavaScript (Media 2.x SDK). Essa extensão fornece a funcionalidade para adicionar a instância MediaHeartbeat
do rastreador a um site ou projeto de tag. A extensão do MA exige duas extensões adicionais:
Depois de incluir todas as três extensões mencionadas acima no projeto de tag, você pode prosseguir de uma das duas seguintes formas:
- Use APIs
MediaHeartbeat
do aplicativo web - Com a inclusão ou criação de uma extensão específica para um reprodutor que mapeie eventos específicos daquele reprodutor de mídia para as APIs na instância do rastreador do
MediaHeartbeat
. Essa instância é exposta por meio da extensão do MA.
Instalação e configuração da extensão do MA
-
Instalar - para instalar a extensão do MA, abra a propriedade da extensão e selecione Extensões > Catálogo, passe o mouse sobre a extensão Adobe Media Analytics para áudio e vídeo e selecione Instalar.
-
Configurar - para configurar a extensão do MA, abra a guia Extensões, passe o mouse sobre a extensão e selecione Configurar:
Opções de configuração:
window
Lembrete: a extensão do MA exige as extensões do Analytics e da Experience Cloud ID. Você também deve adicionar essas extensões à propriedade da sua extensão e configurá-las.
Uso da extensão do MA
Uso de uma página web/aplicativo JS
A extensão do MA exporta as APIs do MediaHeartbeat no objeto da janela global ao ativar a configuração "Exportar APIs para objeto da janela" na página Configuração. Exporta as APIs sob o nome da variável configurada. Por exemplo, se o nome da variável estiver configurado para ser ADB
, o MediaHeartbeat pode ser acessado em window.ADB.MediaHeartbeat
.
window["CONFIGURED_VARIABLE_NAME"]
está indefinido e não substitui as variáveis existentes.-
Criar instância do MediaHeartbeat:
window["CONFIGURED_VARIABLE_NAME"].MediaHeartbeat.getInstance
Params: um objeto delegado válido que expõe essas funções.
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 Método Descrição getQoSObject()
Retorna a instância theMediaObject
que contém as informações de QoS atuais. Esse método será chamado várias vezes durante uma sessão de reprodução. A implementação do player sempre deve retornar os dados de QoS mais recentes.getCurrentPlaybackTime()
Retorna a posição atual do indicador de reprodução. Para rastreamento VOD, o valor é especificado em segundos a partir do início do item de mídia. Para rastreamento LIVE/LIVE, o valor é especificado em segundos a partir do início do programa. Valor de retorno: uma promessa que resolve uma instância do
MediaHeartbeat
ou a rejeita com uma mensagem de erro. -
Acessar constantes do MediaHeartbeat:
window["CONFIGURED_VARIABLE_NAME"].MediaHeartbeat
Isso expõe todas as constantes e métodos estáticos da classe
MediaHeartbeat
.Você pode obter o player de amostra aqui: reprodutor MA de amostra. O reprodutor usado de exemplo atua como uma referência para mostrar como usar a extensão do MA para suportar o Media Analytics diretamente de um aplicativo web.
-
Crie a instância do rastreador de MediaHeartbeat da seguinte maneira:
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. });
Com o uso a partir de outras extensões
A extensão do MA expõe os módulos get-instance
e os módulos compartilhados media-heartbeat
a outras extensões. (Para obter informações adicionais sobre Módulos compartilhados, consulte a documentação Módulos compartilhados.)
turbine
(consulte um exemplo de código abaixo) fora de uma extensão.-
Criar instância de MediaHeartbeat: módulo compartilhado
get-instance
Params:
-
Um objeto delegado válido que expõe essas funções:
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 Método Descrição getQoSObject()
Retorna a instância MediaObject
que contém as informações de QoS atuais. Esse método será chamado várias vezes durante uma sessão de reprodução. A implementação do reprodutor sempre deve retornar os dados de QoS mais recentes.getCurrentPlaybackTime()
Retorna a posição atual do indicador de reprodução. Para rastreamento VOD, o valor é especificado em segundos a partir do início do item de mídia. Para rastreamento LIVE/LIVE, o valor é especificado em segundos a partir do início do programa. -
Um objeto de configuração opcional que expõe essas propriedades:
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 Propriedade Descrição Obrigatório Online Video Provider Nome da plataforma de vídeo online pela qual o conteúdo é distribuído. Não. Se estiver presente, substituirá o valor definido durante a configuração da extensão. Nome do reprodutor Nome do reprodutor de vídeo em uso (por exemplo, "AVPlayer", "HTML5 Player", "My Custom VideoPlayer") Não. Se estiver presente, substituirá o valor definido durante a configuração da extensão. Canal Propriedade do nome do canal Não. Se estiver presente, substituirá o valor definido durante a configuração da extensão.
Valor de retorno: uma promessa que resolve uma instância do
MediaHeartbeat
ou a rejeita com uma mensagem de erro. -
-
Constantes de acesso do MediaHeartbeat: módulo compartilhado
media-heartbeat
Esse módulo expõe todas as constantes e métodos estáticos dessa classe: https://adobe-marketing-cloud.github.io/media-sdks/reference/javascript/MediaHeartbeat.html.
-
Crie a instância do rastreador de MediaHeartbeat da seguinte maneira:
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. }); ...
-
Usando a instância Media Heartbeat, siga a documentação da Media SDK JS e a documentação da API JS para implementar o rastreamento de mídia.