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

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

概要

カスタム ディメンションでは Google アナリティクスのメタデータとヒット、ユーザー、セッションを関連付けることができ、カスタム指標では Google アナリティクスで独自の指標を作成して増やすことができます。

  1. Google アナリティクスの管理画面を使ってカスタム ディメンションやカスタム指標を設定します。 詳しくは、カスタム ディメンションやカスタム指標の設定方法(ヘルプセンター)をご覧ください。
  2. アプリからカスタム ディメンションとカスタム指標の値を設定、送信します。

カスタム ディメンションとカスタム指標には、次の 2 つのフィールドがあります。

  • NSNumber 型の Index - カスタム ディメンションやカスタム指標の インデックスです。このインデックスは 1 から始まります。
  • NSString 型の Value - カスタム ディメンションやカスタム指標の 値です。このフィールドが指標の場合、値は整数と見なされます。 ただし、指標が通貨の種類を表す場合は、固定小数点の 10 進数 と見なされます。

値の設定と送信

カスタム ディメンションの値を設定、送信するには、次のように記述します。

// May return nil if a tracker has not yet been initialized with a property ID.
id tracker = [[GAI sharedInstance] defaultTracker];

// Set the custom dimension value on the tracker using its index.
[tracker set:[GAIFields customDimensionForIndex:1]
       value:@"Premium user"];

[tracker set:kGAIScreenName
       value:@"Home screen"];

// Send the custom dimension value with a screen view.
// Note that the value only needs to be sent once, so it is set on the Map,
// not the tracker.

// Previous V3 SDK versions.
// [tracker send:[[[GAIDictionaryBuilder createAppView] set:@"premium"
//                                                   forKey:[GAIFields customDimensionForIndex:1]] build]];

// // SDK Version 3.08 and up.
[tracker send:[[[GAIDictionaryBuilder createScreenView] set:@"premium"
                                                     forKey:[GAIFields customDimensionForIndex:1]] build]];

カスタム ディメンションの値は、Google アナリティクスの任意のヒットタイプ(スクリーンビュー、イベント、e コマース トランザクション、カスタム速度、ソーシャル インタラクションなど)に付加して送ることができます。データ処理の際に、カスタム ディメンションの既定のスコープが判別され、そのスコープに当てはまるヒットにディメンションの値が結び付けられます。

カスタム指標の値を設定、送信するには、次のように記述します。

// May return nil if a tracker has not yet been initialized with a property ID.
id tracker = [[GAI sharedInstance] defaultTracker];


// Set the custom metric to be incremented by 5 using its index.
[tracker set:[GAIFields customMetricForIndex:1]
       value:[[NSNumber numberWithInt:5] stringValue]];


[tracker set:kGAIScreenName
       value:@"Home screen"];

// Custom metric value is sent with this screen view.
// [tracker send:[[GAIDictionaryBuilder createAppView] build]];     // Previous V3 SDK versions.
[tracker send:[[GAIDictionaryBuilder createScreenView] build]];     // SDK Version 3.08 and up.

実装に関する注意事項

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

カスタム ディメンションに関する注意事項

ユーザーレベルやセッション レベルのスコープを持つ値は、過去のヒットにも適用される

  • ユーザーレベルやセッション レベルのスコープを持つカスタム ディメンションの値は、現在のセッションの過去のヒットを含む、すべてのヒットに適用されます。セッション レベルやユーザーレベルのスコープを持つカスタム ディメンションを、現在のセッションの過去のヒットに適用したくない場合は、その値をヒットに設定する前に新しいセッションを開始してください。
  • たとえば、メンバーシップの種類をユーザーレベルのカスタム ディメンションで指定している状況で、ユーザーがセッションの途中でメンバーシップをアップグレードした場合は、そのカスタム ディメンションに新しい値を設定する前に、新たなセッションを始めるようにします。これにより、アップグレード前のヒットには古いメンバーシップの値が結び付けられ、新しいヒットには新しいメンバーシップの値が結び付けられます。

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

  • ユーザーレベルやセッション レベルのカスタム ディメンションの値は、現在以降のセッションのすべてのヒットに適用されます。これは、値を付加したヒットがビュー(旧プロファイル)でフィルタされている場合でも同様です。
  • カスタム ディメンションの値でフィルタを設定している場合は、そのカスタム ディメンションの値のスコープに応じて、ヒットがフィルタされます。 詳しくは、データ処理におけるフィルタとカスタム ディメンションの値の関係の説明をご覧ください。

カスタム指標に関する注意事項

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

  • カスタム指標の値は、Google アナリティクスの既定の指標と同じようにレポートで集計されます。つまり、カスタム指標の値として 1 を設定すると、レポートにはその指標の値を合計した数が表示されます。

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

  • カスタム指標の値はいつでも設定できますが、ビューフィルタで除外される可能性があるヒットには設定しないようにしてください。値を付加したヒットがビューフィルタで除外されると、そのカスタム指標の値も除外されてしまいます。 詳しくは、カスタム ディメンションとカスタム指標、ビューフィルタの説明をご覧ください。

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

  • 自動スクリーン測定機能で送られたスクリーンビューにカスタム ディメンションの値を適用するには、ビュー コントローラの viewDidAppear: メソッドで値を設定してください。この場合、ビュー コントローラの .m ファイルは次の例のようになります。
#import "myViewController.h"
#import "GAI.h"

@implementation myViewController

-(void)viewDidAppear
{
    id<GAITracker> tracker = [[GAI sharedInstance] defaultTracker];  // Get the tracker object.
    [tracker set:[GAIFields customDimensionForIndex:1]
           value:@"premium"];
    [super viewDidAppear:animated];   // Custom dimension value will be sent with the screen view.

}

// The remainder of the implementation is omitted.

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

  • Google アナリティクスの利用規約により、Google アナリティクス サーバーに個人情報を送ることは禁止されています。詳しくは、 利用規約をご確認ください。