**This is an old revision of the document!**

Supported macros

The following creative macros are supported in Atomx:

Macro Context URL safe Note
${APP_ID} Click URL, IFRAME URL, Javascript yes
${APP_BUNDLE} Click URL, IFRAME URL, Javascript Yes An App bundle, for example com.dailymotion.dailymotion for android. Or 312681409 for iOS.
${APP_NAME} Click URL, IFRAME URL, Javascript Yes URL encoded. For example Whisper%20Android
${APP_STOREURL} Click URL, IFRAME URL, Javascript Yes URL encoded. For example https%3A%2F%2Fplay.google.com%2Fstore%2Fapps%2Fdetails%3Fid%3Dsh.whisper
${APP_VERSION} Click URL, IFRAME URL, Javascript Yes URL encoded. For example android9.21.1 | | ${CACHE_BUSTER} | Click URL, IFRAME URL, Javascript | Yes | A random number. | | ${CAMPAIGN_ID} | Click URL, IFRAME URL, Javascript | Yes | | | ${CREATIVE_ID} | Click URL, IFRAME URL, Javascript | Yes | | | ${CLICK_URL} | IFRAME URL, Javascript | No | | | ${CLICK_URL_ENC} | IFRAME URL, Javascript | Yes | URL encoded. | | ${COUNTRY} | Click URL, IFRAME URL, Javascript | yes | ISO 3166-1 alpha-2 upper case country code. For example: US | | ${DOMAIN_ID} | Click URL, IFRAME URL, Javascript | Yes | For example: 123123 | | ${DOMAIN} | Click URL, IFRAME URL, Javascript | Yes | TLD + 1. For example: example.com | | ${HEIGHT} | Click URL, IFRAME URL, Javascript | Yes | Placement height. | | ${NETWORK_ID} | Click URL, IFRAME URL, Javascript | Yes | Publisher Network Id. | | ${PLACEMENT_ID} | Click URL, IFRAME URL, Javascript | Yes | | | ${PROTOCOL} | Click URL, IFRAME URL, Javascript | No | http: or https: | | ${PROTOCOL_ENC} | Click URL, IFRAME URL, Javascript | Yes | http%3A or https%3A | | ${PUBLISHER_ID} | Click URL, IFRAME URL, Javascript | Yes | | | ${REQUEST_ID} | Click URL, IFRAME URL, Javascript | Yes | Request id string. For example: 1Lr1-uMIQYFST_PyfZyKQw | | ${S2S_DATA} | Click URL, IFRAME URL, Javascript | Yes | URL encoded conversion context. | | ${SITE_ID} | Click URL, IFRAME URL, Javascript | Yes | | | ${WIDTH} | Click URL, IFRAME URL, Javascript | Yes | Placement width. | | ${COST} | Click URL, IFRAME URL, Javascript | Yes | CPM the campaign paid. For example: 0.01 | | ${PAGE_URL} | Click URL, IFRAME URL, Javascript | No | URL of the page where the impression will be shown. For example: http://example.com/somepage?foo=bar | | ${PAGE_URL_ENC} | Click URL, IFRAME URL, Javascript | Yes | URL of the page where the impression will be shown. For example: http%3A%2F%2Fexample.com%2Fsomepage%3Ffoo%3Dbar | | ${USER_AGENT} | Click URL, IFRAME URL, Javascript | No | User Agent string of the browser. For example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.12; rv:52.0) Gecko/20100101 Firefox/52.0 | | ${USER_AGENT_ENC} | Click URL, IFRAME URL, Javascript | Yes | URL encoded User Agent string of the browser. For example: Mozilla%2F5.0%20(Macintosh%3B%20Intel%20Mac%20OS%20X%2010.12%3B%20rv%3A52.0)%20Gecko%2F20100101%20Firefox%2F52.0 | | ${USER_ID} | Click URL, IFRAME URL, Javascript | Yes | User id string. For example: 1Lr1-uMIQYFSTPyfZyKQw
${USER_IP} Click URL, IFRAME URL, Javascript Yes User IP. For example 93.184.216.34
${GAID} IFRAME URL, Javascript Yes Google Advertising ID (Android - reference)
${IDFA} IFRAME URL, Javascript Yes Apple Identifier For Advertisers (iOS - reference)
${ADID} IFRAME URL, Javascript Yes GAID or IDFA, depending on device
${PARAM:name} Click URL, IFRAME URL, Javascript No Parameter passed in to the ad tag.
If the ad tag looks like: <iframe src="//s.ato.mx/p.html#id=1&amp;size=300x250&amp;foo=bar">
Then ${PARAM:foo} will be replaced with bar.
${PARAM_ENC:name} Click URL, IFRAME URL, Javascript Yes Parameter passed in to the ad tag.
If the ad tag looks like: <iframe src="//s.ato.mx/p.html#id=1&amp;size=300x250&amp;foo=bar">
Then ${PARAM:foo} will be replaced with bar.
${IFA} Click URL, IFRAME URL, Javascript Yes From OpenRTB request.
${DIDSHA1} Click URL, IFRAME URL, Javascript Yes From OpenRTB request.
${DIDMD5} Click URL, IFRAME URL, Javascript Yes From OpenRTB request.
${DPIDSHA1} Click URL, IFRAME URL, Javascript Yes From OpenRTB request.
${DPIDMD5} Click URL, IFRAME URL, Javascript Yes From OpenRTB request.
${MACSHA1} Click URL, IFRAME URL, Javascript Yes From OpenRTB request.
${MACMD5} Click URL, IFRAME URL, Javascript Yes From OpenRTB request.