開発者向け Matomo Tracking API サンプル (PHP SDK)

2025年01月21日 API 追跡API 開発者向け使用例

お好きなプログラミング言語を使ってMatomo Tracking APIを呼び出すことができます。

例として、以下の手順で PHP Tracking Web API クライアントを使用します。

MatomoTracker.phpをダウンロードするには、ここをクリックしてください。(このリンクを右クリックしてSave Page As)
プロジェクトファイルと同じパスにMatomoTracker.phpファイルをアップロードします。
以下のコードをコピーし、追跡したいすべてのページに貼り付けます。以下では、{$IDSITE}をあなたのマトモウェブサイトIDに置き換え、https://matomo.example.org/ をあなたのマトモURLに置き換えてください。
```
<?php 
// -- Matomo Tracking API init -- 
require_once "/path/to/MatomoTracker.php";
MatomoTracker::$URL = 'https://matomo.example.org/';
?>
```

トラッキング方法を選択し、トラッキングしたいすべてのページにコードを貼り付けます。

方法1：高度なイメージトラッカー
クライアントは、HTMLコード内にラップされたトラッキングURLを生成するために使用されます。
このコードをページ内のコードの前に貼り付ける。

<?php 
// Example 1: Tracks a pageview for Website id = {$IDSITE}
echo '<img src="'. str_replace("&","&amp;", Matomo_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;", Matomo_getUrlTrackGoal( $idSite = {$IDSITE}, $idGoal = 2, $customRevenue = 39)) . '" alt="" />';
?>

Advanced Image Trackerの方法は、標準のJavascript Trackingコードを使用する方法と似ています。ただし、一部のユーザー設定は検出されません（解像度、ローカル時間、プラグイン、クッキーのサポート）。

方法2：HTTPリクエスト
また、Matomo (Piwik) Tracker APIにHTTP経由でリモートから問い合わせることもできます。これはHTMLやJavascriptを実行できない環境で便利です。
このコードを、ユーザーとのインタラクションを追跡したいコードの任意の場所に貼り付けてください。

<?php 
$matomoTracker = new MatomoTracker( $idSite = {$IDSITE} );

// Specify an API token with at least Write permission, so the Visitor IP address can be recorded 
// Learn more about token_auth: https://matomo.org/faq/general/faq_114/
$matomoTracker->setTokenAuth('my_token_auth_value_here');

// You can manually set the visitor details (resolution, time, plugins, etc.) 
// See all other ->set* functions available in the MatomoTracker.php file
$matomoTracker->setResolution(1600, 1400);

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

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

Matomo トラッキング HTTP APIまたはPHPクライアントについての詳細はこちらをご覧ください

技術情報

例として、以下の手順で PHP Tracking Web API クライアントを使用します。