淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	描述
biz_type	Number	必须	1	淘宝频道
scenario_type	Number	必须	1	标的类型
outer_creative_id	String	必须	1234	渠道-创意id
title	String	可选	长文案	长文案
img_url	String	可选	https://xx.taobao.com/image.jpg	图片url
h5_url	String	可选	https://m.taobao.com/tbopen/index.html?action=ali.open.nav&bc_fl_src=&idfa=__IDFA__&imei=__IMEI__&oaid=__OAID__&oaidMd5=__OAID_MD5__&rtaId=__REQUEST_ID__&clickId=__CLICK_ID__	H5落地页链接
ad_type	Number	必须	1	广告类型
video_url	String	可选	https://xx.taobao.com/video.mp4	视频url
sub_title	String	可选	短文案	短文案
creative_type	Number	可选	1	创意类型
dp_url	String	可选	tbopen://m.taobao.com/tbopen/index.html?action=ali.open.nav&bc_fl_src=&idfa=__IDFA__&imei=__IMEI__&oaid=__OAID__&oaidMd5=__OAID_MD5__&rtaId=__REQUEST_ID__&clickId=__CLICK_ID__	dp链接
app_id	Number	必须	1	应用id
channel_id	Number	必须	1234	渠道id
id	Number	必须	1234	创意id
hot_event	Number	必须	0	热点事件

名称	类型	示例值	描述
trace_id	String	12353324	鹰眼id
response_code	Number	6	参数错误
data	String	1234	更新创意的id
message	String	参数错误	错误信息
successful	Boolean	true	请求结果

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
UsergrowthAdMaterialUpdateRequest req = new UsergrowthAdMaterialUpdateRequest();
req.setBizType(1L);
req.setScenarioType(1L);
req.setOuterCreativeId("1234");
req.setTitle("长文案");
req.setImgUrl("https://xx.taobao.com/image.jpg");
req.setH5Url("https://m.taobao.com/tbopen/index.html?action=ali.open.nav&bc_fl_src=&idfa=__IDFA__&imei=__IMEI__&oaid=__OAID__&oaidMd5=__OAID_MD5__&rtaId=__REQUEST_ID__&clickId=__CLICK_ID__");
req.setAdType(1L);
req.setVideoUrl("https://xx.taobao.com/video.mp4");
req.setSubTitle("短文案");
req.setCreativeType(1L);
req.setDpUrl("tbopen://m.taobao.com/tbopen/index.html?action=ali.open.nav&bc_fl_src=&idfa=__IDFA__&imei=__IMEI__&oaid=__OAID__&oaidMd5=__OAID_MD5__&rtaId=__REQUEST_ID__&clickId=__CLICK_ID__");
req.setAppId(1L);
req.setChannelId(1234L);
req.setId(1234L);
req.setHotEvent(0L);
UsergrowthAdMaterialUpdateResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
UsergrowthAdMaterialUpdateRequest req = new UsergrowthAdMaterialUpdateRequest();
req.BizType = 1L;
req.ScenarioType = 1L;
req.OuterCreativeId = "1234";
req.Title = "长文案";
req.ImgUrl = "https://xx.taobao.com/image.jpg";
req.H5Url = "https://m.taobao.com/tbopen/index.html?action=ali.open.nav&bc_fl_src=&idfa=__IDFA__&imei=__IMEI__&oaid=__OAID__&oaidMd5=__OAID_MD5__&rtaId=__REQUEST_ID__&clickId=__CLICK_ID__";
req.AdType = 1L;
req.VideoUrl = "https://xx.taobao.com/video.mp4";
req.SubTitle = "短文案";
req.CreativeType = 1L;
req.DpUrl = "tbopen://m.taobao.com/tbopen/index.html?action=ali.open.nav&bc_fl_src=&idfa=__IDFA__&imei=__IMEI__&oaid=__OAID__&oaidMd5=__OAID_MD5__&rtaId=__REQUEST_ID__&clickId=__CLICK_ID__";
req.AppId = 1L;
req.ChannelId = 1234L;
req.Id = 1234L;
req.HotEvent = 0L;
UsergrowthAdMaterialUpdateResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new UsergrowthAdMaterialUpdateRequest;
$req->setBizType("1");
$req->setScenarioType("1");
$req->setOuterCreativeId("1234");
$req->setTitle("长文案");
$req->setImgUrl("https://xx.taobao.com/image.jpg");
$req->setH5Url("https://m.taobao.com/tbopen/index.html?action=ali.open.nav&bc_fl_src=&idfa=__IDFA__&imei=__IMEI__&oaid=__OAID__&oaidMd5=__OAID_MD5__&rtaId=__REQUEST_ID__&clickId=__CLICK_ID__");
$req->setAdType("1");
$req->setVideoUrl("https://xx.taobao.com/video.mp4");
$req->setSubTitle("短文案");
$req->setCreativeType("1");
$req->setDpUrl("tbopen://m.taobao.com/tbopen/index.html?action=ali.open.nav&bc_fl_src=&idfa=__IDFA__&imei=__IMEI__&oaid=__OAID__&oaidMd5=__OAID_MD5__&rtaId=__REQUEST_ID__&clickId=__CLICK_ID__");
$req->setAppId("1");
$req->setChannelId("1234");
$req->setId("1234");
$req->setHotEvent("0");
$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.usergrowth.ad.material.update' \
-d 'partner_id=apidoc' \
-d 'sign=44ABDDC3385C2CA6F5FCFCF7D5668852' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-06-07+14%3A04%3A50' \
-d 'v=2.0' \
-d 'ad_type=1' \
-d 'app_id=1' \
-d 'biz_type=1' \
-d 'channel_id=1234' \
-d 'creative_type=1' \
-d 'dp_url=tbopen%3A%2F%2Fm.taobao.com%2Ftbopen%2Findex.html%3Faction%3Dali.open.nav%26bc_fl_src%3D%26idfa%3D__IDFA__%26imei%3D__IMEI__%26oaid%3D__OAID__%26oaidMd5%3D__OAID_MD5__%26rtaId%3D__REQUEST_ID__%26clickId%3D__CLICK_ID__' \
-d 'h5_url=https%3A%2F%2Fm.taobao.com%2Ftbopen%2Findex.html%3Faction%3Dali.open.nav%26bc_fl_src%3D%26idfa%3D__IDFA__%26imei%3D__IMEI__%26oaid%3D__OAID__%26oaidMd5%3D__OAID_MD5__%26rtaId%3D__REQUEST_ID__%26clickId%3D__CLICK_ID__' \
-d 'hot_event=0' \
-d 'id=1234' \
-d 'img_url=https%3A%2F%2Fxx.taobao.com%2Fimage.jpg' \
-d 'outer_creative_id=1234' \
-d 'scenario_type=1' \
-d 'sub_title=%E7%9F%AD%E6%96%87%E6%A1%88' \
-d 'title=%E9%95%BF%E6%96%87%E6%A1%88' \
-d 'video_url=https%3A%2F%2Fxx.taobao.com%2Fvideo.mp4'

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

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

req.biz_type=1
req.scenario_type=1
req.outer_creative_id="1234"
req.title="长文案"
req.img_url="https://xx.taobao.com/image.jpg"
req.h5_url="https://m.taobao.com/tbopen/index.html?action=ali.open.nav&bc_fl_src=&idfa=__IDFA__&imei=__IMEI__&oaid=__OAID__&oaidMd5=__OAID_MD5__&rtaId=__REQUEST_ID__&clickId=__CLICK_ID__"
req.ad_type=1
req.video_url="https://xx.taobao.com/video.mp4"
req.sub_title="短文案"
req.creative_type=1
req.dp_url="tbopen://m.taobao.com/tbopen/index.html?action=ali.open.nav&bc_fl_src=&idfa=__IDFA__&imei=__IMEI__&oaid=__OAID__&oaidMd5=__OAID_MD5__&rtaId=__REQUEST_ID__&clickId=__CLICK_ID__"
req.app_id=1
req.channel_id=1234
req.id=1234
req.hot_event=0
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.usergrowth.ad.material.update");
add_param(pRequest,"biz_type","1");
add_param(pRequest,"scenario_type","1");
add_param(pRequest,"outer_creative_id","1234");
add_param(pRequest,"title","长文案");
add_param(pRequest,"img_url","https://xx.taobao.com/image.jpg");
add_param(pRequest,"h5_url","https://m.taobao.com/tbopen/index.html?action=ali.open.nav&bc_fl_src=&idfa=__IDFA__&imei=__IMEI__&oaid=__OAID__&oaidMd5=__OAID_MD5__&rtaId=__REQUEST_ID__&clickId=__CLICK_ID__");
add_param(pRequest,"ad_type","1");
add_param(pRequest,"video_url","https://xx.taobao.com/video.mp4");
add_param(pRequest,"sub_title","短文案");
add_param(pRequest,"creative_type","1");
add_param(pRequest,"dp_url","tbopen://m.taobao.com/tbopen/index.html?action=ali.open.nav&bc_fl_src=&idfa=__IDFA__&imei=__IMEI__&oaid=__OAID__&oaidMd5=__OAID_MD5__&rtaId=__REQUEST_ID__&clickId=__CLICK_ID__");
add_param(pRequest,"app_id","1");
add_param(pRequest,"channel_id","1234");
add_param(pRequest,"id","1234");
add_param(pRequest,"hot_event","0");
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.usergrowth.ad.material.update', {
	'biz_type':'1',
	'scenario_type':'1',
	'outer_creative_id':'1234',
	'title':'长文案',
	'img_url':'https://xx.taobao.com/image.jpg',
	'h5_url':'https://m.taobao.com/tbopen/index.html?action=ali.open.nav&bc_fl_src=&idfa=__IDFA__&imei=__IMEI__&oaid=__OAID__&oaidMd5=__OAID_MD5__&rtaId=__REQUEST_ID__&clickId=__CLICK_ID__',
	'ad_type':'1',
	'video_url':'https://xx.taobao.com/video.mp4',
	'sub_title':'短文案',
	'creative_type':'1',
	'dp_url':'tbopen://m.taobao.com/tbopen/index.html?action=ali.open.nav&bc_fl_src=&idfa=__IDFA__&imei=__IMEI__&oaid=__OAID__&oaidMd5=__OAID_MD5__&rtaId=__REQUEST_ID__&clickId=__CLICK_ID__',
	'app_id':'1',
	'channel_id':'1234',
	'id':'1234',
	'hot_event':'0'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<usergrowth_ad_material_update_response>
    <trace_id>12353324</trace_id>
    <response_code>6</response_code>
    <data>1234</data>
    <message>参数错误</message>
    <successful>true</successful>
</usergrowth_ad_material_update_response>

{
    "usergrowth_ad_material_update_response":{
        "trace_id":"12353324",
        "response_code":6,
        "data":"1234",
        "message":"参数错误",
        "successful":true
    }
}

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下载

开放平台

用户增长

taobao.usergrowth.ad.material.update (素材更新)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ