淘宝开放平台

请求地址：

环境	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。

名称	类型	是否必须	示例值	更多限制	描述
query_type	Number	可选	1	默认值：1	明细类型，1：预估明细，2：结算明细
page_size	Number	可选	10	默认值：10	每页条数
page_no	Number	可选	1	默认值：1	页码
event_id	Number	必须	111		CPA活动ID
indicator_alias	String	可选	abcde		CPA活动奖励的统计口径，相关说明见文档：https://www.yuque.com/docs/share/7ecf8cf1-7f99-4633-a2ed-f9b6f8116af5?#

名称	类型	示例值	描述
result	Result		接口返回model
└ biz_error_feature String demo 错误代码 data PageResult 1234 返回素材id results Results [] 数据结果 └ field_detail String 奖励明细数据，KV结构。字段释义见文档：https://www.yuque.com/docs/share/7ecf8cf1-7f99-4633-a2ed-f9b6f8116af5?# └ calc_type Number 1 明细类型，1：预估明细，2：结算明细 └ pre_page Number 1 上一页页码 └ next_page Number 1 下一页页码 └ page_no Number 1 当前页码 └ total_pages Number 1 总共页数 └ page_size Number 10 每页条数 └ has_next Boolean false 是否有下一页 └ total_count Number 4 总条数 └ has_pre Boolean false 是否有下一页 └ success Boolean true 是否成功 └ result_code Number 200 结果码 └ biz_error_desc String demo 错误描述 └ biz_error_code Number 0 错误代码 └ result_msg String demo 结果信息

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TbkScCpaActivityDetailRequest req = new TbkScCpaActivityDetailRequest();
req.setQueryType(1L);
req.setPageSize(10L);
req.setPageNo(1L);
req.setEventId(111L);
req.setIndicatorAlias("abcde");
TbkScCpaActivityDetailResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TbkScCpaActivityDetailRequest req = new TbkScCpaActivityDetailRequest();
req.QueryType = 1L;
req.PageSize = 10L;
req.PageNo = 1L;
req.EventId = 111L;
req.IndicatorAlias = "abcde";
TbkScCpaActivityDetailResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TbkScCpaActivityDetailRequest;
$req->setQueryType("1");
$req->setPageSize("10");
$req->setPageNo("1");
$req->setEventId("111");
$req->setIndicatorAlias("abcde");
$resp = $c->execute($req, $sessionKey);

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.sc.cpa.activity.detail' \
-d 'partner_id=apidoc' \
-d 'session=ecb5c437-0ce5-45c0-9411-1f2b270bbf25' \
-d 'sign=E0482298F39E8B34A38A4F156655FD44' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-01-16+00%3A47%3A36' \
-d 'v=2.0' \
-d 'event_id=111' \
-d 'indicator_alias=abcde' \
-d 'page_no=1' \
-d 'page_size=10' \
-d 'query_type=1'

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

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

req.query_type=1
req.page_size=10
req.page_no=1
req.event_id=111
req.indicator_alias="abcde"
try:
	resp= req.getResponse(sessionkey)
	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.sc.cpa.activity.detail");
add_param(pRequest,"query_type","1");
add_param(pRequest,"page_size","10");
add_param(pRequest,"page_no","1");
add_param(pRequest,"event_id","111");
add_param(pRequest,"indicator_alias","abcde");
pResponse = top_execute(pClient,pRequest,sessionKey);
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.sc.cpa.activity.detail', {
	'query_type':'1',
	'page_size':'10',
	'page_no':'1',
	'event_id':'111',
	'indicator_alias':'abcde'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<tbk_sc_cpa_activity_detail_response>
    <result>
        <biz_error_feature>demo</biz_error_feature>
        <data>
            <results>
                <results>
                    <field_detail></field_detail>
                    <calc_type>1</calc_type>
                </results>
            </results>
            <pre_page>1</pre_page>
            <next_page>1</next_page>
            <page_no>1</page_no>
            <total_pages>1</total_pages>
            <page_size>10</page_size>
            <has_next>false</has_next>
            <total_count>4</total_count>
            <has_pre>false</has_pre>
        </data>
        <success>true</success>
        <result_code>200</result_code>
        <biz_error_desc>demo</biz_error_desc>
        <biz_error_code>0</biz_error_code>
        <result_msg>demo</result_msg>
    </result>
</tbk_sc_cpa_activity_detail_response>

{
    "tbk_sc_cpa_activity_detail_response":{
        "result":{
            "biz_error_feature":"demo",
            "data":{
                "results":{
                    "results":[
                        {
                            "field_detail":"",
                            "calc_type":1
                        }
                    ]
                },
                "pre_page":1,
                "next_page":1,
                "page_no":1,
                "total_pages":1,
                "page_size":10,
                "has_next":false,
                "total_count":4,
                "has_pre":false
            },
            "success":true,
            "result_code":200,
            "biz_error_desc":"demo",
            "biz_error_code":0,
            "result_msg":"demo"
        }
    }
}

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.sc.cpa.activity.detail (淘宝客-服务商-CPA活动执行明细)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ