Google Tag ManagerとAnalyticsにカスタムイベントをプッシュする

[Integrating Google Tag Manager with Google Analytics](https://meta.discourse.org/t/integrating-google-tag-manager-with-google-analytics/47335) からの議論を継続します。

カスタムイベントを Google Tag Manager および Analytics にプッシュする

:bookmark: このガイドでは、Discourse サイトを設定してカスタムイベントを Google Tag Manager (GTM) および Google Analytics に送信し、特定のユーザー操作を追跡する方法について説明します。

:person_raising_hand: 必要なユーザーレベル: 管理者

前提条件

カスタムイベントを実装する前に、以下のことを確認してください。

  1. Setup Google Tag Manager for Analytics ガイドに従って、Discourse サイトに Google Tag Manager を設定したこと
  2. サイトの gtm container id 設定に GTM コンテナ ID を追加したこと
  3. Google スクリプトを許可するようにサイトの content security policy script src 設定を更新したこと

カスタムイベントの追加

テーマコンポーネントの作成

  1. 管理 (Admin) > カスタマイズ (Customize) > コンポーネント (Components) に移動します
  2. 「新規 (New)」をクリックし、「新規コンポーネントの作成 (Create new component)」を選択します
  3. コンポーネントに名前を付けます
  4. JS タブを選択し、コードを追加します。たとえば、以下のコードは appEvent トリガーを取得し、次のイベントを dataLayer にプッシュします。
  • post:liked
  • post:created
  • topic:created
import { apiInitializer } from "discourse/lib/api";

export default apiInitializer((api) => {
  window.dataLayer = window.dataLayer || [];

  // トピックへの「いいね」を追跡
  api.onAppEvent("page:like-toggled", (post, likeAction) => {
    let topic = post.topic;
    if (post && topic && likeAction && likeAction.acted) {
      window.dataLayer.push({
        'event': 'postLiked',
        'postId': post.id
      });
    }
  });

  // 新しい投稿を追跡
  api.onAppEvent("post:created", post => {
    if (post) {
      window.dataLayer.push({
        'event': 'postCreated',
        'postId': post.id
      });
    }
  });

  // 新しいトピックを追跡
  api.onAppEvent("topic:created", (post, composerModel) => {
    if (post) {
      window.dataLayer.push({
        'event': 'topicCreated',
        'topicCategory': composerModel.get("category.name"),
        'topicId': post.topic_id
      });
    }
  });
});
  1. コンポーネントを保存します
  2. サイト上のアクティブなすべてのテーマにコンポーネントを追加します

利用可能なイベント

利用可能なトリガーイベントはすべてこちらに記載されています: AppEvents triggers reference

GTM の設定

トリガーの作成

  1. https://tagmanager.google.com/ にアクセスします
  2. サイドメニューから「トリガー (Triggers)」を選択します
  3. 「新規 (New)」をクリックします
  4. トリガーに名前を付けます
  5. トリガータイプとして「カスタムイベント (Custom Event)」を選択します
  6. イベント名を入力します (例: postCreated)
  7. トリガーが「すべてのカスタムイベント (All Custom Events)」で発生するように設定します

データレイヤー変数の作成

  1. GTM のサイドメニューから「変数 (Variables)」を選択します
  2. ユーザー定義変数 (User-Defined Variables) セクションで「新規 (New)」をクリックします
  3. 変数に名前を付けます
  4. 変数タイプとして「データレイヤー変数 (Data Layer Variable)」を選択します
  5. データレイヤー変数名を入力します (例: postCreated)
  6. データレイヤーのバージョンを「バージョン 2 (Version 2)」に設定します

イベント追跡用の Google タグの作成

:information_source: 2024年現在、推奨されるアプローチは、古い「Google Analytics: GA4 イベント」タグタイプではなく、新しい「Google タグ (Google Tag)」テンプレートを使用することです。「Google タグ」は GA4 との統合が改善され、同意モード v2 のサポートが組み込まれています。

  1. GTM のサイドメニューから「タグ (Tags)」を選択します
  2. 「新規 (New)」をクリックします
  3. タグに名前を付けます (例: 「GT - Post Created」)
  4. タグ設定 (Tag Configuration) の下:
    • 「Google タグ (Google Tag)」を選択します
    • GA4 設定を選択します (これが最初のタグの場合は新しいものを設定します)
    • 「イベント名 (Event Name)」には、GA4 の命名規則に従った説明的な名前を入力します (例: post_created)
    • 「設定パラメータ (Configuration settings)」の下で、「行を追加 (Add Row)」をクリックしてデータレイヤー変数を含めます。
      • 設定パラメータ: (例: postId)
      • 値: データレイヤー変数 (例: {{postCreated}})
  5. 「トリガー (Triggering)」の下:
    • 事前に作成したカスタムイベントトリガーを選択します

:warning: 現在「Google Analytics: GA4 イベント」タグを使用している場合、それらは引き続き機能しますが、新しい実装では将来の互換性と機能向上のために「Google タグ」テンプレートを使用する必要があります。

イベント名の要件

GA にはイベント名に関する特定の要件があります。

  • snake_case (アンダースコアで区切られた小文字) を使用します
  • 最大長は 40 文字
  • 英数字とアンダースコアのみを含めることができます

Google タグのテスト

  1. GTM で「プレビュー (Preview)」ボタンをクリックします
  2. Discourse サイトに移動します
  3. 追跡したい操作を実行します (例: 投稿を作成する)
  4. GTM のプレビューモードで:
    • カスタムイベントが左側のパネルに表示されていることを確認します
    • Google タグが正しく発火したことを確認します
    • すべてのパラメータが期待どおりに渡されていることを確認します
  5. Google Analytics で:
    • 「設定 (Configure)」>「イベント (Events)」に移動します
    • カスタムイベントは、トリガーされた後にリストに表示されるはずです
    • 注意: 新しいイベントが GA4 レポートに表示されるまで最大 24 時間かかる場合があります

:information_source: テスト中にリアルタイムのイベントデータを確認するには、GA4 DebugView を使用できます。

トラブルシューティング

GTM でイベントが表示されない場合:

  1. Discourse で GTM コンテナ ID が正しく設定されているか確認します
  2. テーマコンポーネントがすべての有効なテーマに追加されていることを確認します
  3. イベントが発火していることを確認するために console.log ステートメントを追加します。
api.onAppEvent("post:created", post => {
  console.log("post:created event triggered");
  if (post) {
    window.dataLayer.push({
      'event': 'postCreated',
      'postId': post.id
    });
  }
});
  1. Chrome 拡張機能 Simple Data Layer Viewer を使用してデータレイヤーを監視します
  2. コンテンツセキュリティポリシー (CSP) エラーが表示される場合は、上記の前提条件を参照し、詳細な手順については Mitigate XSS Attacks with Content Security Policy を確認してください。

:warning: サイト設定の ga universal tracking code が設定されている場合は、GTM が追跡スクリプトを処理するため、空にしてください。

「いいね!」 13