Measurement Protocol のリファレンス

このページでは、Measurement Protocol のトランスポート メカニズムとデータ パラメータについて説明します。

トランスポート

すべてのデータは、HTTPS POST リクエストを使用して安全に送信する必要があります。

次のエンドポイントにリクエストを送信します。

https://www.google-analytics.com/mp/collect

データを EU で処理する場合は、代わりに次のエンドポイントを使用します。

https://region1.google-analytics.com/mp/collect

POST リクエストの例を次に示します。

POST /mp/collect HTTP/1.1
HOST: www.google-analytics.com
Content-Type: application/json
PAYLOAD_DATA

PAYLOAD_DATA は、リクエストのペイロードに置き換えます。

Measurement Protocol は、HTTP リクエストを受け取った場合には 2xx ステータス コードを返します。ペイロードの形式が不適切であったり、データが間違っていたり、Google アナリティクスで処理されていなかったりしても、Measurement Protocol からエラーコードが返されることはありません。

ペイロード

ペイロードは 2 つの部分で構成されています。

  1. クエリ パラメータ。
  2. JSON POST 本文。

クエリ パラメータ

パラメータ名 説明

api_secret

 必須。Google アナリティクスの管理画面の API Secret。

[管理] > [データ ストリーム] > [ストリームを選択] > [Measurement Protocol] > [作成] の順にクリックします。

組織内で限定公開。スパムの発生を防ぐため、定期的に更新する必要があります。

JSON POST 本文

キー 型 説明

user_id

 string

（省略可）ユーザーの一意の識別子。この識別子について詳しくは、User-ID によるクロスプラットフォーム分析をご覧ください。 使用できるのは UTF-8 の文字のみです。

timestamp_micros

 number

（省略可）Unix タイムスタンプ（マイクロ秒、ミリ秒ではありません）。イベントの時刻を表します。過去に発生したイベントを記録する場合にのみ設定します。user_property またはイベントのタイムスタンプでオーバーライドできます。イベントには、プロパティのタイムゾーンに基づいて、最大 3 日前までさかのぼってタイムスタンプを適用できます。

user_properties

 object （省略可）測定のユーザー プロパティ。

user_data

 object （省略可）ユーザー提供データ。
object （省略可）リクエストの同意設定。詳しくは同意セクションをご覧ください。

non_personalized_ads

 boolean 省略可。ユーザーのデータをパーソナライズド広告に使用しないことを示すには、true に設定します。

user_location

 object （省略可）リクエストの位置情報を構造化形式で設定します。

ip_override

 string （省略可）Google アナリティクスがリクエストの位置情報の取得に使用する IP アドレス。

events[]

 array 必須。event アイテムの配列。リクエストごとに最大 25 個のイベントを送信できます。有効なすべてのイベントについては、イベント リファレンスをご覧ください。

events[].name

 string 必須。イベントの名前。すべてのオプションについては、イベントをご覧ください。

events[].params

 object （省略可）イベントのパラメータ。各イベントの推奨パラメータについては、イベントをご覧ください。

consent 属性は同意のタイプと状態を設定します。consent を指定しない場合、Google アナリティクスでは、対応するクライアントのオンライン インタラクションまたはアプリ インスタンスからの同意設定が使用されます。

キー 型 説明

ad_user_data

 string

（省略可）広告目的でリクエストのイベントとユーザー プロパティから Google にユーザーデータを送信することへの同意。

GRANTED または DENIED のいずれか。

ad_personalization

 string

（省略可）ユーザーのパーソナライズド広告への同意。

GRANTED または DENIED のいずれか。

地理情報

user_location 属性と ip_override 属性は地理情報を提供します。user_location は ip_override より優先されます。

user_location フィールドの構造は次のとおりです。できるだけ多くの属性を指定してください。少なくとも country_id と region_id を指定することをおすすめします。

キー 型 説明

city

 string （省略可）都市名。都市が米国にある場合は、country_id と region_id も設定して、Google アナリティクスが都市名を都市 ID に正しくマッピングできるようにします。

region_id

 string （省略可）ISO 3166 の国と行政区画。たとえば、US-CA、US-AR、CA-BC、GB-LND、CN-HK です。

country_id

 string （省略可）ISO 3166-1 alpha-2 形式の国。たとえば、US、AU、ES、FR です。

subcontinent_id

 string （省略可）UN M49 形式の亜大陸。たとえば、011、021、030、039 です。

continent_id

 string （省略可）UN M49 形式で指定する大陸。たとえば、002、019、142、150 です。

user_location の例を次に示します。

"user_location:" {
  "city:" "Mountain View",
  "region_id:" "US-CA",
  "country_id:" "US",
  "subcontinent_id:" "021",
  "continent_id:" "019"
}

ip_override は user_location の代替手段です。代わりに ip_override を送信すると、Google アナリティクスは IP アドレスから位置情報を取得します。user_location を送信すると、ip_override は無視されます。

user_location または ip_override を送信しない場合、Google アナリティクスは client_id。

Google アナリティクスでは、送信された位置情報に関係なく、プロパティの位置情報の詳細設定がリクエストに適用されます。

カスタム パラメータ

Measurement Protocol のペイロードには、ユーザー スコープ、イベント スコープ、アイテム スコープのカスタム パラメータを追加できます。

  • ユーザー スコープのカスタム パラメータは user_properties に含めることができます。
  • イベント スコープのカスタム パラメータは events[].params に追加できます。
  • アイテム スコープのカスタム パラメータは items に追加できます。

一部のイベントには推奨パラメータがあります。サポートされているすべてのイベントの推奨パラメータについては、イベントをご覧ください。

予約済みの名前

一部のイベント、パラメータ、ユーザー プロパティ名は予約済みのため使用できません。

予約済みのイベント名

以下のイベント名は予約済みのため使用できません。

  • ad_activeview
  • ad_click
  • ad_exposure
  • ad_query
  • ad_reward
  • adunit_exposure
  • app_clear_data
  • app_exception
  • app_install
  • app_remove
  • app_store_refund
  • app_update
  • app_upgrade
  • dynamic_link_app_open
  • dynamic_link_app_update
  • dynamic_link_first_open
  • error
  • firebase_campaign
  • firebase_in_app_message_action
  • firebase_in_app_message_dismiss
  • firebase_in_app_message_impression
  • first_open
  • first_visit
  • in_app_purchase
  • notification_dismiss
  • notification_foreground
  • notification_open
  • notification_receive
  • notification_send
  • os_update
  • session_start
  • user_engagement

予約済みのパラメータ名

以下のパラメータ名は予約済みのため使用できません。

  • firebase_conversion

パラメータ名の先頭を以下にすることはできません。

  • _ (underscore)
  • firebase_
  • ga_
  • google_
  • gtag.

予約済みのユーザー プロパティ名

以下のユーザー プロパティ名は予約済みのため使用できません。

  • first_open_time
  • first_visit_time
  • last_deep_link_referrer
  • user_id
  • first_open_after_install

また、ユーザー プロパティ名の先頭を以下にすることはできません。

  • _ (underscore)
  • firebase_
  • ga_
  • google_