Cheat Sheet - News.com.au

advertisement
Ad Tool Kit (version 3.0.6) Cheat Sheet
Debug parameters
1.) sops – The sops options is used to enable debug mode for the ad kit,
in debug mode the adkit will show a yellow div with targeting
information and key values for each ad.

Example http://news.com.au/?sops=debug
2.) sopsver – The sopsver option is used to force a page to run a
particular version of the adkit. Must be used in conjunction with
sopshost.


Use “sopsver=3.0.X”, replace X with the minor version you wish
to load.
Example
http://news.com.au/?sopsver=3.0.6&sopshost=http://sops.news.
com.au/adkit/tests/version_3_0_6/js/
3.) sopshost – The sopshost parameter is used to tell the adkit where the
javascript referenced by the sopsver value resides.


Use “sopshost= adkit/tests/version_4_X_0/js/”, replace ‘X’ with
the minor version you wish to load.
Example http://news.com.au/?sopsver=4.2.0&sopshost=
adkit/tests/version_4_2_0/js/
4.) sopsenv – The sopsenv parameter is used to force the adkit to send a
particular env value to DFP with each ad on the page.


Use “sopsenv=xxx”, replace xxx with the env param you wish to
pass to DFP
Example http://news.com.au/?sopsenv=uat
5.) sopssticky – Used to make the adkit write a cookie for the sops,
sopshost and sopsver parameters so you don’t have to type them
for every page you visit for a day. Is always used in conjunction with
sops or sopshost and sopsver.

Use “sopssticky=on” to save your preferences, “sopsstick=clear”
to remove saved preferences. You can also delete cookies to
remove saved preferences.

Example http://news.com.au/?sops=debug&sopssticky=on
6.) sopsads – Used to switch off ads on a page.


Use “sopsads=false” to switch ads off.
Example http://news.com.au/?sopsads=false
FAQs
1.) Why am I seeing page layout issues / misplaced ads on FF3?

Check if you are using Firebug, Firebug is a debugging add-on
for Firefox. Firebug versions 1.2.0b5 – 1.2.0b15 are known to
cause problems. If you do have firebug you are advised to
disable it for the duration of your testing or use version 1.2.0b4.
2.) Why am I not seeing any ads after using the sopshost and
sopsver parameters?




Check if you are referring to a version number that exists.
Check if the sopshost string is typed correctly and ends with a
slash.
Check if the adkit URL logged in debug mode near the header is
valid.
Send an email to adtoolkit@newsdigitalmedia.com.au
3.) Why do I get an “Invalid URI” or “Page not found” error after
using the sopshost or sopsver parameters?




If the URL includes “.html” then try adding sops parameters
directly after the .html.
 For example :
http://www.news.com.au/story/0,23599,2425543329277,00.html?sops=debug&sopssticky=on
If the URL does not include “.html” then try loading the page in
FF and adding the debug parameters after a slash.
 For example :
http://www.news.com.au/?sops=debug&sopssticky=on
Some pages such as carsguide may require an index.php to be
manually added before they will accept parameters through the
URL.
If you still can’t get things to work using URL parameters on a
particular site, go to a site/page where you can get it to work and
use sopssticky to set a cookie, now revisit the previous site and
see if things work.
4.) How do I check what version of the adkit is running on a page?

Use the sops parameter to enable debug, there should be a
version string near the header debug.
5.) What do the version numbers mean?

Version numbers that begin with 2 indicate an Atlas version of
the adkit, whereas numbers that begin with 3 indicate that
doubleclick is being used.
6.) How do I know what each version does?


For production use: http://sops.news.com.au/adkit/version.txt
For test / dev versions use:
http://sops.news.com.au/adkit/tests/version_3_0_X/version.txt ,
replace X with the appropriate minor version.
7.) What browser versions does the adkit support?

The adkit is tested against Internet Explorer 6 and 7 and Firefox
2 & 3 but there’s no reason why it should not work in other
browsers.
8.) How is the adkit tested?






Functional testing consists of 15 test cases that cover the
different targeting scenarios; each test case is run on IE6, IE7,
FF2 and FF3.
After functional testing the adkit scanned through jsLint to
identify any syntax / formatting errors or bugs.
After jsLint the adkit it profiled to check its performance.
If issues are identified at any stage then they are corrected and
the adkit is retested.
We also use sopshost and sopsver to test the release on many
different sites on production
Site owners also get a chance to test and verify at their end.
9.) I have a great idea for a debug feature, how can I get it added to
the adkit?

Talk to someone from Sales Operations.
Download