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.json → settingsSchema)
| Field | Type | Source | Required |
|---|---|---|---|
publisherId | string (UUID) | VTEX Admin app settings | yes |
Browser inputs
| Source | Field | Purpose |
|---|---|---|
document.location.search | naid | Ad ID — required; absence aborts tracking |
document.location.search | ncid | Campaign ID — optional |
document.location.search | gadv_id | Google Ads click ID — optional |
Cookie VtexRCMacIdv7 | value | Anonymous user identifier (user_id) |
window.vtex.session (pixel event) | id | Session ID |
crypto.randomUUID() | — | Generates event_id and request_id per beacon |
Beacon payload (query string sent to Newtail)
| Param | Origin |
|---|---|
publisher_id | App setting |
ad_id | URL naid |
campaign_id | URL ncid (omitted if missing) |
ad_type | Constant banner |
pname, context | Constant offsite |
campaign_type | Constant off_site |
event_id, request_id | Generated per request |
user_id | Cookie MAC ID |
ads_sourcing_components | Appended PIXEL_VTEX_ADS_AGENT |
Relationships
_10VTEX Admin (publisherId)_10 │_10 ▼_10manifest.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