淘宝开放平台

请求地址：

环境	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		CPA活动ID，详见https://www.yuque.com/docs/share/16905f3f-3a22-4e7c-b8c3-4d23791d42f7?#
biz_date	String	必须	20210818		日期(yyyyMMdd)
page_no	Number	可选	1		分页页数，从1开始
query_type	Number	可选	1	默认值：1	数据类型：数据类型:1预估 2结算（选择1可查询含当天实时预估统计的累计数据，选择2可查询最晚截止昨天结算的累计数据，具体逻辑以活动规则描述为准；）
page_size	Number	可选	10		分页大小
pid	String	可选	mm_123_123_123		媒体三段式id（如果传入pid则返回pid汇总数据，不传则返回member维度统计数据，pid和relationid不可同时传入）
relation_id	Number	可选	100		代理id（如果传入rid则返回rid统计数据，不传则返回member维度统计数据）

名称	类型	示例值	描述
result	RpcResult	{}	返回模型
data PageResult {} 分页模型 results VegasCpaReportDTO [] [] 数据列表 └ reward_amount String 100.1 奖励金额；按入参是预估/结算，区分获得金额为预估or可结算结果； └ union_30d_lx_uv Number 100 符合奖励要求的累计用户数；按入参是预估/结算，区分用户数为预估or可结算结果； └ relation_id Number 123456 rid，当查询数据为rid维度时返回该字段 └ biz_date String 20210301 统计日期（统计活动期内，截止统计日期的数据） └ pid String mm_123_123_123 媒体三段式id，当查询数据为pid维度时返回该字段 └ query_type Number 1 数据类型:1预估 2结算

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TbkScCpaActivityReportRequest req = new TbkScCpaActivityReportRequest();
req.setEventId(1L);
req.setBizDate("20210818");
req.setPageNo(1L);
req.setQueryType(1L);
req.setPageSize(10L);
req.setPid("mm_123_123_123");
req.setRelationId(100L);
TbkScCpaActivityReportResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TbkScCpaActivityReportRequest req = new TbkScCpaActivityReportRequest();
req.EventId = 1L;
req.BizDate = "20210818";
req.PageNo = 1L;
req.QueryType = 1L;
req.PageSize = 10L;
req.Pid = "mm_123_123_123";
req.RelationId = 100L;
TbkScCpaActivityReportResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TbkScCpaActivityReportRequest;
$req->setEventId("1");
$req->setBizDate("20210818");
$req->setPageNo("1");
$req->setQueryType("1");
$req->setPageSize("10");
$req->setPid("mm_123_123_123");
$req->setRelationId("100");
$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.report' \
-d 'partner_id=apidoc' \
-d 'session=9a1c3375-f9f3-4031-8bbf-a8f51d894bbb' \
-d 'sign=512B89EC25815CEB276D0B20C1C86928' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-05-04+23%3A19%3A45' \
-d 'v=2.0' \
-d 'biz_date=20210818' \
-d 'event_id=1' \
-d 'page_no=1' \
-d 'page_size=10' \
-d 'pid=mm_123_123_123' \
-d 'query_type=1' \
-d 'relation_id=100'

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

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

req.event_id=1
req.biz_date="20210818"
req.page_no=1
req.query_type=1
req.page_size=10
req.pid="mm_123_123_123"
req.relation_id=100
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.report");
add_param(pRequest,"event_id","1");
add_param(pRequest,"biz_date","20210818");
add_param(pRequest,"page_no","1");
add_param(pRequest,"query_type","1");
add_param(pRequest,"page_size","10");
add_param(pRequest,"pid","mm_123_123_123");
add_param(pRequest,"relation_id","100");
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.report', {
	'event_id':'1',
	'biz_date':'20210818',
	'page_no':'1',
	'query_type':'1',
	'page_size':'10',
	'pid':'mm_123_123_123',
	'relation_id':'100'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<tbk_sc_cpa_activity_report_response>
    <result>
        <data>
            <results>
                <vegas_cpa_report_d_t_o>
                    <reward_amount>100.1</reward_amount>
                    <union_30d_lx_uv>100</union_30d_lx_uv>
                    <relation_id>123456</relation_id>
                    <biz_date>20210301</biz_date>
                    <pid>mm_123_123_123</pid>
                    <query_type>1</query_type>
                </vegas_cpa_report_d_t_o>
            </results>
        </data>
    </result>
</tbk_sc_cpa_activity_report_response>

{
    "tbk_sc_cpa_activity_report_response":{
        "result":{
            "data":{
                "results":{
                    "vegas_cpa_report_d_t_o":[
                        {
                            "reward_amount":"100.1",
                            "union_30d_lx_uv":100,
                            "relation_id":123456,
                            "biz_date":"20210301",
                            "pid":"mm_123_123_123",
                            "query_type":1
                        }
                    ]
                }
            }
        }
    }
}

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.report (淘宝客-服务商-任务奖励效果报表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ