Pinax Web Analytics 技术文档

1. 安装指南

1.1 安装步骤

要安装 pinax-webanalytics，可以通过以下命令使用 pip 进行安装：

$ pip install pinax-webanalytics

1.2 配置 Django 项目

安装完成后，需要在 Django 项目的 INSTALLED_APPS 设置中添加 pinax.webanalytics：

INSTALLED_APPS = [
    # 其他应用
    "pinax.webanalytics",
]

2. 项目的使用说明

2.1 基本使用

在 Django 模板中，首先需要加载 pinax_webanalytics_tags 模板标签：

{% load pinax_webanalytics_tags %}

然后，在页面的底部（通常在 </body> 标签之前）插入以下代码以启用分析功能：

{% analytics %}

2.2 自定义活动跟踪

如果你需要跟踪特定的用户活动，可以使用 pinax-webanalytics 提供的 activity API。例如：

from pinax.webanalytics import activity

activity.add(request, "mixpanel", "track", "Node Viewed", {
    "node": self.get_object().title,
    "user": request.user.username
})

这段代码通常放在视图中，用于跟踪用户在页面上的特定行为。

2.3 AdWords 转化跟踪

要启用 AdWords 转化跟踪，首先加载模板标签：

{% load pinax_webanalytics_tags %}

然后在页面底部插入以下代码：

{% adwords_conversion "waitinglist" %}

其中，"waitinglist" 是 PINAX_WEBANALYTICS_ADWORDS_SETTINGS 中定义的转化标识符。

3. 项目 API 使用文档

3.1 activity.add 方法

activity.add 方法用于记录用户活动。其参数如下：

• request: Django 的请求对象。
• kind: 分析服务的类型（如 "mixpanel"）。
• method: 分析服务的 JavaScript API 方法（如 "track"）。
• args: 传递给 JavaScript API 的参数。

3.2 模板标签

• {% analytics %}: 用于在页面中插入分析代码。
• {% adwords_conversion "key" %}: 用于插入 AdWords 转化跟踪代码，其中 "key" 是 PINAX_WEBANALYTICS_ADWORDS_SETTINGS 中定义的键。

4. 项目安装方式

4.1 通过 pip 安装

如前所述，可以通过 pip 直接安装 pinax-webanalytics：

$ pip install pinax-webanalytics

4.2 配置 Django 项目

安装完成后，确保在 INSTALLED_APPS 中添加 pinax.webanalytics，并根据需要配置 PINAX_WEBANALYTICS_SETTINGS 和 PINAX_WEBANALYTICS_ADWORDS_SETTINGS。

4.3 自定义模板

pinax-webanalytics 提供了默认的分析服务模板，但你可以通过在项目的 templates/pinax-webanalytics 目录下创建自定义模板来覆盖默认行为。模板的命名格式为 "_%s.html" % slug，其中 slug 是 PINAX_WEBANALYTICS_SETTINGS 中定义的键。

总结

pinax-webanalytics 是一个强大的 Django 应用，能够轻松集成多种分析服务。通过简单的安装和配置，你可以快速为你的网站添加分析功能，并跟踪用户行为。希望本文档能帮助你更好地理解和使用 pinax-webanalytics。