Campo de Captura
Um Campo de Captura representa uma informação específica que será coletada dentro de uma captura. Uma captura é composta por uma coleção de campos. Cada tipo de captura (Product, Lead, Phone, Cart, Conversion, Generic) possui seus próprios campos obrigatórios e opcionais.
Por exemplo:
- Uma captura de Lead normalmente precisa do campo
lead. - Uma captura de Product pode exigir
name,price,urleimage. - Uma captura de Cart pode exigir
itemsebasket_value.
Sempre que você configurar uma captura, será necessário configurar todos os campos que a compõem.
Estrutura do Campo de Captura
| Campo | Tipo | Obrigatório | Valor Padrão | Descrição |
|---|---|---|---|---|
name | string | Sim | — | Nome identificador do campo capturado. |
selector | string | Não | — | Seletor CSS do elemento de onde o valor será extraído. |
htmlAttribute | enum | Não | VALUE | Define qual atributo do elemento será capturado. |
triggerEvent | enum | Não | LOAD | Define quando o campo será capturado. |
validatorNotNull | boolean | Não | false | (AVANÇADO) Exige que o valor não seja nulo ou vazio. |
validatorRegex | string | Não | — | (AVANÇADO) Expressão regular para validar o valor capturado. |
validatorGreaterThan | number | Não | — | (AVANÇADO) Valor mínimo permitido (numérico). |
validatorLesserThan | number | Não | — | (AVANÇADO) Valor máximo permitido (numérico). |
Detalhamento dos Campos
name
Tipo: string
Obrigatório: Sim
Descrição:
Nome identificador do campo. Deve representar claramente o dado capturado.
A maioria das capturas possui um conjunto de campos predefinidos, com nomes configurados automaticamente pelo sistema. Isso ocorre porque cada tipo de captura exige um conjunto específico de dados para descrever corretamente a entidade em questão — por exemplo, um produto normalmente é composto por preço, URL, imagem e descrição.
Já nas capturas do tipo Generic, o usuário pode definir livremente o nome dos campos que deseja capturar, de acordo com a necessidade do seu cenário.
selector
Tipo: string
Obrigatório: Não
Descrição:
Seletor CSS do elemento no DOM de onde o valor será extraído. Detalhes sobre seletores podem ser encontrados aqui.
Exemplos:
| Selector | Descrição |
|---|---|
.product-title | Captura o título do produto. |
#price | Captura o preço. |
input[name="email"] | Captura o valor digitado no campo de e-mail. |
htmlAttribute
Tipo: enum
Obrigatório: Não
Valor padrão: VALUE
Descrição:
Define qual atributo do elemento será capturado.
Valores disponíveis
| Valor | Uso |
|---|---|
VALUE | Valor de inputs e campos de formulário. |
SRC | URL de imagens. |
HREF | Link de redirecionamento. |
BACKGROUND_IMAGE | URL definida como imagem de fundo. |
INNER_HTML | HTML interno do elemento. |
INNER_TEXT | Texto visível do elemento. |
TEXT_CONTENT | Conteúdo textual bruto. |
META_CONTENT | Conteúdo de meta tags. |
URL | URL atual da página. |
triggerEvent
Tipo: LOAD, CHANGE, LOAD_CHANGE, CLICK
Obrigatório: Não
Valor padrão: LOAD
Descrição:
Define quando o campo será capturado.
| Evento | Comportamento |
|---|---|
LOAD | No carregamento da página. |
CHANGE | Quando o elemento sofre alteração. |
LOAD_CHANGE | No carregamento e em alterações posteriores. |
CLICK | Quando o elemento é clicado. |
Validadores (Configuração Avançada)
Os validadores são recursos de configuração avançada.
Recomenda-se solicitar apoio do time de suporte etag para utilizá-los corretamente.
Quando um validador é configurado em um campo, a captura só será registrada se todas as validações definidas forem atendidas.
Caso alguma validação falhe:
- A captura não é salva no sistema;
- Nenhuma ação derivada dela é executada.
Isso significa que o sistema só executará ações engatilhadas por capturas — como, por exemplo, o envio de e-mails de abandono de carrinho — se a captura configurada cumprir todas as validações estabelecidas.
Exemplo Prático
Imagine uma captura de Carrinho com as seguintes validações no campo cart_total:
validatorNotNull = truevalidatorRegex = número válidovalidatorGreaterThan = 100
Nesse cenário:
- Se o valor do carrinho for 50, a captura não será registrada.
- Se o valor estiver vazio ou inválido, a captura não será registrada.
- Apenas carrinhos com valor maior que 100 serão efetivamente capturados e poderão disparar ações, como uma campanha de recuperação.
Para que utilizar validadores?
Os validadores permitem:
- Criar segmentações mais inteligentes;
- Restringir campanhas a determinados perfis ou valores;
- Evitar disparos desnecessários;
- Garantir maior qualidade dos dados capturados.
Embora a configuração possa ser mais técnica, o time etag pode ajudar na definição e implementação adequada para o seu cenário.
validatorNotNull
Tipo: boolean
Exige que o valor capturado não seja nulo nem vazio.
validatorRegex
Tipo: string
Define uma expressão regular que o valor precisa satisfazer.
validatorGreaterThan
Tipo: number
Define o valor mínimo permitido (para campos numéricos). Requer que validatorRegex esteja configurado para validar número.
validatorLesserThan
Tipo: number
Define o valor máximo permitido (para campos numéricos).
Requer que validatorRegex esteja configurado para validar número.