Revive AdServer (Formerly OpenX Source) Magic Macros

Magic Macros are your typical macro commands that you can place inside the HTML banner or the banner destination URL for an ad to insert various attributes into the generated ad code.

HTML Content Macros

Magic Macro	Description
{clickurl}	Substituted by the Revive AdServer (Formerly OpenX Source) click tracking URL for the delivered ad example: http://…/delivery/ck.php?oaparams=2__bannerid=…
{timestamp}	Substituted by a decimal string based on the current timestamp example: 1185290310.72
{random}	Substituted by a 10 character alpha-numeric random string value example: b616f31e72
{logurl}*	Substituted by an Revive AdServer (Formerly OpenX Source) impression logging URL example: http://…/delivery/lg.php?bannerid=…
{logurl_enc}*	Substituted by url-encoded  Revive AdServer (Formerly OpenX Source) impression logging URL example: http%3A%2F%2F…%2Fdelivery%2Flg.php%3Fbannerid%3D…
{target}	Substituted by the target value for the selected banner example: _blank
{url_prefix}	Substituted by the base delivery URI of the Revive AdServer (Formerly OpenX Source) example: http://ads.example.com/www/delivery
{bannerid}	Substituted by the ID of the selected banner example: 123
{zoneid}	Substituted by the ID of the selected zone example: 456
{source}	Substituted by the value of “source=” as passed into the ad-request from the site tags example: source=cat123/cat456…
{pageurl}	Substituted by the URL of the page the ad was requested on (url encoded) example: http%3A%2F%2Flocalhost%2Fmagic_macros%2Ftest.html
{referer}	Substituted by the referrer of the page the ad was requested on (url encoded) example: http%3A%2F%2Flocalhost%2Fmagic_macros%2F
{width}	Substituted by the width (in pixels) of the selected ad example: 468
{height}	Substituted by the height (in pixels) of the selected ad example: 60
{clickurlparams}	Substituted by the parameters which would be passed to the {clickurl} example: 2__bannerid=X__zoneid=Y__source=cat123/cat456__cb=0d9139d879__maxdest=
{ANY_INPUT_VARIABLE}	Substituted by any value present in the php $_REQUEST array ($_GET/$_POST/$_COOKIE) example: {OAID} -> $_COOKIE[‘OAID’] = 1fd819ffc7267757ba681ff5daa3007e

If any of the magic macros are present in the HTML, but the value cannot be found, then the replaced value depends on the type of macro:

• For core macros ending in id – The value zero is used
• For other core macros – An empty string is used
• For “ANY_INPUT_VARIABLE” macros – The macro string is left unchanged in the HTML

* IMPORTANT: If either {logurl} or {logurl_enc} are detected in an HTML ad,  Revive AdServer (Formerly OpenX Source) will not log an impression, but will pass the logging URL on to a 3rd party and rely on them to call-back using the logurl provided.

URL Macros

The {clickurl} Macro

By inserting the {clickurl} macro into the banner HTML for an ad stored on a third party server,  Revive AdServer (Formerly OpenX Source) can track clicks on that ad.

 When the ad is clicked,  Revive AdServer (Formerly OpenX Source) substitutes the click tracking URL for the macro, for example: http://.../delivery/ck.php?oaparams=2__bannerid=.... The browser is redirected to this URL where  Revive AdServer (Formerly OpenX Source) counts the click and then forwards the browser to the ad URL.

{clickurlparams}

The {clickurlparams} are the parameters that are passed to the {clickurl} address for third party click tracking. These parameters are:

• bannerid
• zoneid
• source
• cb
• maxdest

{pageurl}

The URL of the page that requested the ad (url-encoded), for example: http%3A%2F%2Flocalhost%2Fmagic_macros%2Ftest.html

{logurl}

To track impressions for third party ads, use the {logurl} macro. When the ad is displayed,  Revive AdServer (Formerly OpenX Source) substitutes the impression logging URL for the macro, for example http://.../delivery/lg.php?bannerid=.... The browser is redirected to this URL where  Revive AdServer (Formerly OpenX Source) logs the impression and then forwards the browser to the ad. As with the {clickurl} macro,  Revive AdServer (Formerly OpenX Source) appends various parameters for the ad to the URL and passes these to the impression logging page.

{logurl_enc}

The {logurl_enc} macro is similar to the {logurl} macro but the substituted URL is url-encoded, for examplehttp%3A%2F%2F...%2Fdelivery%2Flg.php%3Fbannerid%3D....

{url_prefix}

The URL to the base of the  Revive AdServer (Formerly OpenX Source) delivery server, for example http://ads.example.com/www/delivery

Google+