文档中心 > API类目 > 淘宝客API

taobao.tbk.sc.ucrowd.create (淘宝客-服务商-创建人群标签)

服务商使用。可为淘宝客创建会员人群标签，获得人群id，人群id可用于物料评估推荐等场景。

公共参数

请求地址：

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

请求参数

名称	类型	是否必须	示例值	描述
ucrowd_type	Number	必须	1	人群类型，1:社群
external_crowd_code	String	可选	tbk_crowd_1	人群外部编码，只能包含：字母、数字、下划线（以字母、数字开头），最大128字符
ucrowd_name	String	必须	淘客购物群1	人群名称，最大32字符
desc	String	可选	淘宝客购物群1	人群描述，最大100字符

响应参数

名称	类型	示例值	描述
data	RpcResult		data
└ ucrowd_id Number 123 人群标签id

请求示例

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TbkScUcrowdCreateRequest req = new TbkScUcrowdCreateRequest();
req.setUcrowdType(1L);
req.setExternalCrowdCode("tbk_crowd_1");
req.setUcrowdName("淘客购物群1");
req.setDesc("淘宝客购物群1");
TbkScUcrowdCreateResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TbkScUcrowdCreateRequest req = new TbkScUcrowdCreateRequest();
req.UcrowdType = 1L;
req.ExternalCrowdCode = "tbk_crowd_1";
req.UcrowdName = "淘客购物群1";
req.Desc = "淘宝客购物群1";
TbkScUcrowdCreateResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TbkScUcrowdCreateRequest;
$req->setUcrowdType("1");
$req->setExternalCrowdCode("tbk_crowd_1");
$req->setUcrowdName("淘客购物群1");
$req->setDesc("淘宝客购物群1");
$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.tbk.sc.ucrowd.create' \
-d 'partner_id=apidoc' \
-d 'session=b61b3cc9-13ec-4bfa-bcc9-c46a555c498f' \
-d 'sign=B83409671EB244CAD8FD3E7B05493E90' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-05-07+20%3A21%3A49' \
-d 'v=2.0' \
-d 'desc=%E6%B7%98%E5%AE%9D%E5%AE%A2%E8%B4%AD%E7%89%A9%E7%BE%A41' \
-d 'external_crowd_code=tbk_crowd_1' \
-d 'ucrowd_name=%E6%B7%98%E5%AE%A2%E8%B4%AD%E7%89%A9%E7%BE%A41' \
-d 'ucrowd_type=1'

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

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

req.ucrowd_type=1
req.external_crowd_code="tbk_crowd_1"
req.ucrowd_name="淘客购物群1"
req.desc="淘宝客购物群1"
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.tbk.sc.ucrowd.create");
add_param(pRequest,"ucrowd_type","1");
add_param(pRequest,"external_crowd_code","tbk_crowd_1");
add_param(pRequest,"ucrowd_name","淘客购物群1");
add_param(pRequest,"desc","淘宝客购物群1");
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.tbk.sc.ucrowd.create', {
	'ucrowd_type':'1',
	'external_crowd_code':'tbk_crowd_1',
	'ucrowd_name':'淘客购物群1',
	'desc':'淘宝客购物群1'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

XML示例
JSON示例

<tbk_sc_ucrowd_create_response>
    <data>
        <ucrowd_id>123</ucrowd_id>
    </data>
</tbk_sc_ucrowd_create_response>

{
    "tbk_sc_ucrowd_create_response":{
        "data":{
            "ucrowd_id":123
        }
    }
}

异常示例

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

错误码解释

错误码	错误描述	解决方案
1154	人群创建数量已达上限	可清除无用人群
1150	人群名称重复	调整人群名称

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

淘宝开放平台

淘宝客API

taobao.tbk.sc.ucrowd.create (淘宝客-服务商-创建人群标签)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ