Package: eea.google
This package contains useful tools for talking with Google Analytics.ContentsContentsContentsMain featuresGoogle API (eea.google.api)Google Tool (eea.google.tool)Google Analytics (eea.google.analytics)AnalyticsAnalytics ReportConnection UtilityXML Parser utilityDependenciesSource codeCopyright and licenseFundingChangelog5.8 - (2019-01-28)5.7 - (2017-12-12)5.6 - (2017-11-07)5.5 - (2017-05-22)5.4 - (2017-05-15)5.3 - (2017-04-24)5.2 - (2016-05-19)5.1 - (2015-10-05)5.0 - (2015-08-18)4.9 - (2015-03-17)4.8 - (2014-01-22)4.7 - (2013-10-04)4.6 - (2013-06-17)4.5 - (2013-02-04)4.4 - (2012-07-13)4.3 - (2012-06-12)4.2 - (2012-02-06)4.0 - (2011-11-07)1.2 (2010-02-24)1.1 (2010-02-24)1.0 (2009-11-09)Main featuresA low level API to access Google API;A CMF portal tool to store Google connections;Logic to authenticate with Google Analytics without touching Google
credentials usingAuthSub tokensLogic to create custom Google Analytics reports usingGoogle Analytics Data Export API.Google Analytics reports created this way can be made available via portlets. Right
now there is an example under skins folder.Google API (eea.google.api)A python package that provides a low level Google Connection and a generic
connection error GoogleClientError. To use this connection you’ll need an
AuthBase authentication token. You can get one by calling Google like:https://www.google.com/accounts/AuthSubRequest?scope=https://www.google.com/analytics/feeds/&session=1&next=http://yourdomain.com/do_something_with_tokenAfter you login into your Google Analytics account, you’ll be asked to grant
access toyourdomain.comto access Analytics statistics. If you do so, Google
will redirect your browser to thenextlink provided, adding a request
parametertoken=<one-session-authsub-token>, in our casehttp://yourdomain.com/do_something_with_token?token=ADFAFDDKLJH14234__ASDDAs this token was provided in clear to you, it can be used only once to query
Google API, that’s why you’ll need to exchange it for a multi-session one.
But this time you can not do it from browser. So here eea.google.api comes in.>>> from eea.google.api import Connection
>>> google = Connection(token='ADFAFDDKLJH14234__ASDD')
>>> new_token = google.token2session()If you provided an invalid token it will quietly fail and return you a
None object, else it will return you a multi-session token. Now you are
connected with Google, forever :).With this connection you can check it’s status:>>> google.status
(200, 'OK')Or make a call:>>> response = google(scope, data, method='GET')scope  - the Google service you want to access;data   - query parametersmethod - request method: GET or POSTIf something doesn’t work well this will raise a GoogleClientError, else
it will return aGoogle Data Feed Response>>> response.read()
<?xml ...You can also make a safe request by calling.requestmethod. This will return
a None object if something works wrong.>>> google.request(scope, data, method='GET')Google Tool (eea.google.tool)A CMF portal tool that can be retrieved using CMF method getToolByName: This a
simple container for Google connections. It provides a basic browser interface
to add and remove connections.>>> from Products.CMFCore.utils import getToolByName
>>> tool = getToolByName(portal, 'portal_google')Google Analytics (eea.google.analytics)This package provides the browser interface to register with Google Analytics
and defines two storage models: Analytics and AnalyticsReport. Also it provides
a utility to easily access low level api.Connection and another one to parse
Google response XML.AnalyticsThis will store AuthSub token and it’s also a container for Analytics Reports.
It provides a basic browser interface to get token from Google and to manage
reports.Analytics ReportA Google Analytics custom report by dimensions, metrics, start-date, end-date,
filters and sort order. It is actually a query object for Google Analytics API.>>> from zope.component import getMultiAdapter
>>> report = tool.analytics.report
>>> xml = getMultiAdapter((report, request), 'index.xml')Now you have a custom XML report based on defined filters.Connection UtilityEasily access low level eea.google.api.Connection using zope components>>> from zope.component import getUtility
>>> from eea.google.analytics.interfaces import IGoogleAnalyticsConnection
>>> utility = getUtility(IGoogleAnalyticsConnection)
>>> conn = utility(token='ABCDEFGH__FAH')XML Parser utilityParse Google reponse XML>>> from zope.component import getUtility
>>> from eea.google.analytics.interfaces import IXMLParser
>>> parse = getUtility(IXMLParser)
>>> table = parse(xml)Here table is a (dimensions, metrics) python generator>>> dimensions, metrics = table.next()
>>> dimensions
{'ga:pagePath': '/some/doc/path', 'ga:browser': 'Firefox'}>>> metrics
{'ga:pageviews': u'34235', 'ga:timeOnPage': '2433.0'}Dependenciespython2.4+Plone 2.5.x or Plone 3.x. (optional if you’re using only eea.google.api package).Source codeLatest source code (Plone 4 compatible):https://github.com/eea/eea.googlePlone 2 and 3 compatible:https://github.com/eea/eea.google/tree/plone25Copyright and licenseThe Initial Owner of the Original Code is European Environment Agency (EEA).
All Rights Reserved.The EEA Google (the Original Code) is free software;
you can redistribute it and/or modify it under the terms of the GNU
General Public License as published by the Free Software Foundation;
either version 2 of the License, or (at your option) any later
version.Contributor(s): Alin Voinea (Eau de Web),Antonio De Marinis (European Environment Agency),More details under docs/License.txtFundingEEA- European Enviroment Agency (EU)Changelog5.8 - (2019-01-28)Jenkins: Add sonarqube step
[avoinea refs #101552]Change: updated URLs pointing to eea.europa.eu withhttps://[alecghica refs #95849]5.7 - (2017-12-12)Change: Replace eeacms/zptlint with eeacms/plone-test:4 zptlint
[avoinea refs #90415]5.6 - (2017-11-07)Change: Remove Sphinx generated documentation
[petchesi-iulian refs #88212]5.5 - (2017-05-22)Change: fixed PyLint warnings and errors
[valipod refs #84949]5.4 - (2017-05-15)Change: fixed PyLint warnings and errors
[eduard-fironda refs #84949]5.3 - (2017-04-24)Change: updated package information
[eduard-fironda]5.2 - (2016-05-19)Bug fix: Fix pylint warnings
[ichim-david refs #71940]5.1 - (2015-10-05)Bugfix: set socket timeout to prevent hanging out connection on xmlrpc calling using eventlet
[lucas refs #29063]5.0 - (2015-08-18)Change: Auto-include zcml within plone context in order to make this package
work without having to add it within buildout zcml directive.
[avoinea]4.9 - (2015-03-17)Change: Switched to curl in the jenkins build install script
[olimpiurob refs #22402]Change: Changed fetch url for jenkins build install script to the install
script from the main EEA CPB repository
[olimpiurob refs #22402]4.8 - (2014-01-22)Feature: adding Sphinx-generated documentation in Page Template format
[batradav refs #9502]Bug fix: removed wrongly added blockquotes within README.rst
[ichim-david refs #18064]4.7 - (2013-10-04)Change: updated zope imports with the versions that require minimum Plone 4.1
for eea.google
[ichimdav refs #15651]4.6 - (2013-06-17)Change: updated link to site setup
[ghicale]4.5 - (2013-02-04)Bug Fix: Fixed to work with the 2.4 API
[batradav refs #9551]4.4 - (2012-07-13)Bug Fix: Fixed i18n missing tags in .pt files
[prospchr refs #5160]4.3 - (2012-06-12)Bug fix: fixed markup of HISTORY.txt file
[ciobabog refs #5231]4.2 - (2012-02-06)No changes4.0 - (2011-11-07)Cleanup: of pylint, pyflakes warnings
[ichimdav #4140, #4141]Feature: added upgrade steps
[voineali #4392]Feature: Plone 4.x compatible release
[ghicaale #4212]1.2 (2010-02-24)Bug fix: fixed stinky egg
[ghicale]1.1 (2010-02-24)Bug fix: fixed layout in edit mode
[voineali #2685]1.0 (2009-11-09)Initial release
[voineali]