Coletar informações de comércio, produto e pedido

Se sua organização vende produtos ou serviços, você pode usar esta página como um guia sobre como rastrear esses produtos e serviços.

Esta página usa o grupo de campos Esquema Commerce do XDM.

Este grupo de campos consiste em duas partes principais:

  • O objeto commerce. Este objeto permite indicar quais ações ocorrem com a matriz productListItems.
  • A matriz productListItems.
TIP
Se você estiver familiarizado com o Adobe Analytics, o objeto commerce conterá dados semelhantes aos eventos de comércio na variável events. A matriz de objetos productListItems contém dados semelhantes à variável products.

O objeto commerce commerce-object

Esta seção descreve os campos disponíveis no objeto commerce.

TIP
Uma medida tem dois campos: id e value. Na maioria das vezes, você só usa o campo value (por exemplo, 'value':1). O campo id permite definir um identificador exclusivo para rastreamento quando a medida foi enviada. Consulte a documentação do XDM para Medida para obter mais informações.
Medição
Recomendação
Descrição
cartAbandons
Opcional
Um carrinho não pode mais ser acessado ou comprado pelo usuário.
checkouts
Altamente recomendado
Um usuário não está mais procurando produtos, mas está comprando um produto.
productListAdds
Altamente recomendado
Um produto é adicionado a uma lista. Defina o produto no productListItems ao mesmo tempo.
productListOpens
Opcional
Uma nova lista de produtos é criada. Por exemplo, um novo carrinho de compras é criado.
productListRemovals
Altamente recomendado
Um produto é removido de uma lista de produtos.
productListReopens
Opcional
Uma lista de produtos é reativada pelo usuário. Essa ação geralmente acontece em campanhas de remarketing.
productListViews
Altamente recomendado
Uma lista de produtos é exibida.
productViews
Altamente recomendado
Ocorreu uma exibição de um produto. Defina o produto exibido no productListItems.
purchases
Altamente recomendado
Um pedido é aceito. Deve ter uma lista de produtos.
saveForLaters
Opcional
Um produto é salvo para uso futuro.

Exemplos de objeto Commerce

Expanda a seção abaixo para ver um exemplo de um comando do Web SDK usando um campo do objeto commerce.

productViews

Uma chamada sendEvent básica do Web SDK definindo o campo productViews como 1:

code language-javascript
alloy("sendEvent", {
  "xdm":{
    "commerce":{
      "productViews":{
        "value":1
      }
    }
  }
});

O objeto order order-object

O objeto commerce contém um objeto dedicado para coletar detalhes do pedido. Este objeto é chamado de objeto order.

Esta seção descreve todos os campos suportados pelo objeto order.

Campo
Opção
Recomendação
Descrição
currencyCode
A moeda ISO 4217 para o total do pedido.
payments[]
A lista de pagamentos de um pedido. Um paymentItem inclui o seguinte.
currencyCode
Opcional
A moeda ISO 4217 para este método de pagamento.
paymentAmount
Altamente recomendado
O valor do pagamento no código de moeda especificado.
paymentType
Altamente recomendado
O tipo de pagamento (por exemplo, credit_card, gift_card, paypal). Consulte a lista de valores conhecidos para obter detalhes.
transactionID
Opcional
Um identificador exclusivo para esta transação de pagamento.
priceTotal
Altamente recomendado
O total deste pedido após a aplicação de todos os descontos e impostos.
purchaseID
Altamente recomendado
O identificador exclusivo atribuído pelo vendedor para esta compra.
purchaseOrderNumber
Opcional
Um identificador exclusivo atribuído pelo comprador para esta compra.

Exemplos de objetos de ordem

Expanda a seção abaixo para ver um exemplo de um comando do Web SDK usando o objeto commerce.

Exemplo de objeto Order

Uma chamada de Web SDK sendEvent definindo o objeto order que se aplica a vários produtos na matriz productListItems:

code language-javascript
alloy("sendEvent",{
  "xdm":{
    "commerce":{
      "order":{
        "purchaseID":"123456789",
        "currencyCode":"USD",
        "priceTotal":39.98,
        "payments":[
          {
            "transactionID":"amx12345",
            "paymentAmount":39.98,
            "paymentType":"credit_card",
            "currencyCode":"USD"
          }
        ]
      }
    },
    "productListItems":[
      {
        "SKU":"HT105",
        "name":"The Big Floppy Hat",
        "priceTotal":29.99,
        "quantity":1
      },
      {
        "SKU":"HT104",
        "name":"The Small Floppy Hat",
        "priceTotal":9.99,
        "quantity":1
      }
    ]
  }
});

O objeto da lista de produtos product-list-object

A lista de produtos indica quais produtos estão relacionados à ação correspondente. Esta é uma lista de productListItems. Cada produto tem vários campos opcionais.

Campo
Recomendação
Descrição
currencyCode
Opcional
A moeda ISO 4217 do produto. Normalmente, esse campo só se aplica quando você tem vários produtos na lista de produtos com códigos monetários diferentes.
priceTotal
Altamente recomendado
Defina esse campo somente quando aplicável. Por exemplo, talvez não seja possível definir em um evento productView porque variações diferentes do produto podem ter preços diferentes, mas em um evento productListAdds.
product
Altamente recomendado
A ID XDM do produto.
productAddMethod
Altamente recomendado
O método usado para adicionar um item de produto à lista pelo visitante. Definido com productListAdds medidas e usado somente quando um produto é adicionado à lista. Os exemplos incluem add to cart button, quick add e upsell.
productName
Altamente recomendado
O nome de exibição ou o nome legível do produto.
quantity
Altamente recomendado
O número de unidades que o cliente indicou que precisa do produto. Deve ser definido em productListAdds, productListRemoves, purchases, saveForLaters e assim por diante.
SKU
Altamente recomendado
Unidade de manutenção de armazenamento. É o identificador exclusivo do produto.

Exemplos de lista de produtos

Expanda as seções abaixo para ver exemplos de comandos do Web SDK usando o objeto productListItems.

Exemplo de productListItems

Uma chamada sendEvent do Web SDK define o productViews para vários produtos na matriz productListItems:

code language-javascript
alloy("sendEvent",{
  "xdm":{
    "commerce":{
      "productViews":{
        "value":1
      }
    },
    "productListItems":[
      {
        "SKU":"HT105",
        "name":"The Big Floppy Hat",
      },
      {
        "SKU":"HT104",
        "name":"The Small Floppy Hat",
      }
    ]
  }
});
Exemplo de productListAdds

Uma chamada sendEvent do Web SDK que define o evento productListAdds para vários produtos na matriz productListItems:

code language-javascript
alloy("sendEvent",{
  "xdm":{
    "commerce":{
      "productListAdds":{
        "value":1
      }
    },
    "productListItems":[
      {
        "SKU":"HT105",
        "name":"The Big Floppy Hat",
        "quantity":1,
        "priceTotal":29.99,
        "productAddMethod":"Add to Cart Button"
      },
      {
        "SKU":"HT104",
        "name":"The Small Floppy Hat",
        "quantity":1,
        "priceTotal":9.99,
        "productAddMethod":"Add-on"
      }
    ]
  }
});
Exemplo de checkouts

Uma chamada sendEvent do Web SDK que define o evento checkouts para vários produtos na matriz productListItems:

code language-javascript
alloy("sendEvent",{
  "xdm":{
    "commerce":{
      "checkouts":{
        "value":1
      }
    },
    "productListItems":[
      {
        "SKU":"HT105",
        "name":"The Big Floppy Hat",
        "quantity":1,
        "priceTotal":29.99
      },
      {
        "SKU":"HT104",
        "name":"The Small Floppy Hat",
        "quantity":1,
        "priceTotal":9.99
      }
    ]
  }
});
recommendation-more-help
experience-platform-help-collection