AppsFlyer와 딥링크 | Appbox iOS SDK 가이드

AppsFlyer와 딥링크

AppsFlyer 설정

AppsFlyer SDK를 시작하기 위한 dev key, Apple App ID와 ATT 대기 시간을 설정합니다.

AppsFlyer 설정

AppBox.configureAppsFlyer(_ config: AppBoxAppsFlyerConfig)

Swift
1 let appsFlyerConfig = AppBoxAppsFlyerConfig(
2 devKey: "<APPSFLYER_DEV_KEY>",
3 appleAppID: "<APPLE_APP_ID>",
4 attTimeout: 60
5 )
6 AppBox.configureAppsFlyer(appsFlyerConfig)
1 AppBoxAppsFlyerConfig *appsFlyerConfig =
2 [[AppBoxAppsFlyerConfig alloc] initWithDevKey:@"<APPSFLYER_DEV_KEY>"
3 appleAppID:@"<APPLE_APP_ID>"
4 attTimeout:60];
5 [AppBox configureAppsFlyerWithConfig:appsFlyerConfig];

Request 항목 정의

Request 항목필수여부설명기본값
config필수AppsFlyer 설정-
config.devKey필수AppsFlyer dev key-
config.appleAppID필수Apple App ID: App Store Connect의 숫자 ID-
config.attTimeout선택ATT 응답 대기 시간60초

Response 항목 정의

Response 결과값
없음반환값과 callback이 모두 없습니다


AppBoxInitConfig.appsFlyer를 전달하면 같은 설정이 초기화 중 자동 적용됩니다. 초기화 config로 설정했다면 이 함수를 다시 호출하지 않습니다. 설정만으로 AppsFlyer가 시작되지는 않습니다. listener 또는 bridge를 준비한 뒤 startAppsFlyer()를 호출합니다.

AppsFlyer 시작

설정된 AppsFlyer SDK를 시작합니다.

AppsFlyer 시작

AppBox.startAppsFlyer()

Swift
1 AppBox.setAppsFlyerDeepLinkListener { result in
2 handleDeepLink(result)
3 }
4 AppBox.startAppsFlyer()
1 [AppBox setAppsFlyerDeepLinkListener:^(AppBoxAppsFlyerDeepLinkResult *result) {
2 [self handleDeepLink:result];
3 }];
4 [AppBox startAppsFlyer];

Request 항목 정의

인자가 없습니다.

Response 항목 정의

Response 결과값
없음반환값과 callback이 모두 없습니다


AppsFlyer 설정 또는 AppBoxInitResult.appsFlyer.status == .INITIALIZED 확인 뒤 호출합니다.

  • Native 결과가 필요하면 listener를 먼저 등록합니다.
  • WebView 결과가 필요하면 JavaScript bridge를 먼저 설정합니다.
  • 앱 lifecycle에서 한 번만 시작합니다.

딥링크 listener 설정

AppsFlyer 딥링크 결과를 받을 Native listener를 설정하거나 교체합니다.

딥링크 listener 설정

AppBox.setAppsFlyerDeepLinkListener(_ listener: ((AppBoxAppsFlyerDeepLinkResult) -> Void)?)

Swift
1 AppBox.setAppsFlyerDeepLinkListener { result in
2 switch result.status {
3 case .found:
4 routeDeepLink(
5 value: result.value,
6 sub1: result.getSubParam(.sub1)
7 )
8 case .notFound:
9 break
10 case .error:
11 print(result.errorMessage ?? "AppsFlyer deep link error")
12 }
13 }
1 [AppBox setAppsFlyerDeepLinkListener:^(AppBoxAppsFlyerDeepLinkResult *result) {
2 switch (result.status) {
3 case AppBoxAppsFlyerDeepLinkStatusFound:
4 [self routeDeepLinkWithValue:result.value
5 sub1:[result getSubParam:AppBoxAppsFlyerSubParamSub1]];
6 break;
7 case AppBoxAppsFlyerDeepLinkStatusNotFound:
8 break;
9 case AppBoxAppsFlyerDeepLinkStatusError:
10 NSLog(@"%@", result.errorMessage ?: @"AppsFlyer deep link error");
11 break;
12 }
13 }];

Request 항목 정의

Request 항목필수여부설명기본값
listener선택딥링크 결과를 받을 closure/block. nil이면 listener 없음nil

Response 항목 정의

Response 결과값
result.status.found, .notFound, .error
result.value발견된 딥링크 값
result.subParamssub1부터 sub10까지의 하위 파라미터
result.rawParamsAppsFlyer 원본 파라미터
result.isDeferreddeferred deep link 여부
result.errorCode, result.errorMessage실패 코드와 설명


listener 등록 → AppsFlyer 설정, 초기화 → startAppsFlyer() 순서를 사용합니다. 해제 의도를 명확히 하려면 clearAppsFlyerDeepLinkListener()를 사용합니다. rawParams에 포함될 수 있는 식별 정보나 token을 로그에 남기지 않습니다.

딥링크 listener 해제

등록된 AppsFlyer Native 딥링크 listener를 해제합니다.

딥링크 listener 해제

AppBox.clearAppsFlyerDeepLinkListener()

Swift
1 AppBox.clearAppsFlyerDeepLinkListener()
1 [AppBox clearAppsFlyerDeepLinkListener];

Request 항목 정의

인자가 없습니다.

Response 항목 정의

Response 결과값
없음반환값과 callback이 모두 없습니다


해제 후에는 Native listener로 새 딥링크 결과를 받지 않습니다. 화면 단위 listener라면 화면 종료 시점에 해제합니다.

AppsFlyer JavaScript bridge 설정

AppsFlyer 딥링크 결과를 AppBox WebView의 JavaScript로 전달하는 bridge를 설정합니다.

AppsFlyer JavaScript bridge 설정

AppBox.configureAppsFlyerJavaScriptBridge(_ config: AppBoxAppsFlyerJavaScriptBridgeConfig)

Swift
1 let bridgeConfig = AppBoxAppsFlyerJavaScriptBridgeConfig(
2 deliverNotFoundAndError: false,
3 pendingLimit: 10
4 )
5 AppBox.configureAppsFlyerJavaScriptBridge(bridgeConfig)
1 AppBoxAppsFlyerJavaScriptBridgeConfig *bridgeConfig =
2 [[AppBoxAppsFlyerJavaScriptBridgeConfig alloc]
3 initWithDeliverNotFoundAndError:NO
4 pendingLimit:10];
5 [AppBox configureAppsFlyerJavaScriptBridgeWithConfig:bridgeConfig];

Request 항목 정의

Request 항목필수여부설명기본값
config필수AppsFlyer JavaScript bridge 설정-
config.deliverNotFoundAndError선택not-found와 error 결과도 웹에 전달할지 여부false
config.pendingLimit선택웹 준비 전 보관할 최대 결과 수10

Response 항목 정의

Response 결과값
없음반환값과 callback이 모두 없습니다


WebView와 AppsFlyer 초기화가 완료된 뒤, startAppsFlyer() 전에 설정합니다. pendingLimit이 음수이면 0으로 보정됩니다. WebView에서 AppsFlyer 결과가 필요할 때만 사용합니다.

AppsFlyer JavaScript bridge 해제

AppBox WebView에 연결된 AppsFlyer JavaScript bridge를 해제합니다.

AppsFlyer JavaScript bridge 해제

AppBox.clearAppsFlyerJavaScriptBridge()

Swift
1 AppBox.clearAppsFlyerJavaScriptBridge()
1 [AppBox clearAppsFlyerJavaScriptBridge];

Request 항목 정의

인자가 없습니다.

Response 항목 정의

Response 결과값
없음반환값과 callback이 모두 없습니다


해제 후에는 새 AppsFlyer 결과가 JavaScript로 전달되지 않습니다. Native listener 설정에는 영향을 주지 않습니다.

URL Scheme 전달

앱이 받은 URL Scheme callback을 Auth와 AppsFlyer 처리 경로에 전달합니다.

URL Scheme 전달

AppBox.handleURL(_ url: URL, options: [UIApplication.OpenURLOptionsKey: Any]) -> Bool

Swift
1 func application(
2 _ application: UIApplication,
3 open url: URL,
4 options: [UIApplication.OpenURLOptionsKey: Any] = [:]
5 ) -> Bool {
6 AppBox.handleURL(url, options: options)
7 }
1 - (BOOL)application:(UIApplication *)application
2 openURL:(NSURL *)url
3 options:(NSDictionary<UIApplicationOpenURLOptionsKey, id> *)options {
4 return [AppBox handleURL:url options:options];
5 }

Request 항목 정의

Request 항목필수여부설명기본값
url필수앱 lifecycle callback이 전달한 URL-
options필수동일 callback이 전달한 URL open options-

Response 항목 정의

Response 결과값
BoolAuth 또는 AppsFlyer 경로에서 URL을 처리했는지 여부


options를 버리지 말고 lifecycle callback이 전달한 값을 함께 전달합니다. AppDelegate와 SceneDelegate에서 같은 URL을 중복 전달하지 않습니다. 앱의 다른 URL router가 있다면 반환값을 기준으로 후속 처리를 결정합니다.

AppDelegate 연결 예제는 AppBoxSampleiOS에서 확인할 수 있습니다.

www.naver.com
QR 코드를 촬영하면 입력하신 주소의
앱 예시 화면을 테스트할 수 있습니다.
* 스캔 후 바로 앱 다운로드 이동합니다.