GAIDictionaryBuilder クラス リファレンス

概要

ヒットのパラメータと値のマップを構築するヘルパークラス。


例:

id<GAITracker> t = // get a tracker.
[t send:[[[GAIDictionaryBuilder createEventWithCategory:@"EventCategory"
                                                 action:@"EventAction"
                                                  label:nil
                                                  value:nil]
    set:"dimension1" forKey:[GAIFields customDimensionForIndex:1]] build]];

この例では、指定されたパラメータとカスタム ディメンション パラメータで event ヒットタイプを送信しています。
すべてのヒットでパラメータを送信する場合は、GAITracker に直接設定します。

[t set:kGAIScreenName value:@"Home"];
[t send:[[GAIDictionaryBuilder createSocialWithNetwork:@"Google+"
                                                action:@"PlusOne"
                                                target:@"SOME_URL"] build]];
[t send:[[GAIDictionaryBuilder createSocialWithNetwork:@"Google+"
                                                action:@"Share"
                                                target:@"SOME_POST"] build]];
[t send:[[GAIDictionaryBuilder createSocialWithNetwork:@"Google+"
                                                action:@"HangOut"
                                                target:@"SOME_CIRCLE"]
    build]];

トラッカーに設定された値をオーバーライドするには、マップに値を追加します。

[t set:kGAIScreenName value:@"Home"];
[t send:...];
[t send[[[GAIDictionaryBuilder createEventWithCategory:@"click"
                                                action:@"popup"
                                                 label:nil
                                                 value:nil]
    set:@"popup title" forKey:kGAIScreenName] build]];

[GAIDictionaryBuilder set] または [GAIDictionaryBuilder setAll] で設定された値は、GAIDictionaryBuilder オブジェクトにあるすべての既存の値をオーバーライドします(オブジェクトは [GAIDictionaryBuilder createXYZ] で初期化)。例:

GAIDictionaryBuilder *m =
    GAIDictionaryBuilder createTimingWithCategory:@"category"
                                         interval:@0
                                             name:@"name"
                                            label:nil];
[t send:[m.set:@"10" forKey:kGAITimingVar] build];
[t send:[m.set:@"20" forKey:kGAITimingVar] build];

NSObject を継承します。

インスタンス メソッド

(GAIDictionaryBuilder *) - setAll:
 params に含まれるすべての名前と値のペアをこのオブジェクトにコピーします。その際、NSString でないすべてのキーと、NSString と NSNull のいずれでもないすべての値は無視されます。詳細...
 
(NSString *) - get:
 入力された paramName パラメータの値を返します。paramName が存在しない場合は、nil を返します。詳細...
 
(NSMutableDictionary *) - build
 このメソッドに設定されたすべてのパラメータで NSMutableDictionary オブジェクトを返します。詳細...
 
(GAIDictionaryBuilder *) - setCampaignParametersFromUrl:
 UTM キャンペーン パラメータを解析して、アナリティクス キャンペーン パラメータに変換し、マップとして返します。詳細...
 
(GAIDictionaryBuilder *) - setProductAction:
 このヒットの商品アクション フィールドを設定します。詳細...
 
(GAIDictionaryBuilder *) - addProduct:
 このヒットに商品を追加します。詳細...
 
(GAIDictionaryBuilder *) - addProductImpression:impressionList:impressionSource:
 このヒットに商品インプレッションを追加します。詳細...
 
(GAIDictionaryBuilder *) - addPromotion:
 このヒットにプロモーションを追加します。詳細...
 

クラスメソッド

代わりに createScreenView メソッドを使用してください。+ createAppView
 appview ヒット固有のパラメータで GAIDictionaryBuilder オブジェクトを返します。詳細...
 
(GAIDictionaryBuilder *) + createScreenView
 screenview ヒット固有のパラメータで GAIDictionaryBuilder オブジェクトを返します。詳細...
 
(GAIDictionaryBuilder *) + createEventWithCategory:action:label:value:
 event ヒット固有のパラメータで GAIDictionaryBuilder オブジェクトを返します。詳細...
 
(GAIDictionaryBuilder *) + createExceptionWithDescription:withFatal:
 exception ヒット固有のパラメータで GAIDictionaryBuilder オブジェクトを返します。詳細...
 
(GAIDictionaryBuilder *) + createItemWithTransactionId:name:sku:category:price:quantity:currencyCode:
 item ヒット固有のパラメータで GAIDictionaryBuilder オブジェクトを返します。詳細...
 
(GAIDictionaryBuilder *) + createSocialWithNetwork:action:target:
 social ヒット固有のパラメータで GAIDictionaryBuilder オブジェクトを返します。詳細...
 
(GAIDictionaryBuilder *) + createTimingWithCategory:interval:name:label:
 timing ヒット固有のパラメータで GAIDictionaryBuilder オブジェクトを返します。詳細...
 
(GAIDictionaryBuilder *) + createTransactionWithId:affiliation:revenue:tax:shipping:currencyCode:
 transaction ヒット固有のパラメータで GAIDictionaryBuilder オブジェクトを返します。詳細...
 

メソッドのドキュメント

- (GAIDictionaryBuilder *) setAll: (NSDictionary *)  params

params に含まれるすべての名前と値のペアをこのオブジェクトにコピーします。その際、NSString でないすべてのキーと、NSString と NSNull のいずれでもないすべての値は無視されます。

- (NSString *) get: (NSString *)  paramName

入力された paramName パラメータの値を返します。paramName が存在しない場合は、nil を返します。

- (NSMutableDictionary *) build

このメソッドに設定されたすべてのパラメータで NSMutableDictionary オブジェクトを返します。

- (GAIDictionaryBuilder *) setCampaignParametersFromUrl: (NSString *)  urlString

UTM キャンペーン パラメータを解析して、アナリティクス キャンペーン パラメータに変換し、マップとして返します。

パラメータ
paramsUTM キャンペーン パラメータを含む URL

有効なキャンペーン パラメータは次のとおりです。

  • utm_id
  • utm_campaign
  • utm_content
  • utm_medium
  • utm_source
  • utm_term
  • dclid
  • gclid
  • gmob_t
  • aclid
  • anid

例: http://my.site.com/index.html?utm_campaign=wow&utm_source=source utm_campaign=wow&utm_source=source

自動タグ設定と手動タグ設定の詳細については、自動タグ設定のメリットをご覧ください。

+ (GAIDictionaryBuilder *) createAppView

appview ヒット固有のパラメータで GAIDictionaryBuilder オブジェクトを返します。

このメソッドを使用しても、後続のヒットにスクリーン名は設定されません。後続のヒットにスクリーン名を設定するには、GAITracker インスタンスで set:kGAIDescription value:<screenName> を呼び出してください。

このメソッドのサポートは終了しているため、代わりに createScreenView を使用してください。

+ (GAIDictionaryBuilder *) createScreenView

screenview ヒット固有のパラメータで GAIDictionaryBuilder オブジェクトを返します。

このメソッドを使用しても、後続のヒットにスクリーン名は設定されません。後続のヒットにスクリーン名を設定するには、GAITracker インスタンスで set:kGAIDescription value:<screenName> を呼び出してください。

+ (GAIDictionaryBuilder *) createEventWithCategory: (NSString *)  category
action: (NSString *)  action
label: (NSString *)  label
value: (NSNumber *)  value 

event ヒット固有のパラメータで GAIDictionaryBuilder オブジェクトを返します。

+ (GAIDictionaryBuilder *) createExceptionWithDescription: (NSString *)  description
withFatal: (NSNumber *)  fatal 

exception ヒット固有のパラメータで GAIDictionaryBuilder オブジェクトを返します。

+ (GAIDictionaryBuilder *) createItemWithTransactionId: (NSString *)  transactionId
name: (NSString *)  name
sku: (NSString *)  sku
category: (NSString *)  category
price: (NSNumber *)  price
quantity: (NSNumber *)  quantity
currencyCode: (NSString *)  currencyCode 

item ヒット固有のパラメータで GAIDictionaryBuilder オブジェクトを返します。

+ (GAIDictionaryBuilder *) createSocialWithNetwork: (NSString *)  network
action: (NSString *)  action
target: (NSString *)  target 

social ヒット固有のパラメータで GAIDictionaryBuilder オブジェクトを返します。

+ (GAIDictionaryBuilder *) createTimingWithCategory: (NSString *)  category
interval: (NSNumber *)  intervalMillis
name: (NSString *)  name
label: (NSString *)  label 

timing ヒット固有のパラメータで GAIDictionaryBuilder オブジェクトを返します。

+ (GAIDictionaryBuilder *) createTransactionWithId: (NSString *)  transactionId
affiliation: (NSString *)  affiliation
revenue: (NSNumber *)  revenue
tax: (NSNumber *)  tax
shipping: (NSNumber *)  shipping
currencyCode: (NSString *)  currencyCode 

transaction ヒット固有のパラメータで GAIDictionaryBuilder オブジェクトを返します。

- (GAIDictionaryBuilder *) setProductAction: (GAIEcommerceProductAction *)  productAction

このヒットの商品アクション フィールドを設定します。

- (GAIDictionaryBuilder *) addProduct: (GAIEcommerceProduct *)  product

このヒットに商品を追加します。

- (GAIDictionaryBuilder *) addProductImpression: (GAIEcommerceProduct *)  product
impressionList: (NSString *)  name
impressionSource: (NSString *)  source 

このヒットに商品インプレッションを追加します。

- (GAIDictionaryBuilder *) addPromotion: (GAIEcommercePromotion *)  promotion

このヒットにプロモーションを追加します。