GVA configuration
Overview
This document describes the configuration options for the Generic VAST Adapter (GVA), including how parameters, functions, and mappings interact with the ad server to enable proper ad delivery.
Template and ad source parameters
| Section | Description |
|---|---|
mappings |
The mapping of static values to parameters required by the ad server. |
functions |
The functions that might need to be executed if required by the ad server, for example, unwrap.user-agent. |
wrapperMappings |
The mapping of dynamic or static parameters and values from the client or SSAI to the ad server, specifically for VAST wrapper sub-levels. |
ignoreAdBuffet |
The ad buffet (or fallback ads) that can be enabled or disabled. When enabled, all fallback ads will be used (roadmap feature). |
conditions |
The conditions that can be added to the template to select or ignore one or more media files for the same ad, for example, aspect ratio, resolution, media type, or bitrate. |
whitelist |
The list of all dynamically passed parameters from the client. If not included in the whitelist, parameters won't be passed to the ad server. |
ad server url |
The host URL used to request the ad server. |
Example for Equativ
{
"mappings": [
{
"value": "{{ip}}",
"mapsTo": "x-forwarded-for",
"position": "header"
},
{
"value": "{{{user-agent}}}",
"mapsTo": "user-agent",
"position": "header"
},
{
"value": "$SITEID",
"mapsTo": "siteid",
"position": "query"
},
{
"value": "$PAGEID",
"mapsTo": "pgid",
"position": "query"
},
{
"value": "$FMTID",
"mapsTo": "fmtid",
"position": "query"
},
{
"value": "1",
"mapsTo": "oc",
"position": "query"
},
{
"value": "s",
"mapsTo": "vcn",
"position": "query"
},
{
"value": "S",
"mapsTo": "visit",
"position": "query"
},
{
"value": "{{tmstp}}",
"mapsTo": "tmstp",
"position": "query"
},
{
"value": "vast4.2",
"mapsTo": "out",
"position": "query"
},
{
"value": "0",
"mapsTo": "vpaidt",
"position": "query"
},
{
"value": "0",
"mapsTo": "vpaidv",
"position": "query"
},
{
"value": "1",
"mapsTo": "ab",
"position": "query"
},
{
"value": "0",
"mapsTo": "ssar",
"position": "query"
},
{
"value": "{{maxCount}}",
"mapsTo": "ps",
"position": "query"
},
{
"value": "{{maxDuration}}",
"mapsTo": "mabd",
"position": "query"
},
{
"value": "0",
"mapsTo": "pb",
"position": "query"
},
{
"value": "{{gdpr}}",
"mapsTo": "gdpr",
"position": "query"
},
{
"value": "{{gdpr_consent}}",
"mapsTo": "gdpr_consent",
"position": "query"
},
{
"value": "{{us_privacy}}",
"mapsTo": "us_privacy",
"position": "query"
},
{
"value": "{{publisher domain}}",
"mapsTo": "pgdomain",
"position": "query"
},
{
"value": "1080",
"mapsTo": "vph",
"position": "query"
},
{
"value": "1920",
"mapsTo": "vpw",
"position": "query"
},
{
"value": "1",
"mapsTo": "vpt",
"position": "query"
},
{
"value": "3",
"mapsTo": "vpmt",
"position": "query"
},
{
"value": "{{schain}}",
"mapsTo": "schain",
"position": "query"
},
{
"value": "0",
"mapsTo": "skip",
"position": "query"
},
{
"value": "{{appname}}",
"mapsTo": "appname",
"position": "query"
},
{
"value": "{{bundleId}}",
"mapsTo": "buid",
"position": "query"
},
{
"value": "{{storeUrl}}",
"mapsTo": "srl",
"position": "query"
},
{
"value": "{{user_id}}",
"mapsTo": "uid",
"position": "query"
},
{
"value": "{{iabframeworks}}",
"mapsTo": "iabframeworks",
"position": "query"
},
{
"value": "{{omidpn}}",
"mapsTo": "omidpn",
"position": "query"
},
{
"value": "{{omidpv}}",
"mapsTo": "omidpv",
"position": "query"
},
{
"value": "{{vdmin}}",
"mapsTo": "vdmin",
"position": "query"
},
{
"value": "{{vdmax}}",
"mapsTo": "vdmax",
"position": "query"
},
{
"value": "{{vdmax}}",
"mapsTo": "vdmax",
"position": "query"
},
{
"value": "{{tgt}}",
"mapsTo": "tgt",
"position": "query"
},
{
"value": "{{ctid}}",
"mapsTo": "ctid",
"position": "query"
},
{
"value": "{{ctn}}",
"mapsTo": "ctn",
"position": "query"
},
{
"value": "{{content_type}}",
"mapsTo": "ctt",
"position": "query"
},
{
"value": "{{content_category}}",
"mapsTo": "ctc",
"position": "query"
},
{
"value": "{{content_duration}}",
"mapsTo": "ctd",
"position": "query"
},
{
"value": "{{cts}}",
"mapsTo": "cts",
"position": "query"
},
{
"value": "{{cte}}",
"mapsTo": "cte",
"position": "query"
},
{
"value": "{{ctr}}",
"mapsTo": "ctr",
"position": "query"
},
{
"value": "{{ctpid}}",
"mapsTo": "ctpid",
"position": "query"
}
],
"functions": {},
"whitelist": [
"ip",
"user-agent",
"maxDuration",
"maxCount",
"tmstp",
"gdpr",
"gdpr_consent",
"us_privacy",
"publisher domain",
"appName",
"bundleId",
"storeUrl",
"user_id",
"iabframeworks",
"omidpn",
"omidpv",
"vdmin",
"vdmax",
"tgt",
"ctid",
"ctn",
"ctt",
"ctc",
"ctd",
"cts",
"cte",
"ctr",
"ctpid"
],
"url": "https://videoapi.smartadserver.com/ac"
}