TrackerObjectiveC

@objc(KRTTracker)
public class TrackerObjectiveC : NSObject

イベントトラッキングを行うためのクラスです。

送信するイベントの種類に応じて、複数のメソッドが用意されております。

track

任意の名前のイベントを送る場合に利用します。

identify

ユーザーに関する情報（ユーザーIDや名前、メールアドレス等）を送る場合に利用します。

view

画面表示に関する情報を送る場合に利用します。
通常は viewDidAppear: 等で呼び出します。

なおViewイベントに関しては、イベントの送信だけではなくアプリ上で画面遷移が発生したことを認識するためのものとしても利用されます。
具体的には、Viewイベントを発火させたタイミングで、既にアプリ内メッセージが表示されている場合は、自動でアプリ内メッセージを非表示にします。
またネイティブアプリにおける接客表示制限オプションを有効にした場合にも、ここで設定した認識結果が利用されます。

iPad OS における Split View / Slide Over 対応について

iPad OS の Split View / Slide Over に対応するために、イニシャライザに UIView を引数として取るものがあります。
Split View / Slide Over を有効がアプリケーションでは、UIView を引数として取るイニシャライザを利用することで適切なシーンにアプリ内メッセージを表示することが可能です。


                    
                    
                    init(view:)

トラッカーインスタンスを初期化します。

Declaration

Swift

@objc
public init(view: UIView?)

Parameters


                                view

イベントの発火に関連する UIView。イベント発火に関連するシーンの特定に利用されます。


                    
                    
                    track(_:)

イベントの送信を行います。

Declaration

Swift

@discardableResult
@objc
public static func track(_ name: String) -> TrackingTask

Parameters


                                name

イベント名

Return Value

トラッキングタスクの状態を保持するオブジェクトを返します。


                    
                    
                    track(_:values:)

イベントの送信を行います。

Declaration

Swift

@discardableResult
@objc
public static func track(_ name: String, values: [String : Any]) -> TrackingTask

Parameters

`name`	イベント名
`values`	イベントに紐付けるカスタムオブジェクト

Return Value

トラッキングタスクの状態を保持するオブジェクトを返します。


                    
                    
                    identify(_:)

Identifyイベントの送信を行います。

Declaration

Swift

@available(*, deprecated, message: "userId is a required parameter")
@discardableResult
@objc
public static func identify(_ values: [String : Any]) -> TrackingTask

Parameters


                                values

Identifyイベントに紐付けるカスタムオブジェクト

Return Value

トラッキングタスクの状態を保持するオブジェクトを返します。


                    
                    
                    identify(_:_:)

Identifyイベントの送信を行います。

Declaration

Swift

@discardableResult
@objc
public static func identify(_ userId: String, _ values: [String : Any]) -> TrackingTask

Parameters

`userId`	ユーザーを識別する一意なID
`values`	Identifyイベントに紐付けるカスタムオブジェクト

Return Value

トラッキングタスクの状態を保持するオブジェクトを返します。


                    
                    
                    attribute(_:)

Attributeイベントの送信を行います。

Declaration

Swift

@discardableResult
@objc
public static func attribute(_ values: [String : Any]) -> TrackingTask

Parameters


                                values

Attributeイベントに紐付けるカスタムオブジェクト

Return Value

トラッキングタスクの状態を保持するオブジェクトを返します。


                    
                    
                    view(_:)

Viewイベントの送信を行います。

Declaration

Swift

@discardableResult
@objc
public static func view(_ viewName: String) -> TrackingTask

Parameters


                                viewName

画面名

Return Value

トラッキングタスクの状態を保持するオブジェクトを返します。


                    
                    
                    view(_:title:)

Viewイベントの送信を行います。

Declaration

Swift

@discardableResult
@objc
public static func view(_ viewName: String, title: String?) -> TrackingTask

Parameters

`viewName`	画面名
`title`	タイトル

Return Value

トラッキングタスクの状態を保持するオブジェクトを返します。


                    
                    
                    view(_:title:values:)

Viewイベントの送信を行います。

Declaration

Swift

@discardableResult
@objc
public static func view(_ viewName: String, title: String?, values: [String : Any]) -> TrackingTask

Parameters

`viewName`	画面名
`title`	タイトル
`values`	Viewイベントに紐付けるカスタムオブジェクト

Return Value

トラッキングタスクの状態を保持するオブジェクトを返します。


                    
                    
                    track(_:)

イベントの送信を行います。

Declaration

Swift

@discardableResult
@objc
public func track(_ name: String) -> TrackingTask

Parameters


                                name

イベント名

Return Value

トラッキングタスクの状態を保持するオブジェクトを返します。


                    
                    
                    track(_:values:)

イベントの送信を行います。

Declaration

Swift

@discardableResult
@objc
public func track(_ name: String, values: [String : Any]) -> TrackingTask

Parameters

`name`	イベント名
`values`	イベントに紐付けるカスタムオブジェクト

Return Value

トラッキングタスクの状態を保持するオブジェクトを返します。


                    
                    
                    identify(_:)

Identifyイベントの送信を行います。

Declaration

Swift

@available(*, deprecated, message: "userId is a required parameter")
@discardableResult
@objc
public func identify(_ values: [String : Any]) -> TrackingTask

Parameters


                                values

Identifyイベントに紐付けるカスタムオブジェクト

Return Value

トラッキングタスクの状態を保持するオブジェクトを返します。


                    
                    
                    identify(_:_:)

Identifyイベントの送信を行います。

Declaration

Swift

@discardableResult
@objc
public func identify(_ userId: String, _ values: [String : Any]) -> TrackingTask

Parameters

`userId`	ユーザーを識別する一意なID
`values`	Identifyイベントに紐付けるカスタムオブジェクト

Return Value

トラッキングタスクの状態を保持するオブジェクトを返します。


                    
                    
                    attribute(_:)

Attributeイベントの送信を行います。

Declaration

Swift

@discardableResult
@objc
public func attribute(_ values: [String : Any]) -> TrackingTask

Parameters


                                values

Attributeイベントに紐付けるカスタムオブジェクト

Return Value

トラッキングタスクの状態を保持するオブジェクトを返します。


                    
                    
                    view(_:)

Viewイベントの送信を行います。

Declaration

Swift

@discardableResult
@objc
public func view(_ viewName: String) -> TrackingTask

Parameters


                                viewName

画面名

Return Value

トラッキングタスクの状態を保持するオブジェクトを返します。


                    
                    
                    view(_:title:)

Viewイベントの送信を行います。

Declaration

Swift

@discardableResult
@objc
public func view(_ viewName: String, title: String?) -> TrackingTask

Parameters

`viewName`	画面名
`title`	タイトル

Return Value

トラッキングタスクの状態を保持するオブジェクトを返します。


                    
                    
                    view(_:title:values:)

Viewイベントの送信を行います。

Declaration

Swift

@discardableResult
@objc
public func view(_ viewName: String, title: String?, values: [String : Any]) -> TrackingTask

Parameters

`viewName`	画面名
`title`	タイトル
`values`	Viewイベントに紐付けるカスタムオブジェクト

Return Value

トラッキングタスクの状態を保持するオブジェクトを返します。