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