Dicionário de dados

nome
tipo
exemplo
Descrição
campaignId
STRING
"3bb82f16-7a0a-4f36-a2d8-ed331c1f03a0"
id da campanha retornada na requisição de leilões
partnershipId
INTERGER
123
id da parceria retornada na requisição de leilões
zaplyAdsCustomerId
STRING
"71bcc076-e8ae-43d9-a519-8437a4bec909"
id do usuário na plataforma, ou id de uma sessão do usuário (recomendável com uma sessão com mínimo de 7 dias)
cartId
STRING
"123abc"
Id do carrinho gerado no sistema do ecommerce
event
ENUM
"view"
Tipo de evento do Zaply Ads
﻿
view: quando o produto resultado de um leilão é visualizado.
click: quando o produto resultado de um leilão é clicado.
add_to_cart: quando o produto resultado de um leilão é adicionado ao carrinho
device
ENUM
"mobile"
Entre "mobile" e "desktop"
campaignType
ENUM
"sponsored"
Tipos de campanhas do Zaply Ads.
﻿
sponsored: eventos de produtos patrocinados
banner:  evento de banners
digital_signage: telas digitais
cpc
FLOAT
0.10
Campo exclusivo quando o "event" for igual a "click" e o "campaignType" for "sponsored"
﻿
custo por clique retornado na requisição de leilões para produtos patrocinados.
productId
STRING
"123abc"
Campo exclusivo quando o "event" for igual a "click" e o "campaignType" for "sponsored"
cpm
FLOAT
0.002
Campo exclusiso quando o "event" for a igual a "view" e o "campaignType" for "banner". Cpm retornado na requisição de leilão para banners.
slotId
STRING
"banner-landing-x"
Campo exclusivo quando o "campaignType" for igual a "banner". SlotId retornado na requisição de leilão para banners.
categoryId
STRING
"refrigerante" | "23"
Campo de categoria do banner, caso o banner seja exibido em uma página de categoria da propriedade de anúncio. Campo deve ser enviado sempre que "campaignType" for igual a "banner" e o banner estiver posicionado em uma página de categoria. CategoryId é retornado na requisição de leilão para banners, caso exista.
﻿