淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	描述
top_context	TopContextDto	必须	用户信息
└ product_line_id Number 必须 110101 产品线id └ product_id Number 可选 110101010 产品id
recommend_query	ProductRecommendQueryDTO	必须	推品查询条件
└ page Number 必须 1 当前页数 └ size Number 必须 10 每页数量 └ tag_list String [] 可选 ["TESTING"] TESTING：新发产品 HOT：优质转化品 WIN：橱窗产品 PRE：优先推广品 HIGH_VIDEO_PROD：优质视频品 PRODTAG_HOTSALE,PRODTAG_STRENGTH: 优品 SITE_NEW: 平台新品 DIRECT_PROD: 行业定征新品 └ tag_query_type String 可选 or 优品必填"or" └ sub_type String 可选 NEW_PROD 新品必填：“NEW_PROD” └ create_days Number 可选 90 品创建天数,新品必传“90/180”

名称	类型	示例值	描述
result_list	RecommendProductDTO []		推品返回实体类
└ product_id Number 154545487 品id └ subject String 衣服yt 品标题 └ ads_impr_cnt Number 10 曝光数 └ ads_click_cnt Number 10 点击数 └ ads_cost_amt String 10.0 消耗 └ ads_ctr String 50% 点击率 └ ads_cpc String 1 平均点击价格 └ web_impr_cnt Number 10 网页曝光数 └ web_click_cnt Number 10 网页点击数 └ web_ctr String 50% 网页点击率 └ web_rank Number 17 网页排名 └ ads_rank Number 59 排名 └ prod_score String 52 产品分数 └ power_score String 59 权力分数 └ blue_sea_score String 1 蓝海指数 └ gmt_posting_create String 2022-07-12 12:00:00 品创建时间 └ promotion_status Number 1 商品推广状态 └ superior_prod Number 1 优越品

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaScbpAdGroupRecommendProductRequest req = new AlibabaScbpAdGroupRecommendProductRequest();
AlibabaScbpAdGroupRecommendProductRequest.TopContextDto obj1 = new AlibabaScbpAdGroupRecommendProductRequest.TopContextDto();
obj1.setProductLineId(110101L);
obj1.setProductId(110101010L);
req.setTopContext(obj1);
AlibabaScbpAdGroupRecommendProductRequest.ProductRecommendQueryDTO obj2 = new AlibabaScbpAdGroupRecommendProductRequest.ProductRecommendQueryDTO();
obj2.setPage(1L);
obj2.setSize(10L);
obj2.setTagList(""TESTING"");
obj2.setTagQueryType("or");
obj2.setSubType("NEW_PROD");
obj2.setCreateDays(90L);
req.setRecommendQuery(obj2);
AlibabaScbpAdGroupRecommendProductResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaScbpAdGroupRecommendProductRequest req = new AlibabaScbpAdGroupRecommendProductRequest();
AlibabaScbpAdGroupRecommendProductRequest.TopContextDtoDomain obj1 = new AlibabaScbpAdGroupRecommendProductRequest.TopContextDtoDomain();
obj1.ProductLineId = 110101L;
obj1.ProductId = 110101010L;
req.TopContext_ = obj1;
AlibabaScbpAdGroupRecommendProductRequest.ProductRecommendQueryDTODomain obj2 = new AlibabaScbpAdGroupRecommendProductRequest.ProductRecommendQueryDTODomain();
obj2.Page = 1L;
obj2.Size = 10L;
obj2.TagList = ""TESTING"";
obj2.TagQueryType = "or";
obj2.SubType = "NEW_PROD";
obj2.CreateDays = 90L;
req.RecommendQuery_ = obj2;
AlibabaScbpAdGroupRecommendProductResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaScbpAdGroupRecommendProductRequest;
$top_context = new TopContextDto;
$top_context->product_line_id="110101";
$top_context->product_id="110101010";
$req->setTopContext(json_encode($top_context));
$recommend_query = new ProductRecommendQueryDTO;
$recommend_query->page="1";
$recommend_query->size="10";
$recommend_query->tag_list="[\"TESTING\"]";
$recommend_query->tag_query_type="or";
$recommend_query->sub_type="NEW_PROD";
$recommend_query->create_days="90";
$req->setRecommendQuery(json_encode($recommend_query));
$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=alibaba.scbp.ad.group.recommend.product' \
-d 'partner_id=apidoc' \
-d 'session=716cb124-a6d1-414a-a998-0c8a6c9f45b2' \
-d 'sign=A34F6D79649D2F0DB08925D3C3FF9EBB' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-29+18%3A45%3A58' \
-d 'v=2.0' \
-d 'recommend_query=1' \
-d 'top_context=null'

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

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

req.top_context=""
req.recommend_query="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,"alibaba.scbp.ad.group.recommend.product");
add_param(pRequest,"top_context","数据结构JSON示例");
add_param(pRequest,"recommend_query","数据结构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('alibaba.scbp.ad.group.recommend.product', {
	'top_context':'数据结构JSON示例',
	'recommend_query':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_scbp_ad_group_recommend_product_response>
    <result_list>
        <recommend_product_d_t_o>
            <product_id>154545487</product_id>
            <subject>衣服yt</subject>
            <ads_impr_cnt>10</ads_impr_cnt>
            <ads_click_cnt>10</ads_click_cnt>
            <ads_cost_amt>10.0</ads_cost_amt>
            <ads_ctr>50%</ads_ctr>
            <ads_cpc>1</ads_cpc>
            <web_impr_cnt>10</web_impr_cnt>
            <web_click_cnt>10</web_click_cnt>
            <web_ctr>50%</web_ctr>
            <web_rank>17</web_rank>
            <ads_rank>59</ads_rank>
            <prod_score>52</prod_score>
            <power_score>59</power_score>
            <blue_sea_score>1</blue_sea_score>
            <gmt_posting_create>2022-07-12 12:00:00</gmt_posting_create>
            <promotion_status>1</promotion_status>
            <superior_prod>1</superior_prod>
        </recommend_product_d_t_o>
    </result_list>
</alibaba_scbp_ad_group_recommend_product_response>

{
    "alibaba_scbp_ad_group_recommend_product_response":{
        "result_list":{
            "recommend_product_d_t_o":[
                {
                    "product_id":154545487,
                    "subject":"衣服yt",
                    "ads_impr_cnt":10,
                    "ads_click_cnt":10,
                    "ads_cost_amt":"10.0",
                    "ads_ctr":"50%",
                    "ads_cpc":"1",
                    "web_impr_cnt":10,
                    "web_click_cnt":10,
                    "web_ctr":"50%",
                    "web_rank":17,
                    "ads_rank":59,
                    "prod_score":"52",
                    "power_score":"59",
                    "blue_sea_score":"1",
                    "gmt_posting_create":"2022-07-12 12:00:00",
                    "promotion_status":1,
                    "superior_prod":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下载

开放平台

国际站外贸直通车操作

alibaba.scbp.ad.group.recommend.product (推品)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ