文档中心 > API类目 > 营销API

taobao.ump.detail.add (新增活动详情)

增加活动详情。活动详情里面包括活动的范围（店铺，商品），活动的参数（比如具体的折扣），参与类型（全部，部分，部分不参加）等信息。当参与类型为部分或部分不参加的时候需要和taobao.ump.range.add来配合使用。

公共参数

请求地址：

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

请求参数

名称	类型	是否必须	示例值	更多限制	描述
act_id	Number	必须	12345		增加工具详情
content	String	必须	{'tool_name':'test','desc':'test_desc'}		活动详情内容，json格式，可以通过ump sdk中的MarketingTool来进行处理

响应参数

名称	类型	示例值	描述
detail_id	Number	12345	活动详情的id

请求示例

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
UmpDetailAddRequest req = new UmpDetailAddRequest();
req.setActId(12345L);
req.setContent("{'tool_name':'test','desc':'test_desc'}");
UmpDetailAddResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
UmpDetailAddRequest req = new UmpDetailAddRequest();
req.ActId = 12345L;
req.Content = "{'tool_name':'test','desc':'test_desc'}";
UmpDetailAddResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new UmpDetailAddRequest;
$req->setActId("12345");
$req->setContent("{'tool_name':'test','desc':'test_desc'}");
$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.ump.detail.add' \
-d 'partner_id=apidoc' \
-d 'session=e3c82019-165b-4a4e-98a0-23825bc31ba1' \
-d 'sign=CB42D2A2532BFECE58755B771E3A8BE5' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-02+22%3A09%3A39' \
-d 'v=2.0' \
-d 'act_id=12345' \
-d 'content=%7B%27tool_name%27%3A%27test%27%2C%27desc%27%3A%27test_desc%27%7D'

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

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

req.act_id=12345
req.content="{'tool_name':'test','desc':'test_desc'}"
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.ump.detail.add");
add_param(pRequest,"act_id","12345");
add_param(pRequest,"content","{'tool_name':'test','desc':'test_desc'}");
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.ump.detail.add', {
	'act_id':'12345',
	'content':'{'tool_name':'test','desc':'test_desc'}'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

XML示例
JSON示例

<ump_detail_add_response>
    <detail_id>12345</detail_id>
</ump_detail_add_response>

{
    "ump_detail_add_response":{
        "detail_id":12345
    }
}

异常示例

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"
	}
}

错误码解释

错误码	错误描述	解决方案
isv.activity-not-exist	优惠活动不存在	isv自查优惠活动是否存在
isp.system-unvilable	系统暂不可用	稍后重试
isv.detail-format-error	活动详情的内容格式错误	修改内容格式为正确的格式，或直接使用ump sdk完成内容的生成
isv.detail-count-exceeds-max-number	详情数超过最大限制	清理无效活动后重新操作

API工具

API测试工具错误码查询工具 SDK下载

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

营销API

taobao.ump.detail.add (新增活动详情)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ