淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	描述
cur_page	Number	必须	1	当前页
page_size	Number	必须	10	页大小
activity_source	String	可选	SINGLE_TREASURE	活动类型

名称	类型	示例值	描述
total_count	Number	998	数据总数
tao_activity_get_schema_resp_list	TaoActivityGetSchemaResp []		响应结果
└ activity_schema String {"model": [{"key": "activityName","name": "活动名称","tips": "活动名称小提示","validates": ["{\"name\":require,\"value\":true,\"type\":\"requiredRule\",\"tips\":\"是否必填\"}","{\"name\":update,\"value\":true,\"type\":\"uploadRule\",\"tips\":\"能否修改\"}","{\"name\":maxLength,\"value\":12,\"type\":\"textLength\",\"tips\":\"字段最大长度\"}","{\"name\":minLength,\"value\":1,\"type\":\"textLength\",\"tips\":\"字段最小长度\"}"],"subKey": [],"structure": "key"},{"key": "activityType","name": "活动类型","tips": "活动类型小提示","validates": ["{\"name\":require,\"value\":true,\"type\":\"requiredRule\",\"tips\":\"是否必填\"}","{\"name\":update,\"value\":true,\"type\":\"uploadRule\",\"tips\":\"能否修改\"}","{\"name\":dics,\"value\":\"1\|\|2\",\"type\":\"dicValues\",\"tips\":\"字典值\"}"],"subKey": [],"structure": "key"}]} 活动schema └ activity_source String SINGLE_TREASURE 活动类型

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
ActivitySchemaGetRequest req = new ActivitySchemaGetRequest();
req.setCurPage(1L);
req.setPageSize(10L);
req.setActivitySource("SINGLE_TREASURE");
ActivitySchemaGetResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
ActivitySchemaGetRequest req = new ActivitySchemaGetRequest();
req.CurPage = 1L;
req.PageSize = 10L;
req.ActivitySource = "SINGLE_TREASURE";
ActivitySchemaGetResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new ActivitySchemaGetRequest;
$req->setCurPage("1");
$req->setPageSize("10");
$req->setActivitySource("SINGLE_TREASURE");
$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.activity.schema.get' \
-d 'partner_id=apidoc' \
-d 'session=d87808cd-a86e-4292-9f06-2166517b7aa9' \
-d 'sign=34220E00E3CC9170C169BF4601F8E6F1' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-21+12%3A11%3A19' \
-d 'v=2.0' \
-d 'activity_source=SINGLE_TREASURE' \
-d 'cur_page=1' \
-d 'page_size=10'

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

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

req.cur_page=1
req.page_size=10
req.activity_source="SINGLE_TREASURE"
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.activity.schema.get");
add_param(pRequest,"cur_page","1");
add_param(pRequest,"page_size","10");
add_param(pRequest,"activity_source","SINGLE_TREASURE");
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.activity.schema.get', {
	'cur_page':'1',
	'page_size':'10',
	'activity_source':'SINGLE_TREASURE'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<activity_schema_get_response>
    <total_count>998</total_count>
    <tao_activity_get_schema_resp_list>
        <tao_activity_get_schema_resp>
            <activity_schema>{&quot;model&quot;: [{&quot;key&quot;: &quot;activityName&quot;,&quot;name&quot;: &quot;活动名称&quot;,&quot;tips&quot;: &quot;活动名称小提示&quot;,&quot;validates&quot;: [&quot;{\&quot;name\&quot;:require,\&quot;value\&quot;:true,\&quot;type\&quot;:\&quot;requiredRule\&quot;,\&quot;tips\&quot;:\&quot;是否必填\&quot;}&quot;,&quot;{\&quot;name\&quot;:update,\&quot;value\&quot;:true,\&quot;type\&quot;:\&quot;uploadRule\&quot;,\&quot;tips\&quot;:\&quot;能否修改\&quot;}&quot;,&quot;{\&quot;name\&quot;:maxLength,\&quot;value\&quot;:12,\&quot;type\&quot;:\&quot;textLength\&quot;,\&quot;tips\&quot;:\&quot;字段最大长度\&quot;}&quot;,&quot;{\&quot;name\&quot;:minLength,\&quot;value\&quot;:1,\&quot;type\&quot;:\&quot;textLength\&quot;,\&quot;tips\&quot;:\&quot;字段最小长度\&quot;}&quot;],&quot;subKey&quot;: [],&quot;structure&quot;: &quot;key&quot;},{&quot;key&quot;: &quot;activityType&quot;,&quot;name&quot;: &quot;活动类型&quot;,&quot;tips&quot;: &quot;活动类型小提示&quot;,&quot;validates&quot;: [&quot;{\&quot;name\&quot;:require,\&quot;value\&quot;:true,\&quot;type\&quot;:\&quot;requiredRule\&quot;,\&quot;tips\&quot;:\&quot;是否必填\&quot;}&quot;,&quot;{\&quot;name\&quot;:update,\&quot;value\&quot;:true,\&quot;type\&quot;:\&quot;uploadRule\&quot;,\&quot;tips\&quot;:\&quot;能否修改\&quot;}&quot;,&quot;{\&quot;name\&quot;:dics,\&quot;value\&quot;:\&quot;1||2\&quot;,\&quot;type\&quot;:\&quot;dicValues\&quot;,\&quot;tips\&quot;:\&quot;字典值\&quot;}&quot;],&quot;subKey&quot;: [],&quot;structure&quot;: &quot;key&quot;}]}</activity_schema>
            <activity_source>SINGLE_TREASURE</activity_source>
        </tao_activity_get_schema_resp>
    </tao_activity_get_schema_resp_list>
</activity_schema_get_response>

{
    "activity_schema_get_response":{
        "total_count":998,
        "tao_activity_get_schema_resp_list":{
            "tao_activity_get_schema_resp":[
                {
                    "activity_schema":"{\"model\": [{\"key\": \"activityName\",\"name\": \"活动名称\",\"tips\": \"活动名称小提示\",\"validates\": [\"{\\\"name\\\":require,\\\"value\\\":true,\\\"type\\\":\\\"requiredRule\\\",\\\"tips\\\":\\\"是否必填\\\"}\",\"{\\\"name\\\":update,\\\"value\\\":true,\\\"type\\\":\\\"uploadRule\\\",\\\"tips\\\":\\\"能否修改\\\"}\",\"{\\\"name\\\":maxLength,\\\"value\\\":12,\\\"type\\\":\\\"textLength\\\",\\\"tips\\\":\\\"字段最大长度\\\"}\",\"{\\\"name\\\":minLength,\\\"value\\\":1,\\\"type\\\":\\\"textLength\\\",\\\"tips\\\":\\\"字段最小长度\\\"}\"],\"subKey\": [],\"structure\": \"key\"},{\"key\": \"activityType\",\"name\": \"活动类型\",\"tips\": \"活动类型小提示\",\"validates\": [\"{\\\"name\\\":require,\\\"value\\\":true,\\\"type\\\":\\\"requiredRule\\\",\\\"tips\\\":\\\"是否必填\\\"}\",\"{\\\"name\\\":update,\\\"value\\\":true,\\\"type\\\":\\\"uploadRule\\\",\\\"tips\\\":\\\"能否修改\\\"}\",\"{\\\"name\\\":dics,\\\"value\\\":\\\"1||2\\\",\\\"type\\\":\\\"dicValues\\\",\\\"tips\\\":\\\"字典值\\\"}\"],\"subKey\": [],\"structure\": \"key\"}]}",
                    "activity_source":"SINGLE_TREASURE"
                }
            ]
        }
    }
}

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.activity.schema.get (获取商家能创建的小活动schema)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ