Sponsor Ad Management User Guide



The cd_ad_sponsor plug-in was written to manage the sponsor ads that can be presented within your blogs. In the case of a WordPressµ installation, there can be a very large number of sponsor ads. I wrote this article to help you get the most out of the cd_ad_sponsor plug-in. This article is a continuation of the Sponsor Ad Management article.

Note: The cd_ad_sponsor download from WordPress in incorrectly named. The download DOES contain the correctly named cd_ad_sponsor.zip file. Please extract this file before you upload it to your plugins folder. You may also download the correctly named plug-in from here.

Change Log

Version 1.1 is now available. This User Guide reflects those changes and is noted by, [Version 1.1, 11-09-2009].

Version 1.2.1 is now available. This User Guide reflects those changes and is noted by, [Version 1.2.1, 12-07-2009].

Version 1.2.2 (01-20-2010) is now available. This upgrade reflects minor bug fixes only. No changes to the documentation is required.

Version 1.2.3 is now available. This User Guide reflects those changes and is noted by, [Version 1.2.3, 01-30-2010].

Version 1.3.0 is now available. This User Guide reflects those changes and is noted by, [Version 1.3.0, 02-20-2010].


Preface

I would like to preface this article with a few things I want you to know.

First, should you have any questions after reading this user guide, please leave your comments at the end of this article. I will do my best to assist you as soon as I am able.

Second. The cd_ad_sponsor plug-in was designed with both mainstream and adult-oriented blogs in mind. Subsequently, there may be specific data fields which are not relevant to one or the other blog type. Simply ignore the data that is not specific to your use.

Third. The cd_ad_sponsor plug-in is an initial release. This simply means that it resolves my current issues, and, that I will continue to expand the capabilities to fit additional requirements, or to incorporate feature enhancements made by you, the user, as time and funds permit.

Lastly, I want to thank you for your interest in using this plug-in. I have found that I now have much more time to write blog articles rather than managing ad placements and I hope that using this plug-in will save you time as well.

I've listed a sub-TOC here so that as you use the plug-in later you can refer to each section as needed. The plug-in is divided into the following administration menus:

I've added a couple of entries, "Modifying your theme" and "Miscellaneous" to the TOC. These sections describe the changes you need to make to your theme files. These entries are not part of the cd_ad_sponsor plug-in administration menu.


Prerequisite

  1. You should already have the cd_ad_sponsor plug-in installed and activated for your WordPress installation. Please refer to the installation instructions in the readme.txt file for more information.
  2. You should have a working knowledge of WordPress theme structures. The cd_ad_sponsor plug-in requires that you modify some of your blog theme files in order to present your sponsor ads as desired.
  3. Due to the shear number of user-defined themes available, I cannot cover all permutations. Therefore, I will use a fictional theme as an example guide throughout this article. You will need to make the necessary modifications in order to fit your particular theme style.

What do we do first?

Before you begin configuring the cd_ad_sponsor plug-in, you should consider how you sell ad spots to your sponsors. You should also consider whether you are billed for the use of a sponsor ad, such as the case of a PPC ad. The selling and buying of sponsor ads is categorized as a Revenue Type, which I explain in section Manage Revenue later in this article.

The next item for consideration is the location within your theme where you place sponsor ads. These locations are sometimes referred to as Zones. Again, I'll explain more about locations in section Manage Zones later in this article. For now, I want to demonstrate an easy method that you can use to initially define these locations. We'll be using this throughout the remainder of this article.

To define locations for ad placement in your theme, start by sketching an overall layout of the main theme page. Make sure to label each area. Our end goal is to have ads placed within each of these areas, so we'll start with the header, and work our way down.

Let's say that we want a single ad location in the Page Header section of our theme's main page to place a sponsor ad. Label this location as shown and give this location a number. You can use any integer identifier for your location reference, but for this example, I'll keep it simple and label it as, "zone 1". You should notice that I have included the ad size. The ad sizes I use conform to the IAB Ad Unit Guidelines but you may use any banner ad size that fits within your theme style. Whatever size you use, make sure to note it on our sketch for later reference.

Next, we'll sketch another location to appear at the top of the content area. Notice that I have specified two (2) ads to be placed in this zone. This location will be zone 2. I'll explain how to get more than one ad to display in a single location later in this article. For now, I think you get the idea how to label the rest of the locations in the sketch. You are not limited to the layout I have used here. This is simply an example. Just remember that you will need whatever zone identifiers you create when you define your zones within the cd_ad_sponsor plug-in.

One final note before we get started is that this sketch actually represents four different theme files, the header, the index or main page, the sidebar, and the footer. The ad location in the header means you will need to modify the header.php file. The ad in the content area means you will need to modify your index.php file, and possibly others, such as the page.php, the single.php, etc. The sidebar location obviously is the sidebar.php file. Lastly, the footer location represents the footer.php file. It is important that you understand one, how your particular theme is constructed, and two, be familiar with reading and writing PHP code.


Getting Started

Now that we have a general sketch outlining the different ad locations for our theme, we can start entering information into the cd_ad_sponsor plug-in. First, I will explain the purpose of each of these sections and describe each of the data fields. At the end of each section I'll provide a tutorial for that section.

In the following tutorial, we will create two sponsor ads, a image-based ad that we will place in the page header zone (Zone 1 on our sketch), and a script-based ad that we will place in he sidebar (Zone 5 on our sketch). You should complete each of these sections with your specific sponsor information.

Manage Sponsors

Sponsors are your clients. You either sell ad spots to a sponsor, or subscribe to their affiliate program. Either way, you obtain ads to display on your site from your sponsors. The Manage Sponsors page displays a list of all the currently defined sponsors for your blog. If you are running WordPressµ then the sponsors you define apply across all blogs.

The cd_ad_sponsor plug-in manages specific contact information about each of your sponsors. The Manage Sponsors page lists each of your sponsors in alphabetical order. Not all data fields are used when creating a new sponsor, depending upon the type of your sponsor. You can leave a data field empty if it does not apply.

Sponsor Name
This is the name of this sponsor.
User Name
This is your user name that you use to log in to the sponsor web site.
Login Password
This is your password that you use to log in to the sponsor web site.
Affiliate ID
This is the sponsor assigned affiliate ID you received when you signed up for this sponsor program. Not all sponsors provide an affiliate ID, however. If you do not have an affiliate ID, leave this field empty.
Webmaster URL
This is the URL you use to log in to the sponsor web site.
Referral URL
This is the webmaster referral URL that other webmasters use to sign up with this sponsor under your account. Not all sponsors offer a webmaster referral program. Leave this field blank if your sponsor does not offer this benefit.
Referral Banner
This is the webmaster referral banner URL. The URL can be a sponsor hosted banner or a banner hosted by you on your server.
2257 Doc URL
This is the URL for the sponsor's legal page detailing the 2257 requirements statement. This information is specific to adult oriented web sites only.
Sponsor Support Email
This is the support e-mail address for this sponsor.
Sponsor Support ICQ
This is the support ICQ address for this sponsor.

After you are satisfied with your entries, click Save Changes. The Manage Sponsors page is displayed with your new sponsor data.

To edit sponsor data, click the sponsor name.

Tutorial: Manage Sponsors

In this tutorial, we'll be creating two sponsors. We'll create an entry for Google, and an entry for the AdCouncil.

Start by clicking the Manage Sponsors option from the Ad Sponsors administration menu.
The Manage Sponsors page is displayed. You should see an empty listing.


Click the Add Sponsor button to display the Add Sponsor form.

Google PSACentral
  1. In the Sponsor Name field, type, Google.
  2. In the User Name field, type the user name that you use to log in to your Google account.
  3. In the Login Password field, type the password that you use to log in to your Google account.
  4. In the Affiliate ID field, type the affiliate ID assigned to you when your Google account was created. This should look similar to, pub-nnnn.
  5. In the Webmaster URL field, type the URL that you use to log in to your Google account.
  6. Leave the Referral URL field empty, since Google does not offer a webmaster referral program.
  7. Leave the Referral Banner field empty, since Google does not offer a webmaster referral program.
  8. Leave the 2257 Doc URL field empty, since we are not working with an adult-oriented sponsor.
  9. In the Sponsor Support Email field, type the Google support email address.
  10. Leave the Sponsor Support ICQ field empty, since Google does not have a support ICQ feature.
  1. In the Sponsor Name field, type, PSACentral.
  2. In the User Name field, type the user name that you use to log in to your PSACentral account.
  3. In the Login Password field, type the password that you use to log in to your PSACentral account.
  4. Leave the Affiliate ID field empty, since PSACentral does not provide an affiliate ID.
  5. In the Webmaster URL field, type the URL that you use to log in to your PSACentral account.
  6. Leave the Referral URL field empty, since PSACentral does not offer a webmaster referral program.
  7. Leave the Referral Banner field empty, since PSACentral does not offer a webmaster referral program.
  8. Leave the 2257 Doc URL field empty, since we are not working with an adult-oriented sponsor.
  9. In the Sponsor Support Email field, type the PSACentral support email address.
  10. Leave the Sponsor Support ICQ field empty, since PSACentral does not have a support ICQ feature.

Review your entries. If your entries are correct, click Save Changes. The Manage Sponsors page is displayed with each of your sponsor information data listed in alphabetical order.


Pages: 1 2 3 4

21 Responses to “Sponsor Ad Management User Guide”

  • hall says:

    There is potential problem with the folder name structure. When you download the plug-in from the WP site the ZIP name is cd-ad-sponsor and inside there is another ZIP cd_ad_sponsor if you decide to extract the files withing the same directory and you don't pay attention to the exact folder names you will install cd-ad-sponsor and some features will not work. I have spend few hours figuring out what's wrong and I guess others will experience the same problem if the name structure is not uniform.

  • Coyote says:

    Hi Hall,

    Thanks for the heads-up. I had gotten an email earlier about the naming issue. It is odd that the svn folder name was apparently changed to use hyphens rather than underscores. I'll look into this.
    [Update]

    The e-mail I received from WordPress with my approval for hosting shows the svn folder name using hyphens rather than underscores. I did not catch this before I created the repository and checked in the files.

    The download file from WordPress does contain the correctly named zip file. Please extract this file before uploading to your plugins folder.

    I apologize for the inconvenience.

  • hall says:

    Until you resolve it is best to point the issue in the readme file and in the WP plugin page, oh and by the way the plug-in is great, keep up the good work ;)

  • flyboy says:

    Great plugin. Got a question about having the multiple ads in a zone.

    I'm trying to have a four ad square along the sidebar, pretty common on blogs.

    I can define a default image and it shows up fine as a 2 row x 2 column image quadrant. But when I go to edit the banner, I only have one ad image that I can define so I can only seem to put one in the upper left quadrant. The other 3 default ads show for the other spaces.

    Can you direct me to anything that will explain what I'm doing wrong?

    Thanks!

  • Coyote says:

    Howdy,

    Actually, if I am reading your comment correctly, this was by design. You should have enough ads defined to occupy the positions within the 2x2 matrix. That is, if you only have two sponsor ads, default ads are displayed in the remaining slots. I did not initially code the capability to define one or more ad slots within a matrix in which to assign a sponsor ad. All ads you create are randomly placed within the matrix. So, if you have six ads designated for your side bar matrix, and assuming you do not specify CPD, then four random ads are displayed with each page refresh.

    I hope this helps. Please let me know if I misunderstood you, or if you have any other questions.

  • stefan says:

    Hi

    Great plugin! I combined it with Executable PHP widget, so that I can select adplaces using widgets. Works fine! Only one weird problem. After it showed one ad once, It now shows the default the ad only.

    I walked through you manual step by step three times, I filled sponsors, programs, zones, banners, scedules, default options (when left empty, homapage is linked, very nice detail). Everything looks fine, I can see the ads in the "Manage Banner Ads", all ads in "Manage Ad Schedules" are green and running, zone ID is set correctly, cetegories are selected (tried to selct, one, multiple, all). No IPs are excluded. Still only default banner displayed. What am I doing wrong?
    Any help is greatly appreciated
    Stefan

  • Coyote says:

    Hi Stefan,

    Thanks for the kind words. I have not used the executable php widget, nor do I know how it is used to "select ad places". But, let me offer a brief description of the process used by the cd_ad_sponsor plug-in when the intent is to embed ads within posts, and maybe it will help troubleshoot this issue.

    The cd_ad_sponsor plug-in function, cd_ad_embed_post(), located in the cd_ad_functions.php, line 147, is where the content is analyzed to determine the position to insert a qualified ad. Once this determination is made, a call to the primary function, cd_ad_zone(), is made to select one or more qualified ads. Qualified ads are any ads that are scheduled (as you currently have set up) that also were assigned to the post category. Ads are chosen based on the revenue type, first by CPD, then by other revenue types to create a 'pool' of ads. The ads are then embedded, first by CPD, then randomly by other revenue types.

    I did not code for the scenario where a specific ad can be placed in a specific position, which I am assuming is the intention of using that widget. If you would e-mail a copy of the code you are using, I would be more than happy to take a look and see if we can get this resolved. You can reach me at coyote [at] coyotesdesigns [dot] com.

    I hope this helps, and I look forward to hearing from you.

  • jmg says:

    Coyote

    I have been searching for the best ad script for days now. Can you guess what?
    Yes yours is the best. I have been playing (working) for hours with your plugin. It does everything perfectly.

    If I may I found a small bug and I have 2 question.

    First: in the manage schedules if I add a sponser schedule and then I want to edit the calender time and save it again then I lose the program name. In the sql table the pid number turns to 0.

    Now my question.
    Why can we schedule twice the same sponser with all the same starting and ending time? What will happen if I have 2 same scedule with different starting and ending time?

    Thanks for your time

    Jean-Marc

  • Coyote says:

    Hi Jean-Marc,

    Thank you very much for the kind words! I really appreciate hearing that others find this plug-in useful.

    Let me address your question first. I did not code any error checking for the data entered, since this plug-in is only for administrators. For example, you can create a banner ad entry without creating a program type. It will not function, but it is still possible to create this scenario. I am working on the next release, which will have error checking as well as some additional functionality.

    I will look into fixing the pid schedule management error shortly, and notify you by email when it is corrected. Thank you for providing enough information to duplicate the error.

    Feel free to let me know what features you would like me to include and I will do my best to get them out soon.

    Sincerely,
    Coyote

  • jmg says:

    Coyote

    I'm already back. I happy that you asked for new features. (and also maybe a new little bug)

    As a feature I would like for my advertiser(s) to see their own report. So if I have an advertiser(s) advertising on one blog or more they could come and see their report. So it would be per banner(s) and blog(s).
    How?: A new page where I could tick a few boxes, banner, blogs and then put a password and give my advertiser(s) a link and the password.

    Ok I understand It's not that simple to program but what a great add-on. Don't you think? :)

    Now for the little bug I would like to send you to a page link so you could test it and I would also like to send you the php file where I put your little insert.
    Would you please email me so I could send you everything.

    Once more thanks for your time.

    Jean-Marc


Popular Posts

Quote of the day plugin

The Quote Of The Day plug-in manages quotes displayed on your WordPress or WordPressµ

Sponsor Ad Management User Guide

The cd_ad_sponsor plug-in was written to manage the sponsor ads that can be presented with

A WordPress Sponsor Ad Management Plug-In

I wrote the WordPress Sponsor Ad Management Plug-in to use within the WordPress and WordPr

Quote Of The Day
This nation is like all the others that have been spewed upon the earth--ready to shout for any cause that will tickle its vanity or fill its pocket. What a hell of a heaven it will be when they get all these hypocrites assembled there!
~Mark Twain