collective.googleanalytics 1.6.1

在 Plone 3 上

在 Plone 3 上，建议使用以下版本限制

[versions]
collective.googleanalytics = 1.4.1
gdata = 2.0.17
simplejson = 2.3.3

全局报告

• 网站访问：折线图

• 前 5 页：表格

• 前 5 个来源：表格

• 网站页面浏览量：折线图

• 网站停留时间：折线图

• 网站独立访客：折线图

页面特定报告

• 页面浏览量：Sparkline

• 页面停留时间：Sparkline

• 前10个页面来源：表格

• 前10个关键词：表格

• 前5个上一页：表格

• 前5个下一页：表格

报告存储在Plone工具中，称为portal_analytics。要查看和修改报告，请在ZMI中导航到网站的根目录，然后单击portal_analytics实用程序。由于它们是标准Zope对象，因此可以使用Zope按钮在报告列表下方复制、粘贴、重命名、删除、导入和导出报告。还可以使用上、下、顶和底按钮在列表中上下移动。portal_analytics中的报告顺序控制了它们在网站各个部分小部件中出现的顺序。

报告设置

报告设置部分由五个属性组成，用于控制报告的显示和行为。这些属性不接受TAL或TALES。

标题

管理界面中报告的标题。这是用户在分配小部件时选择的标题。

描述

报告的简要描述。描述主要用于开发人员参考，永远不会出现在Plone用户界面中。

I18n域

翻译报告的域。

分类

报告所属的分类列表。分类用于确定报告可以显示的位置。

插件

插件是上下文、请求和报告的多适配器，用于扩展报告的默认功能。collective.googleanalytics附带了两个插件。有关更多详细信息，请参阅上下文结果插件和变量日期范围插件部分。

请注意，一些插件会增加额外的维度、指标和可视化选项，这些选项只有在报告保存后才能使用。因此，在添加或删除任何插件后立即保存报告通常是一个好主意。

查询条件

报告的查询条件部分由所有以单词“查询”开头的属性组成。这些属性决定了发送给Google以检索分析数据的查询。所有这些属性都接受TALES表达式。它们可以访问在在报告中使用TAL和TALES部分定义的TALES变量以及所选插件提供的任何TALES对象。

查询指标

查询中使用的Google分析指标的列表。

查询维度

查询中要返回的Google分析维度的列表。此列表可以包括特殊维度变量date_range_dimension和date_range_sort_dimension。有关使用这些维度的更多信息，请参阅变量日期范围插件部分。

查询过滤器

查询中要使用的过滤器列表。过滤器定义为字符串或TALES表达式，其结果为字符串，格式为METRIC==VALUE，其中METRIC是Google分析指标或维度的名称，VALUE是所需的值，==是适当的逻辑运算符。

查询排序

要按其排序查询结果的指标或维度列表。排序参数使用字符串或TALES表达式定义，这些表达式评估为包含Google分析维度或指标名称的字符串。此外，维度或指标的名称之前可以加一个负号(-)以将排序顺序从升序改为降序。

查询开始日期

查询结果的开端日期。它必须是一个TALES表达式，该表达式评估为Python datetime.date对象。在使用变量日期范围插件的报告中，不需要指定开始日期或结束日期。

查询结束日期

查询结果的结束日期。有关更多信息，请参阅上面的查询开始日期。

查询最大结果数

查询可以返回的最大结果数。它必须是一个TALES表达式，该表达式评估为正整数。

表格生成器

报告的表格构建部分包括三个属性。这三个属性共同负责将Google返回的查询结果转换成可用于可视化或在其他地方显示在报告正文中的结果表。

为了执行此转换，这三个属性使用返回Python列表的TALES表达式。TALES表达式可以访问三个特殊函数，允许它们从Google返回的数据源中提取数据

dimension(dimension, specified={}, aggregate=unique_list, default=[])

返回给定维度在指定维度和指标中使用的值的列表，使用指定的聚合方法（默认为unique_list）。如果没有找到值，则返回默认值，默认情况下为空列表。

例如，以下TALES表达式将返回查询返回的所有浏览器的列表

python:dimension('ga:browser')

metric(metric, specified={}, aggregate=sum, default=0)

返回给定指标在指定维度和指标中使用的值的列表，使用指定的聚合方法（默认为sum）。如果没有找到值，则返回默认值，默认情况下为0。

要获取记录中‘ga:browser’等于‘Mozilla’的‘ga:visits’值的总和，我们可以使用此表达式

python:metric('ga:visits', {'ga:browser': 'Mozilla'})

在使用变量日期范围插件的报告中，指定的参数值通常设置为由possible_dates方法返回的列表中的元素。

possible_dates(dimensions=[], aggregate=unique_list)

返回一个包含当前日期范围内给定日期维度的所有可能值的字典列表。如果没有指定维度，则使用查询中所有日期维度。

此方法通常用于替代包含日期维度的报告中的维度方法，以确保表中包含日期范围内的每个日期单元一行。

这三个属性构成了报告的表构建部分。

表列表达式

表列的标题。它必须是一个TALES表达式，其结果为字符串的Python列表。这些标题的显示取决于可视化类型。例如，在表格可视化中，它们作为表格列标题显示。

在大多数报告中，表列表达式是一个静态的Python列表。

python:['Visits']

当然，可以使用TALES变量来填充列列表。

python:[date_range_unit, 'Visits']

在复杂表格中，列数可能由查询返回的结果确定。在这个例子中，第一列是“日期”，其余列的名称由查询返回的浏览器名称组成。

python:['Date'] + dimension('ga:browser')

表行重复表达式

产生用于生成结果表中的行的行键集合的表达式。它指定为一个TALES表达式，其结果为包含最终表中每行一个元素的Python可迭代对象。

当报告渲染器请求结果表行时，它首先评估行重复表达式。然后，它遍历结果列表中的每个元素，并使用当前元素（分配给变量“row”）评估表行表达式。

通常，使用维度函数或possible_dates函数生成行重复表达式的值。

python:dimension('ga:pagePath')

或

possible_dates

有关这些函数的更多信息，请参阅在报告中使用TAL和TALES部分。

表行表达式

每行表的内容。它必须是一个TALES表达式，其结果为包含该表行“单元格”值的Python列表。表行表达式可以访问两个特殊的TALES变量：

row

当前评估的行的行键值。这些值来自评估表行重复表达式产生的列表。

columns

由评估表列表达式产生的表列标题列表。

在只有一列的表中，行表达式的值通常与行键的值相同。

python:[row]

在两列表中，一列的值通常是行键，另一列是使用行键查找的度量值。

python:[row, metric('ga:visits', {'ga:browser': row})]

在复杂的多列表中，可能需要使用Python列表推导式遍历列变量。

python:[row] + [metric('ga:visits', {'ga:browser': row, 'ga:operatingSystem': c}) for c in columns[1:]]

可视化设置

报告的可视化设置部分由可视化类型和可视化选项属性组成。这些属性用于创建使用Google可视化API渲染由上述表构建部分生成的数据表的javascript。

可视化类型

用于显示报告结果Google可视化的类型。此属性可以设置为Google提供的任何默认可视化名称。

可视化选项

一个选项和值列表，格式为TAL定义，用于指定可视化选项。可用的选项取决于选定的可视化类型。重要的是选项表达式必须评估为可视化期望的数据类型。

例如，一个接受整数高度选项的可视化高度可以设置为以下：

height python:300

报告正文

报告正文由一个包含报告 TAL 模板的属性组成。在报告渲染时，会评估这个 TAL 代码块。该代码块中的 TALES 表达式可以访问第 使用 TAL 和 TALES 在报告中 部分描述的正常对象。它们还可以访问报告渲染器提供的所有公共方法。在报告正文中，必须使用 view/method_name 或 python:view.method_name() 来访问这些方法。

profile_ids()

返回正在评估报告的 Google Analytics 配置文件列表。

query_criteria()

返回评估后的查询条件。

data()

返回一个字典列表，包含由 Google 返回的数据源中每个条目的维度和度量值。

columns()

返回评估后的表格列标题。

rows()

返回评估后的表格行。

visualization()

返回渲染的可视化。

dimension(dimension, specified={}, aggregate=unique_list, default=[])

返回在指定维度和度量值以及指定聚合方法下给定度量的值。请参阅上方 表格构建器 部分的描述。

metric(metric, specified={}, aggregate=sum, default=0)

返回在指定维度和度量值以及指定聚合方法下给定度量的值。请参阅上方 表格构建器 部分的描述。

possible_dates(dimensions=[], aggregate=unique_list)

返回一个字典列表，包含当前日期范围内给定日期维度上所有可能的值。请参阅上方 表格构建器 部分的描述。

Google Analytics API

• Google 分析数据导出 API 文档

  这是学习 Google 分析的绝佳起点。特别感兴趣的是这些页面

  • 数据馈送参考

    本参考描述了用于查询 Google 的参数。

  • 数据馈送查询探索器

    此工具允许你交互式地尝试查询，这在创建和调试报告过程中非常有帮助。

  • 维度和度量参考

    本页描述了每个可用的维度和度量。另请参阅有关有效组合和常见计算的子页面。

• gdata API 参考

  gdata 是与 Google API 交互的 Python 模块。此文档对希望向或扩展 collective.googleanalytics 做出贡献的开发者最有用。相关的文档分为两个部分

  • gdata.analtyics.service 参考

    本文档描述了 gdata 提供的分析服务对象的 API。collective.googleanalytics 使用 AccountsService 和 AnalyticsDataService。

  • gdata.analytics 参考

    本参考记录了 Google 分析查询返回的响应对象。

Google 可视化 API

• Google 可视化 API 文档

  可视化 API 文档概述了 Google 可视化的内容以及它们是如何工作的。

• Google 可视化画廊

  此画廊提供了每种类型可视化的示例，并记录了每个可视化接受的选项。

TAL 和 TALES

• 使用 Zope 页面模板

  本章节来自《Zope2书籍》，介绍了TAL、TALES及相关技术。

• 高级页面模板

  本章节来自《Zope2书籍》，描述了TAL规范的一些高级功能。

• Zope页面模板参考

  本书附录提供了Zope页面模板中使用TAL和TALES的全面概述。

开发

• 马特·约德

• 汤姆·格罗斯

代码审查

• 大卫·格利克

用户文档

• 乔恩·斯塔ahl

其他

• 感谢FamFamFam提供的图表图标，这些图标是Silk集的一部分。

1.6.1 (2017-08-22)

• 基于HTTP响应状态而不是Python exc_info（即使在已处理的异常中也设置）记录虚拟错误页面视图。[davisagli]

• 使用jQuery全局代替jq。[davisagli]

• Plone 5.1兼容性[alecm]

• 移植到plone.app.testing[tomgross]

• 删除未使用的egg依赖项[tomgross]

• implements -> implementer[tomgross]

1.6.0 (2017-02-21)

• Plone 5兼容性[enfold-josh, tomgross]

1.5.0 (2016-07-27)

• 添加虚拟页面视图以用于搜索和错误页面[tomgross]

• 使用Python json代替自定义的[tomgross]

• 更新西班牙语翻译[macagua]

• 添加更多关于i18n的改进[macagua]

• 迁移到OAuth2凭证认证[frapell]

1.4.4 (2014-10-15)

• 添加更多关于i18n的改进[macagua]

• 添加西班牙语翻译[macagua]

• 更新核心GA代码，包含来自Google的最新片段[spanktar]

• 如果复制粘贴报告，则添加“副本”前缀。[frapell]

• 在创建报告词汇时使用SimpleTerm。[frapell]

• 裁剪过长的配置文件名称[tomgross]

• 传递视图小部件视图和管理器[tomgross]

1.4.3 (2013-05-28)

• 法语翻译[kiorky]

1.4.2 (2013-05-28)

• 修复发布，添加.mo[kiorky]

1.4.1 (2013-05-28)

• 添加对unittest2的依赖以支持Python 2.6下的高级测试功能。[2013-04-06 - hvelarde]

• 添加对plone.app.testing的依赖以及对控制面板配置小部件的一些测试。[2013-04-05 - hvelarde]

• 包分发重构：更新了包分类器；将文档文件重命名为.rst；修复了MANIFEST.in，并添加了一些缺少的测试依赖项。[2013-04-05 - hvelarde]

• 将.docx、.pptx和.xlsx添加到文件下载插件跟踪的扩展名中。[2013-03-28 - davisagli]

• 改进i18n并包含pt-br翻译的第一版。[2012-10-19 - tcurvelo]

• 改进词汇表中的Unicode值处理[2012-10-23 - kiorky]

• 发布和QA内容[2013-05-28 - kiorky]

1.4.1 - 2012-08-29

• 如果没有有效的auth_token，则避免调用Google检索词汇表。这应该有助于避免分析工具上的冲突错误。[2012-08-29 - davisagli]

1.4 - 2012-08-27

• 更新以继续使用Google的新管理API以及它们对数据导出API的向后兼容性的一些错误。[2012-08-27 - davisagli]

• 仅当渲染跟踪代码时尝试查找可用的Web属性列表。[2012-08-23 - davisagli]

• 当遇到禁止异常并且存储的access_token被删除时，还必须确保清除reports_profile，这样新的授权就不会立即遇到相同的禁止异常。[2012-08-23 - davisagli]

1.3 - 2012-04-09

• 添加Plone 4.1兼容性[2012-03-28 - encolpe]

• 修复日期范围计算中的闰日错误。[2012-03-01 - yomatters]

• 更新文件下载跟踪插件以跟踪at_download链接。[2011-07-26 - yomatters]

1.2 - 2011-05-31

• 转义CDATA标签以使Chameleon满意。[2011-05-27 - yomatters]

• 拒绝生成禁止响应的AuthSub令牌。[2011-04-27 - yomatters]

• 将页面视图跟踪移动到插件之后，以便将自定义变量与页面视图一起发送。[2011-04-04 - yomatters]

• 添加了跟踪用户类型的插件。[2011-04-04 - yomatters]

• 更新跟踪代码[2011-04-15 - garbas]

• 添加了跟踪页面加载时间的插件。[2011-05-05 - toutpt]

1.1 - 2011-03-24

• 记录域名注册过程。[2011-03-24 - yomatters]

• 为包含非ASCII字符的配置文件制作安全词汇表。[2010-12-23 - yomatters]

1.0 - 2010-12-07

• 为Plone 4添加了控制面板的图标表达式。[2010-12-07 - yomatters]

• 修复了权限错误，使得Google Analytics小部件可以显示给非管理员。[2010-12-07 - yomatters]

• 如果当前页面是以安全方式提供的，则允许通过HTTPS请求Google API JavaScript。[2010-11-04 - yomatters]

• 降低查询消息的日志级别。[2010-08-13 - yomatters]

• 将内联JavaScript包装在CDATA中，使其更容易与Deliverance一起使用。[2010-08-13 - garbas]

1.0b3 - 2010-06-30

• 将连接到Google Analytics的连接存储在ZODB连接上，而不是在分析工具中。[2010-06-30 - yomatters]

• 解决了同一Zope实例上多个Plone站点上分析工具之间的冲突。[2010-06-30 - yomatters]

1.0b2 - 2010-06-18

• 为与Plone 4兼容，在异步加载器中更改为逗号分隔的字符串。[2010-06-18 - yomatters]

• 修复了“网站时间：折线图”报告中除以零的错误。[2010-06-18 - yomatters]

• 添加了基本的超时处理，以便Google的请求不会无限期地占用Zope线程。[2010-06-15 - yomatters]

• 将上下文结果插件生成的正则表达式限制为128个字符，以符合Google API限制。[2010-06-07 - yomatters]

• 为1.0b2添加了升级步骤。[2010-06-07 - yomatters]

• 更改为AuthSub身份验证。[2010-06-04 - yomatters]

• 添加跟踪功能，包括外部链接、电子邮件地址、评论和文件下载。[2010-05-11 - yomatters]

• 由于尝试访问self.context.request（由于某些原因不可用），在Plone 4中@@analytics-controlpanel无法显示。对于Plone 3.3.5和Plone 4b2，使用self.context.REQUEST可以工作。没有时间进一步调查，但我使其工作。[2010-05-07 garbas]

1.0b1 - 2010-05-05

注意：1.0b1更改了报告表格构建部分（以前为报告列标签和表达式）和报告正文的语法。升级步骤会覆盖随产品提供的默认报告的这些属性。如果您已自定义这些属性，请确保在运行升级步骤之前在portal_analytics中将自定义报告重命名，以避免丢失更改。

• 将加载器更改为在当前上下文中调用@@analytics_async。[2010-05-05 - yomatters]

• 在控制面板中添加了Google Analytics链接。[2010-05-04 - yomatters]

• 将i18n域标准化为collective.googleanalytics。[2010-04-30 - yomatters]

• 添加了可能的日期辅助函数，以解决基于日期的报告在范围中的每个日期都没有结果的问题。[2010-04-28 - yomatters]

• 使其与Plone4兼容。[2010-04-26 - garbas]

• 更改了表格构建界面，以便行不直接与Google返回的结果相关联。添加了维度和指标值获取函数。[2010-04-22 - yomatters]

• 当没有数据时，改进了报告。[2010-04-09 - yomatters]

• 将单体报告重构为可插入组件。[2010-04-09 - yomatters]

• 将实用函数从报告类中移除。[2010-04-01 - yomatters]

1.0a4 - 2010-03-24

• 仅在上下文的视图模板上显示小部件。[2010-03-24 - yomatters]

• 添加从1.0a3到1.0a4的升级步骤。[2010-03-24 - yomatters]

• 修改测试以匹配异步JavaScript。[2010-03-24 - yomatters]

• 使用异步视图进行全局分析视图小部件。[2010-03-24 - yomatters]

• 添加异步结果的视图，并修改小部件以使用它。[2010-03-19 - yomatters]

1.0a3 - 2010-03-05

• 添加从1.0a2到1.0a3的升级步骤。[2010-03-05 - yomatters]

• 修改JavaScript注册和配置JavaScript以与Plone 3.1兼容。[2010-03-05 - yomatters]

• 添加更多默认报告。[2010-03-05 - yomatters]

• 通过视图小部件而不是通过注册加载外部JavaScript，以添加对Plone < 3.3的支持。[2010-03-05 - yomatters]

1.0a2 - 2010-02-10

• 为报告类别添加安全断言。[2010-02-10 - yomatters]

• 更新文档以反映日期范围更改。[2010-02-10 - yomatters]

• 使日期范围独立于报告，并更新测试和默认报告以反映新现实；添加JavaScript以根据容器宽度设置可视化宽度；向报告中添加类别，并调整词汇以适应特定类别；处理认证令牌过期错误。[2010-02-03 - yomatters]

• 使报告ID唯一，以便同一页面可以包含同一报告的多个副本。[2010-01-19 - yomatters]

• 修复一个错误，当查询返回无结果时会导致错误。[2010-01-19 - yomatters]

• 修复了旧版Zopes中的错误，该错误要求用户每次保存配置表单时都必须重新输入密码。[2010-01-14 - yomatters]

• 为2.12之前的Zopes添加导入InitializeClass的回退。[2010-01-05 - yomatters]

1.0a1 - 2009-12-23

• 初始发布