Rugalytics项目技术文档

1. 安装指南

Rugalytics 是一个使用 Ruby 语言编写的，用于访问 Google Analytics 数据的 API。要安装 Rugalytics，您可以通过以下命令将其作为 Gem 安装：

sudo gem install rugalytics

请注意，Rugalytics 目前处于早期开发阶段，因此可能会随时间略有变化。

2. 项目使用说明

在使用 Rugalytics 之前，您需要使用您的 Google Analytics 用户名和密码进行身份验证：

require 'rubygems'
require 'rugalytics'

Rugalytics.login 'username', 'password'

接下来，您可以通过以下方式获取配置文件：

profile = Rugalytics.find_profile('your_site.com', 'blog.your_site.com')

如果账户名称和配置文件名称相同，您可以简化此过程：

profile = Rugalytics.find_profile('your_site.com')

确保您的 Google Analytics 账户的语言设置已更改为英文（英国或美国英语），因为 Rugalytics 目前仅支持英文。

3. 项目API使用文档

Rugalytics 提供了多种方法来获取不同类型的报告，以下是一些基础用法：

获取页面浏览量：

profile.pageviews # 默认为当前一个月结束
profile.pageviews :from=>'2007-01-01'
profile.pageviews :from=>'2007-01-01', :to=>'2007-01-02'

获取报告名称列表：

profile.report_names

加载特定报告：

report = profile.traffic_sources_report
report = profile.visitors_overview_report

根据 URL 获取报告：

report = profile.top_content_detail_keywords_report(:url=>'/projects/abc')
report = profile.top_content_detail_report(:url => "/projects/abc")
report = profile.content_drilldown_report(:url => "/projects/abc/")

根据页面标题获取报告：

report = profile.content_by_title_detail_report(:page_title => "Project ABC | Company XYZ")

4. 项目安装方式

Rugalytics 可以在 Rails 项目中使用。首先，创建一个配置文件 rails_root/config/rugalytics.yml，内容如下：

account: your_account_name
profile: your_profile_name
username: your_user_name
password: your_pass_w

请确保将此配置文件添加到您的版本控制忽略列表中，例如，如果您使用的是 git，请将其添加到 .gitignore 文件中。

在 Rails 中使用 Rugalytics：

profile = Rugalytics.default_profile
report = profile.top_content_report(:from=>(Date.today - 7))
top_items_over_week = report.items.sort_by{|i| i.unique_pageviews.to_i}.reverse

此外，Rugalytics 还可以配合一个名为 Rugrat 的 Greasemonkey 脚本在 Firefox 中使用，具体安装和使用说明请参照项目 README 文档。