カスタム ディメンションとカスタム指標 - iOS SDK

このデベロッパー ガイドでは、iOS 向け Google アナリティクス SDK v2 を使ってカスタム ディメンションとカスタム指標を実装する方法を説明します。

概要

iOS 向け Google アナリティクス SDK を使ってカスタム ディメンションまたはカスタム指標の値を設定すると、その値は、次にディスパッチされるヒットでパラメータとして送信されます。これらの値は、スクリーン ビュー、イベント、e コマース トランザクション、カスタム速度、ソーシャル インタラクションなど、Google アナリティクスのすべてのヒットタイプに適用できます。

カスタム ディメンションまたはカスタム指標を実装する主な手順は、次の 2 つです。

  1. Google アナリティクスの管理画面を使用してカスタム ディメンションまたはカスタム指標を定義します。
    管理画面のプロパティ設定セクションで、カスタム ディメンションまたはカスタム指標のインデックス、名前、スコープを設定します。
    カスタム ディメンションまたはカスタム指標の定義方法
  2. カスタム ディメンションとカスタム指標の値を設定、収集するコードを実装します。
    コードをアプリに追加して、前のステップで定義したインデックスを Google アナリティクスのヒットにカスタム ディメンションまたはカスタム指標の値を設定します。

この記事の残りの部分では、カスタム ディメンションまたはカスタム指標の値を Google アナリティクスに送信するためのコードを実装する方法について説明します。

カスタム ディメンション

カスタム ディメンションの値は、Google アナリティクスのすべてのヒットタイプで設定できます。 値を適用する send の呼び出しの直前に、カスタム ディメンションの値を設定します。

処理時点で、カスタム ディメンションに定義されたスコープによって、その値に関連付けられる追加のヒットが決定されます。

カスタム ディメンションの値を設定するには、以下のフィールドが必要です。

  • NSNumber インデックス - カスタム ディメンション定義のインデックス。このインデックスは 1 から始まります。
  • NSString 値 - カスタム ディメンションの値です。

カスタム ディメンション値の設定

カスタム ディメンションの値を設定するには、値を関連付ける send 呼び出しの前に setCustom:dimension: を呼び出します。

// Get the tracker object.
id tracker = [[GAI sharedInstance].defaultTracker;

// Set the dimension value for index 1.
[tracker setCustom:1
         dimension:@"myValue"];

// Dimension value is associated and sent with this hit.
[tracker sendView:screenName];

導入の際の留意事項（英語記事）

このセクションでは、カスタム ディメンションを実装する際のその他の考慮事項について説明します。

ユーザーレベルとセッション レベルのスコープは欲張り

ユーザーレベルまたはセッション レベルのスコープを持つカスタム ディメンションの値は、現在のセッションの過去のヒットを含む、すべてのヒットに適用されます。セッション レベルやユーザーレベルのスコープが設定されたカスタム ディメンションを、現在のセッションの過去のヒットに適用したくない場合は、値をヒットに適用する前に新しいセッションを開始してください。

たとえば、ユーザーレベルのカスタム ディメンションとしてメンバーシップ タイプを使用していて、ユーザーがセッション中にメンバーシップをアップグレードした場合は、新しいカスタム ディメンション値を設定する前に新しいセッションを開始することをおすすめします。これにより、アップグレード前のヒットには古いメンバーシップ値が、新しいヒットには新しい値が関連付けられます。

カスタム ディメンションとビュー（旧プロファイル）フィルタ

ユーザーレベルまたはセッション レベルのカスタム ディメンションの値は、送られたヒットがビュー（旧プロファイル）からフィルタされた場合でも、現在および将来のセッションのすべてのヒットに適用されます。

カスタム ディメンション値でフィルタすると、そのカスタム ディメンション値の範囲に基づいてヒットがフィルタされます。

詳しくは、データ処理におけるフィルタとカスタム ディメンション値の関係をご確認ください。

自動スクリーン測定で値を設定する場合

自動スクリーン測定機能で送信されたスクリーン ビューにカスタム ディメンション値を適用するには、ビュー コントローラの viewDidAppear: メソッドで値を設定します。たとえば、ビュー コントローラの .m ファイルは次のようになります。

#import "myViewController.h"
#import "GAI.h"

@implementation myViewController

-(void)viewDidAppear
{
    id tracker = [[GAI sharedInstance].defaultTracker;  // Get the tracker object.
    [tracker setCustom:1
             dimension:@"myValue"];  // Set the custom dimension value.
    [super viewDidAppear:animated]   // Custom dimension value will be sent with the screen view.

}

// The remainder of the implementation is omitted.

値として個人情報を送信しない

Google アナリティクスの利用規約では、Google アナリティクスのサーバーに個人情報（PII）を送信することは禁止されています。詳しくは、利用規約をご覧ください。

カスタム指標

カスタム ディメンションは、特定のヒットには慎重に適用し、スコープで管理する必要がありますが、カスタム指標が適用されたヒットは通常、レポートに影響を与えないため、指標の値が判明するたびに設定できます。

カスタム指標の値を設定するには、以下のフィールドが必要です。

  • NSInteger インデックス - カスタム指標定義のインデックス。
  • NSNumber 値 - カスタム指標の値。値は負の値でもかまいません。

カスタム指標の値の設定

カスタム指標の値を設定するには、次の send 呼び出しの前に setCustom:metric: を呼び出します。

// Get the tracker object.
id tracker = [GAI sharedInstance].defaultTracker;

// Increment the metric at index 1.
[tracker setCustom:1
            metric:[NSNumber numberWithLongLong:1]];

// Metric value sent with this hit.
[tracker sendView:screenName];

通貨に関するカスタム指標を設定するには:

// Get the tracker.
id tracker = [GAI sharedInstance].defaultTracker;

// Create a dictionary for hit params.
NSDictionary *params = [[NSDictionary alloc] initWithObjectsAndKeys:
    @"Product Page", @"&cd",
   // Set currency value to custom metric slot 1.
   // Currency values may be fixed decimal.
    @"24.99", @"&cm1", nil];

// Send the custom metric value with a screen view.
[tracker send:@"appview"
       params:params];

導入の際の留意事項（英語記事）

次のセクションでは、カスタム ディメンションまたはカスタム指標の実装を計画する際のその他の考慮事項について概説します。

カスタム指標の値はレポートで集計される

カスタム指標の値は、Google アナリティクスの他の定義済み指標と同様にレポートで集計されます。そのため、カスタム指標の値に 1 を設定すると、レポートでその指標の集計値が増加します。

カスタム指標とビュー（旧プロファイル）フィルタ

通常、カスタム指標の値は都合のよいときに設定できますが、ビュー（プロファイル）から除外される可能性が高いヒットには、カスタム指標の値を設定しないようにしてください。ヒットがビュー（旧プロファイル）フィルタでフィルタされると、関連付けられているカスタム指標値もフィルタされます。詳しくは、カスタム ディメンションとカスタム指標、ビュー（旧プロファイル）フィルタをご覧ください。