トラックキングAPI

2014年11月17日機能説明

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

目次
1. トラッキングウェブ API のための JavaScript クライアント
2. トラッキングウェブ API クライアント
・PHP クライアント
・Java クライアント
・Python クライアント
・C# クライアント
・iOS SDK
3. トラッキングウェブ API リファレンス
4. Php クライアントを使用したトラッキングデータの使用事例
・イメージトラッカーコード
・Matomo(Piwik) トラッキング API（上級ユーザー）
5. 詳細情報

トラッキングウェブ API のための JavaScript クライアント

JavaScript は、デフォルトで推奨されているクライアントです。詳細はこちらをご確認ください: developer.piwik.org/api-reference/tracking-javascript

JavaScript クライアントは、多くのユーザーが使用しており、よい働きをします。JavaScript コードを貼り付けているページフッターの位置は、問題ではありません。ただし、たとえば Software アプリケーション、 iPhone/Android アプリ、モバイルウェブサイト、 Ebay ページなどでは、 JavaScript が使用できない場合があります。

このような場合に、 Matomo(Piwik) でビジター、訪問数、ページ、目標コンバージョンを記録するもう1つの方法を利用できます。

・イメージトラッカー
・トラッキング API のための PHP クライアント
・トラッキング API のための Java クライアント
・トラッキング API のための Python クライアント
・その他

トラッキングウェブ API クライアント

ここでは、 Matomo(Piwik) でデータを追跡するのに使用可能な、様々なクライアントについて学んでいきましょう。

トラッキングウェブ API のための PHP クライアント
デフォルトクライアントは、 PHP Matomo(Piwik) トラッカーです。詳細はこちら
developer.piwik.org/api-reference/PHP-Matomo(Piwik)-Tracker

トラッキングウェブ API のための Java クライアント
トラッキングウェブ API のための Java クライアントは、 Github 上でご利用いただけます。
github.com/piwik/piwik-java-tracking

トラッキングウェブ API のための Python クライアント
トラッキング API の完全な Python クライアントの実行は、 Github 上でご利用いただけます。
github.com/piwik/piwik-python-api

トラッキングウェブ API のための C# クライアント
トラッキング API の C# クライアントの実行は、 Github 上でご利用いただけます。
github.com/piwik/piwik-dotnet-tracker

トラッキングウェブ API のための iOS SDK
もし iOS アプリを構築中の場合、あなたの Matomo(Piwik) サーバーにトラッキングデータを送信するには、
Objective-C Matomo(Piwik) トラッカークライアントをご利用ください。

Matomo(Piwik) iOS SDK のダウンロードおよび詳細は、 Github にてご確認ください。
github.com/piwik/piwik-sdk-ios

トラッキングウェブ API リファレンス

JavaScript、PHP、Java、PythonC#Objective-C(いづれのクライアントも利用可能です) のいづれかを利用している場合、HTTP 経由でトラッキングウェブ API を直接呼び出すことができます。

トラッキング API の様々なパラメータと機能は、トラッキングウェブ API リファレンスドキュメントをご確認ください。

php クライアントを使用したトラッキングデータの使用事例

さて、ここでは Matomo(Piwik) にデータを記録するいくつかの事例をみていきましょう。なお以下でご紹介するコード内の、 {$IDSITE} は、ご利用の Matomo(Piwik) ウェブサイト ID に、また http://piwik.example.org/ は、ご利用の Matomo(Piwik) URL に書き換えてください。

イメージトラッカーコード

イメージトラッカーコードは、JavaScript が許可されない場合に利用することができます。MySpace や、 eBay のようないくつかのウェブサイトは、ユーザーのプロフィールに、 javaScript が追加されることを許可していません。このような場合でも、Matomo(Piwik) のイメージトラッカーを使用すれば、訪問を追跡することができます。
注：ただし、JavaScriptを使用しないため、たとえば、検索キーワード、リファラー、画面解像度、ブラウザプラグイン、ページタイトルなどのユーザー情報を追跡することはできません。

<!-- Matomo(Piwik) Image Tracker -->
<img src="http://piwik.example.org/piwik.php?idsite={$IDSITE}amp;rec=1" style="border:0" alt="" /> <!-- End Matomo(Piwik) -->

以下のパラメータは、イメージ URL に渡すことができます。

・rec –( 必須 ) &rec=1 パラメータは、強制的に記録されるリクエストが必要です。
・idsite –( 必須 ) 追跡されているウェブサイトIDを定義します。
・Action_name – このページビューに対するカスタムページタイトルを定義します。
・Urlref – 参照元の URL ：イメージトラッカーを含むページに到達する前に使用された参照元 URL に設定する必要があります。
たとえば、PHP ではこの値は以下を経由してアクセスすることができます。$_SERVER['HTTP_REFERER']
・Idgoal – リクエストは指定の目標をトリガーします。
Revenue – idgoal と共に利用し、このコンバージョンに対するカスタムレベニューを定義します。
・and more! – 上記の主なもの以外でも、設定できるさらに多くのパラメータがあります。トラッキング API ドキュメントページをご確認ください。

Matomo(Piwik) トラッキング API（上級ユーザー）

あなたのお気に入りのプログラミング言語を使用して Matomo(Piwik) トラッキング API を呼び出すことが可能です。PHP トラッキングェブ API クライアントで始めるには、以下のインストラクションに続いてください。

・Matomo(Piwik)Tracker.php ファイルをダウンロードするには、こちらをクリック
・あなたのプロジェクトファイルと同じパスに Matomo(Piwik)Tracker.php ファイルをアップロードしてください。
・以下のコードをコピーし、追跡したい各ページに貼り付けてください。

<?php
// -- Matomo(Piwik) Tracking API init --
require_once "/path/to/Matomo(Piwik)Tracker.php";
Matomo(Piwik)Tracker::$URL = 'http://piwik.example.org/';
?>

・トラッキング方法を選択し、追跡したい各ページにコードを貼り付けます。
・方法 1 ：上級イメージトラッカー
HTML コード内に含まれているトラッキング URL を生成するために、クライアントが使用されます。
あなたのページのコードの前に、以下のコードを貼り付けてください。

<?php 
// Example 1: Tracks a pageview for Website id = {$IDSITE}
echo '<img src="'. str_replace("&","&amp;", Piwik_getUrlTrackPageView( $idSite = {$IDSITE}, $customTitle = 'This title will appear in the report Actions > Page titles')) . '" alt="" />';
// Example 2: Triggers a Goal conversion for Website id = {$IDSITE} and Goal id = 2
// $customRevenue is optional and is set to the amount generated by the current transaction (in online shops for example)
echo '<img src="'. str_replace("&","&amp;", Piwik_getUrlTrackGoal( $idSite = {$IDSITE}, $idGoal = 2, $customRevenue = 39)) . '" alt="" />';
?>

上級イメージトラッカーを使用する方法は、基本の JavaScript トラッキングコードを使用する方法に似ていますが、いくつかのユーザー設定（解像度、ローカルタイム、プラグイン、 cookie サポート）に関しては、検出されません。

方法 2 ： HTTP リクエスト
HTTP 経由で、 Matomo(Piwik) トラッカー API を遠隔でクエリ（検索要求）することもできます。これは、もし HTML でも JavaScript でも実行できない環境で役に立ちます。このコードを、ユーザー行動を追跡したい場所のコードに貼り付けてください。
貼り付ける位置はどこでも構いません。

<?php 
$piwikTracker = new Matomo(Piwik)Tracker( $idSite = {$IDSITE} );
// You can manually set the visitor details (resolution, time, plugins, etc.) 
// See all other ->set* functions available in the PiwikTracker.php file
$piwikTracker->setResolution(1600, 1400);

// Sends Tracker request via http
$piwikTracker->doTrackPageView('Document title of current page view');

// You can also track Goal conversions
$piwikTracker->doTrackGoal($idGoal = 1, $revenue = 42);
?>

さらに詳細をお知りになりたい方は、Matomo(Piwik) トラッキング HTTP API または、PHP クライアントをご確認ください。

詳細情報

※この記事はMatomo(Piwik)公式サイト2014年10月1日時点の内容です
※掲載内容が古くなっている場合もありますので最新情報はMatomo(Piwik)公式サイトをご覧ください。

オリジナルの記事はこちら
http://matomo.org/docs/tracking-api/

技術情報

トラッキングウェブ API のための JavaScript クライアント

トラッキングウェブ API クライアント

トラッキングウェブ API リファレンス

php クライアントを使用したトラッキングデータの使用事例

詳細情報