Page tree
TypeDemand Tag MacrosSupply tag query parameterDescriptionExample valuesNotes
Player{{AD_POSITION}}ad_pos=position of adPlayer macros are all pass through macros, meaning that they are declared in the supply tag and not stored.
Mobile{{APP_BUNDLE}}app_bundle=app bundle591560124, com.pic.photoeditor
Mobile{{APP_NAME}}app_name=app namephotoeditor
Mobile{{APP_STORE_URL}}app_store_urlapp store URLhttps://play.google.com/store/apps/details?id=com.pic.photoeditor&hl=en_USAvailable as of 5/14/2018
{{AUCTION_ID}}
Player{{AUTOPLAY}}ap=1 if player set to autoplay, 0 if not0 or 1Player macros are all pass through macros, meaning that they are declared in the supply tag and not stored.
Event{{BID_PRICE}}header bidding bid price10.5Only for use on impression pixels
General{{CACHEBUSTER}}cb=random number to prevent caching0.037084893
GDPR{{CONSENT}}consentA consent string passed from various Consent Management Platforms (CMP's)TBDMandatory for all European traffic for GDPR
Media{{CONTENT_ID}}cid=content id
Other{{COUNTRY}}countryCanada
Other{{DEMAND_TAG_ID}}demand tag id65432
Player{{DESCRIPTION}}desc=video descriptionPlayer macros are all pass through macros, meaning that they are declared in the supply tag and not stored.
Detected{{DETECTED_DOMAIN}}domain as detected by SpringServe
Detected{{DETECTED_DOUBLE_ENCODED_URL}}double encoded url as detected by SpringServe
Detected{{DETECTED_ENCODED_URL}}encoded url as detected by SpringServe
Detected{{DETECTED_HEIGHT}}height as detected by SpringServe
Detected{{DETECTED_URL}}url as detected by SpringServe
Detected{{DETECTED_WIDTH}}width as detected by SpringServe
Mobile/CTV{{DEVICE_ID}}did=user device id for all device types437825ef-a4a6-4575-8b70-81630c6d76e5
General{{DEVICE_MAKE}}device_make=A device MakeSamsung, Apple
General{{DEVICE_MODEL}}device_model=A devices ModelGalaxy, F8332
General{{DNT}}dnt=do not track0 or 1dnt 1 = true and is essentially an opt out of advertisements
General{{DOMAIN}}url=domain of the webpage the player is onweather.com
General{{DOUBLE_ENCODED_URL}}url=double encoded page urlhttp%253A%252F%252Fwww.weather.com%252Fweather%252Fradar %252Finteractive%252Fl%252F1037891%253A5%253AUS
Player{{DURATION}}dur=video duration length in seconds15Player macros are all pass through macros, meaning that they are declared in the supply tag and not stored.
General{{ENCODED_URL}}url=encoded page urlhttp%3A%2F%2Fwww.weather.com%2Fweather%2Fradar %2Finteractive%2Fl%2F1037891%3A5%3AUS
Media{{ENCODED_VIDEO_TITLE}}vt=encoded video title
GDPR{{GDPR}}gdprA flag for European Union traffic consenting to advertising1,0Mandatory for all European traffic for GDPR
General{{HEIGHT}}h=player height250
Player{{IAB_CATEGORY}}ic=IAB Category ID of site contentIAB19Player macros are all pass through macros, meaning that they are declared in the supply tag and not stored.
Mobile{{IP}}ip=user ip address52.52.52.52
Visibility{{IS_VISIBLE}}is visible1 (visible), 0 (not visible), -1 (unknown)for use with TbV tags. Detects visibility in real-time.
Media{{KEYWORDS}}kwds=keywords
Mobile{{LAT}}lat=user latitude33.543682
Mobile{{LON}}lon=user longitude-86.779633
Player{{MAXIMUM_DURATION}}max_dur=maximum durationPlayer macros are all pass through macros, meaning that they are declared in the supply tag and not stored.
Media{{MEDIA_ID}}mid=media id
Player{{MINIMUM_DURATION}}min_dur=minimum durationPlayer macros are all pass through macros, meaning that they are declared in the supply tag and not stored.
Visibility{{MOAT_VIEW_BINARY}}moat viewability1 (visible), 0 (not visible), -1 (unknown)for use with TbV tags. Based on historical Moat data.
Player{{MUTE}}mute=mute or volumeSizes will be unknown if not implemented on SpotX tags Player macros are all pass through macros, meaning that they are declared in the supply tag and not stored.
Other{{PAY_ID}}payid=payment id chainXYZ01234:ABCD56789Pass through macro. In OpenRTB bid requests, SpringServe will construct a payment chain which will also include this value if passed in the payid= param.
CTV{{pod_ad_slots}}pod_ad_slots=A range from Min - max for each ad slot. Could be an array supporting up to 10 ranges in ocmma delimited format.15-45,10-30,8-30,10-45 <—This shows 4 ad slots and their ranges
CTV{{pod_max_dur}}pod_max_dur=Maximum duration of an ad pod120seconds
Player{{SIZE}}size=size of player, for use for SpotX onlySSize is parsed into dimensions that are passed to Demand Tags.
{{SS_USER_ID}}
Other{{SUB_ID}}sid=sub id
Other{{SUPPLY_TAG_ID}}supply_tag_id12345
General{{URL}}url=page urlhttp://www.weather.com/weather/radar/interactive/l/1037891:5:USThis passes the full page url on the demand tag.
General{{USER_AGENT}}ua=user agent stringMozilla/5.0 (iPhone; CPU iPhone OS 6_0 like Mac OS X) AppleWebKit/536.26 (KHTML, like Gecko) Version/6.0 Mobile/10A5376e Safari/8536.25
General{{UUID}}uuid=unique user id5c7fe17b-06c0-49f9-b20b-59164e4bed4a
Media{{VIDEO_ID}}vid=video id
Media{{VIDEO_URL}}v_urlencoded video url
General{{WIDTH}}w=player width300
Other{{ZONE_ID}}zid=zone id