激勵配置接口
激勵抽獎接口的demo在LotteryActivity.java里
業(yè)務(wù)描述
抽獎方式:
支持以下抽獎方式
1. 免費(fèi)抽獎:即用戶可免費(fèi)進(jìn)行抽獎
2. 消耗抽獎:即需要消耗商城積分進(jìn)行抽獎
3. 混合型抽獎:先進(jìn)行免費(fèi)抽獎,在免費(fèi)次數(shù)用盡后再進(jìn)行消耗型抽獎
4. 消費(fèi)抽獎:用戶在購買商品時 可按配置的幾率返回獎品(無需APP對接,即可實現(xiàn))
抽獎策略:
幾率型抽獎:配置一定幾率的抽獎
獎種說明:
1) 虛擬商品
集分寶、紅包(全網(wǎng)或指定商品)、代金卷、淘金幣、天貓積分、商城積分、電影票、彩票、APP禮包
2) 實物獎品
免費(fèi)商品:可發(fā)放有天貓/淘寶店鋪或無店鋪的實物獎品。
折扣商品:用戶可通過掃碼購買折扣商品;折扣率后臺可配置。
其他說明:
1) eventKey
APP中用來定義滿足抽獎的事件,每個eventKey對應(yīng)一個抽獎活動,活動策略由激勵后臺配置如果增加了eventKey,一般需APP更新安裝包。
2)激勵后臺
- 激勵后臺可根據(jù)APP的需求,配置相應(yīng)的抽獎活動,每個活動對應(yīng)一個eventKey。
- 抽獎活動過期后,即使APP再次調(diào)用eventKey進(jìn)行抽獎,也不會中獎。
- 若一個APP存在多個抽獎活動,則需創(chuàng)建多個eventKey,相同eventKey的抽獎活動時間不能重疊
- 對于消費(fèi)抽獎,無需APP配置,僅需提出需求到數(shù)娛運(yùn)營,運(yùn)營后臺配置即可
獲取激勵信息列表
接口說明:
獲取抽獎活動信息列表,根據(jù)listener中的結(jié)果展現(xiàn)活動信息或做相應(yīng)的處理。
返回數(shù)據(jù)里包括抽獎類型、抽獎消耗積分及免費(fèi)抽獎次數(shù)等。
前置條件:
無
函數(shù)原型:
public static void getActivitesInfo(String eventKey, IReceiveActivitesListener listener)
參數(shù)說明:
eventKey:獲取此ID對應(yīng)的活動信息,如果傳null則獲取所有可用活動的的信息
Listener:活動信息返回監(jiān)聽,返回類型為ActivityInfoModel。
請求樣例:
AliTvSdk.Lottery.getActivitesInfo (eventKey, new IReceiveActivitesListener() { @Override public void onResult(ActivityInfoModel activies) { ArrayList<ActivityInfoItem> items = model.obtainActivities(); if(items != null){ ActivityInfoItem item = items.get(0); //抽獎類型,1.免費(fèi)型2.消耗型3.混合型 int luckyType = item.getLuckyType(); //抽獎一次需要消耗的積分,若免費(fèi)型抽獎為0 int consumeAmount = item.getConsumeAmount()); //抽獎次數(shù)(免費(fèi)或混合型抽獎初始化設(shè)置免費(fèi)抽獎次數(shù)) int accessAmount = item.getAccessAmount()); AwardsList awardsList = item.getAwards(); for(int j = 0;j < awardItems.size();j++){ //根據(jù)活動信息繪制UI,詳見Demo。 } } @Override public void onError(int errCode, String errMsg) { } });
返回說明
名稱 | 類型 | 描述 |
activityId | String | 活動ID |
fventKey | String | 事件Key |
name | String | 活動名稱 |
startTime | String | 活動開始時間 |
endTime | String | 活動結(jié)束時間 |
awardInfoItemList | ActivityInfoAwardItem
| 該活動獎項對象 可查看獎項列表 |
consumeAmount | Int | 該活動每次消耗數(shù)娛積分 若為0則不消耗 |
accessAmount | Int | 該活動免費(fèi)抽獎次數(shù) |
luckyType | Int | 抽獎類型 免費(fèi)抽獎:1 消耗抽獎:2 混合抽獎:3 |
activityUrl
| String | 返回活動URL,可供CP生產(chǎn)二維碼,用戶手機(jī)掃碼后在手機(jī)上展示H5頁面 |
AwardInfoItemList定義
字段 | 類型 | 描述 |
activityId | Number | 活動id |
name | String | 獎項名稱 |
Id | Number | 獎項id |
typeName | String | 獎種名稱 |
Type | Number | 獎種代碼 |
amount | Number | 獎種數(shù)量 |
Unit | String | 獎種單位 注、個、張 |
price | Number | 獎種價值 單位分 |
hyperlinkUrl | String | 自定義超鏈URL(如折扣二維碼、業(yè)務(wù)跳轉(zhuǎn)等) |
hyperlinkDesc | String | 超鏈文案說明 |
接口激勵
接口說明:獲取抽獎結(jié)果。APP內(nèi)UI由CP展現(xiàn)。
前置條件:
需要授權(quán),若未授權(quán)則返回未授權(quán)錯誤碼
函數(shù)原型:
public static void getLotteryResultWithPermission(String eventKey, String confirmKey, String behaviorKey, IReceiveAwardResultListener listener)
參數(shù)說明:
eventKey: 對應(yīng)的活動關(guān)鍵字
listener: 抽獎結(jié)果id返回監(jiān)聽,返回數(shù)據(jù)位ActivityAwardModel
behaviorKey(可選):行為型抽獎的Key名稱
confirmKey(可選): 確認(rèn)秘鑰。此秘鑰是由CP從阿里獲得一個密鑰,然后通過算法計算出的秘鑰串,秘鑰算法參考demo。為算法安全起見,此確認(rèn)秘鑰需要由cp服務(wù)器產(chǎn)生傳回給客戶端。
請求樣例:
AliTvSdk.Lottery.getLotteryResultWithPermission (eventKey, String confirmKey, new IReceiveAwardResultListener() { @Override public void onResult(ActivityAwardModel activies) { if(model != null){ if(model.isResult()){ ActivityAwardItem item = model.getAward(); //提示中獎 }else{ //未中獎 } //數(shù)娛積分/金牌余額 int totalAmount = model.getTotalAmount()); //可用抽獎次數(shù)(免費(fèi)) int accessAmount = model.getAccessAmount()); }else{//未中獎 } } @Override public void onError(int errCode, String errMsg) { } });
返回說明:
名稱 | 類型 | 描述 |
isLucky | Boolean | 是否中獎,true為中獎,false為未中獎 |
activityAwardItem | ActivityAwardItem | 中獎:請見下文 未中獎:為空 |
totalAmount | Long | 用戶剩余積分 若為負(fù)數(shù)為無效值 |
accessAmount | Int | 用戶剩余免費(fèi)抽獎次數(shù) |
ActivityAwardItem定義:
字段 | 類型 | 描述 |
activityId | Number | 活動id |
Name | String | 獎項名稱 |
Id | Number | 獎項id |
typeName | String | 返回的獎種名稱 |
Type | Number | 獎種代碼 |
Amount | Number | 獎種數(shù)量 |
Unit | String | 獎種單位 注、個、張 |
Price | Number | 獎種價值 單位分 |
simpleDesc | String | 獎種簡短描述 |
fullDesc | String | 獎種完整描述 |
hyperlinkUrl | String | 自定義超鏈URL(如折扣二維碼、業(yè)務(wù)跳轉(zhuǎn)等) |
hyperlinkDesc | String | 超鏈文案說明 |
消費(fèi)激勵
前置條件:向數(shù)娛運(yùn)營接口人提出配置需求,由數(shù)娛后臺配置生效。無需APP對接
接入方式:
正常拉起支付
可針對特定商品配置返回的獎項,無需接入方做任何配置和UI,所有配置和展現(xiàn)均由數(shù)娛實現(xiàn),支付后可發(fā)放的獎種如下(需用戶登錄后支付)
1虛擬獎品:- 平臺內(nèi)獎品:商城積分、App禮包
- 平臺外獎品:集分寶、紅包、代金卷、淘金幣、天貓積分、電影票、彩票;用戶
- 支持天貓或淘寶店鋪的實物
- 支持無天貓或淘寶店鋪的實物