淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
ad_effect_report_request	AdEffectReportRequest	可选			响应结果集
└ company_id String 可选 50001234 TMGE公司ID，TMGE入住商家必传 └ campaign_id Number 可选 123 投放计划ID └ ds String 必须 20221011 日期, 格式: yyyyMMdd

名称	类型	示例值	描述
result	BizResult		返回实体父节点
└ fail Boolean false 是否失败 └ code String SUCCESS 响应code data AdEffectReportDTO [] 数据集 └ alipay_inshop_dir_amt7d BigDecimal 1023 直接购买金额(7天) └ itemcol_inshop_num Number 1 商品收藏数 └ alipay_inshop_dir_num3d Number 2 直接购买数量(3天) └ alipay_inshop_dir_num7d Number 2 直接购买数量(7天) └ ds String 20221011 日期 └ scene String 商品打爆场景 └ alipay_inshop_amt7d BigDecimal 1773 总购买金额(7天) └ item_name String 君乐宝优萃有机幼儿配方牛奶粉（12-36个月）3段800g×1罐商品名 └ alipay_inshop_num15d Number 4 总购买数量(15天) └ alipay_inshop_amt3d BigDecimal 1773 总购买金额(3天) └ alipay_inshop_dir_num1d Number 2 直接购买数量(1天) └ adgroup_id Number 165880 单元ID └ alipay_inshop_amt1d BigDecimal 1773 总购买金额(1天) └ alipay_inshop_dir_num15d Number 2 直接购买数量(15天) └ alipay_inshop_dir_amt3d BigDecimal 1023 直接购买金额(3天) └ alipay_inshop_dir_amt1d BigDecimal 1023 直接购买金额(1天) └ cost BigDecimal 348.2088 消耗 └ campaign_id Number 126855 投放计划ID └ alipay_inshop_num1d Number 4 总购买数量(1天) └ click Number 111 点击 └ alipay_inshop_num3d Number 4 总购买数量(3天) └ item_id Number 610690551711 商品ID └ alipay_inshop_amt15d BigDecimal 1773 总购买金额(15天) └ alipay_inshop_num7d Number 4 总购买数量(7天) └ cart_inshop_num Number 9 商品加购数 └ impression Number 7616 曝光 └ campaign_name String 优萃3段9到13 投放计划名称 └ alipay_inshop_dir_amt15d BigDecimal 1023 直接购买金额(15天) └ success Boolean true 是否成功 └ message String 成功响应结果

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TmallTxcsAdEffectReportGetRequest req = new TmallTxcsAdEffectReportGetRequest();
TmallTxcsAdEffectReportGetRequest.AdEffectReportRequest obj1 = new TmallTxcsAdEffectReportGetRequest.AdEffectReportRequest();
obj1.setCompanyId("50001234");
obj1.setCampaignId(123L);
obj1.setDs("20221011");
req.setAdEffectReportRequest(obj1);
TmallTxcsAdEffectReportGetResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TmallTxcsAdEffectReportGetRequest req = new TmallTxcsAdEffectReportGetRequest();
TmallTxcsAdEffectReportGetRequest.AdEffectReportRequestDomain obj1 = new TmallTxcsAdEffectReportGetRequest.AdEffectReportRequestDomain();
obj1.CompanyId = "50001234";
obj1.CampaignId = 123L;
obj1.Ds = "20221011";
req.AdEffectReportRequest_ = obj1;
TmallTxcsAdEffectReportGetResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TmallTxcsAdEffectReportGetRequest;
$ad_effect_report_request = new AdEffectReportRequest;
$ad_effect_report_request->company_id="50001234";
$ad_effect_report_request->campaign_id="123";
$ad_effect_report_request->ds="20221011";
$req->setAdEffectReportRequest(json_encode($ad_effect_report_request));
$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=tmall.txcs.ad.effect.report.get' \
-d 'partner_id=apidoc' \
-d 'sign=DFFABBF95A89B1412678BF80D09345BD' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-06-26+22%3A40%3A11' \
-d 'v=2.0' \
-d 'ad_effect_report_request=null'

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

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

req.ad_effect_report_request="数据结构示例JSON格式"
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,"tmall.txcs.ad.effect.report.get");
add_param(pRequest,"ad_effect_report_request","数据结构JSON示例");
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('tmall.txcs.ad.effect.report.get', {
	'ad_effect_report_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<tmall_txcs_ad_effect_report_get_response>
    <result>
        <fail>false</fail>
        <code>SUCCESS</code>
        <data>
            <ad_effect_report_d_t_o>
                <alipay_inshop_dir_amt7d>1023</alipay_inshop_dir_amt7d>
                <itemcol_inshop_num>1</itemcol_inshop_num>
                <alipay_inshop_dir_num3d>2</alipay_inshop_dir_num3d>
                <alipay_inshop_dir_num7d>2</alipay_inshop_dir_num7d>
                <ds>20221011</ds>
                <scene>商品打爆</scene>
                <alipay_inshop_amt7d>1773</alipay_inshop_amt7d>
                <item_name>君乐宝优萃有机幼儿配方牛奶粉（12-36个月）3段800g&amp;times;1罐</item_name>
                <alipay_inshop_num15d>4</alipay_inshop_num15d>
                <alipay_inshop_amt3d>1773</alipay_inshop_amt3d>
                <alipay_inshop_dir_num1d>2</alipay_inshop_dir_num1d>
                <adgroup_id>165880</adgroup_id>
                <alipay_inshop_amt1d>1773</alipay_inshop_amt1d>
                <alipay_inshop_dir_num15d>2</alipay_inshop_dir_num15d>
                <alipay_inshop_dir_amt3d>1023</alipay_inshop_dir_amt3d>
                <alipay_inshop_dir_amt1d>1023</alipay_inshop_dir_amt1d>
                <cost>348.2088</cost>
                <campaign_id>126855</campaign_id>
                <alipay_inshop_num1d>4</alipay_inshop_num1d>
                <click>111</click>
                <alipay_inshop_num3d>4</alipay_inshop_num3d>
                <item_id>610690551711</item_id>
                <alipay_inshop_amt15d>1773</alipay_inshop_amt15d>
                <alipay_inshop_num7d>4</alipay_inshop_num7d>
                <cart_inshop_num>9</cart_inshop_num>
                <impression>7616</impression>
                <campaign_name>优萃3段9到13</campaign_name>
                <alipay_inshop_dir_amt15d>1023</alipay_inshop_dir_amt15d>
            </ad_effect_report_d_t_o>
        </data>
        <success>true</success>
        <message>成功</message>
    </result>
</tmall_txcs_ad_effect_report_get_response>

{
    "tmall_txcs_ad_effect_report_get_response":{
        "result":{
            "fail":false,
            "code":"SUCCESS",
            "data":{
                "ad_effect_report_d_t_o":[
                    {
                        "alipay_inshop_dir_amt7d":"1023",
                        "itemcol_inshop_num":1,
                        "alipay_inshop_dir_num3d":2,
                        "alipay_inshop_dir_num7d":2,
                        "ds":"20221011",
                        "scene":"商品打爆",
                        "alipay_inshop_amt7d":"1773",
                        "item_name":"君乐宝优萃有机幼儿配方牛奶粉（12-36个月）3段800g&times;1罐",
                        "alipay_inshop_num15d":4,
                        "alipay_inshop_amt3d":"1773",
                        "alipay_inshop_dir_num1d":2,
                        "adgroup_id":165880,
                        "alipay_inshop_amt1d":"1773",
                        "alipay_inshop_dir_num15d":2,
                        "alipay_inshop_dir_amt3d":"1023",
                        "alipay_inshop_dir_amt1d":"1023",
                        "cost":"348.2088",
                        "campaign_id":126855,
                        "alipay_inshop_num1d":4,
                        "click":111,
                        "alipay_inshop_num3d":4,
                        "item_id":610690551711,
                        "alipay_inshop_amt15d":"1773",
                        "alipay_inshop_num7d":4,
                        "cart_inshop_num":9,
                        "impression":7616,
                        "campaign_name":"优萃3段9到13",
                        "alipay_inshop_dir_amt15d":"1023"
                    }
                ]
            },
            "success":true,
            "message":"成功"
        }
    }
}

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

tmall.txcs.ad.effect.report.get (猫超智投效果数据回传)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ