Hybrid App
해당 연동 가이드는 하이브리드 환경 내에서 SDK 기능을 제공해 주는 가이드 문서입니다.
1. SDK 설치
1.1 Android
기본 설정위 링크에 안내되어 있는 SDK Gradle 설치 및 AndroidManaifest.xml 설정을 완료해 줍니다.
AdPopcornSSP v3.9.0 버전부터 지원합니다.
1.2 iOS
기본 설정위 링크에 안내되어 있는 SDK 설치 및 IDFA 설정을 완료해 줍니다.
iOS v2.10.7 버전부터 지원합니다.
2. 네이티브 웹뷰 연동
2.1 WebView 내 Javascript interface 설정
WebView 내 Javascript 설정을 활성화 및 AdPopcornSSPJsBridge 관련 세팅을 진행합니다.
반드시, name은 AdPopcornSSPJsBridge로 선언해 주어야 웹(HTML)과 통신이 이루어집니다.
3. 웹 Javacript API 연동
3.1 기본 연동
3.1.1 초기화
SDK 초기화 시 사용되는 API 입니다.
3.1.2 해제 API(Only Android)
SDK 해제 시 사용되는 API 입니다.
3.2 전면 광고
3.2.1 전면 광고 요청
전면 형태의 광고 요청이 필요할 때 사용되는 API 입니다.
appKey : 앱키
placementId: 지면키
3.2.2 전면 광고 노출
전면 광고 노출 시 사용되는 API 입니다.
appKey : 앱키
placementId: 지면키
3.2.3 전면 광고 이벤트
전면 광고 관련 이벤트를 받고자 할 때 사용됩니다.
(전면) 지원되는 이벤트
OnInterstitialLoaded (- placementId)
전면 광고 로드 성공
OnInterstitialLoadFailed (- placementId, errorCode)
전면 광고 로드 실패
OnInterstitialOpened (- placementId)
전면 광고 노출 성공
OnInterstitialOpenFailed (- placementId, errorCode)
전면 광고 노출 실패
OnInterstitialClosed (- placementId)
전면 광고 닫기
OnInterstitialClicked (- placementId)
전면 광고 클릭
OnInterstitialLoadSuccess (- placementId)
전면 광고 로드 성공
OnInterstitialLoadFail (- placementId, errorCode)
전면 광고 로드 실패
OnInterstitialShowSuccess (- placementId)
전면 광고 노출 성공
OnInterstitialShowFail (- placementId, errorCode)
전면 광고 노출 실패
OnInterstitialClosed (- placementId)
전면 광고 닫기
OnInterstitialClicked (- placementId)
전면 광고 클릭
3.3 전면 비디오 광고
3.3.1 전면 비디오광고 요청
전면 형태의 비디오광고 요청이 필요할 때 사용되는 API 입니다.
appKey : 앱키
placementId: 지면키
3.3.2 전면 비디오광고 노출
전면 비디오광고 노출 시 사용되는 API 입니다.
appKey : 앱키
placementId: 지면키
3.3.3 전면 비디오 광고 이벤트
전면 비디오광고 관련 이벤트를 받고자 할 때 사용됩니다.
(전면 비디오) 지원되는 이벤트
OnInterstitialVideoAdLoaded (- placementId)
전면 비디오 광고 로드 성공
OnInterstitialVideoAdLoadFailed (- placementId, errorCode)
전면 비디오 광고 로드 실패
OnInterstitialVideoAdOpened (- placementId)
전면 비디오 광고 노출 성공
OnInterstitialVideoAdOpenFailed (- placementId, errorCode)
전면 비디오 광고 노출 실패
OnInterstitialVideoAdClosed (- placementId)
전면 비디오 광고 닫기
OnInterstitialVideoAdClicked (- placementId)
전면 비디오 광고 클릭
OnInterstitialVideoLoadSuccess (- placementId)
전면 비디오 광고 로드 성공
OnInterstitialVideoLoadFail (- placementId, errorCode)
전면 비디오 광고 로드 실패
OnInterstitialVideoShowSuccess (- placementId)
전면 비디오 광고 노출 성공
OnInterstitialVideoShowFail (- placementId)
전면 비디오 광고 노출 실패
OnInterstitialVideoClosed (- placementId)
전면 비디오 광고 닫기
3.4 리워드 비디오 광고
3.4.1 리워드 비디오광고 요청
리워드 비디오광고 요청이 필요할 때 사용되는 API 입니다.
appKey : 앱키
placementId: 지면키
3.4.2 리워드 비디오광고 노출
리워드 비디오광고 노출 시 사용되는 API 입니다.
appKey : 앱키
placementId: 지면키
3.4.3 리워드비디오 광고 이벤트
리워드비디오광고 관련 이벤트를 받고자 할 때 사용됩니다.
(리워드 비디오) 지원되는 이벤트
OnRewardVideoAdLoaded (- placementId)
리워드 비디오 광고 로드 성공
OnRewardVideoAdLoadFailed (- placementId, errorCode)
리워드 비디오 광고 로드 실패
OnRewardVideoAdOpened (- placementId)
리워드 비디오 광고 노출 성공
OnRewardVideoAdOpenFailed (- placementId, errorCode)
리워드 비디오 광고 노출 실패
OnRewardVideoPlayCompleted (- placementId)
리워드 비디오 광고 재생 완료
OnRewardVideoAdClosed (- placementId)
리워드 비디오 광고 닫기
OnRewardVideoAdClicked (- placementId)
리워드 비디오 광고 클릭
OnRewardVideoLoadSuccess (- placementId)
리워드 비디오 광고 로드 성공
OnRewardVideoLoadFail (- placementId, errorCode)
리워드 비디오 광고 로드 실패
OnRewardVideoShowSuccess (- placementId)
리워드 비디오 광고 노출 성공
OnRewardVideoShowFail (- placementId)
리워드 비디오 광고 노출 실패
OnRewardVideoPlayCompleted (- placementId)
리워드 비디오 광고 재생 완료
OnRewardVideoClosed (- placementId)
리워드비디오 광고 닫기
3.5 비디오 믹스 광고
3.5.1 비디오 믹스광고 요청
비디오 믹스 광고 요청이 필요할 때 사용되는 API 입니다.
appKey : 앱키
placementId: 지면키
3.5.2 비디오 믹스광고 노출
비디오 믹스광고 노출 시 사용되는 API 입니다.
appKey : 앱키
placementId: 지면키
3.5.3 비디오 믹스광고 이벤트
비디오 믹스광고 관련 이벤트를 받고자 할 때 사용됩니다.
(비디오 믹스) 지원되는 이벤트
OnVideoMixAdLoaded (- placementId)
비디오 믹스 광고 로드 성공
OnVideoMixAdLoadFailed (- placementId, errorCode)
비디오 믹스 광고 로드 실패
OnVideoMixAdOpened (- placementId)
비디오 믹스 광고 노출 성공
OnVideoMixAdOpenFailed (- placementId, errorCode)
비디오 믹스 광고 노출 실패
OnVideoMixPlayCompleted (- placementId)
비디오 믹스 광고 재생 완료
OnVideoMixAdClosed (- placementId - campaignType : 2(전면), 4(리워드 비디오), 6(전면 비디오))
비디오 믹스 광고 닫기
OnVideoMixAdClicked (- placementId)
비디오 믹스 광고 클릭
OnVideoMixLoadSuccess (- placementId)
비디오 믹스 광고 로드 성공
OnVideoMixLoadFail (- placementId, errorCode)
비디오 믹스 광고 로드 실패
OnVideoMixShowSuccess (- placementId)
비디오 믹스 광고 노출 성공
OnVideoMixShowFail (- placementId)
비디오 믹스 광고 노출 실패
OnVideoMixPlayCompleted (- placementId - campaignType : 2(전면), 4(리워드 비디오), 6(전면 비디오))
비디오 믹스 광고 재생 완료
OnVideoMixClosed (- placementId)
비디오 믹스 광고 닫기
3.6 보상형 광고 플러스 연동
3.6.1 유저 식별값(USN) 입력
보상형 광고 플러스 기능을 활성화 및 활용하기 위해서는 반드시 유저의 식별값이 지정되어야 합니다.
유저 식별값은 리워드 지급 조건이 달성 되었을 때 완료 유저를 식별하기 위해 사용되는 값입니다.
주의 사항
1명의 유저는 1개의 고유한 유저 식별값을 가져야 하며, 가변적인 값을 사용해서는 안됩니다.
개인정보(이메일, 이름, 전화번호, 식별 가능한 유저 아이디 등)이 포함되어서는 안됩니다.
한글, 특수 문자, 공백 등이 포함된 경우에는 반드시 URL 인코딩 처리를 하여 사용하여야 합니다.
유저가 비디오 광고 로딩 전에 설정되어야 합니다.
개발 서버에서 사용한 특정 USN값을 라이브 서버에서 유저가 할당받지 않도록 예외 처리를 하거나, 개발 서버에서 사용하는 USN은 별도 구분값을 설정해주셔야 합니다.
위 주의 사항에 유의하여 유저 식별값을 입력합니다.
userId : 유저 식별값
3.6.2 보상형 광고 플러스 세팅 페이지 연동
유저의 CS 문의 및 현재 리워드 참여 횟수 확인을 위해서는 세팅 페이지 연동이 반드시 필요합니다.
버튼 등의 진입 경로를 만든 후, 아래 API를 연동하여 유저가 세팅 페이지 진입이 가능하도록 합니다.
3.6.3 보상형 광고 플러스 이벤트 처리
보상형 광고 플러스에서 발생되는 이벤트를 전달 받고자 할 경우 아래 api를 호출합니다.
api 를 호출 한 뒤에는 아래의 이벤트를 전달 받을 수 있습니다.
OnClosedRewardAdPlusPage
보상형 광고 플러스 세팅 페이지 닫기 이벤트
OnRewardAdPlusEventResult
보상형 광고 플러스 1차 광고 리워드 처리 결과
OnVideoMixLoadSuccess (- placementId)
비디오 믹스 광고 로드 성공
OnVideoMixLoadFail (- placementId, errorCode)
비디오 믹스 광고 로드 실패
3.6.4 보상형 광고 플러스 사용자 정보 조회
현재 유저의 사용 정보를 직접 조회하고자 할 땐, 아래의 API를 활용 가능합니다.
현재사용자의 전체 사용 정보 조회
api 를 호출 한 뒤에는 아래의 이벤트를 전달 받을 수 있습니다.
OnRewardAdPlusUserMediaStatus
현재사용자의 전체 사용 정보 조회
ㄴtotalBoxCount
전체 받은 포인트 박스
ㄴplacementStatusList
ㄴplacementStatusList.placementId
지면키
ㄴplacementStatusList.dailyUserLimit
일별 유저 한도
ㄴplacementStatusList.dailyUserCount
일별 유저 참여 횟수
OnRewardAdPlusUserMediaStatus
현재사용자의 전체 사용 정보 조회
ㄴtotalBoxCount
전체 받은 포인트 박스
ㄴplacementStatusList
ㄴplacementStatusList.placementID
지면키
ㄴplacementStatusList.limit
일별 유저 한도
ㄴplacementStatusList.current
일별 유저 참여 횟수
사용자의 특정 지면에 대한 사용 정보 조회
api 를 호출 한 뒤에는 아래의 이벤트를 전달 받을 수 있습니다.
OnRewardAdPlusUserPlacementStatus
현재 사용자의 특정 지면 사용 정보 조회
ㄴplacementId
지면키
ㄴdailyUserLimit
일별 유저 한도
ㄴdailyUserCount
일별 유저 참여 횟수
OnRewardAdPlusUserPlacementStatus
현재 사용자의 특정 지면 사용 정보 조회
ㄴplacementId
지면키
ㄴdailyUserLimit
일별 유저 한도
ㄴdailyUserCount
일별 유저 참여 횟수
Last updated
Was this helpful?