淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
creative_component_top_dto	CreativeComponentTopDTO	必须			组件详细信息
toutiao_coupon_magnet ToutiaoCouponComponentTopDTO 可选组件详细信息-电商优惠券磁贴-头条 └ effective_end_date String 可选 2020-12-01 优惠结束时间。格式: "2020-12-01" └ duration Number 可选 10 出现时间，单位s。当show_time为自定义时必传，小于等于59，大于等于10。当show_time为系统默认时，可不传，默认为10 └ coupon_amount Number 可选 100 优惠金额，单位分 └ landing_page String 可选 http://xx 淘积木链接 └ coupon_condition Number 可选 200 优惠条件，单位分 └ show_time Number 可选 1 出现时间类型。1 系统默认，2自定义。不传代表系统默认 └ activity_name String 可选活动名称活动名称。长度最大为15。一个中文长度为2 └ effective_start_date String 可选 2020-12-01 优惠开始时间。格式: "2020-12-01" └ start_time String 可选 2020-12-01 投放开始时间。格式: "2020-12-01" └ end_time String 可选 2020-12-01 投放结束时间。格式: "2020-12-01" └ type Number 必须 1 组件类型， 1图片磁贴 2电商磁贴 3电商优惠券磁贴 4推广卡片 5购物车锚点 toutiao_promotion_card ToutiaoPromotionCardComponentTopDTO 可选组件详细信息-推广卡片-头条 └ button_text String 可选 1 行动号召。内容长度要求：2 ≤ x ≤6。一个中文长度为1 └ img_id String 可选 1 图片文件 └ title String 可选 1 卡片标题。长度最大为20。一个中文长度为1 └ enable_personal_action Number 可选 1 是否开启智能优选，1-开启、0-不开启 └ product_selling_points String [] 可选 1 推广卖点。最多选择10个推广卖点，内容长度要求：6 ≤ x ≤9 。一个中文长度为1 toutiao_image_magnet ToutiaoImageComponentTopDTO 可选组件详细信息-图片磁贴-头条 └ duration Number 可选 10 出现时间，单位s。当show_time为自定义时必传，小于等于59，大于等于10。当show_time为系统默认时，可不传，默认为10 └ img_id String 可选 1 图片尺寸<=540276px ，大小<2M └ show_time Number 可选 1 出现时间类型。1 系统默认，2自定义。不传代表系统默认 └ start_time String 可选 2020-12-01 投放开始时间。格式: "2020-12-01" └ end_time String 可选 2020-12-01 投放结束时间。格式: "2020-12-01" └ advertiser_id Number 必须 1 广告主id └ name String 必须 1 组件名称 toutiao_commerce_magnet ToutiaoECommerceCreativeTopComponent 可选组件详细信息-电商磁贴-头条 └ start_time String 可选 2020-12-01 投放开始时间。格式: "2020-12-01" └ end_time String 可选 2020-12-01 投放结束时间。格式: "2020-12-01" └ magnet_title String 可选磁贴标题磁贴标题。长度最大为10。一个中文长度为1 └ title String 可选文案内容文案内容。长度最大为15。一个中文长度为1 └ button_text String 可选立即购买按钮文案。只支持立即下单和立即购买 └ img_id String 可选 1 图片，宽高比1:1，尺寸最大为174174，大小<1M kuaishou_image_magnet KuaishouImageComponentTopDTO 可选组件详细信息-图片磁贴-快手 └ img_id String 可选 1 图片id kuaishou_coupon_magnet KuaishouCouponComponentTopDTO 可选组件详细信息-优惠券磁贴-快手 └ landing_page String 可选 http://xx 淘积木链接 └ activity_name String 可选活动名称活动名称。长度最大为15。一个中文长度为2 └ coupon_amount Number 可选 100 优惠金额，单位分 └ coupon_condition Number 可选 200 优惠条件，单位分 └ effective_start_date String 可选 2023-01-01 优惠开始时间。格式: "2020-12-01" └ effective_end_date String 可选 2023-02-01 优惠结束时间。格式: "2020-12-01" toutiao_shopping_cart_magnet ToutiaoShoppingCartCreativeComponentTopDTO 可选组件详细信息-购物车锚点 └ shopping_cart_title String 可选购物车标题购物车标题 └ img_ids String [] 可选 1 商品图片 └ product_price Number 可选 1 商品价格 └ product_title String 可选商品标题商品标题 └ product_source Number 可选 1 商品来源 1:淘宝 └ link_type Number 可选 1 跳转类型 1 一跳 └ external_url String 可选 https:// 落地页链接 └ open_url String 可选 https:// 应用直达链接只有加白用户可以使用

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

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
UnideskRtaAssetsCreativecomponentAddRequest req = new UnideskRtaAssetsCreativecomponentAddRequest();
UnideskRtaAssetsCreativecomponentAddRequest.CreativeComponentTopDTO obj1 = new UnideskRtaAssetsCreativecomponentAddRequest.CreativeComponentTopDTO();
UnideskRtaAssetsCreativecomponentAddRequest.ToutiaoCouponComponentTopDTO obj2 = new UnideskRtaAssetsCreativecomponentAddRequest.ToutiaoCouponComponentTopDTO();
obj2.setEffectiveEndDate("2020-12-01");
obj2.setDuration(10L);
obj2.setCouponAmount(100L);
obj2.setLandingPage("http://xx");
obj2.setCouponCondition(200L);
obj2.setShowTime(1L);
obj2.setActivityName("活动名称");
obj2.setEffectiveStartDate("2020-12-01");
obj2.setStartTime("2020-12-01");
obj2.setEndTime("2020-12-01");
obj1.setToutiaoCouponMagnet(obj2);
obj1.setType(1L);
UnideskRtaAssetsCreativecomponentAddRequest.ToutiaoPromotionCardComponentTopDTO obj3 = new UnideskRtaAssetsCreativecomponentAddRequest.ToutiaoPromotionCardComponentTopDTO();
obj3.setButtonText("1");
obj3.setImgId("1");
obj3.setTitle("1");
obj3.setEnablePersonalAction(1L);
obj3.setProductSellingPoints("1");
obj1.setToutiaoPromotionCard(obj3);
UnideskRtaAssetsCreativecomponentAddRequest.ToutiaoImageComponentTopDTO obj4 = new UnideskRtaAssetsCreativecomponentAddRequest.ToutiaoImageComponentTopDTO();
obj4.setDuration(10L);
obj4.setImgId("1");
obj4.setShowTime(1L);
obj4.setStartTime("2020-12-01");
obj4.setEndTime("2020-12-01");
obj1.setToutiaoImageMagnet(obj4);
obj1.setAdvertiserId(1L);
obj1.setName("1");
UnideskRtaAssetsCreativecomponentAddRequest.ToutiaoECommerceCreativeTopComponent obj5 = new UnideskRtaAssetsCreativecomponentAddRequest.ToutiaoECommerceCreativeTopComponent();
obj5.setStartTime("2020-12-01");
obj5.setEndTime("2020-12-01");
obj5.setMagnetTitle("磁贴标题");
obj5.setTitle("文案内容");
obj5.setButtonText("立即购买");
obj5.setImgId("1");
obj1.setToutiaoCommerceMagnet(obj5);
UnideskRtaAssetsCreativecomponentAddRequest.KuaishouImageComponentTopDTO obj6 = new UnideskRtaAssetsCreativecomponentAddRequest.KuaishouImageComponentTopDTO();
obj6.setImgId("1");
obj1.setKuaishouImageMagnet(obj6);
UnideskRtaAssetsCreativecomponentAddRequest.KuaishouCouponComponentTopDTO obj7 = new UnideskRtaAssetsCreativecomponentAddRequest.KuaishouCouponComponentTopDTO();
obj7.setLandingPage("http://xx");
obj7.setActivityName("活动名称");
obj7.setCouponAmount(100L);
obj7.setCouponCondition(200L);
obj7.setEffectiveStartDate("2023-01-01");
obj7.setEffectiveEndDate("2023-02-01");
obj1.setKuaishouCouponMagnet(obj7);
UnideskRtaAssetsCreativecomponentAddRequest.ToutiaoShoppingCartCreativeComponentTopDTO obj8 = new UnideskRtaAssetsCreativecomponentAddRequest.ToutiaoShoppingCartCreativeComponentTopDTO();
obj8.setShoppingCartTitle("购物车标题");
obj8.setImgIds("1");
obj8.setProductPrice(1L);
obj8.setProductTitle("商品标题");
obj8.setProductSource(1L);
obj8.setLinkType(1L);
obj8.setExternalUrl("https://");
obj8.setOpenUrl("https://");
obj1.setToutiaoShoppingCartMagnet(obj8);
req.setCreativeComponentTopDto(obj1);
UnideskRtaAssetsCreativecomponentAddResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
UnideskRtaAssetsCreativecomponentAddRequest req = new UnideskRtaAssetsCreativecomponentAddRequest();
UnideskRtaAssetsCreativecomponentAddRequest.CreativeComponentTopDTODomain obj1 = new UnideskRtaAssetsCreativecomponentAddRequest.CreativeComponentTopDTODomain();
UnideskRtaAssetsCreativecomponentAddRequest.ToutiaoCouponComponentTopDTODomain obj2 = new UnideskRtaAssetsCreativecomponentAddRequest.ToutiaoCouponComponentTopDTODomain();
obj2.EffectiveEndDate = "2020-12-01";
obj2.Duration = 10L;
obj2.CouponAmount = 100L;
obj2.LandingPage = "http://xx";
obj2.CouponCondition = 200L;
obj2.ShowTime = 1L;
obj2.ActivityName = "活动名称";
obj2.EffectiveStartDate = "2020-12-01";
obj2.StartTime = "2020-12-01";
obj2.EndTime = "2020-12-01";
obj1.ToutiaoCouponMagnet= obj2;
obj1.Type = 1L;
UnideskRtaAssetsCreativecomponentAddRequest.ToutiaoPromotionCardComponentTopDTODomain obj3 = new UnideskRtaAssetsCreativecomponentAddRequest.ToutiaoPromotionCardComponentTopDTODomain();
obj3.ButtonText = "1";
obj3.ImgId = "1";
obj3.Title = "1";
obj3.EnablePersonalAction = 1L;
obj3.ProductSellingPoints = "1";
obj1.ToutiaoPromotionCard= obj3;
UnideskRtaAssetsCreativecomponentAddRequest.ToutiaoImageComponentTopDTODomain obj4 = new UnideskRtaAssetsCreativecomponentAddRequest.ToutiaoImageComponentTopDTODomain();
obj4.Duration = 10L;
obj4.ImgId = "1";
obj4.ShowTime = 1L;
obj4.StartTime = "2020-12-01";
obj4.EndTime = "2020-12-01";
obj1.ToutiaoImageMagnet= obj4;
obj1.AdvertiserId = 1L;
obj1.Name = "1";
UnideskRtaAssetsCreativecomponentAddRequest.ToutiaoECommerceCreativeTopComponentDomain obj5 = new UnideskRtaAssetsCreativecomponentAddRequest.ToutiaoECommerceCreativeTopComponentDomain();
obj5.StartTime = "2020-12-01";
obj5.EndTime = "2020-12-01";
obj5.MagnetTitle = "磁贴标题";
obj5.Title = "文案内容";
obj5.ButtonText = "立即购买";
obj5.ImgId = "1";
obj1.ToutiaoCommerceMagnet= obj5;
UnideskRtaAssetsCreativecomponentAddRequest.KuaishouImageComponentTopDTODomain obj6 = new UnideskRtaAssetsCreativecomponentAddRequest.KuaishouImageComponentTopDTODomain();
obj6.ImgId = "1";
obj1.KuaishouImageMagnet= obj6;
UnideskRtaAssetsCreativecomponentAddRequest.KuaishouCouponComponentTopDTODomain obj7 = new UnideskRtaAssetsCreativecomponentAddRequest.KuaishouCouponComponentTopDTODomain();
obj7.LandingPage = "http://xx";
obj7.ActivityName = "活动名称";
obj7.CouponAmount = 100L;
obj7.CouponCondition = 200L;
obj7.EffectiveStartDate = "2023-01-01";
obj7.EffectiveEndDate = "2023-02-01";
obj1.KuaishouCouponMagnet= obj7;
UnideskRtaAssetsCreativecomponentAddRequest.ToutiaoShoppingCartCreativeComponentTopDTODomain obj8 = new UnideskRtaAssetsCreativecomponentAddRequest.ToutiaoShoppingCartCreativeComponentTopDTODomain();
obj8.ShoppingCartTitle = "购物车标题";
obj8.ImgIds = "1";
obj8.ProductPrice = 1L;
obj8.ProductTitle = "商品标题";
obj8.ProductSource = 1L;
obj8.LinkType = 1L;
obj8.ExternalUrl = "https://";
obj8.OpenUrl = "https://";
obj1.ToutiaoShoppingCartMagnet= obj8;
req.CreativeComponentTopDto_ = obj1;
UnideskRtaAssetsCreativecomponentAddResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new UnideskRtaAssetsCreativecomponentAddRequest;
$creative_component_top_dto = new CreativeComponentTopDTO;
$toutiao_coupon_magnet = new ToutiaoCouponComponentTopDTO;
$toutiao_coupon_magnet->effective_end_date="2020-12-01";
$toutiao_coupon_magnet->duration="10";
$toutiao_coupon_magnet->coupon_amount="100";
$toutiao_coupon_magnet->landing_page="http://xx";
$toutiao_coupon_magnet->coupon_condition="200";
$toutiao_coupon_magnet->show_time="1";
$toutiao_coupon_magnet->activity_name="活动名称";
$toutiao_coupon_magnet->effective_start_date="2020-12-01";
$toutiao_coupon_magnet->start_time="2020-12-01";
$toutiao_coupon_magnet->end_time="2020-12-01";
$creative_component_top_dto->toutiao_coupon_magnet = $toutiao_coupon_magnet;
$creative_component_top_dto->type="1";
$toutiao_promotion_card = new ToutiaoPromotionCardComponentTopDTO;
$toutiao_promotion_card->button_text="1";
$toutiao_promotion_card->img_id="1";
$toutiao_promotion_card->title="1";
$toutiao_promotion_card->enable_personal_action="1";
$toutiao_promotion_card->product_selling_points="1";
$creative_component_top_dto->toutiao_promotion_card = $toutiao_promotion_card;
$toutiao_image_magnet = new ToutiaoImageComponentTopDTO;
$toutiao_image_magnet->duration="10";
$toutiao_image_magnet->img_id="1";
$toutiao_image_magnet->show_time="1";
$toutiao_image_magnet->start_time="2020-12-01";
$toutiao_image_magnet->end_time="2020-12-01";
$creative_component_top_dto->toutiao_image_magnet = $toutiao_image_magnet;
$creative_component_top_dto->advertiser_id="1";
$creative_component_top_dto->name="1";
$toutiao_commerce_magnet = new ToutiaoECommerceCreativeTopComponent;
$toutiao_commerce_magnet->start_time="2020-12-01";
$toutiao_commerce_magnet->end_time="2020-12-01";
$toutiao_commerce_magnet->magnet_title="磁贴标题";
$toutiao_commerce_magnet->title="文案内容";
$toutiao_commerce_magnet->button_text="立即购买";
$toutiao_commerce_magnet->img_id="1";
$creative_component_top_dto->toutiao_commerce_magnet = $toutiao_commerce_magnet;
$kuaishou_image_magnet = new KuaishouImageComponentTopDTO;
$kuaishou_image_magnet->img_id="1";
$creative_component_top_dto->kuaishou_image_magnet = $kuaishou_image_magnet;
$kuaishou_coupon_magnet = new KuaishouCouponComponentTopDTO;
$kuaishou_coupon_magnet->landing_page="http://xx";
$kuaishou_coupon_magnet->activity_name="活动名称";
$kuaishou_coupon_magnet->coupon_amount="100";
$kuaishou_coupon_magnet->coupon_condition="200";
$kuaishou_coupon_magnet->effective_start_date="2023-01-01";
$kuaishou_coupon_magnet->effective_end_date="2023-02-01";
$creative_component_top_dto->kuaishou_coupon_magnet = $kuaishou_coupon_magnet;
$toutiao_shopping_cart_magnet = new ToutiaoShoppingCartCreativeComponentTopDTO;
$toutiao_shopping_cart_magnet->shopping_cart_title="购物车标题";
$toutiao_shopping_cart_magnet->img_ids="1";
$toutiao_shopping_cart_magnet->product_price="1";
$toutiao_shopping_cart_magnet->product_title="商品标题";
$toutiao_shopping_cart_magnet->product_source="1";
$toutiao_shopping_cart_magnet->link_type="1";
$toutiao_shopping_cart_magnet->external_url="https://";
$toutiao_shopping_cart_magnet->open_url="https://";
$creative_component_top_dto->toutiao_shopping_cart_magnet = $toutiao_shopping_cart_magnet;
$req->setCreativeComponentTopDto(json_encode($creative_component_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.assets.creativecomponent.add' \
-d 'partner_id=apidoc' \
-d 'session=054f8d05-e76a-4706-b691-017689c118a1' \
-d 'sign=EE2C03D24E4A19AB9AC4C290D5BD39A5' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-30+17%3A11%3A45' \
-d 'v=2.0' \
-d 'creative_component_top_dto=null'

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

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

req.creative_component_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.assets.creativecomponent.add");
add_param(pRequest,"creative_component_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.assets.creativecomponent.add', {
	'creative_component_top_dto':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<unidesk_rta_assets_creativecomponent_add_response>
    <result>
        <id>1</id>
    </result>
</unidesk_rta_assets_creativecomponent_add_response>

{
    "unidesk_rta_assets_creativecomponent_add_response":{
        "result":{
            "id":1
        }
    }
}

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.assets.creativecomponent.add (UD创意组件创建接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ