文档中心 > 开放平台

开放平台

自定义报表快速接入

更新时间：2017/06/08 访问次数：27716

该文档主要面向需要入驻蚂蚁金服开放平台的产品、架构、开发等相关人员， 需要有基本的程序开发背景。通过该文档能够快速集成（自定义报表）功能，接入前需要入驻开放平台并创建了应用，应用已申请该接口权限并配置RSA密钥。

第一步：创建应用并获取APPID

要在您的应用中使用支付宝开放产品的接口能力，您需要先去蚂蚁金服开放平台（open.alipay.com），在开发者中心创建登记您的应用，并提交审核，审核通过后会为您生成应用唯一标识（APPID），并且可以申请开通开放产品使用权限，通过APPID您的应用才能调用开放产品的接口能力。需要详细了解开放平台创建应用步骤请参考《开放平台应用创建指南》。

第二步：配置密钥

开发者调用接口前需要先生成RSA密钥，RSA密钥包含应用私钥(APP_PRIVATE_KEY)、应用公钥(APP_PUBLIC_KEY）。生成密钥后在开放平台开发者中心进行密钥配置，配置完成后可以获取支付宝公钥(ALIPAY_PUBLIC_KEY)。详情请参考《配置应用环境》。

第三步：搭建和配置开发环境

1. 下载服务端SDK

为了帮助开发者调用开放接口，我们提供了开放平台服务端SDK，包含JAVA、PHP和.NET三个语言版本，封装了签名&验签、HTTP接口请求等基础功能。请先下载对应语言版本的SDK并引入您的开发工程。

各语言版本服务端SDK详细使用说明，请参考《服务端SDK说明》

2. 接口调用配置

在SDK调用前需要进行初始化，以Java代码为示例如下：

AlipayClient alipayClient = new DefaultAlipayClient(URL, APP_ID, APP_PRIVATE_KEY, FORMAT, CHARSET, ALIPAY_PUBLIC_KEY, SIGN_TYPE);

关键参数说明:

配置参数 示例值解释 获取方式/示例值
URL 支付宝网关（固定） https://openapi.alipay.com/gateway.do
APPID APPID 即创建应用后生成 获取见上面创建应用并获取APPID
APP_PRIVATE_KEY 开发者私钥，由开发者自己生成 获取详见上面配置密钥
FORMAT 参数返回格式，只支持json json（固定）
CHARSET 编码集，支持GBK/UTF-8 开发者根据实际工程编码配置
ALIPAY_PUBLIC_KEY 支付宝公钥，由支付宝生成 获取详见上面配置密钥
SIGN_TYPE 商户生成签名字符串所使用的签名算法类型，目前支持RSA2和RSA，推荐使用RSA2 RSA2

第四步：调用接口

自定义报表包含5个接口，其中：

配置自定义报表功能：

接口中文名 接口英文名 接口描述

自定义数据报表创建及更新接口

 koubei.marketing.data.customreport.save

自定义报表规则创建及更新接口

自定义数据报表删除接口

  koubei.marketing.data.customreport.delete

自定义报表规则删除接口

自定义数据报表列表分页查询接口

  koubei.marketing.data.customreport.batchquery

自定义报表规则列表分页查询接口

自定义数据报表规则详情查询接口

  koubei.marketing.data.customreport.detail.query

自定义报表规则详情查询接口

 

查询自定义报表数据功能：

接口中文名 接口英文名 接口描述

自定义数据报表数据查询接口

 koubei.marketing.data.customreport.query

 自定义报表数据查询接口

接口调用示例大致分为3步：

  1. 拼装业务参数
  2. 将参数发送给开放平台服务端
  3. 获取开放平台服务端返回值，并进行具体业务处理

1. 自定义报表规则创建及更新

 

接口代码调用示例：

/**
 * 自定义报表规则保存，包括创建和修改
 */
public static String testSave() throws Exception {		
    AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do", APP_ID, APP_PRIVATE_KEY, "json", CHARSET, ALIPAY_PUBLIC_KEY, "RSA2");
    KoubeiMarketingDataCustomreportSaveRequest request = new KoubeiMarketingDataCustomreportSaveRequest();
    KoubeiMarketingDataCustomreportSaveResponse response = new KoubeiMarketingDataCustomreportSaveResponse();
    request.setBizContent("{" +
		"    \"report_condition_info\":{" +
		"    \"condition_key\":\"20000131311113\"," +
		"    \"name\":\"最近三天会员信息报表\"," +
		"    \"memo\":\"该报表可统计最近三天的会员信息\"," +
		"    \"data_tags\":[{" +
		"    \"code\":\"orpt_umct_trade_cnt\"," +
		"    \"aggregate\":\"SUM\"," +
		"    \"alias\":\"trade\"" +
		"    }]," +
		"    \"group_tags\":\"[\\\"orpt_ubase_age\\\",\\\"orpt_ubase_birthday_mm\\\"]\"," +
		"    \"sort_tags\":\"[{\\\"code\\\":\\\"orpt_ubase_age\\\",\\\"sortBy\\\":\\\"DESC\\\"}]\"," +
		"    \"filter_tags\":[{" +
		"    \"code\":\"orpt_ubase_age\"," +
		"    \"filter_items\":\"[{\\\"operate\\\": \\\"EQ\\\",\\\"value\\\": \\\"1\\\" }]\"" +
		"    }]" +
		"    }" +
		"    }"); 
    response = alipayClient.execute(request); 
    System.out.println(response.getBody()); // 开发者根据返回结果处理业务
    String conditionKey = response.getConditionKey();
    return conditionKey; 
}

2. 自定义报表规则删除

接口代码调用示例：

/**
 * 自定义报表规则删除
 *
 * @throws Exception
 */
public static void testDelete() throws Exception {
    AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do", APP_ID, APP_PRIVATE_KEY, "json", CHARSET, ALIPAY_PUBLIC_KEY, "RSA2"); 
    String conditionKey = testSave();  //请参考自定义报表规则创建及更新返回的conditionKey
    System.out.println("conditionKey=" + conditionKey);
    KoubeiMarketingDataCustomreportDeleteRequest request = new KoubeiMarketingDataCustomreportDeleteRequest();
    request.setBizContent("{\"condition_key\":\"" + conditionKey + "\"}");
    KoubeiMarketingDataCustomreportDeleteResponse response = alipayClient.execute(request);
    System.out.println("response.subCode=" + response.getSubCode());
    System.out.println("response.subMsg=" + response.getSubMsg());
    System.out.println("response.isSuccess=" + response.isSuccess());
    System.out.println("response.code=" + response.getCode());
    System.out.println("response.msg=" + response.getMsg());
}

3. 自定义报表规则列表分页查询

接口代码调用示例：

/**
  * 批量查询自定义报表规则
  *
  * @throws Exception
  */
public static void testBatchQuery() throws Exception {
    AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do", APP_ID, APP_PRIVATE_KEY, "json", CHARSET, ALIPAY_PUBLIC_KEY, "RSA2");
    KoubeiMarketingDataCustomreportBatchqueryRequest request = new KoubeiMarketingDataCustomreportBatchqueryRequest();
    KoubeiMarketingDataCustomreportBatchqueryResponse response = new KoubeiMarketingDataCustomreportBatchqueryResponse();
    request.setBizContent("{ \"page_no\":\"1\",\"page_size\":\"1\"}");
    response = alipayClient.execute(request);
    System.out.println(response.getBody());
    List customReportConditionList = response.getReportConditionList();
//请根据返回处理业务 
}

4. 自定义报表规则详情查询

接口代码调用示例：

/**
 * 查询自定义报表规则详情
 *
 * @throws Exception
 */
public static void testQueryDetail() throws Exception {
    AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do", APP_ID, APP_PRIVATE_KEY, "json", CHARSET, ALIPAY_PUBLIC_KEY, "RSA2"); 
    KoubeiMarketingDataCustomreportDetailQueryRequest request = new KoubeiMarketingDataCustomreportDetailQueryRequest();
    request.setBizContent("{\"condition_key\":\"QK160708t2x7547s\"}");
    KoubeiMarketingDataCustomreportDetailQueryResponse response = alipayClient.execute(request);
    CustomReportCondition customReportCondition = response.getReportConditionInfo();
    //打印自定义报表规则明细信息
    System.out.println(response.getBody());
}

5. 自定义报表数据查询

接口代码调用示例：

/**
 * 报表查询
 *
 * @return
 * @throws Exception
 */
public static void testQuery() throws Exception { 
    AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do", APP_ID, APP_PRIVATE_KEY, "json", CHARSET, ALIPAY_PUBLIC_KEY, "RSA2");
    KoubeiMarketingDataCustomreportQueryRequest request = new KoubeiMarketingDataCustomreportQueryRequest();
    request.setBizContent("{" +
        "    \"condition_key\":\"200000081\"," +
        "      \"filter_tags\":[{" +
        "                \"code\":\"orpt_ubase_age\"," +
        "        \"filter_items\":\"[{\\\"operate\\\": \\\"EQ\\\",\\\"value\\\": \\\"1\\\" }]\"" +
        "        }]," +
        "    \"max_count\":\"50\"" +
        "  }");
    KoubeiMarketingDataCustomreportQueryResponse response = alipayClient.execute(request);
    System.out.println(response.getBody());
}

可用标签信息

可用标签信息参见附件。

聚合方式aggregate参数详细说明

code 描述

NONE

无聚合

COUNT

计数

COUNT_DISTINCT

去重计数

DISTINCT

去重

MIN

最小值

MAX

最大值

SUM

求和

过滤条件filter_items参数中operate详细说明

code 描述 映射的操作

EQ

相等

=

GT

大于

> 

GTEQ

大于等于

>=

LT

小于

< 

LTEQ

小于等于

<=

NEQ

不等

!=

LIKE

模糊匹配

like

IN

在枚举范围内

in

NOTIN

不在枚举范围内

not in

BETWEEN

范围比较

between

LEFTDAYS

几天以内

leftdays

RIGHTDAYS

几天以外

rightdays

LOCATE

地理位置比较

 

LBS

地图位置数据

 

接口调用结果码说明

同步返回结果码 含义 说明

10000

 业务处理成功  
40001～40006 业务处理失败 具体失败原因请参考公共错误码。其它请参考API文档。
20000 业务出现未知错误或者系统异常 业务出现未知错误或者系统异常(请一定在确定本次调用结果后，发起重试)，可调用查询接口发起查询确定结果。

关于沙箱

如何接入沙箱

      沙箱是开放平台提供给开发者用户调试接口的环境，具体操作步骤见 沙箱接入指南。

自定义报表接入注意点

      1、自定义报表支持沙箱接入；在沙箱调通接口后，必须在线上进行测试与验收，所有返回码及业务逻辑以线上为准；
      2、自定义报表所有接口，当前沙箱返回的均为固定的模拟数据，仅供接口联通调试使用。

FAQ

关于此文档暂时还没有FAQ
有用(12) 我要提问
返回
顶部
阿里巴巴集团 | 淘宝网 | 天猫 | 聚划算 | 全球速卖通 | 阿里巴巴国际交易市场 | 1688 | 阿里妈妈 | 阿里旅行·去啊 | 阿里云计算 | YunOS | 阿里通信 | 万网 | 高德 | 优视 | 友盟 | 酷盘 | 虾米 | 天天动听 | 来往 | 钉钉 | 11Main | 支付宝
关于淘宝 合作伙伴 营销中心 联系客服 开放平台 诚征英才 联系我们 网站地图 法律声明 © 2016 Taobao.com 版权所有
网络文化经营许可证：文网文[2010]040号 | 增值电信业务经营许可证：浙B2-20080224-1 | 信息网络传播视听节目许可证：1109364号