[service]
name = "WCommon"
desc = "通用服务"

[[method]]
name = "PolicyToken"
desc = "获取阿里云token"
[method.req]
field = [
    "string file_suffix //文件后缀",
]

[method.res]
field = [
    "string access_key_id //oss accessKeyId",
    "string host //oss访问域名",
    "string upload_url //上传地址",
    "int64 expire //过期时间，单位（s）",
    "string signature //验签字符串",
    "string dir //存储文件夹（文件前缀）",
    "string key //文件名称",
    "string policy //验签token",
]

[[method]]
name = "Whitelist"
desc = "服务器白名单"
[method.req]

[method.res]
field = [
    "repeated string ips //服务器列表",
]

[[method]]
name = "Download"
desc = "下载"
[method.req]
field = [
    "int64 user_id //下载人id",
    "string mark //campaign_report-活动报表，fission_user-活动用户，fission_reward_record-活动奖品，fission_user_stat-活动排行榜，ads_table-广告报表，new_user_list-新版用户列表",
    "CampaignReport campaign_report //活动报表条件",
    "FissionUser fission_user //活动用户条件",
    "FissionRewardRecord fission_reward_record //活动奖品条件",
    "FissionUserStat fission_user_stat //活动排行榜条件",
    "AdsTable ads_table //广告报表条件",
    "NewUserList new_user_list //新版用户列表",
    "CoinRecord coin_record //金币池领扣记录",
    "ChildList child_list //子活动用户列表",
]

[[method.req.message]]
name = "CampaignReport"
field = [
    "string campaign_hash_id //活动hash_id",
    "int64 start_time //统计开始时间时间戳",
    "int64 end_time //统计结束时间时间戳",
]

[[method.req.message]]
name = "FissionUser"
field = [
    "string campaign_hash_id //活动hash_id",
    "string user_mark //用户标识关键字",
    "int64 start //参与时间开始时间戳",
    "int64 end //参与时间结束时间戳",
    "string parent_user_mark //上级用户标识关键字",
    "int32 source //来源（1-直接访问，2-打开事件，3-安装事件，4-注册事件，5-自定义事件）",
]

[[method.req.message]]
name = "FissionRewardRecord"
field = [
    "string campaign_hash_id //活动hash_id",
    "string user_mark //用户标识关键字",
    "int64 start //参与时间开始时间戳",
    "int64 end //参与时间结束时间戳",
    "repeated int32 status //奖品状态（1-发送成功，2-待发送，3-发送失败，4-手动发放）",
    "string reward_title //奖品名称",
    "int32 t_offset //时区",
    "int32 is_child //是否子活动奖品",
]

[[method.req.message]]
name = "FissionUserStat"
field = [
    "string campaign_hash_id //活动hash_id",
    "string type //数据类型（空-旧报表，invite-下载/注册排行榜，task-用户完成指定事件排行榜，grow-养成排行榜）",
]

[[method.req.message]]
name = "AdsTable"
field = [
    "string campaign_hash_id //活动hash_id",
    "int64 start_time //统计开始时间时间戳",
    "int64 end_time //统计结束时间时间戳",
]

[[method.req.message]]
name = "NewUserList"
field = [
    "string campaign_hash_id //活动hash_id",
    "string user_mark //用户标识关键字",
    "int64 start //参与时间开始时间戳",
    "int64 end //参与时间结束时间戳",
    "string parent_user_mark //上级用户标识关键字",
    "int32 source //来源（1-直接访问，2-打开事件，3-安装事件，4-注册事件，5-自定义事件）",
    "string lang_mark //上级用户标识关键字",
    "int32 t_offset //时区",
    "int32 pid_type //上级用户类型（0-指定上级用户id，1-仅有上级的用户，2-仅无上级的用户）",
    "int32 join_type //上级用户类型（1-进入过活动的用户，2-没有进入过活动的用户）",
    "repeated int32 user_cond //用户条件（1-有安装的用户，2-有注册的用户）",
]

[[method.req.message]]
name = "CoinRecord"
field = [
    "int64 user_id //活动用户id",
    "int64 campaign_id //活动id",
    "string campaign_hash_id //活动hash_id",
    "int64 scene_id //场次id",
    "int32 type //日志类型（1-消耗金币，2-获得金币）",
    "string source //来源标识",
    "int32 t_offset //时区",
    "int64 start //创建时间开始时间戳",
    "int64 end //创建时间结束时间戳",
    "string sub_user_id //用户id",
]

[[method.req.message]]
name = "ChildList"
field = [
    "string campaign_hash_id //活动hash_id",
    "string user_mark //用户标识关键字",
    "int64 start //参与时间开始时间戳",
    "int64 end //参与时间结束时间戳",
    "string parent_user_mark //上级用户标识关键字",
    "int32 t_offset //时区",
    "int32 pid_type //上级用户类型（0-指定上级用户id，1-仅有上级的用户，2-仅无上级的用户）",
]

[method.res]
field = [
    "string hash_id //报表id",
]

[[method]]
name = "DownloadStatus"
desc = "下载状态"
[method.req]
field = [
    "string hash_id //报表id",
]

[method.res]
field = [
    "int32 status //状态（1-下载中，2-下载完成，3-下载失败，4-已过期）",
    "string url //文件地址",
    "string fail_msg //失败原因",
    "string progress //导出进度",
]

[[method]]
name = "OperateLog"
desc = "dashboard操作日志"
[method.req]
field = [
    "int64 user_id //员工id",
    "string ip //客户端ip地址",
    "string mark //操作唯一标识，一种操作对应一个标识，长度不能超过32个字符串",
    "string mark_id //操作数据追踪类型id，如：修改某个活动奖品，那这个就是奖品id（其实这个字段为了优化mark索引的，所以不传也可以）",
    "string data //记录的数据 json格式字符串",
]

[method.res]

[[method]]
name = "SaveMaterial"
desc = "保存素材"
[method.req]
field = [
    "string project_hash_id //项目hash_id",
    "int32 material_type //素材类型（1-图片）",
    "string material_data //素材类型的数据（图片类型：地址图片）",
]

[method.res]
field = [
    "int64 id //素材id",
]

[[method]]
name = "MaterialList"
desc = "素材列表"
[method.req]
field = [
    "int32 page //当前页",
    "int32 per_page //每页条数",
    "int32 material_type //素材类型（1-图片）",
    "int64 project_id //项目id",
    "string project_hash_id //项目hash_id",
]

[method.res]
field = [
    "repeated One list //数据集合",
    "int64 total //数据总数",
]

[[method.res.message]]
name = "One"
field = [
    "int64 id //素材id",
    "int32 material_type //素材id",
    "string material_data //素材数据",
]

[[method]]
name = "CompanyMade"
desc = "企业定制组件列表"
[method.req]
field = [
    "int64 company_id //企业id",
]

[method.res]
field = [
    "repeated One list //数据集合",
]

[[method.res.message]]
name = "One"
field = [
    "int64 id //素材id",
    "string mark //标识（lv_api支持用户类型配置api）",
    "repeated string fission_temp //支持的模版"
]