MACROS

A MACRO is a command that the ad server replaces at the moment of processing the request and generating the final code in the client’s browser. In this way, it makes it easier to automatically insert values in parameters such as random numbers, ads’ identifiers, counting URLs, among others. Macros can be used in the following scenarios:

• Ads from Creative Templates
• Third Party Tag Codes
• HTML Ads
• Text Ads
• Dynamic Ads (DCO)
• Impression counting URLs
• Click counting URLs
• Landing URLs
• FlashVars

These are the current available Macros:

$ccid 

System ID; it identifies a <campaign - ad - space> relationship. Each time a campaign’s ad is associated to a space, e-planning assigns a new CCID for that combination. It is used for conversion tracking when the advertiser already has a tracking system in place. A list of campaign IDs can be seen by going to a campaign and clicking on the IDs link.

$nccid 

User ID; it defines a <campaign - space - ad> combination. It has the same use as $ccid. It can be set by clicking on the IDs link of a campaign, and then on Edit. 

$random

Twelve number character random figure generated by e-planning. It can be used to avoid caches.

$country

User’s country two-letter ISO 3166-1 code. For instance: if the user who clicked on the ad is connected from France, the value will be FR. 

$network

Name of the user’s ISP or network of origin.

$space_id

System ID of the space where the click was registered. Please, use e-planning’s API to get a list of spaces and their IDs.

$site_id

System ID of the site where the click was registered. Use e-planning’s API to get a list of sites and their IDs. 

$custom_site_id

User-set ID of the site where the click was registered.

$ptv

Passthru variable. The value must be set on the tag and it will be passed through to the landing URL, untouched. By adding a &ptv parameter to an e-planning tag, you can have a value passed over to the landing URL.

$ORDER_ID

Identifier of the order to which the ad where the click was recorded belongs.

$CAMPAIGN_ID

Identifier of the campaign to which the ad where the click was recorded belongs.

$AD_ID

Identifier of the ad where the click was registered.

$KW_xxx

Keyword values for Text, Option List, Integer/Decimal Numbers variables. The “xxx” must be replaced by the Keyword parameter name.

$KWT_xxx

Keyword values for “Data Table” variables of the following types: Text, Option List, Integer/Decimal Numbers. The “xxx” must be replaced by the Keyword parameter name.

$LINKURL

Counting and Click Redirect URL

$ENC_LINKURL

Encoded Counting and Click Redirect URL

$REDIRURL

Click Redirect URL

$CLICKTRACKURL

Click Counting URL

$ENC_CLICKTRACKURL

Encoded Click Counting URL

$IMPTRACKURL

Impression Counting URL

$ENC_IMPTRACKURL

Encoded Impression Counting URL

$click_id

Personalized ID for user+click

$uid

User unique identifier, if cookies are allowed, if not 0

$URL_CONTEO_TAG

Counting URL sent in the tag (3pit)

$document_url

Referrer URL

$enc_document_url

Encoded referrer URL

 

Available Macros for clickthrough URL:

$ccid
$nccid
$random
$country
$network
$space_id
$site_id
$custom_site_id
$order_id
$ad_id
$ptv
$campaign_id
$kw_xxx
$kwt_xxx
$enc_kw_xxx
$enc_kwt_xxx
$click_id
$uid
$document_url
$enc_document_url

 

Available Macros for third party tags or HTML banner using AjaxV4:

$SPACE_ID
$AD_ID
$CAMPAIGN_ID
$SITE_ID
$RANDOM
$KW_
$KWT_
$ENC_KW_
$ENC_KWT
$ENC_LINKURL
$LINKURL
$IMPTRACKURL
$ENC_IMPTRACKURL
$URL_CONTEO_TAG
$DOCUMENT_URL
$ENC_DOCUMENT_URL

 

Available Macros for third party tags or HTML banner using JavascriptV3:

$CLIENT_IP: It is replaced by the users IP.

 

 

DCO Macros:

$PBRAND (DCO)

DCO e-commerce store brand

$LC_PBRAND (DCO)

Name of the DCO e-commerce store brand, rewritten in lower case and without spaces.

$PNAME (DCO)

Name of the DCO e-commerce store Product

$LC_PNAME (DCO)

Name of the DCO e-commerce store Product, rewritten in lower case and without spaces.

$PCATEGORY (DCO)

Name of Category to which the product is directly associated in the DCO e-commerce store.

$LC_PCATEGORY (DCO)

Name of the Category to which the product is directly associated in the DCO e-commerce store, rewritten in lower case and without spaces.

$PCATx (DCO)

Name of the “x” level Category to which the product belongs to in the DCO e-commerce store. The “x” must be replaced by an integer that indicates the selected category level (e.g.: “2” for the 2nd level category).

$LC_PCATx (DCO)

Name of the “x” level Category to which the product belongs to in the DCO e-commerce store, expressed in lower case and without spaces. The “x” must be replaced by an integer that indicates the selected category level (e.g.: “2” for the 2nd level category).

 

To insert a MACRO, include the term that identifies the MACRO inside the selected variable. For instance:

Javascript Tag

<script type='text/javascript'><!--
google_ad_client = 'ca-pub-3204866889900107';
/* Mobile 320x50 */
google_ad_slot = '6142527672';
google_ad_country = $COUNTRY;

 

IMPRESSION COUNTING URL

http://ad.doubleclick.net/ad/N5926.189900.space/B7323552.5;sz=1x1;ord=$random?

LANDING URL

Httl://www.mylandingpage.com?brand=$PBRAND&product=$PNAME&category=$PCATEGORY