collective.googleanalytics (1.2)

collective.googleanalytics is a Plone product used to pull statistics from Google Analytics and display them in a Plone site. It defines Analytics reports that are used to query Google and display the results using Google Visualizations. Reports are Zope objects that can be imported and exported using GenericSetup XML and modified on a site-by-site basis. The product currently provides a portlet that can display results of reports as well as a control panel for setting credentials and configuring settings.

To install collective.googleanalytics, add it to the eggs section of your buildout. If you are using Plone 3.2 or earlier, you also need to add a ZCML slug. Then re-run buildout and restart Zope.

When you install the product from the Plone Add-ons control panel, a new control panel called Google Analytics will be added to your Plone site. In this control panel, you can set the e-mail address and password that Plone will use to access Google Analytics. You can also configure the amount of time, in minutes, that report results will be cached, reducing the need to query Google. Sixty minutes is the default caching interval.

After you have set your credentials in the control panel, you can begin using Analytics reports. First navigate to the page where you would like to display the report results. Where you place the portlet depends on your goals and the type of report you are displaying. For site-wide reports, your user dashboard may be the most appropriate place. For reports that monitor a specific page or section of the site, it may makes sense to place the portlet on the page that it references. Even if you place a portlet on a public page, the portlet will only be visible to users who have the "View Google Analytics Reports" permission, which, by default is assigned to Managers.

Next, place the portlet as you normally would, using the manage portlets page and selecting Google Analytics from the list of available portlets. In the portlet add form, you can set the title of the portlet, the profile the portlet will use and the reports it will display. Note that the title of the portlet is not the same as the title of the report, which is displayed inside the portlet. The profile is the Google property where the statistics that you want to access live. Which profiles you can select within the portlet depends on which profiles the Analytics account you provide to Plone can access. If you do not see any profiles in the dropdown menu, check to be sure that you have correctly set your Analytics e-mail address and password in the Google Analytics control panel.

You can select more than one report to display within a single portlet. Each report performs its own query to Google, however, so including many reports on a single page may cause a decrease in performance. To change the order of the reports within a portlet, see the section on Managing Reports below.

Once you have set the portlet title and profile and selected one or more reports, click save to add the portlet. When you navigate to the page where you assigned the portlet, you should see the results of your report.