淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	描述
request_id	String	可选	1	请求id，用于幂等唯一key
creative_group_top_dto	CreativeGroupTopDTO	必须		创意组信息
creatives CreativeTopDTO [] 必须 list 创意内容 └ action_text String 可选行动号召文本行动号召文本 └ format Number 必须 1 广告形式，1：竖版视频，2：横版视频，3：大图横图，5：小图，6：大图竖图，7：开屏图片，8：开屏视频。竖版视频：格式要求：mp4、mpeg、3gp、avi 视频格式，建议尺寸要求：宽高比9:16，分辨率≥ 7201280，视频码率≥516kbps，时长≥4s；竖版视频-视频封面：格式要求：jpg、jpeg、png 图片格式，尺寸要求：宽高比9:16，14402560 ≤ 尺寸≥ 7201280；横版视频：格式要求：mp4、mpeg、3gp、avi 视频格式，建议尺寸要求：宽高比16:9，分辨率≥ 1280720，视频码率≥516kbps，时长≥4s,大小≤1000M；横版视频-视频封面：格式要求：jpg、jpeg、png 图片格式，尺寸要求：宽高比16:9，25601440 ≤ 尺寸≥ 1280720；大图横图：格式要求：jpg、jpeg、png 图片格式，尺寸要求：宽高比16:9，25601440 ≤ 尺寸≥ 1280720；组图：格式要求：jpg、jpeg、png 图片格式，尺寸要求：宽高比1.52，1368900 ≤ 尺寸≥ 456300；小图：格式要求：jpg、jpeg、png 图片格式，尺寸要求：宽高比1.52，1368900 ≤ 尺寸≥ 456300；大图竖图：格式要求：jpg、jpeg、png 图片格式，尺寸要求：宽高比9:16，14402560 ≤ 尺寸≥ 7201280； └ img_ids String [] 可选 1 图片素材id列表(组图存在多个) └ video_id String 可选 1 视频素材id └ title String 可选创意标题创意标题 └ video_cover_img_id String 可选视频素材封面id 视频素材封面id tencent TencentCreativeTopDTO 可选腾讯特有参数 └ ad_source String 可选 name 品牌名称 └ button_text String 可选 text 按钮文案 └ description String 可选 description 创意描述 └ name String 可选 name 创意名称 └ profile_id Number 可选 1 用户头像id └ landing_page_id Number 可选 1 落地页id └ content_type Number 可选 1 落地页推广内容：1：单品推广，2：店铺/活动等其他推广 countdown CreativeCountDownTopDTO 可选倒计时组件 └ start_time String 可选 2023-01-01 起始时间 └ end_time String 可选 2023-01-01 结束时间 └ price String 可选 1 倒计时价格展示 └ auto_open_url Number 可选 0 是否自动生成应用直达链接:0，1 └ landing_page String 可选 www.taobao.com 落地页链接 └ dp_link_url String 可选 tbopen://m.taobao.com/tbopen 自定义deeplink，需要UDBP开通白名单功能才能使用 └ tags String [] 可选创意标签创意标签 └ id Number 可选 1 创意id，如果是修改此创意则需要传创意id，可通过创意组查询接口获取 └ video_ids String [] 可选 1 视频素材id列表，多视频自定义创意时使用，如快手 └ adgroup_id Number 必须 1 计划id └ campaign_id Number 必须 1 计划组id └ advertiser_id Number 必须 1 广告主id └ tags String [] 可选 1 创意标签 └ category Number 可选 1 创意分类

名称	类型	示例值	描述
result	CreativeGroupTopDTO		返回结果
└ id Number 1 创意组id

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
UnideskRtaAdCreativeCustomUpdateRequest req = new UnideskRtaAdCreativeCustomUpdateRequest();
req.setRequestId("1");
UnideskRtaAdCreativeCustomUpdateRequest.CreativeGroupTopDTO obj1 = new UnideskRtaAdCreativeCustomUpdateRequest.CreativeGroupTopDTO();
List<UnideskRtaAdCreativeCustomUpdateRequest.CreativeTopDTO> list3 = new ArrayList<UnideskRtaAdCreativeCustomUpdateRequest.CreativeTopDTO>();
UnideskRtaAdCreativeCustomUpdateRequest.CreativeTopDTO obj4 = new UnideskRtaAdCreativeCustomUpdateRequest.CreativeTopDTO();
list3.add(obj4);
obj4.setActionText("行动号召文本");
obj4.setFormat(1L);
obj4.setImgIds("1");
obj4.setVideoId("1");
obj4.setTitle("创意标题");
obj4.setVideoCoverImgId("视频素材封面id");
UnideskRtaAdCreativeCustomUpdateRequest.TencentCreativeTopDTO obj6 = new UnideskRtaAdCreativeCustomUpdateRequest.TencentCreativeTopDTO();
obj6.setAdSource("name");
obj6.setButtonText("text");
obj6.setDescription("description");
obj6.setName("name");
obj6.setProfileId(1L);
obj6.setLandingPageId(1L);
obj6.setContentType(1L);
UnideskRtaAdCreativeCustomUpdateRequest.CreativeCountDownTopDTO obj7 = new UnideskRtaAdCreativeCustomUpdateRequest.CreativeCountDownTopDTO();
obj7.setStartTime("2023-01-01");
obj7.setEndTime("2023-01-01");
obj7.setPrice("1");
obj6.setCountdown(obj7);
obj6.setAutoOpenUrl(0L);
obj6.setLandingPage("www.taobao.com");
obj6.setDpLinkUrl("tbopen://m.taobao.com/tbopen");
list5.setTencent(obj6);
obj4.setTags("创意标签");
obj4.setId(1L);
obj4.setVideoIds("1");
obj1.setCreatives(list3);
obj1.setAdgroupId(1L);
obj1.setCampaignId(1L);
obj1.setAdvertiserId(1L);
obj1.setTags("1");
obj1.setCategory(1L);
req.setCreativeGroupTopDto(obj1);
UnideskRtaAdCreativeCustomUpdateResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
UnideskRtaAdCreativeCustomUpdateRequest req = new UnideskRtaAdCreativeCustomUpdateRequest();
req.RequestId = "1";
UnideskRtaAdCreativeCustomUpdateRequest.CreativeGroupTopDTODomain obj1 = new UnideskRtaAdCreativeCustomUpdateRequest.CreativeGroupTopDTODomain();
List<UnideskRtaAdCreativeCustomUpdateRequest.CreativeTopDTODomain> list3 = new List<UnideskRtaAdCreativeCustomUpdateRequest.CreativeTopDTODomain>();
UnideskRtaAdCreativeCustomUpdateRequest.CreativeTopDTODomain obj4 = new UnideskRtaAdCreativeCustomUpdateRequest.CreativeTopDTODomain();
list3.Add(obj4);
obj4.ActionText = "行动号召文本";
obj4.Format = 1L;
obj4.ImgIds = "1";
obj4.VideoId = "1";
obj4.Title = "创意标题";
obj4.VideoCoverImgId = "视频素材封面id";
UnideskRtaAdCreativeCustomUpdateRequest.TencentCreativeTopDTODomain obj5 = new UnideskRtaAdCreativeCustomUpdateRequest.TencentCreativeTopDTODomain();
obj5.AdSource = "name";
obj5.ButtonText = "text";
obj5.Description = "description";
obj5.Name = "name";
obj5.ProfileId = 1L;
obj5.LandingPageId = 1L;
obj5.ContentType = 1L;
UnideskRtaAdCreativeCustomUpdateRequest.CreativeCountDownTopDTODomain obj6 = new UnideskRtaAdCreativeCustomUpdateRequest.CreativeCountDownTopDTODomain();
obj6.StartTime = "2023-01-01";
obj6.EndTime = "2023-01-01";
obj6.Price = "1";
obj5.Countdown= obj6;
obj5.AutoOpenUrl = 0L;
obj5.LandingPage = "www.taobao.com";
obj5.DpLinkUrl = "tbopen://m.taobao.com/tbopen";
obj4.Tencent= obj5;
obj4.Tags = "创意标签";
obj4.Id = 1L;
obj4.VideoIds = "1";
obj1.Creatives= list3;
obj1.AdgroupId = 1L;
obj1.CampaignId = 1L;
obj1.AdvertiserId = 1L;
obj1.Tags = "1";
obj1.Category = 1L;
req.CreativeGroupTopDto_ = obj1;
UnideskRtaAdCreativeCustomUpdateResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new UnideskRtaAdCreativeCustomUpdateRequest;
$req->setRequestId("1");
$creative_group_top_dto = new CreativeGroupTopDTO;
$creatives = new CreativeTopDTO;
$creatives->action_text="行动号召文本";
$creatives->format="1";
$creatives->img_ids="1";
$creatives->video_id="1";
$creatives->title="创意标题";
$creatives->video_cover_img_id="视频素材封面id";
$tencent = new TencentCreativeTopDTO;
$tencent->ad_source="name";
$tencent->button_text="text";
$tencent->description="description";
$tencent->name="name";
$tencent->profile_id="1";
$tencent->landing_page_id="1";
$tencent->content_type="1";
$countdown = new CreativeCountDownTopDTO;
$countdown->start_time="2023-01-01";
$countdown->end_time="2023-01-01";
$countdown->price="1";
$tencent->countdown = $countdown;
$tencent->auto_open_url="0";
$tencent->landing_page="www.taobao.com";
$tencent->dp_link_url="tbopen://m.taobao.com/tbopen";
$creatives->tencent = $tencent;
$creatives->tags="创意标签";
$creatives->id="1";
$creatives->video_ids="1";
$creative_group_top_dto->creatives = $creatives;
$creative_group_top_dto->adgroup_id="1";
$creative_group_top_dto->campaign_id="1";
$creative_group_top_dto->advertiser_id="1";
$creative_group_top_dto->tags="1";
$creative_group_top_dto->category="1";
$req->setCreativeGroupTopDto(json_encode($creative_group_top_dto));
$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.unidesk.rta.ad.creative.custom.update' \
-d 'partner_id=apidoc' \
-d 'session=4f29d245-cdb2-4d19-ac2b-c921514d8df5' \
-d 'sign=B7B8232AFAAE2BA20BB06755086E2EE0' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-30+17%3A14%3A18' \
-d 'v=2.0' \
-d 'creative_group_top_dto=null' \
-d 'request_id=1'

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

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

req.request_id="1"
req.creative_group_top_dto="数据结构示例JSON格式"
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.unidesk.rta.ad.creative.custom.update");
add_param(pRequest,"request_id","1");
add_param(pRequest,"creative_group_top_dto","数据结构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.unidesk.rta.ad.creative.custom.update', {
	'request_id':'1',
	'creative_group_top_dto':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<unidesk_rta_ad_creative_custom_update_response>
    <result>
    </result>
</unidesk_rta_ad_creative_custom_update_response>

{
    "unidesk_rta_ad_creative_custom_update_response":{
        "result":{
        }
    }
}

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

开放平台

阿里妈妈-UniDesk

taobao.unidesk.rta.ad.creative.custom.update (UD创意修改自定义创意接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ