Skip to content

IvySdk/android

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

94 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

android sdk 文档

当前版本:6.0.2

增加引用:

implementation 'com.tencent:mmkv:1.0.23'

English Doc Link :https://github.com/IvySdk/android/wiki/English-Doc

1,添加risesdk.jar文件依赖,将demo中的libs目录下的risesdk.jar文件拷贝到您项目中进行引用

Copy

2,如果您有使用proguard来混淆Java代码,需要添加以下规则:

-dontwarn com.unity3d.**
-keep class com.android.client.** {
    <methods>;
}

-keep class android.support.** {
    *;
}

-keep class com.android.async.** {
    public *;
}

-keep class com.android.common.** {
    public *;
}

-keep class com.android.network.** {
    public *;
}

-keep class com.android.view.** {
    public *;
}

3,在Activity中初始化Android SDK,构造AndroidSDK builder对象,提供初始化完成回调

  @Override
    protected void onCreate() {
       AndroidSdk.Builder builder = new AndroidSdk.Builder();
       builder.setSdkResultListener(new SdkResultListener() {
            @Override
            public void onInitialized() {
                 //sdk初始化成功接口
                 Log.e("DEMO","sdk initialized");
            }

            @Override
            public void onReceiveServerExtra(String data) {
                 // 初始化成功后收到服务器回传数据
                 Log.e("DEMO","server data: " + data);
            }

            @Override
            public void onReceiveNotificationData(String data) {
                 //初始化成功后收到通知数据
                 Log.e("DEMO","noti: " + data);
            }
        });
       AndroidSdk.onCreate(this, builder);
       AndroidSdk.registerAdEventListener(new AdEventListener());
    }
    
  @Override
    protected void onStart() {
        super.onStart();
        AndroidSdk.onStart();
    }

    @Override
    protected void onStop() {
        AndroidSdk.onStop();
        super.onStop();
    }

    @Override
    protected void onPause() {
        super.onPause();
        AndroidSdk.onPause();
    }

    @Override
    protected void onResume() {
        super.onResume();
        AndroidSdk.onResume(this);
    }

    @Override
    protected void onDestroy() {
        AndroidSdk.onDestroy();
        super.onDestroy();
    }
    
    @Override
    protected void onActivityResult(int requestCode, int resultCode, Intent data) {
        AndroidSdk.onActivityResult(requestCode, resultCode, data);
        super.onActivityResult(requestCode, resultCode, data);
    }

4,广告相关接口以及回调:

  • 全屏广告,需配置不同时机弹出的广告,以便于后台统计,我们预定义了以下几种时机弹出的广告:
AndroidSdk.showFullAd(AndroidSdk.FULL_TAG_START); //游戏开始时
AndroidSdk.showFullAd(AndroidSdk.FULL_TAG_PAUSE); //游戏暂停
AndroidSdk.showFullAd(AndroidSdk.FULL_TAG_PASS_LEVEL);//游戏过关
AndroidSdk.showFullAd(AndroidSdk.FULL_TAG_EXIT); //游戏退出
AndroidSdk.showFullAd("xxx"); //您还可以自定义类型广告

注意:不要在activity的生命周期onResume()和onPause()中调用弹出全屏广告  

  • banner广告
int[] bannerPos = {
            AndroidSdk.POS_CENTER,      //居中显示banner广告
            AndroidSdk.POS_CENTER_BOTTOM, //底部居中显示banner广告
            AndroidSdk.POS_CENTER_TOP, //顶部居中显示banner广告
            AndroidSdk.POS_LEFT_BOTTOM, //左下角显示banner广告
            AndroidSdk.POS_LEFT_TOP, //左上角显示banner广告
            AndroidSdk.POS_RIGHT_BOTTOM, //右下角显示banner广告
            AndroidSdk.POS_RIGHT_TOP //右上角显示banner广告
 };
 AndroidSdk.showBanner("default", bannerPos[0]); //居中显示banner广告
 AndroidSdk.closeBanner("default"); //关闭banner广告
  • 视频广告
int rewardId = 1; //客户端配置的视频广告奖励id,自定义即可,依据这个id决定给玩家奖励什么物品,以及数量等
if(AndroidSdk.hasRewardAd("shop")){ //检查是否有视频广告
    AndroidSdk.showRewardAd("shop", new AdListener(){
        @Override
        public void onAdReward(boolean skip) {
            asyncToast("shop reward video is played");
        }
    }); //展示视频广告
}
  • Native广告
showNativeBanner(String tag, int x, int y, int w, int h, int sw, int sh)

tag:
x:
y: w: h:
sw: 屏幕宽度
sh: 屏幕设计高度

5, faceook接口以及回调

  • 登陆facebook账户
AndroidSdk.login();
  • 是否登陆facebook账户
boolean isLogin = AndroidSdk.isLogin()
  • facebook分享
 AndroidSdk.share(); 
  • facebook点赞
AndroidSdk.like();
  • facebook邀请好友安装应用,游戏等
AndroidSdk.invite();
  • 向你的facebook朋友发出挑战
 AndroidSdk.challenge("haha title", "heihei message");
  • 获取faceook朋友信息列表
 String friendsJson = AndroidSdk.friends();
 //返回的json格式如下:
 [
 {
 "id":"0000000000000001",//我的facebook好友1的账户id
 "name":"Friend 1",//我的facebook好友1的账户名称
 "picture":"/data/empty_not_exists1"//我的facebook好友1个人头像本地保存的绝对路径
 },
 {
  "id":"0000000000000002",//我的facebook好友2的账户id
 "name":"Friend 2",//我的facebook好友2的账户名称
 "picture":"/data/empty_not_exists2"//我的facebook好友2个人头像本地保存的绝对路径
 },
 {
 "id":"0000000000000003",//我的facebook好友3的账户id
 "name":"Friend 3",//我的facebook好友3的账户名称
 "picture":"/data/empty_not_exists3"//我的facebook好友3个人头像本地保存的绝对路径
 }
 ]
  • 获取我的faceook个人信息
String meJson = AndroidSdk.me();
//返回的json格式如下:
 {
 "id":"0000000000000000",//我的facebook账户id
 "name":"Me is me",//我的facebook账户名称
 "picture":"/data/empty_not_exists"//我的facebook账户个人图片本地保存的绝对路径
 }
  • 退出facebook账户
 AndroidSdk.logout();
  • facebook接口回调:
builder.setUserCenterListener(new UserCenterListener() {
           @Override
           public void onReceiveLoginResult(boolean success) {
                //登陆facebook账户成功与否回调
                Log.e("DEMO","login? " + success);
           }

           @Override
           public void onReceiveInviteResult(boolean success) {
                //邀请好友安装程序,游戏等回调
                Log.e("DEMO","invite? " + success);
           }

           @Override
           public void onReceiveChallengeResult(int count) {
                //收到挑战结果的回调,count代表成功挑战了几位好友
                Log.e("DEMO","challenge? " + " count: " + count);
           }

           @Override
           public void onReceiveLikeResult(boolean success) {
                //点赞回调,是否点赞成功
                 Log.e("DEMO","like? " + success);
           }

           @Override
           public void onReceiveFriends(String s) {
               asyncToast("friends: " + s);
           }

});

6,应用内支付的接口以及回调,后台配置计费点 :

int billId = 1; //计费点,和运营人员确定即可
AndroidSdk.pay(billId);//支付接口,对计费点进行支付
AndroidSdk.pay(billId, payload)
AndroidSdk.query(billId);//查询支付结果
/**
* AndroidSdk.pay(billId); //支付接口,对计费点进行支付
  AndroidSdk.query(billId); //查询支付结果
  PaymentSystemListener 是以上两个接口的回调类
*/
builder.setPaymentListener(new PaymentSystemListener() {
            @Override
            public void onPaymentSuccess(int billId) {
                //支付成功
                Log.d("DEMO","payment success: " + billId);
            }

            @Override
            public void onPaymentFail(int billId) {
                 //支付失败
                 Log.d("DEMO","payment fail: " + billId);
            }

            @Override
            public void onPaymentCanceled(int bill) {
                //取消支付
                Log.d("DEMO","payment cancel: " + bill);
            }

            @Override
            public void onPaymentSystemValid() {
                //手机,平板等支持支付功能,支付环境有效的回调
                Log.d("DEMO", "pay system is valid");
            }
  });

V2以后支付成功以后,会同步回调配置的游戏服务器接口(可选),可以在此接口中实现游戏发货,进一步校验的逻辑。会上传如下参数

// 所在的国家
.add("country", countryCode)
// 用户购买的Google SKU
.add("sku", purchase.getSku())
// billId
.add("payId", String.valueOf(billId))
// 订单号
.add("orderId", purchase.getOrderId())
.add("purchaseTime", String.valueOf(purchase.getPurchaseTime()))
// purchaseToken可以用来自行向google服务器监听购买的通知,比如退款等
.add("purchaseToken", purchase.getPurchaseToken())
.add("purchaseState", String.valueOf(purchase.getPurchaseState()))
.add("uuid", IvySdk.getUUID())
.add("packageName", purchase.getPackageName())
.add("jsonData", purchase.getOriginalJson())
.add("signature", purchase.getSignature())
.add("sku_json", skuDetail != null ? skuDetail.toString() : "{}")
.add("appid", appid != null ? appid : "")
// 可选,如果使用pay(billId, payload)接口,将提交
.add("payload", payload)

游戏服务器接口,需要使用返回一个加密的json字符串(请联系),再强校验的情况下,SDK会检查status字段,明确为1才会回调onPaymentSuccess的客户端回调。 payload: 客户端通过pay(billId, payload)接口调用支付接口,对接的服务器接口将上传payload, payload可以加密保存一些支付的用户信息,用于后续的校验或发货。

服务器可以对jsonData进行验签,防止数据被修改 参考: https://gist.github.com/mkorszunsands/3cbc0016ac7d0bca318228f96ffd0ab3

https://stackoverflow.com/questions/30420847/verification-google-play-purchase-from-server-side

支付校验PHP Sample

public function get_openssl_key($publicKey){
  $key = "-----BEGIN PUBLIC KEY-----\n".chunk_split($publicKey, 64, "\n")."-----END PUBLIC KEY-----";
  $key = openssl_get_publickey($key);
  return $key;
}

$public_keys = 'google - public -key'; //计费平台公钥
$key = $this->get_openssl_key($public_keys);
// signature: 是客户端post过来的signature数据
// jsonData 是客户端Post过来的json数据
$result = openssl_verify($jsonData, base64_decode($signature), $key, OPENSSL_ALGO_SHA1);

接口返回

{"status":1}

的JSON字符串,将认为发货成功,将调用支付成功,否则将调用支付失败回调。 可选的可以回传payload

{"status" : 1, "payload": payload}

这样客户端收到的回调就会包含此payload, 服务器可以将个性化的数据包含在此payload中

AndroidSdk.getPrices函数返回以billId为key的本地化json字符串 注意: 此函数返回的数据依赖于Google Play的连接,所以游戏刚打开的时候可能没有。

    /// 返回json数据,格式为:
    /// 22 23 等是计费点
    /// price_amount 一般用于计算折扣,当前的价格是打折后的价格,通过折扣来计算原价,展示给用户
    /// {
    ///     "22": {
    ///         "id": "com.ivy.galaxyshooting.sky22",
    ///         "type": "inapp",
    ///         "price": "HK$15.00",
    ///         "price_amount": 15.0,
    ///         "currency": "HKD",
    ///         "title": " remove Ads +2000 coins (Galaxy sky shooting)",
    ///         "desc": " remove Ads +2000 coins"
    ///     },
    ///     "23": {
    ///         "id": "com.ivy.galaxyshooting.sky23",
    ///         "type": "subs",
    ///         "price": "HK$15.00",
    ///         "price_amount": 15.0,
    ///         "currency": "HKD",
    ///         "title": "VIP Privilege (Galaxy sky shooting)",
    ///         "desc": "VIP Privilege"
    ///     }
    /// }

7,友盟统计相关接口

  • 统计玩家等级
int level = 1; //玩家等级
AndroidSdk.UM_setPlayerLevel(level);//统计玩家等级
  • 统计进入某页面
String pageName = "Shop"; 
AndroidSdk.UM_onPageStart(pageName);//统计进入商店页面
  • 统计离开某页面
String pageName = "Shop";
AndroidSdk.UM_onPageEnd(pageName);//统计离开商店页面
  • 统计事件名称
String eventId = "EnterGame"; //事件名称
AndroidSdk.UM_onEvent(eventId);
  • 统计事件标签操作
String eventId = "EnterGame"; //事件名称
String eventLabel = "eventLable";//事件的某个操作标签
AndroidSdk.UM_onEvent(eventId, eventLabel);
  • 统计事件详细分组内容
HashMap<String, String> map = new HashMap<>(); //事件详细分组内容
map.put("openGift", "roll");
int value = 1;//计数统计值,比如持续时间,每次付款金额
AndroidSdk.UM_onEventValue("EnterGame", map, value);
  • 统计关卡开始
String level = "Level" + 5;//level ,开始哪个关卡
AndroidSdk.UM_startLevel(level);
  • 统计关卡失败
String level = "Level" + 5); //level ,哪个关卡失败
AndroidSdk.UM_failLevel(level);
  • 关卡结束
String level = "Level" + (new Random().nextInt(30) + 10); //level,完成哪个关卡
AndroidSdk.UM_finishLevel(level);
  • 游戏内付统计
double money = 5.0; //内付的金额
String itemName = "钻石"; //内付购买的商品名称
int number = 10;//内付购买的商品数量
double price = 99.0;//内付购买的商品价格
AndroidSdk.UM_pay(money,itemName,number,price);
  • 购买道具统计
String itemName = "血瓶"; //购买游戏中道具名称
int number = 10;//购买道具数量
double price = 99.0;//购买道具价格
AndroidSdk.UM_buy(itemName,count,price); 
  • 使用道具统计
String itemName = "血瓶"; //使用道具名称
int count = 10;//使用道具数量
double price = 99.0;//使用道具价格
AndroidSdk.UM_use(itemName,count,price); 
  • 额外奖励统计
String itemName = "血瓶"; //奖励道具名称
int number = 5;//奖励道具数量
double price = 99.0;//奖励道具价格
int trigger = 1;//触发奖励的事件, 取值在 1~10 之间,“1”已经被预先定义为“系统奖励”, 2~10 需要在网站设置含义
AndroidSdk.UM_bonus(itemName,number,price,trigger); 

8,我们额外还提供以下接口:

  • 提供给欧盟区的设置: 在应用的设置页面提供一个设置项,让用户可以设置广告相关的策略
// 判断该用户是否是欧盟区的
AndroidSdk.hasGDPR()

// 显示广告设置页面
AndroidSdk.resetGDPR();

// 使用场景
如果是欧盟区的用户,你需要提供个设置项
if (AndroidSdk.hasGDPR()){
    // 这里展示你们自己的设置项 UI
    // 如果用户点击了你们的设置项,
    // 则你们需要调用 AndroidSdk.resetGDPR() 来展示广告设置
    // 广告设置我们已经做好了,你们不需要自己另做界面
}
  • 判断网络是否连接
boolean isNetworkConnected = AndroidSdk.isNetworkConnected();
  • 弹出android原生toast提示
String messageContent="我是toast消息内容";
AndroidSdk.toast(messageContent);
  • 弹出android原生alert dialog
String title = "我是标题";
String message = "我是内容";
AndroidSdk.alert(title,message);
  • 游戏,应用程序退出
AndroidSdk.onQuit();
  • 缓存文件
String url = "http://xxxx.png";//文件下载连接
String path = AndroidSdk.cacheUrl(url); //返回保存文件的绝对路径(/sdcard/0/.cache/383292918283483291)
  • 给应用,游戏等五星好评
AndroidSdk.rateUs();
  • 给应用,游戏等加Google Analytics统计
AndroidSdk.track("shop"); //统计商店页面
AndroidSdk.track("shop","buy"); //商店页面购买装备统计
AndroidSdk.track("shop","buy","血瓶"); //商店页面购买血瓶装备统计

9, 远程配置

RemoteConfig接口首先会检查Firebase RemoteConfig的值,如果是默认值将fallback到运营本地配置的值。

注意: Firebase Remote Config不是数据库,在后台更新后不会立马生效,Firebase会根据自己的策略发布到用户设备上。

AndroidSdk.getRemoteConfigInt(String key);
AndroidSdk.getRemoteConfigLong(String key);
AndroidSdk.getRemoteConfigDouble(String key);
AndroidSdk.getRemoteConfigBoolean(String key);
AndroidSdk.getRemoteConfigString(String key);

10,demo中有对接口的详细注释,如您看完demo后还有不明白之处,可发送邮件到appdev@ivymobile.com,我们会尽快给您回复!谢谢!