Eventos
Os eventos informam a outros scripts que algo aconteceu na página, como uma exibição de página, um clique ou um envio de formulário. Você envia um evento para a ACDL (Adobe Client Data Layer) como um objeto com uma chave event. Os scripts que registraram um ouvinte de eventos para esse nome de evento são chamados.
Objetos de evento event-objects
Um objeto de evento tem as seguintes chaves:
eventcart add e Cart add são eventos diferentes.eventInfoeventInfo para ouvintes, mas não o armazena no estado computado.window.adobeDataLayer = window.adobeDataLayer || [];
// An event with no data
window.adobeDataLayer.push({ event: "page loaded" });
// An event with extra information for listeners
window.adobeDataLayer.push({
event: "click",
eventInfo: { reference: "component.hero-1" }
});
// An event that also updates the computed state
window.adobeDataLayer.push({
event: "cart add",
eventInfo: { sku: "a-100" },
cart: { itemCount: 3 }
});
Após essas envios, o estado calculado é { cart: { itemCount: 3 } }. As chaves event e eventInfo não fazem parte do estado computado, mas os objetos de evento permanecem na matriz da camada de dados como histórico.
Se a chave event estiver ausente, vazia ou não for uma cadeia de caracteres, o ACDL tratará o objeto como um push de dados. Nenhum ouvinte de evento é chamado e o estado calculado não inclui as chaves event ou eventInfo.
noun verb (cart add, form submit) ou object.action (cart.add, form.submit), e use-a em todos os lugares. Como os nomes diferenciam maiúsculas de minúsculas, os nomes inconsistentes são um motivo comum pelo qual os ouvintes não executam.Eventos incorporados built-in-events
Além do evento nomeado, o ACDL aciona dois eventos incorporados:
adobeDataLayer:change: acionado quando um push altera o estado calculado. Os envios de dados e os envios de eventos que contêm dados o acionam.adobeDataLayer:event: acionado para cada push de evento, qualquer que seja o nome.
A tabela a seguir mostra quais eventos cada tipo de push aciona:
adobeDataLayer:eventadobeDataLayer:change{ page: { title: "Home" } }{ event: "click" }eventInfo, como { event: "click", eventInfo: {...} }{ event: "cart add", cart: {...} }Quando um push aciona mais de um evento, o ACDL chama os ouvintes na seguinte ordem: adobeDataLayer:event, depois adobeDataLayer:change e, em seguida, o evento nomeado.
O que os ouvintes recebem listener-arguments
A ACDL chama cada ouvinte com um argumento: uma cópia do objeto completo que foi enviado por push, incluindo event, eventInfo e quaisquer dados.
window.adobeDataLayer.push(function(dl) {
dl.addEventListener("cart add", function(event) {
console.log(event.eventInfo.sku); // "a-100"
console.log(event.cart.itemCount); // 3
console.log(dl.getState("cart")); // { itemCount: 3 }
});
});
Os detalhes a seguir se aplicam a cada listener:
- O estado computado já foi atualizado. Quando um ouvinte é executado, o estado calculado já inclui os dados do push que o acionou.
- O argumento é uma cópia. Alterá-la não altera a camada de dados ou o objeto que foi enviado.
thisé a camada de dados. Dentro de uma função de ouvinte,thisrefere-se à matrizadobeDataLayer.- Ouvintes executados de forma síncrona. O ACDL chama cada ouvinte antes de
push()retornar. Mantenha os ouvintes curtos e não trabalhe lentamente com eles.
Ouvir eventos passados e futuros scope
Por padrão, um novo ouvinte é executado para eventos correspondentes que já estão na matriz da camada de dados e para eventos correspondentes que são enviados posteriormente. Esse comportamento significa que um script pode adicionar seu ouvinte a qualquer momento sem perder eventos que ocorreram anteriormente, como uma exibição de página enviada antes do carregamento da biblioteca de tags.
Você pode alterar esse comportamento com a opção scope para ouvir somente eventos anteriores ou futuros. Para saber como o ACDL mantém eventos anteriores, consulte Fila e histórico.
Evite loops infinitos loops
Um ouvinte pode enviar para a camada de dados. Processos ACDL que enviam imediatamente, antes que o ouvinte retorne. Se um ouvinte enviar algo que aciona o mesmo ouvinte novamente, as chamadas nunca terminarão até que o navegador acione um erro de estouro de pilha, como RangeError: Maximum call stack size exceeded. Por exemplo, um ouvinte adobeDataLayer:change que envia dados aciona a si mesmo.
Submeter de um ouvinte somente quando o novo push não puder acionar o mesmo ouvinte.