mySimpleAds User Manual

version 1.90 (Autumnal Equinox)

October 31, 2011

Contents

[1] mySimpleAds User Manual

[1.1] Installing

[1.2] Overview

[1.3] Host System Requirements

[1.4] Administration

[1.4.1] Accessing

[1.4.2] Navigation

[1.4.3]
Ads : Listing current ads

[1.4.4] Ads : Creating a new ad

[1.4.5] Ads : Editing an existing ad

[1.4.6] Ads : Deleting an existing ad

[1.4.7] Ads : Getting the Ad Code for your website

[1.4.8] Advertisers : Listing current advertisers

[1.4.9] Advertisers : Creating a new advertiser

[1.4.10] Advertisers : Editing an existing advertiser

[1.4.11] Advertisers : Deleting an existing advertiser

[1.4.12] Advertisers : Advertiser's RSS URL

[1.4.13] Ad Groups : Listing current ad groups

[1.4.14] Ad Groups : Creating a new ad group

[1.4.15] Ad Groups : Editing an existing ad group

[1.4.16] Ad Groups : Deleting an existing ad group

[1.4.17] Ad Groups : Getting the Ad Group Code for your website

[1.4.18] Ad Stats : Stats Overview

[1.4.19] Configuration : Configuration options

[1.4.20] Maintenance : mySimpleAds Maintenance

[1.5] Plugins

[1.6] How-To / FAQ / Troubleshooting

[1.7] Contact


Installing

Please see the readme_install.txt file located in the root of the mySimpleAds directory. If you will be updating an existing installation, please see the read_upgrade.txt file also located in the root of the mySimpleAds directory.

Overview

mySimpleAds is ad management for the rest of us.  It was designed with the website publisher in mind who would like to get his/her ads up on a site without having to spend ages climbing up a hefty learning curve. mySimpleAds provides useful features such as GeoTargeting and ad expiration, without any unnecessary bloat.

Host System Requirements


Administration

Accessing

To access your mySimpleAds administration panel, point your web browser to...
http://yoursite.com/yourmysimpleadsdirectory/admin/index.php . Then in the username box, enter your Administrator username as selected during the install process.  Same goes with the password box.
Your advertisers, at your discretion, can also login here to administer their ads.  You assign them a username and password in the Advertisers section.

Navigation

mySimpleAds Administration area is logically broken up into different areas of administration.  These areas are :

 Ads : The Ads area is where you will enter your ad information and individual ad options, such as which in which countries will or will not display the ad.

 Advertisers : The Advertisers area is where you can keep track of information on each advertiser, whose ads you might be displaying.  The information is for your reporting purposes and organization only.  This is also the location to set the advertisers' username and password, if you would like them to login to administer their ads.

 Ad Groups : The Ad Groups area is where you can create groups that will house multiple ads to rotate amongst.  For example, to show ad one in the United States and ad two everywhere else, you would create an Ad Group and assign ad one and ad two to the group.  Paste the Ad Group code into your website and the two ads will rotate amongst each other based on visitor's country.

 Ad Stats : The Ad Stats area is where you can monitor your advertising impressions, from looking at pie charts to downloading CSV spreadsheets for analyzing with your favorite tool.  You can also access the stats via various RSS feeds.

 Configuration : The Configuration area is where you can set the mySimpleAds options, such as turning on/off GeoTargeting.  It is also where you can change your administrator user id and/or password.

Maintenance : The Maintenance area is where you can accomplish such things, as backing up your database, downloading your stats to a CSV file, and checking for GeoIP Database updates.


Ads : Listing current ads

To list the current ads in your mySimpleAds system, click on the Ads link in the navigation menu to access the Ads area (this is also the default area when you first login to the Administration area).  The Ad Listing table will be displayed which provides an overview of all the ads currently in the system.  The table displays information including : ID, Status, Last Update Time, Description, Advertiser, Ad Group, Impressions, Clicks, and Click Through Rate (CTR).   

The Ad Listing table also provides the links to edit an ad, delete an ad, and get the code for an ad.

Note: If an advertiser logs in, they will only see and optionally be able to administer their own ads.

Ads : Creating a new ad

To create a new ad, click on the Ads link in the navigation menu to access the Ads area (this is also the default area when you first login to the Administration area).  On the top right of the Ad Listing table, click the Create a New Ad link.  Now, lets walk through the options...

When completed, click the Save button to create the ad, or Cancel to exit without saving the changes. 

Note : For Flash banners, the clicks must be handled internally by the Flash file itself.  You must add the appropriate Action Script code to the Flash file, by doing something like the following...

The preferred method is using the new clickTag code...

http://www.adobe.com/resources/richmedia/tracking/designers_guide/

...mySimpleAds will read the clickTag code and redirect the visitor to the URL.

Another option is to make your entire movie a link, make a huge button covering the entire thing with a getURL code. Using the effect palette, make the button transparent.

To make a text link, type something with your text tool and turn it into a button. Then add a getURL to that button.

Ads : Editing an existing ad

To edit an existing ad, click on the Ads link in the navigation menu to access the Ads area (this is also the default area when you first login to the Administration area).  In the Ad Listing table, click the Edit Icon in the row of the ad you wish to edit.  You will then be brought to the ad options page, with the options as listed in the 'Creating a new ad' section above.  In addition to the options above, you will also be able to reset your lifetime Ad impressions and clicks, as well (assuming the Ad has impressions/clicks).

When completed, click the Save button to store the ad changes, or Cancel to exit without saving the changes.

Ads : Deleting an existing ad

To delete an existing ad, click on the Ads link in the navigation menu to access the Ads area (this is also the default area when you first login to the Administration area).  In the Ad Listing table, click the Delete Icon in the row of the ad you wish to delete.

You will be prompted with an 'OK' or 'Cancel' box.  Click OK to delete the ad, or Cancel to exit without deleting the ad.

Ads : Getting the Ad Code for your website

To get the Ad Code for inserting into your website source, click on the Ads link in the navigation menu to access the Ads area (this is also the default area when you first login to the Administration area).  In the Ad Listing table, click the Ad Code Icon in the row of the ad you wish to retrieve the code for.

If the ad you wish to display is a member of an Ad Group, you can select to either display the Ad Group or just the individual ad.  mySimpleAds will display both options for you, when available.

mySimpleAds supports multiple ad codes per page.  Simply insert each Ad Code in your page - no special procedures need to be followed.

In the Ad Code page, select the code type you wish to use. The code types are as follows :

Click Back to Ad Listing to return to the Ad Listing table page.

 Advertisers : Listing current advertisers

To list the current advertisers in your mySimpleAds system, click on the Advertisers link in the navigation menu to access the Advertisers area.  The Advertisers Listing table will be displayed which provides an overview of all the advertisers currently in the system.  The table displays information including : ID, Description, URL,  Number of ads, and the advertiser's custom RSS URL.

The Advertisers Listing table also provides the links to edit an advertiser, and delete an advertiser.

Advertisers : Creating a new advertiser

To create a new advertiser, click on the Advertisers link in the navigation menu to access the Advertisers area.  On the top right of the Advertisers Listing table, click the Create a New Advertiser link.  Advertiser listings are for your reporting / organizational purposes only.  Now, lets walk through the options...

When completed, click the Save button to create the advertiser, or Cancel to exit without saving the changes.

Advertisers : Editing an existing advertiser

To edit an existing advertiser, click on the Advertisers link in the navigation menu to access the Advertisers area.  In the Advertisers Listing table, click the Edit Icon in the row of the advertiser you wish to edit.  You will then be brought to the advertiser options page, with the options as listed in the 'Creating a new advertiser' section above.

When completed, click the Save button to store the advertiser changes, or Cancel to exit without saving the changes.

Advertisers : Deleting an existing advertiser

To delete an existing advertiser, click on the Ads link in the navigation menu to access the Advertisers area.  In the Advertisers Listing table, click the Delete Icon in the row of the advertiser you wish to delete.

You will be prompted with an 'OK' or 'Cancel' box.  Click OK to delete the advertiser, or Cancel to exit without deleting the advertiser.

Advertisers : Advertiser's RSS URL

mySimpleAds allows you to see your statistics via an RSS feed. You can setup a password for each advertiser, and then get their particular RSS feed URL by clicking on their RSS URL icon in the Advertisers table.

The feed will only show the advertiser the statistics to the ads they are assigned to.  So, each advertiser will not see any other advertiser's statistics.

Note: You can get your admin RSS feed from the Stats page, which will show all your ads statistics.

 Ad Groups : Listing current ad groups

To list the current Ad Groups in your mySimpleAds system, click on the Ad Groups link in the navigation menu to access the Ad Groups area.  The Ad Groups Listing table will be displayed which provides an overview of all the Ad Groups currently in the system.  The table displays information including : ID, Description, URL, and Number of ads assigned.

The Advertisers Listing table also provides the links to edit an Ad Group, delete an Ad Group, and get the Ad Group Ad Code.

Ad Groups : Creating a new ad group

To create a new Ad Group, click on the Ad Groups link in the navigation menu to access the Ad Groups area.  On the top right of the Ad Groups Listing table, click the Create a New Ad Group link.   Now, lets walk through the options...

When completed, click the Save button to create the Ad Group, or Cancel to exit without saving the changes.

Ad Groups : Editing an existing ad group

To edit an existing Ad Group, click on the Ad Groups link in the navigation menu to access the Ad Groups area.  In the Ad Groups Listing table, click the Edit Icon in the row of the Ad Group you wish to edit.  You will then be brought to the Ad Group options page, with the options as listed in the 'Creating a new ad group' section above.

When completed, click the Save button to store the Ad Group changes, or Cancel to exit without saving the changes.

Ad Groups : Deleting an existing ad group

To delete an existing Ad Group, click on the Ad Groups link in the navigation menu to access the Ad Groups area.  In the Ad Groups Listing table, click the Delete Icon in the row of the Ad Group you wish to delete.

You will be prompted with an 'OK' or 'Cancel' box.  Click OK to delete the Ad Group, or Cancel to exit without deleting the Ad Group.

Ad Groups : Getting the Ad Group Code for your website

To get the Ad Group Code for inserting into your website source, click on the Ad Groups link in the navigation menu to access the Ad Groups area.  In the Ad Group Listing table, click the Ad Group Code Icon in the row of the Ad Group you wish to retrieve the code for.

The different code types and their descriptions are as described in the 'Ads : Getting the Ad Code for your website' section above.

Ad Stats : Stats Overview

The Ad Stats area gives you a detailed overview of your Ad impressions.  Select the Ad to view, along with the time frame, and click View.  A pop-up window will appear showing:

All will be ranked and include a pie-chart.

You can also access all your ad stats via a Stats RSS Feed.  The password protected feed can be consumed by any RSS reader, simply by using the URL provided on the Ad Stats page.

Configuration : Configuration options

To access the configuration options in your mySimpleAds system, click on the Configurations link in the navigation menu to access the Configuration area.  Now, lets walk through the options...

When completed, click the Save button to store the configuration changes, or Cancel to exit without saving the changes.

Maintenance : mySimpleAds Maintenance

To access the maintenance options in your mySimpleAds system, click on the Maintenance link in the navigation menu to access the Maintenance area.  Now, lets walk through the options...

Plugins

mySimpleAds supports a basic plugin system when its necessary to extend its ad serving functionality.  For example, if you work with an ad company that provides their own PHP code, you can place that code into a plugin and be able to call it from mySimpleAds.

Variables available from mySimpleAds...

$ads->mysa_ip : The visitor's IP Address

Example : 127.0.0.1

$ads->mysa_cc : The visitor's Country code (if GeoTargeting countries is enabled)

Example : US

$ads->mysa_rc : The visitor's Region code (if GeoTargeting regions is enabled)

Example : US|6

$ads->mysa_cyc : The visitor's City code (if GeoTargeting cities is enabled)

Example : US|6|los angeles

The file must be saved with a '.php' extension and the plugin system must be enabled in the Configuration section, for the plugin to be accessed.

Sample plugin...

<?php

function hello(){

 global $ads;

 echo 'Hello, your IP Address is:'.$ads->mysa_ip;

}

?>

...You can then create an ad in mySimpleAds using the 'ad code' type, and enter '<?php hello(); ?>' (without the quotes) to have the function run, just as any other ad code would.

How-To / FAQ / Troubleshooting

Please check the ClipperSoft website and forum at http://www.clippersoft.net for the latest information and tips on working with mySimpleAds.

Contact

Please use the help desk or contact form at the ClipperSoft website, http://www.clippersoft.net, to contact us about specific issues.

Thank you for using ClipperSoft's mySimpleAds for your ad management needs!