Google Analytics Plugin analytics.swf, analytics.js for Flash and HTML5

by Jaydee - info@jaydee.ru

• Integrates Google Analytics functionality in your virtual tour.
• Allows to track pano visits and events.
• Both scenes and external files with panoramas are supported.
• Can work either in automatic or manual mode.
• Easy events tracking.
• One codebase works the same on desktops and devices.
• HTML5 version of the plugin is free.

• Description
• Demo & Downloads
• Buy / Order
• Updates
• Integration
• Usage Syntax
• Plugin Attributes
• Plugin Subnodes:
  • Pano
  • Event
• Plugin Actions
• Examples
• FAQ
• Troubleshooting
• Changelog

Description

Demo & Downloads

Buy / Order

• The Google Analytics Plugin is an additional Commercial Plugin.
• To use it a full version must be bought.
• Without buying a full version you will be able to use plugin only in debug mode.
• Updates - All updates for the Google Analytics Plugin are free.
  Please, follow the instruction on this page to get an update. You need to know the email address, which you used to buy the plugin. You will receive a zip with updated version in a couple of minutes. If you forget or don't own that address anymore, please write me a short email.

Integration

• Sign up for Google Analytics account for your domain at this page.
• Then, include analytics.xml file from the demo package into your root XML file by using the include tag.

  <include url="analytics.xml"/>

• After that, you should copy required plugin files (analytics.swf, analytics.js) and change analytics.xml according to your tour requirements and architecture.

Syntax / XML Usage Example

<plugin name="ga" 
        url="plugins/analytics.swf"
	alturl="plugins/analytics.js"
	keep="true"
	preload="true"
	mode="auto"
	account="UA-XXXXXXXX-1"
	debug="false"
	prefix="/virtualtour"
	parsepaths="true"
>
   <pano name="pano1"
	 xmlurl="pano1.xml"
	 scene="scene1"
	 pageurl="/pano1/"
   />
   <event name="event1"
	  xmlurl="pano1.xml"
	  scene="scene1"
	  global="false"
	  target=""
	  data=""
   />
   ...
</plugin>

Plugin Attributes

• mode
  • A string, containing mode of the plugin. Possible values:
    • auto
    • manual (default)
  • Can't be changed at runtime.
• debug
  • A boolean value, specifying whether plugin will work in debug mode.
  • Set this parameter to true, if you want to see the tracking requests log and other useful information for debugging. Note that in HTML5 version you should open krpano log panel to view the debugging info, while in flash version the debug HUD will appear on the top of krpano viewer.
  • Default: false.
• account
  • A string value, specifying your Google Analytics account code.
  • Must be defined.
• prefix
  • A string to be added at the beginning of all pageurl attributes of pano subnodes.
  • Use this to easily distinguish between the panoramas and other pages on your website in the Google Analytics admin panel.
• parsepaths
  • A boolean value, specifying whether to parse placeholders (e.g. %SWFPATH%) in the xmlurl attribute of pano and event subnodes.
  • Default: true.
• version
  • A string, containing current version of the plugin.
  • Read only.

Plugin Subnodes - <pano>

• With the <pano> subnode it is possible to define what page tracking request should be sent to Google Analytics tracker when user views specific panorama.
• Add one subnode for each scene or XML file with panorama.
• Should be used with automatic mode only.

<pano name="pano1"
      xmlurl="pano1.xml"
      scene="pano1"
      pageurl="/pano1/"
      />

<pano> Attributes

• name
  • The name of the pano.
• xmlurl
  • A URL of XML file, which should be linked to specific page visit request.
  • May contain any of path placeholders (e.g. %SWFPATH%).
• scene
  • A scene name, which should be linked to specific page visit request.
• pageurl
  • A page URL, which should be sent to Google Analytics tracker when user opens linked panorama.

Plugin Subnodes - <event>

• With the <event> subnode it is possible to link specific event tracking requests to any krpano attribute or event.
• Each event subnode can be global linked or panorama-specific. For example, a Fullscreen button, which is usually always presented on the screen, is the example of a global linked event. And a hotspot on a specific panorama is the example of panorama-specific event.
• Add one subnode for each event trigger.
• Should be used with automatic mode only.

<event name="pano1"
       xmlurl="pano1.xml"
       scene="pano1"
       global="false"
       target=""
       data=""
      />

<event> Attributes

• name
  • The name of the event.
• xmlurl
  • A URL of XML file, which has the event trigger, specified in target attribute.
  • May contain any path placeholders (e.g. %SWFPATH%).
• scene
  • A scene name, which has the event trigger, specified in target attribute.
• global
  • A boolean value, specifying whether this event is global or panorama-specific.
  • Default: false.
• target
  • A string value, specifying a trigger for this event.
  • Event tracking code will be automatically added at the end of this trigger.
  • Must be defined.
• data
  • A string value, specifying parameters, which will be passed to trackevent method when this event will be fired.
  • May contain up to four parameters, separated by comma.
  • Must be defined.

Plugin Actions

<krpano version="1.0.8">
	<plugin name="ga"
		url="plugins/analytics.swf"
		url="plugins/analytics.js"
		preload="true"
		
		mode="auto"
		account="UA-XXXXXXXX-1"
		>
		<pano name="pano1"
		      scene="p1"
		      pageurl="/pano1/"
		      />
		<pano name="pano2"
		      scene="p2"
		      pageurl="/pano2/"
		      />
		<event name="event1"
		       global="true"
		       target="plugin[fullscreen_button].onclick"
		       data="UI,Button click,Fullscreen button"
		       />
	</plugin>
	
	<plugin name="fullscreen_button">
		onclick="switch(fullscreen);"
		...
		/>
	
	<scene name="p1">
		...
	</scene>
	
	<scene name="p2">
		...
	</scene>
</krpano>

v1.2
* [Added] HTML5 version of the plugin
* [Added] event subnode for easy events tracking
* [Improved] GA account now can be changed at runtime
* [Improved] Minor improvements and bugfixes
* [Removed] ontrackerready attribute
* [Removed] isready attribute

v1.1
* [Improved] auto|xml and auto|scenes modes are removed.
New auto mode supports using both scenes and external XML files
simultaneously
* [Added] version attribute
* [Improved] Some minor improvements

v1.0
* initial plugin release