Creating an advertisement widget for external websites using JavaScript

Posted on November 16, 2009 by Kevin Dubois

If you work with Google Analytics or Google Adsense, you've undoubtedly worked with the little code bits they ask you to include in your website. This tutorial will teach you how to create your own widget that people can include on their website by pasting a similar piece of javascript.

First off, you'll need to create a javascript file, accessible from 3rd party systems. Typically you won't have to do anything for this – just make sure you can access the file from any browser and host with the http protocol.

1) The simple and easy (but limited) solution

So let's go ahead and create mywidget1.js, and tell it to output the string 'Hello World'.

document.write("hello world!");

Now, we'll write the code bit that will be included on the 3rd party sites:

<script type="text/javascript" 
 src="https://www.kevindubois.com/demos/js/mywidget1.js"></script>

Simple, right? If that satisfieds your needs, all the better, but most people will want a little more functionality.

Either way, you can see a demo for this one at https://www.kevindubois.com/demos/widget1.html (the js code is at https://www.kevindubois.com/demos/js/mywidget1.js)

There are ways to pass variables and there are ways to handle secure servers, so if that's what you're interested in, please continue to read!

2) The more advanced (but still pretty easy) solution:

The files stay the same, only the code within will get a little more chunky. My sample will be based on the assumption that you're sending an advertisement widget to the 3rd party sites – but it really could be anything you want, just change the parameters in whatever you want.

Let's start with the 3rd party code this time. We'll write the javascript tags again, but this time we're not going to include the location to the js file in the tag but rather, we're going to tell the browser to write another javascript codebit from within the first javascript tag. This is necessary to pass some parameters to the js file; and to write some code around secure sites (or not) issues:

<script type="text/javascript">
 referral_code = "MQI74";
 ad_code = "aa";
 ad_width = "200"; // optional
 var myHost = (("https:" == document.location.protocol) 
  ? "https://www." : "http://www.");
 document.write(unescape("%3Cscript src='" + myHost +  
  "kevindubois.com/demos/js/mywidget2.js' type='text/javascript'%3E%3C/script%3E"));
</script>

referral_code, ad_code and ad_width are parameters that are being sent to the js file. myHost detects whether we're on a secure site or not, and will change the path to reflect that. Note that this will only work if you have a secure certificate on your end too. The reason why I included this, is because some browsers will return a warning on the 3rd party secure site if your js file is not secure, saying that some items on the site are not secure. The html tags are being escaped ( < = %3C and > = %3E ) and then unescaped, because otherwise the browser will interpret these tags incorrectly.

Let's go back to the js file and add some more code to handle the parameters and the security:

Start the js file by figuring out the security again:

var myHost = (("https:" == document.location.protocol) ? 
  "https://www." : "http://www.");

The parameters you passed are directly available, so you can start using them immediately. In my case, I added a switch statement to show different ads (sort of like google adsense, where you can show different ad sizes and types by changing the ad code). Make sure you escape opening and closing tags because you will get problems with the browser interpreting things incorrectly.

var ad_code = ad_code ? ad_code : '1a';
var referral_code = referral_code ? referral_code : '000';
var ad_width = ad_width ? ad_width : 200;

// switch code to see what we want to serve up
switch(ad_code){

   case '1a':
     document.write(unescape("%3Cdiv  
 style='width:"+ad_width+"px; font-family: verdana, arial, helvetica,  
 sans-serif; cursor:pointer; font-size:11px;'%3E"));
     document.write(unescape("%3Ca href='" + myHost + "kevindubois.com/index.php? 
 referral="+referral_code+"' style='text-decoration:none;color:white'%3E"));

     document.write(unescape("%3Cdiv style='border-top:5px solid #0F0442;  
 width:"+ad_width+"px; background-color:#FF6204; color:#FFF; padding-bottom:10px '%3E"));
     document.write(unescape("%3Cul%3E"));    
     document.write(unescape("%3Cli style='margin-left:-15px'%3EThis is a  
 demo for %3Ca href='https://www.kevindubois.com/2009/11/16/creating-advertisement-widgets-for-3rd-party-websites'%3E 
 https://www.kevindubois.com/2009/11/16/creating-advertisement-widgets-for-3rd-party-websites%3C/a%3E%3C/li%3E"));    
     document.write(unescape("%3Cli style='margin-left:-15px'%3bla bla bla%3C/li%3E"));    
     document.write(unescape("%3Cli style='margin-left:-15px'%3Ebla bla bla%3C/li%3E"));    
     document.write(unescape("%3Cli style='margin-left:-15px'%3Ebla bla bla%3C/li%3E"));    
     document.write(unescape("%3C/ul%3E  "));    
     document.write(unescape("%3Cdiv style='text-align:center;font-weight:bold; 
  font-size:12px; '%3E LEARN MORE %3C/div%3E"));    
     document.write(unescape("%3C/div%3E"));    
     document.write(unescape("%3C/a%3E"));    
     document.write(unescape("%3C/div%3E"));
   break;

   case '2a':
     document.write(unescape("%3Cdiv style='width:"+ad_width+"px; font-family: 
  verdana, arial, helvetica, sans-serif; cursor:pointer; font-size:11px;'%3E"));
     document.write(unescape("%3Ca href='" + myHost +  
 "kevindubois.com/index.php?referral="+referral_code+"' style='text-decoration:none;color:white'%3E"));

     document.write(unescape("%3Cdiv style='border-top:5px solid #0F0442;  
 width:"+ad_width+"px; background-color:#FF6204; color:#FFF; padding-bottom:10px '%3E"));
     document.write(unescape("%3Cul%3E"));    
     document.write(unescape("%3Cli style='margin-left:-15px'%3EThis is a demo for  
 %3Ca href='https://www.kevindubois.com/2009/11/16/creating-advertisement-widgets-for-3rd-party-websites'%3Ehttps://www.kevindubois.com/2009/11/16/creating-advertisement-widgets-for-3rd-party-websites%3C/a%3E%3C/li%3E"));    
     document.write(unescape("%3Cli style='margin-left:-15px'%3bla bla bla%3C/li%3E"));    
     document.write(unescape("%3Cli style='margin-left:-15px'%3Ebla bla bla%3C/li%3E"));    
     document.write(unescape("%3Cli style='margin-left:-15px'%3Ebla bla bla%3C/li%3E"));    
     document.write(unescape("%3C/ul%3E  "));    
     document.write(unescape("%3Cdiv style='text-align:center;font-weight:bold;  
 font-size:12px; '%3E LEARN MORE %3C/div%3E"));    
     document.write(unescape("%3C/div%3E"));    
     document.write(unescape("%3C/a%3E"));    
     document.write(unescape("%3C/div%3E"));
   break;

   // and so on ...
}

The only thing I haven't mentioned is the links and the referral code: you can track widgets and clicks from each 3rd party by supplying a referral code. The link within the widget has this referral code and in the linked page you can then write some code to track/count/whatever you want.
From here on, I think you should have all the tools to start customizing your own widget. You can make everything even more dynamic by using some ajax; you can add more parameters or really any content you want.

You can find a demo for the 2nd widget at https://www.kevindubois.com/demos/widget2.html (the js code is at https://www.kevindubois.com/demos/js/mywidget2.js)

Rotating images using jQuery Ajax

Posted on March 3, 2009 by Kevin Dubois

There are many ways to rotate images on a website. In my case, I needed a way to rotate all images from a particular folder, and I wanted it so that I just have to dump images in the folder in order for the slideshow to pick them up. ** NOTE: if you want a more advanced setup with database driven slides visit my post about database driven slideshows

For this tutorial I'm going to use jQuery's framework and crossSlide, a plugin for jQuery which will allow smooth transitions between the images. If you don't have it already, you can get jQuery at www.jquery.com and the crossSlide plugin at www.gruppo4.com/~tobia/cross-slide.shtml . You'll also have to create a folder with images. You'll get the best result if all images are identical in size.

A working example can be found at duboistechnologies.com .

Download the code here

Ok, first things first: we'll need a placeholder for the images. We'll need to specify a fixed height for this placeholder too, otherwise the content below will be jumping up and down every time a new image is loaded:

<div id="imgcontainer" style="margin:0; width:46em; height:20em;">
<img src="img/ajax-loader.gif" style="margin-top:20%" alt="loading…" id="mainImg" />
</div>

I put an image in the div that will show an icon while the images are loaded…

Next step is to create a php page with some code to get all images from the folder. The getfiles function will get all files and return a string that will be formatted so it can be parsed as separate objects by the javascript eval() function… but that's for later. We just echo this string so our ajax call will pick it up. The only thing you'll need to customize is the 'imagefolder'… change this to whatever the name or path is to your folder:

<?php

echo getfiles('imagefolder');

function getfiles($folder=", $extensions='.*')
{

// path:
$folder = trim($folder);
$folder = ($folder == ") ? './' : $folder;

// validate folder
if (!is_dir($folder)){ die('invalid folder given!'); }

// create files array
$files = array();

// open directory
if ($dir = @opendir($folder)){

// get all files:
while($file = readdir($dir)){

if (!preg_match('/^\.+$/', $file) and
preg_match('/\.('.$extensions.')$/', $file)){

// feed the array:
$files[] = $file;
}
}
// close directory
closedir($dir);
}
else {
die('Could not open the folder "'.$folder.'"');
}

if (count($files) == 0){
die('No files where found :-(');
}
// shuffle the array so we have a random sequence of images
shuffle($files);

$return = ";
foreach($files as $file){
// format the string so we can later parse it into objects in javascript
$return .= "{'src':'{$folder}/{$file}'},";
}
$return = "[".substr($return, 0,-1)."]";

// return the string:
return $return;

}

?>

What we need to do now is set up an ajax call that gets the string of images the above function found in my images folder. We'll also have to include the jquery and crossSlide packages:

<script type="text/javascript" src="js/jquery.js"></script>
<script type="text/javascript" src="js/jquery.cross-slide.js"></script>

<script type="text/javascript">
$(document).ready(function(){loadImage();})

function loadImage(){
// getimage.php is the php file that gets my images from the images folder
$.post("getimage.php", function(data){
if(data.length >0) {
// evaluate the string to a group of objects
myObject = eval(data);
// create a slideshow with the image objects and drop them in the placeholder
$('#imgcontainer').crossSlide({sleep:5,fade:2},myObject);
}
});

}
</script>

That's all there is to it. This is a great alternative to flash and is much less cpu intensive!

Adding additional text fields with Javascript

Posted on October 16, 2008 by Kevin Dubois

** UPDATE: This functionality is outdated. Look at a more recent post on how to add more field to a form field:
'Add More' form fields with javascript / jquery **

One of my clients needed the ability for users to refer their family and friends to the website by sending them an email. The idea was to have 5 fixed fields, and the ability to add more fields on the fly before hitting submit.

Step 1 is obviously adding the static html code (with a tiny bit of php to avoid redundancy):

<form action="mysubmitpage.php" method="post">
<div id='fields'>
<? for($i=1; $i<6; $i++){?>
<div>
name: <input type="text" name="refname<?=$i?>" />

email: <input type="text" name="refemail<?=$i?>" />

</div>
<? }?>

</div>

<div style="margin-top:5px;">
<input type="submit" value="Send Invitations" name="send" />
</div>

</form>

Step 2 involves adding an 'add more' link, which calls the javascript function that adds the field. I'm passing the number of the next field into the function, so when the time comes to submit it to the server I can distinguish the fields. I would have preferred to use IE's outerHTML but that's not supported in my preferred browser firefox, so to keep everything neat I get the existing fields and append the new field to the end of the string. I also replace the "add more" link so next time it is clicked the number 7, 8, 9 etc is passed.

<script language="javascript">
function addrefField(i){
var newfieldContent = "<div>name: <input type=\"text\" name=\"refname"+i+"\" /> email: <input type=\"text\" name=\"refemail"+i+"\" /> </div> \n";

var oldfieldContent = document.getElementById('fields').innerHTML;

el = document.getElementById('fields');
el.innerHTML = oldfieldContent + newfieldContent;

x = i + 1;
var addmoreContent = document.getElementById('addmorelink');
addmoreContent.innerHTML = '<div><a href="javascript:addrefField('+x+')">add more</a></div><input type="hidden" name="numberfields" value="'+i+'" />';

}

</script>

<div id='addmorelink'>
<a href="javascript:addrefField(6)">add more</a>
<input type="hidden" name="numberfields" value="6" />
</div>

Step 3 : The above code seems to work fine in IE, but in Firefox there is a problem: the value of the existing fields is reset to whatever the DOM originally served up to the user. So if the user had started to fill out the fields and then clicked the 'add more' link, all fields would have been emptied. With every problem comes a solution ofcourse. I googled my problem and stumbled upon this post. By adding a function (updateDOM()) on the onBlur event for each field, we can update the DOM to reflect the already inserted values. So here's the entire code for the form:

<script language="javascript">
function addrefField(i){
var newfieldContent = "<div>name: <input type=\"text\" name=\"refname"+i+"\" onBlur=\"updateDOM(this)\" /> email: <input type=\"text\" name=\"refemail"+i+"\" onBlur=\"updateDOM(this)\" /> </div> \n";

var oldfieldContent = document.getElementById('fields').innerHTML;

el = document.getElementById('fields');
el.innerHTML = oldfieldContent + newfieldContent;

x = i + 1;
var addmoreContent = document.getElementById('addmorelink');
addmoreContent.innerHTML = '<div><a href="javascript:addrefField('+x+')">add more</a></div><input type="hidden" name="numberfields" value="'+i+'" />';

}

function updateDOM(inputField) {
// if the inputField ID string has been passed in, get the inputField object
if (typeof inputField == "string") {
inputField = document.getElementById(inputField);
}

if (inputField.type == "select-one") {
for (var i=0; i<inputField.options.length; i++) {
if (i == inputField.selectedIndex) {
inputField.options[inputField.selectedIndex].setAttribute("selected","selected");
}
}
} else if (inputField.type == "text") {
inputField.setAttribute("value",inputField.value);
} else if (inputField.type == "textarea") {
inputField.setAttribute("value",inputField.value);
} else if ((inputField.type == "checkbox") || (inputField.type == "radio")) {
if (inputField.checked) {
inputField.setAttribute("checked","checked");
} else {
inputField.removeAttribute("checked");
}
}
}

</script>

<form action="index.php" method="post">
<div id='fields'>
<? for($i=1; $i<6; $i++){?>
<div>
name: <input type="text" name="refname<?=$i?>" onBlur="updateDOM(this)" /> email:
<input type="text" name="refemail<?=$i?>" onBlur="updateDOM(this)" /> </div>
<? }?>

</div>
<div id='addmorelink'>
<a href="javascript:addrefField(6)">add more</a>
<input type="hidden" name="numberfields" value="6" />
</div>
<div style="margin-top:5px;"> <input type="submit" value="Send Invitations" name="send" /> </div>

</form>

Step 4 : All that's left is processing the fields on the next page:

<?php

$loops = $_POST['numberfields'];
for($i=1;$i<=$loops;$i++){

$namepost = "refname" . $i;
$name = $_POST[$namepost];
$emailpost = "refemail" . $i;
$email = $_POST[$emailpost];
if($name && $email){
echo $name .' ' .$email;
echo '<br />';
}

}

?>

Kevin Dubois

Principal Developer Advocate at Red Hat. Content and opinions are my own.

Tag Archives: javascript

Creating an advertisement widget for external websites using JavaScript

1) The simple and easy (but limited) solution

2) The more advanced (but still pretty easy) solution:

Rotating images using jQuery Ajax

Adding additional text fields with Javascript