ヒットの検証 - Measurement Protocol

このドキュメントでは、Google アナリティクスの Measurement Protocol のヒットを検証する方法について説明します。

概要

Measurement Protocol ヒットの形式が正しくない場合や、必要なパラメータがない場合でも、Google アナリティクス Measurement Protocol は HTTP エラーコードを返しません。ヒットの形式が正しいこと、必要なパラメータがすべて含まれていることを確認するには、ヒットを本番環境にデプロイする前に検証サーバーでテストします。

このガイドでは、Measurement Protocol 検証サーバーにヒットを送信するプロセスと、そのレスポンスを解釈する方法について説明します。

検証用にヒットを送信する

ヒットは、現在 Measurement Protocol でサポートされている方法で、Measurement Protocol 検証サーバーに送信できます。異なる点は URL だけです。ヒットを Measurement Protocol 検証サーバーに送信するには、エンドポイント /collect ではなく /debug/collect エンドポイントを使用します。Measurement Protocol 検証サーバーに送信された無効なヒットの例を次に示します。

https://www.google-analytics.com/debug/collect?tid=fake&v=1

Measurement Protocol ヒットの作成方法について詳しくは、プロトコルのリファレンスをご覧ください。

レスポンスの解釈

Measurement Protocol 検証サーバーからのレスポンスは JSON 形式です。次の例は、上記のヒットに対するレスポンスを示しています。

{
  "hitParsingResult": [
    {
      "valid": false,
      "hit": "GET /debug/collect?tid=fake\u0026v=1 HTTP/1.1",
      "parserMessage": [
        {
          "messageType": "ERROR",
          "description": "The value provided for parameter 'tid' is invalid. Please see http://goo.gl/a8d4RP#tid for details.",
          "parameter": "tid"
        },
        {
          "messageType": "ERROR",
          "description": "Tracking Id is a required field for this hit. Please see http://goo.gl/a8d4RP#tid for details.",
          "parameter": "tid"
        }
      ]
    }
  ]
}

レスポンスのルート hitParsingResult は、元のリクエストで送信されたヒット数に対応する長さの配列です。配列内の各オブジェクトにはキー valid、hit、parserMessage が含まれます。ヒットが無効な場合、parserMessage には検証の問題を示すオブジェクトの配列が含まれます。ヒットが有効な場合、parserMessage は空の配列になります。

次の表に、hitParsingResult 配列の各項目のプロパティを示します。

キー タイプ 説明
valid Boolean 有効なヒットの場合は true、無効なヒットの場合は false。
hit string リクエストのパスのほか、そのメソッドとプロトコルを含む文字列です。
parserMessage Array パーサー メッセージのリストです。ヒットが有効な場合、この配列は空です。
parserMessage.messageType string "INFO"、"WARN"、"ERROR" のいずれかの値になります。
parserMessage.description string 検証で見つかった問題の詳細と修正手順です。
parserMessage.parameter string|undefined 検証で見つかった問題の原因となっているパラメータです（該当する場合）。