このガイドでは、Google アナリティクス Measurement Protocol のウェブとアプリのストリーム イベントを Google アナリティクス サーバーに送信し、Measurement Protocol イベントを Google アナリティクスのレポートで確認できるようにする方法を説明します。
このガイドで説明を希望するプラットフォームを選択してください。
リクエストを整形する
Google アナリティクス Measurement Protocol でサポートされるのは、HTTP POST
リクエストのみです。
イベントを送信するには、次の形式を使用してください。
POST /mp/collect HTTP/1.1
HOST: www.google-analytics.com
Content-Type: application/json
<payload_data>
リクエスト URL に次の情報を必ず含めてください。
api_secret
: Google アナリティクス管理画面で生成される API Secret。新しい Secret を作成するには、[管理] > [データ ストリーム] > ストリームを選択 > [Measurement Protocol] > [作成] の順にクリックします。
measurement_id
: ストリームに関連付けられた測定 ID。この ID は、Google アナリティクス管理画面の [管理] > [データ ストリーム] > ストリームを選択 > [測定 ID] で確認できます。measurement_id
は、ストリーム ID ではありません。
詳しくは、クエリ パラメータをご覧ください。
リクエスト本文には、次の情報を必ず含めてください。
client_id
: クライアントの一意の識別子。これは、Firebase のapp_instance_id
とは異なります。gtag.js('get') を使用してください。
user_id
: 省略可。ユーザーの一意の識別子。使用できるのは UTF-8 の文字のみです。この識別子について詳しくは、クロスプラットフォーム分析用の User-ID をご覧ください。consent
: 省略可。同意設定の設定方法をご確認ください。timestamp_micros
: 省略可。リクエストに含めるイベントとユーザー プロパティの Unix エポック時間(マイクロ秒単位)。指定しない場合、デフォルトでリクエストの日時が使用されます。events
: イベント項目の配列。1 つのリクエストに複数のイベントを含めることができます。ユーザー アクティビティをリアルタイム レポートなどのレポートに表示するには、
event
のparams
の要素としてengagement_time_msec
とsession_id
を指定する必要があります。engagement_time_msec
パラメータは、イベントのエンゲージメント時間(ミリ秒単位)を示す必要があります。次の例をご覧ください。
{
"client_id": "123456.7654321",
"events": [
{
"name": "campaign_details",
"params": {
"campaign_id": "google_1234",
"campaign": "Summer_fun",
"source": "google",
"medium": "cpc",
"term": "summer+travel",
"content": "logolink",
"session_id": "123",
"engagement_time_msec": 100
}
}
]
}
session_start
は予約済みのイベント名ですが、新しい session_id
を作成すると、session_start
を送信しなくても新たなセッションを作成できます。セッション数のカウント方法を理解しましょう。
試してみる
複数のイベントを一度に送信する例を次に示します。この例では、tutorial_begin
イベントと join_group
イベントを Google アナリティクス サーバーに送信します。
const measurement_id = `G-XXXXXXXXXX`;
const api_secret = `<secret_value>`;
fetch(`https://www.google-analytics.com/mp/collect?measurement_id=${measurement_id}&api_secret=${api_secret}`, {
method: "POST",
body: JSON.stringify({
client_id: "XXXXXXXXXX.YYYYYYYYYY",
events: [
{
name: "tutorial_begin",
params: {
"session_id": "123",
"engagement_time_msec": 100
}
},
{
name: "join_group",
params: {
"group_id": "G_12345",
"session_id": "123",
"engagement_time_msec": 150
}
}
]
})
});
タイムスタンプのオーバーライド
Measurement Protocol は、リクエスト内の各イベントについて、次のリストで最初に見つかったタイムスタンプを使用します。
- イベントの
timestamp_micros
。 - リクエストの
timestamp_micros
。 - Measurement Protocol がリクエストを受信した時刻。
次の例では、リクエスト内のすべてのイベントに適用されるリクエストレベルのタイムスタンプを送信します。その結果、Measurement Protocol は tutorial_begin
イベントと join_group
イベントの両方に requestUnixEpochTimeInMicros
のタイムスタンプを割り当てます。
{
"timestamp_micros": requestUnixEpochTimeInMicros,
"events": [
{
"name": "tutorial_begin"
},
{
"name": "join_group",
"params": {
"group_id": "G_12345",
}
}
]
}
次の例では、リクエストレベルのタイムスタンプとイベントレベルのタイムスタンプの両方を送信します。その結果、Measurement Protocol は tutorial_begin
イベントに tutorialBeginUnixEpochTimeInMicros
のタイムスタンプを割り当て、join_group
イベントに requestUnixEpochTimeInMicros
のタイムスタンプを割り当てます。
{
"timestamp_micros": requestUnixEpochTimeInMicros,
"events": [
{
"name": "tutorial_begin",
"timestamp_micros": tutorialBeginUnixEpochTimeInMicros
},
{
"name": "join_group",
"params": {
"group_id": "G_12345",
}
}
]
}
制限事項
Measurement Protocol イベントを Google アナリティクスに送信する際には、次の制限が適用されます。
- リクエスト内で指定できるイベントは 25 個までです。
- イベント内で指定できるパラメータは 25 個までです。
- イベント内で指定できるユーザー プロパティは 25 個までです。
- ユーザー プロパティ名は半角 24 文字(全角 12 文字)以下にする必要があります。
- ユーザー プロパティ値は半角 36 文字(全角 18 文字)以下にする必要があります。
- イベント名は半角 40 文字以下にして、先頭を英字にする必要があります。使用できる文字は英数字とアンダースコアのみです。
- アイテム パラメータなどのパラメータ名は半角 40 文字以下にして、先頭を英字にする必要があります。使用できる文字は英数字とアンダースコアのみです。
- アイテム パラメータなどのパラメータ値は、標準の Google アナリティクス プロパティの場合は 100 文字以下、Google アナリティクス 360 プロパティの場合は 500 文字以下にする必要があります。
- アイテム パラメータに指定できるカスタム パラメータの数は 10 個までです。
- POST 本文は 130 KB 未満にする必要があります。
- Google アナリティクスに送信されるアプリの Measurement Protocol イベントでは、アプリユーザーについて、Google 広告で検索ユーザーは入力されません。
各ユースケースの追加要件については、一般的なユースケースをご覧ください。