查询单元报表历史数据
名称 | 类型 | 是否必须 | 示例值 | 描述 |
---|---|---|---|---|
appMethod | String | Y | suning.custom.category.query | 方法名 |
appRequestTime | String | Y | 2012-04-25 20:23:30 | 时间戳,格式为yyyy-MM-dd HH:mm:ss,例如:2012-04-25 20:23:30。API服务端允许客户端请求时间误差为10分钟。 |
format | String | N | XML | 默认xml,可指定格式为xml,json |
appKey | String | Y | b0c332a133c102765f39de********** | 分配给应用的访问令牌 |
versionNo | String | Y | v1.2 | API的版本,目前为v1.2版本 |
signInfo | String | Y | 460d7ff15b073e463125b4********** | appSecret,appMethod ,appRequestTime, appKey, versionNo, 请求报文base64加密后的数据顺序MD5(32位小写),其中appSecret为appKey对应的密钥 |
access_token | String | N | a1c5c62b08df3a3cbf7efd********** | 采用OAuth授权方式为必填参数 |
名称 | 类型 | 是否必须 | 示例值 | 描述 |
---|---|---|---|---|
custnum | String | Y | 777777 | 操作用户id |
pagerNumber | String | Y | 1 | 当前页数 |
pagerSize | String | Y | 1 | 每页条数 |
throwType | String | N | 0:PC,1:mobile,其他:全部 | 投放终端 |
startDate | String | Y | yyyy-MM-dd | 开始日期 |
endDate | String | Y | yyyy-MM-dd | 结束日期 |
orderBy | String | N | 可为空,默认按更新时间倒序,可自己设置的排序字段如下:orderByFields.add(showNum); | 排序字段 |
promotionName | String | N | xxxx | 计划名称 |
productType | String | N | 1.聚客宝 2.生意通 3.大聚惠 4.生意通店铺推广 | 产品类型 |
promotionUnitId | String | N | 54321 | 计划单元id |
promotionDate | String | N | yyyy-MM-dd | 计划日期 |
goodsName | String | N | 可乐 | 商品名称 |
dayType | String | N | _:1天,3day:3天,_7day:7天,_15day:15天 | ROI及订单统计范围 |
isDay | String | Y | true:分日报表 false:统计报表 | 是否分日报表 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
status | String | 0:成功,1:失败 | 状态 |
msg | String | 成功 | 状态说明 |
data | String | ||
dataList | String | ||
avgCost | String | 0.39 | 平均点击成本(单位:元) |
clickNum | String | 111 | 点击量 |
clickRate | String | 55.50% | 点击率 |
clickRateSort | String | 55.5 | 点击率排序 |
conversionRate | String | 444.14% | 下单转化率 |
conversionRateSort | String | 444.14 | 下单率排序 |
cost | String | 43 | 花费(单位:元) |
directAddshoppingcartNum | String | 154 | 直接加购数 |
directDealAmount | String | 1200 | 直接成交金额 |
directDealNum | String | 1000 | 直接成交笔数 |
directSubmitAmount | String | 650 | 直接提交订单金额 |
directSubmitOrder | String | 252 | 直接提交订单数 |
goodsFocusNum | String | 504 | 商品关注数 |
goodsName | String | C店球票商品测试数据201911230726382mq3 | 商品名称 |
indirectAddshoppingcartNum | String | 245 | 间接加购数 |
indirectDealAmount | String | 200 | 间接成交金额 |
indirectDealOrder | String | 244 | 间接成交订单总数 |
promotionName | String | 大促报文测试_勿删 | 计划名称 |
promotionStatus | String | 1 | 计划状态 |
promotionDate | String | 时间格式:yyyy-MM-dd | 推广日期 |
promotionUnitId | String | 8880001000002057 | 计划单元ID |
roi | String | 5.74 | 下单ROI |
showNum | String | 200 | 展现量 |
throwSource | String | 全部 | 投放终端 |
totalAddshoppingcartNum | String | 399 | 总加购数 |
totalDealAmount | String | 1000 | 总成交金额 |
totalSubmitAmount | String | 247 | 总下单金额 |
indirectSubmitAmount | String | 10 | 10 |
indirectSubmitOrder | String | 1 | 间接提交订单 |
overViewData | String | ||
avgCost | String | 0.5 | 平均点击成本(单位:元) |
clickNum | String | 136 | 点击量 |
clickRate | String | 45.33% | 点击率 |
conversionRate | String | 725.00% | 下单转化率 |
cost | String | 68 | 花费(单位:元) |
directAddshoppingcartNum | String | 308 | 直接加购数 |
directDealAmount | String | 1500 | 直接成交金额 |
directDealNum | String | 1500 | 直接成交订单数 |
directSubmitAmount | String | 1300 | 直接下单金额 |
directSubmitOrder | String | 504 | 直接下单量 |
goodsFocusNum | String | 1008 | 商品关注数 |
goodsName | String | 商品名称 | 商品名称 |
indirectAddshoppingcartNum | String | 490 | 间接加购数 |
indirectDealAmount | String | 400 | 间接成交金额 |
indirectDealOrder | String | 488 | 间接成交订单数 |
indirectSubmitAmount | String | 490 | 间接下单金额 |
indirectSubmitOrder | String | 482 | 间接下单量 |
promotionName | String | 计划名称 | 计划名称 |
roi | String | 26.32 | 下单ROI |
showNum | String | 300 | 展现量 |
throwSource | String | 投放终端 | 投放终端 |
totalAddshoppingcartNum | String | 798 | 总加购数 |
totalDealAmount | String | 1500 | 总成交金额 |
totalSubmitAmount | String | 494 | 下单金额 |
pagerNumber | String | 1 | 当前页数 |
totalCount | String | 2 | 记录总是 |
<sn_request> <sn_body> <queryGetpromotionunitrepbypage> <throwType>0:PC,1:mobile,其他:全部</throwType> <endDate>yyyy-MM-dd</endDate> <custnum>777777</custnum> <pagerNumber>1</pagerNumber> <orderBy>可为空,默认按更新时间倒序,可自己设置的排序字段如下:orderByFields.add(showNum);</orderBy> <promotionDate>yyyy-MM-dd</promotionDate> <isDay>true:分日报表 false:统计报表</isDay> <pagerSize>1</pagerSize> <dayType>_:1天,3day:3天,_7day:7天,_15day:15天</dayType> <promotionUnitId>54321</promotionUnitId> <promotionName>xxxx</promotionName> <goodsName>可乐</goodsName> <startDate>yyyy-MM-dd</startDate> <productType>1.聚客宝 2.生意通 3.大聚惠 4.生意通店铺推广</productType> </queryGetpromotionunitrepbypage> </sn_body> </sn_request>
{ "sn_request": { "sn_body": { "queryGetpromotionunitrepbypage": { "throwType": "0:PC,1:mobile,其他:全部", "endDate": "yyyy-MM-dd", "custnum": "777777", "pagerNumber": "1", "orderBy": "可为空,默认按更新时间倒序,可自己设置的排序字段如下:orderByFields.add(showNum);", "promotionDate": "yyyy-MM-dd", "isDay": "true:分日报表 false:统计报表", "pagerSize": "1", "dayType": "_:1天,3day:3天,_7day:7天,_15day:15天", "promotionUnitId": "54321", "promotionName": "xxxx", "goodsName": "可乐", "startDate": "yyyy-MM-dd", "productType": "1.聚客宝 2.生意通 3.大聚惠 4.生意通店铺推广" } } } }
<sn_responseContent> <sn_body> <queryGetpromotionunitrepbypage> <msg>成功</msg> <data> <dataList> <totalAddshoppingcartNum> 399</totalAddshoppingcartNum> <roi>5.74</roi> <conversionRateSort>444.14</conversionRateSort> <promotionStatus> 1</promotionStatus> <promotionUnitId>8880001000002057</promotionUnitId> <promotionName>大促报文测试_勿删</promotionName> <totalSubmitAmount> 247</totalSubmitAmount> <goodsFocusNum>504</goodsFocusNum> <clickRate>55.50%</clickRate> <directAddshoppingcartNum> 154</directAddshoppingcartNum> <clickNum> 111</clickNum> <avgCost>0.39</avgCost> <indirectDealOrder> 244</indirectDealOrder> <totalDealAmount>1000</totalDealAmount> <goodsName>C店球票商品测试数据201911230726382mq3</goodsName> <indirectAddshoppingcartNum> 245</indirectAddshoppingcartNum> <cost>43</cost> <directSubmitAmount>650</directSubmitAmount> <promotionDate>时间格式:yyyy-MM-dd</promotionDate> <directSubmitOrder> 252</directSubmitOrder> <indirectSubmitAmount>10</indirectSubmitAmount> <throwSource>全部</throwSource> <conversionRate>444.14%</conversionRate> <indirectSubmitOrder>1</indirectSubmitOrder> <showNum>200</showNum> <clickRateSort> 55.5</clickRateSort> <directDealNum> 1000</directDealNum> <directDealAmount>1200</directDealAmount> <indirectDealAmount> 200</indirectDealAmount> </dataList> <pagerNumber>1</pagerNumber> <totalCount>2</totalCount> <overViewData> <cost> 68</cost> <totalAddshoppingcartNum>798</totalAddshoppingcartNum> <directSubmitAmount> 1300</directSubmitAmount> <directSubmitOrder> 504</directSubmitOrder> <indirectSubmitAmount>490</indirectSubmitAmount> <throwSource>投放终端</throwSource> <conversionRate> 725.00%</conversionRate> <roi>26.32</roi> <indirectSubmitOrder>482</indirectSubmitOrder> <showNum>300</showNum> <promotionName>计划名称</promotionName> <totalSubmitAmount> 494</totalSubmitAmount> <goodsFocusNum> 1008</goodsFocusNum> <clickRate>45.33%</clickRate> <directAddshoppingcartNum> 308</directAddshoppingcartNum> <directDealNum> 1500</directDealNum> <clickNum>136</clickNum> <directDealAmount> 1500</directDealAmount> <indirectDealAmount> 400</indirectDealAmount> <avgCost>0.5</avgCost> <indirectDealOrder> 488</indirectDealOrder> <totalDealAmount>1500</totalDealAmount> <goodsName>商品名称</goodsName> <indirectAddshoppingcartNum>490</indirectAddshoppingcartNum> </overViewData> </data> <status>0:成功,1:失败</status> </queryGetpromotionunitrepbypage> </sn_body> </sn_responseContent>
{ "sn_responseContent": { "sn_body": { "queryGetpromotionunitrepbypage": { "msg": "成功", "data": [ { "dataList": [ { "totalAddshoppingcartNum": " 399", "roi": "5.74", "conversionRateSort": "444.14", "promotionStatus": " 1", "promotionUnitId": "8880001000002057", "promotionName": "大促报文测试_勿删", "totalSubmitAmount": " 247", "goodsFocusNum": "504", "clickRate": "55.50%", "directAddshoppingcartNum": " 154", "clickNum": " 111", "avgCost": "0.39", "indirectDealOrder": " 244", "totalDealAmount": "1000", "goodsName": "C店球票商品测试数据201911230726382mq3", "indirectAddshoppingcartNum": " 245", "cost": "43", "directSubmitAmount": "650", "promotionDate": "时间格式:yyyy-MM-dd", "directSubmitOrder": " 252", "indirectSubmitAmount": "10", "throwSource": "全部", "conversionRate": "444.14%", "indirectSubmitOrder": "1", "showNum": "200", "clickRateSort": " 55.5", "directDealNum": " 1000", "directDealAmount": "1200", "indirectDealAmount": " 200" } ], "pagerNumber": "1", "totalCount": "2", "overViewData": [ { "cost": " 68", "totalAddshoppingcartNum": "798", "directSubmitAmount": " 1300", "directSubmitOrder": " 504", "indirectSubmitAmount": "490", "throwSource": "投放终端", "conversionRate": " 725.00%", "roi": "26.32", "indirectSubmitOrder": "482", "showNum": "300", "promotionName": "计划名称", "totalSubmitAmount": " 494", "goodsFocusNum": " 1008", "clickRate": "45.33%", "directAddshoppingcartNum": " 308", "directDealNum": " 1500", "clickNum": "136", "directDealAmount": " 1500", "indirectDealAmount": " 400", "avgCost": "0.5", "indirectDealOrder": " 488", "totalDealAmount": "1500", "goodsName": "商品名称", "indirectAddshoppingcartNum": "490" } ] } ], "status": "0:成功,1:失败" } } } }
异常码 | 错误描述 | 解决方案 |
---|---|---|
biz.advertise.querygetpromotionunitrepbypage.missing-parameter:* | 参数必填 | 请检查此参数的值,*号表示参数字段名 |
biz.handler.data-get:no-result | 查询没结果 | 请检查查询参数 |
isp.sys.service.unavailable.adss | 服务不可用 | 请联系苏宁技术人员 |
异常码 | 错误描述 | 解决方案 |
---|---|---|
sys.check.user-permission:inexistence | 访问令牌不存在 | 更换访问令牌 |
sys.check.user-permission:overdue | 访问令牌已过期 | 请使用刷新令牌刷新 |
sys.check.api-permission:inexistence | Api方法不存在 | 请参考帮助中心 |
sys.check.api-permission:overdue | Api方法已过期 | 请参考帮助中心 |
sys.check.method-permission:authority | 无权操作此api | 确认是否有访问该方法权限 |
sys.auth.vendor-request:errory | 无权操作此供应商 | 请确认供应商编码是否正确 |
sys.controller.api-request:limit | Api请求受控 | 超过请求次数 |
sys.check.app-time:error | 请求参数错误api请求时间误差大 | 参考帮助中心 |
sys.check.request-params:error | 请求报文结构错误 | 参考帮助中心、日期格式等 |
sys.check.starttime-format:error | 请求开始时间错误 | 参考帮助中心、日期格式等 |
biz.handler.data-get:success | 业务数据查询成功 | 无 |
biz.handler.data-get:fail | 业务数据查询失败 | 检查请求条件 |
biz.handler.data-get:no-result | 业务数据结果为空 | 无 |
sys.check.pageno-format:error | pageNo格式错误,只允许1到99999之间的整数 | 检查pageNo输入是否有误 |
sys.check.pagesize-format:error | pageSize格式错误,只允许1到50之间的整数(订单相关是1到100) | 检查pageSize输入是否有误 |
sys.check.page-param:error | pageNo或者pageSize不在要求范围内,pageNo只允许1到99999之间的整数,pageSize只允许1到50之间的整数(订单相关是1到100) | 检查pageNo和pageSize输入是否有误 |
sys.check.miss-time:starttime | 不存在开始时间(节点) | 检查输入 |
sys.check.miss-time:endtime | 不存在结束时间(节点) | 检查输入 |
sys.check.starttime-value:null | 开始时间为空(值) | 检查输入 |
sys.check.endtime-value:null | 结束时间为空(值) | 检查输入 |
sys.check.starttime-format:error | 校验开始时间不合法,格式yyyy-MM-dd HH:mm:ss | 检查时间格式 |
sys.check.endtime-format:error | 校验结束时间不合法,格式yyyy-MM-dd HH:mm:ss | 检查时间格式 |
sys.check.query-time:error | 开始时间是否小于结束时间 | 检查开始和结束时间大小 |
sys.check.query-time:outofrange | 时间查询是否超出指定范围 | 检查时间范围 |
sys.check.app-sign:null | 签名信息为空 | 检查签名信息 |
sys.check.app-sign:error | 签名信息错误 | 检查签名信息 |
sys.check.missing-parameter:apiversion | API版本号未指定 | 检查API版本号 |
sys.check.missing-parameter:appRequestTime | 请求时间丢失 | 检查请求时间 |
sys.check.missing-nestElement:sn_body | 缺少sn_body节点 | 检查sn_body是否存在 |
sys.check.user-permission:inexistence | 用户key不存在 | 检查用户key是否存在 |
biz.handler.batch-handler:no-support | 非查询类API不支持批量操作 | 检查API类型 |
biz.handler.request-message:error | 查询类API输入多个业务节点 | 检查业务节点 |
sys.check.header-param:null | header参数为空 | 请检查header参数 |
sys.controller.api-access:limit | 访问限制 | 无 |
sys.controller.api-frequency:limit | 访问频率限制 | 无 |
sys.error.network:failure | 网络异常 | 无 |
sys.error.network-status:? | 响应失败 ?为状态码 | 无 |
sys.check.snunionid.length.is.not:48 | 混淆会员编码长度不是48位 | 使用转换器转换混淆会员编码规定要求混淆会员编码48位 |