begin_checkout.md

begin_checkout

Esse evento indica que um usuário iniciou o processo de finalização da compra.

Parâmetros

Nome	Tipo	Obrigatório	Exemplo	Descrição
currency	string	Sim*	BRL	Moeda dos itens associados ao evento, no formato ISO 4217 de três letras. * Se você definir value, será necessário usar o parâmetro currency para que as métricas de receita sejam calculadas corretamente.
value	number	Sim*	7.77	Valor monetário do evento. * O parâmetro value costuma ser necessário para gerar relatórios importantes. Se você marca o evento como uma conversão, é recomendável definir value. * O parâmetro currency é obrigatório quando você define value.
coupon	string	Não	SUMMER_FUN	Nome/código do cupom associado ao evento. Os parâmetros coupon no nível do evento e do item são independentes.
items	Array<Item>	Sim		Itens do evento.

Item

Definição do tipo Item utilizado no parâmetro items do evento begin_checkout.

Nome	Tipo	Obrigatório	Exemplo	Descrição
item_id	string	Sim*	12345_67890 (skuID_productID)	ID do sku + ID do produto. * É preciso especificar item_id ou item_name.
item_name	string	Sim*	Camiseta Stan and Friends	Nome do item. *É preciso especificar item_id ou item_name.
affiliation	string	Não	Store	Uma afiliação de produto para indicar uma empresa fornecedora ou loja física. Observação: "affiliation" está disponível apenas no escopo do item.
coupon	string	Não	SUMMER_FUN	Nome/código do cupom associado ao item. Os parâmetros coupon no nível do evento e do item são independentes.
creative_name	string	Não	summer_banner2	Nome do criativo promocional. Se definido, o parâmetro creative_name no nível do evento é ignorado. Se não foi definido, é usado o parâmetro creative_name no nível do evento (quando presente).
creative_slot	string	Não	featured_app_1	Nome do slot do criativo promocional associado ao item. Se definido, o parâmetro creative_slot no nível do evento é ignorado. Se não foi definido, é usado o parâmetro creative_slot no nível do evento (quando presente).
discount	number	Não	2,22	Valor do desconto monetário associado ao item.
index	number	Não	5	Índice/posição do item em uma lista.
item_brand	string	Não	Store	Marca do item.
item_category	string	Não	Vestuário	Categoria do item. Quando usada como parte de uma hierarquia de categorias ou taxonomia, é a primeira categoria.
item_category2	string	Não	Adulto	Hierarquia da segunda categoria ou taxonomia adicional do item.
item_category3	string	Não	Camisas	Hierarquia da terceira categoria ou taxonomia adicional do item.
item_category4	string	Não	Gola redonda	Hierarquia da quarta categoria ou taxonomia adicional do item.
item_category5	string	Não	Manga curta	Hierarquia da quinta categoria ou taxonomia adicional do item.
item_list_id	string	Não	related_products	ID da lista em que o item foi apresentado ao usuário. Se definido, o parâmetro item_list_id no nível do evento é ignorado. Se não foi definido, é usado o parâmetro item_list_id no nível do evento (quando presente).
item_list_name	string	Não	Produtos relacionados	Nome da lista em que o item foi apresentado ao usuário. Se definido, o parâmetro item_list_name no nível do evento é ignorado. Se não foi definido, é usado o parâmetro item_list_name no nível do evento (quando presente).
item_variant	string	Não	verde	Variante, código exclusivo ou descrição do item para detalhes/opções adicionais.
location_id	string	Não	ChIJIQBpAG2ahYAR_6128GcTUEo (o ID de lugar do Google para São Francisco)	O local físico associado ao item, como a localização da filial da loja. É recomendável usar o ID de lugar do Google que corresponde ao item associado. Também é possível usar um ID de local personalizado. Observação: "location id" está disponível apenas no escopo do item.
price	number	Não	9,99	Valor monetário do item em unidades do parâmetro de moeda especificado.
promotion_id	string	Não	P_12345	ID da promoção associada ao item. Se definido, o parâmetro promotion_id no nível do evento é ignorado. Se não foi definido, é usado o parâmetro promotion_id no nível do evento (quando presente).
promotion_name	string	Não	Promoção de verão	Nome da promoção associada ao item. Se definido, o parâmetro promotion_name no nível do evento é ignorado. Se não foi definido, é usado o parâmetro promotion_name no nível do evento (quando presente).
quantity	number	Não	1	Quantidade do item. Se não for definido, quantity vai usar o valor "1".

Além dos parâmetros prescritos, você pode incluir até 27 parâmetros personalizados na matriz items.

Exemplo

sendEvent({
  name: "begin_to_checkout",
  params: {
    currency: "BRL",
    value: 7.77,
    coupon: "SUMMER_FUN",
    items: [
      {
        item_id: "12345_67890 (skuID_productID)",
        item_name: "Stan and Friends Tee",
        affiliation: "Merchandise Store",
        coupon: "SUMMER_FUN",
        discount: 2.22,
        index: 0,
        item_brand: "Store",
        item_category: "Apparel",
        item_category2: "Adult",
        item_category3: "Shirts",
        item_category4: "Crew",
        item_category5: "Short sleeve",
        item_list_id: "related_products",
        item_list_name: "Related Products",
        item_variant: "green",
        location_id: "ChIJIQBpAG2ahYAR_6128GcTUEo",
        price: 9.99,
        quantity: 1
      }
    ]
  }
});