report role

iOSSDK对接说明文档.md

-## ZYouSDK V1.0.0文档接入使用
+## ZYouSDK V1.0.0文档接入使用
@@ -49,6 +49,29 @@
 
                [调用示例](#sec9.1)
 
+    10 [SDK 排行榜](#sec10)
+        接口说明
+
+        调用方式
+
+        请求参数
+
+        示例
+
+    11 [SDK 角色行为上报](#sec11)
+
+        接口说明
+
+        调用方式
+
+        请求参数
+
+        返回参数
+
+        示例
+
+        参数枚举
+
 
 #### 1、对接说明 <a name="sec1"></a>
 &nbsp;&nbsp; 1.1、此sdk只支持iOS9.0以上版本
@@ -589,5 +612,140 @@ payNotify();
     }
 ```
 
+### 10 SDK 排行榜<a name="sec10"></a>
+
+---
+
+##### 接口说明
+
+> 用户在点击排行榜按钮(或链接) 将角色信息和服务器信息通过参数传入sdk
+
+##### 请求参数
+
+> | 参数                                                          | 必选  | 类型   | 默认值   | 说明                                                                                                 |
+> | :------------------------------------------------------------ | :---- | :----- | :------- | :--------------------------------------------------------------------------------------------------- |
+> | role                                                          | true  | Object | -        | 角色相关                                                                                             |
+> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;server_id     | true  | String | ""       | 游戏服务器 ID                                                                                        |
+> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;server_name   | true  | String | ""       | 游戏服务器名称                                                                                       |
+> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;cp_role_id    | true  | String | ""       | 玩家角色 ID                                                                                          |
+> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;role_name     | true  | String | ""       | 玩家角色名称                                                                                         |
+
+##### 示例
+
+```
+    [[ZYouManager shareInstance]zy_rankingWithcp_role_id:@"233" server_name:@"西游一服" server_id:@"87896" role_name:@"hhhh" SuccessBlock:^(id  _Nonnull responseObject) {
+        
+    } failureBlock:^(NSString * _Nonnull error) {
+        
+    }];
+```
+### 11 SDK 角色行为上报<a name="sec11"></a>
+
+---
+
+##### 接口说明
+> 此方法用于上报角色行为，需在角色有对应行为时调用此方法。
+
+##### 请求参数
+
+> | 参数          | 必选 | 类型   | 默认值 | 说明                                                                                                                                    |     |
+> | :------------ | :--- | :----- | :----- | :-------------------------------------------------------------------------------------------------------------------------------------- | --- |
+> | role_name  | true | String      | -      | 角色名称       |
+> | cp_role_id | true | String      | -      | cp角色id       |
+> | event      | true | String      | -      | 事件类型       |
+> | qureys     | true | Array[{name, value}]   | -      | 属性           |
+> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;name     | true | String  | -      | 属性名（中文）   |
+> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;value    | true | String  | -      | 属性值           |
+
+
+##### 示例
+
+```
+    [[ZYouManager shareInstance]zy_gameReportcp_role_id:@"CP角色id" role_name:@"角色名" event:@"coin_get" querys:@[@{@"name":@"货币id",@"value":@"123"},@{@"name":@"货币产出途径",@"value":@"掉落"},@{@"name":@"变动前数量",@"value":@"59"},@{@"name":@"变动数量",@"value":@"32"},@{@"name":@"变动后数量",@"value":@"91"}] SuccessBlock:^(id  _Nonnull responseObject) {
+        
+    } failureBlock:^(NSString * _Nonnull error) {
+        dispatch_async(dispatch_get_main_queue(), ^{
+            CCToastView *view = [[CCToastView alloc]init];
+            [view makeToast:error inView:self.view];
+        });
+    }];
+
+```
+##### 参数枚举
+EVENT枚举
+> | EVENT            | 说明     |
+> | ---------------- | -------- |
+> | coin_get         | 货币产出 |
+> | coin_cost        | 货币消耗 |
+> | item_get         | 道具产出 |
+> | item_cost        | 道具消耗 |
+> | shop             | 商城购买 |
+> | task_complete    | 任务完成 |
+> | newplayer_guide  | 新手指引 |
+> | mail             | 邮件操作 |
+
+EVENT属性对应关系
+> | coin_get 属性名  |
+> | --------------- |
+> | 货币ID      |
+> | 货币产出途径 |
+> | 变动前数量   |
+> | 变动数量     |
+> | 变动后数量   |
+
+> | coin_cost 属性名  |
+> | --------------- |
+> | 货币ID |
+> | 货币消耗途径 |
+> | 变动前数量 |
+> | 变动数量 |
+> | 变动后数量|
+
+> | item_get 属性名  |
+> | --------------- |
+> | 道具ID |
+> | 道具类型 |
+> | 道具产出途径 |
+> | 变动前数量 |
+> | 变动数量|
+> | 变动后数量|
+
+> | item_cost 属性名  |
+> | --------------- |
+> | 道具ID |
+> | 道具类型 |
+> | 道具消耗途径 |
+> | 变动前数量 |
+> | 变动数量|
+> | 变动后数量|
+
+> | shop 属性名  |
+> | --------------- |
+> | 商城ID |
+> | 购买道具ID |
+> | 购买道具数量 |
+> | 消耗货币ID |
+> | 单价|
+> | 消耗货币数量|
+
+> | task_complete 属性名  |
+> | --------------- |
+> | 任务ID |
+> | 任务类型 |
+> | 任务奖励 |
+
+> | newplayer_guide 属性名  |
+> | --------------- |
+> | 步骤ID |
+
+> | mail 属性名  |
+> | --------------- |
+> | 邮件操作类型 |
+> | 邮件ID |
+> | 邮件类型 |
+> | 邮件标题 |
+> | 邮件附件 |
+> | 邮件到期时间 |
+