查看普通计划列表
名称 | 类型 | 是否必须 | 示例值 | 描述 |
---|---|---|---|---|
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 | 7777777 | 操作用户id |
name | String | N | jack | 用户名称 |
startDate | String | Y | 2020-05-06 | 推广开始日期 |
endDate | String | Y | 2020-05-06 | 推广结束日期 |
promotionType | String | Y | 2 | 商品推广类型 2:商品 4:店铺 5:一键 7:大聚惠 ,不在范围内默认查询2,4 |
status | String | Y | 0 | 推广计划状态 0:暂停 1:正常 ,-1不做状态校验不同于 PROMOTION_STATUS推广状态 |
orderBy | String | N | showNum | 排序字段 可为空,默认按更新时间倒序,可自己设置的排序字段如下:orderByFields.add(); |
pageNum | String | N | 1 | 当前页数 |
pagerSize | String | N | 10 | 每页条数 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
status | String | 0:成功,1:失败 | 状态 |
msg | String | 成功 | 状态说明 |
data | String | ||
accountUserId | String | 扣费用户id | |
agentType | String | 0、无代理;1、代理商;2、代运营 | 代理类型 |
allDealAmount | String | 0 | 0 |
allDealOrder | String | 0 | 0 |
allSubmitAmount | String | 0 | 0 |
allSubmitOrder | String | 0 | 0 |
avgClickCost | String | 0 | 平均点击消费 |
budget | String | 11 | 推广计划日预算 |
clickNum | String | 0 | 点击率 |
clickPercent | String | 0 | 点击率 |
companyCode | String | 公司编码 | |
cpcDayAmount | String | null | |
createDate | String | 创建日期 | |
createDateStr | String | 创建日期字符串 | |
dayCost | String | 0 | 0 |
dealROI | String | 0 | 0 |
endDate | String | 1589904000000 | 结束日期时间戳 |
endDateStr | String | 2020-05-20 | 结束日期时间字符串 |
isactive | String | 0 是,1 否 | 推广计划是否删除 |
name | String | 智能词包_YW | 计划名称 |
operateUserId | String | 操作者id | 操作者id |
productUserId | String | 广告主id | 广告主id |
promotionId | String | 40053702 | 计划id |
promotionStatus | String | 0:暂停推广余额不足, 1:正常 | 推广状态 |
promotionType | String | 2:商品 4:店铺 5:一键 7:大聚惠 | 商品推广类型 |
recommendBaseBid | String | 一键优选推荐坑位基础出价 | |
searchBaseBid | String | 一键优选搜索坑位基础出价 | |
showNum | String | 0 | 展示量 |
startDate | String | 1588089600000 | 开始日期 |
startDateStr | String | 2020-04-29 | 开始日期字符串 |
status | String | 2 | 状态 |
statusUpdateTime | String | 状态更新时间 | |
statusUpdateTimeStr | String | 状态更新时间字符串 | |
submitROI | String | 0 | 0 |
throwArea | String | 86 | 投放地域 |
throwControl | String | 投放平台 | |
throwRebate | String | 100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100 | 100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100 |
throwTime | String | 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 | 投放时段 |
updateDate | String | 1588142490000 | 更新日期时间戳 |
updateDateStr | String | 2020/4/29 14:41:30 | 更新日期字符串 |
userId | String | 查询用户IDnull | |
userLimitAmount | String | 推广计划日预算 |
<sn_request> <sn_body> <queryGetpromotionlist> <promotionType>2</promotionType> <endDate>2020-05-06</endDate> <name>jack</name> <custnum>7777777</custnum> <orderBy>showNum</orderBy> <pageNum>1</pageNum> <startDate>2020-05-06</startDate> <status>0</status> <pagerSize>10</pagerSize> </queryGetpromotionlist> </sn_body> </sn_request>
{ "sn_request": { "sn_body": { "queryGetpromotionlist": { "promotionType": "2", "endDate": "2020-05-06", "name": "jack", "custnum": "7777777", "orderBy": "showNum", "pageNum": "1", "startDate": "2020-05-06", "status": "0", "pagerSize": "10" } } } }
<sn_responseContent> <sn_body> <queryGetpromotionlist> <msg>成功</msg> <data> <allDealOrder>0</allDealOrder> <searchBaseBid>null</searchBaseBid> <updateDate>1588142490000</updateDate> <agentType>0、无代理;1、代理商;2、代运营</agentType> <allDealAmount>0</allDealAmount> <userLimitAmount>null</userLimitAmount> <endDate>1589904000000</endDate> <cpcDayAmount>null</cpcDayAmount> <updateDateStr>2020/4/29 14:41:30</updateDateStr> <isactive>0 是,1 否</isactive> <recommendBaseBid>null</recommendBaseBid> <throwArea>86</throwArea> <promotionId>40053702</promotionId> <allSubmitOrder>0</allSubmitOrder> <promotionStatus>0:暂停推广余额不足, 1:正常</promotionStatus> <dealROI>0</dealROI> <avgClickCost>0</avgClickCost> <productUserId>广告主id</productUserId> <submitROI>0</submitROI> <clickNum>0</clickNum> <endDateStr>2020-05-20</endDateStr> <accountUserId>null</accountUserId> <budget>11</budget> <createDate>null</createDate> <companyCode>null</companyCode> <promotionType>2:商品 4:店铺 5:一键 7:大聚惠</promotionType> <startDateStr>2020-04-29</startDateStr> <createDateStr>null</createDateStr> <throwRebate>100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100</throwRebate> <userId>null</userId> <statusUpdateTimeStr>null</statusUpdateTimeStr> <showNum>0</showNum> <throwTime>0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23</throwTime> <throwControl>null</throwControl> <allSubmitAmount>0</allSubmitAmount> <dayCost>0</dayCost> <name>智能词包_YW</name> <operateUserId>操作者id</operateUserId> <clickPercent>0</clickPercent> <startDate>1588089600000</startDate> <statusUpdateTime>null</statusUpdateTime> <status>2</status> </data> <status>0:成功,1:失败</status> </queryGetpromotionlist> </sn_body> </sn_responseContent>
{ "sn_responseContent": { "sn_body": { "queryGetpromotionlist": { "msg": "成功", "data": [ { "allDealOrder": "0", "searchBaseBid": "null", "updateDate": "1588142490000", "agentType": "0、无代理;1、代理商;2、代运营", "allDealAmount": "0", "userLimitAmount": "null", "endDate": "1589904000000", "cpcDayAmount": "null", "updateDateStr": "2020/4/29 14:41:30", "isactive": "0 是,1 否", "recommendBaseBid": "null", "throwArea": "86", "promotionId": "40053702", "allSubmitOrder": "0", "promotionStatus": "0:暂停推广余额不足, 1:正常", "dealROI": "0", "avgClickCost": "0", "productUserId": "广告主id", "submitROI": "0", "clickNum": "0", "endDateStr": "2020-05-20", "accountUserId": "null", "budget": "11", "createDate": "null", "companyCode": "null", "promotionType": "2:商品 4:店铺 5:一键 7:大聚惠", "startDateStr": "2020-04-29", "createDateStr": "null", "throwRebate": "100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100,100", "userId": "null", "statusUpdateTimeStr": "null", "showNum": "0", "throwTime": "0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23", "throwControl": "null", "allSubmitAmount": "0", "dayCost": "0", "name": "智能词包_YW", "operateUserId": "操作者id", "clickPercent": "0", "startDate": "1588089600000", "statusUpdateTime": "null", "status": "2" } ], "status": "0:成功,1:失败" } } } }
异常码 | 错误描述 | 解决方案 |
---|---|---|
biz.advertise.querygetpromotionlist.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位 |