DataLayer — referência completa

Esta página documenta os eventos enviados às camadas JavaScript usadas nos produtos rmbrg, com base no pacote @rmbrg/analytics. Ela é destinada a integradores que usam Google Tag Manager, GA4 ou warehouses de eventos.

Visão geral das camadas

Camada global	Quem escreve	Uso recomendado
`window.dataLayer`	Apps rmbrg (`pushEvent`, `Analytics.*`)	Telemetria completa da plataforma, ecommerce do checkout, identidade
`window.clientDataLayer`	Container GTM do cliente + helpers `ClientAnalytics.*`	Pipelines GA4/Meta do estabelecimento, sem colidir com eventos internos

Quando o perfil tem gtmId, o script do GTM do cliente é carregado com clientDataLayer como nome da fila (l no snippet), não dataLayer.

Helpers de push (rmbrg)

// push simples
window.dataLayer = window.dataLayer || []
window.dataLayer.push({ event: 'page_view', ... })

// push "limpo" — usado em eventos ecommerce (reseta `event` antes)
window.dataLayer.push({ event: undefined })
window.dataLayer.push({ event: 'purchase', ecommerce: { ... } })

Campos comuns

Muitos eventos incluem o campo string product com valores como crdp, imov ou hospd.

Áreas de navegação (setNavigationArea / navigation_area):

landing · dashboard · public_page · auth · onboarding

Navegação e página (SPA)

`page_view`

Disparado em mudanças de rota no app.

Campo	Tipo	Descrição
`event`	string	`page_view`
`page_path`	string	Caminho
`page_title`	string	Título exibido
`page_type`	string	Classificação livre do app
`product`	string	Produto
`area`	string	Uma de `NavigationArea`

Autenticação e onboarding

`sign_up_started`

Campo	Descrição
`product`	Produto
`method`	`'email'`

`sign_up_code_sent`

Campo	Descrição
`product`	Produto

`sign_up`

Evento alinhado ao padrão GA4 de cadastro.

Campo	Descrição
`product`	Produto
`method`	`'email'`

`login_started` · `login`

login segue convenção GA4.

`profile_data_completed`

Perfil mínimo salvo após cadastro.

`onboarding_started` · `onboarding_step` · `onboarding_completed`

Evento	Campos extra
`onboarding_step`	`step` (número), `step_name`
`onboarding_completed`	`plan`

Ecommerce (checkout de planos / Aura)

Estes eventos normalmente usam pushEventClean e incluem um objeto ecommerce.

`view_item_list`

ecommerce.items[] → item_id, item_name, item_category ('plan' | 'aura'),
  price, item_variant ('monthly' | 'semiannual' | 'annual')

`select_item`

Um item selecionado no mesmo formato de items[0].

`begin_checkout`

Campo	Descrição
`ecommerce.value`	Valor total
`ecommerce.currency`	Moeda (padrão `BRL`)
`ecommerce.items[]`	Itens com `quantity`

`add_payment_info`

Inclui payment_type dentro de ecommerce.

`purchase`

Campo	Descrição
`ecommerce.transaction_id`	ID da transação
`ecommerce.value`	Valor
`ecommerce.items[]`	Um item resumido (`item_id`, `item_name`, `item_category`, `item_variant`, `price`, `quantity`)

`plan_upgrade_initiated` · `plan_upgrade_completed` · `plan_downgrade` · `subscription_cancelled`

Campos de plano/período/valor conforme implementação no app.

Aura (IA)

Evento	Campos
`aura_viewed`	`product`
`aura_activated`	`tier`, `period`, `value`
`aura_generation`	`feature` (ex.: `menu_description`, `bio`, `listing_description`, `report`), `credits_used`, `credits_remaining`

Dashboard (área logada)

Evento	Descrição
`dashboard_section_view`	`section`
`profile_saved`	`has_avatar`, `has_cover`
`link_added` · `link_deleted`	`link_type`
`menu_created`	—
`menu_item_added`	`has_photo`, `has_price`
`listing_created`	`type`, `transaction_type`
`qr_code_downloaded`	`format` (ex.: png, svg)

Página pública (camada rmbrg)

`public_page_view`

Campo	Descrição
`profile_id`	UUID do perfil
`profile_slug`	Slug público
`profile_plan`	Plano atual
`referrer`	Referrer normalizado ou string vazia
`via_qr`	boolean

`public_link_click`

link_type, link_title, link_position (índice).

`public_menu_view`

menu_id, menu_name.

`public_menu_item_view`

item_name, item_category, item_price opcional.

`public_listing_view`

listing_id, listing_type, listing_price opcional.

`public_qr_scan`

qr_type: 'profile' | 'listing'

`public_search`

search_term, results_count.

Identidade e propriedades

`user_identity` (área logada)

client_id → user_id do painel
user_properties: cidade, estado, plano, product

`profile_identity` (página pública)

profile_id
user_properties: profile_cidade, profile_estado, profile_plano, product

`navigation_area`

Payload simples: { event: 'navigation_area', area }.

Camada do cliente (`clientDataLayer`)

Funções expostas em ClientAnalytics:

Evento	Quando	Campos principais
`page_view`	SPA pública	`page_path`, `page_title`, `profile_slug`, `profile_name`
`link_click`	Clique em link	`link_type`, `link_title`, `link_url`, `link_position`, `profile_slug`
`menu_view`	Menu exibido	`menu_name`, `profile_slug`
`view_item`	Item de cardápio/imóvel	`item_name`, `item_category`, `item_price?`, `profile_slug` (+ campos de listagem)
`search`	Busca	`search_term`, `profile_slug`
`qr_scan`	QR	`profile_slug`, `qr_type`

Use esses nomes como Eventos personalizados no GTM ao criar disparadores.

Erros frequentes

Duplicar purchase/view_item — conferir se GA4 nativo e GTM disparam o mesmo hit.
Ler dataLayer esperando eventos do cliente — o GTM do cliente escreve em clientDataLayer.
ecommerce inconsistente — eventos pushEventClean zeram o campo event anterior; não misture formatos GA3 legacy.

DataLayer — referência completa

Visão geral das camadas

Helpers de push (rmbrg)

Campos comuns

Navegação e página (SPA)

page_view

Autenticação e onboarding

sign_up_started

sign_up_code_sent

sign_up

login_started · login

profile_data_completed

onboarding_started · onboarding_step · onboarding_completed

Ecommerce (checkout de planos / Aura)

view_item_list

select_item

begin_checkout

add_payment_info

purchase

plan_upgrade_initiated · plan_upgrade_completed · plan_downgrade · subscription_cancelled