DOCUMENTATION
« Documentation home

Dynamic Ad Creative Tags

Introduction

The following are instructions for constructing and configuring ad tags for Canned Banners Dynamic Ad units.

Ad tag IFRAME code

Below is a sample IFRAME ad tag.

<IFRAME SRC="https://dynamic.cannedbanners.com/creative/00/000000/html/300x250/?v=2&numItems=1&urlEncodeLp=1&click=${CLICK_URL_ENC}" WIDTH=300 HEIGHT=250 MARGINWIDTH=0 MARGINHEIGHT=0 HSPACE=0 VSPACE=0 FRAMEBORDER=0 SCROLLING=no BORDERCOLOR='#000000'>
</IFRAME>

The following attributes must be set for every ad tag, with the rest of the ad tag code staying static.

Setting Description
WIDTH The width of the creative in pixels. E.g., "300"
HEIGHT The height of the creative in pixels. E.g., "250"
SRC Your ad's URL at dynamic.cannedbanners.com, plus your configuration parameters (see below).

Ad tag configuration settings

Use the parameters below to set ad configuration options. Each parameter must be appended to your ad URL (see 'SRC' above) as a query string.

Note that all param values must be URL-safe. There's a handy URL encoder/decoder tool at meyerweb.com/eric/tools/dencoder.

Standard settings

Setting Description
v The codebase Version. Always set this to 2.

Example
v=2
numItems The number of Segments the creative should fetch. Use a number between 1 and 10. If not set, numItems will default to 1.

Example
numItems=5

Click URL settings

Setting Description
click Use the click parameter to add your DSP's click tracker macro. Always use a URL-escaped or double-URL-escaped DSP macro. Using an unescaped macro will cause your creative to serve incorrectly.

Example
click=${CLICK_URL_ESC}
lpApp Appends a value to the landing page of every click originating from the ad. This is usually used for appending web analytics tracking params to creatives.

Example
lpApp=%3Futm_source%3Dcanned_banners%26utm_medium%3Ddisplay
lpPre Prepends a value to the full URL (including the DSP click tracker URL) of every click originating from the ad. This setting is usually used for routing all ad clicks through a static click tracker.

Example
lpPre=https%3A%2F%2Fmy.click.tracker.url%3Fredirect%3D
urlEncodeLp When a landing page is appended after the DSP click tracker URL (see click setting above), this setting URL-encodes the final landing page. Can be set to 0 or 1. Make sure to test this setting with your DSP. If not set, urlEncodeLp will default to 0.

Example
urlEncodeLp=1

Segment selection settings

Setting Description
rel Sets the Super Segment field that the creative will use to fetch similar Segments. For example: a Viewer sees a 5-item ad. If the Viewer has a single Segment ID stored in their Audience Profile, then that specific Segment will be shown in the ad. If rel=1 is set, then the ad will attempt to fetch four additional Segments that match on the Super Segment 1 field.

Can be set to 1 through 5. If not set, then the ad will next fail over to a rank-based Segment selection methodology.

Example
re=1
tSeg Declares that Segments fetched by the creative must belong to the specified Tracking Group. For example, tSeg=onsale would instruct the creative to fetch only Segments within the 'onsale' Tracking Group.

Example
tSeg=onsale
tSegD The default Tracking Group for the creative. A default Tracking Group would be used in cases where a Tracking Group filter has already been applied, but no valid Segments were found and the ad needs a Tracking Group to fail over to.

Example
tSegD=fullprice
tSegViewer Limits the Segments fetched to those that match the Tracking Group stored in the Viewer's Audience Profile. Can be set to 0 or 1. If not set, tSegViewer will default to 0.

For example, if a Viewer has the Tracking Group 'onsale' saved in their Audience Profile, then setting tSegViewer=1 would cause that Viewer to only see Segments in the 'onsale' Tracking Group.

If tSegViewer is set to 1 and the ad fails to find any matching Segments, the creative's Default Tracking Group will then be applied.

Example
tSegViewer=1
subEnt Declares that Segments fetched by the creative must belong to the specified Sub-entity. For example, subEnt=location23 would instruct the creative to fetch only Segments within the 'location23' Sub-entity.

Example
subEnt=location23
h A Haystack string to search for Segments with matching Needles. For example, a Segment with the Needle 'cabo' would be fetched as a match the Haystack string 'http://vacation-website.com/cabo-san-lucas-getaways'.

The value for h would most commonly be the page URL where the ad is being served. This would allow the ad to fetch contextually relevant Segments using Needle/Haystack matching.

Example
h=http%3A%2F%2Fvacation-website.com%2Fcabo-san-lucas-getaways

Creative settings

Setting Description
shuf Randomly shuffles the order in which Segments get populated into the creative. Can be set to 0 or 1. If not set, shuf will default to 1.

Example
shuf=1
ri_1 through ri_10 Sets any desired Reserved Custom Values. These will get populated into the ad code via the $D{RI_1} through $D{RI_10} macros.

Example
ri_1=My%20custom%20value
ci_ * Sets any desired Custom Values.

Custom Values must be prefixed with 'ci_', followed by the name of the Value, with no empty spaces. Custom Values will get populated into the ad code via the matching $D{CI_ * macros. For example, an ad tag setting of ci_my_value_1=Hello%20world would cause any $D{CI_MY_CUSTOM_VALUE_1} creative macros to be replaced with 'Hello world'.

More than one Custom Value may be set.

Example
ci_my_value_1=Hello%20world

Viewer-related settings

Setting Description
useIntCode Tells the ad to look up a Viewer according to their Integration Code instead of their Canned Banners Cookie ID. Can be set to 0 or 1. If not set, useIntCode will default to 0.

Example
useIntCode=1
intCode Passes an Integration Code to the creative and declares that the ad should be personalized according to the Audience Profile for that Integration Code.

Normally, intCode would be populated dynamically, such as with the use of a DSP User ID macro.

Example
intCode=${DSP_USER_ID}
pros Sets the creative to prospecting-only, meaning that the creative will make no attempt to look up the Viewer's Audience Profile or personalize the ad based on any Profile. Can be set to 0 or 1.

This setting would be used in cases where the creative must use a specific Segment selection methodology regardless of who is viewing the ad.

If not set, pros will default to 0.

Example
pros=1

 

Contact us to learn more about the Canned Banners Dynamic Ads platform.

CONTACT US