访问路径:api/marketplugin/pluginActivity/getPluginActivityId

接口说明:根据组件 id 获取活动和配置信息

URL结构

https://plugin.szzbmy.com/api/marketplugin/pluginActivity/getPluginActivityId

接口协议:HTTPS

HTTP请求方式:GET

请求参数

参数
必选
类型
说明
pluginComponentId
true
string
插件组件Id

换行和缩进只是为了更好的展示:请求示例

https://plugin.szzbmy.com/api/marketplugin/pluginActivity/getPluginActivityId

返回参数

参数
类型
说明
awardId
string
活动的奖品id
awardLevel
string奖品等级(在配置插件时由用户设置)
awardSource
string奖品的来源, 虚拟奖品 VIRTUAL_PRIZE,实物奖品MATERIAL_PRIZE、优惠券 COUPON

award
obj兔展权益库中对应的奖品信息
objId
string奖品在兔展权益库中的id
objName
string奖品在兔展权益库中的名称
objImg
string奖品的图片
objType
string奖品在兔展权益库中的类型. VIRTUAL 虚拟 、 MATERIAL 实物
objGrantWay
int发奖方式  1. 直发到账、2 发放券码、3  企业自行发奖
objPeriodType
忽略无用字段,忽略
objPeriodDay
忽略无用字段,忽略
objSubTitle
忽略无用字段,忽略

awardNum
int奖品在活动中设置的数量
winRate
int活动中设置的奖品中奖率

winUserLimit
obj中奖用户限制
limitWayint限制方式 1不限制、2白名单、3 黑名单、4 已有客户、5 第三方接口鉴权
blackWhiteojb黑白名单列表
checkField
string校验字段. 由用户上传的excel模板中定义。由后端解析oss文件内容取出来
ossPath
string上传的文件路径
fileName
string文件名称
userobj已有客户列表
optionstringuser 用户,tag 标签,group 分组、mark 星标
dataobj用户信息

exchangePeriodType
string兑奖期限方式 1 时间段 、2 相对时间
periodAfterDay
int兑奖后天数,如果兑奖期限方式为2
checkWay
int核券方式 1 商城核销、2 门店核销
receiveAwardWay
int领奖方式 1跳转网页、2 门店或网点地址
exchangeUrl
string兑奖url,网页链接
exchangeAddress
string兑奖地址,具体的地址位置信息
operateTip
string操作提示
contact
string联系信息
exchangeDescstring兑奖说明
serialNumint排序字段


返回示例

{
  "code": "200",
  "msg": "ok",
  "data": [
    {
      "awardId": "1101a151-600c-4390-9d1c-f008b05081ac",
      "awardLevel": "士大夫是",
      "awardSource": "VIRTUAL_PRIZE",
      "award": {
        "objId": "698179222816305152",
        "objName": "22",
        "objImg": "//test-cdn1.rabbitpre.com/e93e5a4f-c686-4712-8eac-d268cc9c40b4",
        "objType": "VIRTUAL",
        "objGrantWay": 3,
        "objPeriodType": 2,
        "objPeriodDay": 2,
        "objSubTitle": ""
      },
      "awardNum": 10,
      "winRate": 10,
      "winUserLimit": {
        "limitWay": 1,
        "blackWhite": {
          "checkField": "",
          "ossPath": "",
          "fileName": ""
        },
        "user": {
          "option": "tag",
          "data": []
        }
      },
      "exchangePeriodType": "2",
      "periodAfterDay": 2,
      "checkWay": 1,
      "receiveAwardWay": 2,
      "exchangeUrl": "",
      "exchangeAddress": "",
      "operateTip": "",
      "contact": "",
      "exchangeDesc": "",
      "serialNum": 1
    },
    {
      "awardId": "74c8b825-231c-4895-91aa-e6f78b96e6d2",
      "awardLevel": "第三方按时",
      "awardSource": "VIRTUAL_PRIZE",
      "award": {
        "objId": "698199992409657344",
        "objName": "dfsasd",
        "objImg": "//test-cdn1.rabbitpre.com/f616bc77-fe89-4931-b88f-fdc8ed7cf680",
        "objType": "VIRTUAL",
        "objGrantWay": 3,
        "objPeriodType": 2,
        "objPeriodDay": 2,
        "objSubTitle": ""
      },
      "awardNum": 10,
      "winRate": 100,
      "winUserLimit": {
        "limitWay": 1,
        "blackWhite": {
          "checkField": "",
          "ossPath": "",
          "fileName": ""
        },
        "user": {
          "option": "tag",
          "data": []
        }
      },
      "exchangePeriodType": "2",
      "periodAfterDay": 2,
      "checkWay": 1,
      "receiveAwardWay": 2,
      "exchangeUrl": "",
      "exchangeAddress": "",
      "operateTip": "",
      "contact": "",
      "exchangeDesc": "",
      "serialNum": 3
    },
    {
      "awardId": "8461a5bb-7394-41ee-a751-ae08bdca4650",
      "awardLevel": "第三方沙发",
      "awardSource": "VIRTUAL_PRIZE",
      "award": {
        "objId": "698138573853306880",
        "objName": "long-大量数据",
        "objImg": "//test-cdn1.rabbitpre.com/f840a5d4-e17c-47b8-b54c-fc0090d14a47",
        "objType": "VIRTUAL",
        "objGrantWay": 3,
        "objPeriodType": 2,
        "objPeriodDay": 2,
        "objSubTitle": ""
      },
      "awardNum": 10,
      "winRate": 10,
      "winUserLimit": {
        "limitWay": 1,
        "blackWhite": {
          "checkField": "",
          "ossPath": "",
          "fileName": ""
        },
        "user": {
          "option": "tag",
          "data": []
        }
      },
      "exchangePeriodType": "2",
      "periodAfterDay": 2,
      "checkWay": 1,
      "receiveAwardWay": 2,
      "exchangeUrl": "",
      "exchangeAddress": "",
      "operateTip": "",
      "contact": "",
      "exchangeDesc": "",
      "serialNum": 2
    }
  ]
}