Pular para o conteúdo principal

Eventos, campos e rotas

Cada coisa que a pessoa faz vira um evento. Os eventos vão ao Google Tag Manager pelo dataLayer e ao SDK do AI Web Push pelo aiWebPushFront.on, com os mesmos campos push_ nos dois lugares.

Como o evento chega​

DestinoNome do eventoCampos que se somam
dataLayerai_web_push_ mais o nome, como ai_web_push_floating_clickedpush_provider (ai_web_push), push_source e os campos push_
aiWebPushFront.ono nome curto, como floating_clickedsource e os campos push_

Exemplo mínimo, que roda depois de o script do plugin carregar.

aiWebPushFront.on('floating_clicked', function (detalhe) {
console.log(detalhe.push_acao, detalhe.push_rule, detalhe.push_element);
});

O aiWebPushFront só existe depois que o script do plugin carrega. O código do seu site que usa o on precisa rodar depois dele.

Os campos push_​

CampoO que traz
push_ruleO ID do passo que venceu. Na regra padrão vem padrao. Com Ação, o do passo chamado
push_stepA ordem do modal na visita, 1, 2, 3 e assim por diante. Só vem quando a Jornada encadeia modais
push_elementO ID do elemento, o mesmo de Elementos. Nos eventos do pedido e da seta vem o ID da seta
push_tempo_msO tempo, em milissegundos, até a resposta, em permission_granted, permission_denied e permission_timeout
push_acaoO que o clique no botão fez, em floating_clicked. Vale pedir_permissao, modal ou evento
push_motivoPor que a seta não apareceu ou fechou, ou por que o clique no botão não abriu o pedido, em permission_hint_closed, permission_hint_skipped e floating_prompt_skipped

Valores de push_motivo conhecidos. Em permission_hint_closed, x, fundo e tempo. Em permission_hint_skipped, navegador, idioma e resposta_imediata. Em floating_prompt_skipped, denied, resposta_imediata e sem_suporte.

Os campos novos só saem nos sites com a configuração do editor novo, que são os que já salvaram nele e as instalações novas. Os campos só se somam aos de sempre, nenhum sai.

Origem, push_source​

custom_modal, native_prompt, floating_button, site_controls, permission_preexisting, webview_exit, service_worker (push recebido com a pessoa fora da página) e action (Ação que dispara um evento).

Os eventos​

EventoQuando dispara
modal_showno modal do site apareceu
modal_accepteda pessoa tocou em Permitir no modal
modal_dismisseda pessoa fechou o modal (Agora não, Esc, X ou toque fora)
modal_no_responseo modal ficou sem resposta pelos Segundos sem resposta, só quando a Ação tem uma escolha para Sem resposta
prompt_showno pedido do navegador foi aberto
permission_granteda pessoa aceitou no navegador
permission_denieda pessoa negou no navegador
permission_timeouto pedido do navegador fechou sem resposta
subscription_successo cadastro do inscrito foi enviado ao servidor
subscription_skippedo navegador já estava cadastrado, nada foi enviado
subscription_errorerro ao gerar o cadastro
browser_not_supportedo navegador não tem a API de notificação
floating_showno botão flutuante apareceu
floating_clickeda pessoa tocou no botão flutuante
floating_ignoredo tempo de sem clique escolhido na Ação passou com o botão na tela e sem clique. Sem esse tempo na Ação, o evento não sai
floating_prompt_skippedo clique no botão não abriu o pedido do navegador
permission_hint_showna seta do Permitir apareceu
permission_hint_closeda seta saiu
permission_hint_skippeda seta não apareceu
push_received_while_awayum push chegou com a pessoa fora da página
webview_exit_prompt_shown, webview_exit_dismissed, webview_exit_intent_attempt, webview_exit_open_external_success, webview_exit_open_external_failed, webview_exit_auto_attempt, webview_exit_auto_success, webview_exit_auto_failedos eventos da saída de WebView, da aba Configurações Avançadas

Evento da Ação e evento do seu site​

Quando a Ação dispara um evento, o nome que você deu sai no dataLayer como ai_web_push_ seguido do nome, com push_source igual a action. No aiWebPushFront.on você ouve pelo nome que deu.

Evento do seu site​

Para o seu site avisar o plugin, use uma destas formas.

aiWebPushFront.track('abriu_quiz');
document.dispatchEvent(new CustomEvent('aiwebpush:evento', {detail: {nome: 'abriu_quiz'}}));
(window.aiWebPushQueue = window.aiWebPushQueue || []).push(['track', 'abriu_quiz']);

A fila aiWebPushQueue vale também antes de o plugin carregar.

Rotas REST​

RotaMétodoPara que serve
/wp-json/ai-web-push/v1/modal-configGETcarrega a configuração no editor (administrador)
/wp-json/ai-web-push/v1/modal-configPUTsalva a configuração (administrador)
/wp-json/ai-web-push/v1/modal-config/simularPOSTdiz qual passo vence numa página, o Testar uma página (administrador)
/wp-json/ai-web-push/v1/modal-config/converterPOSTconverte uma configuração de editores anteriores para elementos e jornada, o Importar (administrador)
/wp-json/ai-web-push/v1/eventsPOSTrecebe do script do site o cadastro de quem aceitou

Chave geral​

CampoO que é
define('AI_WEB_PUSH_MODAL_CONFIG_DESLIGADO', true); no wp-config.phpDesliga o editor e o modal dele sem desinstalar o plugin
filtro ai_web_push_modal_config_ligadoO mesmo da constante, por código. Devolver false desliga