update: 完善接口说明和文档

deeplink
胡宇飞 2024-05-15 09:58:22 +08:00
parent 8e005c9237
commit 5d7e32a9f1
2 changed files with 41 additions and 31 deletions

View File

@ -48,8 +48,8 @@ namespace Guru
/// <summary>
/// 支付初始化Keys
/// </summary>
public byte[] GoogleKeys;
public byte[] AppleRootCerts;
public byte[] GoogleKeys; // 数据取自 GooglePlayTangle.Data();
public byte[] AppleRootCerts; // 数据取自 AppleTangle.Data();
#region Initialization

View File

@ -62,13 +62,13 @@ namespace Guru
/// <summary>
/// 游戏启动打点
/// </summary>
/// <param name="levelId"></param>
/// <param name="levelName"></param>
/// <param name="levelType"></param>
/// <param name="puzzleId"></param>
/// <param name="startType"></param>
/// <param name="isReplay"></param>
/// <param name="extra"></param>
/// <param name="levelId">关卡Id</param>
/// <param name="levelName">关卡名称: main_01_9001, daily_challenge_81011</param>
/// <param name="levelType">关卡类型: 主线:main</param>
/// <param name="puzzleId">配置/谜题/图片/自定义Id: 101120</param>
/// <param name="startType">关卡开始类型: play开始游戏replay重玩continue继续游戏</param>
/// <param name="isReplay">是否重新开始: true/false</param>
/// <param name="extra">扩展数据</param>
public static void LogLevelStart(int levelId, string startType = EventLevelStartModePlay,
string levelType = LevelTypeMain, string levelName = "", string puzzleId = "",
bool isReplay = false, Dictionary<string, object> extra = null)
@ -83,7 +83,7 @@ namespace Guru
}
/// <summary>
/// 游戏点击 Continue 重开始游戏
/// 游戏点击 Continue 继续游戏
/// </summary>
/// <param name="levelId"></param>
/// <param name="levelType"></param>
@ -97,7 +97,7 @@ namespace Guru
}
/// <summary>
/// 游戏点击 Continue 重开始游戏
/// 游戏点击 Replay 重玩关卡
/// </summary>
/// <param name="levelId"></param>
/// <param name="levelType"></param>
@ -110,8 +110,17 @@ namespace Guru
}
/// <summary>
/// 游戏胜利打点
/// 关卡结束打点
/// </summary>
/// <param name="levelId">关卡Id</param>
/// <param name="result">success:成功fail:失败exit:退出timeout:超时replay:重玩...</param>
/// <param name="levelType">关卡类型: 主线:main</param>
/// <param name="levelName">关卡名称: main_01_9001, daily_challenge_81011</param>
/// <param name="puzzleId">配置/谜题/图片/自定义Id: 101120</param>
/// <param name="duration">关卡完成时长(单位:毫秒)</param>
/// <param name="step">步数(有则上报)</param>
/// <param name="score">分数(有则上报)</param>
/// <param name="extra">扩展数据</param>
public static void LogLevelEnd(int levelId, string result = EventLevelEndSuccess,
string levelType = LevelTypeMain, string levelName = "", string puzzleId = "",
int? duration = null, int? step = null, int? score = null, Dictionary<string, object> extra = null )
@ -193,6 +202,7 @@ namespace Guru
/// </summary>
/// <param name="playerLevel"></param>
/// <param name="playerName"></param>
/// <param name="extra">扩展数据</param>
public static void LogLevelUp(int playerLevel, string playerName, Dictionary<string, object> extra = null)
{
if (!IsInitialSuccess)
@ -207,6 +217,7 @@ namespace Guru
/// 玩家解锁成就
/// </summary>
/// <param name="achievementName"></param>
/// <param name="extra">扩展数据</param>
public static void LogAchievement(string achievementName, Dictionary<string, object> extra = null)
{
if (!IsInitialSuccess)
@ -376,17 +387,18 @@ namespace Guru
//---------------------------------------- EARN ----------------------------------------
/// <summary>
/// 基础收入接口. 可直接调用此接口上报相关参数
/// 获取虚拟货币/道具.
/// 基础接口, 不推荐项目组直接调用
/// 请直接调用其他对应场景的统计接口
/// </summary>
/// <param name="currencyName"></param>
/// <param name="value"></param>
/// <param name="balance"></param>
/// <param name="category"></param>
/// <param name="levelName"></param>
/// <param name="itemName"></param>
/// <param name="scene"></param>
/// <param name="currencyName">货币名称</param>
/// <param name="value">货币增加值 10</param>
/// <param name="balance">结算后货币总量 20 -> 30</param>
/// <param name="category">消耗类型, 默认值请赋 reward</param>
/// <param name="levelName">当前关卡或者人物等级名称</param>
/// <param name="itemName">购买道具名称</param>
/// <param name="scene">购买场景如 Store, Workbench, Sign, Ads....</param>
public static void EarnVirtualCurrency(string currencyName,
int value, int balance,
string category = "", string itemName = "",
@ -598,24 +610,22 @@ namespace Guru
}
//---------------------------------------- EARN ----------------------------------------
//---------------------------------------- SPEND ----------------------------------------
/// <summary>
/// 花费虚拟货币/道具
/// 基础花费虚拟货币/道具
/// 基础接口, 不推荐项目组直接调用
/// 请直接调用其他对应场景的统计接口
/// </summary>
/// <param name="currencyName"></param>
/// <param name="value"></param>
/// <param name="balance"></param>
/// <param name="category"></param>
/// <param name="itemName"></param>
/// <param name="levelName"></param>
/// <param name="scene"></param>
public static void SpendVirtualCurrency(string currencyName,
int value, int balance,
string category = "", string itemName = "",
/// <param name="currencyName">货币名称</param>
/// <param name="value">货币消耗值 10</param>
/// <param name="balance">结算后货币总量 30 -> 20</param>
/// <param name="category">消耗类型, 默认值请赋 reward</param>
/// <param name="levelName">当前关卡或者人物等级名称</param>
/// <param name="itemName">购买道具名称</param>
/// <param name="scene">购买场景如 Store, Workbench, Sign, Ads....</param>
public static void SpendVirtualCurrency(string currencyName, int value, int balance, string category = "", string itemName = "",
string levelName = "", string scene = "", Dictionary<string, object> extra = null)
{
Analytics.SpendVirtualCurrency(currencyName, value, balance, category, itemName, levelName, scene, extra);