Epom's Macros

Macros are predefined expressions that are used to track specific information whenever a conversion takes place. Macros can be inserted in the banner's URL or HTML Code fields.

For example, an advertiser would like to know at which particular web site a conversion took place. To accomplish this, the $$REFERER_ESC$$ macro should be added to the banner URL as a parameter. As a result, the Banner URL will be:

where:

https://epom.com/banner - is the Banner URL.
referer=$$REFERER_ESC$$ - is a parameter containing the macro.

When any given user clicks the banner, the $$REFERER_ESC$$ macro will grab the URL of the page where the ad is served and forward that information to the Advertiser as a &referer parameter:

Bellow is a list of all dynamic macros available in Epom Ad Server

Macro Name	Description
$$CLICK_REDIRECT_URL$$	This macro is used for Third Party Ad Server Click Tracking and will return the redirect URL. This macro can not be used as an URL parameter. Please use the encoded macros instead ($$CLICK_REDIRECT_URL_ESC$$ or $$CLICK_REDIRECT_URL_2_ESC$$).
$$CLICK_REDIRECT_URL_ESC$$	Same as the CLICK_REDIRECT_URL macro, but will return the encoded click redirect URL.
$$CLICK_REDIRECT_URL_2_ESC$$	Returns the twice encoded click redirect URL.
$$CLICK_REDIRECT_URL_DFC$$	Same as the $$CLICK_REDIRECT_URL$$ macro. The key difference is that this macro ignores Epom Validation mechanism.
$$CLICK_REDIRECT_URL_DFC_ESC$$	Returns the encoded click redirect URL that ignores Epom's Validation mechanism.
$$CLICK_URL$$	Returns the click pixel. This macro can not be used as an URL parameter. Please use the encoded macro instead ($$CLICK_URL_ESC$$).
$$CLICK_URL_ESC$$	Returns encoded click pixel.
$$REFERER$$	Returns the URL of the page where the ad was served (i.e., http://foo.bar/page). Can not be used in URL strings; Encoded version ($$REFERER_ESC$$) should be used instead.
$$REFERER_ESC$$	Returns the encoded URL of the page where the ad was served. (http%3A%2F%2Ffoo.bar%2Fpage).
$$REFERER_DOMAIN$$	Returns the domain name where the ad was served. (foo.bar/page).
$$REMOTE_IP$$	Returns client's IP address.
$$REMOTE_IP_ESC$$	Returns encoded client's IP address.
$$REMOTE_PROTOCOL$$	Returns protocol: HTTP, HTTP(S), etc.
$$REMOTE_LANGUAGE$$	Language of the client's browser (i.e.: en).
$$REMOTE_LANGUAGE_ESC$$	Encoded client's browser language.
$$REMOTE_COUNTRY$$	Client's country code (US, UK).
$$REMOTE_COUNTRY_ESC$$	Encoded client's country.
$$REMOTE_COUNTRY_NAME$$	Full country name.
$$REMOTE_CITY$$	City name.
$$REMOTE_CITY_ESC$$	Encoded city name.
$$REMOTE_REGION$$	Region name.
$$REMOTE_REGION_ESC$$	Encoded region name.
$$CLIENT_USER_AGENT$$	Returns User Agent information.
$$CLIENT_USER_AGENT_ESC$$	Returns encoded User Agent information.
$$RANDOM$$	Returns a random numeric string.
$$SUB_ID(action name here)$$	Used for the SUB_ID method of server-to-server action tracking.
$$ACTION_DATA$$	Used for ACTION_DATA method of server-to-server action tracking.
$$TIMESTAMP$$	Returns the current timestamp in milliseconds.
$$EPOM_UUID$$	Unique user ID in Epom system.
$$EPOM_UUID_ESC$$	Encoded user ID in Epom system.
$$PLACEMENT_ID$$	Placement ID.
$$PLACEMENT_NAME$$	Placement name.
$$PLACEMENT_NAME_ESC$$	Encoded placement name.
$$PLACEMENT_KEY$$	Placement key.
$$ZONE_ID$$	Zone ID.
$$ZONE_NAME$$	Zone name.
$$ZONE_NAME_ESC$$	Encoded zone name.
$$PUBLISHER_ID$$	Site ID.
$$PUBLISHER_NAME$$	Publisher name.
$$PUBLISHER_NAME_ESC$$	Encoded publisher name.
$$ADVERTISER$$	Advertiser name.
$$ADVERTISER_ESC$$	Encoded advertiser name.
$$ADVERTISER_ID$$	Advertiser ID.
$$CAMPAIGN$$	Campaign name.
$$CAMPAIGN_ESC$$	Encoded campaign name.
$$CAMPAIGN_ID$$	Campaign ID.
$$BANNER_NAME$$	Banner name.
$$BANNER_NAME_ESC$$	Encoded banner name.
$$BANNER_ID$$	Banner ID.
$$WIDTH$$	Banner width.
$$HEIGHT$$	Banner height.
$$DEVICE_AAID$$	Returns Android advertising ID; used for Application placements.
$$DEVICE_AAID_MD5$$	Returns Android advertising ID in MD5 hash format.
$$DEVICE_AAID_SHA1$$	Returns Android advertising ID in SHA-1 hash format.
$$DEVICE_APPLE_IDA$$	Returns Apple advertising ID; used for Application placements.
$$DEVICE_APPLE_IDA_MD5$$	Returns Apple advertising ID in MD5 hash format.
$$DEVICE_APPLE_IDA_SHA1$$	Returns Apple advertising ID in SHA-1 hash format.
$$WIN_PHONE_DEVICE_ID$$	Windows phone device ID.
$$WIN_PHONE_DEVICE_ID_MD5$$	Windows phone device ID in MD5 hash format.
$$WIN_PHONE_DEVICE_ID_SHA1$$	Windows phone device ID in SHA-1 hash format.
$$BB_DEVICE_ID_PARAM$$	BlackBerry device ID.
$$BB_DEVICE_ID_MD5$$	BlackBerry device ID in MD5 hash format.
$$BB_DEVICE_ID_SHA1$$	BlackBerry device ID in SHA-1 hash format.
$$GOOGLE_AD_ID$$	ID of the Google ad.
$$HTTP_ACCEPT_LANGUAGE$$	Accept-Language header.
$$HTTP_ACCEPT_HEADER$$	Accept header.
$$COOKIE(b$$BANNER_ID$$)$$	Returns the cookie value.
$$ENCR_TIMESTAMP(xxxxx)$$	Encrypted timestamp.
$$DECR_TIMESTAMP(xxxxx)$$	Decrypted timestamp.
$$LAT$$	Latitude.
$$LONG$$	Longitude.
$$CHANNEL$$	Returns channel value.
$$CHANNEL_ESC$$	Encoded channel value.
$$IMPRESSION_IMG_URL$$	Tracks impressions per templates.
$$IMPRESSION_TAG_JS$$	Defines if the impression is added depending on the banner behaviour. Most commonly used for "Popunder" ad type of Non-standard placement.
$$IMPRESSION_REDIRECT_URL$$	Redirect URL.
$$CUSTOM_PARAM(paramName)$$	Is used to pass custom parameters which are specified in the Invocation code.
$$CUSTOM_PARAM_ESC(paramName)$$	Is used to pass encoded custom parameters which are specified in the Invocation code.
$$OS_NAME$$	Operating system.
$$OS_VERSION$$	Operating system version.
$$MOBILE_CARRIER$$	Mobile carrier.
$$DEVICE_VENDOR$$	Device vendor.
$$BROWSER$$	Browser name.
$$GROSS$$	Gross.
$$NET$$	Net.
$$ADVERTISER_DESCRIPTION$$	Returns descrtiption of Advertiser.
$$ADVERTISER_DESCRIPTION_ESC$$	Returns encoded descrtiption of Advertiser.
$$SERVE_DOMAIN$$	Returns ad serving domain.
$$GROSS_PRICING_TYPE$$	Returns Pricing Type set on Advertiser side.
$$NET_PRICING_TYPE$$	Returns Pricing Type set on Publisher side.
$$SITE_DESCRIPTION$$	Returns descrtiption of Publisher.
$$SITE_DESCRIPTION_ESC$$	Returns encoded descrtiption of Publisher.
$$TRANSACTION_ID$$	Returns transaction ID.
$$COUNTRY$$	Returns user's country.
$$INVOCATION_PREFIX$$	Returns invocation code prefix value.
$$DEVICE_MARKET_NAME$$	Returns device name from User Agent.
$$EPOM_APP_IDENTITY$$	Returns Epom network ID.