# GA4のform_submitと送信成功を区別して計測する

## サマリ

- GA4の`form_submit`の増加が、問い合わせの受付件数の増加とは限らない
  - JavaScriptで送信を制御するフォームでは、入力エラーやAPIの失敗を成功と区別する必要がある
  - フォームの操作を検出するイベントを、業務上の受付成功と同一視しない
- JavaScriptで入力を検証するフォームでは、送信操作の後に受付結果が確定する
  - 入力エラーによる送信中止とAPIのエラー応答を、受付成功と区別する
  - ブラウザの`submit`イベントとGA4の`form_submit`も別のイベントである
- 受付の成功後だけ`generate_lead`を送信し、GTMからGA4へ転送する
  - 自動収集の`form_submit`とは別名にし、失敗した送信では成功イベントを発生させない
  - `dataLayer`への追加、GTMのタグ発火、GA4への到達を個別に確認する

## 前提となるフォームの計測

### 拡張計測のフォームイベント

拡張計測はGoogleタグがページ上の操作を自動で収集する機能である。
フォームではセッション内で最初に操作したときの`form_start`と、[フォームを送信したときの`form_submit`](https://support.google.com/analytics/answer/9216061?hl=ja) を収集する。
これはGA4の計測イベントであり、ブラウザ上のDOMイベントである`submit`とは別のものである。
フォームの操作を把握するためのイベントで、受付APIの応答内容を定義したものではない。

### dataLayerとGTMのカスタムイベント

`dataLayer`はページのJavaScriptからGTMへイベントや値を受け渡しするためのキューである。
`dataLayer.push({ event: "generate_lead" })`のように名前を指定すると、GTMは [カスタムイベントトリガー](https://support.google.com/tagmanager/answer/7679219?hl=ja) で対応するタグを発火させられる。
キューへの追加と、GA4への送信は別の処理になる。

### キーイベント

キーイベントはGA4で事業上重要な行動として指定したイベントである。
問い合わせの受付を成果にするなら、その受付のイベントを [キーイベントとしてマークする](https://support.google.com/analytics/answer/9267568?hl=ja)。
イベントの発生条件はアプリケーションが実装し、GA4側での指定とは区別して管理する。

## submitの後に入力検証とAPI応答の判定が続く

`form_submit`の件数を受付件数として扱うと、失敗した送信操作まで成果に含まれる。
自社の問い合わせフォームでも、ある月の`form_submit`の集計件数が実際の完了件数を上回っていた。
ブラウザの標準検証を無効にし、JavaScriptで入力を検証してからAPIへ送信する構成だった。
当時の記録では、入力検証による送信中止、bot対策の未完了、APIのエラー応答も`form_submit`に計上されていた。
この集計では、問い合わせの受付が増加したのか、失敗した送信操作が増加したのかを区別できなかった。

`submit`イベントは受付APIの結果が判明する前に発生する。
[`preventDefault()`](https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault) はデフォルトの送信動作を中止するが、イベントの発生自体を無効化する操作ではない。
JavaScript側が入力検証で処理を終了しても、`submit`が発生した事実は変化しない。
一方、HTMLの`required`などによる[標準検証に失敗すると、`submit`イベントは発生しない](https://developer.mozilla.org/en-US/docs/Web/API/HTMLFormElement/submit_event)。
入力エラーなら常に同じ自動イベントが発生する、という扱いは誤りになる。

自分のフォームを診断するには、GTMのプレビューモードで接続し、入力エラーになる送信を1回行う。
ブラウザの開発者ツールのNetworkで受付APIへのリクエストを確認し、同じ操作でGA4の`form_submit`も記録されたかをDebugViewで確認する。
受付APIが呼ばれていないのに記録されていれば、そのイベントを受付成功の代わりにはできない。
APIが呼ばれた場合は失敗応答でも記録されるかを確認する。

成功イベントを追加した後の処理順は次のようになる。
下図の計測点はAPIの成功応答の後であり、送信ボタンの操作時ではない。

```mermaid
sequenceDiagram
    participant F as フォーム
    participant A as 受付API
    participant D as dataLayer
    Note over F: submit発生後に入力を検証
    alt 入力エラー
        Note over F: APIへ送信せず終了
    else 入力が有効
        F->>A: 問い合わせを送信
        alt APIが失敗応答
            A-->>F: 受付失敗
            Note over F: generate_leadを追加しない
        else APIが成功応答
            A-->>F: 受付成功
            F->>D: generate_leadを追加
        end
    end
```

## APIの成功後にgenerate_leadを追加する

成功イベントには問い合わせなどによる [見込み客の生成を示す推奨イベント名`generate_lead`](https://developers.google.com/analytics/devguides/collection/ga4/reference/events?hl=en#generate_lead) を採用した。
自動収集の`form_submit`と同じ名前で成功イベントを送信すると、両方の意味が1つの集計に混在する。
別名にすれば拡張計測の停止とアプリケーションの変更を同時に行わずに移行できる。

掲載するコードは、`/api/contact`がHTTP 2xxを返したときだけ受付成功とみなす。
bot対策などで受付を却下しても200を返すAPIには、この判定をそのまま使用しない。
その場合はレスポンス内の業務上の成功値で分岐する。

CRMへの登録完了を計測したい場合も、CRMの結果が確定する地点を別に決定する。

フォームのページに入力欄を定義し、そのページから`article.js`をロードする。
`novalidate`を指定し、入力検証はJavaScript側で行う。

```html
<form id="contact" method="post" action="/api/contact" novalidate>
  <label>メール <input name="email" type="email" required></label>
  <label>お問い合わせ <textarea name="message" required></textarea></label>
  <button type="submit">送信</button>
  <p id="status" role="status"></p>
</form>
<script src="./article.js" defer></script>
```

`article.js`では、検証とAPI応答の判定を通過した地点にだけ`push`を配置する。

```javascript
const form = document.querySelector("#contact");
const status = document.querySelector("#status");
const button = form.querySelector('[type="submit"]');
window.dataLayer = window.dataLayer || [];
let pending = false;

form.addEventListener("submit", async (event) => {
  event.preventDefault();
  if (pending) return;
  // novalidateなので、submit後にアプリ側で入力値を検査する。
  if (!form.checkValidity()) {
    status.textContent = "validation_error";
    return;
  }
  const data = new FormData(form);
  pending = true;
  button.disabled = true;
  status.textContent = "pending";
  try {
    const response = await fetch("/api/contact", {
      method: "POST",
      headers: { "Content-Type": "application/json" },
      body: JSON.stringify(Object.fromEntries(data)),
    });
    if (!response.ok) {
      status.textContent = "api_error";
      return;
    }
    // /api/contact は受付に成功したときだけ 2xx を返す。CRM への登録完了までは表さない。
    window.dataLayer.push({ event: "generate_lead", form_type: "contact" });
    status.textContent = "success";
  } catch {
    status.textContent = "network_error";
  } finally {
    pending = false;
    button.disabled = false;
  }
});
```

HTTP 400や500では`api_error`、通信自体の失敗では`network_error`になり、成功イベントを追加しない。

`pending`は応答待ちの連打による重複送信を抑止するために使用している。
送信完了後の別の送信まで同一とみなす処理ではない。

bot対策のあるフォームでは、その検証も成功イベントより前に完了させる。

完了ページへ遷移する実装では、遷移前にキューへ追加するが、追加しただけでGA4への配送が保証されるわけではない。

メールアドレスや問い合わせ本文は受付APIへ送信し、計測イベントには含めない。
イベントの`form_type`はフォームの分類を示す固定値にし、[個人情報や自由入力をGA4へ送信しない](https://support.google.com/analytics/answer/6366371?hl=ja)。

## GTMで成功イベントをGA4へ転送する

`dataLayer`へ追加したイベントをGA4へ送信するには、GTM側にもタグが必要である。
対象サイトのGTMコンテナに、次の変数・トリガー・タグを作成する。
Googleタグは対象のGA4データストリームに設定済みのものを使用する。
GTMの編集・公開権限と、GA4のキーイベント設定を変更する権限が必要である。

| 作成するもの | 項目 | 設定値 |
|---|---|---|
| データレイヤーの変数 | 変数名 | `DLV - form_type` |
| 同上 | データレイヤーの変数名 | `form_type` |
| 同上 | バージョン | 2 |
| カスタムイベントトリガー | イベント名 | `generate_lead` |
| 同上 | 発生場所 | すべてのカスタムイベント |
| GA4イベントタグ | 測定ID | 対象のGoogleタグと同じ`G-…` |
| 同上 | イベント名 | `generate_lead` |
| 同上 | イベントパラメータ | `form_type` = `{{DLV - form_type}}` |
| 同上 | 配信トリガー | 上で作成したカスタムイベントトリガー |

[`event`とパラメータは同じ`push`で指定する](https://developers.google.com/tag-platform/tag-manager/datalayer)。

同じ`generate_lead`を送信する既存タグがあれば、同じ操作で二重に送信しないよう発火条件を整理する。

GTMのプレビューで動作を確認してからコンテナを公開し、GA4で`generate_lead`をキーイベントに指定する。
それまで`form_submit`をキーイベントにしていた場合は、その指定を解除する。
過去の`form_submit`と新規の成功イベントは定義が異なるため、移行日を記録し、同じ指標として前後比較しない。

拡張計測のフォーム操作を無効にするだけでは、APIの成功を計測できるようにはならない。
送信ボタンのクリックをトリガーに置換する案も、入力エラーとAPIの失敗を区別できないため採用しなかった。

## 失敗時に成功イベントがないことを確認する

[DebugViewはデバッグモードを有効にした端末のイベントを表示する](https://support.google.com/analytics/answer/7201382?hl=ja)。
GTMのプレビューモードで接続した端末を使用し、対象のGA4プロパティのDebugViewで確認する。

各ケースはページを再読み込みしてから1回ずつ試し、その操作で新しく発生したイベントを確認する。
掲載した実装の確認項目と期待結果は次のとおりである。

| 操作・応答 | 受付APIへの送信 | `dataLayer`の`generate_lead` |
|---|---|---|
| 必須欄が未入力 | なし | なし |
| bot対策が未完了 | なし（送信前に検証する実装） | なし |
| APIが400や500を返す | あり | なし |
| 受付APIとの通信に失敗する | 試行あり | なし |
| 受付成功の応答を受信する | あり | 1件 |
| 成功応答を待機する間に連打する | 1件 | 応答前はなし、成功後は1件 |

APIエラーは検証用の環境で受付APIの応答を失敗に変更して確認する。
通信失敗は開発者ツールで受付APIへのリクエストだけをブロックし、入力後に送信して確認する。

各操作で、まず`dataLayer`に追加された`event`と`form_type`、GTMのプレビューに表示されたイベント名を確認する。
開発者ツールのConsoleでは、次の式で成功イベントだけを抽出できる。

```javascript
(window.dataLayer || []).filter((entry) => entry.event === "generate_lead");
```

次に、そのイベントでGA4イベントタグが1回発火し、DebugViewにも`generate_lead`が1件到達したことを確認する。
キューに1件しかないのにGA4へ複数届くなら、GTMのタグや別の送信コードの重複を調査する。

公開後も同じ期間・同じフォームの受付記録と成功イベントを比較する。
ユーザーの同意やブラウザでの通信遮断による欠落があるため、GA4の件数を受付記録の代わりにはしない。
失敗時に成功イベントが発生したり、1回の操作から複数回送られたりする状態を検出するために、フォーム改修時にも同じケースを確認する。
