Native In-App과 사용자 여정 | Appbox iOS SDK 가이드

Native In-App과 사용자 여정

전제내용
필요 ProductAppBoxInappMessageSDK + 초기화 설정의 inApp
콘솔 전제여정 event key는 AppBox 콘솔의 watch 목록에 등록돼 있어야 수집됩니다
웹 브릿지 대응inapp.getDeviceUserId, message.trackConversion 등

In-App runtime 확인

앱 target에 Native In-App runtime이 포함되어 있는지 확인합니다.

In-App runtime 확인

AppBox.isInAppAvailable() -> Bool

Swift
1 if AppBox.isInAppAvailable() {
2 AppBox.enterInAppDisplayScreen()
3 }
1 if ([AppBox isInAppAvailable]) {
2 [AppBox enterInAppDisplayScreenWithDelay:0];
3 }

Request 항목 정의

인자가 없습니다.

Response 항목 정의

Response 결과값
BoolNative In-App runtime 포함 여부. 즉시 반환됩니다


현재 구현은 항상 true를 반환합니다. Native In-App runtime이 SDK에 내장되어 있어 false가 나오는 경우가 없습니다. 다른 모듈의 is...Available()과 달리 분기 조건으로 쓸 수 없습니다. true는 초기화 성공이나 표시 가능한 캠페인 존재 여부를 의미하지 않습니다. 실제 사용 가능 여부는 AppBoxInitResult.inApp.status로 판단합니다.

캠페인 동기화

Native In-App 캠페인 정보를 명시적으로 다시 동기화합니다.

캠페인 동기화

AppBox.syncInApp(completion: ((Bool, NSError?) -> Void)?)

Swift
1 AppBox.syncInApp { success, error in
2 if !success {
3 print(error?.localizedDescription ?? "캠페인 동기화 실패")
4 }
5 }
1 [AppBox syncInAppWithCompletion:^(BOOL success, NSError *error) {
2 if (!success) {
3 NSLog(@"%@", error.localizedDescription ?: @"캠페인 동기화 실패");
4 }
5 }];

Request 항목 정의

Request 항목필수여부설명기본값
completion선택동기화 요청 처리 결과nil

Response 항목 정의

Response 결과값
success캠페인 동기화 처리 성공 여부
error동기화 실패 원인


Native In-App 초기화 시 최초 동기화는 자동 실행됩니다. 사용자 새로고침이나 동기화 완료를 명시적으로 확인해야 할 때만 호출합니다. 앱 시작 직후 자동 동기화와 중복 호출하지 않습니다.

표시 화면 진입

현재 화면이 Native In-App 메시지를 표시할 수 있는 상태임을 SDK에 알립니다.

표시 화면 진입

AppBox.enterInAppDisplayScreen(delay: TimeInterval = 0)

Swift
1 override func viewDidAppear(_ animated: Bool) {
2 super.viewDidAppear(animated)
3 AppBox.enterInAppDisplayScreen(delay: 0.3)
4 }
1 - (void)viewDidAppear:(BOOL)animated {
2 [super viewDidAppear:animated];
3 [AppBox enterInAppDisplayScreenWithDelay:0.3];
4 }

Request 항목 정의

Request 항목필수여부설명기본값
delay선택표시 가능 상태 반영 전 대기 시간(초)0

Response 항목 정의

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


실제로 메시지를 표시해도 되는 화면의 viewDidAppear에서 호출합니다. 같은 화면의 이탈 시점에 leaveInAppDisplayScreen()을 짝으로 호출합니다. Objective-C에서는 기본 인자가 없으므로 0을 명시합니다.

표시 화면 이탈

현재 화면이 Native In-App 메시지를 표시할 수 없는 상태임을 SDK에 알립니다.

표시 화면 이탈

AppBox.leaveInAppDisplayScreen()

Swift
1 override func viewDidDisappear(_ animated: Bool) {
2 AppBox.leaveInAppDisplayScreen()
3 super.viewDidDisappear(animated)
4 }
1 - (void)viewDidDisappear:(BOOL)animated {
2 [AppBox leaveInAppDisplayScreen];
3 [super viewDidDisappear:animated];
4 }

Request 항목 정의

인자가 없습니다.

Response 항목 정의

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


enterInAppDisplayScreen(delay:)를 호출한 화면의 이탈 시점에 호출합니다. 화면 진입, 이탈 호출이 불균형하면 잘못된 화면에 메시지가 표시될 수 있습니다.

특정 캠페인 표시 요청

캠페인 코드로 특정 Native In-App 메시지의 표시를 요청합니다.

특정 캠페인 표시 요청

AppBox.showInAppCampaign(_ campaignCode: String, completion: ((Bool, NSError?) -> Void)?)

Swift
1 AppBox.showInAppCampaign("<CAMPAIGN_CODE>") { shownOrQueued, error in
2 if !shownOrQueued {
3 print(error?.localizedDescription ?? "표시할 수 없는 캠페인입니다.")
4 }
5 }
1 [AppBox showInAppCampaign:@"<CAMPAIGN_CODE>"
2 completion:^(BOOL shownOrQueued, NSError *error) {
3 if (!shownOrQueued) {
4 NSLog(@"%@", error.localizedDescription ?: @"표시할 수 없는 캠페인입니다.");
5 }
6 }];

Request 항목 정의

Request 항목필수여부설명기본값
campaignCode필수AppBox 콘솔의 Native In-App 캠페인 코드-
completion선택표시 요청 처리 결과nil

Response 항목 정의

Response 결과값
shownOrQueued메시지가 표시됐거나 표시 대기열에 들어가면 true
error건너뜀 또는 내부 처리 실패 원인


In-App 초기화와 캠페인 동기화가 완료되고 표시 가능 화면에 진입한 뒤 호출합니다. 캠페인 기간, 빈도, 오늘 보지 않기, 화면 조건 또는 콘텐츠 상태 때문에 건너뛰면 false와 AppBoxInappMessage domain의 code 0이 전달될 수 있습니다. 내부 처리 실패는 false와 code -1로 구분됩니다.

In-App 액션 listener 설정

사용자가 Native In-App 메시지에서 실행한 액션을 받을 listener를 설정하거나 해제합니다.

In-App 액션 listener 설정

AppBox.setInAppActionListener(_ listener: ((AppBoxInAppActionEvent) -> Void)?)

Swift
1 AppBox.setInAppActionListener { event in
2 if event.action == "function" {
3 handleCustomAction(event.actionValue)
4 }
5 }
6
7 // 해제
8 AppBox.setInAppActionListener(nil)
1 [AppBox setInAppActionListener:^(AppBoxInAppActionEvent *event) {
2 if ([event.action isEqualToString:@"function"]) {
3 [self handleCustomAction:event.actionValue];
4 }
5 }];
6
7 // 해제
8 [AppBox setInAppActionListener:nil];

Request 항목 정의

Request 항목필수여부설명기본값
listener선택액션 event를 받을 closure/block. nil이면 해제nil

Response 항목 정의

Response 결과값
event.campaignCode액션이 발생한 캠페인 코드
event.actionfunction, close, link, external, event, conversion, dismiss-today 등 액션
event.actionValue액션에 설정된 값


listener는 액션 알림용이며 화면 표시 완료 callback이 아닙니다. link와 external URL은 SDK가 처리하므로 앱에서 같은 URL을 다시 열지 않습니다. 더 이상 event가 필요하지 않으면 nil로 해제합니다.

사용자 여정 이벤트 기록

AppBox 콘솔의 watch 목록에 등록된 사용자 여정 event를 기록합니다.

사용자 여정 이벤트 기록

AppBox.trackJourneyEvent(_ eventKey: String)

Swift
1 AppBox.trackJourneyEvent("product_view")
1 [AppBox trackJourneyEvent:@"product_view"];

Request 항목 정의

Request 항목필수여부설명기본값
eventKey필수AppBox 콘솔 watch 목록에 등록한 event key-

Response 항목 정의

Response 결과값
없음fire-and-forget 함수로 반환값과 callback이 없습니다


SDK 초기화가 완료된 뒤 호출합니다. 앞뒤 공백을 제거한 key가 비어 있거나 SDK 예약 key이면 수집되지 않습니다. 호출 직후 저장 완료를 보장하지 않습니다.

전환 기록

지정한 전환 코드를 AppBox에 기록합니다.

전환 기록

AppBox.trackConversion(_ conversionCode: String, completion: ((Bool, NSError?) -> Void)?)

Swift
1 AppBox.trackConversion("<CONVERSION_CODE>") { success, error in
2 if !success {
3 print(error?.localizedDescription ?? "전환 기록 실패")
4 }
5 }
1 [AppBox trackConversion:@"<CONVERSION_CODE>"
2 completion:^(BOOL success, NSError *error) {
3 if (!success) {
4 NSLog(@"%@", error.localizedDescription ?: @"전환 기록 실패");
5 }
6 }];

Request 항목 정의

Request 항목필수여부설명기본값
conversionCode필수AppBox 콘솔에 정의된 전환 코드-
completion선택전환 전송 처리 결과nil

Response 항목 정의

Response 결과값
success전환 전송 요청 처리 성공 여부
error전환 기록 실패 원인


Push Product와 성공한 Push 초기화가 선행되어야 합니다. success == true는 transport 성공이며 실제 attribution 성공과 같은 의미가 아닙니다. 같은 사용자 행동에 대해 중복 호출하지 않습니다.

기기 사용자 식별자 조회

SDK가 Native 여정과 Push 통계에 사용하는 기기 사용자 식별자를 조회합니다.

기기 사용자 식별자 조회

AppBox.getDeviceUserId() -> String

Swift
1 let deviceUserId = AppBox.getDeviceUserId()
1 NSString *deviceUserId = [AppBox getDeviceUserId];

Request 항목 정의

인자가 없습니다.

Response 항목 정의

Response 결과값
StringSDK 기기 사용자 식별자. 즉시 반환됩니다


서비스 회원 ID나 광고 식별자가 아닙니다. 인증, 권한 판단의 근거로 사용하지 않습니다. 개인정보 정책에 따라 취급하고 불필요하게 로그에 남기지 않습니다.

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