淘宝开放平台

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
target_app_key	String	否	被调用的目标AppKey，仅当被调用的API为第三方ISV提供时有效。
sign_method	String	是	签名的摘要算法，可选值为：hmac，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
partner_id	String	否	合作伙伴身份标识。
simplify	Boolean	否	是否采用精简JSON返回格式，仅当format=json时有效，默认值为：false。

名称	类型	是否必须	示例值	更多限制	描述
event_id	Number	必须	1		活动id

名称	类型	示例值	描述
result	RpcResult		结果数据
data CpaReportDto 结果数据 └ the_date String 数据更新时间 └ settle_total String 结算维度奖励总金额 └ pre_total String 预估维度奖励总金额 campaign_reportdto_list Campaignreportdtolist [] 结果数据 └ campaign_code String 策略名称 └ settle_fee String 该策略下结算金额 └ pre_fee String 该策略下预估金额 result_list Resultlist [] 结果数据 └ pre String 预估明细 └ settle String 结算明细 display_list Displaylist [] 字段说明 └ field_name String 字段名称 └ display_name String 展现名称 └ desc String 字段描述 └ success Boolean 执行结果 └ result_code Number 结果code └ biz_error_desc String 业务错误描述 └ result_msg String 异常错误的详细原因 └ biz_error_code Number 业务错误代码

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TbkDgCpaReportDetailRequest req = new TbkDgCpaReportDetailRequest();
req.setEventId(1L);
TbkDgCpaReportDetailResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TbkDgCpaReportDetailRequest req = new TbkDgCpaReportDetailRequest();
req.EventId = 1L;
TbkDgCpaReportDetailResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TbkDgCpaReportDetailRequest;
$req->setEventId("1");
$resp = $c->execute($req);

curl -X POST 'http://gw.api.taobao.com/router/rest' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'app_key=12129701' \
-d 'format=json' \
-d 'method=taobao.tbk.dg.cpa.report.detail' \
-d 'partner_id=apidoc' \
-d 'sign=8ED429FE6552522BA0F1ACC75B3429DC' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-05-04+16%3A01%3A24' \
-d 'v=2.0' \
-d 'event_id=1'

# -*- coding: utf-8 -*-
import top.api

req=top.api.TbkDgCpaReportDetailRequest(url,port)
req.set_app_info(top.appinfo(appkey,secret))

req.event_id=1
try:
	resp= req.getResponse()
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"taobao.tbk.dg.cpa.report.detail");
add_param(pRequest,"event_id","1");
pResponse = top_execute(pClient,pRequest,NULL);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('taobao.tbk.dg.cpa.report.detail', {
	'event_id':'1'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<tbk_dg_cpa_report_detail_response>
    <result>
        <data>
            <the_date></the_date>
            <settle_total></settle_total>
            <pre_total></pre_total>
            <campaign_reportdto_list>
                <campaignreportdtolist>
                    <campaign_code></campaign_code>
                    <settle_fee></settle_fee>
                    <pre_fee></pre_fee>
                    <result_list>
                        <resultlist>
                            <pre></pre>
                            <settle></settle>
                        </resultlist>
                    </result_list>
                    <display_list>
                        <displaylist>
                            <field_name></field_name>
                            <display_name></display_name>
                            <desc></desc>
                        </displaylist>
                    </display_list>
                </campaignreportdtolist>
            </campaign_reportdto_list>
        </data>
        <success></success>
        <result_code></result_code>
        <biz_error_desc></biz_error_desc>
        <result_msg></result_msg>
        <biz_error_code></biz_error_code>
    </result>
</tbk_dg_cpa_report_detail_response>

{
    "tbk_dg_cpa_report_detail_response":{
        "result":{
            "data":{
                "the_date":"",
                "settle_total":"",
                "pre_total":"",
                "campaign_reportdto_list":{
                    "campaignreportdtolist":[
                        {
                            "campaign_code":"",
                            "settle_fee":"",
                            "pre_fee":"",
                            "result_list":{
                                "resultlist":[
                                    {
                                        "pre":"",
                                        "settle":""
                                    }
                                ]
                            },
                            "display_list":{
                                "displaylist":[
                                    {
                                        "field_name":"",
                                        "display_name":"",
                                        "desc":""
                                    }
                                ]
                            }
                        }
                    ]
                }
            },
            "success":,
            "result_code":,
            "biz_error_desc":"",
            "result_msg":"",
            "biz_error_code":
        }
    }
}

XML示例
JSON示例

<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

{
	"error_response":{
		"msg":"Remote service error",
		"code":50,
		"sub_msg":"非法参数",
		"sub_code":"isv.invalid-parameter"
	}
}

错误码	错误描述	解决方案

API测试工具错误码查询工具 SDK下载

淘宝客API

taobao.tbk.dg.cpa.report.detail (淘宝客-推广者-渠道管理组团汇总数据)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ