技術情報

RailsアプリケーションにMatomo(Piwik)を統合

2012年10月27日 導入ガイド

※注 この記事は Piwik1.8~2.17のアーカイブ情報です

piwik_analytics は Rails 3.x における Ruby の Gem です。サーバーに Matomo(Piwik) をインストールしてウェブサイトを作成した後、ウェブサイトに埋め込む JavaScript のトラッキングタグを取得します。多くの場合 Rails では、トラッキングタグは application.html.erb ビューに埋めこまれます。ビューにトラッキングタグを含めるのはそんなに簡単ではありません。

piwik_analytics の gem は、ビューテンプレートをめちゃくちゃにしなくても、アプリケーションに Matomo(Piwik) を含めるための簡単​​な方法を提供します。

インストール

Gemfile に piwik_analytics の Gem を追加します。:
[info_box]
gem 'piwik_analytics', '~> 1.0.1'
[/info_box]
以下を実行することを忘れないでください。
[info_box]bundle install
[/info_box]
! 次にジェネレータを実行します。:
[info_box]
rails g piwik_analytics:install[/info_box]
これにより、アプリケーションの config ディレクトリにpiwik.yml設定ファイルをインストールします。

設定

config/piwik.yml を開いて、設定を編集します。各設定は、設定ファイル自体に記述されています。

01# Configuration:
02#
03# disabled
04# false if tracking tag should be shown
05# use_async
06# Set to true if you want to use asynchronous tracking
07# url
08# The url of your piwik instance (e.g. localhost/piwik/
09# id_site
10# The id of your website inside Matomo(Piwik)
11#
12production:
13piwik:
14id_site: 1
15url: piwik-production.example.com
16use_async: false
17disabled: false
18 
19development:
20piwik:
21id_site: 1
22url: piwik-development.example.com
23disabled: true
24use_async: false
25 
26test:
27piwik:
28id_site: 1
29url: localhost
30disabled: true
31use_async: false

見て分かるように、Matomo(Piwik) のデフォルトでは本番モードで有効になっています。 disabled: false と設定することにより、開発環境やテスト環境で Matomo(Piwik) を有効にすることもできます。次に、Matomo(Piwik) から追跡したいWebサイトのサイトIDを取得する必要があるでしょう。Matomo(Piwik) のインストールにログインし、”設定”に移動して、 “Webサイト”タブをクリックします。

Matomo(Piwik) Site ID
Matomo(Piwik) のサイトID

この場合、サイトIDは “1”です。最後のステップとして、Matomo(Piwik) のインストールの URL を設定する必要があります。 Matomo(Piwik) が http://example.com/piwik/ でホストされている場合は、 example.com/piwik (最後のスラッシュなし)に URL を設定する必要があります。

Matomo(Piwik) はバージョン1.1から 非同期トラッキング スクリプトをサポートしています。 アプリケーションで非同期トラッキングを使用したい場合には、単に use_async: true と設定します。

用法

Gem は、トラッキングタグを出力するシンプルなヘルパーを提供しています。 application.html.erb (or haml, slim) 内で、シンプルに body 閉じタグの前に次のコードを追加できます。
[info_box]<%= piwik_tracking_tag %>[/info_box]
Gem をテストするときには disabled: false となっていることを確認します。

piwik_analytics のサポートを受ける

サポート、追加情報は?:

この記事は日本Matomo(Piwik)ユーザー会によって翻訳されました。