このリファレンスでは、Google アナリティクスのレポートのあらゆる側面をカスタマイズする際に使用するメソッドについて説明します。
ga.js の基本メソッド
-
_deleteCustomVar(index)
-
_getName()
-
_getAccount()
-
_getVersion()
-
_getVisitorCustomVar(index)
-
_initData()
(非推奨) -
_setAccount(accountID)
-
_setCookiePersistence(milliseconds)
(非推奨) -
_setCustomVar(index, name, value, opt_scope)
-
_setSampleRate(newRate)
-
_setSessionTimeout(newTimeout)
(非推奨) -
_setSessionCookieTimeout(cookieTimeoutMillis)
-
_setSiteSpeedSampleRate(sampleRate)
-
_setVar(newVal)
(非推奨) -
_setVisitorCookieTimeout(cookieTimeoutMillis)
-
_trackPageLoadTime()
(非推奨) -
_trackPageview(opt_pageURL)
メソッドの詳細
_deleteCustomVar()
_deleteCustomVar(index)
このメソッドは、指定されたインデックスに割り当てられた変数(存在する場合)を削除します。たとえば、ビジター レベルのカスタム変数を設定し、このビジター レベルの変数を今後使用しないことを決定できます。
非同期スニペット(推奨)
_gaq.push(['_deleteCustomVar', 1]);
パラメータ
Int index
: 削除するカスタム変数のインデックス。
_getName()
_getName()
トラッカーの作成時に付けられた名前を返します。
非同期スニペット(推奨)
_gaq.push(function() { var pageTracker = _gat._getTrackerByName(); // Gets the default tracker. var trackerName = pageTracker._getName(); });
戻り値
String
トラッカーの名前。
_getAccount()
_getAccount()
このトラッカー オブジェクトの Google アナリティクス ID を返します。ウェブサイトのページを複数のアカウントでトラッキングしている場合は、この方法を使用して、特定のトラッカー オブジェクトに関連付けられているアカウントを特定できます。
非同期スニペット(推奨)
_gaq.push(function() { var pageTracker = _gat._getTrackerByName(); // Gets the default tracker. var accountId = pageTracker._getAccount(); });
戻り値
String
このトラッカー オブジェクトがインスタンス化されるアカウント ID。
_getVersion()
_getVersion()
GATC のバージョン番号を返します。
非同期スニペット(推奨)
_gaq.push(function() { var pageTracker = _gat._getTrackerByName(); // Gets the default tracker. var version = pageTracker._getVersion(); });
戻り値
String
GATC バージョン番号。
_getVisitorCustomVar()
_getVisitorCustomVar(index)
指定されたインデックスに割り当てられたユーザー レベルのカスタム変数の値を返します。
非同期スニペット(推奨)
_gaq.push(function() { var pageTracker = _gat._getTrackerByName(); // Gets the default tracker. var visitorCustomVar1Value = pageTracker._getVisitorCustomVar(1); });
パラメータ
Int index
ユーザー単位のカスタム変数のインデックス。
戻り値
String
ユーザー単位のカスタム変数の値。指定されたインデックスの変数を取得できない場合、未定義を返します。
_initData()
_initData()
サポート終了。initData() が ga.js トラッキング コード内で自動的に実行されるようになりました。
GATC(Google Analytics Tracker Code)オブジェクトを初期化または再初期化します。
var pageTracker = _gat._getTracker("UA-12345-1");
pageTracker._trackPageview();
_setAccount()
_setAccount(accountId)
非同期トラッキングでのみ使用します。トラッキング オブジェクトのウェブ プロパティ ID を設定します。
_gaq.push(['_setAccount', 'UA-XXXXX-X']);
パラメータ
String accountID
トラッカー オブジェクトの完全なウェブ プロパティ ID(UA-65432-1
など)。
_setCookiePersistence()
_setCookiePersistence(milliseconds)
このメソッドはサポートが終了しました。代わりに _setVisitorCookieTimeout(cookieTimeoutMillis)
を使用してください。
Google アナリティクスの訪問者の Cookie の有効期限をミリ秒単位で設定します。デフォルトでは、ユーザーの Cookie の有効期限は 2 年に設定されます。このメソッドを使用してビジターの Cookie の有効期限を変更することもできます。たとえば、ビジターの Cookie の有効期限を 7 日間に設定するには、次のコードを使用します。
pageTracker._setCookiePersistence(604800000);
パラメータ
Number milliseconds
新しいユーザーの Cookie の有効期限。
_setCustomVar()
_setCustomVar(index, name, value, opt_scope)
カスタム変数に指定された名前、値、範囲を指定してカスタム変数を設定します。name
と value
を合わせた文字数は 128 バイトに制限されています。
非同期スニペット(推奨)
_gaq.push(['_setCustomVar', 1, 'Section', 'Life & Style', 3]);
戻り値
Boolean
このメソッドは、カスタム変数が正しく設定されている場合に true
を返し、設定されていない場合は false
を返します(名前/値文字列の長さが 128 バイトを超えている場合、または間違ったスロットを使用している場合など)。
パラメータ
Int index
必須。カスタム変数に使用されるスロット。指定可能な値は 1-5
です。
String name
必須。カスタム変数の名前。
String value
必須。カスタム変数の値。
Int opt_scope
(省略可)カスタム変数に使用されるスコープ。指定できる値は、1
(訪問者単位)、2
(セッション単位)、3
(ページ単位)です。
_setSampleRate()
_setSampleRate(newRate)
新しいサンプルレートを設定します。ウェブサイトが特に大規模で、トラフィックの急増が大きい場合は、サンプルレートを設定することで中断なくレポートをトラッキングできます。Google アナリティクスのサンプリングは、ユニーク ユーザー間で一貫して行われます。サンプリングを有効にしていても、ユニーク ユーザーはサンプルに含まれたり除外されたりするため、トレンド分析とレポートの整合性は確保されています。
このメソッドを指定する必要があるのは、_setAccount() が呼び出されると同時に、通常はページまたはアプリケーションごとに 1 回だけです(トラッキング コード自体を初期化する場所)。指定したサンプルレートの値は、トラッキング オブジェクト自体が保持されている限り有効です。
非同期スニペット(推奨)
_gaq.push(['_setSampleRate', '2.5']);
パラメータ
String newRate
: 設定する新しいサンプルレート。0 ~ 100(小数点以下 2 桁まで)の数値文字列を指定します。
_setSessionTimeout()
_setSessionTimeout(newTimeout)
このメソッドはサポートが終了しました。代わりに _setSessionCookieTimeout(cookieTimeoutMillis)
を使用してください。
新しいセッションのタイムアウトを秒単位で設定します。デフォルトでは、セッション タイムアウトは 30 分(1, 800 秒)に設定されています。セッションのタイムアウトは、アクセス数の算出に使用されます(アナリティクスでのセッションの定義をご覧ください)。「セッション」の定義を変更する場合は、特定の秒数だけ渡して新しい値を定義します。これは、訪問者数が計算されるセクションや、他の値の計算に訪問が使用されるセクションの訪問レポートに影響します。たとえば、通常、セッション数は、セッションのタイムアウトを短くすると増加し、セッションのタイムアウトを増やすと減少します。
パラメータ
String newTimeout
新しいセッション タイムアウト(秒単位)。
_setSessionCookieTimeout()
_setSessionCookieTimeout(cookieTimeoutMillis)
新しいセッション Cookie のタイムアウトをミリ秒単位で設定します。セッションのタイムアウトは、デフォルトで 30 分に設定されています。ブラウザのタイムアウトは、操作がないまま 30 分経過した後やブラウザの終了時に終了するため、アクセスのタイムアウトの計算に使用されます。「セッション」の定義を変更する場合は、特定のニーズに応じてミリ秒単位で新しい値を定義します。これは、訪問数が計算されるセクションや、他の値の計算に訪問数が使用されるすべてのセクションの訪問数レポートに影響します。たとえば、セッション数は、セッションのタイムアウトを短くすると増加し、セッションのタイムアウトを長くすると減少します。有効期限のタイムアウトを 0 に変更することで、ブラウザを閉じたときに、この Cookie を削除するように指定できます。
非同期スニペット(推奨)
_gaq.push(['_setSessionCookieTimeout', 1800000]);
パラメータ
Number cookieTimeoutMillis
: ブラウザの終了時に Cookie を削除する新しいセッション タイムアウト(ミリ秒または 0)。
_setSiteSpeedSampleRate()
_setSiteSpeedSampleRate(sampleRate)
Site Speed のデータ収集用の新しいサンプルセット サイズを定義します。デフォルトでは、サイト訪問者の 1% をサンプリングしたデータプールに基づいてサイトの速度指標が取得されます。1 日あたりのサイト訪問者が比較的少ない場合(10 万人以下など)は、サンプリング レートをより大きく調整することをおすすめします。これにより、ページの読み込み時間やその他のサイトの速度指標を細かく表示できるようになります。(サイトの速度のレポートの詳細については、ヘルプセンターのサイトの速度をご覧ください)。
有効にするには、_trackPageview()
の前に _setSiteSpeedSampleRate()
メソッドを呼び出す必要があります。
アナリティクスでは、この機能のシステム リソースの公平な分布を確保するために、1 つのプロパティのサイト速度収集ヒットを、ユーザー数の 1% または 1 日あたりのヒット数 1 万のうちの大きい方に制限します。
注: 1 日あたりのヒット数が 100 万を超えるサイトでは、サンプルの選択値をデフォルトの 1% のままにすることを強くおすすめします。サンプルサイズをより大きい数に調整しても、サンプルサイズが増大することはありません。
非同期スニペット(推奨)
_gaq.push(['_setSiteSpeedSampleRate', 5]); _gaq.push(['_trackPageview']);
パラメータ
Number sampleRate
0 ~ 100 の値。サイトの速度のうち、測定する訪問者の割合を指定します。たとえば、値 5
を指定すると、サイトの速度の収集サンプルが 5% に設定されます。
_setVisitorCookieTimeout()
_setVisitorCookieTimeout(cookieTimeoutMillis)
Google アナリティクスの訪問者の Cookie の有効期限をミリ秒単位で設定します。デフォルトでは、訪問者の Cookie の有効期限は 2 年に設定されます。このメソッドを使用して、訪問者の Cookie の有効期限を変更することもできます。有効期限のタイムアウトを 0 に変更すると、ブラウザを閉じたときに、この Cookie を削除するように指定できます。
非同期スニペット(推奨)
_gaq.push(['_setVisitorCookieTimeout', 63072000000]);
パラメータ
Number cookieTimeoutMillis
: ブラウザの Cookie の有効期限をミリ秒単位で指定するか、ブラウザを閉じたときに Cookie を削除するように設定します。
_setVar()
_setVar(newVal)
このメソッドはサポートが終了しました。代わりに [_setCustomVar()
] を使用してください。
指定した文字列でカスタム ユーザー セグメントを設定または定義します。 この値を使って、ウェブサイト上でのユーザーの追加によるセグメント化が可能です。たとえば、ユーザーが選択した設定やプライバシー オプションなど、ユーザーの入力に基づいて値をトリガーするログインページやフォームを作成できます。この変数は、そのユーザーの Cookie 内で更新されます。サイトに実装して、この方法でデータを収集すると、定義済みセグメントがアナリティクス レポートの [ユーザー] セクションにある [ユーザー定義] レポートに表示されます。また、コンテンツの詳細レポートの [ユーザー定義値] セグメントを使用すると、定義した特定のセグメントに属するページ訪問者の割合を確認できます。
パラメータ
String newVal
: 設定するユーザー定義の新しい値。
_trackPageLoadTime()
_trackPageLoadTime()
サイトの速度のレポートがすべてのユーザーに対して自動的に有効になるため、この方法は非推奨になりました。Site Speed レポートのサンプリング レートを調整するには、_setSiteSpeedSampleRate()
を使用してください。
このページのサイトの速度レポートを有効にします。サイトの速度のレポートが必要なサイトの各ページにこのメソッドを挿入します。アナリティクスのサイトの速度レポートの詳細については、ヘルプセンターのサイトの速度についての記事をご覧ください。
変更を確認する
レポートに表示されるデータがあれば、設定は正しいです。24 時間経過してもデータが表示されない場合は、カスタマイズをチェックして、エラーがないことを確認します。一般的なトラッキング コードのエラーのリストについては、トラッキング コードのトラブルシューティングをご覧ください。このトラブルシューティング ガイドには、基本的なデバッグ手順とデバッグに関する詳細情報も含まれています。
サイトの速度のトラッキングを有効にすると、ページビューに対するページ トラッキングの GIF リクエストとは別に、Google アナリティクスのサーバーに送信される追加のリクエストが発生することにご注意ください。全体的なサイト レイテンシへの影響を最小限に抑えるため、このリクエストはサイトにサンプリングしたページビューのみに送信されます。そのため、Firebug やその他のツールでこの機能をデバッグしようとすると、サイトの速度の GIF リクエストが表示されないことがあります。これは正常であり、想定されていることです。
非同期スニペット(推奨)
_gaq.push(['_setAccount', 'UA-12345-1']); _gaq.push(['_trackPageview']); _gaq.push(['_trackPageLoadTime']);
_trackPageview()
_trackPageview(opt_pagePath)
GATC(Google Analytic Tracker Code)の主なロジックです。リンカー機能が有効になっている場合、URL から Cookie 値が抽出されます。それ以外の場合は、document.cookie
から Cookie 値の抽出を試みます。また、必要に応じて Cookie の更新や作成を行い、ドキュメント オブジェクトに書き込みます。UCFE(Dataproc コレクタ フロントエンド)に送信する適切な指標がすべて収集されます。
非同期スニペット(推奨)
_gaq.push(['_setAccount', 'UA-12345-1']); _gaq.push(['_trackPageview', '/home/landingPage']);
パラメータ
String opt_pagePath
指標をトラッキングするページのパスを示すオプションのパラメータ。このオプションを使用する場合は、開始スラッシュ(/)を使用してページパスを示します。