Measurement Protocol を使用してアプリイベントを GA4 に送信する

1. はじめに

最終更新日: 2021 年 6 月 8 日

作成するアプリの概要

この Codelab では、Measurement Protocol を使用して外部イベントを GA4 に送信する方法を学びます。

この Codelab では、Firebase 向け Google アナリティクスを実装済みのアプリがすでにあることを前提としています。Firebase 向け Google アナリティクスとの統合方法については、まずこちらの Codelab をご覧ください。Firebase でアプリを作成する方法については、Firebase Android Codelab - 構築に適したチャットをご覧ください。

ラボの内容

  • 初めての MP 呼び出しを行う手順
  • 呼び出しに必要なパラメータについて
  • テスト呼び出しを送信して検証する
  • Python でサンプル スクリプトを作成して呼び出す

必要なもの

  • Android または iOS アプリ
  • 変更が可能な任意の IDE
  • GA4 アカウント
  • 省略可 - Python 開発環境(または Colab

2. 必須項目を収集します

GA4 で API Secret を作成する

GA4 に移動し、[管理] > [データ ストリーム] > ストリームを選択 > [Measurement Protocol] > [作成] の順にクリックして、新しい API Secret を作成します。

6e4afca63054d291.png

c9e9ccd2ffba98eb.png

e714cd969fca4a4d.png

任意のニックネームを付けると、通話で使用できるシークレットの値が表示されます

GA4 にアクセスする方法がわからない場合は、Firebase プロジェクトにアクセスし、[プロジェクトの設定] > [統合] > [Google アナリティクス] の順に選択して、[管理] をクリックします。Google アナリティクスとの接続が表示されます。そこから直接移動することもできます。

73b4d77a57eddfba.png

app_instance_id を収集する

app_instance_id を収集するには、次のいずれかの方法を使用できます。

  1. BigQuery Export の使用
  2. アプリのソースコードでネイティブに取得する

これら 2 つの詳細については、以下で説明します。

  1. BigQuery Export の使用

BigQuery Export を有効にしている場合は、以下の手順を実施します。

  • Firebase にログインする
  • [プロジェクト設定] > [統合] > [BigQuery] に移動します。
  • [BigQuery で表示] をクリックします。データセット付近

注 : データセットは、切り替えボタンを約 24 ~ 48 時間有効にした後でのみ利用可能になります。

63d061088b622961.png

  • BigQuery では、テーブル内の user_pseudo_id を確認できます。呼び出しで使用できる app_instance_id です

4b1b80bdc2884581.png

  1. アプリのソースコード内でネイティブに取得

アプリが Java を使用してビルドされている場合は、次のようなコードを使用して app_instance_id を取得できます。

 FirebaseAnalytics.getInstance(this).getAppInstanceId().addOnCompleteListener(new OnCompleteListener<String>() {
        @Override
        public void onComplete(@NonNull Task<String> task) {
            if (task.isSuccessful()) {
                String user_pseudo_id = task.getResult();
            }
        }
    });

Kotlin の場合は、次のことを試します。

Thread {
   Firebase.analytics.appInstanceId.addOnSuccessListener { user_pseudo_id ->
       Log.d("Firebase", "user_pseudo_id using appInstanceId is $user_pseudo_id")
       /*
       Store the value to your server or do something with the retrieved id
        */
   }
}.start()

iOS アプリをお持ちの場合は、Swift で次のコードを使用できます。

let user_pseudo_id = Analytics.appInstanceID()
print("user_pseudo_id = \(user_pseudo_id)")
/*
Store the value to your server or do something with the retrieved id
*/

インフラストラクチャに応じて、以下のリンクもご覧ください。

3. 電話相談の組み立て

GA4 のイベント ビルダーを使用してサンプル呼び出しを作成できます。(ログインし、Cookie を有効にする必要があります)。切り替えボタンが [firebase] に設定されていることを確認します。

fd78d961f3e48238.png

次のフィールドに入力する必要があります。

  • api_secret - GA4 ですでに作成されている
  • firebase_app_id - 確認するには、[管理] > [データ ストリーム] > [ストリームを選択] に移動します。次のように表示されます。

19801c8e5cb29222.png

  • app_instance_id - この値はすでに取得済みです
  • user_id は必須ではありません。今は空欄のままで構いません
  • カテゴリ - プルダウンから [カスタム] に変更し、任意のイベント名を入力します(自動収集イベントは使用しないでください)。ここでは「test_from_codelab」を使用して、

54cce53df64d697.png

必要に応じて、以下のボタンをクリックして、イベント パラメータやユーザー プロパティを指定することもできます。

16a8f531a3894021.png

すべて入力すると、次のような [イベントを検証] ボタンが表示されます。

475801f25c3caf26.png

ここまで来たら、オレンジ色でハイライト表示されている [VALIDATE EVENT] ボタンをクリックします。イベントが有効であることを示す以下のメッセージが表示されます。また、[SEND TO GA] というボタンが表示されます。この時点でそのイベントが無効の場合は、問題があるフィールドが正確に示されるので、問題を修正して再試行できます。

23e4e6800705b4aa.png

これで、ボタンをクリックしてテストイベントを GA4 に送信できるようになります。

4. GA4 でイベントを検証する

イベントを送信したら、GA4 アカウントに移動して [リアルタイム] を確認できます。イベントが終了したことが

994b51ca46bb1973.png

イベントがリアルタイム ビューから [実際のイベント レポート] タブに反映されるまでに 24 時間ほどかかる場合があります。そのため、通常のイベント レポートにすぐに反映されていなくても心配はいりません。

問題や不一致が発生している場合は、Measurement Protocol の既知の制限事項をご確認ください。

5. Python スクリプトの作成

テストが完了したので、API 呼び出しとイベント ペイロードを調べて、この呼び出しを行うことができる同様のアーキテクチャを Python(または任意の言語)で構築できます。その後、任意の頻度でこの処理をスケジュールし、運用化できます。ここでは、Python をサポートする任意の IDE を使用することも、デバイスへのインストールを必要としない Google Colab ノートブックを使用することもできます。

GA4 イベント ビルダーに戻ると、エンドポイントが次のようになっていることがわかります。

POST /mp/collect?firebase_app_id=XXXX&api_secret=XXXX 
HTTP/1.1
Host: www.google-analytics.com

イベント ペイロードは次のようになります。

{
  "app_instance_id": XXXX,
  "non_personalized_ads": false,
  "events": [
    {
      "name": "test_from_codelab",
      "params": {
        "test_param": "test_123"
      }
    }
  ]
}

これを Python に変換するには、

import requests
import json
url = "https://www.google-analytics.com/mp/collect?firebase_app_id=XXXX&api_secret=XXXX"
payload = {
  "app_instance_id": XXXX,
  "non_personalized_ads": False,
  "events": [
    {
      "name": "test_from_codelab",
      "params": {
        "test_param": "test_123"
      }
    }
  ]
}
r = requests.post(url,data=json.dumps(payload),verify=True)
print(r.status_code)

適切な値で実行すると、GA4 でも同様にイベントがリアルタイムで反映されます。

6. 完了

GA4 で Measurement Protocol を正常に使用できました。強力なソリューション アーキテクチャを構築して、より有意義なデータを Google アナリティクスに送信し、マーケティング分析やビジネス分析を改善できるようになりました。これを最大限に活用するには、Google 広告に接続し、これらのイベントをコンバージョンとしてインポートすることもおすすめします。詳細な手順については、こちらの Codelab のステップ 6 をご覧ください。コンバージョン トラッキングでは、過去 60 日間に Firebase SDK から収集された IDFA またはデバイス ID に関連付けられたデータのみが表示されます。これはまだアルファ版の API であるため、こちらに記載されている制限事項をよく確認し、完全なリリース前に対処してください。

学習した内容

  • MP 呼び出しを行うために適切な変数を収集する方法
  • テストイベントを送信して検証する方法
  • MP 呼び出しを送信するスクリプトを作成する方法