E-commerce avançado

Nesta página, descrevemos como usar a gtag.js para coletar dados de e-commerce avançado. Se você configurar o Google Analytics na gtag.js e ativar o e-commerce avançado no Analytics, poderá usar a gtag.js para enviar dados de impressões, produtos, promoções e ações ao Analytics.

Tipos de dados e ações do e-commerce avançado

Há vários tipos de dados de e-commerce que você pode enviar:

Dados de impressões

Eles representam as informações de um produto que foi visto. Além disso, são representados por um impressionFieldObject e contêm os seguintes valores:

Chave Tipo de valor Obrigatório Descrição
id texto *Sim

O ID ou SKU do produto (por exemplo, P67890).

* É necessário definir um id ou name.

name texto *Sim

O nome do produto (por exemplo, camiseta do Android).

* É necessário definir um id ou name.

list texto Não A lista ou o conjunto a que o produto pertence (por exemplo, Resultados da pesquisa)
list_name texto Não A lista ou o conjunto a que o produto pertence (por exemplo, Resultados da pesquisa)
brand texto Não A marca associada ao produto (por exemplo, Google).
category texto Não A categoria a que o produto pertence (por exemplo, Vestuário). Use / como um delimitador para especificar até 5 níveis de hierarquia (por exemplo, Vestuário/Masculino/Camisetas).
variant texto Não A variante do produto (por exemplo, preto).
position número inteiro Não A posição do produto em uma lista ou conjunto (por exemplo, 2).
list_position número inteiro Não A posição do produto em uma lista ou conjunto (por exemplo, 2).
price número Não O preço de um produto (por exemplo, 29,20).

Dados do produto

Esses dados equivalem a produtos específicos que foram vistos ou adicionados ao carrinho de compras, entre outros. Eles são representados por um productFieldObject e contêm os seguintes valores:

Chave Tipo de valor Obrigatório Descrição
id texto *Sim

O ID ou SKU do produto (por exemplo, P67890).

* É necessário definir um dos IDs ou name.

name texto *Sim

O nome do produto (por exemplo, camiseta do Android).

* É necessário definir um dos IDs ou name.

brand texto Não A marca associada ao produto (por exemplo, Google).
category texto Não A categoria a que o produto pertence (por exemplo, Vestuário). Use / como um delimitador para especificar até 5 níveis de hierarquia (por exemplo, Vestuário/Masculino/Camisetas).
variant texto Não A variante do produto (por exemplo, preto).
price número Não O preço de um produto (por exemplo, 29,20).
quantity número inteiro Não A quantidade de um produto (por exemplo, 2).
coupon texto Não O código do cupom associado a um produto (por exemplo, PROMO_VERAO13).
position número inteiro Não A posição do produto em uma lista ou conjunto (por exemplo, 2).
list_position número inteiro Não A posição do produto em uma lista ou conjunto (por exemplo, 2).

Dados de promoções

Eles representam as informações de uma promoção que foi vista. Além disso, são representados por um promoFieldObject e contêm os seguintes valores:

Chave Tipo de valor Obrigatório Descrição
id texto *Sim

O ID da promoção (por exemplo, PROMO_1234).

* É necessário definir um id ou name.

name texto *Sim

O nome da promoção (por exemplo, Promoção de verão).

* É necessário definir um id ou name.

creative texto Não O criativo associado à promoção (por exemplo, verao_banner2).
creative_name texto Não O nome do criativo (por exemplo, verao_banner2).
position texto Não A posição do criativo (por exemplo, posicao_banner_1).
creative_slot texto Não O nome do slot do criativo (por exemplo, slot_banner_1).

Dados da ação

Esses dados representam as informações sobre uma ação que ocorreu relacionada ao e-commerce. Eles são representados por um actionFieldObject e contêm os seguintes valores:

Chave Tipo de valor Obrigatório Descrição
id texto *Sim

O ID da transação (por exemplo, T1234).

* Obrigatório se o tipo de ação for purchase ou refund

affiliation texto Não A loja ou afiliação na qual a transação ocorreu (por exemplo, Google Store).
revenue número Não

Especifica a receita total ou a soma geral associada à transação (por exemplo, 11,99). Esse valor pode inclui frete, tributos ou outros ajustes na receita total que você quer considerar como parte dos cálculos da receita.

valor número Não Valor (ou seja, receita) associado ao evento.
tax número Não O total de impostos associados à transação.
shipping número Não O custo de envio associado à transação.
coupon texto Não O cupom de transação resgatado na transação.
list texto Não A lista a que os produtos associados pertencem. Opcional.
items matriz Não Matriz que contém os produtos associados.
step número inteiro Não Um número que representa uma etapa no processo de finalização da compra. Opcional em ações de "finalização da compra".
checkout_step número inteiro Não Um número que representa uma etapa no processo de finalização da compra.
option texto Não Mais um campo para ações checkout e checkout_option que podem descrever os detalhes da opção na página de finalização da compra, como a forma de pagamento selecionada.
checkout_option text Não Opção de finalização da compra (ou seja, forma de pagamento selecionada).
Chave Tipo de valor Obrigatório Descrição
coupon string Não Código do cupom de um item à venda.

Ações de produtos e promoções

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

Ação Evento Descrição
click Um clique em um produto ou link do produto para um ou mais itens.
detail Uma visualização dos detalhes do produto.
add A adição de um ou mais produtos a um carrinho de compras.
remove A remoção de um ou mais produtos de um carrinho de compras.
checkout O início do processo de pagamento de um ou mais produtos.
checkout_option O envio de um valor de opção para determinada etapa do pagamento.
purchase A venda de um ou mais produtos.
refund O reembolso de um ou mais produtos.
promo_click O clique em uma promoção interna.
add_to_cart Um usuário adiciona um ou mais produtos a um carrinho de compras.
begin_checkout Um usuário inicia o processo de finalização da compra de um ou mais produtos.
checkout_progress Um usuário conclui as etapas restantes de finalização da compra depois da primeira.
purchase Um usuário conclui uma compra.
refund Um usuário recebe um reembolso de um ou mais produtos.
remove_from_cart Um usuário remove um ou mais produtos de um carrinho de compras.
select_content Um usuário clica em um produto ou no link de um produto.
set_checkout_option A etapa de finalização da compra que o usuário está concluindo.
view_item Um usuário visualiza os detalhes de um produto.
view_item_list Um usuário vê uma lista de um ou mais produtos.
view_promotion Um usuário clica em uma promoção interna.
view_refund Um usuário vê um reembolso de um ou mais produtos.

Exemplos

Medir as impressões do produto

Para medir as impressões do produto, envie view_item_list com as informações dele:

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
    }
  ]
});

Medir os cliques no produto

Para medir um clique no produto, envie um evento select_content, especifique product como content_type e forneça as informações dele:

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
    }
  ]
});

Medir as visualizações de detalhes do produto

Após clicar nas informações, o usuário acessa a página de detalhes do produto. Para medir as visualizações de detalhes, envie um evento view_item com os detalhes do item:

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'
    }
  ]
});

Medir as adições e remoções de produtos do carrinho de compras

Para medir a adição de um produto a um carrinho de compras, envie um evento add_to_cart com as informações dele:

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 medir a remoção de um produto do carrinho de compras, envie um evento remove_from_cart com as informações dele:

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'
    }
  ]
});

Medir as finalizações de compras

Para medir cada etapa do processo de pagamento, siga estas etapas:

  1. Adicione o código de mediçã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. Medir as etapas de finalização da compra

Para medir a primeira etapa da finalização da compra, envie um evento begin_checkout com os itens da finalização:

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": ""
});

Para medir cada etapa da finalização de compra subsequente, envie um evento checkout_progress com os itens da 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. Medir as opções de finalização de compra

Para medir uma dessas opções, envie um evento set_checkout_option com a opção de finalização de compra:

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

Medir as impressões da promoção

Para medir as impressões da promoção, envie um evento view_promotion com informações dela:

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

Medir os cliques da promoção

Para medir os cliques de uma promoção, envie um evento select_content e informe a promoção:

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

Medir as compras

Para medir uma transação, envie um evento purchase com os itens dela:

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'
    }
  ]
});

Medir os reembolsos

Para medir um reembolso total de uma transação, envie um evento refund com o ID da transação:

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

Para medir um reembolso parcial, envie um evento refund com o ID 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'
    }
  ]
});