淘宝开放平台

请求地址：

环境	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	必须	111	星任务id
evoke_pv	Number	可选	11	唤起pv
rpt_start_time	Date	必须	2023-02-10 23:59:59	数据汇总开始时间
creative_name	String	可选	xxx	创意名称
click_pv	Number	必须	1	点击pv
play_pv	Number	必须	1	播放pv
unit_name	String	可选	xxx	单元名称
exposure_pv	Number	必须	1	曝光pv
account_name	String	可选	xxx	账户名称
campaign_id	String	可选	1	计划id
content_id	String	必须	xxx	内容id
sclick_pv	Number	必须	1	蓝链点击
rpt_end_time	Date	必须	2023-02-10 23:59:59	数据汇总结束时间
creative_id	String	可选	1	创意id
content_name	String	必须	xxx	内容名称
sclick_exposure_pv	Number	必须	1	蓝链曝光
account_id	String	可选	1	账户id
unit_id	String	可选	1	单元id
consume_amt	Number	必须	1	消费金额，分
campaign_name	String	可选	xxx	计划名称
play_uv	Number	可选	123	阅读uv
order_id	String	可选	123	订单id
order_name	String	可选	xxx	订单名称
cpm	Number	可选	123	千次曝光成本，分
cpc	Number	可选	123	单次阅读成本，分
cpa	Number	可选	123	单次互动成本，分
like_pv	Number	可选	123	点赞pv
collect_pv	Number	可选	123	收藏pv
comment_pv	Number	可选	123	评论pv
read_rate	Number	可选	123	阅读率，精确至小数点后两位，1234意味着12.34%
sclick_exposure_rate	Number	可选	123	链接曝光率，精确至小数点后两位，1234意味着12.34%
sclick_click_rate	Number	可选	123	链接点击率，精确至小数点后两位，1234意味着12.34%

名称	类型	示例值	描述
data	Boolean	true	成功标志
result_code	Number	200	返回码
biz_error_desc	String	系统异常	业务错误码
result_msg	Number	内部服务发生错误	错误信息
biz_error_code	Number	1001	业务错误信息

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TbkFeedIndicatorUploadRequest req = new TbkFeedIndicatorUploadRequest();
req.setEventId(111L);
req.setEvokePv(11L);
req.setRptStartTime(StringUtils.parseDateTime("2023-02-10 23:59:59"));
req.setCreativeName("xxx");
req.setClickPv(1L);
req.setPlayPv(1L);
req.setUnitName("xxx");
req.setExposurePv(1L);
req.setAccountName("xxx");
req.setCampaignId("1");
req.setContentId("xxx");
req.setSclickPv(1L);
req.setRptEndTime(StringUtils.parseDateTime("2023-02-10 23:59:59"));
req.setCreativeId("1");
req.setContentName("xxx");
req.setSclickExposurePv(1L);
req.setAccountId("1");
req.setUnitId("1");
req.setConsumeAmt(1L);
req.setCampaignName("xxx");
req.setPlayUv(123L);
req.setOrderId("123");
req.setOrderName("xxx");
req.setCpm(123L);
req.setCpc(123L);
req.setCpa(123L);
req.setLikePv(123L);
req.setCollectPv(123L);
req.setCommentPv(123L);
req.setReadRate(123L);
req.setSclickExposureRate(123L);
req.setSclickClickRate(123L);
TbkFeedIndicatorUploadResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TbkFeedIndicatorUploadRequest req = new TbkFeedIndicatorUploadRequest();
req.EventId = 111L;
req.EvokePv = 11L;
req.RptStartTime = DateTime.Parse("2023-02-10 23:59:59");
req.CreativeName = "xxx";
req.ClickPv = 1L;
req.PlayPv = 1L;
req.UnitName = "xxx";
req.ExposurePv = 1L;
req.AccountName = "xxx";
req.CampaignId = "1";
req.ContentId = "xxx";
req.SclickPv = 1L;
req.RptEndTime = DateTime.Parse("2023-02-10 23:59:59");
req.CreativeId = "1";
req.ContentName = "xxx";
req.SclickExposurePv = 1L;
req.AccountId = "1";
req.UnitId = "1";
req.ConsumeAmt = 1L;
req.CampaignName = "xxx";
req.PlayUv = 123L;
req.OrderId = "123";
req.OrderName = "xxx";
req.Cpm = 123L;
req.Cpc = 123L;
req.Cpa = 123L;
req.LikePv = 123L;
req.CollectPv = 123L;
req.CommentPv = 123L;
req.ReadRate = 123L;
req.SclickExposureRate = 123L;
req.SclickClickRate = 123L;
TbkFeedIndicatorUploadResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TbkFeedIndicatorUploadRequest;
$req->setEventId("111");
$req->setEvokePv("11");
$req->setRptStartTime("2023-02-10 23:59:59");
$req->setCreativeName("xxx");
$req->setClickPv("1");
$req->setPlayPv("1");
$req->setUnitName("xxx");
$req->setExposurePv("1");
$req->setAccountName("xxx");
$req->setCampaignId("1");
$req->setContentId("xxx");
$req->setSclickPv("1");
$req->setRptEndTime("2023-02-10 23:59:59");
$req->setCreativeId("1");
$req->setContentName("xxx");
$req->setSclickExposurePv("1");
$req->setAccountId("1");
$req->setUnitId("1");
$req->setConsumeAmt("1");
$req->setCampaignName("xxx");
$req->setPlayUv("123");
$req->setOrderId("123");
$req->setOrderName("xxx");
$req->setCpm("123");
$req->setCpc("123");
$req->setCpa("123");
$req->setLikePv("123");
$req->setCollectPv("123");
$req->setCommentPv("123");
$req->setReadRate("123");
$req->setSclickExposureRate("123");
$req->setSclickClickRate("123");
$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.feed.indicator.upload' \
-d 'partner_id=apidoc' \
-d 'sign=CD34702B8ACAD1346471B0242FCC5636' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-05-07+16%3A53%3A07' \
-d 'v=2.0' \
-d 'account_id=1' \
-d 'account_name=xxx' \
-d 'campaign_id=1' \
-d 'campaign_name=xxx' \
-d 'click_pv=1' \
-d 'collect_pv=123' \
-d 'comment_pv=123' \
-d 'consume_amt=1' \
-d 'content_id=xxx' \
-d 'content_name=xxx' \
-d 'cpa=123' \
-d 'cpc=123' \
-d 'cpm=123' \
-d 'creative_id=1' \
-d 'creative_name=xxx' \
-d 'event_id=111' \
-d 'evoke_pv=11' \
-d 'exposure_pv=1' \
-d 'like_pv=123' \
-d 'order_id=123' \
-d 'order_name=xxx' \
-d 'play_pv=1' \
-d 'play_uv=123' \
-d 'read_rate=123' \
-d 'rpt_end_time=2023-02-10+23%3A59%3A59' \
-d 'rpt_start_time=2023-02-10+23%3A59%3A59' \
-d 'sclick_click_rate=123' \
-d 'sclick_exposure_pv=1' \
-d 'sclick_exposure_rate=123' \
-d 'sclick_pv=1' \
-d 'unit_id=1' \
-d 'unit_name=xxx'

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

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

req.event_id=111
req.evoke_pv=11
req.rpt_start_time="2023-02-10 23:59:59"
req.creative_name="xxx"
req.click_pv=1
req.play_pv=1
req.unit_name="xxx"
req.exposure_pv=1
req.account_name="xxx"
req.campaign_id="1"
req.content_id="xxx"
req.sclick_pv=1
req.rpt_end_time="2023-02-10 23:59:59"
req.creative_id="1"
req.content_name="xxx"
req.sclick_exposure_pv=1
req.account_id="1"
req.unit_id="1"
req.consume_amt=1
req.campaign_name="xxx"
req.play_uv=123
req.order_id="123"
req.order_name="xxx"
req.cpm=123
req.cpc=123
req.cpa=123
req.like_pv=123
req.collect_pv=123
req.comment_pv=123
req.read_rate=123
req.sclick_exposure_rate=123
req.sclick_click_rate=123
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.feed.indicator.upload");
add_param(pRequest,"event_id","111");
add_param(pRequest,"evoke_pv","11");
add_param(pRequest,"rpt_start_time","2023-02-10 23:59:59");
add_param(pRequest,"creative_name","xxx");
add_param(pRequest,"click_pv","1");
add_param(pRequest,"play_pv","1");
add_param(pRequest,"unit_name","xxx");
add_param(pRequest,"exposure_pv","1");
add_param(pRequest,"account_name","xxx");
add_param(pRequest,"campaign_id","1");
add_param(pRequest,"content_id","xxx");
add_param(pRequest,"sclick_pv","1");
add_param(pRequest,"rpt_end_time","2023-02-10 23:59:59");
add_param(pRequest,"creative_id","1");
add_param(pRequest,"content_name","xxx");
add_param(pRequest,"sclick_exposure_pv","1");
add_param(pRequest,"account_id","1");
add_param(pRequest,"unit_id","1");
add_param(pRequest,"consume_amt","1");
add_param(pRequest,"campaign_name","xxx");
add_param(pRequest,"play_uv","123");
add_param(pRequest,"order_id","123");
add_param(pRequest,"order_name","xxx");
add_param(pRequest,"cpm","123");
add_param(pRequest,"cpc","123");
add_param(pRequest,"cpa","123");
add_param(pRequest,"like_pv","123");
add_param(pRequest,"collect_pv","123");
add_param(pRequest,"comment_pv","123");
add_param(pRequest,"read_rate","123");
add_param(pRequest,"sclick_exposure_rate","123");
add_param(pRequest,"sclick_click_rate","123");
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.feed.indicator.upload', {
	'event_id':'111',
	'evoke_pv':'11',
	'rpt_start_time':'2023-02-10 23:59:59',
	'creative_name':'xxx',
	'click_pv':'1',
	'play_pv':'1',
	'unit_name':'xxx',
	'exposure_pv':'1',
	'account_name':'xxx',
	'campaign_id':'1',
	'content_id':'xxx',
	'sclick_pv':'1',
	'rpt_end_time':'2023-02-10 23:59:59',
	'creative_id':'1',
	'content_name':'xxx',
	'sclick_exposure_pv':'1',
	'account_id':'1',
	'unit_id':'1',
	'consume_amt':'1',
	'campaign_name':'xxx',
	'play_uv':'123',
	'order_id':'123',
	'order_name':'xxx',
	'cpm':'123',
	'cpc':'123',
	'cpa':'123',
	'like_pv':'123',
	'collect_pv':'123',
	'comment_pv':'123',
	'read_rate':'123',
	'sclick_exposure_rate':'123',
	'sclick_click_rate':'123'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<tbk_feed_indicator_upload_response>
    <data>true</data>
    <result_code>200</result_code>
    <biz_error_desc>系统异常</biz_error_desc>
    <result_msg>内部服务发生错误</result_msg>
    <biz_error_code>1001</biz_error_code>
</tbk_feed_indicator_upload_response>

{
    "tbk_feed_indicator_upload_response":{
        "data":true,
        "result_code":200,
        "biz_error_desc":"系统异常",
        "result_msg":内部服务发生错误,
        "biz_error_code":1001
    }
}

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.feed.indicator.upload (淘宝客-推广者-内容种草投流前链路数据上传)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ