push()

O método push() adiciona itens à Camada de Dados de Clientes Adobe (ACDL). É o único método que você pode chamar antes que a biblioteca seja carregada, portanto, é a forma principal como o código do site interage com a camada de dados.

adobeDataLayer.push(...items: (object | Function)[]): number | undefined

Antes de carregar a ACDL, push() é o método Array.prototype.push() padrão, e os itens aguardam na matriz até que a biblioteca seja carregada. Depois que o ACDL é carregado, sua versão de push() processa cada item imediatamente. Consulte Fila e histórico.

Sempre crie a matriz antes de enviar:

window.adobeDataLayer = window.adobeDataLayer || [];
window.adobeDataLayer.push({ page: { title: "Home" } });

Tipos de item item-types

Você pode enviar três tipos de itens:

Item
O que a ACDL faz
Objeto de dados
Mescla o objeto no estado computado e aciona adobeDataLayer:change.
Objeto de evento
Aciona o evento nomeado e adobeDataLayer:event. Mescla todos os dados no objeto no estado calculado.
Função
Chama a função e passa a camada de dados para ela.

Objeto de dados data

Um objeto simples sem uma chave event. A ACDL a mescla no estado computado:

window.adobeDataLayer.push({
  page: { title: "Products", language: "en" },
  user: { loggedIn: true }
});

Para excluir uma chave, pressione null como seu valor. Consulte Excluir dados.

Objeto de evento event

Um objeto simples com uma chave event que contém uma cadeia de caracteres não vazia. O objeto também pode incluir uma chave eventInfo e dados para mesclar no estado calculado:

window.adobeDataLayer.push({
  event: "cart add",
  eventInfo: { sku: "a-100" },
  cart: { itemCount: 3 }
});

A ACDL mescla os dados, cart neste exemplo, no estado computado e, em seguida, chama os ouvintes do evento. Consulte Eventos.

Função function

Uma função que a ACDL chama quando a biblioteca está pronta. Use-a para chamar outros métodos ACDL com segurança, mesmo que a biblioteca ainda não tenha sido carregada:

window.adobeDataLayer.push(function(dl) {
  dl.addEventListener("cart add", function(event) {
    console.log("Added to cart:", event.eventInfo.sku);
  });
});

ACDL chama a função com a camada de dados como seu argumento e como this. Ela não mantém a função na matriz. Se a função lança um erro, ele se propaga para o código que chamou push(). Antes que a biblioteca seja carregada, um erro também impede o ACDL de processar o restante da fila. Consulte Executar código quando o ACDL estiver pronto.

Valor de retorno return

Depois que o ACDL é carregado, push() retorna o novo comprimento da matriz quando adiciona um item ao histórico. Retorna undefined quando um item não é adicionado, como quando você envia apenas uma função ou um item inválido.

Enviar um item por chamada one-item

Você pode passar vários itens para uma chamada push(), e a ACDL os processa em ordem. No entanto, quando uma chamada combina diferentes tipos de itens, o histórico pode se tornar inconsistente. Por exemplo, se o primeiro item for uma função, a ACDL processará os objetos de dados que o seguem, mas não os adicionará ao histórico. Encaminhe cada item em uma chamada separada.

Itens inválidos invalid

ACDL aceita somente funções e objetos simples. Se você enviar qualquer outro valor, como uma string, um número, um booleano ou uma matriz, o ACDL não o processará e registrará o seguinte erro no console do navegador:

The following item cannot be handled by the data layer because it does not have a valid format: "example"

O push de null ou undefined gera um TypeError.

NOTE
Objetos com chaves on e handler, ou com uma chave off, não são dados. A ACDL os ignora e não os adiciona ao histórico. Para adicionar ou remover ouvintes, use addEventListener() e removeEventListener().
recommendation-more-help
experience-platform-help-collection