口碑商户经营数据查询接口
环境 | HTTPS请求地址 |
---|---|
正式环境 | https://openapi.alipay.com/gateway.do |
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
app_id | String | 是 | 32 | 支付宝分配给开发者的应用ID | 2014072300007148 |
method | String | 是 | 128 | 接口名称 | koubei.marketing.data.indicator.query |
format | String | 否 | 40 | 仅支持JSON | JSON |
charset | String | 是 | 10 | 请求使用的编码格式,如utf-8,gbk,gb2312等 | utf-8 |
sign_type | String | 是 | 10 | 商户生成签名字符串所使用的签名算法类型,目前支持RSA2和RSA,推荐使用RSA2 | RSA2 |
sign | String | 是 | 256 | 商户请求参数的签名串,详见签名 | 详见示例 |
timestamp | String | 是 | 19 | 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" | 2014-07-24 03:07:50 |
version | String | 是 | 3 | 调用的接口版本,固定为:1.0 | 1.0 |
app_auth_token | String | 否 | 40 | 详见应用授权概述 | |
biz_content | String | 是 | - | 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档 |
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
begin_date | String | 必须 | 8 | 开始日期,格式:yyyyMMdd | 20160616 |
end_date | String | 必须 | 8 | 结束日期 格式:yyyyMMdd | 20160616 |
page_num | String | 可选 | 10 | 当前页数,默认为1 | 1 |
page_size | String | 可选 | 2 | 每页记录数,不能超过50,默认为20 | 20 |
biz_type | String | 必须 | 100 | 业务类型,可选值有六个
1,MemberQuery 商户会员数据查询 2,MemberQueryByStore 门店会员数据查询 3,TradeQuery 商户交易数据查询 4,TradeQueryByStore 门店交易数据查询 5,CampaignQuery 商户活动数据查询 6,CampaignQueryByStore 门店活动数据查询 |
MemberQuery |
ext_info | String | 可选 | 1024 | camp_id:为活动ID
sort_field:为排序指标KEY sort_type:ASC表示升序,DESC表示降序 store_Ids:为门店ID,多个门店使用逗号分隔 |
{"camp_id":"10000000000000000000000000000000","sort_field":"total_user_cnt","sort_type":"ASC","store_Ids":"20131133131,2031313"} |
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
code | String | 是 | - | 网关返回码,详见文档 | 40004 |
msg | String | 是 | - | 网关返回码描述,详见文档 | Business Failed |
sub_code | String | 否 | - | 业务返回码,详见文档 | ACQ.TRADE_HAS_SUCCESS |
sub_msg | String | 否 | - | 业务返回码描述,详见文档 | 交易已被支付 |
sign | String | 是 | - | 签名,详见文档 | DZXh8eeTuAHoYE3w1J+POiPhfDxOYBfUNn1lkeT/V7P4zJdyojWEa6IZs6Hz0yDW5Cp/viufUb5I0/V5WENS3OYR8zRedqo6D+fUTdLHdc+EFyCkiQhBxIzgngPdPdfp1PIS7BdhhzrsZHbRqb7o4k3Dxc+AAnFauu4V6Zdwczo= |
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
total_size | String | 必填 | 10 | 总条目数,供计算分页信息使用 | 100 |
indicator_infos | String | 必填 | 65535 | JSON格式数组,每个对象表示一个门店某个具体日期的指标信息,KEY为指标代码,VALUE为该指标对应的值,各biz_type入参以及返回值的详细信息参见快速接入 | [{"today_new_user_cnt":"1","store_id":"201121"},{"today_new_user_cnt":"1","store_id":"201122"}] |
AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2"); KoubeiMarketingDataIndicatorQueryRequest request = new KoubeiMarketingDataIndicatorQueryRequest(); request.setBizContent("{" + "\"begin_date\":\"20160616\"," + "\"end_date\":\"20160616\"," + "\"page_num\":\"1\"," + "\"page_size\":\"20\"," + "\"biz_type\":\"MemberQuery\"," + "\"ext_info\":\"{\\\"camp_id\\\":\\\"10000000000000000000000000000000\\\",\\\"sort_field\\\":\\\"total_user_cnt\\\",\\\"sort_type\\\":\\\"ASC\\\",\\\"store_Ids\\\":\\\"20131133131,2031313\\\"}\"" + " }"); KoubeiMarketingDataIndicatorQueryResponse response = alipayClient.execute(request); if(response.isSuccess()){ System.out.println("调用成功"); } else { System.out.println("调用失败"); }
{ "sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE", "koubei_marketing_data_indicator_query_response":{ "msg":"Success", "code":"10000", "total_size":"100", "indicator_infos":"[{\"today_new_user_cnt\":\"1\",\"store_id\":\"201121\"},{\"today_new_user_cnt\":\"1\",\"store_id\":\"201122\"}]" } }
{ "sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE", "koubei_marketing_data_indicator_query_response":{ "msg":"Service Currently Unavailable", "code":"20000", "sub_msg":"系统繁忙", "sub_code":"isp.unknow-error" } }
错误码 | 错误描述 | 解决方案 |
---|---|---|
SYSTEM_ERROR | 系统繁忙 | 系统异常,稍后重试 |
ACTIVITY_INDICATOR_QUERY_FAIL | 参数门店id个数超过最大限制 | 调整参数,重试 |
ACTIVITY_INDICATOR_QUERY_FAIL | 参数开始日期和结束日期间隔超过最大限制 | 调整参数,重试 |
ACTIVITY_INDICATOR_QUERY_FAIL | 参数页数或每页大小非法 | 调整参数,重试 |
ACTIVITY_INDICATOR_QUERY_FAIL | 参数orderBy和orderType必须同时存在或不存在 | 调整参数,重试 |
ACTIVITY_INDICATOR_QUERY_FAIL | 参数orderType只能为ASC或DESC | 调整参数,重试 |
ACTIVITY_INDICATOR_QUERY_FAIL | 参数排序指标暂不支持 | 调整参数,重试 |
SYSTEM_ERROR | 系统繁忙 | 稍后重试 |
INVALID_PARAMETER | 参数有误。 | 调整参数后重试 |
EXCEED_TIME_LIMIT | 查询日期超出限制 | 修改日期重试 |
REQ_VALIDATE_ERROR | 参数非法 | 检查bizType,ext_info中的KEY等信息是否合法,修改后重试 |
CAMPAIGN_NOT_EXIST | 活动不存在 | 修改活动ID重试 |
REPORT_QUERY_DATA_NOT_EXIST | 活动尚未启动,无法查询报表信息 | 等活动启动后重试 |
NO_DATA_PERMISSION | 无数据权限 | 可能是由于使用了不属于当前商户的活动ID,造成无数据权限,核实调整活动ID参数后重试 |