HIVE 프로모션은 게임을 이용하는 유저에게 게임의 새로운 소식이나 이벤트를 효과적으로 노출하는 기능을 제공한다
프로모션 뷰 (공지, 이벤트), 보상 (쿠폰, 딥링크), 종료 팝업 (안드로이드), 무료 충전소, 리뷰 유도 팝업

더 자세히 ...

클래스
class	hive.Promotion
	HIVE 프로모션은 게임을 이용하는 유저에게 게임의 새로운 소식이나 이벤트를 효과적으로 노출하는 기능을 제공한다 프로모션 뷰 (공지, 이벤트), 보상 (쿠폰, 딥링크), 종료 팝업 (안드로이드), 무료 충전소, 리뷰 유도 팝업 더 자세히 ...

class	hive.PromotionViewInfo
	Promotion 컨텐츠 화면 내용 (HIVE 프로모션 웹 뷰의 UI 를 게임 UI 의 컨셉에 맞추기 위해서 프로모션 웹 뷰를 게임에서 직접 표시하기 위한 정보) 더 자세히 ...

class	hive.PromotionBadgeInfo
	유저에게 새로운 프로모션 내용이 등록 되었음을 알려주기 위한 정보 더 자세히 ...

class	hive.PromotionBannerInfo
	특정 프로모션에 대한 배너 정보 더 자세히 ...

class	hive.AppInvitationData
	앱 초대 (UserAcquisition)를 위한 정보. 더 자세히 ...

class	hive.AppInvitationCampaign
	앱 초대를 위한 캠패인 정보 캠페인은 초대에 대한 보상을 달상하기 위한 조건을 명시한 데이터. 더 자세히 ...

class	hive.AppInvitationSenderInfo
	UA를 통해 자신을 앱으로 최초 초대한 유저의 정보 더 자세히 ...

열거형 타입
enum	hive.PromotionType { hive.PromotionType.BANNERLEGACY = -1 , hive.PromotionType.BANNER , hive.PromotionType.NEWS , hive.PromotionType.NOTICE }
	프로모션 뷰 창의 형태 더 자세히 ...

enum	hive.PromotionCustomType { hive.PromotionCustomType.VIEW , hive.PromotionCustomType.BOARD , hive.PromotionCustomType.SPOT , hive.PromotionCustomType.DIRECT }
	커스텀 컨텐츠의 형태 더 자세히 ...

enum	hive.PromotionEventType { hive.PromotionEventType.OPEN , hive.PromotionEventType.CLOSE , hive.PromotionEventType.START_PLAYBACK , hive.PromotionEventType.FINISH_PLAYBACK , hive.PromotionEventType.EXIT , GOBACK }
	프로모션 뷰 결과 통지시 이벤트 형태 더 자세히 ...

enum	hive.PromotionBadgeTarget
	프로모션 뱃지 정보가 표시될 대상 정보 만약 NOTICE 이면 공지사항 관련 뱃지를 표시해야한다

enum	hive.OfferwallState { hive.OfferwallState.ENABLED , hive.OfferwallState.DISABLED , hive.OfferwallState.UNKNOWN }
	게임내 오퍼월(무료 충전소) 을 호출 할 수 있는 버튼 노출 가능 상태 정보 더 자세히 ...

함수
delegate void	hive.Promotion.onPromotionView (ResultAPI result, PromotionEventType promotionEventType)
	프로모션 뷰 API 결과 통지

delegate void	hive.Promotion.onPromotionViewInfo (ResultAPI result, List< PromotionViewInfo > viewInfo)
	HIVE 프로모션 웹 뷰의 UI 를 게임 UI 의 컨셉에 맞추기 위해서 프로모션 웹 뷰를 게임에서 직접 구현하기 위한 데이터 반환

delegate void	hive.Promotion.onPromotionBadgeInfo (ResultAPI result, List< PromotionBadgeInfo > badgeInfoList)
	HIVE 프로모션 뱃지 정보 반환

delegate void	hive.Promotion.onPromotionBannerInfo (ResultAPI result, List< PromotionBannerInfo > bannerInfoList)
	프로모션 배너 정보 API 호출에 대한 결과 통지

delegate void	hive.Promotion.onAppInvitationData (ResultAPI result, AppInvitationData appInvitationData)
	앱 초대 (UserAcquisition) 정보 요청에 대한 정보 반환

delegate void	hive.Promotion.onEngagement (ResultAPI result, EngagementEventType engagementEventType, EngagementEventState engagementEventState, JSONObject param)
	SDK 가 특정한 조건에서 클라이언트에 개입 (Engagement) 하기 위한 이벤트 리스너.

delegate void	hive.Promotion.onAppInvitationSenderInfo (ResultAPI result, AppInvitationSenderInfo senderInfo)
	UA를 통해 자신을 앱으로 최초로 초대 성공한 유저의 정보 반환 한다.

static void	hive.Promotion.showPromotion (PromotionType promotionType, Boolean isForced, onPromotionView listener)
	게임의 새로운 이벤트나 새로운 게임 소개등의 배너 화면을 노출

static void	hive.Promotion.showCustomContents (PromotionCustomType customType, String contentsKey, onPromotionView listener)
	외부 컨텐츠를 사용하기 위해서 커스텀 웹 뷰 노출

static void	hive.Promotion.showCustomContentsOnGameWindow (PromotionCustomType customType, String contentsKey, onPromotionView listener)
	외부 컨텐츠를 사용하기 위해서 커스텀 웹 뷰 노출

static void	hive.Promotion.showNews (String menu, List< int > giftPidList, onPromotionView listener)
	게임의 새로운 이벤트나 새로운 게임 소개등의 새소식 화면을 노출

static OfferwallState	hive.Promotion.getOfferwallState ()
	게임내에서 무료 충전소를 노출하기 위한 버튼 UI 는 보여지거나 숨길 수 있도록 구성해야 한다.

static void	hive.Promotion.showOfferwall (onPromotionView listener)
	무료 충전소 화면 노출 (Android only.) 무료 충전소는 HIVE 게임 간의 광고 네트워크로 기존 HIVE 유저들이 새로운 HIVE 게임을 이용할 수 있도록 유도하는 기능이다.

static void	hive.Promotion.showNativeReview ()
	리뷰 유도 팝업 노출 게임 유저들의 긍정적인 평점 및 사용 후기는 다른 유저들이 게임을 이용하는데 영향을 미치게 된다.

static void	hive.Promotion.showReview (onPromotionView listener)
	리뷰 유도 팝업 노출 게임 유저들의 긍정적인 평점 및 사용 후기는 다른 유저들이 게임을 이용하는데 영향을 미치게 된다.

static void	hive.Promotion.showExit (onPromotionView listener)
	종료 확인 팝업 노출 (Android only.) 이용 중인 게임을 종료 하려는 유저에게 새로운 HIVE 게임의 다운로드를 유도하기 위해 '더 많은 게임'이란 버튼을 노출한다

static void	hive.Promotion.getViewInfo (PromotionCustomType customType, String contentsKey, onPromotionViewInfo listener)
	HIVE 프로모션 웹 뷰의 UI 를 게임 UI 의 컨셉에 맞추기 위해서 프로모션 웹 뷰를 게임에서 직접 구현 할 수 있다 이 메서드는 게임에서 HIVE 프로모션 웹 뷰를 커스터 마이징하기 위한 정보를 반환한다.

static void	hive.Promotion.getBadgeInfo (onPromotionBadgeInfo listener)
	뱃지 정보 조회 프로모션 뱃지는 유저에게 새로운 프로모션 내용이 등록 되었음을 알려주기 위해서 게임의 버튼 UI 를 부각하는 정보이다

static void	hive.Promotion.getBannerInfo (PromotionCampaignType campaignType, PromotionBannerType bannerType, onPromotionBannerInfo listener)
	배너 정보 조회 특정 프로모션에 대한 배너 정보를 요청한다.

static void	hive.Promotion.getBannerInfoString (String campaignType, String bannerType, onPromotionBannerInfo listener)
	배너 정보 조회 특정 프로모션에 대한 배너 정보를 요청한다.

static void	hive.Promotion.getAppInvitationData (onAppInvitationData listener)
	앱 초대를 위한 데이터 조회 게임에서 더 많은 사용자를 유치하기 위해서 앱 설치 유도 기능을 제공한다.

static void	hive.Promotion.showUAShare (String inviteMessage, String inviteLink, onPromotionShare listener)
	외부 SNS를 통해 UA url을 공유하기 위한 다이얼로그 노출

static void	hive.Promotion.setAdditionalInfo (String additionalInfo)
	프로모션 뷰의 특정 이벤트 페이지를 노출하거나 프로모션 서버에 부가 정보를 전달하고 싶을 때 JSON 포맷의 문자열을 설정할 수 있다

static ResultAPI	hive.Promotion.setEngagementReady (Boolean isReady)
	Engagement 이벤트 처리가 가능한지(게임 서버에 DB가 생성된 경우 등) 여부를 설정한다.

static void	hive.Promotion.setEngagementListener (onEngagement listener)
	Engagement 리스너를 등록한다.

static Boolean	hive.Promotion.processURI (String uri)
	URI를 파싱하여 Event 타입으로 만든다.

static void	hive.Promotion.updatePromotionData ()
	/~korean Promotion 정보 갱신 Promotion 새소식 페이지 등의 노출에 필요한 정보를 갱신한다.

static void	hive.Promotion.getAppInvitationSenderInfo (onAppInvitationSenderInfo listener)
	UA를 통해 자신을 앱으로 최초 초대한 유저의 정보 반환 한다.

상세한 설명

HIVE 프로모션은 게임을 이용하는 유저에게 게임의 새로운 소식이나 이벤트를 효과적으로 노출하는 기능을 제공한다
프로모션 뷰 (공지, 이벤트), 보상 (쿠폰, 딥링크), 종료 팝업 (안드로이드), 무료 충전소, 리뷰 유도 팝업

열거형 타입 문서화

◆ OfferwallState

enum hive.OfferwallState

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

열거형 멤버
ENABLED	게임내 무료 충전 버튼 노출 가능
DISABLED	게임내 무료 충전 버튼 노출 불가능
UNKNOWN	상태를 알 수 없음

◆ PromotionCustomType

enum hive.PromotionCustomType

커스텀 컨텐츠의 형태

작성자: kjkim

열거형 멤버
VIEW	커스텀 뷰
BOARD	커스텀 보드
SPOT	스팟 배너
DIRECT	다이렉트 캠페인

◆ PromotionEventType

enum hive.PromotionEventType

프로모션 뷰 결과 통지시 이벤트 형태

작성자: ryuvsken

열거형 멤버
OPEN	프로모션 뷰 창이 열렸을 때
CLOSE	프로모션 뷰 창이 닫혔을 때
START_PLAYBACK	영상 재생이 시작되었을 때
FINISH_PLAYBACK	영상 재생이 완료되었을 때
EXIT	종료(더 많은 게임 보기) 팝업에서 종료하기를 선택했을 때

◆ PromotionType

enum hive.PromotionType

프로모션 뷰 창의 형태

작성자: ryuvsken

열거형 멤버
BANNERLEGACY	전면배너 (웹뷰)
BANNER	전면배너
NEWS	새소식
NOTICE	공지사항

함수 문서화

◆ getAppInvitationData()

static void hive.Promotion.getAppInvitationData ( onAppInvitationData listener )

static

앱 초대를 위한 데이터 조회
게임에서 더 많은 사용자를 유치하기 위해서 앱 설치 유도 기능을 제공한다.

앱 설치 유도는 유저 애퀴지션 (User Acquisition) 이라고도 부른다.
앱의 초대를 위한 데이터는 QR Code, 초대링크, 캠페인 등이 있다.
캠페인은 초대에 대한 보상을 달상하기 위한 조건을 명시한 데이터이다.
초대 URL 또는 QR코드를 통해 초대받은 유저가 게임을 설치하고, 특정 레벨 달성 등과 같은 조건(백오피스에서 조건 및 보상 설정 가능)을 달성했을 때 초대한 유저와 초대받은 유저 모두에게 보상을 제공한다.

매개변수

listener API 호출 결과.

◆ getAppInvitationSenderInfo()

static void hive.Promotion.getAppInvitationSenderInfo ( onAppInvitationSenderInfo listener )

static

UA를 통해 자신을 앱으로 최초 초대한 유저의 정보 반환 한다.

SDK 초기화, 로그인, setEngagementReady(true) 호출 이후 최초 초대자 정보 전달이 가능하다.

매개변수

listener API 결과 통지 리스터

◆ getBadgeInfo()

static void hive.Promotion.getBadgeInfo ( onPromotionBadgeInfo listener )

static

뱃지 정보 조회
프로모션 뱃지는 유저에게 새로운 프로모션 내용이 등록 되었음을 알려주기 위해서 게임의 버튼 UI 를 부각하는 정보이다

매개변수

listener API 결과 통지

◆ getBannerInfo()

static void hive.Promotion.getBannerInfo	(	PromotionCampaignType	campaignType,
		PromotionBannerType	bannerType,
		onPromotionBannerInfo	listener )

static

배너 정보 조회
특정 프로모션에 대한 배너 정보를 요청한다.

게임 서버에서 배너 정보를 조회하기 위해 사용된다.

매개변수

campaignType	"event", "notice", "all", "cross"
handler	API 결과 통지

◆ getBannerInfoString()

static void hive.Promotion.getBannerInfoString	(	String	campaignType,
		String	bannerType,
		onPromotionBannerInfo	listener )

static

배너 정보 조회
특정 프로모션에 대한 배너 정보를 요청한다.

게임 서버에서 배너 정보를 조회하기 위해 사용된다.

매개변수

campaignType	campaignType
bannerType	bannerType
handler	API 결과 통지

◆ getOfferwallState()

static OfferwallState hive.Promotion.getOfferwallState ( )

static

게임내에서 무료 충전소를 노출하기 위한 버튼 UI 는 보여지거나 숨길 수 있도록 구성해야 한다.

이 메서드는 게임내에서 오퍼월(무료 충전소) 을 호출 할 수 있는 버튼 노출 가능 여부를 반환한다.

반환값: 오퍼월(무료 충전소) 을 호출 할 수 있는 버튼 노출 가능 여부

◆ getViewInfo()

static void hive.Promotion.getViewInfo	(	PromotionCustomType	customType,
		String	contentsKey,
		onPromotionViewInfo	listener )

static

HIVE 프로모션 웹 뷰의 UI 를 게임 UI 의 컨셉에 맞추기 위해서 프로모션 웹 뷰를 게임에서 직접 구현 할 수 있다
이 메서드는 게임에서 HIVE 프로모션 웹 뷰를 커스터 마이징하기 위한 정보를 반환한다.

매개변수

listener API 결과 통지

◆ onAppInvitationData()

delegate void hive.Promotion.onAppInvitationData	(	ResultAPI	result,
		AppInvitationData	appInvitationData )

앱 초대 (UserAcquisition) 정보 요청에 대한 정보 반환

매개변수

result	API 호출 결과
appInvitationData	앱 초대 정보

◆ onAppInvitationSenderInfo()

delegate void hive.Promotion.onAppInvitationSenderInfo	(	ResultAPI	result,
		AppInvitationSenderInfo	senderInfo )

UA를 통해 자신을 앱으로 최초로 초대 성공한 유저의 정보 반환 한다.

매개변수

result	API 호출 결과
senderInfo	자신을 앱으로 최초로 초대 성공한 유저의 정보

◆ onEngagement()

delegate void hive.Promotion.onEngagement	(	ResultAPI	result,
		EngagementEventType	engagementEventType,
		EngagementEventState	engagementEventState,
		JSONObject	param )

SDK 가 특정한 조건에서 클라이언트에 개입 (Engagement) 하기 위한 이벤트 리스너.

여기서 특정한 조건은 모바일 메시지 (SMS), 푸시 알림 (Push Notification) 으로 전송된 메시지의 URL 클릭이나 프로모션 뷰에서 사용자 동작 등이 있다.

매개변수

result	API 호출 결과
engagementEventType	이벤트 타입
engagementEventState	이벤트 상태
param	이벤트 정보

◆ onPromotionBadgeInfo()

delegate void hive.Promotion.onPromotionBadgeInfo	(	ResultAPI	result,
		List< PromotionBadgeInfo >	badgeInfoList )

HIVE 프로모션 뱃지 정보 반환

매개변수

result	API 호출 결과
badgeInfoList	프로모션 뱃지 정보

◆ onPromotionBannerInfo()

delegate void hive.Promotion.onPromotionBannerInfo	(	ResultAPI	result,
		List< PromotionBannerInfo >	bannerInfoList )

프로모션 배너 정보 API 호출에 대한 결과 통지

매개변수

result	API 호출 결과
bannerInfos	프로모션 배너 정보

◆ onPromotionView()

delegate void hive.Promotion.onPromotionView	(	ResultAPI	result,
		PromotionEventType	promotionEventType )

프로모션 뷰 API 결과 통지

매개변수

result	API 호출 결과
promotionEventType	프로모션 창 이벤트 형태

◆ onPromotionViewInfo()

delegate void hive.Promotion.onPromotionViewInfo	(	ResultAPI	result,
		List< PromotionViewInfo >	viewInfo )

HIVE 프로모션 웹 뷰의 UI 를 게임 UI 의 컨셉에 맞추기 위해서 프로모션 웹 뷰를 게임에서 직접 구현하기 위한 데이터 반환

매개변수

result	API 호출 결과
viewInfo	프로모션 웹 뷰 정보

◆ processURI()

static Boolean hive.Promotion.processURI ( String uri )

static

URI를 파싱하여 Event 타입으로 만든다.

매개변수

URI 파싱할 URI

반환값: 파싱에 문제가 없으면 true, 아니면 false.

◆ setAdditionalInfo()

static void hive.Promotion.setAdditionalInfo ( String additionalInfo )

static

프로모션 뷰의 특정 이벤트 페이지를 노출하거나 프로모션 서버에 부가 정보를 전달하고 싶을 때 JSON 포맷의 문자열을 설정할 수 있다

(필수)서버군이 따로 없는 단일 서버군이라도 아래 예제대로 넣어야 함
ex)"addtionalInfo":"{"server":"0","character":"0"}"

매개변수

additionalInfo (필수) JSON 포맷의 부가 정보 데이터

◆ setEngagementListener()

static void hive.Promotion.setEngagementListener ( onEngagement listener )

static

Engagement 리스너를 등록한다.

매개변수

listener

◆ setEngagementReady()

static ResultAPI hive.Promotion.setEngagementReady ( Boolean isReady )

static

Engagement 이벤트 처리가 가능한지(게임 서버에 DB가 생성된 경우 등) 여부를 설정한다.

true로 설정하려는 경우, <로그인 이후 & 리스너가 등록된 이후>의 조건을 만족한 상태여야 정상적으로 설정되며, false로 설정하려는 경우는 항상 설정 가능하다.

매개변수

bReady Enganement 이벤트 처리 가능 여부.

반환값: API 호출 성공 여부.

◆ showCustomContents()

static void hive.Promotion.showCustomContents	(	PromotionCustomType	customType,
		String	contentsKey,
		onPromotionView	listener )

static

외부 컨텐츠를 사용하기 위해서 커스텀 웹 뷰 노출

매개변수

promotionCustomType	PromotionCustomType Type
contentsKey	백오피스에 설정된 사용자 정의 페이지의 id
listener	API 결과 통지 리스너

◆ showCustomContentsOnGameWindow()

static void hive.Promotion.showCustomContentsOnGameWindow	(	PromotionCustomType	customType,
		String	contentsKey,
		onPromotionView	listener )

static

외부 컨텐츠를 사용하기 위해서 커스텀 웹 뷰 노출

매개변수

promotionCustomType	PromotionCustomType Type
contentsKey	백오피스에 설정된 사용자 정의 페이지의 id
listener	API 결과 통지 리스너

◆ showExit()

static void hive.Promotion.showExit ( onPromotionView listener )

static

종료 확인 팝업 노출 (Android only.)
이용 중인 게임을 종료 하려는 유저에게 새로운 HIVE 게임의 다운로드를 유도하기 위해 '더 많은 게임'이란 버튼을 노출한다

매개변수

listener API 결과 통지

◆ showNativeReview()

static void hive.Promotion.showNativeReview ( )

static

리뷰 유도 팝업 노출
게임 유저들의 긍정적인 평점 및 사용 후기는 다른 유저들이 게임을 이용하는데 영향을 미치게 된다.

리뷰 유도 팝업을 제공하면 유저의 참여 건수가 5~10배 증가하는 것으로 알려져 있다.
iOS 10.3 이상의 기기에서는 앱 내부에서 평점 및 리뷰를 작성할 수 있는 팝업이 노출된다.

매개변수

listener API 결과 통지

◆ showNews()

static void hive.Promotion.showNews	(	String	menu,
		List< int >	giftPidList,
		onPromotionView	listener )

static

게임의 새로운 이벤트나 새로운 게임 소개등의 새소식 화면을 노출

매개변수

menu	최초 노출시 활성화할 메뉴 관리 명
handler	API 결과 통지

◆ showOfferwall()

static void hive.Promotion.showOfferwall ( onPromotionView listener )

static

무료 충전소 화면 노출 (Android only.)
무료 충전소는 HIVE 게임 간의 광고 네트워크로 기존 HIVE 유저들이 새로운 HIVE 게임을 이용할 수 있도록 유도하는 기능이다.

유저가 다운로드 받을 수 있는 게임을 목록으로 노출하고 게임을 다운로드 받아 실행하면 매체가 되는 게임에서 보상이 제공된다.

매개변수

listener API 결과 통지

◆ showPromotion()

static void hive.Promotion.showPromotion	(	PromotionType	promotionType,
		Boolean	isForced,
		onPromotionView	listener )

static

게임의 새로운 이벤트나 새로운 게임 소개등의 배너 화면을 노출

매개변수

promotionType 프로모션 뷰 창의 형태

isForced

type이 "notice" 와 "event" 일 때만 동작

                        true일 경우 24시간 다시보지 않기를 무시한다. 
                        (주의:24시간 다시보기가 적용되지 않으므로 버튼 액션으로 보는 등 특정 액션에서만 사용해야 함.)

                        false이거나 생략할 경우 24시간 안보기가 정상동작함.

listener API 결과 통지

◆ showReview()

static void hive.Promotion.showReview ( onPromotionView listener )

static

리뷰 유도 팝업 노출
게임 유저들의 긍정적인 평점 및 사용 후기는 다른 유저들이 게임을 이용하는데 영향을 미치게 된다.

리뷰 유도 팝업을 제공하면 유저의 참여 건수가 5~10배 증가하는 것으로 알려져 있다.
iOS 10.3 이상의 기기에서는 앱 내부에서 평점 및 리뷰를 작성할 수 있는 팝업이 노출된다.

매개변수

listener API 결과 통지

◆ showUAShare()

static void hive.Promotion.showUAShare	(	String	inviteMessage,
		String	inviteLink,
		onPromotionShare	listener )

static

외부 SNS를 통해 UA url을 공유하기 위한 다이얼로그 노출

매개변수

inviteMessage	UA 초대 메시지
inviteLink	UA 초대 링크
listener	API 결과 통지 리스너

◆ updatePromotionData()

static void hive.Promotion.updatePromotionData ( )

static

/~korean Promotion 정보 갱신 Promotion 새소식 페이지 등의 노출에 필요한 정보를 갱신한다.

/~english Update information of Promotion Update promotion data to show Promotion UI.

HIVE SDK for Unity3D

클래스

열거형 타입

함수

상세한 설명

열거형 타입 문서화

◆ OfferwallState

◆ PromotionCustomType

◆ PromotionEventType

◆ PromotionType

함수 문서화

◆ getAppInvitationData()

◆ getAppInvitationSenderInfo()

◆ getBadgeInfo()

◆ getBannerInfo()

◆ getBannerInfoString()

◆ getOfferwallState()

◆ getViewInfo()

◆ onAppInvitationData()

◆ onAppInvitationSenderInfo()

◆ onEngagement()

◆ onPromotionBadgeInfo()

◆ onPromotionBannerInfo()

◆ onPromotionView()

◆ onPromotionViewInfo()

◆ processURI()

◆ setAdditionalInfo()

◆ setEngagementListener()

◆ setEngagementReady()

◆ showCustomContents()

◆ showCustomContentsOnGameWindow()

◆ showExit()

◆ showNativeReview()

◆ showNews()

◆ showOfferwall()

◆ showPromotion()

◆ showReview()

◆ showUAShare()

◆ updatePromotionData()