ドキュメントが一新されました!旧ドキュメントは doc.newapi.pro
New APINew API
利用ガイドインストールAPI リファレンスAIアプリケーションヘルプ&サポートビジネス協力

分析ツール設定ガイド

概要

New API は現在、一般的な分析プラットフォームとの統合をサポートしており、ユーザー行動とウェブサイトのパフォーマンスを追跡するのに役立ちます。

  • Google Analytics 4 (GA4):Googleの分析プラットフォームの最新バージョン
  • Umami Analytics:プライバシーを重視したオープンソースの分析ツール

両方の分析ツールを同時に有効にすることができ、互いに競合しません。

機能特徴

✅ コード不要の統合 - 環境変数のみで設定
✅ Webインターフェースへのスクリプト自動注入
✅ Dockerおよびスタンドアロンデプロイメントをサポート
✅ プライバシーを重視した実装方法
✅ フロントエンドコードの変更不要


Google Analytics 4 設定

1. 測定IDの取得

  1. Google Analytics にアクセス
  2. 新しいプロパティを作成するか、既存のものを選択
  3. 管理データストリーム に移動
  4. ウェブサイトのデータストリームを作成または選択
  5. 測定ID(形式:G-XXXXXXXXXX)をコピー

2. 環境変数の設定

Docker Composeを使用する場合:

docker-compose.yml ファイルを編集し、Google Analyticsの行のコメントを解除します:

environment:
  - GOOGLE_ANALYTICS_ID=G-XXXXXXXXXX # 実際の測定IDに置き換えてください

スタンドアロンデプロイメントの場合:

.env ファイルに追加するか、環境変数として設定します:

export GOOGLE_ANALYTICS_ID=G-XXXXXXXXXX

Docker Runを使用する場合:

docker run -d \
  -e GOOGLE_ANALYTICS_ID=G-XXXXXXXXXX \
  ...その他のオプション...
  calciumion/new-api:latest

3. アプリケーションの再起動

# Docker Compose
docker-compose down && docker-compose up -d

# スタンドアロンデプロイメント
# アプリケーションを直接再起動してください

Umami Analytics 設定

1. Umami認証情報の取得

オプションA:Umami Cloudを使用する

  1. Umami Cloud に登録
  2. 新しいウェブサイトを追加
  3. ウェブサイトID(UUID形式)をコピー

オプションB:Umamiをセルフホストする

  1. 独自の Umamiインスタンス をデプロイ
  2. ダッシュボードでウェブサイトを作成
  3. ウェブサイトIDスクリプトURLをコピー

2. 環境変数の設定

Docker Composeを使用する場合:

docker-compose.yml ファイルを編集します:

environment:
  - UMAMI_WEBSITE_ID=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
  # オプション:セルフホストインスタンスのみ必要
  - UMAMI_SCRIPT_URL=https://your-umami-domain.com/script.js

スタンドアロンデプロイメントの場合:

.env ファイルに追加します:

export UMAMI_WEBSITE_ID=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
export UMAMI_SCRIPT_URL=https://your-umami-domain.com/script.js  # オプション

注意: Umami Cloudを使用する場合、UMAMI_SCRIPT_URLは公式URLがデフォルトで使用されるため、設定する必要はありません。

3. アプリケーションの再起動

Google Analyticsと同様 - 変更を適用するためにアプリケーションを再起動してください。


両方の分析ツールを同時に使用する

Google AnalyticsとUmamiを同時に有効にすることができます:

environment:
  - GOOGLE_ANALYTICS_ID=G-ABC123XYZ
  - UMAMI_WEBSITE_ID=a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6
  - UMAMI_SCRIPT_URL=https://analytics.umami.is/script.js

検証

アプリケーションの再起動後:

  1. ブラウザでWebインターフェースを開く
  2. ブラウザの開発者ツール(F12)→ ネットワークタブを開く
  3. ページを更新
  4. 以下のリクエストを探します:
    • Google Analytics:https://www.googletagmanager.com/gtag/js
    • Umami:設定したスクリプトURL

ページソースコードを確認し、<head>セクションに注入されたスクリプトを探すこともできます。


故障排除

分析ツールが機能しない場合?

  1. ✅ 環境変数が正しく設定されていることを確認
  2. ✅ 変数を変更した後、アプリケーションを再起動
  3. ✅ ブラウザのコンソールエラーを確認
  4. ✅ 測定ID/ウェブサイトIDの形式が正しいことを確認
  5. ✅ 広告ブロッカーが干渉していないか確認

Dockerユーザーの場合:

# 環境変数が設定されているか確認
docker exec new-api env | grep -E "GOOGLE_ANALYTICS|UMAMI"

プライバシー考慮事項

  • Google AnalyticsはGoogleプライバシーポリシーに基づいてユーザーデータを収集します
  • Umamiはプライバシーを重視しており、個人データを収集しません
  • 分析ツールを使用する場合は、ウェブサイトにプライバシーポリシーを追加することを検討してください
  • 両方のツールは、正しく設定されていればGDPR要件に準拠しています

環境変数リファレンス

変数必須デフォルト値説明
GOOGLE_ANALYTICS_IDいいえ-Google Analytics 4 測定ID(形式:G-XXXXXXXXXX)
UMAMI_WEBSITE_IDいいえ-Umami ウェブサイトID(UUID形式)
UMAMI_SCRIPT_URLいいえhttps://analytics.umami.is/script.jsUmami スクリプトURL(セルフホストのみ必要)

関連リンク

このガイドはいかがですか?

最終更新