alipay.open.public.menu.data.batchquery(菜单分析数据查询接口) 在线调试(沙箱环境)

开发者可以根据本接口查询30天内菜单的相关数据,包括菜单点击人数和次数

公共参数

请求地址

环境HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do

公共请求参数

参数 类型 是否必填最大长度描述示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.open.public.menu.data.batchquery
format String 40 仅支持JSON JSON
charset String 10 请求使用的编码格式,如utf-8,gbk,gb2312等 utf-8
sign_type String 10 商户生成签名字符串所使用的签名算法类型,目前支持RSA2和RSA,推荐使用RSA2 RSA2
sign String 344 商户请求参数的签名串,详见签名 详见示例
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 开始日期 20171101
end_date String 必选 8 结束日期,开始日期/结束日期时间跨度最大30天 20171108

响应参数

参数 类型 是否必填 最大长度 描述 示例值
data_list MenuAnalysisData 选填 菜单分析数据列表
date String 必填 8 日期 20171101
name String 必填 100 菜单名称 菜单
sub_name String 可选 100 子菜单名称,文字菜单才有 子菜单
menu_type String 必填 20 菜单类型 ,iconDefault :图标菜单、default:文字菜单 default
click_cnt Number 必填 100 菜单点击次数 10
click_user_cnt Number 必填 100 菜单点击人数 20
avg_click_user_cnt Number 必填 100 人均点击次数 10.25

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayOpenPublicMenuDataBatchqueryRequest request = new AlipayOpenPublicMenuDataBatchqueryRequest();
request.setBizContent("{" +
"\"begin_date\":\"20171101\"," +
"\"end_date\":\"20171108\"" +
"  }");
AlipayOpenPublicMenuDataBatchqueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "alipay_open_public_menu_data_batchquery_response": {
        "code": "10000",
        "msg": "Success",
        "data_list": [
            {
                "date": "20171101",
                "name": "菜单",
                "sub_name": "子菜单",
                "menu_type": "default",
                "click_cnt": 10,
                "click_user_cnt": 20,
                "avg_click_user_cnt": 10.25
            }
        ]
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

{
    "alipay_open_public_menu_data_batchquery_response": {
        "code": "20000",
        "msg": "Service Currently Unavailable",
        "sub_code": "isp.unknow-error",
        "sub_msg": "系统繁忙"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

业务错误码

公共错误码

错误码错误描述解决方案
ILLEGAL_BIZ_PARAMS 无效的业务参数 检查业务参数是否合法
SYSTEM_ERROR 系统繁忙 请检查输入参数是否正确,或者稍后重试
BUSINESS_ERROR 系统业务处理错误 请检查输入参数是否正确,或者稍后重试
QUERY_DATE_INVALID 查询时间参数不合法 请检查开始日期、结束日期是否合法,是否超过最大30天的跨度
onlineServer