Documentation
Feedback
Guides
VTEX IO Apps

VTEX IO Apps
Data Model
vtex.ads-agent
Version: 2.0.0
Latest version: 2.0.0

This app does not persist data. It reads inputs from the browser environment and emits beacon requests. Entities below describe the shape of data in flight.

App Settings (manifest.jsonsettingsSchema)

FieldTypeSourceRequired
publisherIdstring (UUID)VTEX Admin app settingsyes

Browser inputs

SourceFieldPurpose
document.location.searchnaidAd ID — required; absence aborts tracking
document.location.searchncidCampaign ID — optional
document.location.searchgadv_idGoogle Ads click ID — optional
Cookie VtexRCMacIdv7valueAnonymous user identifier (user_id)
window.vtex.session (pixel event)idSession ID
crypto.randomUUID()Generates event_id and request_id per beacon

Beacon payload (query string sent to Newtail)

ParamOrigin
publisher_idApp setting
ad_idURL naid
campaign_idURL ncid (omitted if missing)
ad_typeConstant banner
pname, contextConstant offsite
campaign_typeConstant off_site
event_id, request_idGenerated per request
user_idCookie MAC ID
ads_sourcing_componentsAppended PIXEL_VTEX_ADS_AGENT

Relationships


_10
VTEX Admin (publisherId)
_10
_10
_10
manifest.json settings ──► pixel/head.html (runs on every page)
_10
_10
├── reads URL params (naid, ncid, gadv_id)
_10
├── reads VtexRCMacIdv7 cookie
_10
└── POSTs beacon → events.newtail-media.newtail.com.br

See also
Vtex.ads Agent
VTEX IO Apps
VTEX App Store
VTEX IO Apps
Was this helpful?