Measurement Protocol の操作

このドキュメントでは、一般的なヒットを Measurement Protocol に送る方法を説明します。

概要

このドキュメントでは、Google アナリティクスの Measurement Protocol に一般的なヒットタイプを送る HTTP リクエストの作成方法を説明します。次のリファレンスもご覧ください。

必須の値の送信

ユーザー インタラクション データを送るには、次のエンドポイントに HTTP POST リクエストを送ります。

POST /collect HTTP/1.1
Host: www.google-analytics.com

payload_data

各ペイロードには次のパラメータが必要です。

v=1              // Version.
&tid=UA-XXXXX-Y  // Tracking ID / Property ID.
&cid=555         // Anonymous Client ID.
&t=              // Hit Type.

各ペイロードには有効なヒットタイプを含め、各ヒットタイプにはそれぞれ固有の必須フィールドを指定します。たとえば、/home ページのページビューを送る場合は、次のようなペイロードを使用します。

v=1&tid=UA-XXXXX-Y&cid=555&t=pageview&dp=%2Fhome

以降のセクションでは、一般的なヒットタイプの例を示します。

複数のヒットを 1 回のリクエストで一括処理

複数のヒットを 1 回のリクエストで送信するには、/collect の代わりに /batch エンドポイントを使用して、各ペイロードを独自の行に指定します。

たとえば、ウェブサイトの「ホーム」、「会社概要」、「連絡先」ページの pageview ヒットを送信するには、以下のバッチ リクエストを送信します。

POST /batch HTTP/1.1
Host: www.google-analytics.com

v=1&tid=UA-XXXXX-Y&cid=555&t=pageview&dp=%2Fhome
v=1&tid=UA-XXXXX-Y&cid=555&t=pageview&dp=%2Fabout
v=1&tid=UA-XXXXX-Y&cid=555&t=pageview&dp=%2Fcontact

バッチの制限

Measurement Protocol のヒットに関する標準的な制限に加えて、以下のようなバッチ リクエストに固有の制限があります。

  • 1 回のリクエストあたり最大 20 ヒットを指定できる。
  • 全ヒットのペイロード合計サイズは 16K バイトを超えることはできない。
  • 単一ヒットのペイロードは 8K バイトを超えることはできない。

一般的なヒットタイプの送信

下の例では、一般的なヒットタイプを Google アナリティクスに送信する方法を示しています。こうした例以外にも、さまざまなパラメータを組み合わせると、データ同士の新たな関係を見出すことができます。たとえば、イベントが発生したページを把握するには、下記に示すように pagePath パラメータ(p)をイベント トラッキング パラメータと一緒に送ります。

Google アナリティクスに送信可能なパラメータの全リストについては、パラメータのリファレンスをご覧ください。

ページ トラッキング

v=1              // Version.
&tid=UA-XXXXX-Y  // Tracking ID / Property ID.
&cid=555         // Anonymous Client ID.

&t=pageview      // Pageview hit type.
&dh=mydemo.com   // Document hostname.
&dp=/home        // Page.
&dt=homepage     // Title.

このヒットを Measurement Protocol Hit Builder で表示する。

イベント トラッキング

v=1              // Version.
&tid=UA-XXXXX-Y  // Tracking ID / Property ID.
&cid=555         // Anonymous Client ID.

&t=event         // Event hit type
&ec=video        // Event Category. Required.
&ea=play         // Event Action. Required.
&el=holiday      // Event label.
&ev=300          // Event value.

このヒットを Measurement Protocol Hit Builder で表示する。

拡張 e コマース トラッキング

拡張 e コマースのヒットは e コマースのヒットの代わりに使用します。既に e コマース トラッキングを実装済みの方が拡張 e コマース トラッキングの使用を開始する場合は、次の 2 つの方法があります。

新しいプロパティを使用する

新しいプロパティを作成し、拡張 e コマースのヒットをその新しいプロパティに送信することができます。

既存のプロパティを移行する

既存の e コマースのヒットを拡張 e コマースのヒットに移行します。下の例をご覧ください。この移行によって、過去に e コマースのヒットで収集されたトランザクション データや商品データが影響を受けることはなく、元のプロパティとビューで引き続き参照できます。

インプレッションの測定

v=1                                      // Version.
&tid=UA-XXXXX-Y                          // Tracking ID / Property ID.
&cid=555                                 // Anonymous Client ID.
&t=pageview                              // Pageview hit type.
&dh=mydemo.com                           // Document hostname.
&dp=/home                                // Page.
&dt=homepage                             // Title.

&il1nm=Search%20Results                  // Impression list 1. Required.
&il1pi1id=P12345                         // Product Impression 1 ID. Either ID or name must be set.
&il1pi1nm=Android%20Warhol%20T-Shirt     // Product Impression 1 name. Either ID or name must be set.
&il1pi1ca=Apparel%2FT-Shirts             // Product Impression 1 category.
&il1pi1br=Google                         // Product Impression 1 brand.
&il1pi1va=Black                          // Product Impression 1 variant.
&il1pi1ps=1                              // Product Impression 1 position.
&il1pi1cd1=Member                        // Custom dimension.

&il2nm=Recommended%20Products            // Impression list 2.
&il2pi1nm=Yellow%20T-Shirt               // Product Impression 1 name.
&il2pi2nm=Red%20T-Shirt                  // Product Impression 2 name.

このヒットを Measurement Protocol Hit Builder で表示する。

アクションの測定

v=1                                   // Version.
&tid=UA-XXXXX-Y                       // Tracking ID / Property ID.
&cid=555                              // Anonymous Client ID.
&t=event                              // Event hit type.
&ec=UX                                // Event Category. Required.
&ea=click                             // Event Action. Required.
&el=Results                           // Event label.

&pa=click                             // Product action (click). Required.
&pal=Search%20Results                 // Product Action List.
&pr1id=P12345                         // Product 1 ID. Either ID or name must be set.
&pr1nm=Android%20Warhol%20T-Shirt     // Product 1 name. Either ID or name must be set.
&pr1ca=Apparel                        // Product 1 category.
&pr1br=Google                         // Product 1 brand.
&pr1va=Black                          // Product 1 variant.
&pr1ps=1                              // Product 1 position.
    

このヒットを Measurement Protocol Hit Builder で表示する。

インプレッションとアクションの併合

v=1                                   // Version.
&tid=UA-XXXXX-Y                       // Tracking ID /  Property ID.
&cid=555                              // Anonymous Client ID.
&t=event                              // Event hit type.
&ec=UX                                // Event Category. Required.
&ea=click                             // Event Action. Required.
&el=Results                           // Event label.

&pa=detail                            // Product action (detail). Required.
&pr1id=P12345                         // Product 1 ID. Either ID or name must be set.
&pr1nm=Android%20Warhol%20T-Shirt     // Product 1 name. Either ID or name must be set.
&pr1ca=Apparel                        // Product 1 category.
&pr1br=Google                         // Product 1 brand.
&pr1va=Black                          // Product 1 variant.
&pr1ps=1                              // Product 1 position.

&il1nm=Related%20Products             // Impression list.
&il1pi1id=P12345                      // Product Impression 1 ID.
&il1pi1nm=Android%20Warhol%20T-Shirt  // Product Impression 1 name.
&il1pi1ca=Apparel%2FT-Shirts          // Product Impression 1 category.
&il1pi1br=Google                      // Product Impression 1 brand.
&il1pi1va=Black                       // Product Impression 1 variant.
&il1pi1ps=1                           // Product Impression 1 position.
   

このヒットを Measurement Protocol Hit Builder で表示する。

購入の測定

v=1                                   // Version.
&tid=UA-XXXXX-Y                       // Tracking ID / Property ID.
&cid=555                              // Anonymous Client ID.
&t=pageview                           // Pageview hit type.
&dh=mydemo.com                        // Document hostname.
&dp=/receipt                          // Page.
&dt=Receipt%20Page                    // Title.

&ti=T12345                            // Transaction ID. Required.
&ta=Google%20Store%20-%20Online       // Affiliation.
&tr=37.39                             // Revenue.
&tt=2.85                              // Tax.
&ts=5.34                              // Shipping.
&tcc=SUMMER2013                       // Transaction coupon.

&pa=purchase                          // Product action (purchase). Required.
&pr1id=P12345                         // Product 1 ID. Either ID or name must be set.
&pr1nm=Android%20Warhol%20T-Shirt     // Product 1 name. Either ID or name must be set.
&pr1ca=Apparel                        // Product 1 category.
&pr1br=Google                         // Product 1 brand.
&pr1va=Black                          // Product 1 variant.
&pr1ps=1                              // Product 1 position.
    

このヒットを Measurement Protocol Hit Builder で表示する。

払い戻しの測定

払い戻しデータをイベントを使って送る必要があり、オンサイトで標準的に測定する行動としてイベントが含まれていない(ユーザーが開始するイベントではない)場合は、非インタラクション イベントを使って送ることをおすすめします。そうすれば、直帰率やセッション継続時間といった指標はイベントの影響を受けません。

 // Refund an entire transaction and send with a non-interaction event.
v=1                                   // Version.
&tid=UA-XXXXX-Y                       // Tracking ID / Property ID.
&cid=555                              // Anonymous Client ID.
&t=event                              // Event hit type.
&ec=Ecommerce                         // Event Category. Required.
&ea=Refund                            // Event Action. Required.
&ni=1                                 // Non-interaction parameter.

&ti=T12345                            // Transaction ID. Required.
&pa=refund                            // Product action (refund). Required.
    

このヒットを Measurement Protocol Hit Builder で表示する。

 // Refund a single product.
v=1                                   // Version.
&tid=UA-XXXXX-Y                       // Tracking ID / Property ID.
&cid=555                              // Anonymous Client ID.
&t=event                              // Event hit type.
&ec=Ecommerce                         // Event Category. Required.
&ea=Refund                            // Event Action. Required.
&ni=1                                 // Non-interaction parameter.

&ti=T12345                            // Transaction ID. Required.
&pa=refund                            // Product action (refund). Required.
&pr1id=P12345                         // Product 1 ID. Required.
&pr1qt=1                              // Product 1 quantity. Required.
    

このヒットを Measurement Protocol Hit Builder で表示する。

決済プロセスの測定

1. 決済ステップの測定
v=1                                   // Version.
&tid=UA-XXXXX-Y                       // Tracking ID / Property ID.
&cid=555                              // Anonymous Client ID.
&t=pageview                           // Pageview hit type.
&dh=mydemo.com                        // Document hostname.
&dp=/checkout                         // Page.
&dt=Checkout                          // Title.

&pa=checkout                          // Product action (checkout).
&pr1id=P12345                         // Product 1 ID. Either ID or name must be set.
&pr1nm=Android%20Warhol%20T-Shirt     // Product 1 name. Either ID or name must be set.
&pr1ca=Apparel                        // Product 1 category.
&pr1br=Google                         // Product 1 brand.
&pr1va=Black                          // Product 1 variant.
&pr1pr=29.20                          // Product 1 Price.
&pr1qt=1                              // Product 1 quantity.
&cos=1                                // Checkout step #1.
&col=Visa                             // Checkout step option.
    

このヒットを Measurement Protocol Hit Builder で表示する。

2. 決済オプションの測定
v=1                                   // Version.
&tid=UA-XXXXX-Y                       // Tracking ID / Property ID.
&cid=555                              // Anonymous Client ID.
&t=event                              // Event hit type
&ec=Checkout                          // Event Category. Required.
&ea=Option                            // Event Action. Required.

&pa=checkout_option                   // Product action (checkout_option).
&cos=2                                // Checkout step.
&col=FedEx                            // Checkout step option.
    

このヒットを Measurement Protocol Hit Builder で表示する。

社内プロモーションの測定

プロモーションのインプレッション
v=1                                      // Version.
&tid=UA-XXXXX-Y                          // Tracking ID / Property ID.
&cid=555                                 // Anonymous Client ID.
&t=pageview                              // Pageview hit type.
&dh=mydemo.com                           // Document hostname.
&dp=/home                                // Page.
&dt=homepage                             // Title.

&promo1id=PROMO_1234                     // Promotion 1 ID. Either ID or name must be set.
&promo1nm=Summer%20Sale                  // Promotion 1 name. Either ID or name must be set.
&promo1cr=summer_banner2                 // Promotion Creative.
&promo1ps=banner_slot1                   // Promotion Position.
    

このヒットを Measurement Protocol Hit Builder で表示する。

プロモーションのクリック
v=1                                   // Version.
&tid=UA-XXXXX-Y                       // Tracking ID / Property ID.
&cid=555                              // Anonymous Client ID.
&t=event                              // Event hit type
&ec=Internal%20Promotions             // Event Category. Required.
&ea=click                             // Event Action. Required.
&el=Summer%20Sale                     // Event label.

&promoa=click                         // Promotion action (click). Required.
&promo1id=PROMO_1234                  // Promotion 1 ID. Either ID or name must be set.
&promo1nm=Summer%20Sale               // Promotion 1 name. Either ID or name must be set.
&promo1cr=summer_banner2              // Promotion Creative.
&promo1ps=banner_slot1                // Promotion Position.
    

このヒットを Measurement Protocol Hit Builder で表示する。

e コマース トラッキング

e コマースデータを送るには、1 つのトランザクション全体を表す transaction ヒットを 1 つ送り、その後でそのトランザクションの各アイテムについて item ヒットを送ります。トランザクション ID(ti)ですべてのヒットが結び付けられ、その購入の全容を表します。

トランザクション ヒット

v=1               // Version.
&tid=UA-XXXXX-Y   // Tracking ID / Property ID.
&cid=555          // Anonymous Client ID.

&t=transaction    // Transaction hit type.
&ti=12345         // transaction ID. Required.
&ta=westernWear   // Transaction affiliation.
&tr=50.00         // Transaction revenue.
&ts=32.00         // Transaction shipping.
&tt=12.00         // Transaction tax.
&cu=EUR           // Currency code.

このヒットを Measurement Protocol Hit Builder で表示する。

商品ヒット

v=1               // Version.
&tid=UA-XXXXX-Y   // Tracking ID / Property ID.
&cid=555          // Anonymous Client ID.

&t=item           // Item hit type.
&ti=12345         // Transaction ID. Required.
&in=sofa          // Item name. Required.
&ip=300           // Item price.
&iq=2             // Item quantity.
&ic=u3eqds43      // Item code / SKU.
&iv=furniture     // Item variation / category.
&cu=EUR           // Currency code.

このヒットを Measurement Protocol Hit Builder で表示する。

ソーシャル インタラクション

v=1              // Version.
&tid=UA-XXXXX-Y  // Tracking ID / Property ID.
&cid=555         // Anonymous Client ID.

&t=social        // Social hit type.
&sa=like         // Social Action. Required.
&sn=facebook     // Social Network. Required.
&st=/home        // Social Target. Required.

このヒットを Measurement Protocol Hit Builder で表示する。

例外のトラッキング

v=1              // Version.
&tid=UA-XXXXX-Y  // Tracking ID / Property ID.
&cid=555         // Anonymous Client ID.

&t=exception       // Exception hit type.
&exd=IOException   // Exception description.
&exf=1             // Exception is fatal?

このヒットを Measurement Protocol Hit Builder で表示する。

カスタム速度のトラッキング

v=1              // Version.
&tid=UA-XXXXX-Y  // Tracking ID / Property ID.
&cid=555         // Anonymous Client ID.

&t=timing        // Timing hit type.
&utc=jsonLoader  // Timing category.
&utv=load        // Timing variable.
&utt=5000        // Timing time.
&utl=jQuery      // Timing label.

 // These values are part of browser load times

&dns=100         // DNS load time.
&pdt=20          // Page download time.
&rrt=32          // Redirect time.
&tcp=56          // TCP connect time.
&srt=12          // Server response time.

このヒットを Measurement Protocol Hit Builder で表示する。

アプリやスクリーンのトラッキング

v=1                         // Version.
&tid=UA-XXXXX-Y             // Tracking ID / Property ID.
&cid=555                    // Anonymous Client ID.

&t=screenview               // Screenview hit type.
&an=funTimes                // App name.
&av=4.2.0                   // App version.
&aid=com.foo.App            // App Id.
&aiid=com.android.vending   // App Installer Id.

&cd=Home                    // Screen name / content description.

このヒットを Measurement Protocol Hit Builder で表示する。

プロキシ サーバーの使用

一部の環境では Google アナリティクスにヒットを直接送信できません。たとえば、JavaScript に対応していない旧式の携帯電話や、ファイアウォールで守られた企業のイントラネットなどがその一例です。こうした場合は、プロキシ サーバーにリクエストを送信してから、Measurement Protocol を使って Google アナリティクスに転送する方法が一般的です。

プロキシ サーバーではなくクライアント端末の IP とユーザー エージェントを収集するには、Measurement Protocol で両方の値を指定します。これらの値により、通常 Google アナリティクスがリクエスト ヘッダーから取得する値が上書きされます。

v=1              // Version.
&tid=UA-XXXXX-Y  // Tracking ID / Property ID.
&cid=555         // Anonymous Client ID.

&t=pageview      // Pageview hit type.
&uip=1.2.3.4     // IP address override.
&ua=Opera/9.80   // User agent override.

このヒットを Measurement Protocol Hit Builder で表示する。