淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	描述
top_service_context	TopServiceContext	必须	topServiceContext
└ biz_code String 必须 xxxxx api业务线编码 └ login_type Number 可选 1 1: 直客(正常)登录 2: 代理直投(叉乘账号) └ member_id Number 可选 12345 代理直投时被代理商家账号, 代理直投（叉乘）时必填。直客时也可以填入 memberId └ ext String 可选 {} 扩展内容, 暂时无用
material_report_query_v_o	MaterialReportQueryVO	必须	materialReportQueryVO
└ creative_id Number 可选 6843262308 素材在本次查询中关联的创意ID └ creative_id_list Number [] 可选 [6843262308] 素材在本次查询中关联的创意ID集合 └ material_type String 可选 title 素材类型 └ campaign_id_in_list Number [] 可选 [7843262308] 计划id集合 └ adgroup_id_in_list Number [] 可选 [6943262308] 单元id集合 rpt_query RptQueryVO 可选横向管理-实体数据列表-通用报表查询条件报表数据查询条件 └ fields String 可选 adPv,click,charge,ctr,ecpc,ecpm 查询指标字段 condition_list RptQueryConditionVO [] 可选报表查询条件 └ start_time String 可选 2023-10-08 开始时间 └ end_time String 可选 2023-10-08 结束时间 └ adzone_pkg_id_list String [] 可选 ["114790550288", "114790550289", "114793500012", "114786650498"] 流量来源（资源位包id） └ is_rt Boolean 可选 true 是否查询实时报表，true查实时、false查离线，不传则默认查离线 └ unify_type String 可选 zhai 归因类型 └ source_list String [] 可选 ["campaign_detail","adgroup_list"] 来源,根据场景去选择,有的不需要传 └ end_time String 可选 2023-06-12 结束时间 └ start_time String 可选 2023-06-06 开始

名称	类型	示例值	描述
top_result	TopResult		topResult
info TopInfo 通用前端结果的Info信息请求系统信息 └ ok Boolean true 是否成功 └ message String 参数错误错误信息 └ error_code String xxxxx 错误编码 creative_v_o CreativeVO 结果集 └ title_material_count Number 5 标题素材个数 media_material_list MediaMaterialInfoVO [] 媒体素材列表 └ creative_id Number 6843262308 素材在本次查询中关联的创意ID └ format Number 2 2、图片 12、视频 └ start_time Date 2024-01-01 00:00:00 素材开始时间 └ end_time Date 2024-01-01 00:00:00 素材结束时间 └ effective_time Date 2024-01-01 00:00:00 风控设置的生效时间 └ expire_time Date 2024-01-01 00:00:00 风控设置的失效时间 └ material_name String 宝贝xxx名称物料名称 └ outer_id Number 1011 海棠ID └ source Number 1 1 主副图 2 主图视频 3 素材 4 sku └ tag String tag名称用于主副图、主图视频名称透出 └ item_id Number 6843262308 素材关联的宝贝ID └ image_position Number 1 主副图图片排序位置 └ image_path String http://localhost 图片链接 └ video_id Number 1012 视频id └ video_image_path String http://localhost 视频封面 └ video_path String http://localhost 视频url └ width Number 200 宽 └ height Number 400 高 └ sync_key String xxxxx 同步标 └ image_id Number 101 sku 图会有这个字段 └ material_type String title 素材类型 └ material_id Number 714894818852 素材id └ haitang_source Number 1 海棠来源 └ report_info String 报表数据 title_material_list TextMaterialInfoVO [] 标题素材列表 └ creative_id Number 6843262308 素材在本次查询中关联的创意ID └ material_id Number 714894818852 素材id └ item_id Number 6843262308 素材关联的宝贝ID └ start_time Date 2024-01-01 00:00:00 素材开始时间 └ end_time Date 2024-01-01 00:00:00 素材结束时间 └ effective_time Date 2024-01-01 00:00:00 风控设置的生效时间 └ expire_time Date 2024-01-01 00:00:00 风控设置的失效时间 └ content_type String title 文案：title 标题：copyWriting └ content String xxxxxx 内容 └ material_type String title 素材类型 └ source Number 2 来源 └ report_info String 报表数据 └ media_material_count Number 5 媒体素材个数

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
UniversalbpNewCreativeReportMaterialRequest req = new UniversalbpNewCreativeReportMaterialRequest();
UniversalbpNewCreativeReportMaterialRequest.TopServiceContext obj1 = new UniversalbpNewCreativeReportMaterialRequest.TopServiceContext();
obj1.setBizCode("xxxxx");
obj1.setLoginType(1L);
obj1.setMemberId(12345L);
obj1.setExt("{}");
req.setTopServiceContext(obj1);
UniversalbpNewCreativeReportMaterialRequest.MaterialReportQueryVO obj2 = new UniversalbpNewCreativeReportMaterialRequest.MaterialReportQueryVO();
obj2.setCreativeId(6843262308L);
obj2.setCreativeIdList(new Long[] { 6843262308 };
);
obj2.setMaterialType("title");
obj2.setCampaignIdInList(new Long[] { 7843262308 };
);
obj2.setAdgroupIdInList(new Long[] { 6943262308 };
);
UniversalbpNewCreativeReportMaterialRequest.RptQueryVO obj3 = new UniversalbpNewCreativeReportMaterialRequest.RptQueryVO();
obj3.setFields("adPv,click,charge,ctr,ecpc,ecpm");
List<UniversalbpNewCreativeReportMaterialRequest.RptQueryConditionVO> list5 = new ArrayList<UniversalbpNewCreativeReportMaterialRequest.RptQueryConditionVO>();
UniversalbpNewCreativeReportMaterialRequest.RptQueryConditionVO obj6 = new UniversalbpNewCreativeReportMaterialRequest.RptQueryConditionVO();
list5.add(obj6);
obj6.setStartTime("2023-10-08");
obj6.setEndTime("2023-10-08");
obj6.setAdzonePkgIdList(""114790550288", "114790550289", "114793500012", "114786650498"");
obj6.setIsRt(true);
obj6.setUnifyType("zhai");
obj6.setSourceList(""campaign_detail","adgroup_list"");
obj3.setConditionList(list5);
obj2.setRptQuery(obj3);
obj2.setEndTime("2023-06-12");
obj2.setStartTime("2023-06-06");
req.setMaterialReportQueryVO(obj2);
UniversalbpNewCreativeReportMaterialResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
UniversalbpNewCreativeReportMaterialRequest req = new UniversalbpNewCreativeReportMaterialRequest();
UniversalbpNewCreativeReportMaterialRequest.TopServiceContextDomain obj1 = new UniversalbpNewCreativeReportMaterialRequest.TopServiceContextDomain();
obj1.BizCode = "xxxxx";
obj1.LoginType = 1L;
obj1.MemberId = 12345L;
obj1.Ext = "{}";
req.TopServiceContext_ = obj1;
UniversalbpNewCreativeReportMaterialRequest.MaterialReportQueryVODomain obj2 = new UniversalbpNewCreativeReportMaterialRequest.MaterialReportQueryVODomain();
obj2.CreativeId = 6843262308L;
obj2.CreativeIdList = new long[] { 6843262308 };
;
obj2.MaterialType = "title";
obj2.CampaignIdInList = new long[] { 7843262308 };
;
obj2.AdgroupIdInList = new long[] { 6943262308 };
;
UniversalbpNewCreativeReportMaterialRequest.RptQueryVODomain obj3 = new UniversalbpNewCreativeReportMaterialRequest.RptQueryVODomain();
obj3.Fields = "adPv,click,charge,ctr,ecpc,ecpm";
List<UniversalbpNewCreativeReportMaterialRequest.RptQueryConditionVODomain> list5 = new List<UniversalbpNewCreativeReportMaterialRequest.RptQueryConditionVODomain>();
UniversalbpNewCreativeReportMaterialRequest.RptQueryConditionVODomain obj6 = new UniversalbpNewCreativeReportMaterialRequest.RptQueryConditionVODomain();
list5.Add(obj6);
obj6.StartTime = "2023-10-08";
obj6.EndTime = "2023-10-08";
obj6.AdzonePkgIdList = ""114790550288", "114790550289", "114793500012", "114786650498"";
obj6.IsRt = true;
obj6.UnifyType = "zhai";
obj6.SourceList = ""campaign_detail","adgroup_list"";
obj3.ConditionList= list5;
obj2.RptQuery= obj3;
obj2.EndTime = "2023-06-12";
obj2.StartTime = "2023-06-06";
req.MaterialReportQueryVO_ = obj2;
UniversalbpNewCreativeReportMaterialResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new UniversalbpNewCreativeReportMaterialRequest;
$top_service_context = new TopServiceContext;
$top_service_context->biz_code="xxxxx";
$top_service_context->login_type="1";
$top_service_context->member_id="12345";
$top_service_context->ext="{}";
$req->setTopServiceContext(json_encode($top_service_context));
$material_report_query_v_o = new MaterialReportQueryVO;
$material_report_query_v_o->creative_id="6843262308";
$material_report_query_v_o->creative_id_list="[6843262308]";
$material_report_query_v_o->material_type="title";
$material_report_query_v_o->campaign_id_in_list="[7843262308]";
$material_report_query_v_o->adgroup_id_in_list="[6943262308]";
$rpt_query = new RptQueryVO;
$rpt_query->fields="adPv,click,charge,ctr,ecpc,ecpm";
$condition_list = new RptQueryConditionVO;
$condition_list->start_time="2023-10-08";
$condition_list->end_time="2023-10-08";
$condition_list->adzone_pkg_id_list="[\"114790550288\", \"114790550289\", \"114793500012\", \"114786650498\"]";
$condition_list->is_rt="true";
$condition_list->unify_type="zhai";
$condition_list->source_list="[\"campaign_detail\",\"adgroup_list\"]";
$rpt_query->condition_list = $condition_list;
$material_report_query_v_o->rpt_query = $rpt_query;
$material_report_query_v_o->end_time="2023-06-12";
$material_report_query_v_o->start_time="2023-06-06";
$req->setMaterialReportQueryVO(json_encode($material_report_query_v_o));
$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.universalbp.new.creative.report.material' \
-d 'partner_id=apidoc' \
-d 'session=42101e5b-1415-41a9-ab74-e812af379c8c' \
-d 'sign=870094E3B14A1F9839BBC23BD1408877' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-28+15%3A29%3A38' \
-d 'v=2.0' \
-d 'material_report_query_v_o=null' \
-d 'top_service_context=TopServiceContext'

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

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

req.top_service_context="TopServiceContext"
req.material_report_query_v_o=""
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.universalbp.new.creative.report.material");
add_param(pRequest,"top_service_context","数据结构JSON示例");
add_param(pRequest,"material_report_query_v_o","数据结构JSON示例");
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.universalbp.new.creative.report.material', {
	'top_service_context':'数据结构JSON示例',
	'material_report_query_v_o':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<universalbp_new_creative_report_material_response>
    <top_result>
        <info>
            <ok>true</ok>
            <message>参数错误</message>
            <error_code>xxxxx</error_code>
        </info>
        <creative_v_o>
            <title_material_count>5</title_material_count>
            <media_material_list>
                <media_material_info_v_o>
                    <creative_id>6843262308</creative_id>
                    <format>2</format>
                    <start_time>2024-01-01 00:00:00</start_time>
                    <end_time>2024-01-01 00:00:00</end_time>
                    <effective_time>2024-01-01 00:00:00</effective_time>
                    <expire_time>2024-01-01 00:00:00</expire_time>
                    <material_name>宝贝xxx名称</material_name>
                    <outer_id>1011</outer_id>
                    <source>1</source>
                    <tag>tag名称</tag>
                    <item_id>6843262308</item_id>
                    <image_position>1</image_position>
                    <image_path>http://localhost</image_path>
                    <video_id>1012</video_id>
                    <video_image_path>http://localhost</video_image_path>
                    <video_path>http://localhost</video_path>
                    <width>200</width>
                    <height>400</height>
                    <sync_key>xxxxx</sync_key>
                    <image_id>101</image_id>
                    <material_type>title</material_type>
                    <material_id>714894818852</material_id>
                    <haitang_source>1</haitang_source>
                </media_material_info_v_o>
            </media_material_list>
            <title_material_list>
                <text_material_info_v_o>
                    <creative_id>6843262308</creative_id>
                    <material_id>714894818852</material_id>
                    <item_id>6843262308</item_id>
                    <start_time>2024-01-01 00:00:00</start_time>
                    <end_time>2024-01-01 00:00:00</end_time>
                    <effective_time>2024-01-01 00:00:00</effective_time>
                    <expire_time>2024-01-01 00:00:00</expire_time>
                    <content_type>title</content_type>
                    <content>xxxxxx</content>
                    <material_type>title</material_type>
                    <source>2</source>
                </text_material_info_v_o>
            </title_material_list>
            <media_material_count>5</media_material_count>
        </creative_v_o>
    </top_result>
</universalbp_new_creative_report_material_response>

{
    "universalbp_new_creative_report_material_response":{
        "top_result":{
            "info":{
                "ok":true,
                "message":"参数错误",
                "error_code":"xxxxx"
            },
            "creative_v_o":{
                "title_material_count":5,
                "media_material_list":{
                    "media_material_info_v_o":[
                        {
                            "creative_id":6843262308,
                            "format":2,
                            "start_time":"2024-01-01 00:00:00",
                            "end_time":"2024-01-01 00:00:00",
                            "effective_time":"2024-01-01 00:00:00",
                            "expire_time":"2024-01-01 00:00:00",
                            "material_name":"宝贝xxx名称",
                            "outer_id":1011,
                            "source":1,
                            "tag":"tag名称",
                            "item_id":6843262308,
                            "image_position":1,
                            "image_path":"http:\/\/localhost",
                            "video_id":1012,
                            "video_image_path":"http:\/\/localhost",
                            "video_path":"http:\/\/localhost",
                            "width":200,
                            "height":400,
                            "sync_key":"xxxxx",
                            "image_id":101,
                            "material_type":"title",
                            "material_id":714894818852,
                            "haitang_source":1
                        }
                    ]
                },
                "title_material_list":{
                    "text_material_info_v_o":[
                        {
                            "creative_id":6843262308,
                            "material_id":714894818852,
                            "item_id":6843262308,
                            "start_time":"2024-01-01 00:00:00",
                            "end_time":"2024-01-01 00:00:00",
                            "effective_time":"2024-01-01 00:00:00",
                            "expire_time":"2024-01-01 00:00:00",
                            "content_type":"title",
                            "content":"xxxxxx",
                            "material_type":"title",
                            "source":2
                        }
                    ]
                },
                "media_material_count":5
            }
        }
    }
}

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.universalbp.new.creative.report.material (素材报表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ