开放服务-API列表

热词搜索：

suning.advertise.getkeywordrepbypagebyday.query 查询关键词分日报表

￥增值

查询关键词分日报表

公共参数

名称	类型	是否必须	示例值	描述
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	不传默认 0	操作用户id
promotionId	String	Y	推广计划ID	推广计划ID
promotionUnitId	String	Y	推广计划单元ID	推广计划单元ID
startDate	String	Y	2020-09-21	开始时间
endDate	String	Y	2020-09-21	结束时间
dayType	String	N	_3day	订单统计范围范围：_3day.3天，_7day.7天，_15day.15天
orderBy	String	N	showNum	排序字段可为空，默认按更新时间倒序，可自己设置的排序字段如下：orderByFields.add(showNum);
pagerNumber	String	Y	1	当前页数
pagerSize	String	Y	11	每页条数
keyword	String	Y	关键词名称	关键词名称
promotionName	String	N	推广计划名称	推广计划名称
goodsName	String	N	商品名称	商品名称

响应参数

名称	类型	示例值	描述
status	String	0	状态 0：失败，1：成功
msg	String	成功	状态说明
data	String
pagerNumber	String	推广计划名称	推广计划名称
totalCount	String	2	条目数
dataList	String
avgCost	String	0.01	平均点击成本
clickNum	String	100	点击量
clickRate	String	100.00%	点击率
clickRateSort	String	100	点击率百分比数值
cost	String	1	花费
directDealAmount	String	1	直接成交金额
directDealNum	String	111	直接成交量
directSubmitAmount	String	1.11	直接下单金额
directSubmitOrder	String	100	直接下单量
goodsName	String	巴宝莉修改test1001(Burberry1001)	商品名称
indirectDealAmount	String	1	间接成交金额
indirectDealOrder	String	111	间接成交订单数量
indirectSubmitAmount	String	1	间接下单金额
indirectSubmitOrder	String	111	间接下单量
keyword	String	smartwp_default_keyword	关键词
promotionDate	String	2020-05-07	推广日期
promotionId	String	50000169	推广计划ID
promotionName	String	智能词包报表测试	推广计划名称
promotionUnitId	String	8880001000002155	计划单元ID
roi	String	0.50	下单ROI
showNum	String	100	展现量
throwSource	String	全部	投放终端
totalDealAmount	String	2	总成交金额
totalSubmitAmount	String	1.11	总下单金额
overViewData	String
avgCost	String	0.01	平均点击成本
clickNum	String	100	点击量
clickRate	String	100.00%	点击率
cost	String	1	花费
directDealAmount	String	1	直接成交金额
directDealNum	String	111	直接成交量
directSubmitAmount	String	1.11	直接下单金额
directSubmitOrder	String	100	直接下单量
goodsName	String	商品名称	商品名称
indirectDealAmount	String	1	间接成交金额
indirectDealOrder	String	100	间接成交订单数量
indirectSubmitAmount	String	1	间接下单金额
indirectSubmitOrder	String	111	间接下单量
keyword	String	关键词	关键词
promotionDate	String	2020-02-02	推广日期
promotionId	String	1245	推广计划ID
promotionName	String	推广计划名称	推广计划名称
promotionUnitId	String	1254625	计划单元ID
roi	String	2.11	下单ROI
showNum	String	100	展现量
throwSource	String	全部	投放终端
totalDealAmount	String	2	总成交金额
totalSubmitAmount	String	1.11	总下单金额

请求示例

XML示例
JSON示例

复制全部代码

                                
<sn_request>
  <sn_body>
    <queryGetkeywordrepbypagebyday>
      <dayType>_3day</dayType>
      <promotionUnitId>推广计划单元ID</promotionUnitId>
      <promotionName>推广计划名称</promotionName>
      <endDate>2020-09-21</endDate>
      <custnum>不传默认 0</custnum>
      <orderBy>showNum</orderBy>
      <pagerNumber>1</pagerNumber>
      <keyword>关键词名称</keyword>
      <goodsName>商品名称</goodsName>
      <promotionId>推广计划ID</promotionId>
      <startDate>2020-09-21</startDate>
      <pagerSize>11</pagerSize>
    </queryGetkeywordrepbypagebyday>
  </sn_body>
</sn_request>

                                
{
  "sn_request": {
    "sn_body": {
      "queryGetkeywordrepbypagebyday": {
        "dayType": "_3day",
        "promotionUnitId": "推广计划单元ID",
        "promotionName": "推广计划名称",
        "endDate": "2020-09-21",
        "custnum": "不传默认 0",
        "orderBy": "showNum",
        "pagerNumber": "1",
        "keyword": "关键词名称",
        "goodsName": "商品名称",
        "promotionId": "推广计划ID",
        "startDate": "2020-09-21",
        "pagerSize": "11"
      }
    }
  }
}

响应示例

XML示例
JSON示例

复制全部代码

                              
<sn_responseContent>
  <sn_body>
    <queryGetkeywordrepbypagebyday>
      <msg>成功</msg>
      <data>
        <dataList>
          <cost>1</cost>
          <directSubmitAmount> 1.11</directSubmitAmount>
          <promotionDate> 2020-05-07</promotionDate>
          <directSubmitOrder>100</directSubmitOrder>
          <indirectSubmitAmount>1</indirectSubmitAmount>
          <throwSource> 全部</throwSource>
          <roi>0.50</roi>
          <promotionId> 50000169</promotionId>
          <indirectSubmitOrder>111</indirectSubmitOrder>
          <promotionUnitId> 8880001000002155</promotionUnitId>
          <showNum>100</showNum>
          <promotionName> 智能词包报表测试</promotionName>
          <totalSubmitAmount>1.11</totalSubmitAmount>
          <clickRate> 100.00%</clickRate>
          <clickRateSort> 100</clickRateSort>
          <directDealNum>111</directDealNum>
          <clickNum> 100</clickNum>
          <directDealAmount>1</directDealAmount>
          <indirectDealAmount>1</indirectDealAmount>
          <avgCost> 0.01</avgCost>
          <indirectDealOrder>111</indirectDealOrder>
          <keyword> smartwp_default_keyword</keyword>
          <totalDealAmount>2</totalDealAmount>
          <goodsName> 巴宝莉修改test1001(Burberry1001)</goodsName>
        </dataList>
        <pagerNumber>推广计划名称</pagerNumber>
        <totalCount>2</totalCount>
        <overViewData>
          <cost>1</cost>
          <directSubmitAmount> 1.11</directSubmitAmount>
          <promotionDate>2020-02-02</promotionDate>
          <directSubmitOrder> 100</directSubmitOrder>
          <indirectSubmitAmount>1</indirectSubmitAmount>
          <throwSource> 全部</throwSource>
          <roi> 2.11</roi>
          <promotionId>1245</promotionId>
          <indirectSubmitOrder>111</indirectSubmitOrder>
          <promotionUnitId>1254625</promotionUnitId>
          <showNum> 100</showNum>
          <promotionName>推广计划名称</promotionName>
          <totalSubmitAmount> 1.11</totalSubmitAmount>
          <clickRate> 100.00%</clickRate>
          <directDealNum>111</directDealNum>
          <clickNum> 100</clickNum>
          <directDealAmount>1</directDealAmount>
          <indirectDealAmount>1</indirectDealAmount>
          <avgCost> 0.01</avgCost>
          <indirectDealOrder> 100</indirectDealOrder>
          <keyword>关键词</keyword>
          <totalDealAmount>2</totalDealAmount>
          <goodsName>商品名称</goodsName>
        </overViewData>
      </data>
      <status>0</status>
    </queryGetkeywordrepbypagebyday>
  </sn_body>
</sn_responseContent>

                              
{
  "sn_responseContent": {
    "sn_body": {
      "queryGetkeywordrepbypagebyday": {
        "msg": "成功",
        "data": [
          {
            "dataList": [
              {
                "cost": "1",
                "directSubmitAmount": " 1.11",
                "promotionDate": " 2020-05-07",
                "directSubmitOrder": "100",
                "indirectSubmitAmount": "1",
                "throwSource": " 全部",
                "roi": "0.50",
                "promotionId": " 50000169",
                "indirectSubmitOrder": "111",
                "promotionUnitId": " 8880001000002155",
                "showNum": "100",
                "promotionName": " 智能词包报表测试",
                "totalSubmitAmount": "1.11",
                "clickRate": " 100.00%",
                "clickRateSort": " 100",
                "directDealNum": "111",
                "clickNum": " 100",
                "directDealAmount": "1",
                "indirectDealAmount": "1",
                "avgCost": " 0.01",
                "indirectDealOrder": "111",
                "keyword": " smartwp_default_keyword",
                "totalDealAmount": "2",
                "goodsName": " 巴宝莉修改test1001(Burberry1001)"
              }
            ],
            "pagerNumber": "推广计划名称",
            "totalCount": "2",
            "overViewData": [
              {
                "cost": "1",
                "directSubmitAmount": " 1.11",
                "promotionDate": "2020-02-02",
                "directSubmitOrder": " 100",
                "indirectSubmitAmount": "1",
                "throwSource": " 全部",
                "roi": " 2.11",
                "promotionId": "1245",
                "indirectSubmitOrder": "111",
                "promotionUnitId": "1254625",
                "showNum": " 100",
                "promotionName": "推广计划名称",
                "totalSubmitAmount": " 1.11",
                "clickRate": " 100.00%",
                "directDealNum": "111",
                "clickNum": " 100",
                "directDealAmount": "1",
                "indirectDealAmount": "1",
                "avgCost": " 0.01",
                "indirectDealOrder": " 100",
                "keyword": "关键词",
                "totalDealAmount": "2",
                "goodsName": "商品名称"
              }
            ]
          }
        ],
        "status": "0"
      }
    }
  }
}

异常示例

XML示例
JSON示例

复制全部代码


  
  	API异常码
  	异常码中文描述

{
  "sn_responseContent": {
    "sn_error": {
      "error_code": "API异常码",
      "error_msg": "异常码中文描述"
    }
  }
}

业务异常码

异常码	错误描述	解决方案
biz.advertise.querygetkeywordrepbypagebyday.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位

API工具

API TOOLS 在线测试工具异常码查询工具 SDK调用示例 SDK下载

FAQ

广告业务