[service] name = "WReward" desc = "奖品服务" [[method]] name = "List" desc = "奖品列表" [method.req] field = [ "int32 page //当前页", "int32 per_page //每页条数", "string page_lang //页面语言", "string project_hash_id //项目hash_id", "string title //奖品名称", "string lang_mark //奖品语言，多个用逗号分开", "string reward_title //奖品标题", "int32 order_type //排序类型（1-创建时间升序），其他默认", ] [method.res] field = [ "repeated One list //列表数据", "int64 total //列表总数", ] [[method.res.message]] name = "One" field = [ "int64 id //奖品id", "string reward_title //奖品标题", "string title //奖品名称", "string img_url //奖品图片", "int32 receive_type //发放类型（1-系统发放，2-联系客服，4-提交表单）", "int64 related_num //关联数量", "repeated KV kv_data //键值数据", "repeated Lang langs //语言数据", "int32 dy_reward_type //动态奖品内容类型（0-无，1-兑换码）", "int64 created_at //创建时间", "string contact //联系方式", "int64 url_id //回调地址id", ] [[method.res.message]] name = "KV" field = [ "string key //键", "string value //值", "int32 is_show //是否展示（0-否，1-是）", ] [[method.res.message]] name = "Lang" field = [ "string mark //语言标识", "string title //奖品名称", "string img_url //奖品图片", "int32 is_default //是否默认语言(0-否，1-是)", "int32 lang_type //语言数字标识", "int64 img_id //奖品图片id", ] [[method]] name = "Select" desc = "奖品选择" [method.req] field = [ "string project_hash_id //项目hash_id", "string lang_mark //奖品语言", "int32 receive_type //发放类型（1-系统发放，2-联系客服，4-提交表单）", ] [method.res] field = [ "repeated One list //列表数据", ] [[method.res.message]] name = "One" field = [ "int64 id //奖品id", "string reward_title //奖品标题", "string title //奖品名称", "string img_url //奖品图片", "string lang_mark //奖品语言", "int32 receive_type //发放类型（1-系统发放，2-联系客服，4-提交表单）", "repeated KV kv_data //键值数据", "string contact //联系方式", "string url //回调地址", "string form_title //表单标题", ] [[method.res.message]] name = "KV" field = [ "string key //键", "string value //值", "int32 is_show //是否展示（0-否，1-是）", ] [[method]] name = "Show" desc = "奖品详情" [method.req] field = [ "string project_hash_id //项目hash_id", "int64 id //奖品id", ] [method.res] field = [ "int64 id //奖品id", "string reward_title //奖品标题", "int32 receive_type //发放类型（1-系统发放，2-联系客服，4-提交表单）", "int64 url_id //回调地址id", "string contact //联系方式", "repeated KV kv_data //键值数据", "repeated Lang langs //语言数据", "int64 form_id //表单Id", "int64 relate_num //关联使用的数量", "int32 dy_reward_type //动态奖品内容类型（0-无，1-兑换码）", ] [[method.res.message]] name = "KV" field = [ "string key //键", "string value //值", "int32 is_show //是否展示（0-否，1-是）", ] [[method.res.message]] name = "Lang" field = [ "string mark //语言标识", "string title //奖品名称", "string img_url //奖品图片", "int32 is_default //是否默认语言(0-否，1-是)", "int32 lang_type //语言数字标识", "int32 open_to_use //开启去使用（0-否，1-是）", "string web_url //Web端的跳转地址", "string app_param //App端的跳转参数", "string pc_param //App端的跳转参数", ] [[method]] name = "Store" desc = "创建奖品" [method.req] field = [ "string project_hash_id //项目hash_id", "string reward_title //奖品标题", "int32 receive_type //发放类型（1-系统发放，2-联系客服，4-提交表单）", "int64 url_id //回调地址id", "string contact //联系方式", "repeated KV kv_data //键值数据", "repeated Lang langs //语言数据", "int64 form_id //表单id", "int32 dy_reward_type //动态奖品内容类型（0-无，1-兑换码）", "int32 source //数据来源（0-后台创建，1-奖品数据迁移，2-api创建）", ] [[method.req.message]] name = "KV" field = [ "string key //键", "string value //值", "int32 is_show //是否展示（0-否，1-是）", ] [[method.req.message]] name = "Lang" field = [ "string mark //语言标识", "string title //奖品名称", "string img_url //奖品图片", "int32 is_default //是否默认语言(0-否，1-是)", "int32 open_to_use //开启去使用（0-否，1-是）", "string web_url //Web端的跳转地址", "string app_param //App端的跳转参数", "int64 image_id //图片id", "string pc_param //App端的跳转参数", ] [method.res] field = [ "int64 id //奖品id", ] [[method]] name = "Update" desc = "更新奖品" [method.req] field = [ "string project_hash_id //项目hash_id", "int64 id //奖品id", "string reward_title //奖品标题", "int32 receive_type //发放类型（1-系统发放，2-联系客服，4-提交表单）", "int64 url_id //回调地址id", "string contact //联系方式", "repeated KV kv_data //键值数据", "repeated Lang langs //语言数据", "int64 form_id //表单id", "int32 dy_reward_type //动态奖品内容类型（0-无，1-兑换码）", ] [[method.req.message]] name = "KV" field = [ "string key //键", "string value //值", "int32 is_show //是否展示（0-否，1-是）", ] [[method.req.message]] name = "Lang" field = [ "string mark //语言标识", "string title //奖品名称", "string img_url //奖品图片", "int32 is_default //是否默认语言(0-否，1-是)", "int32 open_to_use //开启去使用（0-否，1-是）", "string web_url //Web端的跳转地址", "string app_param //App端的跳转参数", "int64 image_id //图片id", "string pc_param //App端的跳转参数", ] [method.res] field = [ "int64 id //奖品id", ] [[method]] name = "Destroy" desc = "删除奖品" [method.req] field = [ "string project_hash_id //项目hash_id", "string ids //奖品id，多个用逗号分割", ] [method.res] field = [ "repeated string ids // 还关联活动的奖品id", ] [[method]] name = "UrlList" desc = "回调地址列表" [method.req] field = [ "string project_hash_id //项目hash_id", "int32 order_type //排序类型（1-创建时间升序），其他默认", ] [method.res] field = [ "repeated One list //列表数据", ] [[method.res.message]] name = "One" field = [ "int64 id //回调地址id", "string title //回调地址说明", "string url //回调地址", "int64 num //关联奖品数量", "int64 created_at //创建时间", "repeated Header headers //头信息", ] [[method.res.message]] name = "Header" field = [ "string key //回调头键", "string mark //特殊键标识", "string val //回调数值", ] [[method]] name = "UrlStore" desc = "创建回调地址" [method.req] field = [ "string project_hash_id //项目hash_id", "string title //回调地址说明", "string url //回调地址", "int32 source //数据来源（0-后台创建，1-奖品数据迁移，2-api创建）", "repeated Header headers //头信息", ] [[method.req.message]] name = "Header" field = [ "string key //回调头键", "string mark //特殊键标识", "string val //回调数值", ] [method.res] field = [ "int64 id //地址id", ] [[method]] name = "UrlUpdate" desc = "更新回调地址" [method.req] field = [ "string project_hash_id //项目hash_id", "int64 id //地址id", "string title //回调地址说明", "string url //回调地址", "repeated Header headers //头信息", ] [[method.req.message]] name = "Header" field = [ "string key //回调头键", "string mark //特殊键标识", "string val //回调数值", ] [method.res] field = [ "int64 id //地址id", ] [[method]] name = "UrlDestroy" desc = "删除回调地址" [method.req] field = [ "string project_hash_id //项目hash_id", "int64 id //地址id", ] [method.res] [[method]] name = "FormList" desc = "表单列表" [method.req] field = [ "int32 page //当前页", "int32 per_page //每页条数", "string project_hash_id //项目hash_id", "string title //表单标题", ] [method.res] field = [ "repeated One list //列表数据", "int64 total //列表总数" ] [[method.res.message]] name = "One" field = [ "int64 id //表单ID", "string title //表单标题", "int64 created_at //创建时间", "repeated Item items //表单项", "int64 num //关联奖品数量", ] [[method.res.message]] name = "Item" field = [ "string name //表单项名称", ] [[method]] name = "FormSelect" desc = "表单选择" [method.req] field = [ "string project_hash_id //项目hash_id", ] [method.res] field = [ "repeated One list //列表数据", ] [[method.res.message]] name = "One" field = [ "int64 id //表单ID", "string title //表单标题", ] [[method]] name = "FormStore" desc = "创建表单" [method.req] field = [ "string project_hash_id //项目hash_id", "string title //表单标题", "repeated Item items //表单项", ] [[method.req.message]] name = "Item" field = [ "string name //表单项名称", "repeated Tran trans //字段语言翻译", ] [[method.req.message]] name = "Tran" field = [ "string mark //语言标识", "string name //字段对应语言的名称", "int32 is_default //字段语言翻译", ] [method.res] field = [ "int64 id //表单id" ] [[method]] name = "FormUpdate" desc = "更新表单" [method.req] field = [ "int64 id //表单ID", "string title //表单标题", "repeated Item items //表单项", ] [[method.req.message]] name = "Item" field = [ "string name //表单项名称", "repeated Tran trans //字段语言翻译", ] [[method.req.message]] name = "Tran" field = [ "string mark //语言标识", "string name //字段对应语言的名称", "int32 is_default //字段语言翻译", ] [method.res] field = [ "int64 id //表单id" ] [[method]] name = "FormDestroy" desc = "删除表单" [method.req] field = [ "string project_hash_id //项目hash_id", "int64 id //表单ID", ] [method.res] field = [ "int64 id //表单id" ] [[method]] name = "Forms" desc = "表单数据" [method.req] field = [ "int64 project_id //项目id", "repeated int64 ids //表单id", ] [method.res] field = [ "repeated One list //列表数据", ] [[method.res.message]] name = "One" field = [ "int64 id //表单ID", "string title //表单标题", "int64 created_at //创建时间", "repeated Item items //表单项", ] [[method.res.message]] name = "Item" field = [ "string name //表单项名称", ] [[method]] name = "Urls" desc = "回调地址数据" [method.req] field = [ "int64 project_id //项目id", "repeated int64 ids //地址id", ] [method.res] field = [ "repeated One list //列表数据", ] [[method.res.message]] name = "One" field = [ "int64 id //回调地址id", "string title //回调地址说明", "string url //回调地址", "int64 created_at //创建时间", "repeated Header headers //头信息", ] [[method.res.message]] name = "Header" field = [ "string key //回调头键", "string mark //特殊键标识", "string val //回调数值", ] [[method]] name = "Rewards" desc = "奖品详情" [method.req] field = [ "int64 project_id //项目id", "repeated int64 ids //奖品id", "string lang_mark //语言标识", ] [method.res] field = [ "repeated One list //列表数据", ] [[method.res.message]] name = "One" field = [ "int64 id //奖品id", "string reward_title //奖品标题", "int32 receive_type //发放类型（1-系统发放，2-联系客服，4-提交表单）", "int64 url_id //回调地址id", "string contact //联系方式", "repeated KV kv_data //键值数据", "Lang lang //语言数据", "int64 form_id //表单Id", "int32 dy_reward_type //动态奖品内容类型（0-无，1-兑换码）", ] [[method.res.message]] name = "KV" field = [ "string key //键", "string value //值", "int32 is_show //是否展示（0-否，1-是）", ] [[method.res.message]] name = "Lang" field = [ "string mark //语言标识", "string title //奖品名称", "string img_url //奖品图片", "int32 is_default //是否默认语言(0-否，1-是)", "int32 open_to_use //开启去使用（0-否，1-是）", "string web_url //Web端的跳转地址", "string app_param //App端的跳转参数", "string pc_param //pc端的跳转参数", ] [[method]] name = "RelateReward" desc = "关联奖品" [method.req] field = [ "int64 project_id //项目id", "int64 relate_id //关联id", "string relate_table //关联表名字，如果不是dplk_db库，建议带上库名字如dbname.relate_table_name", "repeated int64 reward_ids //关联的奖品id集合", ] [method.res] [[method]] name = "PushReward" desc = "奖品推送" [method.req] field = [ "string source //来源标识,wall-积分墙，center-任务中心", "int64 source_id //来源id，如：来源是campaign，这个就写campaign_id，没有填写0", "string source_hash_id //来源hash_id，推送", "int64 source_second_id //来源第二级id，如：来源是任务中心，奖品任务中心的某个模块发放，这里就是模块id，没有填写0", "int64 relate_id //关联id，用于后续对比查询，如：发放记录的ID", "string relate_hash_id //推送时给第三方的id", "string title //关联id，用于后续对比查询，如：发放记录的ID", "int64 reward_id //推送的奖品库存id", "int32 num //奖品发放数量", "string user_id //第三方应用的用户id", "string user_platform //活动用户设备平台", "string parent_user_id //上级用户id", "string parent_platform //活动用户的上级用户设备平台", "string lang //用户语言标识", "int32 sync //是否同步请求（0-否，1-是）", "int32 reward_type //发放类型（1-活动奖品，2-站外活动奖品，3-额外奖品，4-新人奖品，5-养成阶段奖励，6-任务奖励，7-子活动奖励，8-兑换奖励），没有合适的要加", "int64 campaign_id //推送的活动id", ] [method.res] field = [ "string task_id //当前发放任务id，固定20位字符串", "string reward_val //回调后接收到的数据", "int32 status //状态（1-推送中，2-完成，3-失败）", "string fail_type // 失败类型，system-系统出错，client-客户的错误，undefined-未知错误", "string fail_msg // 错误信息", ] [[method]] name = "RewardIds" desc = "查询奖品id" [method.req] field = [ "int64 project_id //项目id", "string reward_title //获取奖品标题", ] [method.res] field = [ "repeated int64 ids //列表数据", ]