このリファレンスでは、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
を返し、設定されていない場合(名前や値の文字列の長さが 128 バイトを超えている場合や、誤ったスロットを使用している場合)は false
を返します。
パラメータ
Int index
必須。カスタム変数に使用されるスロット。有効な値は 1-5
(両端を含む)です。
String name
必須。カスタム変数の名前。
String value
必須。カスタム変数の値。
Int opt_scope
: 省略可。カスタム変数に使用するスコープ。指定できる値は、ユーザーレベルの 1
、セッション レベルの 2
、ページレベルの 3
です。
_setSampleRate()
_setSampleRate(newRate)
新しいサンプルレートを設定します。ウェブサイトの規模が特に大きく、トラフィックの急増が激しい場合は、サンプルレートを設定することで、レポートのトラッキングを中断せずに済みます。Google アナリティクスのサンプリングはユニーク ユーザー全体で一貫して行われるため、サンプリング開始時に設定されたユニーク ユーザーがサンプルに含められる、またはサンプルから除外されたままになるため、サンプリングが有効になっている場合でも傾向とレポートの整合性が確保されます。
このメソッドを指定する必要があるのは、_setAccount() が呼び出されるときだけです。通常は、ページやアプリケーションごとに 1 回(トラッキング コード自体を初期化する)で 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)
サイトの速度データ収集に使用する新しいサンプルセットのサイズを定義します。デフォルトでは、サイト訪問者の 1% をサンプリングしたデータプールから、サイトの速度の指標が取得されます。1 日にサイトを訪れるユーザー数が比較的少ない場合(10 万人以下など)は、サンプリング レートを大きくすることをおすすめします。これにより、ページの読み込み時間などのサイトの速度に関する指標がより詳細になります。(サイトの速度レポートについて詳しくは、ヘルプセンターのサイトの速度をご覧ください)。
_setSiteSpeedSampleRate()
メソッドを有効にするには、_trackPageview()
の前に呼び出す必要があります。
アナリティクスでは、この機能のシステム リソースを公平に配分するため、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 を削除する場合は 0。
_setVar()
_setVar(newVal)
このメソッドは非推奨です。代わりに [_setCustomVar()
] を使用してください。
指定された文字列で、カスタム ユーザー セグメントを設定または定義します。 この値を使用して、ウェブサイトへのユーザーのセグメントを追加できます。たとえば、ログインページやフォームでは、ユーザーの入力内容(ユーザーが選択した設定やプライバシー オプションなど)に基づいて値をトリガーできます。この変数は訪問者の Cookie 内で更新されます。サイトに実装し、このメソッドでデータが収集されると、新たに定義したセグメントがアナリティクス レポートの [ユーザー] セクションの [ユーザー定義] レポートに表示されます。さらに、コンテンツの詳細レポートの [ユーザー定義値] セグメントにアクセスして、定義した特定のセグメントに属する訪問者の割合を確認できます。
パラメータ
String newVal
設定する新しいユーザー定義の値。
_trackPageLoadTime()
_trackPageLoadTime()
サイトの速度レポートはすべてのユーザーに対して自動的に有効になるため、この手法のサポートは終了しました。サイトの速度レポートのサンプリング レートを調整するには、_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 コード)のメインロジックです。リンカー機能が有効になっている場合、URL から Cookie 値が抽出されます。それ以外の場合は、document.cookie
から Cookie 値を抽出しようとします。また、必要に応じて Cookie の更新または作成を行い、ドキュメント オブジェクトに書き戻します。UCFE(Urchin コレクタ フロントエンド)に送信する適切な指標をすべて収集します。
非同期スニペット(推奨)
_gaq.push(['_setAccount', 'UA-12345-1']); _gaq.push(['_trackPageview', '/home/landingPage']);
パラメータ
String opt_pagePath
: 指標をトラッキングするページのパスを示すオプション パラメータ。このオプションを使用する場合は、先頭にスラッシュ(/)を使用してページパスを指定します。