DOCUMENTATION
« Documentation home

Dynamic Ad Pixel

Introduction

The Dynamic Ads Pixel is used to create new Audience members and assign attributes to Audience members within a campaign.

The base URL for the Dynamic Ads Pixel is https://dynamic.cannedbanners.com/pixel/. The pixel serves as a 1x1 transparent GIF and sets a cookie on the viewer's browser. Below is code for a sample pixel.

<img src="https://dynamic.cannedbanners.com/pixel/?campaignId=00000&clientId=00000&segIds=12345" width="1" height="1" />

Clearing a cookie

Any viewer may clear their cookie by visiting dynamic.cannedbanners.com/pixel/clearCookie. Note that visiting this URL will clear your cookie, and this cannot be undone, so proceed with caution!

Viewing or accessing a Canned Banners Cookie ID

A viewer's Cookie ID may be accessed via two simple endpoints, either as a string or as a Javascript function.

The endpoint dynamic.cannedbanners.com/pixel/getCookieId will return the viewer's Cookie ID as a string:

56c255a9677b288c211b96785f

Or a zero (0) if no Cookie ID is found:

0

The endpoint dynamic.cannedbanners.com/tag/getCookieId will return a Javascript function getCBDynamicId() that outputs the viewer's Cookie ID:

// Function returns Canned Banners Cookie ID for this browser
function getCBDynamicId() {
   return "56c255a9677b288c211b96785f";
}

If the viewer does not have a Canned Banners Cookie ID, the endpoint returns the same Javascript function set to return a boolean FALSE value.

// Browser does not have cookie 'cannedbanners_dynamic'
function getCBDynamicId() {
   return false;
}

Viewer attribute fields

Use the following parameters as URL query strings to add or update website visitor attributes stored in your Canned Banners Audience.

Note that any values passed into the pixel URL must be URL-escaped.

Attribute Description
campaignId The Data Source ID to associate the visitor with. Typically, a given advertiser website will have a single Data Source ID, so this value should stay static.

This is a required parameter. If not supplied, the pixel load will have no effect and no visitor attributes will be saved.

Example
campaignId=1234567
clientId The Client ID of the owner of the Data Source ID. This is a required parameter.

Example
clientId=2468
segIds A comma-separated list of Segment IDs to add to the visitor's Profile. A Profile may store up to 10 Segment IDs. Segment IDs are updated on a FIFO (first in, first out) basis, so adding an eleventh Segment ID will cause the first (oldest) Segment ID to be deleted from the visitor's Profile.

Example
segIds=product1,product2
tSeg Sets or updates a visitor's Group.

Example
tSeg=checkout_page

To clear a visitor's Group, set the tSeg parameter to empty:

tSeg=
subEnt Sets or updates a visitor's Sub-entity. The subEnt parameter functions identically to the tSeg parameter.

Example
subEnt=jims_ford_dealership
intCode Sets or updates a visitor's Integration Code.

Example
intCode=taqahaDuJ3VepAChubapAste3es6ubRu
superSeg1 through superSeg5 Sets one or more of the five available Super Segment fields. Super Segments are useful when tagging visitors with more generalized interests or behaviors instead of specific identifiers such as product SKUs.

For example, a car shopping website might want to organize their Super Segments according to general vehicle attributes, where Super Segment 1 is Year, Super Segment 2 is Make, Super Segment 3 is Model, and Super Segment 4 is Color.

So when Visitor 1 searches for Red 2005 Chevy Corvettes, the Canned Banners pixel is loaded with the following four attributes attached:

superSeg1=2009&superSeg2=Chevrolet&superSeg3=Corvette&superSeg4=red

And when Visitor 2 searches for Blue MINIs, the Canned Banners pixel is loaded with the following two attributes attached:

superSeg2=MINI&superSeg4=blue

Up to five sets of Super Segments are stored. Like Segment IDs, Super Segments are updated on a FIFO basis.
h Provides a Haystack value for string-matching against keywords ("Needles") set in the Data Source. When a matching Segment ID is found, it is added to the Audience member's Profile.

For example, a travel publisher would like to promote offers related to travel articles the viewer has read. Each travel offer is tagged with a keyword. An offer for Cabo San Lucas vacations starting at $799 might have the keyword "cabo." So when the viewer views an article at travelsite.com/10-things-to-do-in-cabo-san-lucas, the Canned Banners Dynamic Ads pixel gets loaded with the page URL set as the h attribute:

h=http%3A%2F%2Ftravelsite.com%2F10-things-to-do-in-cabo-san-lucas

The Canned Banners platform will find the match between the URL and the keyword 'cabo' and attach the corresponding Segment ID to the visitor's Profile.
custom1 through custom3 Sets one or more of the three available Custom Value fields. These fields are not available for lookups (i.e., you cannot search an Audience for Profiles where Custom Value 1 is "mickey mouse"). The Custom Values are captured in click tracking and may be accessed via Creative Macro when an Audience member gets served a Dynamic Ad creative.

Example
custom1=foo&custom2=bar

To clear a Custom Value field, set the parameter to empty:

custom1=
doNotTrackGlobal When set to 'true,' the viewer's browser will be disallowed ("opted out") from having a Canned Banners Audience Profile and the viewer will no longer see personalized Dynamic Ads. A setting of 'false' opts the viewer's browser back in.

Example
doNotTrackGlobal=true

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

CONTACT US