OpenXplus documentation
OpenXplus documentation
Description
Use OpenX Advert Plus and Openx Article Plus Article plug-in to create a module zone that pulls ADs to a position from an OpenX AD server.
OpenX Advert Plus has many modes to choose from:
- Normal mode - creates standard Javascript invocation code
- iframe rotation mode - creates an invocation code and enables you to set the time on a rotation for ADs
- contextual ADs based on article title
- contextual ADs based on article meta keywords
Instructions (for both Module and Plug-in. For plug-in specifics see bottom):
Set up your zones as you normally would in the OpenX AD server. For basic functionality of the module you will need to make note of 2 things:
1. The Zone ID (you can find this by creating or editing a zone then look at your browser url to see 'zoneid=' use the number it equals.
2. The URL for the AD delivery (under OpenX Administrator configuration - Banner delivery settings - you will find a URL that looks like this 'yoursite/openx/www/delivery' but with your actual URL path - you do not need the http:// when you put it into the module)
Enter this info into your OpenX Advert Plus module in Joomla!
You can now use Normal and iframe modes to show ADs from your set zone. Using Contextual AD mode will also show any AD that has no set limitations but in order to use these modes as intended read the next instructions.
Do this first to make sure your regular ADs show be for going into contextual mode
*******
iframe mode options:
1. Set your rotation time - ADs will be random in rotation.
2. AD width and height - should be set to the same size as your AD -this sets the iframe area to show AD so if smaller AD may be cut off
3. open to - set for open to _blank or _self browser window
Module options
1. Module Class Suffix - use for module styling
2. Create Module Class - in cases where the position prohibits the module class suffix from working you can set you own class for the div around the code here
*******
Single call method
Get the website ID (go to website list in OpenX and choose one to edit - ID is in the URL)
In each OpenX module:
Choose single call (4) choice from dropdown in each OpenX Module
In ONLY ONE OpenX module - go to the options at the bottom, add your Site ID and set header call options to YES - (THIS MODUEL SHOULD ALWAYS BE ACTIVE OR ADS WILL NOT SHOW)
*******
Contextual AD modes
Normally you would set an AD with a source word(s) or channel with source word(s) then generate the zone code with the same source words so that the AD and zone will 'see' each other and show the AD - but this isn't very dynamic. OpenX Advert Plus will pull the words from title or meta keywords of an article and if they correspond (depending on your AD/channel settings of choice) they will show.
Here is how it set up:
In OpenX AD system:
Create a zone and set an AD or ADs to that zone in the OpenX AD server.
To set up your source keywords (not to be confused with the keyword field in banner properties) do either of the following:
(Note: since there are many options to choose on what condition an AD can display, I'm giving the basic set up that will work in general to match a keyword or keywords to an article with corresponding keyword - other experimentation is up to you)
Go to banners and click on your AD
- click the delivery options tab
- choose 'Site - Source' from the 'ADd delivery limitation' dropdown
- click 'ADD' and you can place in your keyword and set the condition from 'equal to' to 'contains'
- IMPORTANT only put in ONE keyword here NOT multiple like "cat, tabby, furball" - to ADd more keywords ADd another source from the drop down and set a condition of 'OR' insteAD of 'AND' from the between dropdown
OR
You can set up a channel by going to 'targeting channels' which can be ADs can be set to so that you can have a specific keyword channel set up that ADs can always be associated with.
- Under Targeting channels click 'ADd new Targeting Channel' - give it a descriptive name or whatever else you want and save. Now choose 'Edit targeting channel limitations', you can again set delivery options. ADd 'site-source' from the list and ADd your keyword to it (same IMPORTANT not as above on multiple keywords).
Now when you create your ADs choose 'site-channel' as a delivery option which will show all your channels you may have created and you can check off which to use for that AD - this is convenient if you are designating areas of your site by certain keywords that will always be used and can associate your ADs with these areas by channel insteAD or ADding in the keywords each time individually. Here is an example.
I have a site that is for pets. The site has a dog area and a cat area. I set up a channel for the dog area with key source word "dog". I set up a cat channel with key source word "cat" I create ADs for both dogs and cats, set them with their corresponding channels and point them to a single zone. Normally, without any restrictions, both cat and dog ADs would show in the zone on a rotating page refresh basis.
Now if I set my Joomla OpenXplus module to contextual by keyword and the keyword "dog" is in the article's meta keywords any AD that was set by the corresponding "Dog" channel will show. If the article has cat on the keyword - cat ADs will show
If I set it to contextual by title then any title keyword that matches a channel keyword will trigger the ADs
One thing to note: IF you have an AD with no restrictions pointing to the channeled zone it will show up in refresh rotation with the channeled ADs as well - if you want an AD to show in that module position but NOT when channeled ADs are present create a delivery limitation to the 'normal AD' same as the other ADs - set 'site channel' and check off the channels that your other ADs are using but set the condition dropdown to 'is not any of'
***************
OpenX Article Plug-in
Description
This allows OpenX ADs to be delivered directly into the top (left or right) of Joomla content (no need to use tag). Use OpenX AD system to control how and when ADs appear (contextual, URL based) in concurrence with the plug in parameters you set.
This has the same features as the OpenX Article Module with two additional parameters:
- Choose AD to appear LEFT or RIGHT at the top of content
- Choose not to have the plug in active by setting category ID (comma separate for multiple) to not have them appear in un-catagorized pages set to 0
After installing, publish plug-in, choose your parameter options and add your OpenX Ad system settings.