淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
report_type_id	String	必须	union_content_media_monthly_report		月报报表名称，固定值
return_fields	String	可选	pub_id,sub_pub_id,sub_site_id,sub_adzone_id,div_rule,total_alipay_amt,settle_amount,union_pv,union_uv	默认值：pub_id,sub_pub_id,sub_site_id,sub_adzone_id,div_rule,total_alipay_amt,settle_amount,union_pv,union_uv	月报返回字段
dimensions	String	可选	ds		聚合条件
page_no	Number	必须	1		页码
page_size	Number	必须	20		每页大小
filters	String	必须	ds=201911		查询条件。查询达人pid维度数据需添加：sub_pub_id=xxx;sub_site_id=yyy;sub_adzone_id=zzz

名称	类型	示例值	描述
report_type_id	String	union_content_media_monthly_report	月报报表名称，固定值
page_info	PageInfo	map	分页信息
└ page_size Number 10 每页大小 └ page_no Number 1 当前页数 └ total_cnt Number 123 总数
data_list	DataMap []		查询结果列表
└ pub_id Number 123456 媒体平台memberid └ div_rule String 1 1-佣金5%订单；其他枚举值根据结算公式待添加 └ sub_pub_id Number 123456 达人memberId └ sub_site_id Number 123456 达人siteId └ sub_adzone_id Number 123456 达人adzoneId └ total_alipay_amt String 123.32 结算订单金额 └ settle_amount String 123.32 实际打款结算金额 └ union_uv Number 123 联盟口径UV └ union_pv Number 123 联盟口径PV
result_code	Number	500	业务错误码，200正常，500为异常
result_msg	String	sub_site_id为空	服务异常时将展示错误信息

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TbkDgContentMediaMonthlyReportRequest req = new TbkDgContentMediaMonthlyReportRequest();
req.setReportTypeId("union_content_media_monthly_report");
req.setReturnFields("pub_id,sub_pub_id,sub_site_id,sub_adzone_id,div_rule,total_alipay_amt,settle_amount,union_pv,union_uv");
req.setDimensions("ds");
req.setPageNo(1L);
req.setPageSize(20L);
req.setFilters("ds=201911");
TbkDgContentMediaMonthlyReportResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TbkDgContentMediaMonthlyReportRequest req = new TbkDgContentMediaMonthlyReportRequest();
req.ReportTypeId = "union_content_media_monthly_report";
req.ReturnFields = "pub_id,sub_pub_id,sub_site_id,sub_adzone_id,div_rule,total_alipay_amt,settle_amount,union_pv,union_uv";
req.Dimensions = "ds";
req.PageNo = 1L;
req.PageSize = 20L;
req.Filters = "ds=201911";
TbkDgContentMediaMonthlyReportResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TbkDgContentMediaMonthlyReportRequest;
$req->setReportTypeId("union_content_media_monthly_report");
$req->setReturnFields("pub_id,sub_pub_id,sub_site_id,sub_adzone_id,div_rule,total_alipay_amt,settle_amount,union_pv,union_uv");
$req->setDimensions("ds");
$req->setPageNo("1");
$req->setPageSize("20");
$req->setFilters("ds=201911");
$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.content.media.monthly.report' \
-d 'partner_id=apidoc' \
-d 'sign=0278D6E355E2BD24D2BD0E3484B9D504' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-25+15%3A55%3A21' \
-d 'v=2.0' \
-d 'dimensions=ds' \
-d 'filters=ds%3D201911' \
-d 'page_no=1' \
-d 'page_size=20' \
-d 'report_type_id=union_content_media_monthly_report' \
-d 'return_fields=pub_id%2Csub_pub_id%2Csub_site_id%2Csub_adzone_id%2Cdiv_rule%2Ctotal_alipay_amt%2Csettle_amount%2Cunion_pv%2Cunion_uv'

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

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

req.report_type_id="union_content_media_monthly_report"
req.return_fields="pub_id,sub_pub_id,sub_site_id,sub_adzone_id,div_rule,total_alipay_amt,settle_amount,union_pv,union_uv"
req.dimensions="ds"
req.page_no=1
req.page_size=20
req.filters="ds=201911"
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.content.media.monthly.report");
add_param(pRequest,"report_type_id","union_content_media_monthly_report");
add_param(pRequest,"return_fields","pub_id,sub_pub_id,sub_site_id,sub_adzone_id,div_rule,total_alipay_amt,settle_amount,union_pv,union_uv");
add_param(pRequest,"dimensions","ds");
add_param(pRequest,"page_no","1");
add_param(pRequest,"page_size","20");
add_param(pRequest,"filters","ds=201911");
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.content.media.monthly.report', {
	'report_type_id':'union_content_media_monthly_report',
	'return_fields':'pub_id,sub_pub_id,sub_site_id,sub_adzone_id,div_rule,total_alipay_amt,settle_amount,union_pv,union_uv',
	'dimensions':'ds',
	'page_no':'1',
	'page_size':'20',
	'filters':'ds=201911'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<tbk_dg_content_media_monthly_report_response>
    <report_type_id>union_content_media_monthly_report</report_type_id>
    <page_info>
        <page_size>10</page_size>
        <page_no>1</page_no>
        <total_cnt>123</total_cnt>
    </page_info>
    <data_list>
        <data_map>
            <pub_id>123456</pub_id>
            <div_rule>1</div_rule>
            <sub_pub_id>123456</sub_pub_id>
            <sub_site_id>123456</sub_site_id>
            <sub_adzone_id>123456</sub_adzone_id>
            <total_alipay_amt>123.32</total_alipay_amt>
            <settle_amount>123.32</settle_amount>
            <union_uv>123</union_uv>
            <union_pv>123</union_pv>
        </data_map>
    </data_list>
    <result_code>500</result_code>
    <result_msg>sub_site_id为空</result_msg>
</tbk_dg_content_media_monthly_report_response>

{
    "tbk_dg_content_media_monthly_report_response":{
        "report_type_id":"union_content_media_monthly_report",
        "page_info":{
            "page_size":10,
            "page_no":1,
            "total_cnt":123
        },
        "data_list":{
            "data_map":[
                {
                    "pub_id":123456,
                    "div_rule":"1",
                    "sub_pub_id":123456,
                    "sub_site_id":123456,
                    "sub_adzone_id":123456,
                    "total_alipay_amt":"123.32",
                    "settle_amount":"123.32",
                    "union_uv":123,
                    "union_pv":123
                }
            ]
        },
        "result_code":500,
        "result_msg":"sub_site_id为空"
    }
}

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.content.media.monthly.report (淘宝客-推广者-微博月报(达人维度))

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ