平台道具条件发货接入
说明
在一些联合活动的场景中,需要涉及到平台侧自己的道具发放,另外还需要根据平台侧提供的条件确定是否能做道具发放(例如完成了平台的某个任务才能发腾讯游戏道具),所以这里提供了一套接口协议,平台侧按接口协议实现接口并提供给 腾讯游戏来联,腾讯游戏来联 侧会完成平台接口接入,实现平台道具发放和任务条件判断的能力。
1. 发货接口(必要)
说明
平台侧实现该接口,用来发放平台侧道具,
接口入参
字段名称 | 字段类型 | 字段是否必填 | 字段说明 |
userId | string | 是 | 平台用户 ID |
packageId | string | 是 | 平台道具 ID |
serialCode | string | 是 | 幂等标识 |
packageNum | int | 否 | 平台道具数量 |
接口返回
字段名称 | 字段类型 | 字段是否必填 | 字段说明 |
code | int | 是 | 错误码,0 表示成功 |
msg | string | 是 | 错误提示 |
packageName | string | 否 | 平台道具名称 |
2. 任务查询(必要)
说明
平台侧实现该接口,用来判断用户是否通过平台条件。
接口入参
字段名称 | 字段类型 | 字段是否必填 | 字段说明 |
userId | string | 是 | 平台用户 ID |
taskId | string | 是 | 平台任务 ID |
ts | int | 是 | 时间戳(平台侧会带时间戳来访问腾讯的接口,这里会将时间戳透传给平台,防止一些任务判断的临界问题) |
接口返回
字段名称 | 字段类型 | 字段是否必填 | 字段说明 |
code | int | 是 | 错误码,0 表示成功 |
msg | string | 是 | 错误提示 |
isPass | bool | 是 | 是否通过条件 |
3. 任务获取接口
说明
平台侧实现该接口,用来返回平台任务的配置信息。
例如平台侧需要三个条件:满足观看 5min 发货,满足观看 10min 发货,如果根据接口 2 则需要提供两个 taskId 分别对应两个发货,在这种情况可以用这个接口,curVal 返回当前用户的观看时长,由 腾讯游戏来联 活动系统自行判断时长,减少平台的配置工作量。
接口入参
字段名称 | 字段类型 | 字段是否必填 | 字段说明 |
userId | string | 是 | 平台用户 ID |
taskId | string | 是 | 平台任务 ID |
ts | int | 是 | 时间戳(平台侧会带时间戳来访问腾讯的接口,这里会将时间戳透传给平台,防止一些任务判断的临界问题) |
接口返回
字段名称 | 字段类型 | 字段是否必填 | 字段说明 |
code | int | 是 | 错误码,0 表示成功 |
msg | string | 是 | 错误提示 |
curVal | string | 是 | 当前值 |
expectVal | string | 否 | 期望值 |
4. 资格扣减
说明
平台侧实现该接口,用来发货之前确认扣减平台侧发货资格次数。
接口入参
字段名称 | 字段类型 | 字段是否必填 | 字段说明 |
userId | string | 是 | 平台用户 ID |
taskId | string | 是 | 平台任务 ID |
serialCode | string | 是 | 幂等标识 |
num | int | 是 | 扣减次数 |
接口返回
字段名称 | 字段类型 | 字段是否必填 | 字段说明 |
code | int | 是 | 错误码,0 表示成功 |
msg | string | 是 | 错误提示 |
5. 资格增加
说明
平台侧实现该接口,用来处理扣减资格成功但发货失败的回滚场景。
接口入参
字段名称 | 字段类型 | 字段是否必填 | 字段说明 |
userId | string | 是 | 平台用户 ID |
taskId | string | 是 | 平台任务 ID |
serialCode | string | 是 | 幂等标识 |
num | int | 是 | 增加次数 |
接口返回
字段名称 | 字段类型 | 字段是否必填 | 字段说明 |
code | int | 是 | 错误码,0 表示成功 |
msg | string | 是 | 错误提示 |