Screen Tracking

The Hackle SDK collects screen information at the ViewController level. For apps using a single ViewController structure or SwiftUI, it is difficult to automatically collect screen information.

To properly collect $page_view and $engagement events, you must call the setCurrentScreen method manually whenever the screen changes.

setCurrentScreen

This feature is officially supported in iOS SDK 2.59.0 and above.

The setCurrentScreen(screen) method accepts the screen name and screen class name as arguments to track the screen.

The minimum tracking time unit is 1 second.
$engagement for pages changed within 1 second is not measured.

Parameter

Type

Description

name

string

Required. The name of the current screen.

className

string

Required. If you do not need a separate class name, you can enter the same value as name.

Screen Tracking for the same screen is not supported.

If setCurrentScreen is called with a Screen that is identical to the previous screen (both name and className are the same), it is recognized as no screen transition and no action is taken.

$page_view and $engagement are not triggered.

Example

When using Swift UI, it is recommended to track screens when both onAppear and onChange events occur.

let screen = Screen.builder(name: "screenName", className: "screenName")
    .build()

Hackle.app()?.setCurrentScreen(screen: screen)

HackleScreen *screen = [[[HackleScreenBuilder alloc] initWithName:@"screenName"
                                                         className:@"screenName"] build];
[[Hackle app] setCurrentScreenWithScreen:screen];

struct MainView: View {
    @Environment(\.scenePhase) var scenePhase

    let screen = Screen.builder(name: "screenName", className: "screenName")
      .build()

    var body: some View {
        VStack {
            Text("메인 화면")
        }
        .onAppear {
            // 뷰가 나타날 때 화면 추적
            Hackle.app()?.setCurrentScreen(screen: screen)
        }
        .onChange(of: scenePhase) { oldPhase, newPhase in
            // 백그라운드 -> 포그라운드 전환될 때 화면 추적
            // 전환될 때 앱의 화면이 변하는 케이스가 없으면 호출하지 않아도 무방합니다.
            if newPhase == .active {
                Hackle.app()?.setCurrentScreen(screen: screen)
            }
        }
    }
}

Property

The Hackle SDK supports adding properties to Event objects.

A maximum of 64 properties can be added to an event object.

Example

let screen = Screen.builder(name: "screenName", className: "screenName")
    .property("key", "value")
    .build()

Hackle.app()?.setCurrentScreen(screen: screen)

HackleScreen *screen = [[[[HackleScreenBuilder alloc] initWithName:@"screenName"
                                                          className:@"screenName"]
                          property:@"key" value:@"value"]
                         build];
[[Hackle app] setCurrentScreenWithScreen:screen];

Disable automaticScreenTracking

By default, automaticScreenTracking is enabled in the SDK. If you do not want automatic screen information collection at the ViewController level, you must disable automaticScreenTracking.

You can configure automaticScreenTracking when initializing the SDK.

If automaticScreenTracking is enabled and you manually collect screens via setCurrentScreen, $page_view and $engagement may be over-collected or collected with unintended properties.

If you manually collect screen information, it is recommended to disable automaticScreenTracking.

Example

let config = HackleConfigBuilder()
  .automaticScreenTracking(false)
  .build()

Hackle.initialize(sdkKey: YOUR_APP_SDK_KEY, config: config) {
    // SDK ready to use.
}

HackleConfigBuilder *builder = [[HackleConfigBuilder alloc] init];
[builder automaticScreenTracking:false];
HackleConfig *config = [builder build];

[Hackle initializeWithSdkKey:@"YOUR_APP_SDK_KEY" config:config completion:^{
    // SDK ready to use.
}];

PreviousEvent Tracking NextUser Explorer

Last updated 3 months ago