Macros

Ad Server

Macros for Ad Serving

AdGlare comes with some built-in macros that you can use in Third Party tags or Landing URLs. These macros are commonly known for its usage in cache-busting. They can also be used to pass on the page URL on which the ad is shown, as well as ad server variables like the zone ID, campaign ID, creative ID, etc.

Built-In Macros

VariableDescriptionExample
{ts}The Unix timestamp.
1506041149
{rnd}Random 10 character alpha-numeric string.
Y2SYRS8S9N
{zID}The Zone ID.
1234567890
{cID}The Campaign ID.
1234567890
{crID}The Creative ID.
1234567890
{ip}IPv4 address of the visitor.
54.92.158.65
{width}Width of the creative.
468
{height}Height of the creative.
60
{device}The visitor's device type.
pc | mobile
{referer}The URL on which the campaign is displayed.
http://domain.com/abc
{referer_esc}The escaped/encoded referer URL.
http%3A%2F%2Fdomain.com%2Fabc
{ua}The browser's user agent string.
Mozilla/5.0 (Linux; Andro...
{ua_esc}The escaped/encoded browser's user agent string.
Mozilla%2F5.0+%28Linux%3B+Andro...
{domain}The domain on which the campaign is displayed.
domain.com
{zone_name}The zone name (URL encoded).
my+zone+name
{campaign_name}The campaign name (URL encoded).
my+campaign+name
{creative_name}The creative name (URL encoded).
my+creative+name
{click_url}Tracks clicks and redirects to appending URL.
-
{click_url_esc}An escaped click URL macro.
-
{click_url_esc_esc}A double escaped click URL macro.
-
{geo_country}The country name of the visitor.
United States
{geo_country_iso2}ISO 3166-1 alpha-2 country code of the visitor.
US
{geo_country_iso3}ISO 3166-1 alpha-3 country code of the visitor.
USA
{geo_region}The region of the visitor. It can be a number.
VA
{geo_city}The city name of the visitor.
Ashburn
{geo_latitude}The latitude of the visitor.
39.0481
{geo_longitude}The longitude of the visitor.
-77.4728
{geo_dma_code}United States DMA. Empty otherwise.
511
{geo_continent_code}The visitor's 2-letter continent code.
NA


Create your own Macros

You can also create your own macros and pass on their values via the invocation code. The custom parameter is written as: {ag_custom_yourkey}. The invocation code should then be appended with this key/value pair: &ag_custom_yourkey=yourvalue.

Example: Custom Macro

Say, you're using a third party code that should be generated dynamically. You wish to pass on a key/value pair like color=red.
1
You write your creative's third party code as follows:
<script type="text/javascript"> (function() { var mycolor = '{ag_custom_color}'; alert(mycolor); })(); </script>
2
You then call your zone's invocation code as follows:
http://yourname.engine.adglare.net/?123456789&ag_custom_color=red

Share this article



Permalink