Guide Evento Radiodifusão

A transmissão de eventos permite que os desenvolvedores web ouçam eventos transmitidos pelo widget Guide, como um modelo sendo exibido ou um ponto de entrada sendo clicado. Depois, os desenvolvedores podem passar os dados do evento para sistemas de registro de terceiros, como uma ferramenta de relatórios analíticos de sua escolha. A transmissão de eventos é destinada a pessoas responsáveis ​​pela integração do Guide com um site. Exige-se experiência com tecnologias da Web de interface do usuário, inclusive HTML, CSS e JavaScript.

Escuta de eventos

O exemplo a seguir demonstra a escuta do evento templateDisplayed na página:

window.addEventListener("templateDisplayed", function(e) {console.info("Event type: " +  e.type + "  || Detail: " + JSON.stringify(e.detail));});

Como alternativa, eis um exemplo que inclui a carga de Guide em uma página e a escuta do evento templateDisplayed:

(function (i, s, o, r, g, v, a, m) {   
  g = v ? g + '?v=' + v : g; i['CXoneDfo'] = r;   
  i[r] = i[r] || function () {(i[r].q = i[r].q || []).push(arguments)}; i[r].l = +new Date(); i   [r].u = g; 
  a = s.createElement(o); m = s.getElementsByTagName(o)[0]; a.async = true;
  a.src = g + '?' + Math.round(Date.now() / 1000 / 3600); m.parentNode.insertBefore(a, m); 
})(window, document, 'script', 'cxone', '<LOADER-URL>');

cxone('init', '<BRAND-ID>');
cxone('guide', 'init', '<CHANNEL-ID>');

const guideEvents = ['templateDisplayed'
];
      
function handleEvent(event) {  
  console.log('Entire event:', event); 
  console.log('Event Detail property:', event.detail);
}
      
guideEvents.forEach(eventType => {
  window.addEventListener(eventType, handleEvent);
});

Os eventos do Guide são os seguintes:

Eventos de modelos	eventos de oferta proativa
templateDisplayed	proactiveOfferDisplayed
menuOpened	proactiveOfferSuccessful
menuClosed	proactiveOfferDeclined
entrypointOpened
entrypointClosed
pcqDisplayed
pcqFieldPopulated
pcqSubmitted

Guide Carga útil de evento

Os eventos Guide têm as propriedades de um CustomEvent. A carga útil sempre inclui:

• type - O tipo de evento, por exemplo, templateDisplayed ou menuOpened.

• detalhe - Uma estrutura com propriedades relevantes para o evento.

Por exemplo:

templateDisplayed

Utilize o evento templateDisplayed para monitorar quando um modelo for exibido em uma página. O modelo pode ter um único canal, diversos canais ou um portal de cliente.

O evento retorna o seguinte:

• tipo está definido como templateDisplayed.

• carga útil detalhada, que é específica ao tipo de modelo sendo exibido.

menuOpened

Utilize o evento menuOpened para monitorar quando o botão de menu for clicado ou quando um menu for exibido na atualização da página. Este evento diz respeito a modelos de canais múltiplos e a modelos de portal do cliente.

O evento retorna o seguinte:

• tipo está definido como menuOpened.

• carga útil detalhada, que é específica ao tipo de menu sendo aberto. As opções são:

menuClosed

Utilize o evento menuClosed para monitorar quando o botão for clicado para ocultar o portal do cliente ou o modelo de canais múltiplos.

O evento retorna o seguinte:

• tipo está definido como menuClosed.

• carga útil detalhada, que é específica ao tipo de menu sendo fechado. As opções são:

entrypointOpened

Utilize o evento entrypointOpened para monitorar quando um ponto de entrada for aberto. Considera-se que um ponto de entrada está aberto quando um visitante clicar no botão de um ponto de entrada ou quando um ponto de entrada for exibido na atualização da página.

Nos modelos de portal do cliente, as seguintes são consideradas aberturas de pontos de entrada:

• Quando o botão Guide é clicado após a abertura e minimização prévias de um ponto de entrada.
• O visitante clica em um artigo para lê-lo.
• O visitante clica no link Mais artigos.
• O visitante efetuará uma pesquisa na base de conhecimento.
• O visitante clicará no botão para continuar um bate-papo.

O evento retorna o seguinte:

• tipo está definido como entrypointOpened.

• carga útil detalhada do ponto de entrada.

entrypointClosed

Utilize o evento entrypointClosed para monitorar quando um ponto de entrada for fechado. Um ponto de entrada estará fechado quando o canal definido no ponto de entrada tiver sido ignorado.

No caso do portal de um cliente, se você mudar os botões de pontos de entrada, o ponto de entrada antigo será fechado antes que o novo ponto de entrada seja exibido.

O evento retorna o seguinte:

• tipo está definido como entrypointOpened.

• carga útil detalhada do ponto de entrada.

pcqDisplayed

Utilize o evento pcqDisplayed para monitorar quando uma pesquisa de pré-contato for exibida.

O evento retorna o seguinte:

pcqFieldPopulated

Utilize o evento pcqFieldPopulated para monitorar quando um campo de uma pesquisa de pré-contato for editado. Observe que este evento não será transmitido se um visitante remover o valor de um campo e este estiver vazio.

O evento retorna o seguinte:

pcqSubmitted

Utilize o evento pcqSubmitted para monitorar quando uma pesquisa de pré-contato for encaminhada com êxito pelo visitante.

O evento retorna o seguinte:

proactiveOfferDisplayed

Utilize o evento proactiveOfferDisplayed para monitorar quando uma oferta proativa for exibida na página.

O evento retorna o seguinte:

proactiveOfferSuccessful

Utilize o evento proactiveOfferSuccessful para monitorar quando uma oferta proativa tiver tido êxito. Uma oferta proativa terá êxito quando o visitante clicar em um botão de chamada de ação. No caso de um botão de chamada de ação de bate-papo, o visitante precisará iniciar o bate-papo. No caso de um e-mail, o visitante precisará enviar uma mensagem de e-mail.

O evento retorna o seguinte:

proactiveOfferDeclined

Utilize o evento proactiveOfferDeclined para monitorar quando uma oferta proativa for recusada em uma página. Uma oferta proativa é recusada quando o visitante clicar em um botão de chamada de ação definido como Recusada ou no ícone X de fechar, situado no canto superior direito da oferta proativa.

O evento retornará

Detalhes sobre o botão em cargas úteis

Cargas úteis para botões de modelo

A carga útil varia com base no tipo de canal referido em um modelo.

Cargas úteis de templateButton

Detalhes sobre os botões de pontos de entrada (templateButton).

Tipos de ação correspondentes às ofertas proativas

O tipo de ação correspondente à oferta proativa pode ser o início de um bate-papo, o clique em um ponto de entrada, um artigo ou o fechamento da oferta proativa.

Ou se o visitante fechar a oferta proativa com o botão X.