Native In-App과 사용자 여정 | Appbox iOS SDK 가이드
Native In-App과 사용자 여정
| 전제 | 내용 |
|---|---|
| 필요 Product | AppBoxInappMessageSDK + 초기화 설정의 inApp |
| 콘솔 전제 | 여정 event key는 AppBox 콘솔의 watch 목록에 등록돼 있어야 수집됩니다 |
| 웹 브릿지 대응 | inapp.getDeviceUserId, message.trackConversion 등 |
In-App runtime 확인
In-App runtime 확인
Request 항목 정의
Response 항목 정의
| Response 결과값 | |
|---|---|
Bool | Native In-App runtime 포함 여부. 즉시 반환됩니다 |
현재 구현은 항상 true를 반환합니다. Native In-App runtime이 SDK에 내장되어 있어 false가 나오는 경우가 없습니다. 다른 모듈의 is...Available()과 달리 분기 조건으로 쓸 수 없습니다. true는 초기화 성공이나 표시 가능한 캠페인 존재 여부를 의미하지 않습니다. 실제 사용 가능 여부는 AppBoxInitResult.inApp.status로 판단합니다.
캠페인 동기화
캠페인 동기화
Request 항목 정의
| Request 항목 | 필수여부 | 설명 | 기본값 |
|---|---|---|---|
completion | 선택 | 동기화 요청 처리 결과 | nil |
Response 항목 정의
| Response 결과값 | |
|---|---|
success | 캠페인 동기화 처리 성공 여부 |
error | 동기화 실패 원인 |
Native In-App 초기화 시 최초 동기화는 자동 실행됩니다. 사용자 새로고침이나 동기화 완료를 명시적으로 확인해야 할 때만 호출합니다. 앱 시작 직후 자동 동기화와 중복 호출하지 않습니다.
표시 화면 진입
표시 화면 진입
Request 항목 정의
| Request 항목 | 필수여부 | 설명 | 기본값 |
|---|---|---|---|
delay | 선택 | 표시 가능 상태 반영 전 대기 시간(초) | 0 |
Response 항목 정의
| Response 결과값 | |
|---|---|
| 없음 | 반환값과 callback이 모두 없습니다 |
실제로 메시지를 표시해도 되는 화면의 viewDidAppear에서 호출합니다. 같은 화면의 이탈 시점에 leaveInAppDisplayScreen()을 짝으로 호출합니다. Objective-C에서는 기본 인자가 없으므로 0을 명시합니다.
표시 화면 이탈
표시 화면 이탈
Request 항목 정의
Response 항목 정의
| Response 결과값 | |
|---|---|
| 없음 | 반환값과 callback이 모두 없습니다 |
enterInAppDisplayScreen(delay:)를 호출한 화면의 이탈 시점에 호출합니다. 화면 진입, 이탈 호출이 불균형하면 잘못된 화면에 메시지가 표시될 수 있습니다.
특정 캠페인 표시 요청
특정 캠페인 표시 요청
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 설정
In-App 액션 listener 설정
Request 항목 정의
| Request 항목 | 필수여부 | 설명 | 기본값 |
|---|---|---|---|
listener | 선택 | 액션 event를 받을 closure/block. nil이면 해제 | nil |
Response 항목 정의
| Response 결과값 | |
|---|---|
event.campaignCode | 액션이 발생한 캠페인 코드 |
event.action | function, close, link, external, event, conversion, dismiss-today 등 액션 |
event.actionValue | 액션에 설정된 값 |
listener는 액션 알림용이며 화면 표시 완료 callback이 아닙니다. link와 external URL은 SDK가 처리하므로 앱에서 같은 URL을 다시 열지 않습니다. 더 이상 event가 필요하지 않으면 nil로 해제합니다.
사용자 여정 이벤트 기록
사용자 여정 이벤트 기록
Request 항목 정의
| Request 항목 | 필수여부 | 설명 | 기본값 |
|---|---|---|---|
eventKey | 필수 | AppBox 콘솔 watch 목록에 등록한 event key | - |
Response 항목 정의
| Response 결과값 | |
|---|---|
| 없음 | fire-and-forget 함수로 반환값과 callback이 없습니다 |
SDK 초기화가 완료된 뒤 호출합니다. 앞뒤 공백을 제거한 key가 비어 있거나 SDK 예약 key이면 수집되지 않습니다. 호출 직후 저장 완료를 보장하지 않습니다.
전환 기록
전환 기록
Request 항목 정의
| Request 항목 | 필수여부 | 설명 | 기본값 |
|---|---|---|---|
conversionCode | 필수 | AppBox 콘솔에 정의된 전환 코드 | - |
completion | 선택 | 전환 전송 처리 결과 | nil |
Response 항목 정의
| Response 결과값 | |
|---|---|
success | 전환 전송 요청 처리 성공 여부 |
error | 전환 기록 실패 원인 |
Push Product와 성공한 Push 초기화가 선행되어야 합니다. success == true는 transport 성공이며 실제 attribution 성공과 같은 의미가 아닙니다. 같은 사용자 행동에 대해 중복 호출하지 않습니다.
기기 사용자 식별자 조회
기기 사용자 식별자 조회
Request 항목 정의
Response 항목 정의
| Response 결과값 | |
|---|---|
String | SDK 기기 사용자 식별자. 즉시 반환됩니다 |
서비스 회원 ID나 광고 식별자가 아닙니다. 인증, 권한 판단의 근거로 사용하지 않습니다. 개인정보 정책에 따라 취급하고 불필요하게 로그에 남기지 않습니다.