Hive SDK v4/com.hive/Promotion

Promotion

object Promotion

Hive 프로모션은 게임을 이용하는 유저에게 게임의 새로운 소식이나 이벤트를 효과적으로 노출하는 기능을 제공한다.
Hive Promotion provides you with the ability to effectively expose new news or events to the game user.

korean

프로모션 뷰 (공지, 이벤트), 보상 (쿠폰, 딥링크), 종료 팝업 (안드로이드), 무료 충전소, 리뷰 유도 팝업

english

Promotion view (notice, event), reward (coupon, deep link), exit popup (Android), free charging station(Offerwall)

Since

4.0.0

Types

AppInvitationCampaign

open class AppInvitationCampaign

앱 초대를 위한 캠페인 정보
Campaign information for invite

AppInvitationCampaignStage

class AppInvitationCampaignStage : Promotion.AppInvitationCampaign

AppInvitationData

class AppInvitationData

앱 초대 (UserAcquisition)를 위한 정보
Information for App Invitation (UserAcquisition).

AppInvitationDataListener

interface AppInvitationDataListener

앱 초대 정보 요청에 대한 결과 통지
Return information about request for user invite

AppInvitationSenderInfo

class AppInvitationSenderInfo

AppInvitationSenderInfoListener

interface AppInvitationSenderInfoListener

EngagementEventState

enum EngagementEventState : Enum<Promotion.EngagementEventState>

Hive SDK 가 특정한 조건에서 클라이언트에 개입 (Engagement) 하는 상태
The status that Hive SDK engages clients in certain conditions.

EngagementEventType

enum EngagementEventType : Enum<Promotion.EngagementEventType>

UserEngagement 기능 타입
Function type of UserEngagement

EngagementListener

interface EngagementListener

SDK 가 특정한 조건에서 클라이언트에 개입 (Engagement) 하기 위한 이벤트 리스너
An event listener for the SDK to engage clients in certain conditions.

enum OfferwallState : Enum<Promotion.OfferwallState>

게임내 오퍼월(무료 충전소) 을 호출 할 수 있는 버튼 노출 가능 상태 정보
Information of Offerwall(free charging station) button

class PromotionBadge(var target: Promotion.PromotionBadgeTarget, var contentsKey: String, var badgeType: String) : DataModel

유저에게 새로운 프로모션 내용이 등록 되었음을 알려주기 위한 정보
Badge information to inform users that new promotions are registered

PromotionBadgeInfoListener

interface PromotionBadgeInfoListener

프로모션 뱃지 정보 API 호출에 대한 결과 통지
Hive Promotion badge information.

PromotionBadgeTarget

enum PromotionBadgeTarget : Enum<Promotion.PromotionBadgeTarget>

프로모션 뱃지 정보가 표시될 대상 정보
Information on which promotional badge is displayed

PromotionBanner

class PromotionBanner : DataModel

특정 프로모션에 대한 배너 정보
Banner information for a specific promotion

PromotionBannerInfoListener

interface PromotionBannerInfoListener

프로모션 배너 정보 API 호출에 대한 결과 통지
Hive Promotion banner information.

PromotionBannerType

enum PromotionBannerType : Enum<Promotion.PromotionBannerType>

PromotionCampaignType

enum PromotionCampaignType : Enum<Promotion.PromotionCampaignType>

PromotionCustomType

enum PromotionCustomType : Enum<Promotion.PromotionCustomType>

커스텀 컨텐츠의 형태
Types of Promotion CustomView

PromotionShareListener

interface PromotionShareListener

Hive UA 공유 정보 반환
Returns Hive UA Share information.

PromotionViewInfo

class PromotionViewInfo(var url: String, var postString: String) : DataModel

Promotion 컨텐츠 화면 내용
Information of Promotion webview

PromotionViewInfoListener

interface PromotionViewInfoListener

프로모션 뷰 정보 API 호출에 대한 결과 통지
Results for additional information lookups for promotions

PromotionViewInfoWithJSONListener

interface PromotionViewInfoWithJSONListener

프로모션 뷰 정보 API 호출에 대한 결과 통지
Results for additional information lookups for promotions

PromotionViewListener

interface PromotionViewListener

프로모션 뷰 API 호출에 대한 결과 통지
Results for promotion view APK call

PromotionViewResultType

enum PromotionViewResultType : Enum<Promotion.PromotionViewResultType>

프로모션 뷰 결과 통지시 이벤트 형태
Promotion view event types

PromotionViewType

enum PromotionViewType : Enum<Promotion.PromotionViewType>

프로모션 뷰 창의 형태
Types of Promotion view

PromotionWebviewType

enum PromotionWebviewType : Enum<Promotion.PromotionWebviewType>

어떤 프로모션 타입에 대한 웹뷰인가를 나타내기 위한 형태 정의
Defines the format to display the promotion type of webview

Properties

val offerwallState: Promotion.OfferwallState

게임내에서 무료 충전소를 노출하기 위한 버튼 UI 는 보여지거나 숨길 수 있도록 구성해야 한다.
Returns whether the button is available to invoke an offerwall (free recharging station) within the game.

Functions

getAppInvitationData

fun getAppInvitationData(listener: Promotion.AppInvitationDataListener)

앱 초대를 위한 데이터 조회
Request user invite information

getAppInvitationSenderInfo

fun getAppInvitationSenderInfo(listener: Promotion.AppInvitationSenderInfoListener)

fun getBadgeInfo(listener: Promotion.PromotionBadgeInfoListener)

뱃지 정보 조회
Request badge information

fun getBannerInfo(campaignType: Promotion.PromotionCampaignType, bannerType: Promotion.PromotionBannerType, listener: Promotion.PromotionBannerInfoListener)

배너 정보 조회
Request banner information

getBannerInfoString

fun getBannerInfoString(campaignType: String, bannerType: String, listener: Promotion.PromotionBannerInfoListener)

배너 정보 조회
Request banner information

fun getViewInfo(promotionCustomType: Promotion.PromotionCustomType, contentKey: String, listener: Promotion.PromotionViewInfoListener)

Hive 프로모션 웹뷰 정보 호출
Hive promotion webview information call

fun processURI(uri: String): Boolean

URI를 파싱하여 Event 타입으로 만든다.
Parse the URI to make it an Event type.

setAdditionalInfo

fun setAdditionalInfo(additionalInfo: String)

프로모션 뷰의 특정 이벤트 페이지를 노출하거나 프로모션 서버에 부가 정보를 전달하고 싶을 때 JSON 포맷의 문자열을 설정할 수 있다.
You can set a string in JSON format when you want to expose a specific event page in the Promotion View or want to pass additional information to the Promotion Server.

setEngagementListener

fun setEngagementListener(listener: Promotion.EngagementListener)

Engagement 리스너를 등록한다.
It register the Engagement listener.

setEngagementReady

fun setEngagementReady(bReady: Boolean): ResultAPI

Engagement 이벤트 처리가 가능한지(게임 서버에 DB가 생성된 경우 등) 여부를 설정한다.
It sets whether Engagement event handling is enabled.(Such as when a DB is created in the game server)

showCustomContents

fun showCustomContents(promotionCustomType: Promotion.PromotionCustomType, contentsKey: String, listener: Promotion.PromotionViewListener)

외부 컨텐츠를 사용하기 위해서 커스텀 웹 뷰 노출
Show custom Webview to use external content.

showCustomContentsOnGameWindow

fun showCustomContentsOnGameWindow(promotionCustomType: Promotion.PromotionCustomType, contentsKey: String, listener: Promotion.PromotionViewListener)

fun showExit(listener: Promotion.PromotionViewListener)

종료 확인 팝업 노출 (Android only.)
Show exit popup (Android only)

showNativeReview

fun showNativeReview()

리뷰 유도 팝업 노출
Show review popup

fun showNews(menu: String, giftPidList: ArrayList<Int>? = null, listener: Promotion.PromotionViewListener)

fun showOfferwall(listener: Promotion.PromotionViewListener)

무료 충전소 화면 노출 (Android only.)
Show Offerwall(Free recharging station) (Android only.)

fun showPromotion(promotionType: Promotion.PromotionViewType, isForced: Boolean, listener: Promotion.PromotionViewListener)

게임의 새로운 이벤트나 새로운 게임 소개등의 배너 화면을 노출
Shows banner such as new event of game or introduce new game

fun showReview(listener: Promotion.PromotionViewListener)

Hive 리뷰 유도 팝업 노출
Show hive review popup

fun showUAShare(inviteMessage: String, inviteLink: String, listener: Promotion.PromotionShareListener)

외부 SNS를 통해 UA url을 공유하기 위한 다이얼로그 노출
Show dialog to share UA url via SNS.

updatePromotionData

fun updatePromotionData()

Promotion 정보 갱신
Update information of Promotion