二、奖励策略 #
#lfeng/wellplay/能力综述/奖励系统
奖励策略指每次发奖时需要配置的参数,通过这组配置,可以控制Wellplay的发奖规则,如生效时间、截止时间等。
参数说明 #
EffectTimestamp #
生效时间戳,允许领取本次奖励的时间 。
ExpiresTimestamp #
过期时间戳,本次发放的奖励过期的时间。
AwardBody #
请求领奖时,由Wellpaly透传给客户端的参数;长度在1024以内的合法utf8字符。
ReturnBody #
确认领奖后,自定义Wellpaly最终返回給客户端的数据;支持 ~魔法变量~ 和 ~自定义变量~;ReturnBody 要求是合法的 JSON 文本。例如:{"Hello":"$(x:Hello)","RoleID":"$(Role.ID)"} ;长度在1024以内的合法utf8字符。
CallbackURL #
确认领奖时,Wellpaly向游戏服务器发送POST请求的URL;必须是公网上可以正常进行 POST 请求并能响应 HTTP/1.1 200 OK 的有效 URL。
另外,为了给客户端有一致的体验,我们要求 CallbackURL 返回包 Content-Type 为 application/json,即返回的内容必须是合法的 JSON 文本。
出于高可用的考虑,本字段允许设置多个 CallbackURL(用英文符号 ; 分隔),在前一个 CallbackURL 请求失败的时候会依次重试下一个 CallbackURL。一个典型例子是:http://<ip1>/callback;http://<ip2>/callback,并同时指定下面的 CallbackHost 字段。在 CallbackURL 中使用 ip 的好处是减少对 dns 解析的依赖,可改善回调的性能和稳定性。指定 CallbackURL,必须指定 CallbackBody,且值不能为空。
长度应在1024以内的合法utf8字符。
CallbackHost #
确认领奖时,Wellpaly向游戏服务器发送POST请求的Host值;与 CallbackURL 配合使用,仅当设置了 CallbackURL 时才有效。 长度应在64以内的合法utf8字符。
CallbackBody #
确认领奖时,Wellpaly向业务服务器发送Content-Type: application/x-www-form-urlencoded的 POST 请求。业务服务器可以通过直接读取请求的 query 来获得该字段;支持 ~魔法变量~ 和 ~自定义变量~;CallbackBody 要求是合法的 url query string。例如Hello=$(x:Hello)&Foo=$(Role.ID)。如果CallbackBodyType指定为application/json,则CallbackBody应为JSON格式,例如:{“Hello":"$(x:Hello)","RoleID":"$(Role.ID)"}。
长度应在1024以内的合法utf8字符。
CallbackBodyType #
确认领奖时,Wellpaly向业务服务器发送回调通知 CallbackBody 的 Content-Type。默认为application/x-www-form-urlencoded,也可设置为 application/json。
注意事项 #
- 所有文本参数必须采用合法的UTF8编码,否则可能导致无法正常工作。
CallbackXXX和ReturnBody参数不能同时使用,如果采用了回调策略,则由请求CallbackURL返回的内容会直接作为ReturnBody透传给客户端。
其他 #
目前所有奖励策略需要在管理控制台填写。