Comércio eletrônico avançado com gtag.js

Esta página descreve como usar gtag.js para coletar dados de comércio eletrônico avançado.

Se você configurar o Google Analytics em gtag.js e ativar o comércio eletrônico avançado no Google Analytics, poderá usar a gtag.js para enviar dados de impressões, produtos, promoções e ações ao Google Analytics.

Para uma lista de eventos relacionados a comércio eletrônico, consulte a referência de eventos de gtag.js.

Dados de impressões

Os parâmetros do item a seguir representam as informações sobre um produto que foi visualizado:

Parâmetro do item Tipo de dado Obrigatório Descrição
id string Sim* Código / SKU exclusivo do item
name string Sim* Nome do item
list_name string Não A lista na qual o item foi apresentado ao usuário
brand string Não Marca do item
category string Não Categoria do item
variant string Não Variante do item
list_position integer Não Posição do item na lista
price number Não Preço de compra do item

*É necessário configurar o id ou name.

Dados do produto

Os parâmetros do item a seguir representam as informações sobre um produto que foi visualizado, adicionado ao carrinho de compras, etc.:

Parâmetro do item Tipo de dado Obrigatório Descrição
id string Sim* Código / SKU exclusivo do item
name string Sim* Nome do item
brand string Não Marca do item
category string Não Categoria do item
variant string Não Variante do item
price number Não Preço de compra do item
quantity integer Não Quantidade de itens
coupon string Não Código do cupom de um item à venda
list_position integer Não Posição do item na lista

*É necessário configurar o id ou name.

Dados da promoção

Os parâmetros da promoção a seguir representam as informações sobre uma promoção que foi visualizada:

Parâmetro da promoção Tipo de dado Obrigatório Descrição
id string Sim* Código da promoção
name string Sim* Nome da promoção
creative_name string Não Nome do criativo usado
creative_slot string Não Nome da posição do criativo

*É necessário configurar o id ou name.

Dados da ação

Os seguintes parâmetros do evento e do item representam as informações sobre uma ação que ocorreu relacionada ao comércio eletrônico:

Parâmetro do evento Tipo de dado Obrigatório Descrição
transaction_id string Sim* Código exclusivo da transação
affiliation string Não Loja ou afiliação na qual essa transação ocorreu
value number Não Valor (ou seja, receita) associado ao evento
tax number Não Valor dos impostos
shipping number Não Custo de envio
items array Não Matriz que contém os produtos associados
checkout_step number Não Etapa do processo de finalização da compra (apresentada como um número)
checkout_option string Não Opção de finalização da compra (ou seja, forma de pagamento selecionada)

*Obrigatório para purchase ou refund.

Parâmetro do item Tipo de dado Obrigatório Descrição
coupon string Não Código do cupom de um item à venda

Ações do produto e da promoção

As ações (eventos) a seguir especificam como interpretar os dados de produtos e promoções que você envia ao Google Analytics.

Evento Descrição
select_content Um clique em um produto ou link do produto para um ou mais produtos
view_item Uma visualização dos detalhes do produto
add_to_cart Adição de um ou mais produtos a um carrinho de compras
remove_from_cart Remoção de um ou mais produtos de um carrinho de compras
begin_checkout Início do processo de finalização da compra de um ou mais produtos
set_checkout_option O envio de um valor de opção para determinada etapa da finalização de compra
purchase A venda de um ou mais produtos
refund O reembolso de um ou mais produtos
view_promotion Um clique em uma promoção interna

Avaliar as impressões do produto

Para avaliar as impressões de um produto, envie uma view_item_list com as informações do item:

gtag('event', 'view_item_list', {
  "items": [
    {
      "id": "P12345",
      "name": "Android Warhol T-Shirt",
      "list_name": "Search Results",
      "brand": "Google",
      "category": "Apparel/T-Shirts",
      "variant": "Black",
      "list_position": 1,
      "quantity": 2,
      "price": 2
    },
    {
      "id": "P67890",
      "name": "Flame challenge TShirt",
      "list_name": "Search Results",
      "brand": "MyBrand",
      "category": "Apparel/T-Shirts",
      "variant": "Red",
      "list_position": 2,
      "quantity": 1,
      "price": 3
    }
  ]
});

Avaliar os cliques do produto

Para avaliar os cliques, envie um evento select_content, especifique o product como content_type e forneça as informações do produto:

gtag('event', 'select_content', {
  "content_type": "product",
  "items": [
    {
      "id": "P12345",
      "name": "Android Warhol T-Shirt",
      "list_name": "Search Results",
      "brand": "Google",
      "category": "Apparel/T-Shirts",
      "variant": "Black",
      "list_position": 1,
      "quantity": 2,
      "price": 2
    }
  ]
});

Avaliar as visualizações de detalhes do produto

Após clicar nas informações do produto, um usuário pode ver a página de detalhes do item. Para avaliar esse tipo de visualização, envie um evento view_item com estes detalhes:

gtag('event', 'view_item', {
  "items": [
    {
      "id": "P12345",
      "name": "Android Warhol T-Shirt",
      "list_name": "Search Results",
      "brand": "Google",
      "category": "Apparel/T-Shirts",
      "variant": "Black",
      "list_position": 1,
      "quantity": 2,
      "price": '2.0'
    }
  ]
});

Avaliar os produtos adicionados e removidos do carrinho de compras

Para avaliar a adição de um produto ao carrinho de compras, envie um evento add_to_cart com as informações desse item:

gtag('event', 'add_to_cart', {
  "items": [
    {
      "id": "P12345",
      "name": "Android Warhol T-Shirt",
      "list_name": "Search Results",
      "brand": "Google",
      "category": "Apparel/T-Shirts",
      "variant": "Black",
      "list_position": 1,
      "quantity": 2,
      "price": '2.0'
    }
  ]
});

Para avaliar o produto removido do carrinho de compras, envie um evento remove_from_cart com as informações desse produto:

gtag('event', 'remove_from_cart', {
  "items": [
    {
      "id": "P12345",
      "name": "Android Warhol T-Shirt",
      "list_name": "Search Results",
      "brand": "Google",
      "category": "Apparel/T-Shirts",
      "variant": "Black",
      "list_position": 1,
      "quantity": 2,
      "price": '2.0'
    }
  ]
});

Avaliar as impressões da promoção

Envie um evento view_promotion com as informações da promoção para avaliar as impressões dela:

gtag('event', 'view_promotion', {
  "promotions": [
    {
      "id": "abc123",
      "name": "summer_promo"
    },
    {
      "id": "xyz987",
      "name": "spring savings"
    }
  ]
});

Avaliar os cliques na promoção

Envie um evento select_content e forneça a promoção para avaliar os cliques nela:

gtag('event', 'select_content', {
  "promotions": [
    {
      "id": "abc123",
      "name": "summer_promo"
    }
  ]
});

Avaliar as finalizações de compra

Para avaliar cada etapa do processo de finalização de compra, faça o seguinte:

  1. Adicione o código de avaliação para acompanhar cada etapa do processo de finalização de compra.
  2. Inclua o mesmo código para registrar as opções de conclusão de compra, se aplicável.

1. Avaliar as etapas de finalização da compra

Envie um evento begin_checkout com os itens da compra para avaliar a primeira etapa da finalização dessa compra:

gtag('event', 'begin_checkout', {
  "items": [
    {
      "id": "P12345",
      "name": "Android Warhol T-Shirt",
      "list_name": "Search Results",
      "brand": "Google",
      "category": "Apparel/T-Shirts",
      "variant": "Black",
      "list_position": 1,
      "quantity": 2,
      "price": '2.0'
    }
  ],
  "coupon": ""
});

Envie um evento checkout_progress com os itens da finalização de compra para avaliar cada etapa subsequente dessa finalização:

gtag('event', 'checkout_progress', {
  "items": [
    {
      "id": "P12345",
      "name": "Android Warhol T-Shirt",
      "list_name": "Search Results",
      "brand": "Google",
      "category": "Apparel/T-Shirts",
      "variant": "Black",
      "list_position": 1,
      "quantity": 2,
      "price": '2.0'
    }
  ],
  "coupon": "SUMMER_DISCOUNT"
});

2. Avaliar as opções de finalização da compra

Envie um evento set_checkout_option com determinada opção de finalização da compra para avaliá-la:

gtag('event', 'set_checkout_option', {
  "checkout_step": 1,
  "checkout_option": "shipping method",
  "value": "USPS"
});

Avaliar as compras

Envie um evento purchase com os itens da transação para avaliá-la:

gtag('event', 'purchase', {
  "transaction_id": "24.031608523954162",
  "affiliation": "Google online store",
  "value": 23.07,
  "currency": "USD",
  "tax": 1.24,
  "shipping": 0,
  "items": [
    {
      "id": "P12345",
      "name": "Android Warhol T-Shirt",
      "list_name": "Search Results",
      "brand": "Google",
      "category": "Apparel/T-Shirts",
      "variant": "Black",
      "list_position": 1,
      "quantity": 2,
      "price": '2.0'
    },
    {
      "id": "P67890",
      "name": "Flame challenge TShirt",
      "list_name": "Search Results",
      "brand": "MyBrand",
      "category": "Apparel/T-Shirts",
      "variant": "Red",
      "list_position": 2,
      "quantity": 1,
      "price": '3.0'
    }
  ]
});

Avaliar os reembolsos

Envie um evento refund com o código da transação para avaliar o reembolso total dessa transação:

gtag('event', 'refund', { "transaction_id": "T12345" })

Para avaliar um reembolso parcial, envie um evento refund com o código da transação e os itens que serão reembolsados:

gtag('event', 'refund', {
  "transaction_id": "79.18502354114992",
  "affiliation": "Google online store",
  "value": 23.07,
  "currency": "USD",
  "tax": 1.24,
  "shipping": 0,
  "items": [
    {
      "id": "P12345",
      "name": "Android Warhol T-Shirt",
      "list_name": "Search Results",
      "brand": "Google",
      "category": "Apparel/T-Shirts",
      "variant": "Black",
      "list_position": 1,
      "quantity": 2,
      "price": '2.0'
    },
    {
      "id": "P67890",
      "name": "Flame challenge TShirt",
      "list_name": "Search Results",
      "brand": "MyBrand",
      "category": "Apparel/T-Shirts",
      "variant": "Red",
      "list_position": 2,
      "quantity": 1,
      "price": '3.0'
    }
  ]
});