Eventos

Rastreie ações dos usuários e entenda como eles interagem com seu aplicativo

TL;DR

Eventos são ações rastreadas no seu app. Use Paywallo.track() para registrar e analisar comportamento dos usuários.

O que são Eventos?

Eventos são ações que os usuários realizam no seu app. Cada vez que algo importante acontece (um botão clicado, uma tela visualizada, uma compra realizada), você pode rastrear isso como um evento.

O SDK rastreia automaticamente alguns eventos importantes, mas você também pode enviar eventos customizados para rastrear comportamentos específicos do seu negócio.

Eventos são automaticamente enfileirados quando o dispositivo está offline e enviados quando a conexão for restabelecida.

Exemplo Rápido

Rastreando eventos básicos

import { Paywallo } from '@virex-tech/paywallo-sdk'; // Evento simples (sem propriedades) Paywallo.track('screen_viewed'); // Evento com propriedades Paywallo.track('button_clicked', { properties: { buttonId: 'cta_premium', screen: 'home', position: 'header', }, }); // Evento de conversão Paywallo.track('purchase_completed', { properties: { productId: 'premium_monthly', price: 29.90, currency: 'BRL', paymentMethod: 'credit_card', }, });

Nomes de eventos devem usar snake_case (ex: user_login, não userLogin).

Parâmetros

`Paywallo.track()`

Parâmetro	Tipo	Obrigatório	Descrição
`eventName`	string	Sim	Nome do evento (ex: "button_clicked")
`properties`	object	Não	Dados adicionais do evento (chave-valor)

Eventos Automáticos

O SDK rastreia automaticamente os seguintes eventos (não é necessário chamar track() manualmente):

Evento	Quando Dispara	Propriedades
`$app_installed`	Disparado uma vez na primeira abertura do app	installedAt, platform
`$session_start`	Disparado no início de cada sessão	sessionId, timestamp
`$session_end`	Disparado no fim da sessão	sessionId, durationSeconds, startedAt, endedAt
`$app_open`	App retorna ao foreground (abre ou volta do background)	sessionId, timestamp
`$app_background`	App vai para background	sessionId, durationSeconds
`$paywall_viewed`	Paywall é exibido	paywallId, placement
`$paywall_dismissed`	Paywall é fechado sem compra	paywallId, timeSpentSeconds
`$paywall_purchased`	Compra realizada no paywall	paywallId, productId, price

Eventos que começam com $ são reservados do sistema. Não use o prefixo $ em eventos customizados.

Propriedades de Eventos

Tipos de propriedades suportados

Paywallo.track('example_event', { properties: { // String category: 'tutorial', // Number score: 1500, price: 29.90, // Boolean isPremium: true, isFirstTime: false, // Date (ISO string) completedAt: new Date().toISOString(), // Array tags: ['featured', 'popular'], // Object (aninhado) metadata: { source: 'organic', campaign: 'summer_2024', }, }, });

Propriedades automáticas do SDK

O SDK adiciona automaticamente estas propriedades em todos os eventos:

Propriedade	Descrição	Exemplo
`$platform`	Sistema operacional	"ios" ou "android"
`$os_version`	Versão do SO	"17.2"
`$app_version`	Versão do app	"1.2.3"
`$device_model`	Modelo do dispositivo	"iPhone 15 Pro"
`$timestamp`	Data/hora do evento	ISO 8601 string

Dicas de Boas Práticas

•Use nomes descritivos em snake_case: purchase_completed é melhor que purchase
•Seja consistente com nomenclatura. Se você usa "screen_viewed", não use "page_opened" para a mesma ação
•Propriedades são opcionais, mas ajudam muito na análise. Adicione contexto relevante sempre que possível
•Não envie dados sensíveis (senhas, tokens, CPF) nas propriedades dos eventos

Próximos passos

Eventos são a base para Métricas Customizadas — aprenda a criar métricas a partir dos seus eventos.